onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/order_status_output.py

@@ -1,48 +1,50 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.api_error import APIError
+from .api_error import APIError
+from .data_object import DataObject
 
 
 class OrderStatusOutput(DataObject):
-    __errors = None
-    __is_cancellable = None
-    __status_category = None
-    __status_code = None
-    __status_code_change_date_time = None
+
+    __errors: Optional[List[APIError]] = None
+    __is_cancellable: Optional[bool] = None
+    __status_category: Optional[str] = None
+    __status_code: Optional[int] = None
+    __status_code_change_date_time: Optional[str] = None
 
     @property
-    def errors(self) -> List[APIError]:
+    def errors(self) -> Optional[List[APIError]]:
         """
         Type: list[:class:`onlinepayments.sdk.domain.api_error.APIError`]
         """
         return self.__errors
 
     @errors.setter
-    def errors(self, value: List[APIError]):
+    def errors(self, value: Optional[List[APIError]]) -> None:
         self.__errors = value
 
     @property
-    def is_cancellable(self) -> bool:
+    def is_cancellable(self) -> Optional[bool]:
         """
-        | Flag indicating if the payment can be cancelled 
-        |  * true 
-        |  * false
+        | Flag indicating if the payment can be cancelled
+        
+        * true
+        * false
 
         Type: bool
         """
         return self.__is_cancellable
 
     @is_cancellable.setter
-    def is_cancellable(self, value: bool):
+    def is_cancellable(self, value: Optional[bool]) -> None:
         self.__is_cancellable = value
 
     @property
-    def status_category(self) -> str:
+    def status_category(self) -> Optional[str]:
         """
         | Highlevel status of the payment, payout or refund.
 
@@ -51,24 +53,24 @@ class OrderStatusOutput(DataObject):
         return self.__status_category
 
     @status_category.setter
-    def status_category(self, value: str):
+    def status_category(self, value: Optional[str]) -> None:
         self.__status_category = value
 
     @property
-    def status_code(self) -> int:
+    def status_code(self) -> Optional[int]:
         """
-        | Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the BackOffice and in report files.
+        | Numeric status code of the legacy API. The value can also be found in the BackOffice and in report files.
 
         Type: int
         """
         return self.__status_code
 
     @status_code.setter
-    def status_code(self, value: int):
+    def status_code(self, value: Optional[int]) -> None:
         self.__status_code = value
 
     @property
-    def status_code_change_date_time(self) -> str:
+    def status_code_change_date_time(self) -> Optional[str]:
         """
         | Timestamp of the latest status change
 
@@ -77,10 +79,10 @@ class OrderStatusOutput(DataObject):
         return self.__status_code_change_date_time
 
     @status_code_change_date_time.setter
-    def status_code_change_date_time(self, value: str):
+    def status_code_change_date_time(self, value: Optional[str]) -> None:
         self.__status_code_change_date_time = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(OrderStatusOutput, self).to_dictionary()
         if self.errors is not None:
             dictionary['errors'] = []
@@ -97,7 +99,7 @@ class OrderStatusOutput(DataObject):
             dictionary['statusCodeChangeDateTime'] = self.status_code_change_date_time
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'OrderStatusOutput':
         super(OrderStatusOutput, self).from_dictionary(dictionary)
         if 'errors' in dictionary:
             if not isinstance(dictionary['errors'], list):

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/domain/order_type_information.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OrderTypeInformation(DataObject):
+
+    __purchase_type: Optional[str] = None
+    __transaction_type: Optional[str] = None
+
+    @property
+    def purchase_type(self) -> Optional[str]:
+        """
+        | Possible values are:
+        
+        * physical (tangible goods shipped to the customers)
+        * digital (digital services like ebooks, streaming...)
+
+        Type: str
+        """
+        return self.__purchase_type
+
+    @purchase_type.setter
+    def purchase_type(self, value: Optional[str]) -> None:
+        self.__purchase_type = value
+
+    @property
+    def transaction_type(self) -> Optional[str]:
+        """
+        | Identifies the type of transaction being authenticated. Possible values are:
+        
+        * purchase = The purpose of the transaction is to purchase goods or services (Default)
+        * check-acceptance = The purpose of the transaction is to accept a 'check'/'cheque'
+        * account-funding = The purpose of the transaction is to fund an account
+        * quasi-cash = The purpose of the transaction is to buy a quasi cash type product that is representative of actual cash such as money orders, traveler's checks, foreign currency, lottery tickets or casino gaming chips
+        * prepaid-activation-or-load = The purpose of the transaction is to activate or load a prepaid card
+
+        Type: str
+        """
+        return self.__transaction_type
+
+    @transaction_type.setter
+    def transaction_type(self, value: Optional[str]) -> None:
+        self.__transaction_type = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OrderTypeInformation, self).to_dictionary()
+        if self.purchase_type is not None:
+            dictionary['purchaseType'] = self.purchase_type
+        if self.transaction_type is not None:
+            dictionary['transactionType'] = self.transaction_type
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OrderTypeInformation':
+        super(OrderTypeInformation, self).from_dictionary(dictionary)
+        if 'purchaseType' in dictionary:
+            self.purchase_type = dictionary['purchaseType']
+        if 'transactionType' in dictionary:
+            self.transaction_type = dictionary['transactionType']
+        return self

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/domain/other_details.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OtherDetails(DataObject):
+
+    __meta_data: Optional[str] = None
+    __travel_data: Optional[str] = None
+
+    @property
+    def meta_data(self) -> Optional[str]:
+        """
+        | Information used by the following PaymentProducts [5300] to provide details on the item such as the color, size, etc. The field is in JSON format, with keys and values expected by the payment method at transaction creation. Please refer to the payment mean documentation.
+
+        Type: str
+        """
+        return self.__meta_data
+
+    @meta_data.setter
+    def meta_data(self, value: Optional[str]) -> None:
+        self.__meta_data = value
+
+    @property
+    def travel_data(self) -> Optional[str]:
+        """
+        | Information used by the following PaymentProducts [5110,5111,5112,5125,3104,3107,3108,3109].
+
+        Type: str
+        """
+        return self.__travel_data
+
+    @travel_data.setter
+    def travel_data(self, value: Optional[str]) -> None:
+        self.__travel_data = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OtherDetails, self).to_dictionary()
+        if self.meta_data is not None:
+            dictionary['metaData'] = self.meta_data
+        if self.travel_data is not None:
+            dictionary['travelData'] = self.travel_data
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OtherDetails':
+        super(OtherDetails, self).from_dictionary(dictionary)
+        if 'metaData' in dictionary:
+            self.meta_data = dictionary['metaData']
+        if 'travelData' in dictionary:
+            self.travel_data = dictionary['travelData']
+        return self

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/payment_account_on_file.py

@@ -1,23 +1,22 @@
 # -*- 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 PaymentAccountOnFile(DataObject):
-    """
-    | Object containing information on the payment account data on file (tokens)
-    """
 
-    __create_date = None
-    __number_of_card_on_file_creation_attempts_last24_hours = None
+    __create_date: Optional[str] = None
+    __number_of_card_on_file_creation_attempts_last24_hours: Optional[int] = None
 
     @property
-    def create_date(self) -> str:
+    def create_date(self) -> Optional[str]:
         """
         | The date (YYYYMMDD) when the payment account on file was first created.
-        
+        |
         | In case a token is used for the transaction we will use the creation date of the token in our system in case you leave this property empty.
 
         Type: str
@@ -25,11 +24,11 @@ class PaymentAccountOnFile(DataObject):
         return self.__create_date
 
     @create_date.setter
-    def create_date(self, value: str):
+    def create_date(self, value: Optional[str]) -> None:
         self.__create_date = value
 
     @property
-    def number_of_card_on_file_creation_attempts_last24_hours(self) -> int:
+    def number_of_card_on_file_creation_attempts_last24_hours(self) -> Optional[int]:
         """
         | Number of attempts made to add new card to the customer account in the last 24 hours
 
@@ -38,10 +37,10 @@ class PaymentAccountOnFile(DataObject):
         return self.__number_of_card_on_file_creation_attempts_last24_hours
 
     @number_of_card_on_file_creation_attempts_last24_hours.setter
-    def number_of_card_on_file_creation_attempts_last24_hours(self, value: int):
+    def number_of_card_on_file_creation_attempts_last24_hours(self, value: Optional[int]) -> None:
         self.__number_of_card_on_file_creation_attempts_last24_hours = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentAccountOnFile, self).to_dictionary()
         if self.create_date is not None:
             dictionary['createDate'] = self.create_date
@@ -49,7 +48,7 @@ class PaymentAccountOnFile(DataObject):
             dictionary['numberOfCardOnFileCreationAttemptsLast24Hours'] = self.number_of_card_on_file_creation_attempts_last24_hours
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentAccountOnFile':
         super(PaymentAccountOnFile, self).from_dictionary(dictionary)
         if 'createDate' in dictionary:
             self.create_date = dictionary['createDate']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/payment_context.py

@@ -1,18 +1,21 @@
 # -*- 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 typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
 
 
 class PaymentContext(DataObject):
-    __amount_of_money = None
-    __country_code = None
-    __is_recurring = None
+
+    __amount_of_money: Optional[AmountOfMoney] = None
+    __country_code: Optional[str] = None
+    __is_recurring: Optional[bool] = None
 
     @property
