onlinepayments-sdk-python3 4.23.0__zip → 5.1.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/customer_device.py

@@ -1,26 +1,25 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.browser_data import BrowserData
+from typing import Optional
+
+from .browser_data import BrowserData
+from .data_object import DataObject
 
 
 class CustomerDevice(DataObject):
-    """
-    | Object containing information on the device and browser of the customer
-    """
-
-    __accept_header = None
-    __browser_data = None
-    __device_fingerprint = None
-    __ip_address = None
-    __locale = None
-    __timezone_offset_utc_minutes = None
-    __user_agent = None
+
+    __accept_header: Optional[str] = None
+    __browser_data: Optional[BrowserData] = None
+    __device_fingerprint: Optional[str] = None
+    __ip_address: Optional[str] = None
+    __locale: Optional[str] = None
+    __timezone_offset_utc_minutes: Optional[str] = None
+    __user_agent: Optional[str] = None
 
     @property
-    def accept_header(self) -> str:
+    def accept_header(self) -> Optional[str]:
         """
         | The accept-header of the customer client from the HTTP Headers.
 
@@ -29,11 +28,11 @@ class CustomerDevice(DataObject):
         return self.__accept_header
 
     @accept_header.setter
-    def accept_header(self, value: str):
+    def accept_header(self, value: Optional[str]) -> None:
         self.__accept_header = value
 
     @property
-    def browser_data(self) -> BrowserData:
+    def browser_data(self) -> Optional[BrowserData]:
         """
         | Object containing information regarding the browser of the customer
 
@@ -42,11 +41,11 @@ class CustomerDevice(DataObject):
         return self.__browser_data
 
     @browser_data.setter
-    def browser_data(self, value: BrowserData):
+    def browser_data(self, value: Optional[BrowserData]) -> None:
         self.__browser_data = value
 
     @property
-    def device_fingerprint(self) -> str:
+    def device_fingerprint(self) -> Optional[str]:
         """
         | The session ID for the device fingerprint must match the one sent in the device fingerprint script.
 
@@ -55,11 +54,11 @@ class CustomerDevice(DataObject):
         return self.__device_fingerprint
 
     @device_fingerprint.setter
-    def device_fingerprint(self, value: str):
+    def device_fingerprint(self, value: Optional[str]) -> None:
         self.__device_fingerprint = value
 
     @property
-    def ip_address(self) -> str:
+    def ip_address(self) -> Optional[str]:
         """
         | The IP address of the customer client from the HTTP Headers.
 
@@ -68,14 +67,14 @@ class CustomerDevice(DataObject):
         return self.__ip_address
 
     @ip_address.setter
-    def ip_address(self, value: str):
+    def ip_address(self, value: Optional[str]) -> None:
         self.__ip_address = value
 
     @property
-    def locale(self) -> str:
+    def locale(self) -> Optional[str]:
         """
         | Locale of the client device/browser. Returned in the browser from the navigator.language 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.
 
         Type: str
@@ -83,14 +82,14 @@ class CustomerDevice(DataObject):
         return self.__locale
 
     @locale.setter
-    def locale(self, value: str):
+    def locale(self, value: Optional[str]) -> None:
         self.__locale = value
 
     @property
-    def timezone_offset_utc_minutes(self) -> str:
+    def timezone_offset_utc_minutes(self) -> Optional[str]:
         """
         | Offset in minutes of timezone of the client versus the UTC. Value is returned by the JavaScript getTimezoneOffset() Method.
-        
+        |
         | 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.
 
         Type: str
@@ -98,14 +97,14 @@ class CustomerDevice(DataObject):
         return self.__timezone_offset_utc_minutes
 
     @timezone_offset_utc_minutes.setter
-    def timezone_offset_utc_minutes(self, value: str):
+    def timezone_offset_utc_minutes(self, value: Optional[str]) -> None:
         self.__timezone_offset_utc_minutes = value
 
     @property
-    def user_agent(self) -> str:
+    def user_agent(self) -> Optional[str]:
         """
         | User-Agent of the client device/browser from the HTTP Headers.
-        
+        |
         | As a fall-back we will use the userAgent that might be included in the encryptedCustomerInput, but this is captured client side using JavaScript and might be different.
 
         Type: str
@@ -113,10 +112,10 @@ class CustomerDevice(DataObject):
         return self.__user_agent
 
     @user_agent.setter
-    def user_agent(self, value: str):
+    def user_agent(self, value: Optional[str]) -> None:
         self.__user_agent = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CustomerDevice, self).to_dictionary()
         if self.accept_header is not None:
             dictionary['acceptHeader'] = self.accept_header
@@ -134,7 +133,7 @@ class CustomerDevice(DataObject):
             dictionary['userAgent'] = self.user_agent
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CustomerDevice':
         super(CustomerDevice, self).from_dictionary(dictionary)
         if 'acceptHeader' in dictionary:
             self.accept_header = dictionary['acceptHeader']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/customer_device_output.py

@@ -1,19 +1,18 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class CustomerDeviceOutput(DataObject):
-    """
-    | Object containing information on the device and browser of the customer
-    """
 
-    __ip_address_country_code = None
+    __ip_address_country_code: Optional[str] = None
 
     @property
-    def ip_address_country_code(self) -> str:
+    def ip_address_country_code(self) -> Optional[str]:
         """
         | ISO 3166-1 alpha-2 country code
 
@@ -22,16 +21,16 @@ class CustomerDeviceOutput(DataObject):
         return self.__ip_address_country_code
 
     @ip_address_country_code.setter
-    def ip_address_country_code(self, value: str):
+    def ip_address_country_code(self, value: Optional[str]) -> None:
         self.__ip_address_country_code = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CustomerDeviceOutput, self).to_dictionary()
         if self.ip_address_country_code is not None:
             dictionary['ipAddressCountryCode'] = self.ip_address_country_code
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CustomerDeviceOutput':
         super(CustomerDeviceOutput, self).from_dictionary(dictionary)
         if 'ipAddressCountryCode' in dictionary:
             self.ip_address_country_code = dictionary['ipAddressCountryCode']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/customer_output.py

@@ -1,20 +1,19 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.customer_device_output import CustomerDeviceOutput
+from typing import Optional
+
+from .customer_device_output import CustomerDeviceOutput
+from .data_object import DataObject
 
 
 class CustomerOutput(DataObject):
-    """
-    | Object containing the details of the customer
-    """
 
-    __device = None
+    __device: Optional[CustomerDeviceOutput] = None
 
     @property
-    def device(self) -> CustomerDeviceOutput:
+    def device(self) -> Optional[CustomerDeviceOutput]:
         """
         | Object containing information on the device and browser of the customer
 
@@ -23,16 +22,16 @@ class CustomerOutput(DataObject):
         return self.__device
 
     @device.setter
-    def device(self, value: CustomerDeviceOutput):
+    def device(self, value: Optional[CustomerDeviceOutput]) -> None:
         self.__device = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CustomerOutput, self).to_dictionary()
         if self.device is not None:
             dictionary['device'] = self.device.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CustomerOutput':
         super(CustomerOutput, self).from_dictionary(dictionary)
         if 'device' in dictionary:
             if not isinstance(dictionary['device'], dict):

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/customer_payment_activity.py

@@ -1,21 +1,20 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class CustomerPaymentActivity(DataObject):
-    """
-    | Object containing data on the purchase history of the customer with you
-    """
 
-    __number_of_payment_attempts_last24_hours = None
-    __number_of_payment_attempts_last_year = None
-    __number_of_purchases_last6_months = None
+    __number_of_payment_attempts_last24_hours: Optional[int] = None
+    __number_of_payment_attempts_last_year: Optional[int] = None
+    __number_of_purchases_last6_months: Optional[int] = None
 
     @property
-    def number_of_payment_attempts_last24_hours(self) -> int:
+    def number_of_payment_attempts_last24_hours(self) -> Optional[int]:
         """
         | Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
 
@@ -24,11 +23,11 @@ class CustomerPaymentActivity(DataObject):
         return self.__number_of_payment_attempts_last24_hours
 
     @number_of_payment_attempts_last24_hours.setter
