tesla-api-sdk 1.0.0__py3-none-any.whl

teslafleetmanagementapi/exceptions/__init__.py

@@ -0,0 +1,6 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "api_exception",
+    "oauth_provider_exception",
+]

teslafleetmanagementapi/exceptions/api_exception.py

@@ -0,0 +1,36 @@
+"""teslafleetmanagementapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+
+class ApiException(Exception):
+    """Class that handles HTTP Exceptions when fetching API Endpoints.
+
+    Attributes:
+        response_code (int): The status code of the response.
+        response (HttpResponse): The HttpResponse of the API call.
+
+    """
+
+    def __init__(self,
+                 reason,
+                 response):
+        """Initialize ApiException object.
+
+        Args:
+            reason (string): The reason (or error message) for the Exception
+                to be raised.
+            response (HttpResponse): The HttpResponse of the API call.
+
+        """
+        super(ApiException, self).__init__(reason)
+        self.reason = reason
+        self.response = response
+        self.response_code = response.status_code
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        return (f"{self.__class__.__name__}("
+                f"status_code={self.response_code!s}, "
+                f"message={self.reason!s})")

teslafleetmanagementapi/exceptions/oauth_provider_exception.py

@@ -0,0 +1,75 @@
+"""teslafleetmanagementapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from teslafleetmanagementapi.api_helper import (
+    APIHelper,
+)
+from teslafleetmanagementapi.exceptions.api_exception import (
+    ApiException,
+)
+
+
+class OauthProviderException(ApiException):
+    def __init__(self, reason, response):
+        """Initialize OauthProviderException object.
+
+        Args:
+            reason (string): The reason (or error message) for the Exception
+                to be raised.
+            response (HttpResponse): The HttpResponse of the API call.
+
+        """
+        super(OauthProviderException, self).__init__(reason, response)
+        dictionary = APIHelper.json_deserialize(self.response.text)
+        if isinstance(dictionary, dict):
+            self.unbox(dictionary)
+
+    def unbox(self, dictionary):
+        """Populate the properties of this object by extracting them from a dictionary.
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object as
+            obtained from the deserialization of the server's response. The keys
+            MUST match property names in the API description.
+
+        """
+        self.error =\
+            dictionary.get("error")\
+            if dictionary.get("error")\
+                else None
+        self.error_description =\
+            dictionary.get("error_description")\
+            if dictionary.get("error_description")\
+                else None
+        self.error_uri =\
+            dictionary.get("error_uri")\
+            if dictionary.get("error_uri")\
+                else None
+
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _error=self.error
+        _error_description=(
+            self.error_description
+            if hasattr(self, "error_description")
+            else None
+        )
+        _error_uri=(
+            self.error_uri
+            if hasattr(self, "error_uri")
+            else None
+        )
+        _base_str = super().__str__()
+        _base_str = _base_str[_base_str.find("(") + 1:-1]
+        return (
+            f"{self.__class__.__name__}("
+            f"base_str={_base_str!s}, "
+            f"error={_error!s}, "
+            f"error_description={_error_description!s}, "
+            f"error_uri={_error_uri!s}, "
+            f")"
+        )

teslafleetmanagementapi/http/__init__.py

@@ -0,0 +1,11 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "auth",
+    "http_call_back",
+    "http_client_provider",
+    "http_method_enum",
+    "http_request",
+    "http_response",
+    "proxy_settings",
+]

teslafleetmanagementapi/http/api_response.py

