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

fortisapi/models/v_1_elements_transaction_intention_request.py

@@ -0,0 +1,591 @@
+"""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.models.method_50 import Method50
+
+
+class V1ElementsTransactionIntentionRequest(object):
+    """Implementation of the 'V1 Elements Transaction Intention Request' model.
+
+    Attributes:
+        action (ActionEnum): The action to be performed
+        digital_wallets_only (bool): The model property of type bool.
+        methods (List[Method50]): By default the system will try to offer all the
+            availables payment methods from your account. But if you like, you can
+            specify exactly what services you want to use.
+        amount (int): The total amount to be charged. Allowed on the actions: `sale`,
+            `auth-only`, `refund`
+        tax_amount (int | None): Amount of Sales Tax. If supplied, this amount should
+            be already included in the transaction amount. Allowed on the actions:
+            `sale`, `auth-only`, `refund`
+        extra_tax (int | None): Amount of Extra Tax. If supplied, this amount should
+            be already included in the transaction amount. Allowed on the actions:
+            `sale`, `auth-only`, `refund`
+        secondary_amount (int | None): Retained Amount. Allowed on the actions:
+            `sale`, `auth-only`, `refund`
+        location_id (str): Location ID
+        contact_id (str): Contact ID
+        save_account (bool | None): Specifies to tokenize card/bank information
+            within the transaction. Allowed on the actions: `sale`, `auth-only`,
+            `avs-only`, `refund`
+        save_account_title (str | None): Specifies to tokenize card/bank information
+            within the transaction. Allowed on the actions: `sale`, `auth-only`,
+            `avs-only`, `refund`
+        title (str | None): A title for the token.
+        ach_sec_code (AchSecCodeEnum): SEC code for the transaction if it's an ACH
+            transaction
+        bank_funded_only_override (bool | None): Bank Funded Only Override
+        allow_partial_authorization_override (bool | None): Allow partial
+            Authorization Override
+        auto_decline_cvv_override (bool | None): Auto Decline Cvv Override
+        auto_decline_street_override (bool | None): Auto Decline Street Override
+        auto_decline_zip_override (bool | None): Auto Decline Zip Override
+        message (str): A custom text message that displays after the payment is
+            processed.
+        currency_code (str): The currency code for the transaction, default is 'USD'.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "action": "action",
+        "digital_wallets_only": "digitalWalletsOnly",
+        "methods": "methods",
+        "amount": "amount",
+        "tax_amount": "tax_amount",
+        "extra_tax": "extra_tax",
+        "secondary_amount": "secondary_amount",
+        "location_id": "location_id",
+        "contact_id": "contact_id",
+        "save_account": "save_account",
+        "save_account_title": "save_account_title",
+        "title": "title",
+        "ach_sec_code": "ach_sec_code",
+        "bank_funded_only_override": "bank_funded_only_override",
+        "allow_partial_authorization_override": "allow_partial_authorization_override",
+        "auto_decline_cvv_override": "auto_decline_cvv_override",
+        "auto_decline_street_override": "auto_decline_street_override",
+        "auto_decline_zip_override": "auto_decline_zip_override",
+        "message": "message",
+        "currency_code": "currency_code",
+    }
+
+    _optionals = [
+        "action",
+        "digital_wallets_only",
+        "methods",
+        "amount",
+        "tax_amount",
+        "extra_tax",
+        "secondary_amount",
+        "location_id",
+        "contact_id",
+        "save_account",
+        "save_account_title",
+        "title",
+        "ach_sec_code",
+        "bank_funded_only_override",
+        "allow_partial_authorization_override",
+        "auto_decline_cvv_override",
+        "auto_decline_street_override",
+        "auto_decline_zip_override",
+        "message",
+        "currency_code",
+    ]
+
+    _nullables = [
+        "action",
+        "location_id",
+        "contact_id",
+        "ach_sec_code",
+        "message",
+        "currency_code",
+    ]
+
+    def __init__(
+        self,
+        action="sale",
+        digital_wallets_only=False,
+        methods=APIHelper.SKIP,
+        amount=APIHelper.SKIP,
+        tax_amount=APIHelper.SKIP,
+        extra_tax=APIHelper.SKIP,
+        secondary_amount=APIHelper.SKIP,
+        location_id=APIHelper.SKIP,
+        contact_id=APIHelper.SKIP,
+        save_account=APIHelper.SKIP,
+        save_account_title=APIHelper.SKIP,
+        title=APIHelper.SKIP,
+        ach_sec_code="WEB",
+        bank_funded_only_override=APIHelper.SKIP,
+        allow_partial_authorization_override=APIHelper.SKIP,
+        auto_decline_cvv_override=APIHelper.SKIP,
+        auto_decline_street_override=APIHelper.SKIP,
+        auto_decline_zip_override=APIHelper.SKIP,
+        message=APIHelper.SKIP,
+        currency_code="USD",
+        additional_properties=None):
+        """Initialize a V1ElementsTransactionIntentionRequest instance."""
+        # Initialize members of the class
+        self.action = action
+        self.digital_wallets_only = digital_wallets_only
+        if methods is not APIHelper.SKIP:
+            self.methods = methods
+        if amount is not APIHelper.SKIP:
+            self.amount = amount
+        if tax_amount is not APIHelper.SKIP:
+            self.tax_amount = tax_amount
+        if extra_tax is not APIHelper.SKIP:
+            self.extra_tax = extra_tax
+        if secondary_amount is not APIHelper.SKIP:
+            self.secondary_amount = secondary_amount
+        if location_id is not APIHelper.SKIP:
+            self.location_id = location_id
+        if contact_id is not APIHelper.SKIP:
+            self.contact_id = contact_id
+        if save_account is not APIHelper.SKIP:
+            self.save_account = save_account
+        if save_account_title is not APIHelper.SKIP:
+            self.save_account_title = save_account_title
+        if title is not APIHelper.SKIP:
+            self.title = title
+        self.ach_sec_code = ach_sec_code
+        if bank_funded_only_override is not APIHelper.SKIP:
+            self.bank_funded_only_override = bank_funded_only_override
+        if allow_partial_authorization_override is not APIHelper.SKIP:
+            self.allow_partial_authorization_override =\
+                 allow_partial_authorization_override
+        if auto_decline_cvv_override is not APIHelper.SKIP:
+            self.auto_decline_cvv_override = auto_decline_cvv_override
+        if auto_decline_street_override is not APIHelper.SKIP:
+            self.auto_decline_street_override = auto_decline_street_override
+        if auto_decline_zip_override is not APIHelper.SKIP:
+            self.auto_decline_zip_override = auto_decline_zip_override
+        if message is not APIHelper.SKIP:
+            self.message = message
+        self.currency_code = currency_code
+
+        # 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.
+
+        """
+        from fortisapi.utilities.union_type_lookup import (
+            UnionTypeLookUp,
+        )
+
+        if not isinstance(dictionary, dict) or dictionary is None:
+            return None
+
+        # Extract variables from the dictionary
+        action =\
+            dictionary.get("action")\
+            if dictionary.get("action")\
+                else "sale"
+        digital_wallets_only =\
+            dictionary.get("digitalWalletsOnly")\
+            if dictionary.get("digitalWalletsOnly")\
+                else False
+        methods = None
+        if dictionary.get("methods") is not None:
+            methods = [
+                Method50.from_dictionary(x)
+                    for x in dictionary.get("methods")
+            ]
+        else:
+            methods = APIHelper.SKIP
+        amount =\
+            dictionary.get("amount")\
+            if dictionary.get("amount")\
+                else APIHelper.SKIP
+        tax_amount = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestTaxAmount"),
+            dictionary.get("tax_amount"),
+            False)\
+            if dictionary.get("tax_amount") is not None\
+            else APIHelper.SKIP
+        extra_tax = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestExtraTax"),
+            dictionary.get("extra_tax"),
+            False)\
+            if dictionary.get("extra_tax") is not None\
+            else APIHelper.SKIP
+        secondary_amount = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestSecondaryAmount"),
+            dictionary.get("secondary_amount"),
+            False)\
+            if dictionary.get("secondary_amount") is not None\
+            else APIHelper.SKIP
+        location_id =\
+            dictionary.get("location_id")\
+            if "location_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        contact_id =\
+            dictionary.get("contact_id")\
+            if "contact_id" in dictionary.keys()\
+                else APIHelper.SKIP
+        save_account = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestSaveAccount"),
+            dictionary.get("save_account"),
+            False)\
+            if dictionary.get("save_account") is not None\
+            else APIHelper.SKIP
+        save_account_title = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestSaveAccountTitle"),
+            dictionary.get("save_account_title"),
+            False)\
+            if dictionary.get("save_account_title") is not None\
+            else APIHelper.SKIP
+        title = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestTitle"),
+            dictionary.get("title"),
+            False)\
+            if dictionary.get("title") is not None\
+            else APIHelper.SKIP
+        ach_sec_code =\
+            dictionary.get("ach_sec_code")\
+            if dictionary.get("ach_sec_code")\
+                else "WEB"
+        bank_funded_only_override = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestBankFundedOnlyOverride"),
+            dictionary.get("bank_funded_only_override"),
+            False)\
+            if dictionary.get("bank_funded_only_override") is not None\
+            else APIHelper.SKIP
+        allow_partial_authorization_override = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestAllowPartialAuthorizationOverride"),
+            dictionary.get("allow_partial_authorization_override"),
+            False)\
+            if dictionary.get("allow_partial_authorization_override") is not None\
+            else APIHelper.SKIP
+        auto_decline_cvv_override = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestAutoDeclineCvvOverride"),
+            dictionary.get("auto_decline_cvv_override"),
+            False)\
+            if dictionary.get("auto_decline_cvv_override") is not None\
+            else APIHelper.SKIP
+        auto_decline_street_override = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestAutoDeclineStreetOverride"),
+            dictionary.get("auto_decline_street_override"),
+            False)\
+            if dictionary.get("auto_decline_street_override") is not None\
+            else APIHelper.SKIP
+        auto_decline_zip_override = APIHelper.deserialize_union_type(
+            UnionTypeLookUp.get("V1ElementsTransactionIntentionRequestAutoDeclineZipOverride"),
+            dictionary.get("auto_decline_zip_override"),
+            False)\
+            if dictionary.get("auto_decline_zip_override") is not None\
+            else APIHelper.SKIP
+        message =\
+            dictionary.get("message")\
+            if "message" in dictionary.keys()\
+                else APIHelper.SKIP
+        currency_code =\
+            dictionary.get("currency_code")\
+            if dictionary.get("currency_code")\
+                else "USD"
+
+        # 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(action,
+                   digital_wallets_only,
+                   methods,
+                   amount,
+                   tax_amount,
+                   extra_tax,
+                   secondary_amount,
+                   location_id,
+                   contact_id,
+                   save_account,
+                   save_account_title,
+                   title,
+                   ach_sec_code,
+                   bank_funded_only_override,
+                   allow_partial_authorization_override,
+                   auto_decline_cvv_override,
+                   auto_decline_street_override,
+                   auto_decline_zip_override,
+                   message,
+                   currency_code,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _action=(
+            self.action
+            if hasattr(self, "action")
+            else None
+        )
+        _digital_wallets_only=(
+            self.digital_wallets_only
+            if hasattr(self, "digital_wallets_only")
+            else None
+        )
+        _methods=(
+            self.methods
+            if hasattr(self, "methods")
+            else None
+        )
+        _amount=(
+            self.amount
+            if hasattr(self, "amount")
+            else None
+        )
+        _tax_amount=(
+            self.tax_amount
+            if hasattr(self, "tax_amount")
+            else None
+        )
+        _extra_tax=(
+            self.extra_tax
+            if hasattr(self, "extra_tax")
+            else None
+        )
+        _secondary_amount=(
+            self.secondary_amount
+            if hasattr(self, "secondary_amount")
+            else None
+        )
+        _location_id=(
+            self.location_id
+            if hasattr(self, "location_id")
+            else None
+        )
+        _contact_id=(
+            self.contact_id
+            if hasattr(self, "contact_id")
+            else None
+        )
+        _save_account=(
+            self.save_account
+            if hasattr(self, "save_account")
+            else None
+        )
+        _save_account_title=(
+            self.save_account_title
+            if hasattr(self, "save_account_title")
+            else None
+        )
+        _title=(
+            self.title
+            if hasattr(self, "title")
+            else None
+        )
+        _ach_sec_code=(
+            self.ach_sec_code
+            if hasattr(self, "ach_sec_code")
+            else None
+        )
+        _bank_funded_only_override=(
+            self.bank_funded_only_override
+            if hasattr(self, "bank_funded_only_override")
+            else None
+        )
+        _allow_partial_authorization_override=(
+            self.allow_partial_authorization_override
+            if hasattr(self, "allow_partial_authorization_override")
+            else None
+        )
+        _auto_decline_cvv_override=(
+            self.auto_decline_cvv_override
+            if hasattr(self, "auto_decline_cvv_override")
+            else None
+        )
+        _auto_decline_street_override=(
+            self.auto_decline_street_override
+            if hasattr(self, "auto_decline_street_override")
+            else None
+        )
+        _auto_decline_zip_override=(
+            self.auto_decline_zip_override
+            if hasattr(self, "auto_decline_zip_override")
+            else None
+        )
+        _message=(
+            self.message
+            if hasattr(self, "message")
+            else None
+        )
+        _currency_code=(
+            self.currency_code
+            if hasattr(self, "currency_code")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"action={_action!r}, "
+            f"digital_wallets_only={_digital_wallets_only!r}, "
+            f"methods={_methods!r}, "
+            f"amount={_amount!r}, "
+            f"tax_amount={_tax_amount!r}, "
+            f"extra_tax={_extra_tax!r}, "
+            f"secondary_amount={_secondary_amount!r}, "
+            f"location_id={_location_id!r}, "
+            f"contact_id={_contact_id!r}, "
+            f"save_account={_save_account!r}, "
+            f"save_account_title={_save_account_title!r}, "
+            f"title={_title!r}, "
+            f"ach_sec_code={_ach_sec_code!r}, "
+            f"bank_funded_only_override={_bank_funded_only_override!r}, "
+            f"allow_partial_authorization_override={_allow_partial_authorization_override!r}, "
+            f"auto_decline_cvv_override={_auto_decline_cvv_override!r}, "
+            f"auto_decline_street_override={_auto_decline_street_override!r}, "
+            f"auto_decline_zip_override={_auto_decline_zip_override!r}, "
+            f"message={_message!r}, "
+            f"currency_code={_currency_code!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _action=(
+            self.action
+            if hasattr(self, "action")
+            else None
+        )
+        _digital_wallets_only=(
+            self.digital_wallets_only
+            if hasattr(self, "digital_wallets_only")
+            else None
+        )
+        _methods=(
+            self.methods
+            if hasattr(self, "methods")
+            else None
+        )
+        _amount=(
+            self.amount
+            if hasattr(self, "amount")
+            else None
+        )
+        _tax_amount=(
+            self.tax_amount
+            if hasattr(self, "tax_amount")
+            else None
+        )
+        _extra_tax=(
+            self.extra_tax
+            if hasattr(self, "extra_tax")
+            else None
+        )
+        _secondary_amount=(
+            self.secondary_amount
+            if hasattr(self, "secondary_amount")
+            else None
+        )
+        _location_id=(
+            self.location_id
+            if hasattr(self, "location_id")
+            else None
+        )
+        _contact_id=(
+            self.contact_id
+            if hasattr(self, "contact_id")
+            else None
+        )
+        _save_account=(
+            self.save_account
+            if hasattr(self, "save_account")
+            else None
+        )
+        _save_account_title=(
+            self.save_account_title
+            if hasattr(self, "save_account_title")
+            else None
+        )
+        _title=(
+            self.title
+            if hasattr(self, "title")
+            else None
+        )
+        _ach_sec_code=(
+            self.ach_sec_code
+            if hasattr(self, "ach_sec_code")
+            else None
+        )
+        _bank_funded_only_override=(
+            self.bank_funded_only_override
+            if hasattr(self, "bank_funded_only_override")
+            else None
+        )
+        _allow_partial_authorization_override=(
+            self.allow_partial_authorization_override
+            if hasattr(self, "allow_partial_authorization_override")
+            else None
+        )
+        _auto_decline_cvv_override=(
+            self.auto_decline_cvv_override
+            if hasattr(self, "auto_decline_cvv_override")
+            else None
+        )
+        _auto_decline_street_override=(
+            self.auto_decline_street_override
+            if hasattr(self, "auto_decline_street_override")
+            else None
+        )
+        _auto_decline_zip_override=(
+            self.auto_decline_zip_override
+            if hasattr(self, "auto_decline_zip_override")
+            else None
+        )
+        _message=(
+            self.message
+            if hasattr(self, "message")
+            else None
+        )
+        _currency_code=(
+            self.currency_code
+            if hasattr(self, "currency_code")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"action={_action!s}, "
+            f"digital_wallets_only={_digital_wallets_only!s}, "
+            f"methods={_methods!s}, "
+            f"amount={_amount!s}, "
+            f"tax_amount={_tax_amount!s}, "
+            f"extra_tax={_extra_tax!s}, "
+            f"secondary_amount={_secondary_amount!s}, "
+            f"location_id={_location_id!s}, "
+            f"contact_id={_contact_id!s}, "
+            f"save_account={_save_account!s}, "
+            f"save_account_title={_save_account_title!s}, "
+            f"title={_title!s}, "
+            f"ach_sec_code={_ach_sec_code!s}, "
+            f"bank_funded_only_override={_bank_funded_only_override!s}, "
+            f"allow_partial_authorization_override={_allow_partial_authorization_override!s}, "
+            f"auto_decline_cvv_override={_auto_decline_cvv_override!s}, "
+            f"auto_decline_street_override={_auto_decline_street_override!s}, "
+            f"auto_decline_zip_override={_auto_decline_zip_override!s}, "
+            f"message={_message!s}, "
+            f"currency_code={_currency_code!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )