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

@@ -1,29 +1,28 @@
 # -*- 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_personal import AddressPersonal
-from onlinepayments.sdk.domain.shipping_method import ShippingMethod
+from typing import Optional
+
+from .address_personal import AddressPersonal
+from .data_object import DataObject
+from .shipping_method import ShippingMethod
 
 
 class Shipping(DataObject):
-    """
-    | Object containing information regarding shipping / delivery
-    """
-
-    __address = None
-    __address_indicator = None
-    __email_address = None
-    __first_usage_date = None
-    __is_first_usage = None
-    __method = None
-    __shipping_cost = None
-    __shipping_cost_tax = None
-    __type = None
+
+    __address: Optional[AddressPersonal] = None
+    __address_indicator: Optional[str] = None
+    __email_address: Optional[str] = None
+    __first_usage_date: Optional[str] = None
+    __is_first_usage: Optional[bool] = None
+    __method: Optional[ShippingMethod] = None
+    __shipping_cost: Optional[int] = None
+    __shipping_cost_tax: Optional[int] = None
+    __type: Optional[str] = None
 
     @property
-    def address(self) -> AddressPersonal:
+    def address(self) -> Optional[AddressPersonal]:
         """
         | Object containing address information
 
@@ -32,31 +31,32 @@ class Shipping(DataObject):
         return self.__address
 
     @address.setter
-    def address(self, value: AddressPersonal):
+    def address(self, value: Optional[AddressPersonal]) -> None:
         self.__address = value
 
     @property
-    def address_indicator(self) -> str:
+    def address_indicator(self) -> Optional[str]:
         """
         | Indicates shipping method chosen for the transaction. Possible values:
-        |  * same-as-billing = the shipping address is the same as the billing address
-        |  * another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
-        |  * different-than-billing = shipping address is different from the billing address
-        |  * ship-to-store = goods are shipped to a store (shipping address = store address)
-        |  * digital-goods = electronic delivery of digital goods
-        |  * travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
-        |  * other = other means of delivery
+        
+        * same-as-billing = the shipping address is the same as the billing address
+        * another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
+        * different-than-billing = shipping address is different from the billing address
+        * ship-to-store = goods are shipped to a store (shipping address = store address)
+        * digital-goods = electronic delivery of digital goods
+        * travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
+        * other = other means of delivery
 
         Type: str
         """
         return self.__address_indicator
 
     @address_indicator.setter
-    def address_indicator(self, value: str):
+    def address_indicator(self, value: Optional[str]) -> None:
         self.__address_indicator = value
 
     @property
-    def email_address(self) -> str:
+    def email_address(self) -> Optional[str]:
         """
         | Email address linked to the shipping
 
@@ -65,11 +65,11 @@ class Shipping(DataObject):
         return self.__email_address
 
     @email_address.setter
-    def email_address(self, value: str):
+    def email_address(self, value: Optional[str]) -> None:
         self.__email_address = value
 
     @property
-    def first_usage_date(self) -> str:
+    def first_usage_date(self) -> Optional[str]:
         """
         | Date (YYYYMMDD) when the shipping details for this transaction were first used.
 
@@ -78,16 +78,16 @@ class Shipping(DataObject):
         return self.__first_usage_date
 
     @first_usage_date.setter
-    def first_usage_date(self, value: str):
+    def first_usage_date(self, value: Optional[str]) -> None:
         self.__first_usage_date = value
 
     @property
-    def is_first_usage(self) -> bool:
+    def is_first_usage(self) -> Optional[bool]:
         """
         | Indicator if this shipping address is used for the first time to ship an order
-        
+        |
         | true = the shipping details are used for the first time with this transaction
-        
+        |
         | false = the shipping details have been used for other transactions in the past
 
         Type: bool
@@ -95,11 +95,11 @@ class Shipping(DataObject):
         return self.__is_first_usage
 
     @is_first_usage.setter
-    def is_first_usage(self, value: bool):
+    def is_first_usage(self, value: Optional[bool]) -> None:
         self.__is_first_usage = value
 
     @property
-    def method(self) -> ShippingMethod:
+    def method(self) -> Optional[ShippingMethod]:
         """
         | Object containing information regarding shipping method
 
@@ -108,11 +108,11 @@ class Shipping(DataObject):
         return self.__method
 
     @method.setter
-    def method(self, value: ShippingMethod):
+    def method(self, value: Optional[ShippingMethod]) -> None:
         self.__method = value
 
     @property
-    def shipping_cost(self) -> int:
+    def shipping_cost(self) -> Optional[int]:
         """
         | Cost associated with the shipping of the order.
 
@@ -121,11 +121,11 @@ class Shipping(DataObject):
         return self.__shipping_cost
 
     @shipping_cost.setter
