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

fortisapi/models/v_1_webhooks_apm_onboarding_request.py

@@ -0,0 +1,421 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class V1WebhooksApmOnboardingRequest(object):
+    """Implementation of the 'V1 Webhooks Apm Onboarding Request' model.
+
+    Attributes:
+        attempt_interval (int): Number of seconds before another retry is submitted
+        basic_auth_username (str): The Basic authorization username for the URL, if
+            not supplied, the postback will be submitted without Basic authorization
+            headers >This is only expandable for response but settable in the
+            POST/PUT request >
+        basic_auth_password (str): The basic authorization password >This is only
+            expandable for response but settable in the POST/PUT request >
+        expands (str): An option list of expanded data to send with base data. (i.e.
+            set this field to “contact,account_vault” to get the contact an
+            accountvault used to run a transaction.)
+        format (FormatEnum): Options include: api-default
+        is_active (bool): Flag to indicate whether configuration is active (in
+            effect).
+        location_id (str): The location identifier of the resource you want to
+            recieve postbacks from.
+        location_api_id (str): Location Api ID
+        on_create (bool): To receive postbacks on the creation of a resource
+        on_update (bool): To receive postbacks on the updating of a resource
+        on_delete (bool): To receive postbacks when the record is deleted
+        legacy (bool): Prefer the legacy api format.
+        postback_config_id (str): Postback Config ID
+        product_transaction_id (str): Required when using 'transaction' or
+            'transactionbatch' resource
+        resource (Resource12Enum): The resource you want to subscribe the postbacks
+            to. >Possible values include: 'contact', 'transaction',
+            'transactionbatch' >
+        number_of_attempts (int): Maximum number of attempts on failure
+        url (str): The URL where the postback will be submitted
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "is_active": "is_active",
+        "location_id": "location_id",
+        "on_create": "on_create",
+        "on_update": "on_update",
+        "on_delete": "on_delete",
+        "number_of_attempts": "number_of_attempts",
+        "url": "url",
+        "attempt_interval": "attempt_interval",
+        "basic_auth_username": "basic_auth_username",
+        "basic_auth_password": "basic_auth_password",
+        "expands": "expands",
+        "format": "format",
+        "location_api_id": "location_api_id",
+        "legacy": "legacy",
+        "postback_config_id": "postback_config_id",
+        "product_transaction_id": "product_transaction_id",
+        "resource": "resource",
+    }
+
+    _optionals = [
+        "attempt_interval",
+        "basic_auth_username",
+        "basic_auth_password",
+        "expands",
+        "format",
+        "location_api_id",
+        "legacy",
+        "postback_config_id",
+        "product_transaction_id",
+        "resource",
+    ]
+
+    _nullables = [
+        "attempt_interval",
+        "basic_auth_username",
+        "basic_auth_password",
+        "expands",
+        "format",
+        "location_api_id",
+        "postback_config_id",
+        "product_transaction_id",
+        "resource",
+    ]
+
+    def __init__(
+        self,
+        is_active=None,
+        location_id=None,
+        on_create=None,
+        on_update=None,
+        on_delete=None,
+        number_of_attempts=None,
+        url=None,
+        attempt_interval=300,
+        basic_auth_username=APIHelper.SKIP,
+        basic_auth_password=APIHelper.SKIP,
+        expands=APIHelper.SKIP,
+        format=APIHelper.SKIP,
+        location_api_id=APIHelper.SKIP,
+        legacy=True,
+        postback_config_id=APIHelper.SKIP,
+        product_transaction_id=APIHelper.SKIP,
+        resource=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a V1WebhooksApmOnboardingRequest instance."""
+        # Initialize members of the class
+        self.attempt_interval = attempt_interval
+        if basic_auth_username is not APIHelper.SKIP:
+            self.basic_auth_username = basic_auth_username
+        if basic_auth_password is not APIHelper.SKIP:
+            self.basic_auth_password = basic_auth_password
+        if expands is not APIHelper.SKIP:
+            self.expands = expands
+        if format is not APIHelper.SKIP:
+            self.format = format
+        self.is_active = is_active
+        self.location_id = location_id
+        if location_api_id is not APIHelper.SKIP:
+            self.location_api_id = location_api_id
+        self.on_create = on_create
+        self.on_update = on_update
+        self.on_delete = on_delete
+        self.legacy = legacy
+        if postback_config_id is not APIHelper.SKIP:
+            self.postback_config_id = postback_config_id
+        if product_transaction_id is not APIHelper.SKIP:
+            self.product_transaction_id = product_transaction_id
+        if resource is not APIHelper.SKIP:
+            self.resource = resource
+        self.number_of_attempts = number_of_attempts
+        self.url = url
+
+        # Add additional model properties to the instance
+        if additional_properties is None:
+            additional_properties = {}
+        self.additional_properties = additional_properties
+
+    @classmethod
+    def from_dictionary(cls,
+                        dictionary):
+        """Create an instance of this model 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.
+
+        Returns:
+            object: An instance of this structure class.
+
+        """
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        is_active =\
+            dictionary.get("is_active")\
+            if "is_active" in dictionary.keys()\
+                else None
+        location_id =\
+            dictionary.get("location_id")\
+            if dictionary.get("location_id")\
+                else None
+        on_create =\
+            dictionary.get("on_create")\
+            if "on_create" in dictionary.keys()\
+                else None
+        on_update =\
+            dictionary.get("on_update")\
+            if "on_update" in dictionary.keys()\
+                else None
+        on_delete =\
+            dictionary.get("on_delete")\
+            if "on_delete" in dictionary.keys()\
+                else None
+        number_of_attempts =\
+            dictionary.get("number_of_attempts")\
+            if dictionary.get("number_of_attempts")\
+                else None
+        url =\
+            dictionary.get("url")\
+            if dictionary.get("url")\
+                else None
+        attempt_interval =\
+            dictionary.get("attempt_interval")\
+            if dictionary.get("attempt_interval")\
+                else 300
+        basic_auth_username =\
+            dictionary.get("basic_auth_username")\
+            if "basic_auth_username" in dictionary.keys()\
+                else APIHelper.SKIP
+        basic_auth_password =\
+            dictionary.get("basic_auth_password")\
+            if "basic_auth_password" in dictionary.keys()\
+                else APIHelper.SKIP
+        expands =\
+            dictionary.get("expands")\
+            if "expands" in dictionary.keys()\
+                else APIHelper.SKIP
+        format =\
+            dictionary.get("format")\
+            if "format" in dictionary.keys()\
+                else APIHelper.SKIP
+        location_api_id =\
+            dictionary.get("location_api_id")\
+            if "location_api_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        legacy =\
+            dictionary.get("legacy")\
+            if dictionary.get("legacy")\
+                else True
+        postback_config_id =\
+            dictionary.get("postback_config_id")\
+            if "postback_config_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        product_transaction_id =\
+            dictionary.get("product_transaction_id")\
+            if "product_transaction_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        resource =\
+            dictionary.get("resource")\
+            if "resource" in dictionary.keys()\
+                else APIHelper.SKIP
+
+        # Clean out expected properties from dictionary
+        additional_properties =\
+            {k: v for k, v in dictionary.items() if k not in cls._names.values()}
+
+        # Return an object of this model
+        return cls(is_active,
+                   location_id,
+                   on_create,
+                   on_update,
+                   on_delete,
+                   number_of_attempts,
+                   url,
+                   attempt_interval,
+                   basic_auth_username,
+                   basic_auth_password,
+                   expands,
+                   format,
+                   location_api_id,
+                   legacy,
+                   postback_config_id,
+                   product_transaction_id,
+                   resource,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _attempt_interval=(
+            self.attempt_interval
+            if hasattr(self, "attempt_interval")
+            else None
+        )
+        _basic_auth_username=(
+            self.basic_auth_username
+            if hasattr(self, "basic_auth_username")
+            else None
+        )
+        _basic_auth_password=(
+            self.basic_auth_password
+            if hasattr(self, "basic_auth_password")
+            else None
+        )
+        _expands=(
+            self.expands
+            if hasattr(self, "expands")
+            else None
+        )
+        _format=(
+            self.format
+            if hasattr(self, "format")
+            else None
+        )
+        _is_active=self.is_active
+        _location_id=self.location_id
+        _location_api_id=(
+            self.location_api_id
+            if hasattr(self, "location_api_id")
+            else None
+        )
+        _on_create=self.on_create
+        _on_update=self.on_update
+        _on_delete=self.on_delete
+        _legacy=(
+            self.legacy
+            if hasattr(self, "legacy")
+            else None
+        )
+        _postback_config_id=(
+            self.postback_config_id
+            if hasattr(self, "postback_config_id")
+            else None
+        )
+        _product_transaction_id=(
+            self.product_transaction_id
+            if hasattr(self, "product_transaction_id")
+            else None
+        )
+        _resource=(
+            self.resource
+            if hasattr(self, "resource")
+            else None
+        )
+        _number_of_attempts=self.number_of_attempts
+        _url=self.url
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"attempt_interval={_attempt_interval!r}, "
+            f"basic_auth_username={_basic_auth_username!r}, "
+            f"basic_auth_password={_basic_auth_password!r}, "
+            f"expands={_expands!r}, "
+            f"format={_format!r}, "
+            f"is_active={_is_active!r}, "
+            f"location_id={_location_id!r}, "
+            f"location_api_id={_location_api_id!r}, "
+            f"on_create={_on_create!r}, "
+            f"on_update={_on_update!r}, "
+            f"on_delete={_on_delete!r}, "
+            f"legacy={_legacy!r}, "
+            f"postback_config_id={_postback_config_id!r}, "
+            f"product_transaction_id={_product_transaction_id!r}, "
+            f"resource={_resource!r}, "
+            f"number_of_attempts={_number_of_attempts!r}, "
+            f"url={_url!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _attempt_interval=(
+            self.attempt_interval
+            if hasattr(self, "attempt_interval")
+            else None
+        )
+        _basic_auth_username=(
+            self.basic_auth_username
+            if hasattr(self, "basic_auth_username")
+            else None
+        )
+        _basic_auth_password=(
+            self.basic_auth_password
+            if hasattr(self, "basic_auth_password")
+            else None
+        )
+        _expands=(
+            self.expands
+            if hasattr(self, "expands")
+            else None
+        )
+        _format=(
+            self.format
+            if hasattr(self, "format")
+            else None
+        )
+        _is_active=self.is_active
+        _location_id=self.location_id
+        _location_api_id=(
+            self.location_api_id
+            if hasattr(self, "location_api_id")
+            else None
+        )
+        _on_create=self.on_create
+        _on_update=self.on_update
+        _on_delete=self.on_delete
+        _legacy=(
+            self.legacy
+            if hasattr(self, "legacy")
+            else None
+        )
+        _postback_config_id=(
+            self.postback_config_id
+            if hasattr(self, "postback_config_id")
+            else None
+        )
+        _product_transaction_id=(
+            self.product_transaction_id
+            if hasattr(self, "product_transaction_id")
+            else None
+        )
+        _resource=(
+            self.resource
+            if hasattr(self, "resource")
+            else None
+        )
+        _number_of_attempts=self.number_of_attempts
+        _url=self.url
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"attempt_interval={_attempt_interval!s}, "
+            f"basic_auth_username={_basic_auth_username!s}, "
+            f"basic_auth_password={_basic_auth_password!s}, "
+            f"expands={_expands!s}, "
+            f"format={_format!s}, "
+            f"is_active={_is_active!s}, "
+            f"location_id={_location_id!s}, "
+            f"location_api_id={_location_api_id!s}, "
+            f"on_create={_on_create!s}, "
+            f"on_update={_on_update!s}, "
+            f"on_delete={_on_delete!s}, "
+            f"legacy={_legacy!s}, "
+            f"postback_config_id={_postback_config_id!s}, "
+            f"product_transaction_id={_product_transaction_id!s}, "
+            f"resource={_resource!s}, "
+            f"number_of_attempts={_number_of_attempts!s}, "
+            f"url={_url!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )