"""visaacceptancemergedspec.

This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
"""

# ruff: noqa: E501
from visaacceptancemergedspec.api_helper import (
    APIHelper,
)


class Card10(object):
    """Implementation of the 'Card10' model.

    Attributes:
        number (str): The customer’s payment card number, also known as the Primary
            Account Number (PAN). You can also use this field for encoded account
            numbers.  #### FDMS Nashville Required. String (19)  #### GPX Required if
            `pointOfSaleInformation.entryMode=keyed`. However, this field is optional
            if your account is configured for relaxed requirements for address data
            and expiration date. **Important** It is your responsibility to determine
            whether a field is required for the transaction you are requesting.  ####
            All other processors Required if
            `pointOfSaleInformation.entryMode=keyed`. However, this field is optional
            if your account is configured for relaxed requirements for address data
            and expiration date. **Important** It is your responsibility to determine
            whether a field is required for the transaction you are requesting.
        expiration_month (str): Two-digit month in which the payment card expires.
            Format: `MM`.  Valid values: `01` through `12`. Leading 0 is required.
            #### Barclays and Streamline For Maestro (UK Domestic) and Maestro
            (International) cards on Barclays and Streamline, this must be a valid
            value (`01` through `12`) but is not required to be a valid expiration
            date. In other words, an expiration date that is in the past does not
            cause Visa Acceptance to reject your request. However, an invalid
            expiration date might cause the issuer to reject your request.  ####
            Encoded Account Numbers For encoded account numbers (_type_=039), if
            there is no expiration date on the card, use `12`.  #### FDMS Nashville
            Required field.  #### All other processors Required if
            `pointOfSaleInformation.entryMode=keyed`. However, this field is optional
            if your account is configured for relaxed requirements for address data
            and expiration date. **Important** It is your responsibility to determine
            whether a field is required for the transaction you are requesting.  ####
            Google Pay transactions For PAN-based Google Pay transactions, this field
            is returned in the API response.
        expiration_year (str): Four-digit year in which the payment card expires.
            Format: `YYYY`.  #### Barclays and Streamline For Maestro (UK Domestic)
            and Maestro (International) cards on Barclays and Streamline, this must
            be a valid value (`1900` through `3000`) but is not required to be a
            valid expiration date. In other words, an expiration date that is in the
            past does not cause Visa Acceptance to reject your request. However, an
            invalid expiration date might cause the issuer to reject your request.
            #### Encoded Account Numbers For encoded account numbers
            (**_type_**`=039`), if there is no expiration date on the card, use
            `2021`.  #### FDMS Nashville Required field.  #### FDC Nashville Global
            and FDMS South You can send in 2 digits or 4 digits. If you send in 2
            digits, they must be the last 2 digits of the year.  #### All other
            processors Required if `pointOfSaleInformation.entryMode=keyed`. However,
            this field is optional if your account is configured for relaxed
            requirements for address data and expiration date. **Important** It is
            your responsibility to determine whether a field is required for the
            transaction you are requesting.  #### Google Pay transactions For
            PAN-based Google Pay transactions, this field is returned in the API
            response.
        mtype (str): Three-digit value that indicates the card type.  **IMPORTANT**
            It is strongly recommended that you include the card type field in
            request messages even if it is optional for your processor and card type.
            Omitting the card type can cause the transaction to be processed with the
            wrong card type.  Possible values: - `001`: Visa. Use card type value
            `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a
            European regional brand of Mastercard. - `003`: American Express - `004`:
            Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1]
            - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private
            Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`:
            WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot
            Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner
            - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK
            Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business -
            `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`:
            Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa
            Electron[^1]. Do not use this value. Use `001` for all Visa card types. -
            `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] -
            `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account
            number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro
            (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`:
            Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn
            Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura -
            `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One
            Private Label - `056`: Carnet - `057`: Costco Private Label - `058`:
            Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China
            UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`:
            Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak -
            `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio -
            `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`:
            DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan  [^1]: For this card
            type, you must include the `paymentInformation.card.type` or
            `paymentInformation.tokenizedCard.type` field in your request for an
            authorization or a stand-alone credit. [^2]: For this card type on Cielo
            3.0, you must include the `paymentInformation.card.type` or
            `paymentInformation.tokenizedCard.type` field in a request for an
            authorization or a stand-alone credit. This card type is not supported on
            Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include
            the `paymentInformation.card.type` or
            `paymentInformation.tokenizedCard.type` field in a request for an
            authorization or a stand-alone credit. [^4]: For this card type, you must
            include the `paymentInformation.card.type` in your request for any payer
            authentication services.  #### Used by **Authorization** Required for
            Carte Blanche and JCB. Optional for all other card types.  #### Card
            Present reply This field is included in the reply message when the client
            software that is installed on the POS terminal uses the token management
            service (TMS) to retrieve tokenized payment details. You must contact
            customer support to have your account enabled to receive these fields in
            the credit reply message.  Returned by the Credit service.  This reply
            field is only supported by the following processors: - American Express
            Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX
            #### Google Pay transactions For PAN-based Google Pay transactions, this
            field is returned in the API response.  #### GPX This field only supports
            transactions from the following card types: - Visa - Mastercard - AMEX -
            Discover - Diners - JCB - Union Pay International
        security_code (str): Card Verification Number.  #### FDMS Nashville Required
            for American Express or if swiped; otherwise, optional.  #### Ingenico
            ePayments Do not include this field when `commerceIndicator=recurring`.
            **Note** Ingenico ePayments was previously called _Global Collect_.  ####
            TSYS Acquiring Solutions Optional if
            pointOfSaleInformation.entryMode=keyed; otherwise, not used.  #### GPX
            Optional.  #### All other processors: Optional.
        use_as (str): Flag that specifies the type of account associated with the
            card.  This field is available only for China UnionPay, Cielo, Comercio
            Latino and Visa Platform Connect. The cardholder provides this
            information during the payment process.  This field is required for:  -
            Debit transactions on Cielo and Comercio Latino.  - Transactions with
            Brazilian-issued cards on Visa Acceptance through VisaNet.  **China
            UnionPayCard Transactions on China UnionPay:** Possible values:  - C:
            Domestic credit card  - D: Domestic debit card  - F: International credit
            card  - I: International debit card  When the value is D, the e-commerce
            indicator and CAVV fields must be included in the authorization request.
            When the value is C, F or I the card verification number, expiration
            month and expiration year fields must in included in the authorization
            request.  **Cielo and Comercio Latino Credit Card Transactions:** On
            these processors, this field is supported only for authorizations.
            Possible values:  - CR: Credit card  - DB: Debit card       **Visa
            Platform Connect Credit Card Transactions:** This field is supported for
            all card types on Visa Platform Connect. For combo **card present**
            transactions with Mastercard on Brazilian-issued cards, possible values:
            - CR: Credit card  - DB: Debit Card  For combo **card not present**
            transactions with Mastercard on Brazilian-issued cards, possible values:
            - C: Credit card  - D: Debit card  A value of CR or DB in the useAs field
            takes precedence over any value in the Source Account Type field.
        additional_properties (Dict[str, Any]): The additional properties for the
            model.

    """

    # Create a mapping from Model property names to API property names
    _names = {
        "number": "number",
        "expiration_month": "expirationMonth",
        "expiration_year": "expirationYear",
        "mtype": "type",
        "security_code": "securityCode",
        "use_as": "useAs",
    }

    _optionals = [
        "number",
        "expiration_month",
        "expiration_year",
        "mtype",
        "security_code",
        "use_as",
    ]

    def __init__(
        self,
        number=APIHelper.SKIP,
        expiration_month=APIHelper.SKIP,
        expiration_year=APIHelper.SKIP,
        mtype=APIHelper.SKIP,
        security_code=APIHelper.SKIP,
        use_as=APIHelper.SKIP,
        additional_properties=None):
        """Initialize a Card10 instance."""
        # Initialize members of the class
        if number is not APIHelper.SKIP:
            self.number = number
        if expiration_month is not APIHelper.SKIP:
            self.expiration_month = expiration_month
        if expiration_year is not APIHelper.SKIP:
            self.expiration_year = expiration_year
        if mtype is not APIHelper.SKIP:
            self.mtype = mtype
        if security_code is not APIHelper.SKIP:
            self.security_code = security_code
        if use_as is not APIHelper.SKIP:
            self.use_as = use_as

        # 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
        number =\
            dictionary.get("number")\
            if dictionary.get("number")\
                else APIHelper.SKIP
        expiration_month =\
            dictionary.get("expirationMonth")\
            if dictionary.get("expirationMonth")\
                else APIHelper.SKIP
        expiration_year =\
            dictionary.get("expirationYear")\
            if dictionary.get("expirationYear")\
                else APIHelper.SKIP
        mtype =\
            dictionary.get("type")\
            if dictionary.get("type")\
                else APIHelper.SKIP
        security_code =\
            dictionary.get("securityCode")\
            if dictionary.get("securityCode")\
                else APIHelper.SKIP
        use_as =\
            dictionary.get("useAs")\
            if dictionary.get("useAs")\
                else APIHelper.SKIP

        additional_properties = APIHelper.get_additional_properties(
            dictionary={k: v for k, v in dictionary.items()
                        if k not in cls._names.values()},
            unboxing_function=lambda value: value)

        # Return an object of this model
        return cls(number,
                   expiration_month,
                   expiration_year,
                   mtype,
                   security_code,
                   use_as,
                   additional_properties)

    def __repr__(self):
        """Return a unambiguous string representation."""
        _number=(
            self.number
            if hasattr(self, "number")
            else None
        )
        _expiration_month=(
            self.expiration_month
            if hasattr(self, "expiration_month")
            else None
        )
        _expiration_year=(
            self.expiration_year
            if hasattr(self, "expiration_year")
            else None
        )
        _mtype=(
            self.mtype
            if hasattr(self, "mtype")
            else None
        )
        _security_code=(
            self.security_code
            if hasattr(self, "security_code")
            else None
        )
        _use_as=(
            self.use_as
            if hasattr(self, "use_as")
            else None
        )
        _additional_properties=self.additional_properties
        return (
            f"{self.__class__.__name__}("
            f"number={_number!r}, "
            f"expiration_month={_expiration_month!r}, "
            f"expiration_year={_expiration_year!r}, "
            f"mtype={_mtype!r}, "
            f"security_code={_security_code!r}, "
            f"use_as={_use_as!r}, "
            f"additional_properties={_additional_properties!r}, "
            f")"
        )

    def __str__(self):
        """Return a human-readable string representation."""
        _number=(
            self.number
            if hasattr(self, "number")
            else None
        )
        _expiration_month=(
            self.expiration_month
            if hasattr(self, "expiration_month")
            else None
        )
        _expiration_year=(
            self.expiration_year
            if hasattr(self, "expiration_year")
            else None
        )
        _mtype=(
            self.mtype
            if hasattr(self, "mtype")
            else None
        )
        _security_code=(
            self.security_code
            if hasattr(self, "security_code")
            else None
        )
        _use_as=(
            self.use_as
            if hasattr(self, "use_as")
            else None
        )
        _additional_properties=self.additional_properties
        return (
            f"{self.__class__.__name__}("
            f"number={_number!s}, "
            f"expiration_month={_expiration_month!s}, "
            f"expiration_year={_expiration_year!s}, "
            f"mtype={_mtype!s}, "
            f"security_code={_security_code!s}, "
            f"use_as={_use_as!s}, "
            f"additional_properties={_additional_properties!s}, "
            f")"
        )