-    def amount_of_money(self) -> AmountOfMoney:
+    def amount_of_money(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -21,11 +24,11 @@ class PaymentContext(DataObject):
         return self.__amount_of_money
 
     @amount_of_money.setter
-    def amount_of_money(self, value: AmountOfMoney):
+    def amount_of_money(self, value: Optional[AmountOfMoney]) -> None:
         self.__amount_of_money = value
 
     @property
-    def country_code(self) -> str:
+    def country_code(self) -> Optional[str]:
         """
         | The country the payment takes place in
 
@@ -34,11 +37,11 @@ class PaymentContext(DataObject):
         return self.__country_code
 
     @country_code.setter
-    def country_code(self, value: str):
+    def country_code(self, value: Optional[str]) -> None:
         self.__country_code = value
 
     @property
-    def is_recurring(self) -> bool:
+    def is_recurring(self) -> Optional[bool]:
         """
         | True if the payment is recurring
 
@@ -47,10 +50,10 @@ class PaymentContext(DataObject):
         return self.__is_recurring
 
     @is_recurring.setter
-    def is_recurring(self, value: bool):
+    def is_recurring(self, value: Optional[bool]) -> None:
         self.__is_recurring = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentContext, self).to_dictionary()
         if self.amount_of_money is not None:
             dictionary['amountOfMoney'] = self.amount_of_money.to_dictionary()
@@ -60,7 +63,7 @@ class PaymentContext(DataObject):
             dictionary['isRecurring'] = self.is_recurring
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentContext':
         super(PaymentContext, self).from_dictionary(dictionary)
         if 'amountOfMoney' in dictionary:
             if not isinstance(dictionary['amountOfMoney'], dict):

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/payment_creation_output.py

@@ -1,22 +1,21 @@
 # -*- 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 PaymentCreationOutput(DataObject):
-    """
-    | Object containing the details of the created payment.
-    """
 
-    __external_reference = None
-    __is_new_token = None
-    __token = None
-    __tokenization_succeeded = None
+    __external_reference: Optional[str] = None
+    __is_new_token: Optional[bool] = None
+    __token: Optional[str] = None
+    __tokenization_succeeded: Optional[bool] = None
 
     @property
-    def external_reference(self) -> str:
+    def external_reference(self) -> Optional[str]:
         """
         | The external reference identifier for this transaction. Data in this property will also be returned in our report files, allowing you to reconcile them
 
@@ -25,26 +24,27 @@ class PaymentCreationOutput(DataObject):
         return self.__external_reference
 
     @external_reference.setter
-    def external_reference(self, value: str):
+    def external_reference(self, value: Optional[str]) -> None:
         self.__external_reference = value
 
     @property
-    def is_new_token(self) -> bool:
+    def is_new_token(self) -> Optional[bool]:
         """
-        | Indicates if a new token was created 
-        |  * true - A new token was created 
-        |  * false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
+        | Indicates if a new token was created
+        
+        * true - A new token was created
+        * false - A token with the same card number already exists and is returned. Please note that the existing token has not been updated. When you want to update other data then the card number, you need to update data stored in the token explicitly, as data is never updated during the creation of a token.
 
         Type: bool
         """
         return self.__is_new_token
 
     @is_new_token.setter
-    def is_new_token(self, value: bool):
+    def is_new_token(self, value: Optional[bool]) -> None:
         self.__is_new_token = value
 
     @property
-    def token(self) -> str:
+    def token(self) -> Optional[str]:
         """
         | ID of the token. This property is populated when the payment was done with a token or when the payment was tokenized.
 
@@ -53,11 +53,11 @@ class PaymentCreationOutput(DataObject):
         return self.__token
 
     @token.setter
-    def token(self, value: str):
+    def token(self, value: Optional[str]) -> None:
         self.__token = value
 
     @property
