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/payment_error_response.py

@@ -1,21 +1,22 @@
 # -*- 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 onlinepayments.sdk.domain.create_payment_response import CreatePaymentResponse
+from .api_error import APIError
+from .create_payment_response import CreatePaymentResponse
+from .data_object import DataObject
 
 
 class PaymentErrorResponse(DataObject):
-    __error_id = None
-    __errors = None
-    __payment_result = None
+
+    __error_id: Optional[str] = None
+    __errors: Optional[List[APIError]] = None
+    __payment_result: Optional[CreatePaymentResponse] = None
 
     @property
-    def error_id(self) -> str:
+    def error_id(self) -> Optional[str]:
         """
         | Unique reference, for debugging purposes, of this error response
 
@@ -24,22 +25,22 @@ class PaymentErrorResponse(DataObject):
         return self.__error_id
 
     @error_id.setter
-    def error_id(self, value: str):
+    def error_id(self, value: Optional[str]) -> None:
         self.__error_id = value
 
     @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 payment_result(self) -> CreatePaymentResponse:
+    def payment_result(self) -> Optional[CreatePaymentResponse]:
         """
         | Object that contains details on the created payment in case one has been created.
 
@@ -48,10 +49,10 @@ class PaymentErrorResponse(DataObject):
         return self.__payment_result
 
     @payment_result.setter
-    def payment_result(self, value: CreatePaymentResponse):
+    def payment_result(self, value: Optional[CreatePaymentResponse]) -> None:
         self.__payment_result = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentErrorResponse, self).to_dictionary()
         if self.error_id is not None:
             dictionary['errorId'] = self.error_id
@@ -64,7 +65,7 @@ class PaymentErrorResponse(DataObject):
             dictionary['paymentResult'] = self.payment_result.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentErrorResponse':
         super(PaymentErrorResponse, self).from_dictionary(dictionary)
         if 'errorId' in dictionary:
             self.error_id = dictionary['errorId']

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/payment_link_event.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 PaymentLinkEvent(DataObject):
-    """
-    | Changes related to a payment link status or usage.
-    """
 
-    __date_time = None
-    __details = None
-    __type = None
+    __date_time: Optional[str] = None
+    __details: Optional[str] = None
+    __type: Optional[str] = None
 
     @property
-    def date_time(self) -> str:
+    def date_time(self) -> Optional[str]:
         """
         | The date and time the change occurred. The date will contain the UTC offset.
 
@@ -24,11 +23,11 @@ class PaymentLinkEvent(DataObject):
         return self.__date_time
 
     @date_time.setter
-    def date_time(self, value: str):
+    def date_time(self, value: Optional[str]) -> None:
         self.__date_time = value
 
     @property
-    def details(self) -> str:
+    def details(self) -> Optional[str]:
         """
         | Details of the events. Ex.: email address or phone number of the recipient.
 
@@ -37,11 +36,11 @@ class PaymentLinkEvent(DataObject):
         return self.__details
 
     @details.setter
-    def details(self, value: str):
+    def details(self, value: Optional[str]) -> None:
         self.__details = value
 
     @property
-    def type(self) -> str:
+    def type(self) -> Optional[str]:
         """
         | The type of event that occurred.
 
@@ -50,10 +49,10 @@ class PaymentLinkEvent(DataObject):
         return self.__type
 
     @type.setter
-    def type(self, value: str):
+    def type(self, value: Optional[str]) -> None:
         self.__type = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentLinkEvent, self).to_dictionary()
         if self.date_time is not None:
             dictionary['dateTime'] = self.date_time
@@ -63,7 +62,7 @@ class PaymentLinkEvent(DataObject):
             dictionary['type'] = self.type
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentLinkEvent':
         super(PaymentLinkEvent, self).from_dictionary(dictionary)
         if 'dateTime' in dictionary:
             self.date_time = dictionary['dateTime']

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

@@ -1,31 +1,22 @@
 # -*- 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.surcharge_for_payment_link import SurchargeForPaymentLink
+from typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
+from .surcharge_for_payment_link import SurchargeForPaymentLink
 
 
 class PaymentLinkOrderInput(DataObject):
-    """
-    | An object containing the details of the related payment input.
-    
-    | Deprecated: All properties in `paymentLinkOrder` are deprecated.  
-    | Use corresponding values as noted below:  
-    | | Property | Replacement |
-    | | - | - |
-    | | merchantReference | `order/references/merchantReference` |  
-    | | amount | `order/amountOfMoney` |  
-    | | surchargeSpecificInput | `order/surchargeSpecificInput` |
-    """
 
-    __amount = None
-    __merchant_reference = None
-    __surcharge_specific_input = None
+    __amount: Optional[AmountOfMoney] = None
+    __merchant_reference: Optional[str] = None
+    __surcharge_specific_input: Optional[SurchargeForPaymentLink] = None
 
     @property
-    def amount(self) -> AmountOfMoney:
+    def amount(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -34,25 +25,24 @@ class PaymentLinkOrderInput(DataObject):
         return self.__amount
 
     @amount.setter
-    def amount(self, value: AmountOfMoney):
+    def amount(self, value: Optional[AmountOfMoney]) -> None:
         self.__amount = value
 
     @property
-    def merchant_reference(self) -> str:
+    def merchant_reference(self) -> Optional[str]:
         """