-    def shipping_cost(self, value: int):
+    def shipping_cost(self, value: Optional[int]) -> None:
         self.__shipping_cost = value
 
     @property
-    def shipping_cost_tax(self) -> int:
+    def shipping_cost_tax(self) -> Optional[int]:
         """
         | Tax amount of the shipping cost.
 
@@ -134,27 +134,28 @@ class Shipping(DataObject):
         return self.__shipping_cost_tax
 
     @shipping_cost_tax.setter
-    def shipping_cost_tax(self, value: int):
+    def shipping_cost_tax(self, value: Optional[int]) -> None:
         self.__shipping_cost_tax = value
 
     @property
-    def type(self) -> str:
+    def type(self) -> Optional[str]:
         """
         | Indicates the merchandise delivery timeframe. Possible values:
-        |  * electronic = For electronic delivery (services or digital goods)
-        |  * same-day = For same day deliveries
-        |  * overnight = For overnight deliveries
-        |  * 2-day-or-more = For two day or more delivery time
+        
+        * electronic = For electronic delivery (services or digital goods)
+        * same-day = For same day deliveries
+        * overnight = For overnight deliveries
+        * 2-day-or-more = For two day or more delivery time
 
         Type: str
         """
         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(Shipping, self).to_dictionary()
         if self.address is not None:
             dictionary['address'] = self.address.to_dictionary()
@@ -176,7 +177,7 @@ class Shipping(DataObject):
             dictionary['type'] = self.type
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'Shipping':
         super(Shipping, self).from_dictionary(dictionary)
         if 'address' in dictionary:
             if not isinstance(dictionary['address'], dict):

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.1.0}/onlinepayments/sdk/domain/shipping_method.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 ShippingMethod(DataObject):
-    """
-    | Object containing information regarding shipping method
-    """
 
-    __details = None
-    __name = None
-    __speed = None
-    __type = None
+    __details: Optional[str] = None
+    __name: Optional[str] = None
+    __speed: Optional[int] = None
+    __type: Optional[str] = None
 
     @property
-    def details(self) -> str:
+    def details(self) -> Optional[str]:
         """
         | Details about the shipping method
 
@@ -25,11 +24,11 @@ class ShippingMethod(DataObject):
         return self.__details
 
     @details.setter
-    def details(self, value: str):
+    def details(self, value: Optional[str]) -> None:
         self.__details = value
 
     @property
-    def name(self) -> str:
+    def name(self) -> Optional[str]:
         """
         | Name of the shipping method
 
@@ -38,11 +37,11 @@ class ShippingMethod(DataObject):
         return self.__name
 
     @name.setter
-    def name(self, value: str):
+    def name(self, value: Optional[str]) -> None:
         self.__name = value
 
     @property
-    def speed(self) -> int:
+    def speed(self) -> Optional[int]:
         """
         | Number of hours to delivery
 
@@ -51,11 +50,11 @@ class ShippingMethod(DataObject):
         return self.__speed
 
     @speed.setter
-    def speed(self, value: int):
+    def speed(self, value: Optional[int]) -> None:
         self.__speed = value
 
     @property
-    def type(self) -> str:
+    def type(self) -> Optional[str]:
         """
         | Shipping method type
 
@@ -64,10 +63,10 @@ class ShippingMethod(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(ShippingMethod, self).to_dictionary()
         if self.details is not None:
             dictionary['details'] = self.details
@@ -79,7 +78,7 @@ class ShippingMethod(DataObject):
             dictionary['type'] = self.type
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ShippingMethod':
         super(ShippingMethod, self).from_dictionary(dictionary)
         if 'details' in dictionary:
             self.details = dictionary['details']

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

@@ -1,43 +1,41 @@
 # -*- 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.amount_breakdown import AmountBreakdown
-from onlinepayments.sdk.domain.gift_card_purchase import GiftCardPurchase
-from onlinepayments.sdk.domain.line_item import LineItem
+from .amount_breakdown import AmountBreakdown
+from .data_object import DataObject
+from .gift_card_purchase import GiftCardPurchase
+from .line_item import LineItem
 
 
 class ShoppingCart(DataObject):
-    """
-    | Shopping cart data, including items and specific amounts.
-    """
 
-    __amount_breakdown = None
-    __gift_card_purchase = None
-    __is_pre_order = None
-    __items = None
-    __pre_order_item_availability_date = None
-    __re_order_indicator = None
+    __amount_breakdown: Optional[List[AmountBreakdown]] = None
+    __gift_card_purchase: Optional[GiftCardPurchase] = None
+    __is_pre_order: Optional[bool] = None
+    __items: Optional[List[LineItem]] = None
+    __pre_order_item_availability_date: Optional[str] = None
+    __re_order_indicator: Optional[bool] = None
 
     @property
-    def amount_breakdown(self) -> List[AmountBreakdown]:
+    def amount_breakdown(self) -> Optional[List[AmountBreakdown]]:
         """
