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

@@ -1,27 +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.amount_of_money import AmountOfMoney
-from onlinepayments.sdk.domain.payment_references import PaymentReferences
-from onlinepayments.sdk.domain.payment_status_output import PaymentStatusOutput
+from typing import Optional
+
+from .amount_of_money import AmountOfMoney
+from .data_object import DataObject
+from .operation_payment_references import OperationPaymentReferences
+from .payment_references import PaymentReferences
+from .payment_status_output import PaymentStatusOutput
 
 
 class OperationOutput(DataObject):
-    """
-    | Object containing operation details
-    """
 
-    __amount_of_money = None
-    __id = None
-    __payment_method = None
-    __references = None
-    __status = None
-    __status_output = None
+    __amount_of_money: Optional[AmountOfMoney] = None
+    __id: Optional[str] = None
+    __operation_references: Optional[OperationPaymentReferences] = None
+    __payment_method: Optional[str] = None
+    __references: Optional[PaymentReferences] = None
+    __status: Optional[str] = None
+    __status_output: Optional[PaymentStatusOutput] = None
 
     @property
-    def amount_of_money(self) -> AmountOfMoney:
+    def amount_of_money(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -30,11 +31,11 @@ class OperationOutput(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 id(self) -> str:
+    def id(self) -> Optional[str]:
         """
         | Our unique payment transaction identifier
 
@@ -43,11 +44,24 @@ class OperationOutput(DataObject):
         return self.__id
 
     @id.setter
-    def id(self, value: str):
+    def id(self, value: Optional[str]) -> None:
         self.__id = value
 
     @property
-    def payment_method(self) -> str:
+    def operation_references(self) -> Optional[OperationPaymentReferences]:
+        """
+        | Object that holds all reference properties that are linked to this transaction
+
+        Type: :class:`onlinepayments.sdk.domain.operation_payment_references.OperationPaymentReferences`
+        """
+        return self.__operation_references
+
+    @operation_references.setter
+    def operation_references(self, value: Optional[OperationPaymentReferences]) -> None:
+        self.__operation_references = value
+
+    @property
+    def payment_method(self) -> Optional[str]:
         """
         | Payment method identifier used by the our payment engine.
 
@@ -56,24 +70,24 @@ class OperationOutput(DataObject):
         return self.__payment_method
 
     @payment_method.setter
-    def payment_method(self, value: str):
+    def payment_method(self, value: Optional[str]) -> None:
         self.__payment_method = value
 
     @property
-    def references(self) -> PaymentReferences:
+    def references(self) -> Optional[PaymentReferences]:
         """
-        | Object that holds all reference properties that are linked to this transaction
+        | Object that holds all reference properties that are linked to this transaction. **Deprecated for capture/refund**: Use operationReferences instead.
 
         Type: :class:`onlinepayments.sdk.domain.payment_references.PaymentReferences`
         """
         return self.__references
 
     @references.setter
-    def references(self, value: PaymentReferences):
+    def references(self, value: Optional[PaymentReferences]) -> None:
         self.__references = value
 
     @property
-    def status(self) -> str:
+    def status(self) -> Optional[str]:
         """
         | Current high-level status of the payment in a human-readable form.
 
@@ -82,11 +96,11 @@ class OperationOutput(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.
 
@@ -95,15 +109,17 @@ class OperationOutput(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(OperationOutput, self).to_dictionary()
         if self.amount_of_money is not None:
             dictionary['amountOfMoney'] = self.amount_of_money.to_dictionary()
         if self.id is not None:
             dictionary['id'] = self.id
+        if self.operation_references is not None:
+            dictionary['operationReferences'] = self.operation_references.to_dictionary()
         if self.payment_method is not None:
             dictionary['paymentMethod'] = self.payment_method
         if self.references is not None:
@@ -114,7 +130,7 @@ class OperationOutput(DataObject):
             dictionary['statusOutput'] = self.status_output.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'OperationOutput':
         super(OperationOutput, self).from_dictionary(dictionary)
         if 'amountOfMoney' in dictionary:
             if not isinstance(dictionary['amountOfMoney'], dict):
@@ -123,6 +139,11 @@ class OperationOutput(DataObject):
             self.amount_of_money = value.from_dictionary(dictionary['amountOfMoney'])
         if 'id' in dictionary:
             self.id = dictionary['id']
+        if 'operationReferences' in dictionary:
+            if not isinstance(dictionary['operationReferences'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['operationReferences']))
+            value = OperationPaymentReferences()
+            self.operation_references = value.from_dictionary(dictionary['operationReferences'])
         if 'paymentMethod' in dictionary:
             self.payment_method = dictionary['paymentMethod']
         if 'references' in dictionary:

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

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OperationPaymentReferences(DataObject):
+
+    __merchant_reference: Optional[str] = None
+
+    @property
+    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
+
+        Type: str
+        """
+        return self.__merchant_reference
+
+    @merchant_reference.setter
+    def merchant_reference(self, value: Optional[str]) -> None:
+        self.__merchant_reference = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OperationPaymentReferences, self).to_dictionary()
+        if self.merchant_reference is not None:
+            dictionary['merchantReference'] = self.merchant_reference
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OperationPaymentReferences':
+        super(OperationPaymentReferences, self).from_dictionary(dictionary)
+        if 'merchantReference' in dictionary:
+            self.merchant_reference = dictionary['merchantReference']
+        return self

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

@@ -1,35 +1,33 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.additional_order_input import AdditionalOrderInput
-from onlinepayments.sdk.domain.amount_of_money import AmountOfMoney
-from onlinepayments.sdk.domain.customer import Customer
-from onlinepayments.sdk.domain.discount import Discount
-from onlinepayments.sdk.domain.order_references import OrderReferences
-from onlinepayments.sdk.domain.shipping import Shipping
-from onlinepayments.sdk.domain.shopping_cart import ShoppingCart
-from onlinepayments.sdk.domain.surcharge_specific_input import SurchargeSpecificInput
+from typing import Optional
+
+from .additional_order_input import AdditionalOrderInput
+from .amount_of_money import AmountOfMoney
+from .customer import Customer
+from .data_object import DataObject
+from .discount import Discount
+from .order_references import OrderReferences
+from .shipping import Shipping
+from .shopping_cart import ShoppingCart
+from .surcharge_specific_input import SurchargeSpecificInput
 
 
 class Order(DataObject):
-    """
-    | Order object containing order related data 
-    |  Please note that this object is required to be able to submit the amount.
-    """
-
-    __additional_input = None
-    __amount_of_money = None
-    __customer = None
-    __discount = None
-    __references = None
-    __shipping = None
-    __shopping_cart = None
-    __surcharge_specific_input = None
+
+    __additional_input: Optional[AdditionalOrderInput] = None
+    __amount_of_money: Optional[AmountOfMoney] = None
+    __customer: Optional[Customer] = None
+    __discount: Optional[Discount] = None
+    __references: Optional[OrderReferences] = None
+    __shipping: Optional[Shipping] = None
+    __shopping_cart: Optional[ShoppingCart] = None
+    __surcharge_specific_input: Optional[SurchargeSpecificInput] = None
 
     @property
-    def additional_input(self) -> AdditionalOrderInput:
+    def additional_input(self) -> Optional[AdditionalOrderInput]:
         """
         | Object containing additional input on the order
 
@@ -38,11 +36,11 @@ class Order(DataObject):
         return self.__additional_input
 
     @additional_input.setter
-    def additional_input(self, value: AdditionalOrderInput):
+    def additional_input(self, value: Optional[AdditionalOrderInput]) -> None:
         self.__additional_input = value
 
     @property
-    def amount_of_money(self) -> AmountOfMoney:
+    def amount_of_money(self) -> Optional[AmountOfMoney]:
         """
         | Object containing amount and ISO currency code attributes
 
@@ -51,11 +49,11 @@ class Order(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 customer(self) -> Customer:
+    def customer(self) -> Optional[Customer]:
         """
         | Object containing the details of the customer
 
@@ -64,11 +62,11 @@ class Order(DataObject):
         return self.__customer
 
     @customer.setter
-    def customer(self, value: Customer):
+    def customer(self, value: Optional[Customer]) -> None:
         self.__customer = value
 
     @property
-    def discount(self) -> Discount:
+    def discount(self) -> Optional[Discount]:
         """
         | Object to apply a discount to the total basket by adding a discount line.
 
@@ -77,11 +75,11 @@ class Order(DataObject):
         return self.__discount
 
     @discount.setter
-    def discount(self, value: Discount):
+    def discount(self, value: Optional[Discount]) -> None:
         self.__discount = value
 
     @property
-    def references(self) -> OrderReferences:
+    def references(self) -> Optional[OrderReferences]:
         """
         | Object that holds all reference properties that are linked to this transaction
 
@@ -90,11 +88,11 @@ class Order(DataObject):
         return self.__references
 
     @references.setter
-    def references(self, value: OrderReferences):
+    def references(self, value: Optional[OrderReferences]) -> None:
         self.__references = value
 
     @property
-    def shipping(self) -> Shipping:
+    def shipping(self) -> Optional[Shipping]:
         """
         | Object containing information regarding shipping / delivery
 
@@ -103,11 +101,11 @@ class Order(DataObject):
         return self.__shipping
 
     @shipping.setter
-    def shipping(self, value: Shipping):
+    def shipping(self, value: Optional[Shipping]) -> None:
         self.__shipping = value
 
     @property
-    def shopping_cart(self) -> ShoppingCart:
+    def shopping_cart(self) -> Optional[ShoppingCart]:
         """
         | Shopping cart data, including items and specific amounts.
 
@@ -116,11 +114,11 @@ class Order(DataObject):
         return self.__shopping_cart
 
     @shopping_cart.setter
-    def shopping_cart(self, value: ShoppingCart):
+    def shopping_cart(self, value: Optional[ShoppingCart]) -> None:
         self.__shopping_cart = value
 
     @property
-    def surcharge_specific_input(self) -> SurchargeSpecificInput:
+    def surcharge_specific_input(self) -> Optional[SurchargeSpecificInput]:
         """
         | Object containing specific input required to apply surcharging to an order.
 
@@ -129,10 +127,10 @@ class Order(DataObject):
         return self.__surcharge_specific_input
 
     @surcharge_specific_input.setter
-    def surcharge_specific_input(self, value: SurchargeSpecificInput):
+    def surcharge_specific_input(self, value: Optional[SurchargeSpecificInput]) -> None:
         self.__surcharge_specific_input = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(Order, self).to_dictionary()
         if self.additional_input is not None:
             dictionary['additionalInput'] = self.additional_input.to_dictionary()
@@ -152,7 +150,7 @@ class Order(DataObject):
             dictionary['surchargeSpecificInput'] = self.surcharge_specific_input.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'Order':
         super(Order, self).from_dictionary(dictionary)
         if 'additionalInput' in dictionary:
             if not isinstance(dictionary['additionalInput'], dict):

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

@@ -1,26 +1,26 @@
 # -*- 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 OrderLineDetails(DataObject):
-    """
-    | Object containing additional information that when supplied can have a beneficial effect on the discountrates
-    """
-
-    __discount_amount = None
-    __product_code = None
-    __product_name = None
-    __product_price = None
-    __product_type = None
-    __quantity = None
-    __tax_amount = None
-    __unit = None
+
+    __discount_amount: Optional[int] = None
+    __product_brand: Optional[str] = None
+    __product_code: Optional[str] = None
+    __product_name: Optional[str] = None
+    __product_price: Optional[int] = None
+    __product_type: Optional[str] = None
+    __quantity: Optional[int] = None
+    __tax_amount: Optional[int] = None
+    __unit: Optional[str] = None
 
     @property
-    def discount_amount(self) -> int:
+    def discount_amount(self) -> Optional[int]:
         """
         | Discount on the line item, with the last two digits implied as decimal places
 
@@ -29,11 +29,24 @@ class OrderLineDetails(DataObject):
         return self.__discount_amount
 
     @discount_amount.setter
-    def discount_amount(self, value: int):
+    def discount_amount(self, value: Optional[int]) -> None:
         self.__discount_amount = value
 
     @property
-    def product_code(self) -> str:
+    def product_brand(self) -> Optional[str]:
+        """
+        | The brand of the product.
+
+        Type: str
+        """
+        return self.__product_brand
+
+    @product_brand.setter
+    def product_brand(self, value: Optional[str]) -> None:
+        self.__product_brand = value
+
+    @property
+    def product_code(self) -> Optional[str]:
         """
         | Product or UPC Code
 
@@ -42,11 +55,11 @@ class OrderLineDetails(DataObject):
         return self.__product_code
 
     @product_code.setter
-    def product_code(self, value: str):
+    def product_code(self, value: Optional[str]) -> None:
         self.__product_code = value
 
     @property
-    def product_name(self) -> str:
+    def product_name(self) -> Optional[str]:
         """
         | The name of the product.
 
@@ -55,11 +68,11 @@ class OrderLineDetails(DataObject):
         return self.__product_name
 
     @product_name.setter
-    def product_name(self, value: str):
+    def product_name(self, value: Optional[str]) -> None:
         self.__product_name = value
 
     @property
-    def product_price(self) -> int:
+    def product_price(self) -> Optional[int]:
         """
         | The price of one unit of the product, the value should be zero or greater
 
@@ -68,11 +81,11 @@ class OrderLineDetails(DataObject):
         return self.__product_price
 
     @product_price.setter
-    def product_price(self, value: int):
+    def product_price(self, value: Optional[int]) -> None:
         self.__product_price = value
 
     @property
-    def product_type(self) -> str:
+    def product_type(self) -> Optional[str]:
         """
         | Code used to classify items that are purchased
 
@@ -81,25 +94,24 @@ class OrderLineDetails(DataObject):
         return self.__product_type
 
     @product_type.setter
-    def product_type(self, value: str):
+    def product_type(self, value: Optional[str]) -> None:
         self.__product_type = value
 
     @property
-    def quantity(self) -> int:
+    def quantity(self) -> Optional[int]:
         """
-        | Quantity of the units being purchased, should be greater than zero
-        | Note: Must not be all spaces or all zeros
+        | Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros
 
         Type: int
         """
         return self.__quantity
 
     @quantity.setter
-    def quantity(self, value: int):
+    def quantity(self, value: Optional[int]) -> None:
         self.__quantity = value
 
     @property
-    def tax_amount(self) -> int:
+    def tax_amount(self) -> Optional[int]:
         """
         | Tax on the line item, with the last two digits implied as decimal places
 
@@ -108,11 +120,11 @@ class OrderLineDetails(DataObject):
         return self.__tax_amount
 
     @tax_amount.setter
-    def tax_amount(self, value: int):
+    def tax_amount(self, value: Optional[int]) -> None:
         self.__tax_amount = value
 
     @property
-    def unit(self) -> str:
+    def unit(self) -> Optional[str]:
         """
         | Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
 
@@ -121,13 +133,15 @@ class OrderLineDetails(DataObject):
         return self.__unit
 
     @unit.setter
-    def unit(self, value: str):
+    def unit(self, value: Optional[str]) -> None:
         self.__unit = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(OrderLineDetails, self).to_dictionary()
         if self.discount_amount is not None:
             dictionary['discountAmount'] = self.discount_amount
+        if self.product_brand is not None:
+            dictionary['productBrand'] = self.product_brand
         if self.product_code is not None:
             dictionary['productCode'] = self.product_code
         if self.product_name is not None:
@@ -144,10 +158,12 @@ class OrderLineDetails(DataObject):
             dictionary['unit'] = self.unit
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'OrderLineDetails':
         super(OrderLineDetails, self).from_dictionary(dictionary)
         if 'discountAmount' in dictionary:
             self.discount_amount = dictionary['discountAmount']
+        if 'productBrand' in dictionary:
+            self.product_brand = dictionary['productBrand']
         if 'productCode' in dictionary:
             self.product_code = dictionary['productCode']
         if 'productName' in dictionary:

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

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OrderReferences(DataObject):
+
+    __descriptor: Optional[str] = None
+    __merchant_parameters: Optional[str] = None
+    __merchant_reference: Optional[str] = None
+
+    @property
+    def descriptor(self) -> Optional[str]:
+        """
+        | Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
+        
+        * AIB - 22 characters
+        * American Express - 25 characters
+        * Atos Origin BNP - 15 characters
+        * Barclays - 25 characters
+        * Catella - 22 characters
+        * CBA - 20 characters
+        * Elavon - 25 characters
+        * First Data - 25 characters
+        * INICIS (INIPAY) - 22-30 characters
+        * JCB - 25 characters
+        * Merchant Solutions - 22-25 characters
+        * Payvision (EU & HK) - 25 characters
+        * SEB Euroline - 22 characters
+        * Sub1 Argentina - 15 characters
+        * Wells Fargo - 25 characters Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays For alternative payment products the maximum allowed length varies per payment product:
+        * 402 e-Przelewy - 30 characters
+        * 404 INICIS - 80 characters
+        * 802 Nordea ePayment Finland - 234 characters
+        * 809 iDeal - 32 characters
+        * 836 SOFORT - 42 characters
+        * 840 PayPal - 127 characters
+        * 841 WebMoney - 175 characters
+        * 849 Yandex - 64 characters
+        * 861 Alipay - 256 characters
+        * 863 WeChat Pay - 32 characters
+        * 880 BOKU - 20 characters
+        * 8580 Qiwi - 255 characters
+        * 1504 Konbini - 80 characters All other payment products do not support a descriptor.
+
+        Type: str
+        """
+        return self.__descriptor
+
+    @descriptor.setter
+    def descriptor(self, value: Optional[str]) -> None:
+        self.__descriptor = value
+
+    @property
+    def merchant_parameters(self) -> Optional[str]:
+        """
+        | It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications. This field must not contain any personal data.
+
+        Type: str
+        """
+        return self.__merchant_parameters
+
+    @merchant_parameters.setter
+    def merchant_parameters(self, value: Optional[str]) -> None:
+        self.__merchant_parameters = value
+
+    @property
+    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
+
+        Type: str
+        """
+        return self.__merchant_reference
+
+    @merchant_reference.setter
+    def merchant_reference(self, value: Optional[str]) -> None:
+        self.__merchant_reference = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OrderReferences, self).to_dictionary()
+        if self.descriptor is not None:
+            dictionary['descriptor'] = self.descriptor
+        if self.merchant_parameters is not None:
+            dictionary['merchantParameters'] = self.merchant_parameters
+        if self.merchant_reference is not None:
+            dictionary['merchantReference'] = self.merchant_reference
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OrderReferences':
+        super(OrderReferences, self).from_dictionary(dictionary)
+        if 'descriptor' in dictionary:
+            self.descriptor = dictionary['descriptor']
+        if 'merchantParameters' in dictionary:
+            self.merchant_parameters = dictionary['merchantParameters']
+        if 'merchantReference' in dictionary:
+            self.merchant_reference = dictionary['merchantReference']
+        return self