-    def number_of_payment_attempts_last24_hours(self, value: int):
+    def number_of_payment_attempts_last24_hours(self, value: Optional[int]) -> None:
         self.__number_of_payment_attempts_last24_hours = value
 
     @property
-    def number_of_payment_attempts_last_year(self) -> int:
+    def number_of_payment_attempts_last_year(self) -> Optional[int]:
         """
         | Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
 
@@ -37,11 +36,11 @@ class CustomerPaymentActivity(DataObject):
         return self.__number_of_payment_attempts_last_year
 
     @number_of_payment_attempts_last_year.setter
-    def number_of_payment_attempts_last_year(self, value: int):
+    def number_of_payment_attempts_last_year(self, value: Optional[int]) -> None:
         self.__number_of_payment_attempts_last_year = value
 
     @property
-    def number_of_purchases_last6_months(self) -> int:
+    def number_of_purchases_last6_months(self) -> Optional[int]:
         """
         | Number of successful purchases made by this customer with you in the last 6 months
 
@@ -50,10 +49,10 @@ class CustomerPaymentActivity(DataObject):
         return self.__number_of_purchases_last6_months
 
     @number_of_purchases_last6_months.setter
-    def number_of_purchases_last6_months(self, value: int):
+    def number_of_purchases_last6_months(self, value: Optional[int]) -> None:
         self.__number_of_purchases_last6_months = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CustomerPaymentActivity, self).to_dictionary()
         if self.number_of_payment_attempts_last24_hours is not None:
             dictionary['numberOfPaymentAttemptsLast24Hours'] = self.number_of_payment_attempts_last24_hours
@@ -63,7 +62,7 @@ class CustomerPaymentActivity(DataObject):
             dictionary['numberOfPurchasesLast6Months'] = self.number_of_purchases_last6_months
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CustomerPaymentActivity':
         super(CustomerPaymentActivity, self).from_dictionary(dictionary)
         if 'numberOfPaymentAttemptsLast24Hours' in dictionary:
             self.number_of_payment_attempts_last24_hours = dictionary['numberOfPaymentAttemptsLast24Hours']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/customer_token.py

@@ -1,20 +1,23 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.address import Address
-from onlinepayments.sdk.domain.company_information import CompanyInformation
-from onlinepayments.sdk.domain.personal_information_token import PersonalInformationToken
+from typing import Optional
+
+from .address import Address
+from .company_information import CompanyInformation
+from .data_object import DataObject
+from .personal_information_token import PersonalInformationToken
 
 
 class CustomerToken(DataObject):
-    __billing_address = None
-    __company_information = None
-    __personal_information = None
+
+    __billing_address: Optional[Address] = None
+    __company_information: Optional[CompanyInformation] = None
+    __personal_information: Optional[PersonalInformationToken] = None
 
     @property
-    def billing_address(self) -> Address:
+    def billing_address(self) -> Optional[Address]:
         """
         | Object containing billing address details.
 
@@ -23,11 +26,11 @@ class CustomerToken(DataObject):
         return self.__billing_address
 
     @billing_address.setter
-    def billing_address(self, value: Address):
+    def billing_address(self, value: Optional[Address]) -> None:
         self.__billing_address = value
 
     @property
-    def company_information(self) -> CompanyInformation:
+    def company_information(self) -> Optional[CompanyInformation]:
         """
         | Object containing company information
 
@@ -36,21 +39,21 @@ class CustomerToken(DataObject):
         return self.__company_information
 
     @company_information.setter
-    def company_information(self, value: CompanyInformation):
+    def company_information(self, value: Optional[CompanyInformation]) -> None:
         self.__company_information = value
 
     @property
-    def personal_information(self) -> PersonalInformationToken:
+    def personal_information(self) -> Optional[PersonalInformationToken]:
         """
         Type: :class:`onlinepayments.sdk.domain.personal_information_token.PersonalInformationToken`
         """
         return self.__personal_information
 
     @personal_information.setter
