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

fortisapi/controllers/reports_controller.py

@@ -0,0 +1,209 @@
+"""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_reporting_reports_cc_settled_transactions_collection import (  # noqa: E501
+    ResponseReportingReportsCCSettledTransactionsCollection,
+)
+from fortisapi.models.response_reporting_reports_chargebacks_collection import (
+    ResponseReportingReportsChargebacksCollection,
+)
+
+
+class ReportsController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize ReportsController object."""
+        super(ReportsController, self).__init__(config)
+
+    def chargeback(self,
+                   filter_by=None,
+                   order=None,
+                   page=None,
+                   format=None,
+                   fields=None):
+        """Perform a GET request to /v1/reporting/reports/chargebacks.
+
+        List of Chargbacks
+
+        Args:
+            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.
+                >?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" }] >
+            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.
+                >/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"}] >
+            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 >
+            format (Format1Enum, optional): Reporting format, valid values: csv, tsv
+            fields (List[Field45Enum], optional): You can use any `field_name` from
+                this endpoint results to filter the list of fields returned on the
+                response.
+
+        Returns:
+            ResponseReportingReportsChargebacksCollection: 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/reporting/reports/chargebacks")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("filter_by")
+                .value(filter_by))
+            .query_param(Parameter()
+                .key("order")
+                .value(order))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .query_param(Parameter()
+                .key("_format")
+                .value(format))
+            .query_param(Parameter()
+                .key("fields")
+                .value(fields))
+            .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(ResponseReportingReportsChargebacksCollection.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()
+
+    def settled_transactions(self,
+                             filter_by=None,
+                             order=None,
+                             page=None,
+                             fields=None,
+                             export_refunds_negative=None,
+                             format=None):
+        """Perform a GET request to
+        /v1/reporting/reports/transactions/cc-settled.
+
+        Settled transactions
+
+        Args:
+            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.
+                >?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" }] >
+            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.
+                >/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"}] >
+            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 >
+            fields (List[Field46Enum], 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): Enable negative refund amounts
+                in exports. Requires _format to be passed.
+            format (Format1Enum, optional): Reporting format, valid values: csv, tsv
+
+        Returns:
+            ResponseReportingReportsCCSettledTransactionsCollection: 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/reporting/reports/transactions/cc-settled")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("filter_by")
+                .value(filter_by))
+            .query_param(Parameter()
+                .key("order")
+                .value(order))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .query_param(Parameter()
+                .key("fields")
+                .value(fields))
+            .query_param(Parameter()
+                .key("export_refunds_negative")
+                .value(export_refunds_negative))
+            .query_param(Parameter()
+                .key("_format")
+                .value(format))
+            .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(ResponseReportingReportsCCSettledTransactionsCollection.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()

fortisapi/controllers/signatures_controller.py

@@ -0,0 +1,249 @@
+"""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_signature import (
+    ResponseSignature,
+)
+from fortisapi.models.response_signatures_collection import (
+    ResponseSignaturesCollection,
+)
+
+
+class SignaturesController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize SignaturesController object."""
+        super(SignaturesController, self).__init__(config)
+
+    def create_a_new_signature_record(self,
+                                      body,
+                                      expand=None):
+        """Perform a POST request to /v1/signatures.
+
+        Args:
+            body (V1SignaturesRequest): The request body parameter.
+            expand (List[Expand34Enum], 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.
+
+        Returns:
+            ResponseSignature: 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/signatures")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body))
+            .query_param(Parameter()
+                .key("expand")
+                .value(expand))
+            .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(ResponseSignature.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def list_all_signatures_record(self,
+                                   page=None,
+                                   order=None,
+                                   filter_by=None,
+                                   expand=None,
+                                   format=None,
+                                   typeahead=None,
+                                   fields=None,
+                                   export_refunds_negative=None):
+        """Perform a GET request to /v1/signatures.
+
+        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.
+                >/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.
+                >?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[Expand34Enum], 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[Field47Enum], 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
+
+        Returns:
+            ResponseSignaturesCollection: 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/signatures")
+            .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))
+            .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(ResponseSignaturesCollection.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()
+
+    def view_single_signature_record(self,
+                                     signature_id,
+                                     expand=None,
+                                     fields=None):
+        """Perform a GET request to /v1/signatures/{signature_id}.
+
+        Args:
+            signature_id (str): Signature ID
+            expand (List[Expand34Enum], 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.
+            fields (List[Field47Enum], optional): You can use any `field_name` from
+                this endpoint results to filter the list of fields returned on the
+                response.
+
+        Returns:
+            ResponseSignature: 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/signatures/{signature_id}")
+            .http_method(HttpMethodEnum.GET)
+            .template_param(Parameter()
+                .key("signature_id")
+                .value(signature_id)
+                .should_encode(True))
+            .query_param(Parameter()
+                .key("expand")
+                .value(expand))
+            .query_param(Parameter()
+                .key("fields")
+                .value(fields))
+            .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(ResponseSignature.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()