wp-sdk 1.0.0__py3-none-any.whl

reportingsettlementresearchapi/__init__.py

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

reportingsettlementresearchapi/api_helper.py

@@ -0,0 +1,19 @@
+"""
+reportingsettlementresearchapi
+
+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.
+    """

reportingsettlementresearchapi/apis/__init__.py

@@ -0,0 +1,11 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "base_api",
+    "settlement_batches_api",
+    "settlement_daily_totals_api",
+    "settlement_errors_api",
+    "settlements_api",
+    "transaction_status_api",
+    "transaction_type_api",
+]

reportingsettlementresearchapi/apis/base_api.py

@@ -0,0 +1,70 @@
+"""reportingsettlementresearchapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+import platform
+
+from apimatic_core.api_call import ApiCall
+from apimatic_core.types.error_case import ErrorCase
+
+from reportingsettlementresearchapi.exceptions.api_exception import (
+    ApiException,
+)
+
+
+class BaseApi(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 "Python SDK, Version: 1.0.0, on OS {os-info}"
+
+    @staticmethod
+    def user_agent_parameters():
+        """Return UserAgentParameters value."""
+        return {
+            "os-info": {"value": platform.system(), "encode": False},
+        }
+
+    @staticmethod
+    def global_errors():
+        """Return GlobalErrors value."""
+        return {
+            "default": ErrorCase()
+                .error_message("HTTP response not OK.")
+                .exception_type(ApiException),
+        }
+
+    def __init__(self, config):
+        """Initialize BaseApi 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

reportingsettlementresearchapi/apis/settlement_batches_api.py

