fortis-python-sdk 1.0.0__py3-none-any.whl

fortisapi/exceptions/response_412_exception.py

@@ -0,0 +1,109 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+from fortisapi.exceptions.api_exception import (
+    APIException,
+)
+from fortisapi.models.meta import Meta
+
+
+class Response412Exception(APIException):
+    def __init__(self, reason, response):
+        """Initialize Response412Exception object.
+
+        Args:
+            reason (string): The reason (or error message) for the Exception
+                to be raised.
+            response (HttpResponse): The HttpResponse of the API call.
+
+        """
+        super(Response412Exception, 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.mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else None
+        self.id =\
+            dictionary.get("id")\
+            if dictionary.get("id")\
+                else None
+        self.status_code =\
+            dictionary.get("statusCode")\
+            if dictionary.get("statusCode")\
+                else None
+        self.title =\
+            dictionary.get("title")\
+            if dictionary.get("title")\
+                else None
+        self.detail =\
+            dictionary.get("detail")\
+            if dictionary.get("detail")\
+                else None
+        self.meta =\
+            Meta.from_dictionary(
+                dictionary.get("meta"))\
+                if "meta" in dictionary.keys()\
+                else None
+
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _status_code=(
+            self.status_code
+            if hasattr(self, "status_code")
+            else None
+        )
+        _title=(
+            self.title
+            if hasattr(self, "title")
+            else None
+        )
+        _detail=(
+            self.detail
+            if hasattr(self, "detail")
+            else None
+        )
+        _meta=(
+            self.meta
+            if hasattr(self, "meta")
+            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"mtype={_mtype!s}, "
+            f"id={_id!s}, "
+            f"status_code={_status_code!s}, "
+            f"title={_title!s}, "
+            f"detail={_detail!s}, "
+            f"meta={_meta!s}, "
+            f")"
+        )

fortisapi/exceptions/response_error_exception.py

@@ -0,0 +1,109 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+from fortisapi.exceptions.api_exception import (
+    APIException,
+)
+from fortisapi.models.detail_1 import Detail1
+
+
+class ResponseErrorException(APIException):
+    def __init__(self, reason, response):
+        """Initialize ResponseErrorException object.
+
+        Args:
+            reason (string): The reason (or error message) for the Exception
+                to be raised.
+            response (HttpResponse): The HttpResponse of the API call.
+
+        """
+        super(ResponseErrorException, 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.mtype =\
+            dictionary.get("type")\
+            if dictionary.get("type")\
+                else None
+        self.id =\
+            dictionary.get("id")\
+            if dictionary.get("id")\
+                else None
+        self.status_code =\
+            dictionary.get("statusCode")\
+            if dictionary.get("statusCode")\
+                else None
+        self.title =\
+            dictionary.get("title")\
+            if dictionary.get("title")\
+                else None
+        self.detail =\
+            Detail1.from_dictionary(
+                dictionary.get("detail"))\
+                if "detail" in dictionary.keys()\
+                else None
+        self.meta =\
+            dictionary.get("meta")\
+            if dictionary.get("meta")\
+                else None
+
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _mtype=(
+            self.mtype
+            if hasattr(self, "mtype")
+            else None
+        )
+        _id=(
+            self.id
+            if hasattr(self, "id")
+            else None
+        )
+        _status_code=(
+            self.status_code
+            if hasattr(self, "status_code")
+            else None
+        )
+        _title=(
+            self.title
+            if hasattr(self, "title")
+            else None
+        )
+        _detail=(
+            self.detail
+            if hasattr(self, "detail")
+            else None
+        )
+        _meta=(
+            self.meta
+            if hasattr(self, "meta")
+            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"mtype={_mtype!s}, "
+            f"id={_id!s}, "
+            f"status_code={_status_code!s}, "
+            f"title={_title!s}, "
+            f"detail={_detail!s}, "
+            f"meta={_meta!s}, "
+            f")"
+        )

fortisapi/fortisapi_client.py

@@ -0,0 +1,360 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from apimatic_core.configurations.global_configuration import (
+    GlobalConfiguration,
+)
+from apimatic_core.decorators.lazy_property import (
+    LazyProperty,
+)
+
+from fortisapi.configuration import (
+    Configuration,
+    Environment,
+)
+from fortisapi.controllers.apple_pay_validate_merchant_controller import (
+    ApplePayValidateMerchantController,
+)
+from fortisapi.controllers.async_processing_controller import (
+    AsyncProcessingController,
+)
+from fortisapi.controllers.base_controller import (
+    BaseController,
+)
+from fortisapi.controllers.batches_controller import (
+    BatchesController,
+)
+from fortisapi.controllers.calculate_surcharge_controller import (
+    CalculateSurchargeController,
+)
+from fortisapi.controllers.contacts_controller import (
+    ContactsController,
+)
+from fortisapi.controllers.declined_recurring_transactions_controller import (
+    DeclinedRecurringTransactionsController,
+)
+from fortisapi.controllers.device_terms_controller import (
+    DeviceTermsController,
+)
+from fortisapi.controllers.elements_controller import (
+    ElementsController,
+)
+from fortisapi.controllers.enterprise_link_redirect_controller import (
+    EnterpriseLinkRedirectController,
+)
+from fortisapi.controllers.full_boarding_controller import (
+    FullBoardingController,
+)
+from fortisapi.controllers.level_3_data_controller import (
+    Level3DataController,
+)
+from fortisapi.controllers.locations_controller import (
+    LocationsController,
+)
+from fortisapi.controllers.m_3_ds_authentication_controller import (
+    M3DSAuthenticationController,
+)
+from fortisapi.controllers.m_3_ds_transactions_controller import (
+    M3DSTransactionsController,
+)
+from fortisapi.controllers.merchant_deposits_controller import (
+    MerchantDepositsController,
+)
+from fortisapi.controllers.merchant_details_controller import (
+    MerchantDetailsController,
+)
+from fortisapi.controllers.on_boarding_controller import (
+    OnBoardingController,
+)
+from fortisapi.controllers.paylinks_controller import (
+    PaylinksController,
+)
+from fortisapi.controllers.payment_card_reader_token_controller import (
+    PaymentCardReaderTokenController,
+)
+from fortisapi.controllers.quick_invoices_controller import (
+    QuickInvoicesController,
+)
+from fortisapi.controllers.recurring_controller import (
+    RecurringController,
+)
+from fortisapi.controllers.reports_controller import (
+    ReportsController,
+)
+from fortisapi.controllers.signatures_controller import (
+    SignaturesController,
+)
+from fortisapi.controllers.tags_controller import (
+    TagsController,
+)
+from fortisapi.controllers.terminals_controller import (
+    TerminalsController,
+)
+from fortisapi.controllers.tickets_controller import (
+    TicketsController,
+)
+from fortisapi.controllers.tokens_controller import (
+    TokensController,
+)
+from fortisapi.controllers.transaction_ach_retries_controller import (
+    TransactionACHRetriesController,
+)
+from fortisapi.controllers.transactions_ach_controller import (
+    TransactionsACHController,
+)
+from fortisapi.controllers.transactions_cash_controller import (
+    TransactionsCashController,
+)
+from fortisapi.controllers.transactions_credit_card_controller import (
+    TransactionsCreditCardController,
+)
+from fortisapi.controllers.transactions_ebt_card_controller import (
+    TransactionsEBTCardController,
+)
+from fortisapi.controllers.transactions_read_controller import (
+    TransactionsReadController,
+)
+from fortisapi.controllers.transactions_updates_controller import (
+    TransactionsUpdatesController,
+)
+from fortisapi.controllers.webhooks_controller import (
+    WebhooksController,
+)
+from fortisapi.http.auth.access_token import (
+    AccessToken,
+)
+from fortisapi.http.auth.developer_id import (
+    DeveloperId,
+)
+from fortisapi.http.auth.user_api_key import (
+    UserApiKey,
+)
+from fortisapi.http.auth.user_id import UserId
+
+
+class FortisapiClient(object):
+    """Client that provide access to the FortisapiClient APIs."""
+
+    @LazyProperty
+    def async_processing(self):
+        """Provide access to the AsyncProcessingController endpoints."""
+        return AsyncProcessingController(self.global_configuration)
+
+    @LazyProperty
+    def batches(self):
+        """Provide access to the BatchesController endpoints."""
+        return BatchesController(self.global_configuration)
+
+    @LazyProperty
+    def contacts(self):
+        """Provide access to the ContactsController endpoints."""
+        return ContactsController(self.global_configuration)
+
+    @LazyProperty
+    def declined_recurring_transactions(self):
+        """Provide access to the DeclinedRecurringTransactionsController endpoints."""
+        return DeclinedRecurringTransactionsController(self.global_configuration)
+
+    @LazyProperty
+    def device_terms(self):
+        """Provide access to the DeviceTermsController endpoints."""
+        return DeviceTermsController(self.global_configuration)
+
+    @LazyProperty
+    def elements(self):
+        """Provide access to the ElementsController endpoints."""
+        return ElementsController(self.global_configuration)
+
+    @LazyProperty
+    def full_boarding(self):
+        """Provide access to the FullBoardingController endpoints."""
+        return FullBoardingController(self.global_configuration)
+
+    @LazyProperty
+    def locations(self):
+        """Provide access to the LocationsController endpoints."""
+        return LocationsController(self.global_configuration)
+
+    @LazyProperty
+    def m3_ds_authentication(self):
+        """Provide access to the M3DSAuthenticationController endpoints."""
+        return M3DSAuthenticationController(self.global_configuration)
+
+    @LazyProperty
+    def m3_ds_transactions(self):
+        """Provide access to the M3DSTransactionsController endpoints."""
+        return M3DSTransactionsController(self.global_configuration)
+
+    @LazyProperty
+    def merchant_deposits(self):
+        """Provide access to the MerchantDepositsController endpoints."""
+        return MerchantDepositsController(self.global_configuration)
+
+    @LazyProperty
+    def enterprise_link_redirect(self):
+        """Provide access to the EnterpriseLinkRedirectController endpoints."""
+        return EnterpriseLinkRedirectController(self.global_configuration)
+
+    @LazyProperty
+    def on_boarding(self):
+        """Provide access to the OnBoardingController endpoints."""
+        return OnBoardingController(self.global_configuration)
+
+    @LazyProperty
+    def paylinks(self):
+        """Provide access to the PaylinksController endpoints."""
+        return PaylinksController(self.global_configuration)
+
+    @LazyProperty
+    def payment_card_reader_token(self):
+        """Provide access to the PaymentCardReaderTokenController endpoints."""
+        return PaymentCardReaderTokenController(self.global_configuration)
+
+    @LazyProperty
+    def calculate_surcharge(self):
+        """Provide access to the CalculateSurchargeController endpoints."""
+        return CalculateSurchargeController(self.global_configuration)
+
+    @LazyProperty
+    def quick_invoices(self):
+        """Provide access to the QuickInvoicesController endpoints."""
+        return QuickInvoicesController(self.global_configuration)
+
+    @LazyProperty
+    def recurring(self):
+        """Provide access to the RecurringController endpoints."""
+        return RecurringController(self.global_configuration)
+
+    @LazyProperty
+    def reports(self):
+        """Provide access to the ReportsController endpoints."""
+        return ReportsController(self.global_configuration)
+
+    @LazyProperty
+    def signatures(self):
+        """Provide access to the SignaturesController endpoints."""
+        return SignaturesController(self.global_configuration)
+
+    @LazyProperty
+    def tags(self):
+        """Provide access to the TagsController endpoints."""
+        return TagsController(self.global_configuration)
+
+    @LazyProperty
+    def terminals(self):
+        """Provide access to the TerminalsController endpoints."""
+        return TerminalsController(self.global_configuration)
+
+    @LazyProperty
+    def tickets(self):
+        """Provide access to the TicketsController endpoints."""
+        return TicketsController(self.global_configuration)
+
+    @LazyProperty
+    def tokens(self):
+        """Provide access to the TokensController endpoints."""
+        return TokensController(self.global_configuration)
+
+    @LazyProperty
+    def transaction_ach_retries(self):
+        """Provide access to the TransactionACHRetriesController endpoints."""
+        return TransactionACHRetriesController(self.global_configuration)
+
+    @LazyProperty
+    def transactions_ach(self):
+        """Provide access to the TransactionsACHController endpoints."""
+        return TransactionsACHController(self.global_configuration)
+
+    @LazyProperty
+    def transactions_cash(self):
+        """Provide access to the TransactionsCashController endpoints."""
+        return TransactionsCashController(self.global_configuration)
+
+    @LazyProperty
+    def transactions_credit_card(self):
+        """Provide access to the TransactionsCreditCardController endpoints."""
+        return TransactionsCreditCardController(self.global_configuration)
+
+    @LazyProperty
+    def transactions_ebt_card(self):
+        """Provide access to the TransactionsEBTCardController endpoints."""
+        return TransactionsEBTCardController(self.global_configuration)
+
+    @LazyProperty
+    def transactions_read(self):
+        """Provide access to the TransactionsReadController endpoints."""
+        return TransactionsReadController(self.global_configuration)
+
+    @LazyProperty
+    def level_3_data(self):
+        """Provide access to the Level3DataController endpoints."""
+        return Level3DataController(self.global_configuration)
+
+    @LazyProperty
+    def transactions_updates(self):
+        """Provide access to the TransactionsUpdatesController endpoints."""
+        return TransactionsUpdatesController(self.global_configuration)
+
+    @LazyProperty
+    def apple_pay_validate_merchant(self):
+        """Provide access to the ApplePayValidateMerchantController endpoints."""
+        return ApplePayValidateMerchantController(self.global_configuration)
+
+    @LazyProperty
+    def merchant_details(self):
+        """Provide access to the MerchantDetailsController endpoints."""
+        return MerchantDetailsController(self.global_configuration)
+
+    @LazyProperty
+    def webhooks(self):
+        """Provide access to the WebhooksController endpoints."""
+        return WebhooksController(self.global_configuration)
+
+    def __init__(self, http_client_instance=None,
+                 override_http_client_configuration=False, http_call_back=None,
+                 timeout=60, max_retries=0, backoff_factor=2,
+                 retry_statuses=None, retry_methods=None, proxy_settings=None,
+                 environment=Environment.SANDBOX, user_id_credentials=None,
+                 user_api_key_credentials=None, developer_id_credentials=None,
+                 access_token_credentials=None, config=None):
+        """Initialize a new instance of FortisapiClient."""
+        self.config = config or Configuration(
+            http_client_instance=http_client_instance,
+            override_http_client_configuration=override_http_client_configuration,
+            http_call_back=http_call_back, timeout=timeout,
+            max_retries=max_retries, backoff_factor=backoff_factor,
+            retry_statuses=retry_statuses, retry_methods=retry_methods,
+            proxy_settings=proxy_settings, environment=environment,
+            user_id_credentials=user_id_credentials,
+            user_api_key_credentials=user_api_key_credentials,
+            developer_id_credentials=developer_id_credentials,
+            access_token_credentials=access_token_credentials)
+
+        self.global_configuration = GlobalConfiguration(self.config)\
+            .global_errors(BaseController.global_errors())\
+            .base_uri_executor(self.config.get_base_uri)\
+            .user_agent(BaseController.user_agent(),
+                BaseController.user_agent_parameters())
+
+        self.auth_managers = {
+            "user-id": UserId(self.config.user_id_credentials),
+            "user-api-key": UserApiKey(self.config.user_api_key_credentials),
+            "developer-id": DeveloperId(self.config.developer_id_credentials),
+            "access-token": AccessToken(self.config.access_token_credentials),
+        }
+        self.global_configuration =\
+            self.global_configuration.auth_managers(self.auth_managers)
+
+    @classmethod
+    def from_environment(cls, dotenv_path=None, **overrides):
+        """Create a client instance using environment variables.
+
+        Returns:
+            FortisapiClient instance.
+
+        """
+        return cls(config=Configuration
+            .from_environment(dotenv_path=dotenv_path, **overrides))

fortisapi/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",
+]

fortisapi/http/auth/__init__.py

@@ -0,0 +1,8 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "access_token",
+    "developer_id",
+    "user_api_key",
+    "user_id",
+]

fortisapi/http/auth/access_token.py

@@ -0,0 +1,100 @@
+
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import os
+
+from apimatic_core.authentication.header_auth import HeaderAuth
+
+
+class AccessToken(HeaderAuth):
+    """
+    An authentication handler that applies `CustomHeaderAuthentication` 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 "AccessToken: access_token is undefined."
+
+    def __init__(self, auth_model):
+        """
+        Initialize the authentication handler with credential data.
+
+        Args:
+            auth_model: The credentials object used to generate the authorization
+             header.
+
+        """
+        auth_params = {}
+        if auth_model is not None \
+                and auth_model.access_token is not None:
+            auth_params["access-token"] = auth_model.access_token
+        super().__init__(auth_params=auth_params)
+
+
+class AccessTokenCredentials:
+    """
+    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):
+        """
+        Access Token.
+        """
+        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 AccessTokenCredentials(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(
+            "ACCESS_TOKEN_ACCESS_TOKEN",
+            None,
+        )
+
+        if (access_token is None):
+            return None
+
+        return cls(
+            access_token=access_token,
+        )