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

fortisapi/controllers/merchant_deposits_controller.py

@@ -0,0 +1,295 @@
+"""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.or_auth_group import (
+    Or,
+)
+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_deposit import (
+    ResponseMerchantDeposit,
+)
+from fortisapi.models.response_merchant_deposits_collection import (
+    ResponseMerchantDepositsCollection,
+)
+from fortisapi.utilities.union_type_lookup import (
+    UnionTypeLookUp,
+)
+
+
+class MerchantDepositsController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize MerchantDepositsController object."""
+        super(MerchantDepositsController, self).__init__(config)
+
+    def view_single_merchant_deposit(self,
+                                     deposit_id,
+                                     page=None,
+                                     order=None,
+                                     filter_by=None,
+                                     expand=None,
+                                     format=None,
+                                     typeahead=None,
+                                     fields=None,
+                                     export_refunds_negative=None,
+                                     keyword=None):
+        """Perform a GET request to /v1/merchants/deposits/{deposit_id}.
+
+        Args:
+            deposit_id (str): Deposit Id
+            page (Page, optional): Use this field to specify paginate your results,
+                by using page size and number. You can use one of the following
+                methods: >/endpoint?page={ "number": 1, "size": 50 } >
+                >/endpoint?page[number]=1&page[size]=50 >
+            order (List[Order21], optional): Criteria used in query string parameters
+                to order results.  Most fields from the endpoint results can be used
+                as a `key`.  Unsupported fields or operators will return a `412`.
+                Must be encoded, or use syntax that does not require encoding.
+                >`Unsupported values:` bank_name, details.processor_batch_number,
+                details.product_code, details.deposit_detail_type, details.amount,
+                details.memo, details.reported_date, details.settled_date,
+                details.mid >
+                >/endpoint?order[0][key]=created_ts&order[0][operator]=asc >
+                >/endpoint?order=[{ "key": "created_ts", "operator": "asc"}] >
+                >/endpoint?order=[{ "key": "balance", "operator": "desc"},{ "key":
+                "created_ts", "operator": "asc"}] >
+            filter_by (List[FilterBy], optional): Filter criteria that can be used in
+                query string parameters.  Most fields from the endpoint results can
+                be used as a `key`.  Unsupported fields or operators will return a
+                `412`. Must be encoded, or use syntax that does not require encoding.
+                >`Unsupported values:` bank_name, details.processor_batch_number,
+                details.product_code, details.deposit_detail_type, details.amount,
+                details.memo, details.reported_date, details.settled_date,
+                details.mid >
+                >?filter_by[0][key]=first_name&filter_by[0][operator]==&filter_by[0][v
+                alue]=Steve > >/endpoint?filter_by=[{ "key": "first_name",
+                "operator": "=", "value": "Fred" }] > >/endpoint?filter_by=[{ "key":
+                "account_type", "operator": "=", "value": "VISA" }] >
+                >/endpoint?filter_by=[{ "key": "created_ts", "operator": ">=",
+                "value": "946702799" }, { "key": "created_ts", "operator": "<=",
+                value: "1695061891" }] > >/endpoint?filter_by=[{ "key": "last_name",
+                "operator": "IN", "value": "Williams,Brown,Allman" }] >
+            expand (List[Expand15Enum], optional): Most endpoints in the API have a
+                way to retrieve extra data related to the current record being
+                retrieved. For example, if the API request is for the accountvaults
+                endpoint, and the end user also needs to know which contact the token
+                belongs to, this data can be returned in the accountvaults endpoint
+                request.
+            format (Format1Enum, optional): Reporting format, valid values: csv, tsv
+            typeahead (str, optional): You can use any `field_name` from this
+                endpoint results to order the list using the value provided as filter
+                for the same `field_name`. It will be ordered using the following
+                rules: 1) Exact match, 2) Starts with, 3) Contains.
+                >/endpoint?filter={ "field_name": "Value" }&_typeahead=field_name >
+            fields (List[Field37Enum], optional): You can use any `field_name` from
+                this endpoint results to filter the list of fields returned on the
+                response.
+            export_refunds_negative (bool, optional): When true, converts refund
+                amounts to negative values for export formats
+            keyword (str | float | None, optional): You can use any value to search
+                on specific fields of this endpoint results. You can not specify the
+                fields that are used.
+
+        Returns:
+            ResponseMerchantDeposit: 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/deposits/{deposit_id}")
+            .http_method(HttpMethodEnum.GET)
+            .template_param(Parameter()
+                .key("deposit_id")
+                .value(deposit_id)
+                .should_encode(True))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .query_param(Parameter()
+                .key("order")
+                .value(order))
+            .query_param(Parameter()
+                .key("filter_by")
+                .value(filter_by))
+            .query_param(Parameter()
+                .key("expand")
+                .value(expand))
+            .query_param(Parameter()
+                .key("_format")
+                .value(format))
+            .query_param(Parameter()
+                .key("_typeahead")
+                .value(typeahead))
+            .query_param(Parameter()
+                .key("fields")
+                .value(fields))
+            .query_param(Parameter()
+                .key("export_refunds_negative")
+                .value(export_refunds_negative))
+            .query_param(Parameter()
+                .key("keyword")
+                .value(keyword)
+                .validator(lambda value: UnionTypeLookUp
+                    .get("ViewSingleMerchantDepositKeyword").validate(value)))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Or(And(Single("developer-id"),
+                Single("access-token")), And(Single("user-id"),
+                Single("user-api-key"), Single("developer-id")))),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ResponseMerchantDeposit.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()
+
+    def list_all_merchant_deposits(self,
+                                   page=None,
+                                   order=None,
+                                   filter_by=None,
+                                   expand=None,
+                                   format=None,
+                                   typeahead=None,
+                                   fields=None,
+                                   export_refunds_negative=None,
+                                   keyword=None):
+        """Perform a GET request to /v1/merchants/deposits.
+
+        Args:
+            page (Page, optional): Use this field to specify paginate your results,
+                by using page size and number. You can use one of the following
+                methods: >/endpoint?page={ "number": 1, "size": 50 } >
+                >/endpoint?page[number]=1&page[size]=50 >
+            order (List[Order21], optional): Criteria used in query string parameters
+                to order results.  Most fields from the endpoint results can be used
+                as a `key`.  Unsupported fields or operators will return a `412`.
+                Must be encoded, or use syntax that does not require encoding.
+                >`Unsupported values:` bank_name, details.processor_batch_number,
+                details.product_code, details.deposit_detail_type, details.amount,
+                details.memo, details.reported_date, details.settled_date,
+                details.mid >
+                >/endpoint?order[0][key]=created_ts&order[0][operator]=asc >
+                >/endpoint?order=[{ "key": "created_ts", "operator": "asc"}] >
+                >/endpoint?order=[{ "key": "balance", "operator": "desc"},{ "key":
+                "created_ts", "operator": "asc"}] >
+            filter_by (List[FilterBy], optional): Filter criteria that can be used in
+                query string parameters.  Most fields from the endpoint results can
+                be used as a `key`.  Unsupported fields or operators will return a
+                `412`. Must be encoded, or use syntax that does not require encoding.
+                >`Unsupported values:` bank_name, details.processor_batch_number,
+                details.product_code, details.deposit_detail_type, details.amount,
+                details.memo, details.reported_date, details.settled_date,
+                details.mid >
+                >?filter_by[0][key]=first_name&filter_by[0][operator]==&filter_by[0][v
+                alue]=Steve > >/endpoint?filter_by=[{ "key": "first_name",
+                "operator": "=", "value": "Fred" }] > >/endpoint?filter_by=[{ "key":
+                "account_type", "operator": "=", "value": "VISA" }] >
+                >/endpoint?filter_by=[{ "key": "created_ts", "operator": ">=",
+                "value": "946702799" }, { "key": "created_ts", "operator": "<=",
+                value: "1695061891" }] > >/endpoint?filter_by=[{ "key": "last_name",
+                "operator": "IN", "value": "Williams,Brown,Allman" }] >
+            expand (List[Expand15Enum], optional): Most endpoints in the API have a
+                way to retrieve extra data related to the current record being
+                retrieved. For example, if the API request is for the accountvaults
+                endpoint, and the end user also needs to know which contact the token
+                belongs to, this data can be returned in the accountvaults endpoint
+                request.
+            format (Format1Enum, optional): Reporting format, valid values: csv, tsv
+            typeahead (str, optional): You can use any `field_name` from this
+                endpoint results to order the list using the value provided as filter
+                for the same `field_name`. It will be ordered using the following
+                rules: 1) Exact match, 2) Starts with, 3) Contains.
+                >/endpoint?filter={ "field_name": "Value" }&_typeahead=field_name >
+            fields (List[Field37Enum], optional): You can use any `field_name` from
+                this endpoint results to filter the list of fields returned on the
+                response.
+            export_refunds_negative (bool, optional): When true, converts refund
+                amounts to negative values for export formats
+            keyword (str | float | None, optional): You can use any value to search
+                on specific fields of this endpoint results. You can not specify the
+                fields that are used.
+
+        Returns:
+            ResponseMerchantDepositsCollection: 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/deposits")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .query_param(Parameter()
+                .key("order")
+                .value(order))
+            .query_param(Parameter()
+                .key("filter_by")
+                .value(filter_by))
+            .query_param(Parameter()
+                .key("expand")
+                .value(expand))
+            .query_param(Parameter()
+                .key("_format")
+                .value(format))
+            .query_param(Parameter()
+                .key("_typeahead")
+                .value(typeahead))
+            .query_param(Parameter()
+                .key("fields")
+                .value(fields))
+            .query_param(Parameter()
+                .key("export_refunds_negative")
+                .value(export_refunds_negative))
+            .query_param(Parameter()
+                .key("keyword")
+                .value(keyword)
+                .validator(lambda value: UnionTypeLookUp
+                    .get("ListAllMerchantDepositsKeyword").validate(value)))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Or(And(Single("developer-id"),
+                Single("access-token")), And(Single("user-id"),
+                Single("user-api-key"), Single("developer-id")))),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ResponseMerchantDepositsCollection.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()

