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

fortisapi/controllers/elements_controller.py

@@ -0,0 +1,129 @@
+"""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_ticket_intention import (
+    ResponseTicketIntention,
+)
+from fortisapi.models.response_transaction_intention import (
+    ResponseTransactionIntention,
+)
+
+
+class ElementsController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize ElementsController object."""
+        super(ElementsController, self).__init__(config)
+
+    def ticket_intention(self,
+                         body):
+        """Perform a POST request to /v1/elements/ticket/intention.
+
+        Elements uses a `TicketIntention` object to represent your intent to tokenize
+        credit card information from a customer.
+
+        Args:
+            body (V1ElementsTicketIntentionRequest): The request body parameter.
+
+        Returns:
+            ResponseTicketIntention: 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/elements/ticket/intention")
+            .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(ResponseTicketIntention.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def transaction_intention(self,
+                              body):
+        """Perform a POST request to /v1/elements/transaction/intention.
+
+        Elements uses a `TransactionIntention` object to represent your intent to
+        collect payment from a customer, tracking charge attempts and payment state
+        changes throughout the process.
+
+        Args:
+            body (V1ElementsTransactionIntentionRequest): The request body parameter.
+
+        Returns:
+            ResponseTransactionIntention: 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/elements/transaction/intention")
+            .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(ResponseTransactionIntention.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()

fortisapi/controllers/enterprise_link_redirect_controller.py

@@ -0,0 +1,81 @@
+"""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_merchant import (
+    ResponseMerchant,
+)
+
+
+class EnterpriseLinkRedirectController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize EnterpriseLinkRedirectController object."""
+        super(EnterpriseLinkRedirectController, self).__init__(config)
+
+    def enterprise_link_redirect_request(self,
+                                         product_transaction_id,
+                                         is_relink=None):
+        """Perform a GET request to
+        /v1/merchants/taptopay/enterprise-link-redirect.
+
+        To register a SoftPos Merchant.
+
+        Args:
+            product_transaction_id (str): Product Transaction ID to be used
+            is_relink (bool, optional): Relink
+
+        Returns:
+            ResponseMerchant: 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/merchants/taptopay/enterprise-link-redirect")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("product_transaction_id")
+                .value(product_transaction_id))
+            .query_param(Parameter()
+                .key("is_relink")
+                .value(is_relink))
+            .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(ResponseMerchant.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()

fortisapi/controllers/full_boarding_controller.py

@@ -0,0 +1,85 @@
+"""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_fullboarding import (
+    ResponseFullboarding,
+)
+
+
+class FullBoardingController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize FullBoardingController object."""
+        super(FullBoardingController, self).__init__(config)
+
+    def merchant_boarding_full(self,
+                               body):
+        """Perform a POST request to /v1/fullboarding.
+
+        This method is used to fully board a merchant to the platform. When using
+        this method, you must provide data for each "Required" property. See the
+        description for each of these properties for more information about their
+        requirement criteria.
+
+        Args:
+            body (V1FullboardingRequest): The request body parameter.
+
+        Returns:
+            ResponseFullboarding: 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/fullboarding")
+            .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(ResponseFullboarding.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()

fortisapi/controllers/level_3_data_controller.py

@@ -0,0 +1,219 @@
+"""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_transaction_level_3 import (
+    ResponseTransactionLevel3,
+)
+from fortisapi.models.response_transaction_level_3_master import (
+    ResponseTransactionLevel3Master,
+)
+from fortisapi.models.response_transaction_level_3_visa import (
+    ResponseTransactionLevel3Visa,
+)
+
+
+class Level3DataController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize Level3DataController object."""
+        super(Level3DataController, self).__init__(config)
+
+    def create_a_new_level_3_entry_for_a_master_card(self,
+                                                     transaction_id,
+                                                     body):
+        """Perform a POST request to
+        /v1/transactions/{transaction_id}/level3/master-card.
+
+        Args:
+            transaction_id (str): Transaction ID
+            body (V1TransactionsLevel3MasterCardRequest): The request body parameter.
+
+        Returns:
+            ResponseTransactionLevel3Master: 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/transactions/{transaction_id}/level3/master-card")
+            .http_method(HttpMethodEnum.POST)
+            .template_param(Parameter()
+                .key("transaction_id")
+                .value(transaction_id)
+                .should_encode(True))
+            .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(ResponseTransactionLevel3Master.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def create_a_new_level_3_entry_for_a_visa(self,
+                                              transaction_id,
+                                              body):
+        """Perform a POST request to
+        /v1/transactions/{transaction_id}/level3/visa.
+
+        Args:
+            transaction_id (str): Transaction ID
+            body (V1TransactionsLevel3VisaRequest): The request body parameter.
+
+        Returns:
+            ResponseTransactionLevel3Visa: 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/transactions/{transaction_id}/level3/visa")
+            .http_method(HttpMethodEnum.POST)
+            .template_param(Parameter()
+                .key("transaction_id")
+                .value(transaction_id)
+                .should_encode(True))
+            .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(ResponseTransactionLevel3Visa.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def delete_a_single_level_3_record(self,
+                                       transaction_id,
+                                       level_3_id):
+        """Perform a DELETE request to
+        /v1/transactions/{transaction_id}/level3/{level3_id}.
+
+        Args:
+            transaction_id (str): Transaction ID
+            level_3_id (str): Level 3 ID
+
+        Returns:
+            ResponseTransactionLevel3: 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/transactions/{transaction_id}/level3/{level3_id}")
+            .http_method(HttpMethodEnum.DELETE)
+            .template_param(Parameter()
+                .key("transaction_id")
+                .value(transaction_id)
+                .should_encode(True))
+            .template_param(Parameter()
+                .key("level3_id")
+                .value(level_3_id)
+                .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(ResponseTransactionLevel3.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()
+
+    def view_single_level_3_record(self,
+                                   transaction_id):
+        """Perform a GET request to
+        /v1/transactions/{transaction_id}/level3/{level3_id?}.
+
+        Args:
+            transaction_id (str): Transaction ID
+
+        Returns:
+            ResponseTransactionLevel3: 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/transactions/{transaction_id}/level3/{level3_id?}")
+            .http_method(HttpMethodEnum.GET)
+            .template_param(Parameter()
+                .key("transaction_id")
+                .value(transaction_id)
+                .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(ResponseTransactionLevel3.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()