-    def personal_information(self, value: PersonalInformationToken):
+    def personal_information(self, value: Optional[PersonalInformationToken]) -> None:
         self.__personal_information = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(CustomerToken, self).to_dictionary()
         if self.billing_address is not None:
             dictionary['billingAddress'] = self.billing_address.to_dictionary()
@@ -60,7 +63,7 @@ class CustomerToken(DataObject):
             dictionary['personalInformation'] = self.personal_information.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'CustomerToken':
         super(CustomerToken, self).from_dictionary(dictionary)
         if 'billingAddress' in dictionary:
             if not isinstance(dictionary['billingAddress'], dict):

onlinepayments_sdk_python3-5.1.0/onlinepayments/sdk/domain/data_object.py

@@ -0,0 +1,34 @@
+from datetime import date, datetime, timezone
+
+
+class DataObject(object):
+    def to_dictionary(self) -> dict:
+        return {}
+
+    def from_dictionary(self, dictionary: dict) -> 'DataObject':
+        if not isinstance(dictionary, dict):
+            raise TypeError('value \'{}\' is not a dictionary'.format(dictionary))
+        return self
+
+    @staticmethod
+    def parse_date(s: str) -> date:
+        return date.fromisoformat(s)
+
+    @staticmethod
+    def format_date(d: date) -> str:
+        return d.isoformat()
+
+    @staticmethod
+    def parse_datetime(s: str) -> datetime:
+        if s.endswith('Z'):
+            s = s[:-1] + '+00:00'
+        return datetime.fromisoformat(s)
+
+    @staticmethod
+    def format_datetime(dt: datetime) -> str:
+        # isoformat(timespec='milliseconds') works fine, as long as there is a timezone
+        # if there isn't one, add the current timezone
+        if dt.tzinfo is None:
+            zone = datetime.fromtimestamp(dt.timestamp(), timezone.utc).astimezone().tzinfo
+            dt = datetime.fromtimestamp(dt.timestamp(), zone)
+        return dt.isoformat(timespec='milliseconds')

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/dcc_card_source.py

@@ -1,43 +1,46 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.card_info import CardInfo
+from typing import Optional
+
+from .card_info import CardInfo
+from .data_object import DataObject
 
 
 class DccCardSource(DataObject):
-    __card = None
-    __encrypted_customer_input = None
-    __hosted_tokenization_id = None
-    __token = None
+
+    __card: Optional[CardInfo] = None
+    __encrypted_customer_input: Optional[str] = None
+    __hosted_tokenization_id: Optional[str] = None
+    __token: Optional[str] = None
 
     @property
-    def card(self) -> CardInfo:
+    def card(self) -> Optional[CardInfo]:
         """
         Type: :class:`onlinepayments.sdk.domain.card_info.CardInfo`
         """
         return self.__card
 
     @card.setter
-    def card(self, value: CardInfo):
+    def card(self, value: Optional[CardInfo]) -> None:
         self.__card = value
 
     @property
-    def encrypted_customer_input(self) -> str:
+    def encrypted_customer_input(self) -> Optional[str]:
         """
-        | Data that was encrypted client-side that contains all customer-entered data elements, such as card data.
+        | Data that was encrypted client side containing all customer entered data elements like card data. Note: Because this data can only be submitted once to our system and contains encrypted card data you should not store it. As the data was captured within the context of a client session you also need to submit it to us before the session has expired.
 
         Type: str
         """
         return self.__encrypted_customer_input
 
     @encrypted_customer_input.setter
-    def encrypted_customer_input(self, value: str):
+    def encrypted_customer_input(self, value: Optional[str]) -> None:
         self.__encrypted_customer_input = value
 
     @property
-    def hosted_tokenization_id(self) -> str:
+    def hosted_tokenization_id(self) -> Optional[str]:
         """
         | An Id of a hosted tokenization session
 
@@ -46,11 +49,11 @@ class DccCardSource(DataObject):
         return self.__hosted_tokenization_id
 
     @hosted_tokenization_id.setter
-    def hosted_tokenization_id(self, value: str):
+    def hosted_tokenization_id(self, value: Optional[str]) -> None:
         self.__hosted_tokenization_id = value
 
     @property
-    def token(self) -> str:
+    def token(self) -> Optional[str]:
         """
         | An identifier that represents card details that have previously been stored
 