fortisapi/controllers/merchant_details_controller.py

@@ -0,0 +1,82 @@
+"""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_merchant_details import (
+    ResponseMerchantDetails,
+)
+
+
+class MerchantDetailsController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize MerchantDetailsController object."""
+        super(MerchantDetailsController, self).__init__(config)
+
+    def merchant_details(self,
+                         body):
+        """Perform a POST request to /v1/wallet-provider/merchant-details.
+
+        Merchant Details
+
+        Args:
+            body (V1WalletProviderMerchantDetailsRequest): The request body parameter.
+
+        Returns:
+            ResponseMerchantDetails: 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/merchant-details")
+            .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(ResponseMerchantDetails.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()

fortisapi/controllers/on_boarding_controller.py

@@ -0,0 +1,100 @@
+"""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_onboarding import (
+    ResponseOnboarding,
+)
+
+
+class OnBoardingController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize OnBoardingController object."""
+        super(OnBoardingController, self).__init__(config)
+
+    def merchant_boarding(self,
+                          body):
+        """Perform a POST request to /v1/onboarding.
+
+        This method can be used to pre-populate data on the Merchant Processing
+        Application (MPA), a form that prospective merchants must complete and sign
+        prior to approval. Using this method will reduce the effort required by the
+        merchant at boarding time, in scenarios where data about the prospective
+        merchant has already been collected. This method will return an Application
+        ID, which can be sent to a prospective merchant to obtain and complete the
+        pre-filled application.
+        Properties that are marked "Required" indicate the minimum required data for
+        creating and saving an MPA. When using this method, you must provide data for
+        each "Required" property, or you will not receive an Application ID.
+        Properties that are marked "Required for completion" are those which need to
+        be provided to Fortis before the Merchant Processing Application can be
+        approved. These properties may be omitted or left blank when using this
+        method, however, the merchant will be required to provide this data before
+        the application can be submitted. Properties that are marked "Conditionally
+        Required" may be required for completion of the Merchant Processing
+        Application, depending on the values provided for other fields. See the
+        description for each of these properties for more information about their
+        requirement criteria.
+
+        Args:
+            body (V1OnboardingRequest): The request body parameter.
+
+        Returns:
+            ResponseOnboarding: 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/onboarding")
+            .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(ResponseOnboarding.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()