-        | Deprecated: Use order.shipping.shippingCost for shipping cost. Other amounts are not used.
-        | Determines how the total amount is split into amount types
+        | Deprecated: Use order.shipping.shippingCost for shipping cost. Other amounts are not used. Determines how the total amount is split into amount types
 
         Type: list[:class:`onlinepayments.sdk.domain.amount_breakdown.AmountBreakdown`]
+
+        Deprecated; Use order.shipping.shippingCost for shipping cost. Other amounts are not used. Determines how the total amount is split into amount types
         """
         return self.__amount_breakdown
 
     @amount_breakdown.setter
-    def amount_breakdown(self, value: List[AmountBreakdown]):
+    def amount_breakdown(self, value: Optional[List[AmountBreakdown]]) -> None:
         self.__amount_breakdown = value
 
     @property
-    def gift_card_purchase(self) -> GiftCardPurchase:
+    def gift_card_purchase(self) -> Optional[GiftCardPurchase]:
         """
         | Object containing information on purchased gift card(s)
 
@@ -46,11 +44,11 @@ class ShoppingCart(DataObject):
         return self.__gift_card_purchase
 
     @gift_card_purchase.setter
-    def gift_card_purchase(self, value: GiftCardPurchase):
+    def gift_card_purchase(self, value: Optional[GiftCardPurchase]) -> None:
         self.__gift_card_purchase = value
 
     @property
-    def is_pre_order(self) -> bool:
+    def is_pre_order(self) -> Optional[bool]:
         """
         | The customer is pre-ordering one or more items
 
@@ -59,11 +57,11 @@ class ShoppingCart(DataObject):
         return self.__is_pre_order
 
     @is_pre_order.setter
-    def is_pre_order(self, value: bool):
+    def is_pre_order(self, value: Optional[bool]) -> None:
         self.__is_pre_order = value
 
     @property
-    def items(self) -> List[LineItem]:
+    def items(self) -> Optional[List[LineItem]]:
         """
         | Shopping cart data
 
@@ -72,11 +70,11 @@ class ShoppingCart(DataObject):
         return self.__items
 
     @items.setter
-    def items(self, value: List[LineItem]):
+    def items(self, value: Optional[List[LineItem]]) -> None:
         self.__items = value
 
     @property
-    def pre_order_item_availability_date(self) -> str:
+    def pre_order_item_availability_date(self) -> Optional[str]:
         """
         | Date (YYYYMMDD) when the preordered item becomes available
 
@@ -85,16 +83,16 @@ class ShoppingCart(DataObject):
         return self.__pre_order_item_availability_date
 
     @pre_order_item_availability_date.setter
-    def pre_order_item_availability_date(self, value: str):
+    def pre_order_item_availability_date(self, value: Optional[str]) -> None:
         self.__pre_order_item_availability_date = value
 
     @property
-    def re_order_indicator(self) -> bool:
+    def re_order_indicator(self) -> Optional[bool]:
         """
         | Indicates whether the cardholder is reordering previously purchased item(s)
-        
+        |
         | true = the customer is re-ordering at least one of the items again
-        
+        |
         | false = this is the first time the customer is ordering these items
 
         Type: bool
@@ -102,10 +100,10 @@ class ShoppingCart(DataObject):
         return self.__re_order_indicator
 
     @re_order_indicator.setter
-    def re_order_indicator(self, value: bool):
+    def re_order_indicator(self, value: Optional[bool]) -> None:
         self.__re_order_indicator = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(ShoppingCart, self).to_dictionary()
         if self.amount_breakdown is not None:
             dictionary['amountBreakdown'] = []
@@ -127,7 +125,7 @@ class ShoppingCart(DataObject):
             dictionary['reOrderIndicator'] = self.re_order_indicator
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ShoppingCart':
         super(ShoppingCart, self).from_dictionary(dictionary)
         if 'amountBreakdown' in dictionary:
             if not isinstance(dictionary['amountBreakdown'], list):

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

@@ -1,8 +1,10 @@
-from onlinepayments.sdk.data_object import DataObject
+from typing import Optional
+
+from .data_object import DataObject
 
 
 class ShoppingCartExtension(DataObject):
-    def __init__(self, creator, name, version, extension_id=None):
+    def __init__(self, creator: str, name: str, version: str, extension_id: Optional[str] = None):
         if not creator:
             raise ValueError("creator is required")
         if not name:
@@ -14,7 +16,7 @@ class ShoppingCartExtension(DataObject):
         self.__version = version
         self.__extension_id = extension_id
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(ShoppingCartExtension, self).to_dictionary()
         if self.__creator is not None:
             dictionary['creator'] = self.__creator