@@ -0,0 +1,67 @@
+
+"""
+teslafleetmanagementapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.http.response.api_response import ApiResponse as CoreApiResponse
+from apimatic_core.http.response.http_response import HttpResponse
+
+
+class ApiResponse(CoreApiResponse):
+    """
+    Represent a processed API response returned by an SDK operation.
+
+    This class wraps the underlying HTTP response and provides convenient
+    access to the response body, headers, and any errors returned by the API.
+    """
+
+    def __init__(self, http_response, body=None, errors=None):
+        """
+        Initialize an ApiResponse instance.
+
+        Args:
+            http_response (HttpResponse): The original HTTP response.
+            body (object | None): The parsed response body.
+            errors (list[str] | None): Any errors returned by the API.
+
+        """
+        super().__init__(http_response, body, errors)
+
+    def __repr__(self):
+        """
+        Return a concise string representation of the response.
+
+        Returns:
+            str: A string identifying the ApiResponse instance.
+
+        """
+        return f"<ApiResponse {self.text}>"
+
+    @classmethod
+    def create(cls, parent_instance):
+        """
+        Create an ApiResponse instance from another response-like object.
+
+        This method is typically used to adapt an internal or intermediate
+        response object into a concrete ApiResponse instance.
+
+        Args:
+            parent_instance: An object containing HTTP response data.
+
+        Returns:
+            ApiResponse: A new ApiResponse instance.
+
+        """
+        return cls(
+            HttpResponse(
+                parent_instance.status_code,
+                parent_instance.reason_phrase,
+                parent_instance.headers,
+                parent_instance.text,
+                parent_instance.request),
+            parent_instance.body,
+            parent_instance.errors,
+        )

teslafleetmanagementapi/http/auth/__init__.py

@@ -0,0 +1,6 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "bearer_auth",
+    "oauth_2",
+]

teslafleetmanagementapi/http/auth/bearer_auth.py

@@ -0,0 +1,103 @@
+
+"""
+teslafleetmanagementapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import os
+
+from apimatic_core.authentication.header_auth import (
+    HeaderAuth,
+)
+
+
+class BearerAuth(HeaderAuth):
+    """
+    An authentication handler that applies `BearerAuth` to
+    outgoing requests. It constructs the required credential values and integrates
+    with the core authentication framework.
+    """
+
+    @property
+    def error_message(self):
+        """Return reason about the authentication failure."""
+        return "BearerAuth: access_token is undefined."
+
+    def __init__(self, auth_credentials_model):
+        """
+        Initialize the authentication handler with credential data.
+
+        Args:
+            auth_credentials_model: The credentials object used to generate
+                the authorization header.
+
+        """
+        self._access_token = auth_credentials_model.access_token \
+            if auth_credentials_model is not None else None
+        auth_params = {}
+        if self._access_token:
+            auth_params = {"Authorization": f"Bearer {self._access_token}"}
+        super().__init__(auth_params=auth_params)
+
+
+class BearerAuthCredentials:
+    """
+    A model for authentication credentials. Provides simple validation,
+    cloning support, and optional construction from environment variables.
+    Suitable as a pattern for other auth models.
+    """
+
+    @property
+    def access_token(self):
+        """
+        The OAuth 2.0 Access Token to use for API requests.
+        """
+        return self._access_token
+
+    def __init__(self, access_token):
+        """
+        Initialize the credentials.
+
+        Args:
+            access_token: The access_token property value to set.
+
+        Raises:
+            ValueError: If any required value is missing.
+
+        """
+        if access_token is None:
+            raise ValueError("access_token cannot be None")
+        self._access_token = access_token
+
+    def clone_with(self, access_token=None):
+        """
+        Return a new instance with optional value overrides.
+
+        Args:
+            access_token: The access_token property value to set.
+
+        """
+        return BearerAuthCredentials(access_token or self.access_token)
+
+    @classmethod
+    def from_environment(cls):
+        """
+        Create credentials from environment variables, if available.
+
+        Returns:
+            A credentials instance or ``None`` if values are missing.
+
+        """
+        access_token = os.getenv(
+            "BEARER_AUTH_ACCESS_TOKEN",
+            None,
+        )
+
+        if (access_token is None):
+            return None
+
+        return cls(
+            access_token=access_token,
+        )

teslafleetmanagementapi/http/auth/oauth_2.py