-    def tokenization_succeeded(self) -> bool:
+    def tokenization_succeeded(self) -> Optional[bool]:
         """
         | Indicates if tokenization was successful or not. If this value is false, then the token and isNewToken properties will not be set.
 
@@ -66,10 +66,10 @@ class PaymentCreationOutput(DataObject):
         return self.__tokenization_succeeded
 
     @tokenization_succeeded.setter
-    def tokenization_succeeded(self, value: bool):
+    def tokenization_succeeded(self, value: Optional[bool]) -> None:
         self.__tokenization_succeeded = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentCreationOutput, self).to_dictionary()
         if self.external_reference is not None:
             dictionary['externalReference'] = self.external_reference
@@ -81,7 +81,7 @@ class PaymentCreationOutput(DataObject):
             dictionary['tokenizationSucceeded'] = self.tokenization_succeeded
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentCreationOutput':
         super(PaymentCreationOutput, self).from_dictionary(dictionary)
         if 'externalReference' in dictionary:
             self.external_reference = dictionary['externalReference']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/payment_details_response.py

@@ -1,30 +1,27 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.hosted_checkout_specific_output import HostedCheckoutSpecificOutput
-from onlinepayments.sdk.domain.operation_output import OperationOutput
-from onlinepayments.sdk.domain.payment_output import PaymentOutput
-from onlinepayments.sdk.domain.payment_status_output import PaymentStatusOutput
+from .data_object import DataObject
+from .hosted_checkout_specific_output import HostedCheckoutSpecificOutput
+from .operation_output import OperationOutput
+from .payment_output import PaymentOutput
+from .payment_status_output import PaymentStatusOutput
 
 
 class PaymentDetailsResponse(DataObject):
-    """
-    | Object that holds the payment details properties
-    """
 
-    __operations = None
-    __hosted_checkout_specific_output = None
-    __id = None
-    __payment_output = None
-    __status = None
-    __status_output = None
+    __operations: Optional[List[OperationOutput]] = None
+    __hosted_checkout_specific_output: Optional[HostedCheckoutSpecificOutput] = None
+    __id: Optional[str] = None
+    __payment_output: Optional[PaymentOutput] = None
+    __status: Optional[str] = None
+    __status_output: Optional[PaymentStatusOutput] = None
 
     @property
-    def operations(self) -> List[OperationOutput]:
+    def operations(self) -> Optional[List[OperationOutput]]:
         """
         | Object that contains the complete list of operations executed on the payment.
 
@@ -33,11 +30,11 @@ class PaymentDetailsResponse(DataObject):
         return self.__operations
 
     @operations.setter
-    def operations(self, value: List[OperationOutput]):
+    def operations(self, value: Optional[List[OperationOutput]]) -> None:
         self.__operations = value
 
     @property
-    def hosted_checkout_specific_output(self) -> HostedCheckoutSpecificOutput:
+    def hosted_checkout_specific_output(self) -> Optional[HostedCheckoutSpecificOutput]:
         """
         | Hosted Checkout specific information. Populated if the payment was created on the platform through a Hosted Checkout.
 
@@ -46,11 +43,11 @@ class PaymentDetailsResponse(DataObject):
         return self.__hosted_checkout_specific_output
 
     @hosted_checkout_specific_output.setter
-    def hosted_checkout_specific_output(self, value: HostedCheckoutSpecificOutput):
+    def hosted_checkout_specific_output(self, value: Optional[HostedCheckoutSpecificOutput]) -> None:
         self.__hosted_checkout_specific_output = value
 
     @property
-    def id(self) -> str:
+    def id(self) -> Optional[str]:
         """
         | Our unique payment transaction identifier
 
@@ -59,11 +56,11 @@ class PaymentDetailsResponse(DataObject):
         return self.__id
 
     @id.setter
-    def id(self, value: str):
+    def id(self, value: Optional[str]) -> None:
         self.__id = value
 
     @property
-    def payment_output(self) -> PaymentOutput:
+    def payment_output(self) -> Optional[PaymentOutput]:
         """
         | Object containing payment details
 
@@ -72,11 +69,11 @@ class PaymentDetailsResponse(DataObject):
         return self.__payment_output
 
     @payment_output.setter
-    def payment_output(self, value: PaymentOutput):
+    def payment_output(self, value: Optional[PaymentOutput]) -> None:
         self.__payment_output = value
 
     @property
-    def status(self) -> str:
+    def status(self) -> Optional[str]:
         """
         | Current high-level status of the payment in a human-readable form.
 
@@ -85,11 +82,11 @@ class PaymentDetailsResponse(DataObject):
         return self.__status
 
     @status.setter
-    def status(self, value: str):
+    def status(self, value: Optional[str]) -> None:
         self.__status = value
 
     @property
-    def status_output(self) -> PaymentStatusOutput:
+    def status_output(self) -> Optional[PaymentStatusOutput]:
         """
         | This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
 
@@ -98,10 +95,10 @@ class PaymentDetailsResponse(DataObject):
         return self.__status_output
 
     @status_output.setter
-    def status_output(self, value: PaymentStatusOutput):
+    def status_output(self, value: Optional[PaymentStatusOutput]) -> None:
         self.__status_output = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentDetailsResponse, self).to_dictionary()
         if self.operations is not None:
             dictionary['Operations'] = []
@@ -120,7 +117,7 @@ class PaymentDetailsResponse(DataObject):
             dictionary['statusOutput'] = self.status_output.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentDetailsResponse':
         super(PaymentDetailsResponse, self).from_dictionary(dictionary)
         if 'Operations' in dictionary:
             if not isinstance(dictionary['Operations'], list):