"""paypalserversdk.

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

# ruff: noqa: E501
from paypalserversdk.api_helper import APIHelper


class ExperienceContext(object):
    """Implementation of the 'Experience Context' model.

    Customizes the payer experience during the approval process for the payment.

    Attributes:
        brand_name (str): The label that overrides the business name in the PayPal
            account on the PayPal site. The pattern is defined by an external party
            and supports Unicode.
        locale (str): The [language tag](https://tools.ietf.org/html/bcp47#section-2)
            for the language in which to localize the error-related strings, such as
            messages, issues, and suggested actions. The tag is made up of the [ISO
            639-2 language
            code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the
            optional [ISO-15924 script
            tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166
            alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region
            code](https://unstats.un.org/unsd/methodology/m49/).
        shipping_preference (ExperienceContextShippingPreference): The location from
            which the shipping address is derived.
        return_url (str): Describes the URL.
        cancel_url (str): Describes the URL.

    """

    # Create a mapping from Model property names to API property names
    _names = {
        "brand_name": "brand_name",
        "locale": "locale",
        "shipping_preference": "shipping_preference",
        "return_url": "return_url",
        "cancel_url": "cancel_url",
    }

    _optionals = [
        "brand_name",
        "locale",
        "shipping_preference",
        "return_url",
        "cancel_url",
    ]

    def __init__(
        self,
        brand_name=APIHelper.SKIP,
        locale=APIHelper.SKIP,
        shipping_preference="GET_FROM_FILE",
        return_url=APIHelper.SKIP,
        cancel_url=APIHelper.SKIP):
        """Initialize a ExperienceContext instance."""
        # Initialize members of the class
        if brand_name is not APIHelper.SKIP:
            self.brand_name = brand_name
        if locale is not APIHelper.SKIP:
            self.locale = locale
        self.shipping_preference = shipping_preference
        if return_url is not APIHelper.SKIP:
            self.return_url = return_url
        if cancel_url is not APIHelper.SKIP:
            self.cancel_url = cancel_url

    @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
        brand_name =\
            dictionary.get("brand_name")\
            if dictionary.get("brand_name")\
                else APIHelper.SKIP
        locale =\
            dictionary.get("locale")\
            if dictionary.get("locale")\
                else APIHelper.SKIP
        shipping_preference =\
            dictionary.get("shipping_preference")\
            if dictionary.get("shipping_preference")\
                else "GET_FROM_FILE"
        return_url =\
            dictionary.get("return_url")\
            if dictionary.get("return_url")\
                else APIHelper.SKIP
        cancel_url =\
            dictionary.get("cancel_url")\
            if dictionary.get("cancel_url")\
                else APIHelper.SKIP

        # Return an object of this model
        return cls(brand_name,
                   locale,
                   shipping_preference,
                   return_url,
                   cancel_url)

    def __repr__(self):
        """Return a unambiguous string representation."""
        _brand_name=(
            self.brand_name
            if hasattr(self, "brand_name")
            else None
        )
        _locale=(
            self.locale
            if hasattr(self, "locale")
            else None
        )
        _shipping_preference=(
            self.shipping_preference
            if hasattr(self, "shipping_preference")
            else None
        )
        _return_url=(
            self.return_url
            if hasattr(self, "return_url")
            else None
        )
        _cancel_url=(
            self.cancel_url
            if hasattr(self, "cancel_url")
            else None
        )
        return (
            f"{self.__class__.__name__}("
            f"brand_name={_brand_name!r}, "
            f"locale={_locale!r}, "
            f"shipping_preference={_shipping_preference!r}, "
            f"return_url={_return_url!r}, "
            f"cancel_url={_cancel_url!r}, "
            f")"
        )

    def __str__(self):
        """Return a human-readable string representation."""
        _brand_name=(
            self.brand_name
            if hasattr(self, "brand_name")
            else None
        )
        _locale=(
            self.locale
            if hasattr(self, "locale")
            else None
        )
        _shipping_preference=(
            self.shipping_preference
            if hasattr(self, "shipping_preference")
            else None
        )
        _return_url=(
            self.return_url
            if hasattr(self, "return_url")
            else None
        )
        _cancel_url=(
            self.cancel_url
            if hasattr(self, "cancel_url")
            else None
        )
        return (
            f"{self.__class__.__name__}("
            f"brand_name={_brand_name!s}, "
            f"locale={_locale!s}, "
            f"shipping_preference={_shipping_preference!s}, "
            f"return_url={_return_url!s}, "
            f"cancel_url={_cancel_url!s}, "
            f")"
        )