@@ -0,0 +1,311 @@
+
+"""
+teslafleetmanagementapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import os
+
+from apimatic_core.authentication.header_auth import (
+    HeaderAuth,
+)
+from apimatic_core.utilities.auth_helper import (
+    AuthHelper,
+)
+
+from teslafleetmanagementapi.api_helper import (
+    APIHelper,
+)
+from teslafleetmanagementapi.configuration import (
+    Server,
+)
+from teslafleetmanagementapi.controllers.oauth_authorization_controller import (
+    OauthAuthorizationController,
+)
+from teslafleetmanagementapi.models.oauth_token import (
+    OauthToken,
+)
+
+
+class Oauth2(HeaderAuth):
+    """
+    An authentication handler that applies `AuthorizationCodeAuth` to
+    outgoing requests. It constructs the required credential values and integrates
+    with the core authentication framework.
+    """
+
+    @property
+    def error_message(self):
+        """Return reason about the authentication failure."""
+        return "Oauth2: OAuthToken is undefined or expired."
+
+    def __init__(self, auth_credentials_model, config):
+        """
+        Initialize the authentication handler with credential data.
+
+        Args:
+            auth_credentials_model: The credentials object used to generate
+                the authorization header.
+            config: The configuration instance.
+
+        """
+        self._oauth_client_id = auth_credentials_model.oauth_client_id \
+            if auth_credentials_model is not None else None
+        self._oauth_client_secret = auth_credentials_model.oauth_client_secret \
+            if auth_credentials_model is not None else None
+        self._oauth_redirect_uri = auth_credentials_model.oauth_redirect_uri \
+            if auth_credentials_model is not None else None
+        if auth_credentials_model is not None \
+                and isinstance(auth_credentials_model.oauth_token, OauthToken):
+            self._oauth_token = OauthToken.from_dictionary(
+                APIHelper.to_dictionary(auth_credentials_model.oauth_token))
+        else:
+            self._oauth_token = auth_credentials_model.oauth_token \
+                if auth_credentials_model is not None else None
+        self._config = config
+        self._o_auth_api = OauthAuthorizationController(config)
+        auth_params = {}
+        if (isinstance(self._oauth_token, OauthToken)
+                and hasattr(self._oauth_token, "access_token")):
+            auth_params = {"Authorization": f"Bearer {self._oauth_token.access_token}"}
+        super().__init__(auth_params=auth_params)
+
+    def is_valid(self):
+        """
+        Validate credentials for authentication.
+
+        Returns:
+            bool: True if the credentials are valid, False otherwise.
+
+        """
+        return (self._oauth_token and isinstance(self._oauth_token, OauthToken)
+                and not self.is_token_expired(self._oauth_token))
+
+    def get_authorization_url(self, state=None, additional_params=None):
+        """
+        Build and return an authorization URL. The user is expected to
+        obtain an authorization code from this URL and then call the authorize
+        function with that authorization code.
+
+        Args:
+            state (str): An opaque state string.
+            additional_params (dict): Any additional query parameters
+                to be added to the URL.
+
+        Returns:
+            str: The authorization URL.
+
+        """
+        auth_url = self._config.get_base_uri(Server.AUTH_SERVER)
+        auth_url += "/authorize"
+        query_params = {
+            "response_type": "code",
+            "client_id": self._oauth_client_id,
+            "redirect_uri": self._oauth_redirect_uri,
+        }
+        if state:
+            query_params["state"] = state
+        if additional_params:
+            query_params.update(additional_params)
+        auth_url = APIHelper.append_url_with_query_parameters(auth_url, query_params)
+        return APIHelper.clean_url(auth_url)
+
+    def build_basic_auth_header(self):
+        """
+        Build the basic auth header for endpoints in the
+        OAuth Authorization Controller.
+
+        Returns:
+            str: The value of the Authentication header.
+
+        """
+        encoded = AuthHelper.get_base64_encoded_value(
+            self._oauth_client_id,
+            self._oauth_client_secret,
+        )
+        return f"Basic {encoded}"
+
+    def fetch_token(self, auth_code, additional_params=None):
+        """
+        Execute call to fetch the OAuth token.
+
+        Args:
+            auth_code (str): The authentication code.
+            additional_params (dict):  Any additional form parameters.
+
+        Returns:
+            OAuthToken: The OAuth token.
+
+        """
+        token = self._o_auth_api.request_token_oauth_2(
+            self.build_basic_auth_header(),
+            auth_code,
+            self._oauth_redirect_uri,
+            _optional_form_parameters=additional_params,
+        ).body
+        if hasattr(token, "expires_in"):
+            current_utc_timestamp = AuthHelper.get_current_utc_timestamp()
+            token.expiry = AuthHelper.get_token_expiry(
+                current_utc_timestamp,
+                token.expires_in,
+            )
+        return token
+
+    def is_token_expired(self, oauth_token=None):
+        """
+        Check if OAuth token has expired.
+
+        Args:
+            oauth_token (OauthToken): The OAuth token whose expiry is to be checked.
+
+        Returns:
+            bool: True if OAuth token has expired, False otherwise.
+
+        """
+        if oauth_token is None:
+            return (hasattr(self._oauth_token, "expiry")
+                    and AuthHelper.is_token_expired(
+                        self._oauth_token.expiry))
+
+        return (hasattr(oauth_token, "expiry")
+                and AuthHelper.is_token_expired(
+                    oauth_token.expiry))
+
+    def refresh_token(self, additional_params=None):
+        """
+        Execute call to refresh the OAuth token.
+
+        Args:
+            additional_params (dict):  Any additional form parameters.
+
+        Returns:
+            OAuthToken: The refreshed OAuth token.
+
+        """
+        token = self._o_auth_api.refresh_token_oauth_2(
+            self.build_basic_auth_header(),
+            self._oauth_token.refresh_token,
+            _optional_form_parameters=additional_params,
+        ).body
+        if hasattr(token, "expires_in"):
+            current_utc_timestamp = AuthHelper.get_current_utc_timestamp()
+            token.expiry = AuthHelper.get_token_expiry(
+                current_utc_timestamp,
+                token.expires_in,
+            )
+        return token
+
+
+class Oauth2Credentials:
+    """
+    A model for authentication credentials. Provides simple validation,
+    cloning support, and optional construction from environment variables.
+    Suitable as a pattern for other auth models.
+    """
+
+    @property
+    def oauth_client_id(self):
+        """
+        OAuth 2 Client ID.
+        """
+        return self._oauth_client_id
+
+    @property
+    def oauth_client_secret(self):
+        """
+        OAuth 2 Client Secret.
+        """
+        return self._oauth_client_secret
+
+    @property
+    def oauth_redirect_uri(self):
+        """
+        OAuth 2 Redirection endpoint or Callback Uri.
+        """
+        return self._oauth_redirect_uri
+
+    @property
+    def oauth_token(self):
+        """
+        Object for storing information about the OAuth token.
+        """
+        return self._oauth_token
+
+    def __init__(self, oauth_client_id, oauth_client_secret, oauth_redirect_uri,
+                 oauth_token=None):
+        """
+        Initialize the credentials.
+
+        Args:
+            oauth_client_id: The oauth_client_id property value to set.
+            oauth_client_secret: The oauth_client_secret property value to set.
+            oauth_redirect_uri: The oauth_redirect_uri property value to set.
+            oauth_token: The oauth_token property value to set.
+
+        Raises:
+            ValueError: If any required value is missing.
+
+        """
+        if oauth_client_id is None:
+            raise ValueError("oauth_client_id cannot be None")
+        if oauth_client_secret is None:
+            raise ValueError("oauth_client_secret cannot be None")
+        if oauth_redirect_uri is None:
+            raise ValueError("oauth_redirect_uri cannot be None")
+        self._oauth_client_id = oauth_client_id
+        self._oauth_client_secret = oauth_client_secret
+        self._oauth_redirect_uri = oauth_redirect_uri
+        self._oauth_token = oauth_token
+
+    def clone_with(self, oauth_client_id=None, oauth_client_secret=None,
+                   oauth_redirect_uri=None, oauth_token=None):
+        """
+        Return a new instance with optional value overrides.
+
+        Args:
+            oauth_client_id: The oauth_client_id property value to set.
+            oauth_client_secret: The oauth_client_secret property value to set.
+            oauth_redirect_uri: The oauth_redirect_uri property value to set.
+            oauth_token: The oauth_token property value to set.
+
+        """
+        return Oauth2Credentials(
+            oauth_client_id or self.oauth_client_id,
+            oauth_client_secret or self.oauth_client_secret,
+            oauth_redirect_uri or self.oauth_redirect_uri,
+            oauth_token or self.oauth_token)
+
+    @classmethod
+    def from_environment(cls):
+        """
+        Create credentials from environment variables, if available.
+
+        Returns:
+            A credentials instance or ``None`` if values are missing.
+
+        """
+        oauth_client_id = os.getenv(
+            "OAUTH_2_OAUTH_CLIENT_ID",
+            None,
+        )
+        oauth_client_secret = os.getenv(
+            "OAUTH_2_OAUTH_CLIENT_SECRET",
+            None,
+        )
+        oauth_redirect_uri = os.getenv(
+            "OAUTH_2_OAUTH_REDIRECT_URI",
+            None,
+        )
+
+        if (oauth_client_id is None
+                or oauth_client_secret is None
+                or oauth_redirect_uri is None):
+            return None
+
+        return cls(
+            oauth_client_id=oauth_client_id,
+            oauth_client_secret=oauth_client_secret,
+            oauth_redirect_uri=oauth_redirect_uri,
+        )

teslafleetmanagementapi/http/http_call_back.py

@@ -0,0 +1,20 @@
+
+"""
+teslafleetmanagementapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.http.http_callback import HttpCallBack as CoreHttpCallback
+
+
+class HttpCallBack(CoreHttpCallback):
+    """
+    An interface for the callback to be called before and after the
+    HTTP call for an endpoint is made.
+
+    This class should not be instantiated but should be used as a base class
+    for HttpCallBack classes.
+
+    """