-        | Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
-        | It is highly recommended to provide a single MerchantReference per unique order on your side
+        | Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side
 
         Type: str
         """
         return self.__merchant_reference
 
     @merchant_reference.setter
-    def merchant_reference(self, value: str):
+    def merchant_reference(self, value: Optional[str]) -> None:
         self.__merchant_reference = value
 
     @property
-    def surcharge_specific_input(self) -> SurchargeForPaymentLink:
+    def surcharge_specific_input(self) -> Optional[SurchargeForPaymentLink]:
         """
         | Object containing details how surcharge will be applied to a payment link.
 
@@ -61,10 +51,10 @@ class PaymentLinkOrderInput(DataObject):
         return self.__surcharge_specific_input
 
     @surcharge_specific_input.setter
-    def surcharge_specific_input(self, value: SurchargeForPaymentLink):
+    def surcharge_specific_input(self, value: Optional[SurchargeForPaymentLink]) -> None:
         self.__surcharge_specific_input = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentLinkOrderInput, self).to_dictionary()
         if self.amount is not None:
             dictionary['amount'] = self.amount.to_dictionary()
@@ -74,7 +64,7 @@ class PaymentLinkOrderInput(DataObject):
             dictionary['surchargeSpecificInput'] = self.surcharge_specific_input.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentLinkOrderInput':
         super(PaymentLinkOrderInput, self).from_dictionary(dictionary)
         if 'amount' in dictionary:
             if not isinstance(dictionary['amount'], dict):

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/domain/payment_link_order_output.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 onlinepayments.sdk.domain.amount_of_money import AmountOfMoney
-from onlinepayments.sdk.domain.surcharge_for_payment_link import SurchargeForPaymentLink
+from typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
+from .surcharge_for_payment_link import SurchargeForPaymentLink
 
 
 class PaymentLinkOrderOutput(DataObject):
-    """
-    | An object containing the details of the related payment output.
-    """
 
-    __amount = None
-    __merchant_reference = None
-    __surcharge_specific_output = None
+    __amount: Optional[AmountOfMoney] = None
+    __merchant_reference: Optional[str] = None
+    __surcharge_specific_output: Optional[SurchargeForPaymentLink] = None
 
     @property