@@ -26,7 +28,7 @@ class ShoppingCartExtension(DataObject):
             dictionary['extensionId'] = self.__extension_id
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ShoppingCartExtension':
         super(ShoppingCartExtension, self).from_dictionary(dictionary)
         if 'creator' in dictionary:
             self.__creator = dictionary['creator']
@@ -39,7 +41,7 @@ class ShoppingCartExtension(DataObject):
         return self
 
     @staticmethod
-    def create_from_dictionary(dictionary):
+    def create_from_dictionary(dictionary: dict) -> 'ShoppingCartExtension':
         if 'creator' in dictionary:
             creator = dictionary['creator']
         else:
@@ -71,5 +73,5 @@ class ShoppingCartExtension(DataObject):
         return self.__version
 
     @property
-    def extension_id(self) -> str:
+    def extension_id(self) -> Optional[str]:
         return self.__extension_id

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

@@ -1,24 +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.payment_product3012 import PaymentProduct3012
-from onlinepayments.sdk.domain.payment_product5404 import PaymentProduct5404
-from onlinepayments.sdk.domain.payment_product5407 import PaymentProduct5407
+from typing import Optional
+
+from .data_object import DataObject
+from .payment_product3012 import PaymentProduct3012
+from .payment_product5404 import PaymentProduct5404
+from .payment_product5407 import PaymentProduct5407
 
 
 class ShowFormData(DataObject):
-    """
-    | Object returned for the SHOW_FORM actionType.
-    """
 
-    __payment_product3012 = None
-    __payment_product5404 = None
-    __payment_product5407 = None
+    __payment_product3012: Optional[PaymentProduct3012] = None
+    __payment_product5404: Optional[PaymentProduct5404] = None
+    __payment_product5407: Optional[PaymentProduct5407] = None
 
     @property
-    def payment_product3012(self) -> PaymentProduct3012:
+    def payment_product3012(self) -> Optional[PaymentProduct3012]:
         """
         | Contains the third party data for payment product 3012 (Bancontact)
 
@@ -27,11 +26,11 @@ class ShowFormData(DataObject):
         return self.__payment_product3012
 
     @payment_product3012.setter
-    def payment_product3012(self, value: PaymentProduct3012):
+    def payment_product3012(self, value: Optional[PaymentProduct3012]) -> None:
         self.__payment_product3012 = value
 
     @property
-    def payment_product5404(self) -> PaymentProduct5404:
+    def payment_product5404(self) -> Optional[PaymentProduct5404]:
         """
         | Contains the third party data for payment product 5404 (WeChat Pay)
 
@@ -40,11 +39,11 @@ class ShowFormData(DataObject):
         return self.__payment_product5404
 
     @payment_product5404.setter
-    def payment_product5404(self, value: PaymentProduct5404):
+    def payment_product5404(self, value: Optional[PaymentProduct5404]) -> None:
         self.__payment_product5404 = value
 
     @property
-    def payment_product5407(self) -> PaymentProduct5407:
+    def payment_product5407(self) -> Optional[PaymentProduct5407]:
         """
         | Contains the third party data for payment product 5407 (Twint)
 
@@ -53,10 +52,10 @@ class ShowFormData(DataObject):
         return self.__payment_product5407
 
     @payment_product5407.setter
-    def payment_product5407(self, value: PaymentProduct5407):
+    def payment_product5407(self, value: Optional[PaymentProduct5407]) -> None:
         self.__payment_product5407 = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(ShowFormData, self).to_dictionary()
         if self.payment_product3012 is not None:
             dictionary['paymentProduct3012'] = self.payment_product3012.to_dictionary()
@@ -66,7 +65,7 @@ class ShowFormData(DataObject):
             dictionary['paymentProduct5407'] = self.payment_product5407.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'ShowFormData':
         super(ShowFormData, self).from_dictionary(dictionary)
         if 'paymentProduct3012' in dictionary:
             if not isinstance(dictionary['paymentProduct3012'], dict):

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

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class ShowInstructionsData(DataObject):
+
+    __show_data: Optional[str] = None
+
+    @property
+    def show_data(self) -> Optional[str]:
+        """
+        | The data that should be shown to the customer that can be used to render the instructions in your own application or website.
+
+        Type: str
+        """
+        return self.__show_data
+
+    @show_data.setter
+    def show_data(self, value: Optional[str]) -> None:
+        self.__show_data = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ShowInstructionsData, self).to_dictionary()
+        if self.show_data is not None:
+            dictionary['showData'] = self.show_data
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ShowInstructionsData':
+        super(ShowInstructionsData, self).from_dictionary(dictionary)
+        if 'showData' in dictionary:
+            self.show_data = dictionary['showData']
+        return self