Source code for worldline.connect.sdk.v1.domain.browser_data

# -*- coding: utf-8 -*-
#
# This class was auto-generated from the API references found at
# https://apireference.connect.worldline-solutions.com/
#
from typing import Optional

from worldline.connect.sdk.domain.data_object import DataObject




class BrowserData(DataObject):
    """
    | Object containing information regarding the browser of the customer
    """

    __color_depth: Optional[int] = None
    __inner_height: Optional[str] = None
    __inner_width: Optional[str] = None
    __java_enabled: Optional[bool] = None
    __java_script_enabled: Optional[bool] = None
    __screen_height: Optional[str] = None
    __screen_width: Optional[str] = None

    @property
    def color_depth(self) -> Optional[int]:
        """
        | ColorDepth in bits. Value is returned from the screen.colorDepth property.
        
        | If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.
        
        | Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

        Type: int
        """
        return self.__color_depth

    @color_depth.setter
    def color_depth(self, value: Optional[int]) -> None:
        self.__color_depth = value

    @property
    def inner_height(self) -> Optional[str]:
        """
        | The innerHeight of the frame in case you are capturing your payments in a frame. We will use this to validate if the height provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.

        Type: str
        """
        return self.__inner_height

    @inner_height.setter
    def inner_height(self, value: Optional[str]) -> None:
        self.__inner_height = value

    @property
    def inner_width(self) -> Optional[str]:
        """
        | The innerWidth of the frame in case you are capturing your payments in a frame. We will use this to validate if the width provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.

        Type: str
        """
        return self.__inner_width

    @inner_width.setter
    def inner_width(self, value: Optional[str]) -> None:
        self.__inner_width = value

    @property
    def java_enabled(self) -> Optional[bool]:
        """
        | true =Java is enabled in the browser
        
        | false = Java is not enabled in the browser
        
        | Value is returned from the navigator.javaEnabled property.
        
        | If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.
        
        | Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

        Type: bool
        """
        return self.__java_enabled

    @java_enabled.setter
    def java_enabled(self, value: Optional[bool]) -> None:
        self.__java_enabled = value

    @property
    def java_script_enabled(self) -> Optional[bool]:
        """
        | true = JavaScript is enabled in the browser
        
        | false = JavaScript is not enabled in the browser
        
        | Note: Required in future 3-D Secure version 2.2.

        Type: bool
        """
        return self.__java_script_enabled

    @java_script_enabled.setter
    def java_script_enabled(self, value: Optional[bool]) -> None:
        self.__java_script_enabled = value

    @property
    def screen_height(self) -> Optional[str]:
        """
        | Height of the screen in pixels. Value is returned from the screen.height property.
        
        | If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.
        
        | Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

        Type: str
        """
        return self.__screen_height

    @screen_height.setter
    def screen_height(self, value: Optional[str]) -> None:
        self.__screen_height = value

    @property
    def screen_width(self) -> Optional[str]:
        """
        | Width of the screen in pixels. Value is returned from the screen.width property.
        
        | If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.
        
        | Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

        Type: str
        """
        return self.__screen_width

    @screen_width.setter
    def screen_width(self, value: Optional[str]) -> None:
        self.__screen_width = value



    def to_dictionary(self) -> dict:
        dictionary = super(BrowserData, self).to_dictionary()
        if self.color_depth is not None:
            dictionary['colorDepth'] = self.color_depth
        if self.inner_height is not None:
            dictionary['innerHeight'] = self.inner_height
        if self.inner_width is not None:
            dictionary['innerWidth'] = self.inner_width
        if self.java_enabled is not None:
            dictionary['javaEnabled'] = self.java_enabled
        if self.java_script_enabled is not None:
            dictionary['javaScriptEnabled'] = self.java_script_enabled
        if self.screen_height is not None:
            dictionary['screenHeight'] = self.screen_height
        if self.screen_width is not None:
            dictionary['screenWidth'] = self.screen_width
        return dictionary




    def from_dictionary(self, dictionary: dict) -> 'BrowserData':
        super(BrowserData, self).from_dictionary(dictionary)
        if 'colorDepth' in dictionary:
            self.color_depth = dictionary['colorDepth']
        if 'innerHeight' in dictionary:
            self.inner_height = dictionary['innerHeight']
        if 'innerWidth' in dictionary:
            self.inner_width = dictionary['innerWidth']
        if 'javaEnabled' in dictionary:
            self.java_enabled = dictionary['javaEnabled']
        if 'javaScriptEnabled' in dictionary:
            self.java_script_enabled = dictionary['javaScriptEnabled']
        if 'screenHeight' in dictionary:
            self.screen_height = dictionary['screenHeight']
        if 'screenWidth' in dictionary:
            self.screen_width = dictionary['screenWidth']
        return self