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

fortis_python_sdk-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fortis_python_sdk-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

fortis_python_sdk-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fortisapi

fortisapi/__init__.py

@@ -0,0 +1,12 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "api_helper",
+    "configuration",
+    "controllers",
+    "exceptions",
+    "fortisapi_client",
+    "http",
+    "models",
+    "utilities",
+]

fortisapi/api_helper.py

@@ -0,0 +1,19 @@
+"""
+fortisapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.utilities.api_helper import ApiHelper as CoreApiHelper
+
+
+class APIHelper(CoreApiHelper):
+    """
+    A Helper Class for various functions associated with API Calls.
+
+    This class contains static methods for operations that need to be
+    performed during API requests. All of the methods inside this class are
+    static methods, there is no need to ever initialise an instance of this
+    class.
+    """

fortisapi/configuration.py

@@ -0,0 +1,294 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+import os
+from enum import Enum
+
+from apimatic_core.http.configurations.http_client_configuration import (
+    HttpClientConfiguration,
+)
+from apimatic_requests_client_adapter.requests_client import (
+    RequestsClient,
+)
+from dotenv import load_dotenv
+
+from fortisapi.http.proxy_settings import ProxySettings
+
+
+class Environment(Enum):
+    """An enum for SDK environments."""
+
+    SANDBOX = 0
+    PRODUCTION = 1
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Convert a value (string or int) to an Environment enum member.
+
+        Args:
+            value (Union[str, int]): The value to convert.
+            default (Environment): The fallback enum member if conversion fails.
+
+        Returns:
+            Environment: Matching enum member or fallback if invalid.
+
+        """
+        if value is None:
+            return default
+
+        # Try to match directly by enum member
+        if isinstance(value, cls):
+            return value
+
+        # Handle integer or string conversion
+        for member in cls:
+            if (str(member.value).lower() == str(value).lower()
+                or member.name.lower() == str(value).lower()):
+                return member
+
+        # Fallback to provided default
+        return default
+
+
+class Server(Enum):
+    """An enum for API servers."""
+
+    DEFAULT = 0
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Convert a value (string or int) to a Server enum member.
+
+        Args:
+            value (Union[str, int]): The value to convert.
+            default (Server): The fallback enum member if conversion fails.
+
+        Returns:
+            Server: Matching enum member or fallback if invalid.
+
+        """
+        if value is None:
+            return default
+
+        # Try to match directly by enum member
+        if isinstance(value, cls):
+            return value
+
+        # Handle integer or string conversion
+        for member in cls:
+            if (str(member.value).lower() == str(value).lower()
+                or member.name.lower() == str(value).lower()):
+                return member
+
+        # Fallback to provided default
+        return default
+
+
+class Configuration(HttpClientConfiguration):
+    """A class used for configuring the SDK by a user."""
+
+    @property
+    def environment(self):
+        """Return current environment."""
+        return self._environment
+
+    @property
+    def user_id_credentials(self):
+        """Return current user_id_credentials."""
+        return self._user_id_credentials
+
+    @property
+    def user_api_key_credentials(self):
+        """Return current user_api_key_credentials."""
+        return self._user_api_key_credentials
+
+    @property
+    def developer_id_credentials(self):
+        """Return current developer_id_credentials."""
+        return self._developer_id_credentials
+
+    @property
+    def access_token_credentials(self):
+        """Return current access_token_credentials."""
+        return self._access_token_credentials
+
+    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):
+        """Initialize Configuration object."""
+        if retry_methods is None:
+            retry_methods = ["GET", "PUT"]
+
+        if retry_statuses is None:
+            retry_statuses = [408, 413, 429, 500, 502, 503, 504, 521,
+                522, 524]
+
+        super().__init__(
+            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,
+        )
+
+        # Current API environment
+        self._environment = environment
+
+        # The object holding Custom Header Signature credentials
+        self._user_id_credentials = user_id_credentials
+
+        # The object holding Custom Header Signature credentials
+        self._user_api_key_credentials = user_api_key_credentials
+
+        # The object holding Custom Header Signature credentials
+        self._developer_id_credentials = developer_id_credentials
+
+        # The object holding Custom Header Signature credentials
+        self._access_token_credentials = access_token_credentials
+
+        # The Http Client to use for making requests.
+        self.set_http_client(self.create_http_client())
+
+    def clone_with(self, http_client_instance=None,
+                   override_http_client_configuration=None, http_call_back=None,
+                   timeout=None, max_retries=None, backoff_factor=None,
+                   retry_statuses=None, retry_methods=None, proxy_settings=None,
+                   environment=None, user_id_credentials=None,
+                   user_api_key_credentials=None, developer_id_credentials=None,
+                   access_token_credentials=None):
+        """Clone configuration with overrides."""
+        http_client_instance = http_client_instance or self.http_client_instance
+        override_http_client_configuration =\
+            (override_http_client_configuration
+            or self.override_http_client_configuration)
+        http_call_back = http_call_back or self.http_callback
+        timeout = timeout or self.timeout
+        max_retries = max_retries or self.max_retries
+        backoff_factor = backoff_factor or self.backoff_factor
+        retry_statuses = retry_statuses or self.retry_statuses
+        retry_methods = retry_methods or self.retry_methods
+        proxy_settings = proxy_settings or self.proxy_settings
+        environment = environment or self.environment
+        user_id_credentials = user_id_credentials or self.user_id_credentials
+        user_api_key_credentials =\
+            (user_api_key_credentials
+            or self.user_api_key_credentials)
+        developer_id_credentials =\
+            (developer_id_credentials
+            or self.developer_id_credentials)
+        access_token_credentials =\
+            (access_token_credentials
+            or self.access_token_credentials)
+        return 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,
+        )
+
+    def create_http_client(self):
+        """Create the HTTP client instance."""
+        return RequestsClient(
+            timeout=self.timeout, max_retries=self.max_retries,
+            backoff_factor=self.backoff_factor, retry_statuses=self.retry_statuses,
+            retry_methods=self.retry_methods,
+            http_client_instance=self.http_client_instance,
+            override_http_client_configuration=self.override_http_client_configuration,
+            response_factory=self.http_response_factory,
+            proxies=self.proxy_settings.to_proxies() if self.proxy_settings else None,
+        )
+
+    # All the environments the SDK can run in
+    environments = {
+        Environment.SANDBOX: {
+            Server.DEFAULT: "https://api.sandbox.fortis.tech",
+        },
+        Environment.PRODUCTION: {
+            Server.DEFAULT: "https://api.fortis.tech",
+        },
+    }
+
+    def get_base_uri(self, server=Server.DEFAULT):
+        """Generate the appropriate base URI for the environment and the server.
+
+        Args:
+            server (Configuration.Server): The server enum for which the base
+            URI is required.
+
+        Returns:
+            String: The base URI.
+
+        """
+        return self.environments[self.environment][server]
+
+    @classmethod
+    def from_environment(cls, dotenv_path=None, **overrides):
+        """Create Configuration object from .env and environment variables.
+
+        Args:
+            dotenv_path (str, optional): Path to the .env file to load.
+             If None, the default .env file is used.
+            **overrides: Optional values overriding setting from environment variables.
+
+        Returns:
+            Configuration: A configuration object populated with the resolved values.
+
+        """
+        # load .env automatically
+        load_dotenv(dotenv_path or None, override=True)
+
+        override_http_client_configuration = os.getenv(
+            "OVERRIDE_HTTP_CLIENT_CONFIGURATION", "false").lower() == "true"
+        timeout = int(os.getenv("TIMEOUT", "60"))
+        max_retries = int(os.getenv("MAX_RETRIES", "0"))
+        backoff_factor = float(os.getenv("BACKOFF_FACTOR", "2"))
+        statuses = os.getenv("RETRY_STATUSES", None)
+        retry_statuses = [int(v.strip()) for v in statuses.split(",")
+                          if v.strip().isdigit()] if statuses else None
+        methods = os.getenv("RETRY_METHODS", None)
+        retry_methods = [v.strip() for v in methods.split(",") if v.strip()]\
+            if methods else None
+        environment = Environment.from_value(
+            os.getenv("ENVIRONMENT"), Environment.SANDBOX)
+
+        from fortisapi.http.auth.access_token import (
+            AccessTokenCredentials,
+        )
+        from fortisapi.http.auth.developer_id import (
+            DeveloperIdCredentials,
+        )
+        from fortisapi.http.auth.user_api_key import (
+            UserApiKeyCredentials,
+        )
+        from fortisapi.http.auth.user_id import UserIdCredentials
+
+        # Preparing default configuration
+        default_config = cls(
+            override_http_client_configuration=override_http_client_configuration,
+            timeout=timeout,
+            max_retries=max_retries,
+            backoff_factor=backoff_factor,
+            retry_statuses=retry_statuses,
+            retry_methods=retry_methods,
+            environment=environment,
+            proxy_settings=ProxySettings.from_environment(),
+            user_id_credentials=UserIdCredentials.from_environment(),
+            user_api_key_credentials=UserApiKeyCredentials.from_environment(),
+            developer_id_credentials=DeveloperIdCredentials.from_environment(),
+            access_token_credentials=AccessTokenCredentials.from_environment(),
+        )
+
+        return default_config.clone_with(**overrides)

fortisapi/controllers/__init__.py

@@ -0,0 +1,40 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "apple_pay_validate_merchant_controller",
+    "async_processing_controller",
+    "base_controller",
+    "batches_controller",
+    "calculate_surcharge_controller",
+    "contacts_controller",
+    "declined_recurring_transactions_controller",
+    "device_terms_controller",
+    "elements_controller",
+    "enterprise_link_redirect_controller",
+    "full_boarding_controller",
+    "level_3_data_controller",
+    "locations_controller",
+    "m_3_ds_authentication_controller",
+    "m_3_ds_transactions_controller",
+    "merchant_deposits_controller",
+    "merchant_details_controller",
+    "on_boarding_controller",
+    "paylinks_controller",
+    "payment_card_reader_token_controller",
+    "quick_invoices_controller",
+    "recurring_controller",
+    "reports_controller",
+    "signatures_controller",
+    "tags_controller",
+    "terminals_controller",
+    "tickets_controller",
+    "tokens_controller",
+    "transaction_ach_retries_controller",
+    "transactions_ach_controller",
+    "transactions_cash_controller",
+    "transactions_credit_card_controller",
+    "transactions_ebt_card_controller",
+    "transactions_read_controller",
+    "transactions_updates_controller",
+    "webhooks_controller",
+]

fortisapi/controllers/apple_pay_validate_merchant_controller.py

@@ -0,0 +1,84 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.and_auth_group import (
+    And,
+)
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from fortisapi.api_helper import APIHelper
+from fortisapi.configuration import Server
+from fortisapi.controllers.base_controller import (
+    BaseController,
+)
+from fortisapi.exceptions.response_401_token_exception import (
+    Response401tokenException,
+)
+from fortisapi.exceptions.response_412_exception import (
+    Response412Exception,
+)
+from fortisapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from fortisapi.models.response_apple_pay_validate_merchant import (
+    ResponseApplePayValidateMerchant,
+)
+
+
+class ApplePayValidateMerchantController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize ApplePayValidateMerchantController object."""
+        super(ApplePayValidateMerchantController, self).__init__(config)
+
+    def apple_pay_validate_merchant(self,
+                                    body):
+        """Perform a POST request to
+        /v1/wallet-provider/apple-pay-validate-merchant.
+
+        Apple Pay Validate Merchant
+
+        Args:
+            body (V1WalletProviderApplePayValidateMerchantRequest): The request body
+                parameter.
+
+        Returns:
+            ResponseApplePayValidateMerchant: Response from the API. Created
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/v1/wallet-provider/apple-pay-validate-merchant")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(And(Single("user-id"), Single("user-api-key"),
+                Single("developer-id"))),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ResponseApplePayValidateMerchant.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()

fortisapi/controllers/async_processing_controller.py

@@ -0,0 +1,78 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.and_auth_group import (
+    And,
+)
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from fortisapi.api_helper import APIHelper
+from fortisapi.configuration import Server
+from fortisapi.controllers.base_controller import (
+    BaseController,
+)
+from fortisapi.exceptions.response_401_token_exception import (
+    Response401tokenException,
+)
+from fortisapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from fortisapi.models.response_async_status import (
+    ResponseAsyncStatus,
+)
+
+
+class AsyncProcessingController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize AsyncProcessingController object."""
+        super(AsyncProcessingController, self).__init__(config)
+
+    def status_check(self,
+                     status_code):
+        """Perform a GET request to /v1/async/status/{status_code}.
+
+        Retrieve the current status for a particular code.
+
+        Args:
+            status_code (uuid|str): A [UUID
+                v4](https://datatracker.ietf.org/doc/html/rfc4122) that's unique for
+                the Async Request
+
+        Returns:
+            ResponseAsyncStatus: Response from the API. OK
+
+        Raises:
+            APIException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/v1/async/status/{status_code}")
+            .http_method(HttpMethodEnum.GET)
+            .template_param(Parameter()
+                .key("status_code")
+                .value(status_code)
+                .should_encode(True))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(And(Single("user-id"), Single("user-api-key"),
+                Single("developer-id"))),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ResponseAsyncStatus.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()

fortisapi/controllers/base_controller.py

@@ -0,0 +1,67 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+from apimatic_core.api_call import ApiCall
+from apimatic_core.types.error_case import ErrorCase
+
+from fortisapi.exceptions.api_exception import (
+    APIException,
+)
+
+
+class BaseController(object):
+    """All controllers inherit from this base class.
+
+    Attributes:
+        config (Configuration): The HttpClient which a specific controller
+            instance will use. By default all the controller objects share
+            the same HttpClient. A user can use his own custom HttpClient
+            as well.
+        http_call_back (HttpCallBack): An object which holds call back
+            methods to be called before and after the execution of an HttpRequest.
+        new_api_call_builder (APICall): Returns the API Call builder instance.
+
+    """
+
+    @staticmethod
+    def user_agent():
+        """Return UserAgent value."""
+        return "APIMATIC 3.0"
+
+    @staticmethod
+    def user_agent_parameters():
+        """Return UserAgentParameters value."""
+        return {
+        }
+
+    @staticmethod
+    def global_errors():
+        """Return GlobalErrors value."""
+        return {
+            "default": ErrorCase()
+                .error_message("HTTP response not OK.")
+                .exception_type(APIException),
+        }
+
+    def __init__(self, config):
+        """Initialize BaseController object."""
+        self._config = config.get_http_client_configuration()
+        self._http_call_back = self.config.http_callback
+        self.api_call = ApiCall(config)
+
+    @property
+    def config(self):
+        """Return Configuration object."""
+        return self._config
+
+    @property
+    def http_call_back(self):
+        """Return HttpCallBack object."""
+        return self._http_call_back
+
+    @property
+    def new_api_call_builder(self):
+        """Return New ApiCallBuilder object."""
+        return self.api_call.new_builder