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

fortisapi/models/merchant_list.py

@@ -0,0 +1,193 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class MerchantList(object):
+    """Implementation of the 'MerchantList' model.
+
+    Attributes:
+        merchant_name_listed (str): Name of the listed merchant as used in the
+            authorization message as defined in ISO 8583.
+        acquirer_merchant_id_listed (str): Acquirer-assigned Merchant Listed
+            Identifier. This may be the same value that is used in authorisation
+            requests sent on behalf of the 3DS Requestor and is represented in ISO
+            8583 formatting requirements.
+        merchant_amount (str): Purchase amount for the merchant in minor units of
+            currency with all punctuation removed. When used in conjunction with the
+            Purchase Currency Exponent field, proper punctuation can be calculated.
+        merchant_currency (str): Currency Code in which purchase Merchant Amount is
+            expressed. Must be provided as ISO 4217 three-digit currency code except
+            values 955-964 and 999.
+        merchant_exponent (str): Minor units of Merchant Currency as specified in the
+            ISO 4217 currency exponent.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "merchant_name_listed": "merchant_name_listed",
+        "acquirer_merchant_id_listed": "acquirer_merchant_id_listed",
+        "merchant_amount": "merchant_amount",
+        "merchant_currency": "merchant_currency",
+        "merchant_exponent": "merchant_exponent",
+    }
+
+    _optionals = [
+        "acquirer_merchant_id_listed",
+        "merchant_amount",
+        "merchant_currency",
+        "merchant_exponent",
+    ]
+
+    def __init__(
+        self,
+        merchant_name_listed=None,
+        acquirer_merchant_id_listed=APIHelper.SKIP,
+        merchant_amount=APIHelper.SKIP,
+        merchant_currency=APIHelper.SKIP,
+        merchant_exponent=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a MerchantList instance."""
+        # Initialize members of the class
+        self.merchant_name_listed = merchant_name_listed
+        if acquirer_merchant_id_listed is not APIHelper.SKIP:
+            self.acquirer_merchant_id_listed = acquirer_merchant_id_listed
+        if merchant_amount is not APIHelper.SKIP:
+            self.merchant_amount = merchant_amount
+        if merchant_currency is not APIHelper.SKIP:
+            self.merchant_currency = merchant_currency
+        if merchant_exponent is not APIHelper.SKIP:
+            self.merchant_exponent = merchant_exponent
+
+        # 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
+        merchant_name_listed =\
+            dictionary.get("merchant_name_listed")\
+            if dictionary.get("merchant_name_listed")\
+                else None
+        acquirer_merchant_id_listed =\
+            dictionary.get("acquirer_merchant_id_listed")\
+            if dictionary.get("acquirer_merchant_id_listed")\
+                else APIHelper.SKIP
+        merchant_amount =\
+            dictionary.get("merchant_amount")\
+            if dictionary.get("merchant_amount")\
+                else APIHelper.SKIP
+        merchant_currency =\
+            dictionary.get("merchant_currency")\
+            if dictionary.get("merchant_currency")\
+                else APIHelper.SKIP
+        merchant_exponent =\
+            dictionary.get("merchant_exponent")\
+            if dictionary.get("merchant_exponent")\
+                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(merchant_name_listed,
+                   acquirer_merchant_id_listed,
+                   merchant_amount,
+                   merchant_currency,
+                   merchant_exponent,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _merchant_name_listed=self.merchant_name_listed
+        _acquirer_merchant_id_listed=(
+            self.acquirer_merchant_id_listed
+            if hasattr(self, "acquirer_merchant_id_listed")
+            else None
+        )
+        _merchant_amount=(
+            self.merchant_amount
+            if hasattr(self, "merchant_amount")
+            else None
+        )
+        _merchant_currency=(
+            self.merchant_currency
+            if hasattr(self, "merchant_currency")
+            else None
+        )
+        _merchant_exponent=(
+            self.merchant_exponent
+            if hasattr(self, "merchant_exponent")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"merchant_name_listed={_merchant_name_listed!r}, "
+            f"acquirer_merchant_id_listed={_acquirer_merchant_id_listed!r}, "
+            f"merchant_amount={_merchant_amount!r}, "
+            f"merchant_currency={_merchant_currency!r}, "
+            f"merchant_exponent={_merchant_exponent!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _merchant_name_listed=self.merchant_name_listed
+        _acquirer_merchant_id_listed=(
+            self.acquirer_merchant_id_listed
+            if hasattr(self, "acquirer_merchant_id_listed")
+            else None
+        )
+        _merchant_amount=(
+            self.merchant_amount
+            if hasattr(self, "merchant_amount")
+            else None
+        )
+        _merchant_currency=(
+            self.merchant_currency
+            if hasattr(self, "merchant_currency")
+            else None
+        )
+        _merchant_exponent=(
+            self.merchant_exponent
+            if hasattr(self, "merchant_exponent")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"merchant_name_listed={_merchant_name_listed!s}, "
+            f"acquirer_merchant_id_listed={_acquirer_merchant_id_listed!s}, "
+            f"merchant_amount={_merchant_amount!s}, "
+            f"merchant_currency={_merchant_currency!s}, "
+            f"merchant_exponent={_merchant_exponent!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/merchant_risk_indicator.py

@@ -0,0 +1,341 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class MerchantRiskIndicator(object):
+    """Implementation of the 'MerchantRiskIndicator' model.
+
+    Contains purchase information
+
+    Attributes:
+        ship_indicator (ShipIndicatorEnum): Indicates shipping method chosen for the
+            transaction. Merchants must choose the Shipping Indicator code that most
+            accurately describes the cardholder's specific transaction. If one or
+            more items are included in the sale, use the Shipping Indicator code for
+            the physical goods, or if all digital goods, use the code that describes
+            the most expensive item. >01 - Ship to cardholder's billing address > >02
+            - Ship to another verified address on file with merchant > >03 - Ship to
+            address that is different than the cardholder's billing address > >04 -
+            "Ship to Store" / Pick-up at local store (Store address shall be
+            populated in shipping address fields) > >05 - Digital goods (includes
+            online services, electronic gift cards and redemption codes) > >06 -
+            Travel and Event tickets, not shipped > >07 - Other (for example, Gaming,
+            digital services not shipped, e-media subscriptions, etc.) > >08 -
+            Pick-up and go delivery. Availble in EMV 3DS 2.3.1 and later > >09 -
+            Locker delivery (or other automated pick-up). Availble in EMV 3DS 2.3.1
+            and later > >80 - PS-specific value (dependent on the payment scheme
+            type) > >81 - PS-specific value (dependent on the payment scheme type) >
+        delivery_timeframe (DeliveryTimeframeEnum): Indicates the merchandise
+            delivery timeframe. >01 - Electronic Delivery > >02 - Same day shipping >
+            >03 - Overnight shipping > >04 - Two-day or more shipping >
+        delivery_email_address (str): For electronic delivery, the email address to
+            which the merchandise was delivered.
+        reorder_items_ind (ReorderItemsIndEnum): Indicates whether the cardholder is
+            reordering previously purchased merchandise. >01 - First time ordered >
+            >02 - Reordered >
+        pre_order_purchase_ind (PreOrderPurchaseIndEnum): Indicates whether
+            Cardholder is placing an order for merchandise with a future availability
+            or release date. >01 - Merchandise available > >02 - Future availability >
+        pre_order_date (str): For a pre-ordered purchase, the expected date that the
+            merchandise will be available. Date format must be YYYYMMDD.
+        gift_card_amount (int): For prepaid or gift card purchase, the purchase
+            amount total of prepaid or gift card(s) in major units (for example, USD
+            123.45 is 123).
+        gift_card_curr (str): For prepaid or gift card purchase, the currency code of
+            the card as defined in ISO 4217 except 955 - 964 and 999.
+        gift_card_count (int): For prepaid or gift card purchase, total count of
+            individual prepaid or gift cards/codes purchased.
+        trans_char (List[TransCharEnum]): Available starting in EMV 3DS 2.3.1.1.
+            Indicates to the ACS specific transactions identified by the Merchant.
+            >01 - Cryptocurrency transaction > >02 - NFT transaction >
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "ship_indicator": "ship_indicator",
+        "delivery_timeframe": "delivery_timeframe",
+        "delivery_email_address": "delivery_email_address",
+        "reorder_items_ind": "reorder_items_ind",
+        "pre_order_purchase_ind": "pre_order_purchase_ind",
+        "pre_order_date": "pre_order_date",
+        "gift_card_amount": "gift_card_amount",
+        "gift_card_curr": "gift_card_curr",
+        "gift_card_count": "gift_card_count",
+        "trans_char": "trans_char",
+    }
+
+    _optionals = [
+        "ship_indicator",
+        "delivery_timeframe",
+        "delivery_email_address",
+        "reorder_items_ind",
+        "pre_order_purchase_ind",
+        "pre_order_date",
+        "gift_card_amount",
+        "gift_card_curr",
+        "gift_card_count",
+        "trans_char",
+    ]
+
+    def __init__(
+        self,
+        ship_indicator=APIHelper.SKIP,
+        delivery_timeframe=APIHelper.SKIP,
+        delivery_email_address=APIHelper.SKIP,
+        reorder_items_ind=APIHelper.SKIP,
+        pre_order_purchase_ind=APIHelper.SKIP,
+        pre_order_date=APIHelper.SKIP,
+        gift_card_amount=APIHelper.SKIP,
+        gift_card_curr=APIHelper.SKIP,
+        gift_card_count=APIHelper.SKIP,
+        trans_char=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a MerchantRiskIndicator instance."""
+        # Initialize members of the class
+        if ship_indicator is not APIHelper.SKIP:
+            self.ship_indicator = ship_indicator
+        if delivery_timeframe is not APIHelper.SKIP:
+            self.delivery_timeframe = delivery_timeframe
+        if delivery_email_address is not APIHelper.SKIP:
+            self.delivery_email_address = delivery_email_address
+        if reorder_items_ind is not APIHelper.SKIP:
+            self.reorder_items_ind = reorder_items_ind
+        if pre_order_purchase_ind is not APIHelper.SKIP:
+            self.pre_order_purchase_ind = pre_order_purchase_ind
+        if pre_order_date is not APIHelper.SKIP:
+            self.pre_order_date = pre_order_date
+        if gift_card_amount is not APIHelper.SKIP:
+            self.gift_card_amount = gift_card_amount
+        if gift_card_curr is not APIHelper.SKIP:
+            self.gift_card_curr = gift_card_curr
+        if gift_card_count is not APIHelper.SKIP:
+            self.gift_card_count = gift_card_count
+        if trans_char is not APIHelper.SKIP:
+            self.trans_char = trans_char
+
+        # 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
+        ship_indicator =\
+            dictionary.get("ship_indicator")\
+            if dictionary.get("ship_indicator")\
+                else APIHelper.SKIP
+        delivery_timeframe =\
+            dictionary.get("delivery_timeframe")\
+            if dictionary.get("delivery_timeframe")\
+                else APIHelper.SKIP
+        delivery_email_address =\
+            dictionary.get("delivery_email_address")\
+            if dictionary.get("delivery_email_address")\
+                else APIHelper.SKIP
+        reorder_items_ind =\
+            dictionary.get("reorder_items_ind")\
+            if dictionary.get("reorder_items_ind")\
+                else APIHelper.SKIP
+        pre_order_purchase_ind =\
+            dictionary.get("pre_order_purchase_ind")\
+            if dictionary.get("pre_order_purchase_ind")\
+                else APIHelper.SKIP
+        pre_order_date =\
+            dictionary.get("pre_order_date")\
+            if dictionary.get("pre_order_date")\
+                else APIHelper.SKIP
+        gift_card_amount =\
+            dictionary.get("gift_card_amount")\
+            if dictionary.get("gift_card_amount")\
+                else APIHelper.SKIP
+        gift_card_curr =\
+            dictionary.get("gift_card_curr")\
+            if dictionary.get("gift_card_curr")\
+                else APIHelper.SKIP
+        gift_card_count =\
+            dictionary.get("gift_card_count")\
+            if dictionary.get("gift_card_count")\
+                else APIHelper.SKIP
+        trans_char =\
+            dictionary.get("trans_char")\
+            if dictionary.get("trans_char")\
+                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(ship_indicator,
+                   delivery_timeframe,
+                   delivery_email_address,
+                   reorder_items_ind,
+                   pre_order_purchase_ind,
+                   pre_order_date,
+                   gift_card_amount,
+                   gift_card_curr,
+                   gift_card_count,
+                   trans_char,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _ship_indicator=(
+            self.ship_indicator
+            if hasattr(self, "ship_indicator")
+            else None
+        )
+        _delivery_timeframe=(
+            self.delivery_timeframe
+            if hasattr(self, "delivery_timeframe")
+            else None
+        )
+        _delivery_email_address=(
+            self.delivery_email_address
+            if hasattr(self, "delivery_email_address")
+            else None
+        )
+        _reorder_items_ind=(
+            self.reorder_items_ind
+            if hasattr(self, "reorder_items_ind")
+            else None
+        )
+        _pre_order_purchase_ind=(
+            self.pre_order_purchase_ind
+            if hasattr(self, "pre_order_purchase_ind")
+            else None
+        )
+        _pre_order_date=(
+            self.pre_order_date
+            if hasattr(self, "pre_order_date")
+            else None
+        )
+        _gift_card_amount=(
+            self.gift_card_amount
+            if hasattr(self, "gift_card_amount")
+            else None
+        )
+        _gift_card_curr=(
+            self.gift_card_curr
+            if hasattr(self, "gift_card_curr")
+            else None
+        )
+        _gift_card_count=(
+            self.gift_card_count
+            if hasattr(self, "gift_card_count")
+            else None
+        )
+        _trans_char=(
+            self.trans_char
+            if hasattr(self, "trans_char")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"ship_indicator={_ship_indicator!r}, "
+            f"delivery_timeframe={_delivery_timeframe!r}, "
+            f"delivery_email_address={_delivery_email_address!r}, "
+            f"reorder_items_ind={_reorder_items_ind!r}, "
+            f"pre_order_purchase_ind={_pre_order_purchase_ind!r}, "
+            f"pre_order_date={_pre_order_date!r}, "
+            f"gift_card_amount={_gift_card_amount!r}, "
+            f"gift_card_curr={_gift_card_curr!r}, "
+            f"gift_card_count={_gift_card_count!r}, "
+            f"trans_char={_trans_char!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _ship_indicator=(
+            self.ship_indicator
+            if hasattr(self, "ship_indicator")
+            else None
+        )
+        _delivery_timeframe=(
+            self.delivery_timeframe
+            if hasattr(self, "delivery_timeframe")
+            else None
+        )
+        _delivery_email_address=(
+            self.delivery_email_address
+            if hasattr(self, "delivery_email_address")
+            else None
+        )
+        _reorder_items_ind=(
+            self.reorder_items_ind
+            if hasattr(self, "reorder_items_ind")
+            else None
+        )
+        _pre_order_purchase_ind=(
+            self.pre_order_purchase_ind
+            if hasattr(self, "pre_order_purchase_ind")
+            else None
+        )
+        _pre_order_date=(
+            self.pre_order_date
+            if hasattr(self, "pre_order_date")
+            else None
+        )
+        _gift_card_amount=(
+            self.gift_card_amount
+            if hasattr(self, "gift_card_amount")
+            else None
+        )
+        _gift_card_curr=(
+            self.gift_card_curr
+            if hasattr(self, "gift_card_curr")
+            else None
+        )
+        _gift_card_count=(
+            self.gift_card_count
+            if hasattr(self, "gift_card_count")
+            else None
+        )
+        _trans_char=(
+            self.trans_char
+            if hasattr(self, "trans_char")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"ship_indicator={_ship_indicator!s}, "
+            f"delivery_timeframe={_delivery_timeframe!s}, "
+            f"delivery_email_address={_delivery_email_address!s}, "
+            f"reorder_items_ind={_reorder_items_ind!s}, "
+            f"pre_order_purchase_ind={_pre_order_purchase_ind!s}, "
+            f"pre_order_date={_pre_order_date!s}, "
+            f"gift_card_amount={_gift_card_amount!s}, "
+            f"gift_card_curr={_gift_card_curr!s}, "
+            f"gift_card_count={_gift_card_count!s}, "
+            f"trans_char={_trans_char!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/message_category_enum.py

@@ -0,0 +1,119 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+
+class MessageCategoryEnum(object):
+    """Implementation of the 'MessageCategory' enum.
+
+    Identifies the category of the message for a specific use case.
+    >01 - Payment Authentication (PA)
+    >
+    >02 - Non-Payment Authentication (NPA)
+    >
+    >80 through 99 - PS Specific Values
+    >
+    >80 - MasterCard Identity Check Insights
+    >
+    >85 - MasterCard Identity Check, Production Validation PA
+    >
+    >86 - MasterCard Identity Check, Production Validation NPA
+    >
+
+    Attributes:
+        ENUM_01: The enum member of type str.
+        ENUM_02: The enum member of type str.
+        ENUM_80: The enum member of type str.
+        ENUM_81: The enum member of type str.
+        ENUM_82: The enum member of type str.
+        ENUM_83: The enum member of type str.
+        ENUM_84: The enum member of type str.
+        ENUM_85: The enum member of type str.
+        ENUM_86: The enum member of type str.
+        ENUM_87: The enum member of type str.
+        ENUM_88: The enum member of type str.
+        ENUM_89: The enum member of type str.
+        ENUM_90: The enum member of type str.
+        ENUM_91: The enum member of type str.
+        ENUM_92: The enum member of type str.
+        ENUM_93: The enum member of type str.
+        ENUM_94: The enum member of type str.
+        ENUM_95: The enum member of type str.
+        ENUM_96: The enum member of type str.
+        ENUM_97: The enum member of type str.
+        ENUM_98: The enum member of type str.
+        ENUM_99: The enum member of type str.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    ENUM_01 = "01"
+
+    ENUM_02 = "02"
+
+    ENUM_80 = "80"
+
+    ENUM_81 = "81"
+
+    ENUM_82 = "82"
+
+    ENUM_83 = "83"
+
+    ENUM_84 = "84"
+
+    ENUM_85 = "85"
+
+    ENUM_86 = "86"
+
+    ENUM_87 = "87"
+
+    ENUM_88 = "88"
+
+    ENUM_89 = "89"
+
+    ENUM_90 = "90"
+
+    ENUM_91 = "91"
+
+    ENUM_92 = "92"
+
+    ENUM_93 = "93"
+
+    ENUM_94 = "94"
+
+    ENUM_95 = "95"
+
+    ENUM_96 = "96"
+
+    ENUM_97 = "97"
+
+    ENUM_98 = "98"
+
+    ENUM_99 = "99"
+
+    @classmethod
+    def from_value(cls, value, default=None):
+        """Return the matching enum value for the given input."""
+        if value is None:
+            return default
+
+        # If numeric and matches directly
+        if isinstance(value, int):
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and val == value:
+                    return val
+
+        # If string, perform case-insensitive match
+        if isinstance(value, str):
+            value_lower = value.lower()
+            for name, val in cls.__dict__.items():
+                if not name.startswith("_") and (
+                    name.lower() == value_lower or str(val).lower() == value_lower
+                ):
+                    return val
+
+        # Fallback to default
+        return default