teslafleetmanagementapi/http/http_client_provider.py

@@ -0,0 +1,23 @@
+"""
+ teslafleetmanagementapi
+
+ This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+from abc import ABC
+
+from apimatic_core_interfaces.client.http_client_provider import (
+    HttpClientProvider as CoreHttpClientProvider,
+)
+
+
+class HttpClientProvider(CoreHttpClientProvider, ABC):
+    """
+     Defines a contract for providing HTTP client configuration.
+
+     Classes implementing this interface are expected to supply a configured
+     HTTP session and timeout value that will be used by the SDK's internal
+     HTTP layer when making network requests.
+
+     This allows developers to inject their own custom HTTP clients while
+     maintaining compatibility with the SDK's request/response handling.
+    """

teslafleetmanagementapi/http/http_method_enum.py

@@ -0,0 +1,25 @@
+
+"""
+teslafleetmanagementapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core_interfaces.types.http_method_enum import (
+    HttpMethodEnum as CoreHttpMethodEnum,
+)
+
+
+class HttpMethodEnum(CoreHttpMethodEnum):
+    """
+    Enumeration of an HTTP Method
+
+    Attributes:
+        GET: A GET Request
+        POST: A POST Request
+        PUT: A PUT Request
+        PATCH: A PATCH Request
+        DELETE: A DELETE Request
+
+    """