feat: further type hinting improvements

Author: Evan Sims

openfga_sdk/api/open_fga_api.py

@@ -24,18 +24,22 @@ class OpenFgaApi:
     Do not edit the class manually.
     """
 
-    def __init__(self, api_client=None):
+    def __init__(
+        self,
+        api_client: ApiClient | None = None,
+    ):
         if api_client is None:
             api_client = ApiClient()
+
         self.api_client: ApiClient = api_client
 
         self._oauth2_client = None
+
         if api_client.configuration is not None:
             credentials = api_client.configuration.credentials
+
             if credentials is not None and credentials.method == "client_credentials":
-                self._oauth2_client = OAuth2Client(
-                    credentials, api_client.configuration
-                )
+                self._oauth2_client = OAuth2Client(credentials)
 
         self._telemetry = Telemetry()
 

openfga_sdk/api_client.py

@@ -169,8 +169,9 @@ async def __call_api(
         _request_auth=None,
         _retry_params=None,
         _oauth2_client=None,
-        _telemetry_attributes: dict[TelemetryAttribute, str | bool | int | float]
-        | None = None,
+        _telemetry_attributes: (
+            dict[TelemetryAttribute, str | bool | int | float] | None
+        ) = None,
         _streaming: bool = False,
     ):
         self.configuration.is_valid()
@@ -193,10 +194,9 @@ async def __call_api(
             path_params = self.sanitize_for_serialization(path_params)
             path_params = self.parameters_to_tuples(path_params, collection_formats)
             for k, v in path_params:
-                # specified safe chars, encode everything
-                _k = urllib.parse.quote(str(k), safe=config.safe_chars_for_path_param)
-                _v = urllib.parse.quote(str(v), safe=config.safe_chars_for_path_param)
-                resource_path = resource_path.replace("{" + str(k) + "}", _v)
+                _k = urllib.parse.quote(str(k))
+                _v = urllib.parse.quote(str(v))
+                resource_path = resource_path.replace("{" + str(k) + "}", str(_v))
 
         # query parameters
         if query_params:
@@ -223,19 +223,7 @@ async def __call_api(
             body = self.sanitize_for_serialization(body)
 
         # request url
-        if _host is None:
-            if self.configuration.api_url is not None:
-                url = self.configuration.api_url + resource_path
-            else:
-                url = (
-                    self.configuration.api_scheme
-                    + "://"
-                    + self.configuration.api_host
-                    + resource_path
-                )
-        else:
-            # use server/host defined in path or operation instead
-            url = self.configuration.api_scheme + "://" + _host + resource_path
+        url = self.configuration.api_url + resource_path
 
         max_retry = (
             self.configuration.retry_params.max_retry
@@ -514,8 +502,9 @@ async def call_api(
         _request_auth=None,
         _retry_params=None,
         _oauth2_client=None,
-        _telemetry_attributes: dict[TelemetryAttribute, str | bool | int | float]
-        | None = None,
+        _telemetry_attributes: (
+            dict[TelemetryAttribute, str | bool | int | float] | None
+        ) = None,
         _streaming: bool = False,
     ):
         """Makes the HTTP request (synchronous) and returns deserialized data.

openfga_sdk/client/client.py

@@ -177,14 +177,22 @@ def _get_authorization_model_id(
         Otherwise, return the authorization model ID stored in the client's configuration
         """
         authorization_model_id = self._client_configuration.authorization_model_id
-        if options is not None and "authorization_model_id" in options:
+
+        if (
+            options is not None
+            and "authorization_model_id" in options
+            and type(options["authorization_model_id"]) is str
+        ):
             authorization_model_id = options["authorization_model_id"]
+
         if authorization_model_id is None or authorization_model_id == "":
             return None
+
         if is_well_formed_ulid_string(authorization_model_id) is False:
             raise FgaValidationException(
                 f"authorization_model_id ('{authorization_model_id}') is not in a valid ulid format"
             )
+
         return authorization_model_id
 
     def _get_consistency(

openfga_sdk/client/configuration.py

@@ -10,7 +10,10 @@
 NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT.
 """
 
-from openfga_sdk.configuration import Configuration
+import os
+
+from openfga_sdk.configuration import Configuration, RetryParams
+from openfga_sdk.credentials import CredentialConfiguration
 from openfga_sdk.exceptions import FgaValidationException
 from openfga_sdk.validation import is_well_formed_ulid_string
 
@@ -20,28 +23,27 @@ class ClientConfiguration(Configuration):
     OpenFGA client configuration
     """
 
+    _authorization_model_id: str | None = None
+
     def __init__(
         self,
-        api_scheme="https",
-        api_host=None,
-        store_id=None,
-        credentials=None,
-        retry_params=None,
-        authorization_model_id=None,
-        ssl_ca_cert=None,
-        api_url=None,  # TODO: restructure when removing api_scheme/api_host
-        timeout_millisec: int | None = None,
+        api_url: str,
+        store_id: str | None = None,
+        credentials: CredentialConfiguration | None = None,
+        retry_params: RetryParams | None = None,
+        authorization_model_id: str | None = None,
+        ssl_ca_cert: str | bytes | os.PathLike | None = None,
+        timeout_millisec: int = 300000,
     ):
         super().__init__(
-            api_scheme,
-            api_host,
-            store_id,
-            credentials,
-            retry_params,
-            ssl_ca_cert=ssl_ca_cert,
             api_url=api_url,
+            store_id=store_id,
+            credentials=credentials,
+            retry_params=retry_params,
+            ssl_ca_cert=ssl_ca_cert,
             timeout_millisec=timeout_millisec,
         )
+
         self._authorization_model_id = authorization_model_id
 
     def is_valid(self):
@@ -57,9 +59,9 @@ def is_valid(self):
             )
 
     @property
-    def authorization_model_id(self):
+    def authorization_model_id(self) -> str | None:
         return self._authorization_model_id
 
     @authorization_model_id.setter
-    def authorization_model_id(self, value):
+    def authorization_model_id(self, value: str | None) -> None:
         self._authorization_model_id = value