@@ -59,10 +62,10 @@ class DccCardSource(DataObject):
         return self.__token
 
     @token.setter
-    def token(self, value: str):
+    def token(self, value: Optional[str]) -> None:
         self.__token = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(DccCardSource, self).to_dictionary()
         if self.card is not None:
             dictionary['card'] = self.card.to_dictionary()
@@ -74,7 +77,7 @@ class DccCardSource(DataObject):
             dictionary['token'] = self.token
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'DccCardSource':
         super(DccCardSource, self).from_dictionary(dictionary)
         if 'card' in dictionary:
             if not isinstance(dictionary['card'], dict):

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/dcc_proposal.py

@@ -1,25 +1,24 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.amount_of_money import AmountOfMoney
-from onlinepayments.sdk.domain.rate_details import RateDetails
+from typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
+from .rate_details import RateDetails
 
 
 class DccProposal(DataObject):
-    """
-    | Details of currency conversion to be proposed to the cardholder
-    """
 
-    __base_amount = None
-    __disclaimer_display = None
-    __disclaimer_receipt = None
-    __rate = None
-    __target_amount = None
+    __base_amount: Optional[AmountOfMoney] = None
+    __disclaimer_display: Optional[str] = None
+    __disclaimer_receipt: Optional[str] = None
+    __rate: Optional[RateDetails] = None
+    __target_amount: Optional[AmountOfMoney] = None
 
     @property
-    def base_amount(self) -> AmountOfMoney:
+    def base_amount(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -28,11 +27,11 @@ class DccProposal(DataObject):
         return self.__base_amount
 
     @base_amount.setter
-    def base_amount(self, value: AmountOfMoney):
+    def base_amount(self, value: Optional[AmountOfMoney]) -> None:
         self.__base_amount = value
 
     @property
-    def disclaimer_display(self) -> str:
+    def disclaimer_display(self) -> Optional[str]:
         """
         | Card scheme disclaimer to present to the cardholder
 
@@ -41,11 +40,11 @@ class DccProposal(DataObject):
         return self.__disclaimer_display
 
     @disclaimer_display.setter
-    def disclaimer_display(self, value: str):
+    def disclaimer_display(self, value: Optional[str]) -> None:
         self.__disclaimer_display = value
 
     @property
-    def disclaimer_receipt(self) -> str:
+    def disclaimer_receipt(self) -> Optional[str]:
         """
         | Card scheme disclaimer to print within cardholder receipt
 
@@ -54,22 +53,22 @@ class DccProposal(DataObject):
         return self.__disclaimer_receipt
 
     @disclaimer_receipt.setter
-    def disclaimer_receipt(self, value: str):
+    def disclaimer_receipt(self, value: Optional[str]) -> None:
         self.__disclaimer_receipt = value
 
     @property
-    def rate(self) -> RateDetails:
+    def rate(self) -> Optional[RateDetails]:
         """
         Type: :class:`onlinepayments.sdk.domain.rate_details.RateDetails`
         """
         return self.__rate
 
     @rate.setter
-    def rate(self, value: RateDetails):
+    def rate(self, value: Optional[RateDetails]) -> None:
         self.__rate = value
 
     @property
-    def target_amount(self) -> AmountOfMoney:
+    def target_amount(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -78,10 +77,10 @@ class DccProposal(DataObject):
         return self.__target_amount
 
     @target_amount.setter
-    def target_amount(self, value: AmountOfMoney):
+    def target_amount(self, value: Optional[AmountOfMoney]) -> None:
         self.__target_amount = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(DccProposal, self).to_dictionary()
         if self.base_amount is not None:
             dictionary['baseAmount'] = self.base_amount.to_dictionary()
@@ -95,7 +94,7 @@ class DccProposal(DataObject):
             dictionary['targetAmount'] = self.target_amount.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'DccProposal':
         super(DccProposal, self).from_dictionary(dictionary)
         if 'baseAmount' in dictionary:
             if not isinstance(dictionary['baseAmount'], dict):