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

fortisapi/controllers/webhooks_controller.py

@@ -0,0 +1,493 @@
+"""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_webhook import (
+    ResponseWebhook,
+)
+
+
+class WebhooksController(BaseController):
+    """A Controller to access Endpoints in the fortisapi API."""
+
+    def __init__(self, config):
+        """Initialize WebhooksController object."""
+        super(WebhooksController, self).__init__(config)
+
+    def create_a_new_apm_onboarding_postback_config(self,
+                                                    body,
+                                                    expand=None):
+        """Perform a POST request to /v1/webhooks/apm-onboarding.
+
+        Args:
+            body (V1WebhooksApmOnboardingRequest): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/apm-onboarding")
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def create_a_new_transaction_batch_postback_config(self,
+                                                       body,
+                                                       expand=None):
+        """Perform a POST request to /v1/webhooks/batch.
+
+        Args:
+            body (V1WebhooksBatchRequest): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/batch")
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def create_a_new_contact_postback_config(self,
+                                             body,
+                                             expand=None):
+        """Perform a POST request to /v1/webhooks/contact.
+
+        Args:
+            body (V1WebhooksContactRequest): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/contact")
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def create_a_new_transaction_postback_config(self,
+                                                 body,
+                                                 expand=None):
+        """Perform a POST request to /v1/webhooks/transaction.
+
+        Args:
+            body (V1WebhooksTransactionRequest): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/transaction")
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def delete_a_postback_config(self,
+                                 webhook_id):
+        """Perform a DELETE request to /v1/webhooks/{webhook_id}.
+
+        Args:
+            webhook_id (str): Postback Config ID
+
+        Returns:
+            ResponseWebhook: Response from the API. No Content
+
+        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/webhooks/{webhook_id}")
+            .http_method(HttpMethodEnum.DELETE)
+            .template_param(Parameter()
+                .key("webhook_id")
+                .value(webhook_id)
+                .should_encode(True))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(And(Single("user-id"), Single("user-api-key"),
+                Single("developer-id"))),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException),
+        ).execute()
+
+    def update_apm_onboarding_postback_config(self,
+                                              webhook_id,
+                                              body,
+                                              expand=None):
+        """Perform a PATCH request to /v1/webhooks/{webhook_id}/apm-onboarding.
+
+        Args:
+            webhook_id (str): Postback Config ID
+            body (V1WebhooksApmOnboardingRequest1): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/{webhook_id}/apm-onboarding")
+            .http_method(HttpMethodEnum.PATCH)
+            .template_param(Parameter()
+                .key("webhook_id")
+                .value(webhook_id)
+                .should_encode(True))
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def update_transaction_batch_postback_config(self,
+                                                 webhook_id,
+                                                 body,
+                                                 expand=None):
+        """Perform a PATCH request to /v1/webhooks/{webhook_id}/batch.
+
+        Args:
+            webhook_id (str): Postback Config ID
+            body (V1WebhooksBatchRequest1): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/{webhook_id}/batch")
+            .http_method(HttpMethodEnum.PATCH)
+            .template_param(Parameter()
+                .key("webhook_id")
+                .value(webhook_id)
+                .should_encode(True))
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def update_contact_postback_config(self,
+                                       webhook_id,
+                                       body,
+                                       expand=None):
+        """Perform a PATCH request to /v1/webhooks/{webhook_id}/contact.
+
+        Args:
+            webhook_id (str): Postback Config ID
+            body (V1WebhooksContactRequest1): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/{webhook_id}/contact")
+            .http_method(HttpMethodEnum.PATCH)
+            .template_param(Parameter()
+                .key("webhook_id")
+                .value(webhook_id)
+                .should_encode(True))
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()
+
+    def update_transaction_postback_config(self,
+                                           webhook_id,
+                                           body,
+                                           expand=None):
+        """Perform a PATCH request to /v1/webhooks/{webhook_id}/transaction.
+
+        Args:
+            webhook_id (str): Postback Config ID
+            body (V1WebhooksTransactionRequest1): The request body parameter.
+            expand (List[Expand108Enum], 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:
+            ResponseWebhook: 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/webhooks/{webhook_id}/transaction")
+            .http_method(HttpMethodEnum.PATCH)
+            .template_param(Parameter()
+                .key("webhook_id")
+                .value(webhook_id)
+                .should_encode(True))
+            .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(ResponseWebhook.from_dictionary)
+            .local_error("401", "Unauthorized", Response401tokenException)
+            .local_error("412", "Precondition Failed", Response412Exception),
+        ).execute()

fortisapi/exceptions/__init__.py

@@ -0,0 +1,8 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "api_exception",
+    "response_401_token_exception",
+    "response_412_exception",
+    "response_error_exception",
+]

fortisapi/exceptions/api_exception.py

@@ -0,0 +1,36 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+
+class APIException(Exception):
+    """Class that handles HTTP Exceptions when fetching API Endpoints.
+
+    Attributes:
+        response_code (int): The status code of the response.
+        response (HttpResponse): The HttpResponse of the API call.
+
+    """
+
+    def __init__(self,
+                 reason,
+                 response):
+        """Initialize APIException object.
+
+        Args:
+            reason (string): The reason (or error message) for the Exception
+                to be raised.
+            response (HttpResponse): The HttpResponse of the API call.
+
+        """
+        super(APIException, self).__init__(reason)
+        self.reason = reason
+        self.response = response
+        self.response_code = response.status_code
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        return (f"{self.__class__.__name__}("
+                f"status_code={self.response_code!s}, "
+                f"message={self.reason!s})")

fortisapi/exceptions/response_401_token_exception.py

@@ -0,0 +1,77 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+from fortisapi.exceptions.api_exception import (
+    APIException,
+)
+
+
+class Response401tokenException(APIException):
+    def __init__(self, reason, response):
+        """Initialize Response401tokenException object.
+
+        Args:
+            reason (string): The reason (or error message) for the Exception
+                to be raised.
+            response (HttpResponse): The HttpResponse of the API call.
+
+        """
+        super(Response401tokenException, self).__init__(reason, response)
+        dictionary = APIHelper.json_deserialize(self.response.text)
+        if isinstance(dictionary, dict):
+            self.unbox(dictionary)
+
+    def unbox(self, dictionary):
+        """Populate the properties of this object by extracting them from a dictionary.
+
+        Args:
+            dictionary (dictionary): A dictionary representation of the object as
+            obtained from the deserialization of the server's response. The keys
+            MUST match property names in the API description.
+
+        """
+        self.status_code =\
+            dictionary.get("statusCode")\
+            if dictionary.get("statusCode")\
+                else None
+        self.error =\
+            dictionary.get("error")\
+            if dictionary.get("error")\
+                else None
+        self.message =\
+            dictionary.get("message")\
+            if dictionary.get("message")\
+                else None
+
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _status_code=(
+            self.status_code
+            if hasattr(self, "status_code")
+            else None
+        )
+        _error=(
+            self.error
+            if hasattr(self, "error")
+            else None
+        )
+        _message=(
+            self.message
+            if hasattr(self, "message")
+            else None
+        )
+        _base_str = super().__str__()
+        _base_str = _base_str[_base_str.find("(") + 1:-1]
+        return (
+            f"{self.__class__.__name__}("
+            f"base_str={_base_str!s}, "
+            f"status_code={_status_code!s}, "
+            f"error={_error!s}, "
+            f"message={_message!s}, "
+            f")"
+        )