Added support for overriding various fields of outgoing requests (#363)

This PR adds support for adding a new `RequestOverride` object which can be built with fields that can override:
* API URI
* API Key
* Timeout
* and, adding additional headers

for outgoing requests.

Author: mrashed-dev

CHANGELOG.md

@@ -4,6 +4,7 @@ nylas-python Changelog
 Unreleased
 ----------------
 * Added support for adding custom headers to outgoing requests
+* Added support for overriding various fields of outgoing requests
 * Added support for `provider` field in code exchange response
 * Added clean messages support
 * Added additional webhook triggers

nylas/config.py

@@ -1,4 +1,7 @@
 from enum import Enum
+from typing import TypedDict
+
+from typing_extensions import NotRequired
 
 
 class Region(str, Enum):
@@ -10,6 +13,23 @@ class Region(str, Enum):
     EU = "eu"
 
 
+class RequestOverrides(TypedDict):
+    """
+    Overrides to use for an outgoing request to the Nylas API
+
+    Attributes:
+        api_key: The API key to use for the request.
+        api_uri: The API URI to use for the request.
+        timeout: The timeout to use for the request.
+        headers: Additional headers to include in the request.
+    """
+
+    api_key: NotRequired[str]
+    api_uri: NotRequired[str]
+    timeout: NotRequired[int]
+    headers: NotRequired[dict]
+
+
 DEFAULT_REGION = Region.US
 """ The default Nylas API region. """
 

nylas/handler/api_resources.py

@@ -8,32 +8,50 @@
 
 class ListableApiResource(Resource):
     def list(
-        self, path, response_type, headers=None, query_params=None, request_body=None
+        self,
+        path,
+        response_type,
+        headers=None,
+        query_params=None,
+        request_body=None,
+        overrides=None,
     ) -> ListResponse:
         response_json = self._http_client._execute(
-            "GET", path, headers, query_params, request_body
+            "GET", path, headers, query_params, request_body, overrides=overrides
         )
 
         return ListResponse.from_dict(response_json, response_type)
 
 
 class FindableApiResource(Resource):
     def find(
-        self, path, response_type, headers=None, query_params=None, request_body=None
+        self,
+        path,
+        response_type,
+        headers=None,
+        query_params=None,
+        request_body=None,
+        overrides=None,
     ) -> Response:
         response_json = self._http_client._execute(
-            "GET", path, headers, query_params, request_body
+            "GET", path, headers, query_params, request_body, overrides=overrides
         )
 
         return Response.from_dict(response_json, response_type)
 
 
 class CreatableApiResource(Resource):
     def create(
-        self, path, response_type, headers=None, query_params=None, request_body=None
+        self,
+        path,
+        response_type,
+        headers=None,
+        query_params=None,
+        request_body=None,
+        overrides=None,
     ) -> Response:
         response_json = self._http_client._execute(
-            "POST", path, headers, query_params, request_body
+            "POST", path, headers, query_params, request_body, overrides=overrides
         )
 
         return Response.from_dict(response_json, response_type)
@@ -48,9 +66,10 @@ def update(
         query_params=None,
         request_body=None,
         method="PUT",
+        overrides=None,
     ):
         response_json = self._http_client._execute(
-            method, path, headers, query_params, request_body
+            method, path, headers, query_params, request_body, overrides=overrides
         )
 
         return Response.from_dict(response_json, response_type)
@@ -64,11 +83,12 @@ def destroy(
         headers=None,
         query_params=None,
         request_body=None,
+        overrides=None,
     ):
         if response_type is None:
             response_type = DeleteResponse
 
         response_json = self._http_client._execute(
-            "DELETE", path, headers, query_params, request_body
+            "DELETE", path, headers, query_params, request_body, overrides=overrides
         )
         return response_type.from_dict(response_json)

nylas/handler/http_client.py

@@ -80,23 +80,26 @@ def _execute(
         query_params=None,
         request_body=None,
         data=None,
+        overrides=None,
     ) -> dict:
         request = self._build_request(
-            method, path, headers, query_params, request_body, data
+            method, path, headers, query_params, request_body, data, overrides
         )
+
+        timeout = self.timeout
+        if overrides and overrides.get("timeout"):
+            timeout = overrides["timeout"]
         try:
             response = self.session.request(
                 request["method"],
                 request["url"],
                 headers=request["headers"],
                 json=request_body,
-                timeout=self.timeout,
+                timeout=timeout,
                 data=data,
             )
         except requests.exceptions.Timeout as exc:
-            raise NylasSdkTimeoutError(
-                url=request["url"], timeout=self.timeout
-            ) from exc
+            raise NylasSdkTimeoutError(url=request["url"], timeout=timeout) from exc
 
         return _validate_response(response)
 
@@ -106,14 +109,19 @@ def _execute_download_request(
         headers=None,
         query_params=None,
         stream=False,
+        overrides=None,
     ) -> Union[bytes, Response]:
-        request = self._build_request("GET", path, headers, query_params)
+        request = self._build_request("GET", path, headers, query_params, overrides)
+
+        timeout = self.timeout
+        if overrides and overrides.get("timeout"):
+            timeout = overrides["timeout"]
         try:
             response = self.session.request(
                 request["method"],
                 request["url"],
                 headers=request["headers"],
-                timeout=self.timeout,
+                timeout=timeout,
                 stream=stream,
             )
 
@@ -123,9 +131,7 @@ def _execute_download_request(
 
             return response.content if response.content else None
         except requests.exceptions.Timeout as exc:
-            raise NylasSdkTimeoutError(
-                url=request["url"], timeout=self.timeout
-            ) from exc
+            raise NylasSdkTimeoutError(url=request["url"], timeout=timeout) from exc
 
     def _build_request(
         self,
@@ -135,10 +141,15 @@ def _build_request(
         query_params: dict = None,
         request_body=None,
         data=None,
+        overrides=None,
     ) -> dict:
-        base_url = f"{self.api_server}{path}"
+        api_server = self.api_server
+        if overrides and overrides.get("api_uri"):
+            api_server = overrides["api_uri"]
+
+        base_url = f"{api_server}{path}"
         url = _build_query_params(base_url, query_params) if query_params else base_url
-        headers = self._build_headers(headers, request_body, data)
+        headers = self._build_headers(headers, request_body, data, overrides)
 
         return {
             "method": method,
@@ -147,23 +158,32 @@ def _build_request(
         }
 
     def _build_headers(
-        self, extra_headers: dict = None, response_body=None, data=None
+        self, extra_headers: dict = None, response_body=None, data=None, overrides=None
     ) -> dict:
+        override_headers = {}
+        if overrides and overrides.get("headers"):
+            override_headers = overrides["headers"]
+
         if extra_headers is None:
             extra_headers = {}
 
         major, minor, revision, _, __ = sys.version_info
         user_agent_header = (
             f"Nylas Python SDK {__VERSION__} - {major}.{minor}.{revision}"
         )
+
+        api_key = self.api_key
+        if overrides and overrides.get("api_key"):
+            api_key = overrides["api_key"]
+
         headers = {
             "X-Nylas-API-Wrapper": "python",
             "User-Agent": user_agent_header,
-            "Authorization": f"Bearer {self.api_key}",
+            "Authorization": f"Bearer {api_key}",
         }
         if data is not None and data.content_type is not None:
             headers["Content-type"] = data.content_type
         elif response_body is not None:
             headers["Content-type"] = "application/json"
 
-        return {**headers, **extra_headers}
+        return {**headers, **extra_headers, **override_headers}

nylas/resources/applications.py

@@ -1,3 +1,4 @@
+from nylas.config import RequestOverrides
 from nylas.models.application_details import ApplicationDetails
 from nylas.models.response import Response
 from nylas.resources.redirect_uris import RedirectUris
@@ -22,15 +23,18 @@ def redirect_uris(self) -> RedirectUris:
         """
         return RedirectUris(self._http_client)
 
-    def info(self) -> Response[ApplicationDetails]:
+    def info(self, overrides: RequestOverrides = None) -> Response[ApplicationDetails]:
         """
         Get the application information.
 
+        Args:
+            overrides: The query parameters to include in the request.
+
         Returns:
             Response: The application information.
         """
 
         json_response = self._http_client._execute(
-            method="GET", path="/v3/applications"
+            method="GET", path="/v3/applications", overrides=overrides
         )
         return Response.from_dict(json_response, ApplicationDetails)

nylas/resources/attachments.py

@@ -1,5 +1,6 @@
 from requests import Response
 
+from nylas.config import RequestOverrides
 from nylas.handler.api_resources import (
     FindableApiResource,
 )
@@ -21,6 +22,7 @@ def find(
         identifier: str,
         attachment_id: str,
         query_params: FindAttachmentQueryParams,
+        overrides: RequestOverrides = None,
     ) -> NylasResponse[Attachment]:
         """
         Return metadata of an attachment.
@@ -29,6 +31,7 @@ def find(
             identifier: The identifier of the Grant to act upon.
             attachment_id: The id of the attachment to retrieve.
             query_params: The query parameters to include in the request.
+            overrides: The request overrides to use for the request.
 
         Returns:
             The attachment metadata.
@@ -37,13 +40,15 @@ def find(
             path=f"/v3/grants/{identifier}/attachments/{attachment_id}",
             response_type=Attachment,
             query_params=query_params,
+            overrides=overrides,
         )
 
     def download(
         self,
         identifier: str,
         attachment_id: str,
         query_params: FindAttachmentQueryParams,
+        overrides: RequestOverrides = None,
     ) -> Response:
         """
         Download the attachment data.
@@ -56,6 +61,7 @@ def download(
             identifier: The identifier of the Grant to act upon.
             attachment_id: The id of the attachment to download.
             query_params: The query parameters to include in the request.
+            overrides: The request overrides to use for the request.
 
         Returns:
             The Response object containing the file data.
@@ -78,13 +84,15 @@ def download(
             path=f"/v3/grants/{identifier}/attachments/{attachment_id}/download",
             query_params=query_params,
             stream=True,
+            overrides=overrides,
         )
 
     def download_bytes(
         self,
         identifier: str,
         attachment_id: str,
         query_params: FindAttachmentQueryParams,
+        overrides: RequestOverrides = None,
     ) -> bytes:
         """
         Download the attachment as a byte array.
@@ -93,6 +101,7 @@ def download_bytes(
             identifier: The identifier of the Grant to act upon.
             attachment_id: The id of the attachment to download.
             query_params: The query parameters to include in the request.
+            overrides: The request overrides to use for the request.
 
         Returns:
             The raw file data.
@@ -101,4 +110,5 @@ def download_bytes(
             path=f"/v3/grants/{identifier}/attachments/{attachment_id}/download",
             query_params=query_params,
             stream=False,
+            overrides=overrides,
         )