-    def amount(self) -> AmountOfMoney:
+    def amount(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -26,25 +25,24 @@ class PaymentLinkOrderOutput(DataObject):
         return self.__amount
 
     @amount.setter
-    def amount(self, value: AmountOfMoney):
+    def amount(self, value: Optional[AmountOfMoney]) -> None:
         self.__amount = value
 
     @property
-    def merchant_reference(self) -> str:
+    def merchant_reference(self) -> Optional[str]:
         """
-        | Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.
-        | It is highly recommended to provide a single MerchantReference per unique order on your side
+        | Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side
 
         Type: str
         """
         return self.__merchant_reference
 
     @merchant_reference.setter
-    def merchant_reference(self, value: str):
+    def merchant_reference(self, value: Optional[str]) -> None:
         self.__merchant_reference = value
 
     @property
-    def surcharge_specific_output(self) -> SurchargeForPaymentLink:
+    def surcharge_specific_output(self) -> Optional[SurchargeForPaymentLink]:
         """
         | Object containing details how surcharge will be applied to a payment link.
 
@@ -53,10 +51,10 @@ class PaymentLinkOrderOutput(DataObject):
         return self.__surcharge_specific_output
 
     @surcharge_specific_output.setter
-    def surcharge_specific_output(self, value: SurchargeForPaymentLink):
+    def surcharge_specific_output(self, value: Optional[SurchargeForPaymentLink]) -> None:
         self.__surcharge_specific_output = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentLinkOrderOutput, self).to_dictionary()
         if self.amount is not None:
             dictionary['amount'] = self.amount.to_dictionary()
@@ -66,7 +64,7 @@ class PaymentLinkOrderOutput(DataObject):
             dictionary['surchargeSpecificOutput'] = self.surcharge_specific_output.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentLinkOrderOutput':
         super(PaymentLinkOrderOutput, self).from_dictionary(dictionary)
         if 'amount' in dictionary:
             if not isinstance(dictionary['amount'], dict):

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

@@ -1,43 +1,41 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from datetime import datetime
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.payment_link_event import PaymentLinkEvent
-from onlinepayments.sdk.domain.payment_link_order_output import PaymentLinkOrderOutput
+from .data_object import DataObject
+from .payment_link_event import PaymentLinkEvent
+from .payment_link_order_output import PaymentLinkOrderOutput
 
 
 class PaymentLinkResponse(DataObject):
-    """
-    | An object representing a payment link.
-    """
-
-    __expiration_date = None
-    __payment_id = None
-    __payment_link_events = None
-    __payment_link_id = None
-    __payment_link_order = None
-    __recipient_name = None
-    __redirection_url = None
-    __status = None
+
+    __expiration_date: Optional[datetime] = None
+    __payment_id: Optional[str] = None
+    __payment_link_events: Optional[List[PaymentLinkEvent]] = None
+    __payment_link_id: Optional[str] = None
+    __payment_link_order: Optional[PaymentLinkOrderOutput] = None
+    __recipient_name: Optional[str] = None
+    __redirection_url: Optional[str] = None
+    __status: Optional[str] = None
 
     @property
-    def expiration_date(self) -> str:
+    def expiration_date(self) -> Optional[datetime]:
         """
         | The date after which the payment link will not be usable to complete the payment. The date will contain the UTC offset.
 
-        Type: str
+        Type: datetime
         """
         return self.__expiration_date
 
     @expiration_date.setter
-    def expiration_date(self, value: str):
+    def expiration_date(self, value: Optional[datetime]) -> None:
         self.__expiration_date = value
 
     @property
-    def payment_id(self) -> str:
+    def payment_id(self) -> Optional[str]:
         """
         | The unique payment transaction identifier. This id is only set when a payment was processed with this payment link.
 
@@ -46,22 +44,22 @@ class PaymentLinkResponse(DataObject):
         return self.__payment_id
 
     @payment_id.setter
-    def payment_id(self, value: str):
+    def payment_id(self, value: Optional[str]) -> None:
         self.__payment_id = value
 
     @property
-    def payment_link_events(self) -> List[PaymentLinkEvent]:
+    def payment_link_events(self) -> Optional[List[PaymentLinkEvent]]:
         """
         Type: list[:class:`onlinepayments.sdk.domain.payment_link_event.PaymentLinkEvent`]
         """
         return self.__payment_link_events
 
     @payment_link_events.setter
-    def payment_link_events(self, value: List[PaymentLinkEvent]):
+    def payment_link_events(self, value: Optional[List[PaymentLinkEvent]]) -> None:
         self.__payment_link_events = value
 
     @property
-    def payment_link_id(self) -> str:
+    def payment_link_id(self) -> Optional[str]:
         """
         | The unique link identifier.
 
@@ -70,11 +68,11 @@ class PaymentLinkResponse(DataObject):
         return self.__payment_link_id
 
     @payment_link_id.setter
-    def payment_link_id(self, value: str):
+    def payment_link_id(self, value: Optional[str]) -> None:
         self.__payment_link_id = value
 
     @property
-    def payment_link_order(self) -> PaymentLinkOrderOutput:
+    def payment_link_order(self) -> Optional[PaymentLinkOrderOutput]:
         """
         | An object containing the details of the related payment output.
 
@@ -83,11 +81,11 @@ class PaymentLinkResponse(DataObject):
         return self.__payment_link_order
 
     @payment_link_order.setter
-    def payment_link_order(self, value: PaymentLinkOrderOutput):
+    def payment_link_order(self, value: Optional[PaymentLinkOrderOutput]) -> None:
         self.__payment_link_order = value
 
     @property
-    def recipient_name(self) -> str:
+    def recipient_name(self) -> Optional[str]:
         """
         | The payment link recipient name.
 
@@ -96,11 +94,11 @@ class PaymentLinkResponse(DataObject):
         return self.__recipient_name
 
     @recipient_name.setter
-    def recipient_name(self, value: str):
+    def recipient_name(self, value: Optional[str]) -> None:
         self.__recipient_name = value
 
     @property
-    def redirection_url(self) -> str:
+    def redirection_url(self) -> Optional[str]:
         """
         | The URL that will redirect the customer to the Hosted Checkout page to process the payment.
 
@@ -109,30 +107,31 @@ class PaymentLinkResponse(DataObject):
         return self.__redirection_url
 
     @redirection_url.setter
-    def redirection_url(self, value: str):
+    def redirection_url(self, value: Optional[str]) -> None:
         self.__redirection_url = value
 
     @property
-    def status(self) -> str:
+    def status(self) -> Optional[str]:
         """
         | The state of the payment link:
-        |   * ACTIVE: The payment link is ready to be used.
-        |   * PAID: The payment has been completed.
-        |   * CANCELLED: The payment link has been manually cancelled.
-        |   * EXPIRED: The payment link is not usable anymore.
+        
+        * ACTIVE: The payment link is ready to be used.
+        * PAID: The payment has been completed.
+        * CANCELLED: The payment link has been manually cancelled.
+        * EXPIRED: The payment link is not usable anymore.
 
         Type: str
         """
         return self.__status
 
     @status.setter
-    def status(self, value: str):
+    def status(self, value: Optional[str]) -> None:
         self.__status = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentLinkResponse, self).to_dictionary()
         if self.expiration_date is not None:
-            dictionary['expirationDate'] = self.expiration_date
+            dictionary['expirationDate'] = DataObject.format_datetime(self.expiration_date)
         if self.payment_id is not None:
             dictionary['paymentId'] = self.payment_id
         if self.payment_link_events is not None:
@@ -152,10 +151,10 @@ class PaymentLinkResponse(DataObject):
             dictionary['status'] = self.status
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentLinkResponse':
         super(PaymentLinkResponse, self).from_dictionary(dictionary)
         if 'expirationDate' in dictionary:
-            self.expiration_date = dictionary['expirationDate']
+            self.expiration_date = DataObject.parse_datetime(dictionary['expirationDate'])
         if 'paymentId' in dictionary:
             self.payment_id = dictionary['paymentId']
         if 'paymentLinkEvents' in dictionary:

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

@@ -1,21 +1,21 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
+from datetime import datetime
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class PaymentLinkSpecificInput(DataObject):
-    """
-    | An object containing details specific to payment link creation
-    """
 
-    __description = None
-    __expiration_date = None
-    __recipient_name = None
+    __description: Optional[str] = None
+    __expiration_date: Optional[datetime] = None
+    __recipient_name: Optional[str] = None
 
     @property
-    def description(self) -> str:
+    def description(self) -> Optional[str]:
         """
         | A note related to the created payment link.
 
@@ -24,24 +24,24 @@ class PaymentLinkSpecificInput(DataObject):
         return self.__description
 
     @description.setter
-    def description(self, value: str):
+    def description(self, value: Optional[str]) -> None:
         self.__description = value
 
     @property
-    def expiration_date(self) -> str:
+    def expiration_date(self) -> Optional[datetime]:
         """
         | The date after which the payment link will not be usable to complete the payment. The date sent cannot be more than 6 months in the future or a past date. It must also contain the UTC offset.
 
-        Type: str
+        Type: datetime
         """
         return self.__expiration_date
 
     @expiration_date.setter
-    def expiration_date(self, value: str):
+    def expiration_date(self, value: Optional[datetime]) -> None:
         self.__expiration_date = value
 
     @property
-    def recipient_name(self) -> str:
+    def recipient_name(self) -> Optional[str]:
         """
         | The payment link recipient name.
 
@@ -50,25 +50,25 @@ class PaymentLinkSpecificInput(DataObject):
         return self.__recipient_name
 
     @recipient_name.setter
-    def recipient_name(self, value: str):
+    def recipient_name(self, value: Optional[str]) -> None:
         self.__recipient_name = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(PaymentLinkSpecificInput, self).to_dictionary()
         if self.description is not None:
             dictionary['description'] = self.description
         if self.expiration_date is not None:
-            dictionary['expirationDate'] = self.expiration_date
+            dictionary['expirationDate'] = DataObject.format_datetime(self.expiration_date)
         if self.recipient_name is not None:
             dictionary['recipientName'] = self.recipient_name
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'PaymentLinkSpecificInput':
         super(PaymentLinkSpecificInput, self).from_dictionary(dictionary)
         if 'description' in dictionary:
             self.description = dictionary['description']
         if 'expirationDate' in dictionary:
-            self.expiration_date = dictionary['expirationDate']
+            self.expiration_date = DataObject.parse_datetime(dictionary['expirationDate'])
         if 'recipientName' in dictionary:
             self.recipient_name = dictionary['recipientName']
         return self