worldpay-apimatic-sdk 0.0.1__py3-none-any.whl

reportingauthorizationsummaryapi/__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",
+    "reportingauthorizationsummaryapi_client",
+    "utilities",
+]

reportingauthorizationsummaryapi/api_helper.py

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

reportingauthorizationsummaryapi/apis/__init__.py

@@ -0,0 +1,6 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "authorizations_api",
+    "base_api",
+]

reportingauthorizationsummaryapi/apis/authorizations_api.py

@@ -0,0 +1,496 @@
+"""reportingauthorizationsummaryapi.
+
+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 reportingauthorizationsummaryapi.api_helper import (
+    APIHelper,
+)
+from reportingauthorizationsummaryapi.apis.base_api import (
+    BaseApi,
+)
+from reportingauthorizationsummaryapi.configuration import (
+    Server,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_0_error_exception import (  # noqa: E501
+    AuthorizationsSummary0ErrorException,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_cardnetwork_0_error_exception import (  # noqa: E501
+    AuthorizationsSummaryCardnetwork0ErrorException,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_chain_0_error_exception import (  # noqa: E501
+    AuthorizationsSummaryChain0ErrorException,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_division_0_error_exception import (  # noqa: E501
+    AuthorizationsSummaryDivision0ErrorException,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_merchant_0_error_exception import (  # noqa: E501
+    AuthorizationsSummaryMerchant0ErrorException,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_store_0_error_exception import (  # noqa: E501
+    AuthorizationsSummaryStore0ErrorException,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_superchain_0_error_exception import (  # noqa: E501
+    AuthorizationsSummarySuperchain0ErrorException,
+)
+from reportingauthorizationsummaryapi.exceptions.authorizations_summary_transactiondate_0_error_exception import (  # noqa: E501
+    AuthorizationsSummaryTransactiondate0ErrorException,
+)
+from reportingauthorizationsummaryapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from reportingauthorizationsummaryapi.models.authorizations_summary_cardnetwork_response import (  # noqa: E501
+    AuthorizationsSummaryCardnetworkResponse,
+)
+from reportingauthorizationsummaryapi.models.authorizations_summary_transactiondate_response import (  # noqa: E501
+    AuthorizationsSummaryTransactiondateResponse,
+)
+from reportingauthorizationsummaryapi.models.summary_detail_chain import (
+    SummaryDetailChain,
+)
+from reportingauthorizationsummaryapi.models.summary_detail_division import (
+    SummaryDetailDivision,
+)
+from reportingauthorizationsummaryapi.models.summary_detail_merchant import (
+    SummaryDetailMerchant,
+)
+from reportingauthorizationsummaryapi.models.summary_detail_store import (
+    SummaryDetailStore,
+)
+from reportingauthorizationsummaryapi.models.summary_detail_super_chain import (
+    SummaryDetailSuperChain,
+)
+from reportingauthorizationsummaryapi.models.summary_responses import (
+    SummaryResponses,
+)
+
+
+class AuthorizationsApi(BaseApi):
+    """A Controller to access Endpoints in the reportingauthorizationsummaryapi API."""
+
+    def __init__(self, config):
+        """Initialize AuthorizationsApi object."""
+        super(AuthorizationsApi, self).__init__(config)
+
+    def get_authorizations_summary(self,
+                                   body,
+                                   v_correlation_id=None):
+        """Perform a POST request to /authorizations/summary.
+
+        Resource to get the total summary of authorizations for a given hierarchy and
+        date range with card type and card network being optional parameters. Refer
+        to the  schema object for the allowed hierarchies and specifications.
+
+        Args:
+            body (AuthTransactionsRequest): 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("/authorizations/summary")
+            .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(SummaryResponses.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummary0ErrorException),
+        ).execute()
+
+    def get_authorizations_summary_by_card_network(self,
+                                                   v_correlation_id=None,
+                                                   body=None):
+        """Perform a POST request to /authorizations/summary/cardnetwork.
+
+        Resource to get the summary of authorizations grouped by card networks for a
+        given hierarchy and date range with card type and card network being optional
+        parameters. Refer to the schema object for the allowed hierarchies and
+        specifications.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+            body (AuthTransactionsSummaryRequestByCardNetwork, optional): The request
+                body parameter.
+
+        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("/authorizations/summary/cardnetwork")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .body_param(Parameter()
+                .value(body))
+            .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(AuthorizationsSummaryCardnetworkResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummaryCardnetwork0ErrorException),
+        ).execute()
+
+    def get_authorizations_summaryby_transaction_date(self,
+                                                      v_correlation_id=None,
+                                                      body=None):
+        """Perform a POST request to /authorizations/summary/transactiondate.
+
+        Resource to get the summary of authorizations grouped by transaction dates
+        for a given hierarchy and date range with card type and card network being
+        optional parameters. Refer to the schema object for the allowed hierarchies
+        and specifications.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+            body (AuthTransactionsSummaryRequestByTransactionDate, optional): The
+                request body parameter.
+
+        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("/authorizations/summary/transactiondate")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .body_param(Parameter()
+                .value(body))
+            .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(AuthorizationsSummaryTransactiondateResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummaryTransactiondate0ErrorException),
+        ).execute()
+
+    def get_authorizations_summaryby_merchant(self,
+                                              v_correlation_id=None,
+                                              body=None):
+        """Perform a POST request to /authorizations/summary/merchant.
+
+        Resource to get the summary of authorizations for given parameters grouped by
+        merchants for a given hierarchy and date range with card type and card
+        network being optional parameters. Refer to the schema object for the allowed
+        hierarchies and specifications.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+            body (AuthTransactionsSummaryRequestByMerchant, optional): The request
+                body parameter.
+
+        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("/authorizations/summary/merchant")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .body_param(Parameter()
+                .value(body))
+            .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(SummaryDetailMerchant.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummaryMerchant0ErrorException),
+        ).execute()
+
+    def get_authorizations_summaryby_division(self,
+                                              v_correlation_id=None,
+                                              body=None):
+        """Perform a POST request to /authorizations/summary/division.
+
+        Resource to get the summary of authorizations grouped by divisions for a
+        given hierarchy and date range with card type and card network being optional
+        parameters. Refer to the schema object for the allowed hierarchies and
+        specifications.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+            body (AuthTransactionsRequestByDivision, optional): The request body
+                parameter.
+
+        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("/authorizations/summary/division")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .body_param(Parameter()
+                .value(body))
+            .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(SummaryDetailDivision.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummaryDivision0ErrorException),
+        ).execute()
+
+    def get_authorizations_summaryby_store(self,
+                                           v_correlation_id=None,
+                                           body=None):
+        """Perform a POST request to /authorizations/summary/store.
+
+        Resource to get the summary of authorizations grouped by stores for a given
+        hierarchy and date range with card type and card network being optional
+        parameters. Refer to the schema object for the allowed hierarchies and
+        specifications.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+            body (AuthTransactionsRequestByStore, optional): The request body
+                parameter.
+
+        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("/authorizations/summary/store")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .body_param(Parameter()
+                .value(body))
+            .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(SummaryDetailStore.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummaryStore0ErrorException),
+        ).execute()
+
+    def get_authorizations_summaryby_chain(self,
+                                           v_correlation_id=None,
+                                           body=None):
+        """Perform a POST request to /authorizations/summary/chain.
+
+        Resource to get the summary of authorizations grouped by chains for a given
+        hierarchy and date range with card type and card network being optional
+        parameters. Refer to the schema object for the allowed hierarchies and
+        specifications.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+            body (AuthTransactionsRequestByChain, optional): The request body
+                parameter.
+
+        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("/authorizations/summary/chain")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .body_param(Parameter()
+                .value(body))
+            .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(SummaryDetailChain.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummaryChain0ErrorException),
+        ).execute()
+
+    def get_authorizations_summaryby_super_chain(self,
+                                                 v_correlation_id=None,
+                                                 body=None):
+        """Perform a POST request to /authorizations/summary/superchain.
+
+        Resource to get the summary of authorizations grouped by superchains for a
+        given hierarchy and date range with card type and card network being optional
+        parameters. Refer to the schema object for the allowed hierarchies and
+        specifications.
+
+        Args:
+            v_correlation_id (uuid|str, optional): Correlation Id
+            body (AuthTransactionsRequestBySuperChain, optional): The request body
+                parameter.
+
+        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("/authorizations/summary/superchain")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .header_param(Parameter()
+                .key("v-correlation-id")
+                .value(v_correlation_id))
+            .body_param(Parameter()
+                .value(body))
+            .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(SummaryDetailSuperChain.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Default errors",
+                AuthorizationsSummarySuperchain0ErrorException),
+        ).execute()

reportingauthorizationsummaryapi/apis/base_api.py

@@ -0,0 +1,72 @@
+"""reportingauthorizationsummaryapi.
+
+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 reportingauthorizationsummaryapi.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/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})"
+
+    @staticmethod
+    def user_agent_parameters():
+        """Return UserAgentParameters value."""
+        return {
+            "engine": {"value": platform.python_implementation(), "encode": False},
+            "engine-version": {"value": platform.python_version(), "encode": False},
+            "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