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

fortisapi/models/broad_info.py

@@ -0,0 +1,241 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class BroadInfo(object):
+    """Implementation of the 'BroadInfo' model.
+
+    Until EMV 3DS 2.2.0:
+    Unstructured information sent between the 3DS Server, the DS and the ACS.
+    This field is not required to be filled by the Requestor and the requirements for
+    the presence of this field are DS specific.
+    Starting from EMV 3DS 2.3.1:
+    Structured information sent between the 3DS Server, the DS and the ACS. 2.3.1
+    structure is defined below. Accepted value length is maximum 4096 characters.
+    This field is optional.
+
+    Attributes:
+        category (CategoryEnum): Indicates the category/type of information. This
+            field is required. >01 - General > >02 - Certificate expiry > >03 - Fraud
+            alert > >04 - Operational alert > >05 - Transactional data > >06 - Other
+            > >80 through 99 - PS-specific value (dependent on the payment scheme
+            type) >
+        description (str): Information to be broadcasted to the recipients. Accepted
+            value length is maximum 4000 characters. This field is optional.
+        expire_date (str): The date after which the relevance of the broadcasted
+            information (e.g., ceritifacte expiration dates) expires. The accepted
+            value length is 8 characters. The accepted format is YYYYMMDD.
+        severity (SeverityEnum): Indicates the importance/severity level of the
+            broadcasted information. This field is required. >01 - Critical.
+            Immediate action to be taken by recipient > >02 - Major. Major impact;
+            Upcoming action to be taken by recipient > >03 - Minor. Minor impact;
+            Upcoming action to be taken by recipient > >04 - Informational.
+            Informational only with no immediate action by recipient >
+        recipients (RecipientsEnum): Indicates the intended recipient(s) of the
+            broadcasted information. This field is required. >01 - 3DS SDK > >02 -
+            3DS Server > >03 - DS > >04 - ACS >
+        source (SourceEnum): Indicates the source of the broadcasted information.
+            This field is required. >01 - 3DS Server > >02 - DS > >03 - ACS >
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "category": "category",
+        "description": "description",
+        "expire_date": "expire_date",
+        "severity": "severity",
+        "recipients": "recipients",
+        "source": "source",
+    }
+
+    _optionals = [
+        "category",
+        "description",
+        "expire_date",
+        "severity",
+        "recipients",
+        "source",
+    ]
+
+    def __init__(
+        self,
+        category=APIHelper.SKIP,
+        description=APIHelper.SKIP,
+        expire_date=APIHelper.SKIP,
+        severity=APIHelper.SKIP,
+        recipients=APIHelper.SKIP,
+        source=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a BroadInfo instance."""
+        # Initialize members of the class
+        if category is not APIHelper.SKIP:
+            self.category = category
+        if description is not APIHelper.SKIP:
+            self.description = description
+        if expire_date is not APIHelper.SKIP:
+            self.expire_date = expire_date
+        if severity is not APIHelper.SKIP:
+            self.severity = severity
+        if recipients is not APIHelper.SKIP:
+            self.recipients = recipients
+        if source is not APIHelper.SKIP:
+            self.source = source
+
+        # 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
+        category =\
+            dictionary.get("category")\
+            if dictionary.get("category")\
+                else APIHelper.SKIP
+        description =\
+            dictionary.get("description")\
+            if dictionary.get("description")\
+                else APIHelper.SKIP
+        expire_date =\
+            dictionary.get("expire_date")\
+            if dictionary.get("expire_date")\
+                else APIHelper.SKIP
+        severity =\
+            dictionary.get("severity")\
+            if dictionary.get("severity")\
+                else APIHelper.SKIP
+        recipients =\
+            dictionary.get("recipients")\
+            if dictionary.get("recipients")\
+                else APIHelper.SKIP
+        source =\
+            dictionary.get("source")\
+            if dictionary.get("source")\
+                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(category,
+                   description,
+                   expire_date,
+                   severity,
+                   recipients,
+                   source,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _category=(
+            self.category
+            if hasattr(self, "category")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _expire_date=(
+            self.expire_date
+            if hasattr(self, "expire_date")
+            else None
+        )
+        _severity=(
+            self.severity
+            if hasattr(self, "severity")
+            else None
+        )
+        _recipients=(
+            self.recipients
+            if hasattr(self, "recipients")
+            else None
+        )
+        _source=(
+            self.source
+            if hasattr(self, "source")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"category={_category!r}, "
+            f"description={_description!r}, "
+            f"expire_date={_expire_date!r}, "
+            f"severity={_severity!r}, "
+            f"recipients={_recipients!r}, "
+            f"source={_source!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _category=(
+            self.category
+            if hasattr(self, "category")
+            else None
+        )
+        _description=(
+            self.description
+            if hasattr(self, "description")
+            else None
+        )
+        _expire_date=(
+            self.expire_date
+            if hasattr(self, "expire_date")
+            else None
+        )
+        _severity=(
+            self.severity
+            if hasattr(self, "severity")
+            else None
+        )
+        _recipients=(
+            self.recipients
+            if hasattr(self, "recipients")
+            else None
+        )
+        _source=(
+            self.source
+            if hasattr(self, "source")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"category={_category!s}, "
+            f"description={_description!s}, "
+            f"expire_date={_expire_date!s}, "
+            f"severity={_severity!s}, "
+            f"recipients={_recipients!s}, "
+            f"source={_source!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )

fortisapi/models/browser_information.py

@@ -0,0 +1,401 @@
+"""fortisapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: E501
+from fortisapi.api_helper import APIHelper
+
+
+class BrowserInformation(object):
+    """Implementation of the 'BrowserInformation' model.
+
+    Contains browser information.
+    This field is required when device_channel=02 (BRW).
+
+    Attributes:
+        browser_accept_header (str): Exact content of the HTTP accept headers as sent
+            to the 3DS Requestor from the Cardholder's browser. This field is limited
+            to maximum 2048 characters  and if the total length exceeds the limit,
+            the 3DS Server truncates the excess portion.   This field is required for
+            requests where device_channel=02 (BRW).
+        browser_java_enabled (bool): Boolean that represents the ability of the
+            cardholder browser to execute Java. Value is returned from the
+            navigator.javaEnabled property.  Depending on the message version, the
+            field is required for requests: - with message version = 2.1.0 and
+            device_channel = 02 (BRW). - with message version = 2.2.0 and
+            device_channel = 02 (BRW) and browser_javascript_enabled = true.
+        browser_language (str): Value representing the browser language as defined in
+            IETF BCP47.  Until EMV 3DS 2.2.0: The value is limited to 1-8 characters.
+            If the value exceeds 8 characters, it will be truncated to a semantically
+            valid value, if possible. The value is returned from navigator.language
+            property.  This field is required for requests where device_channel = 02
+            (BRW). In other cases this field is optional.  Starting from EMV 3DS
+            2.3.1: The value is limited to 35 characters. If the value exceeds 35
+            characters, it will be truncated to a semantically valid value, if
+            possible. The value is returned from navigator.language property.  This
+            field is required for requests where device_channel = 02 (BRW) and
+            browser_javascript_enabled = true. In other cases this field is optional.
+        browser_color_depth (str): Value representing the bit depth of the color
+            palette for displaying images, in bits per pixel. Obtained from
+            Cardholder browser using the screen.colorDepth property. The field is
+            limited to 1-2 characters.  If the value is not in the accepted values,
+            it will be resolved to the first accepted value lower from the one
+            provided.  Depending on the message version, the field is required for
+            requests: - with message version = 2.1.0 and device_channel = 02 (BRW). -
+            with message version = 2.2.0 and device_channel = 02 (BRW) and
+            browser_javascript_enabled = true. >1 - 1 bit > >4 - 4 bits > >8 - 8 bits
+            > >15 - 15 bits > >16 - 16 bits > >24 - 24 bits > >32 - 32 bits > >48 -
+            48 bits >
+        browser_screen_height (int): Total height of the Cardholder's screen in
+            pixels. Value is returned from the screen.height property. The value is
+            limited to 1-6 characters.  Depending on the message version, the field
+            is required for requests: - with message version = 2.1.0 and
+            device_channel = 02 (BRW). - with message version = 2.2.0 and
+            device_channel = 02 (BRW) and
+            browserJavascripbrowser_javascript_enabledtEnabled = true.
+        browser_screen_width (int): Total width of the Cardholder's screen in pixels.
+            Value is returned from the screen.width property. The value is limited to
+            1-6 characters.  Depending on the message version, the field is required
+            for requests: - with message version = 2.1.0 and device_channel = 02
+            (BRW). - with message version = 2.2.0 and device_channel = 02 (BRW) and
+            browser_javascript_enabled = true.
+        browser_tz (int): Time difference between UTC time and the Cardholder browser
+            local time, in minutes. The field is limited to 1-5 characters where the
+            values is returned from the getTimezoneOffset() method.  Depending on the
+            message version, the field is required for requests: - with message
+            version = 2.1.0 and device_channel = 02 (BRW). - with message version =
+            2.2.0 and device_channel = 02 (BRW) and browser_javascript_enabled = true.
+        browser_user_agent (str): Exact content of the HTTP user-agent header. The
+            field is limited to maximum 2048 caracters. If the total length of the
+            User-Agent sent by the browser exceeds 2048 characters, the 3DS Server
+            truncates the excess portion.  This field is required for requests where
+            device_channel = 02 (BRW).
+        challenge_window_size (ChallengeWindowSizeEnum): Dimensions of the challenge
+            window that has been displayed to the Cardholder. The ACS shall reply
+            with content that is formatted to appropriately render in this window to
+            provide the best possible user experience.  Preconfigured sizes are width
+            X height in pixels of the window displayed in the Cardholder browser
+            window. This is used only to prepare the CReq request and it is not part
+            of the AReq flow. If not present it will be omitted.  However, when
+            sending the Challenge Request, this field is required when device_channel
+            = 02 (BRW). >01 - 250 x 400 > >02 - 390 x 400 > >03 - 500 x 600 > >04 -
+            600 x 400 > >05 - Full screen >
+        browser_javascript_enabled (bool): Boolean that represents the ability of the
+            cardholder browser to execute JavaScript.  This field is required for
+            requests where device_channel = 02 (BRW). Available for supporting EMV
+            3DS 2.2.0 and later versions.
+        accept_language (List[str]): Value representing the browser language
+            preference present in the http header, as defined in IETF BCP 47.  The
+            value is limited to 1-99 elements. Each element should contain a maximum
+            of 100 characters.  This field is required for requests where
+            device_channel = 02 (BRW). Available for supporting EMV 3DS 2.3.1 and
+            later versions.
+        additional_properties (Dict[str, object]): The additional properties for the
+            model.
+
+    """
+
+    # Create a mapping from Model property names to API property names
+    _names = {
+        "browser_accept_header": "browser_accept_header",
+        "browser_java_enabled": "browser_java_enabled",
+        "browser_language": "browser_language",
+        "browser_color_depth": "browser_color_depth",
+        "browser_screen_height": "browser_screen_height",
+        "browser_screen_width": "browser_screen_width",
+        "browser_tz": "browser_tz",
+        "browser_user_agent": "browser_user_agent",
+        "challenge_window_size": "challenge_window_size",
+        "browser_javascript_enabled": "browser_javascript_enabled",
+        "accept_language": "accept_language",
+    }
+
+    _optionals = [
+        "browser_accept_header",
+        "browser_java_enabled",
+        "browser_language",
+        "browser_color_depth",
+        "browser_screen_height",
+        "browser_screen_width",
+        "browser_tz",
+        "browser_user_agent",
+        "challenge_window_size",
+        "browser_javascript_enabled",
+        "accept_language",
+    ]
+
+    def __init__(
+        self,
+        browser_accept_header=APIHelper.SKIP,
+        browser_java_enabled=APIHelper.SKIP,
+        browser_language=APIHelper.SKIP,
+        browser_color_depth=APIHelper.SKIP,
+        browser_screen_height=APIHelper.SKIP,
+        browser_screen_width=APIHelper.SKIP,
+        browser_tz=APIHelper.SKIP,
+        browser_user_agent=APIHelper.SKIP,
+        challenge_window_size=APIHelper.SKIP,
+        browser_javascript_enabled=APIHelper.SKIP,
+        accept_language=APIHelper.SKIP,
+        additional_properties=None):
+        """Initialize a BrowserInformation instance."""
+        # Initialize members of the class
+        if browser_accept_header is not APIHelper.SKIP:
+            self.browser_accept_header = browser_accept_header
+        if browser_java_enabled is not APIHelper.SKIP:
+            self.browser_java_enabled = browser_java_enabled
+        if browser_language is not APIHelper.SKIP:
+            self.browser_language = browser_language
+        if browser_color_depth is not APIHelper.SKIP:
+            self.browser_color_depth = browser_color_depth
+        if browser_screen_height is not APIHelper.SKIP:
+            self.browser_screen_height = browser_screen_height
+        if browser_screen_width is not APIHelper.SKIP:
+            self.browser_screen_width = browser_screen_width
+        if browser_tz is not APIHelper.SKIP:
+            self.browser_tz = browser_tz
+        if browser_user_agent is not APIHelper.SKIP:
+            self.browser_user_agent = browser_user_agent
+        if challenge_window_size is not APIHelper.SKIP:
+            self.challenge_window_size = challenge_window_size
+        if browser_javascript_enabled is not APIHelper.SKIP:
+            self.browser_javascript_enabled = browser_javascript_enabled
+        if accept_language is not APIHelper.SKIP:
+            self.accept_language = accept_language
+
+        # 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
+        browser_accept_header =\
+            dictionary.get("browser_accept_header")\
+            if dictionary.get("browser_accept_header")\
+                else APIHelper.SKIP
+        browser_java_enabled =\
+            dictionary.get("browser_java_enabled")\
+            if "browser_java_enabled" in dictionary.keys()\
+                else APIHelper.SKIP
+        browser_language =\
+            dictionary.get("browser_language")\
+            if dictionary.get("browser_language")\
+                else APIHelper.SKIP
+        browser_color_depth =\
+            dictionary.get("browser_color_depth")\
+            if dictionary.get("browser_color_depth")\
+                else APIHelper.SKIP
+        browser_screen_height =\
+            dictionary.get("browser_screen_height")\
+            if dictionary.get("browser_screen_height")\
+                else APIHelper.SKIP
+        browser_screen_width =\
+            dictionary.get("browser_screen_width")\
+            if dictionary.get("browser_screen_width")\
+                else APIHelper.SKIP
+        browser_tz =\
+            dictionary.get("browser_tz")\
+            if dictionary.get("browser_tz")\
+                else APIHelper.SKIP
+        browser_user_agent =\
+            dictionary.get("browser_user_agent")\
+            if dictionary.get("browser_user_agent")\
+                else APIHelper.SKIP
+        challenge_window_size =\
+            dictionary.get("challenge_window_size")\
+            if dictionary.get("challenge_window_size")\
+                else APIHelper.SKIP
+        browser_javascript_enabled =\
+            dictionary.get("browser_javascript_enabled")\
+            if "browser_javascript_enabled" in dictionary.keys()\
+                else APIHelper.SKIP
+        accept_language =\
+            dictionary.get("accept_language")\
+            if dictionary.get("accept_language")\
+                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(browser_accept_header,
+                   browser_java_enabled,
+                   browser_language,
+                   browser_color_depth,
+                   browser_screen_height,
+                   browser_screen_width,
+                   browser_tz,
+                   browser_user_agent,
+                   challenge_window_size,
+                   browser_javascript_enabled,
+                   accept_language,
+                   additional_properties)
+
+    def __repr__(self):
+        """Return a unambiguous string representation."""
+        _browser_accept_header=(
+            self.browser_accept_header
+            if hasattr(self, "browser_accept_header")
+            else None
+        )
+        _browser_java_enabled=(
+            self.browser_java_enabled
+            if hasattr(self, "browser_java_enabled")
+            else None
+        )
+        _browser_language=(
+            self.browser_language
+            if hasattr(self, "browser_language")
+            else None
+        )
+        _browser_color_depth=(
+            self.browser_color_depth
+            if hasattr(self, "browser_color_depth")
+            else None
+        )
+        _browser_screen_height=(
+            self.browser_screen_height
+            if hasattr(self, "browser_screen_height")
+            else None
+        )
+        _browser_screen_width=(
+            self.browser_screen_width
+            if hasattr(self, "browser_screen_width")
+            else None
+        )
+        _browser_tz=(
+            self.browser_tz
+            if hasattr(self, "browser_tz")
+            else None
+        )
+        _browser_user_agent=(
+            self.browser_user_agent
+            if hasattr(self, "browser_user_agent")
+            else None
+        )
+        _challenge_window_size=(
+            self.challenge_window_size
+            if hasattr(self, "challenge_window_size")
+            else None
+        )
+        _browser_javascript_enabled=(
+            self.browser_javascript_enabled
+            if hasattr(self, "browser_javascript_enabled")
+            else None
+        )
+        _accept_language=(
+            self.accept_language
+            if hasattr(self, "accept_language")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"browser_accept_header={_browser_accept_header!r}, "
+            f"browser_java_enabled={_browser_java_enabled!r}, "
+            f"browser_language={_browser_language!r}, "
+            f"browser_color_depth={_browser_color_depth!r}, "
+            f"browser_screen_height={_browser_screen_height!r}, "
+            f"browser_screen_width={_browser_screen_width!r}, "
+            f"browser_tz={_browser_tz!r}, "
+            f"browser_user_agent={_browser_user_agent!r}, "
+            f"challenge_window_size={_challenge_window_size!r}, "
+            f"browser_javascript_enabled={_browser_javascript_enabled!r}, "
+            f"accept_language={_accept_language!r}, "
+            f"additional_properties={_additional_properties!r}, "
+            f")"
+        )
+
+    def __str__(self):
+        """Return a human-readable string representation."""
+        _browser_accept_header=(
+            self.browser_accept_header
+            if hasattr(self, "browser_accept_header")
+            else None
+        )
+        _browser_java_enabled=(
+            self.browser_java_enabled
+            if hasattr(self, "browser_java_enabled")
+            else None
+        )
+        _browser_language=(
+            self.browser_language
+            if hasattr(self, "browser_language")
+            else None
+        )
+        _browser_color_depth=(
+            self.browser_color_depth
+            if hasattr(self, "browser_color_depth")
+            else None
+        )
+        _browser_screen_height=(
+            self.browser_screen_height
+            if hasattr(self, "browser_screen_height")
+            else None
+        )
+        _browser_screen_width=(
+            self.browser_screen_width
+            if hasattr(self, "browser_screen_width")
+            else None
+        )
+        _browser_tz=(
+            self.browser_tz
+            if hasattr(self, "browser_tz")
+            else None
+        )
+        _browser_user_agent=(
+            self.browser_user_agent
+            if hasattr(self, "browser_user_agent")
+            else None
+        )
+        _challenge_window_size=(
+            self.challenge_window_size
+            if hasattr(self, "challenge_window_size")
+            else None
+        )
+        _browser_javascript_enabled=(
+            self.browser_javascript_enabled
+            if hasattr(self, "browser_javascript_enabled")
+            else None
+        )
+        _accept_language=(
+            self.accept_language
+            if hasattr(self, "accept_language")
+            else None
+        )
+        _additional_properties=self.additional_properties
+        return (
+            f"{self.__class__.__name__}("
+            f"browser_accept_header={_browser_accept_header!s}, "
+            f"browser_java_enabled={_browser_java_enabled!s}, "
+            f"browser_language={_browser_language!s}, "
+            f"browser_color_depth={_browser_color_depth!s}, "
+            f"browser_screen_height={_browser_screen_height!s}, "
+            f"browser_screen_width={_browser_screen_width!s}, "
+            f"browser_tz={_browser_tz!s}, "
+            f"browser_user_agent={_browser_user_agent!s}, "
+            f"challenge_window_size={_challenge_window_size!s}, "
+            f"browser_javascript_enabled={_browser_javascript_enabled!s}, "
+            f"accept_language={_accept_language!s}, "
+            f"additional_properties={_additional_properties!s}, "
+            f")"
+        )