@@ -0,0 +1,139 @@
+"""reportingsettlementresearchapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+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 reportingsettlementresearchapi.api_helper import (
+    APIHelper,
+)
+from reportingsettlementresearchapi.apis.base_api import (
+    BaseApi,
+)
+from reportingsettlementresearchapi.configuration import (
+    Server,
+)
+from reportingsettlementresearchapi.exceptions.search_date_0_error_exception import (
+    SearchDate0ErrorException,
+)
+from reportingsettlementresearchapi.exceptions.search_store_0_error_exception import (
+    SearchStore0ErrorException,
+)
+from reportingsettlementresearchapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from reportingsettlementresearchapi.models.search_date_response import (
+    SearchDateResponse,
+)
+from reportingsettlementresearchapi.models.search_store_response import (
+    SearchStoreResponse,
+)
+
+
+class SettlementBatchesApi(BaseApi):
+    """A Controller to access Endpoints in the reportingsettlementresearchapi API."""
+
+    def __init__(self, config):
+        """Initialize SettlementBatchesApi object."""
+        super(SettlementBatchesApi, self).__init__(config)
+
+    def search_settlement_batches_store(self,
+                                        body,
+                                        v_correlation_id=None):
+        """Perform a POST request to /search/store.
+
+        Search settlement batches grouped by store.
+
+        Args:
+            body (SearchStoreRequest): The request body parameter.
+            v_correlation_id (uuid|str, optional): Correlation Id
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. 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("/search/store")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(Single("api_key")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(SearchStoreResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default", "Default errors", SearchStore0ErrorException),
+        ).execute()
+
+    def search_settlement_batches_date(self,
+                                       body,
+                                       v_correlation_id=None):
+        """Perform a POST request to /search/date.
+
+        Search settlement batches grouped by date.
+
+        Args:
+            body (SearchDateRequest): The request body parameter.
+            v_correlation_id (uuid|str, optional): Correlation Id
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. 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("/search/date")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(Single("api_key")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(SearchDateResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default", "Default errors", SearchDate0ErrorException),
+        ).execute()

reportingsettlementresearchapi/apis/settlement_daily_totals_api.py

@@ -0,0 +1,89 @@
+"""reportingsettlementresearchapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+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 reportingsettlementresearchapi.api_helper import (
+    APIHelper,
+)
+from reportingsettlementresearchapi.apis.base_api import (
+    BaseApi,
+)
+from reportingsettlementresearchapi.configuration import (
+    Server,
+)
+from reportingsettlementresearchapi.exceptions.settlements_daily_totals_search_0_error_exception import (  # noqa: E501
+    SettlementsDailyTotalsSearch0ErrorException,
+)
+from reportingsettlementresearchapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from reportingsettlementresearchapi.models.settlements_daily_totals_search_response import (  # noqa: E501
+    SettlementsDailyTotalsSearchResponse,
+)
+
+
+class SettlementDailyTotalsApi(BaseApi):
+    """A Controller to access Endpoints in the reportingsettlementresearchapi API."""
+
+    def __init__(self, config):
+        """Initialize SettlementDailyTotalsApi object."""
+        super(SettlementDailyTotalsApi, self).__init__(config)
+
+    def search_settlements_daily_totals(self,
+                                        body,
+                                        v_correlation_id=None):
+        """Perform a POST request to /settlements/daily-totals/search.
+
+        Retrieve the settled transactions daily financial activity for a given
+        hierarchy and date range. Optional fields help refine the search.
+
+        Args:
+            body (SettlementsDailyTotalsSearchRequest): The request body parameter.
+            v_correlation_id (uuid|str, optional): Correlation Id
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. 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("/settlements/daily-totals/search")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(Single("api_key")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(SettlementsDailyTotalsSearchResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                SettlementsDailyTotalsSearch0ErrorException),
+        ).execute()

reportingsettlementresearchapi/apis/settlement_errors_api.py

@@ -0,0 +1,147 @@
+"""reportingsettlementresearchapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+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 reportingsettlementresearchapi.api_helper import (
+    APIHelper,
+)
+from reportingsettlementresearchapi.apis.base_api import (
+    BaseApi,
+)
+from reportingsettlementresearchapi.configuration import (
+    Server,
+)
+from reportingsettlementresearchapi.exceptions.settlementerrors_pendingsettlementbatches_search_0_error_exception import (  # noqa: E501
+    SettlementerrorsPendingsettlementbatchesSearch0ErrorException,
+)
+from reportingsettlementresearchapi.exceptions.settlementerrors_settlementfileerrors_search_0_error_exception import (  # noqa: E501
+    SettlementerrorsSettlementfileerrorsSearch0ErrorException,
+)
+from reportingsettlementresearchapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from reportingsettlementresearchapi.models.settlementerrors_pendingsettlementbatches_search_response import (  # noqa: E501
+    SettlementerrorsPendingsettlementbatchesSearchResponse,
+)
+from reportingsettlementresearchapi.models.settlementerrors_settlementfileerrors_search_response import (  # noqa: E501
+    SettlementerrorsSettlementfileerrorsSearchResponse,
+)
+
+
+class SettlementErrorsApi(BaseApi):
+    """A Controller to access Endpoints in the reportingsettlementresearchapi API."""
+
+    def __init__(self, config):
+        """Initialize SettlementErrorsApi object."""
+        super(SettlementErrorsApi, self).__init__(config)
+
+    def search_settlement_rejects(self,
+                                  body,
+                                  v_correlation_id=None):
+        """Perform a POST request to
+        /settlementerrors/settlementfileerrors/search.
+
+        Search settlement rejections.
+
+        Args:
+            body (SettlementerrorsSettlementfileerrorsSearchRequest): The request
+                body parameter.
+            v_correlation_id (uuid|str, optional): Correlation Id
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. 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("/settlementerrors/settlementfileerrors/search")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(Single("api_key")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(SettlementerrorsSettlementfileerrorsSearchResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                SettlementerrorsSettlementfileerrorsSearch0ErrorException),
+        ).execute()
+
+    def search_bank_card_rejects(self,
+                                 body,
+                                 v_correlation_id=None):
+        """Perform a POST request to
+        /settlementerrors/pendingsettlementbatches/search.
+
+        Search bank card rejections.
+
+        Args:
+            body (SettlementerrorsPendingsettlementbatchesSearchRequest): The request
+                body parameter.
+            v_correlation_id (uuid|str, optional): Correlation Id
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. 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("/settlementerrors/pendingsettlementbatches/search")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(Single("api_key")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(SettlementerrorsPendingsettlementbatchesSearchResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                SettlementerrorsPendingsettlementbatchesSearch0ErrorException),
+        ).execute()

reportingsettlementresearchapi/apis/settlements_api.py

@@ -0,0 +1,90 @@
+"""reportingsettlementresearchapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+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 reportingsettlementresearchapi.api_helper import (
+    APIHelper,
+)
+from reportingsettlementresearchapi.apis.base_api import (
+    BaseApi,
+)
+from reportingsettlementresearchapi.configuration import (
+    Server,
+)
+from reportingsettlementresearchapi.exceptions.settlements_search_0_error_exception import (  # noqa: E501
+    SettlementsSearch0ErrorException,
+)
+from reportingsettlementresearchapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from reportingsettlementresearchapi.models.settlements_search_response import (
+    SettlementsSearchResponse,
+)
+
+
+class SettlementsApi(BaseApi):
+    """A Controller to access Endpoints in the reportingsettlementresearchapi API."""
+
+    def __init__(self, config):
+        """Initialize SettlementsApi object."""
+        super(SettlementsApi, self).__init__(config)
+
+    def search_settlements(self,
+                           body,
+                           v_correlation_id=None):
+        """Perform a POST request to /settlements/search.
+
+        Endpoint to retrieve the settled transaction details for a given hierarchy
+        and date range, with a 45-day limit and unrestricted lookup period. Optional
+        fields help refine the search.
+
+        Args:
+            body (SettlementsSearchRequest): The request body parameter.
+            v_correlation_id (uuid|str, optional): Correlation Id
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. 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("/settlements/search")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(Single("api_key")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(SettlementsSearchResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                SettlementsSearch0ErrorException),
+        ).execute()

reportingsettlementresearchapi/apis/transaction_status_api.py

@@ -0,0 +1,81 @@
+"""reportingsettlementresearchapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+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 reportingsettlementresearchapi.api_helper import (
+    APIHelper,
+)
+from reportingsettlementresearchapi.apis.base_api import (
+    BaseApi,
+)
+from reportingsettlementresearchapi.configuration import (
+    Server,
+)
+from reportingsettlementresearchapi.exceptions.transaction_statuses_0_error_exception import (  # noqa: E501
+    TransactionStatuses0ErrorException,
+)
+from reportingsettlementresearchapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from reportingsettlementresearchapi.models.transaction_status_code import (
+    TransactionStatusCode,
+)
+
+
+class TransactionStatusApi(BaseApi):
+    """A Controller to access Endpoints in the reportingsettlementresearchapi API."""
+
+    def __init__(self, config):
+        """Initialize TransactionStatusApi object."""
+        super(TransactionStatusApi, self).__init__(config)
+
+    def get_transaction_status(self,
+                               v_correlation_id=None):
+        """Perform a GET request to /transaction-statuses.
+
+        Indicates the current state of a financial transaction, whether it's pending,
+        completed, failed, or under review.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Transaction status code
+                and description.
+
+        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("/transaction-statuses")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("api_key")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(TransactionStatusCode.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                TransactionStatuses0ErrorException),
+        ).execute()