onlinepayments-sdk-python3 8.4.0__tar.gz → 8.5.0__tar.gz

{onlinepayments_sdk_python3-8.4.0/onlinepayments_sdk_python3.egg-info → onlinepayments_sdk_python3-8.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onlinepayments-sdk-python3
-Version: 8.4.0
+Version: 8.5.0
 Summary: SDK to communicate with the Online Payments platform using the Online Payments Server API
 Home-page: https://github.com/wl-online-payments-direct/sdk-python3
 Author: Worldline Direct support team

{onlinepayments_sdk_python3-8.4.0 → onlinepayments_sdk_python3-8.5.0}/onlinepayments/sdk/communication/metadata_provider.py

@@ -23,7 +23,7 @@ class MetadataProvider(IMetadataProvider):
     """
     Provides meta info about the server.
     """
-    __sdk_version = "8.4.0"
+    __sdk_version = "8.5.0"
     __server_meta_info_header = "X-GCS-ServerMetaInfo"
     __prohibited_headers = tuple(sorted([__server_meta_info_header, "X-GCS-Idempotence-Key", "Date", "Content-Type", "Authorization"],
                                         key=str.lower))

onlinepayments_sdk_python3-8.5.0/onlinepayments/sdk/domain/card_payment_method_specific_output_summary.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .card_payment_method_specific_output_summary_card import CardPaymentMethodSpecificOutputSummaryCard
+from .data_object import DataObject
+
+
+class CardPaymentMethodSpecificOutputSummary(DataObject):
+
+    __card: Optional[CardPaymentMethodSpecificOutputSummaryCard] = None
+    __token: Optional[str] = None
+
+    @property
+    def card(self) -> Optional[CardPaymentMethodSpecificOutputSummaryCard]:
+        """
+        | Card details
+
+        Type: :class:`onlinepayments.sdk.domain.card_payment_method_specific_output_summary_card.CardPaymentMethodSpecificOutputSummaryCard`
+        """
+        return self.__card
+
+    @card.setter
+    def card(self, value: Optional[CardPaymentMethodSpecificOutputSummaryCard]) -> None:
+        self.__card = value
+
+    @property
+    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.
+
+        Type: str
+        """
+        return self.__token
+
+    @token.setter
+    def token(self, value: Optional[str]) -> None:
+        self.__token = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CardPaymentMethodSpecificOutputSummary, self).to_dictionary()
+        if self.card is not None:
+            dictionary['card'] = self.card.to_dictionary()
+        if self.token is not None:
+            dictionary['token'] = self.token
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CardPaymentMethodSpecificOutputSummary':
+        super(CardPaymentMethodSpecificOutputSummary, self).from_dictionary(dictionary)
+        if 'card' in dictionary:
+            if not isinstance(dictionary['card'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['card']))
+            value = CardPaymentMethodSpecificOutputSummaryCard()
+            self.card = value.from_dictionary(dictionary['card'])
+        if 'token' in dictionary:
+            self.token = dictionary['token']
+        return self

onlinepayments_sdk_python3-8.5.0/onlinepayments/sdk/domain/card_payment_method_specific_output_summary_card.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class CardPaymentMethodSpecificOutputSummaryCard(DataObject):
+
+    __card_number: Optional[str] = None
+
+    @property
+    def card_number(self) -> Optional[str]:
+        """
+        | The masked credit/debit card number
+
+        Type: str
+        """
+        return self.__card_number
+
+    @card_number.setter
+    def card_number(self, value: Optional[str]) -> None:
+        self.__card_number = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CardPaymentMethodSpecificOutputSummaryCard, self).to_dictionary()
+        if self.card_number is not None:
+            dictionary['cardNumber'] = self.card_number
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CardPaymentMethodSpecificOutputSummaryCard':
+        super(CardPaymentMethodSpecificOutputSummaryCard, self).from_dictionary(dictionary)
+        if 'cardNumber' in dictionary:
+            self.card_number = dictionary['cardNumber']
+        return self

{onlinepayments_sdk_python3-8.4.0 → onlinepayments_sdk_python3-8.5.0}/onlinepayments/sdk/domain/create_hosted_fields_session_request.py

@@ -10,6 +10,7 @@ from .data_object import DataObject
 class CreateHostedFieldsSessionRequest(DataObject):
 
     __locale: Optional[str] = None
+    __origin: Optional[str] = None
     __tokens: Optional[List[str]] = None
 
     @property
@@ -25,6 +26,19 @@ class CreateHostedFieldsSessionRequest(DataObject):
     def locale(self, value: Optional[str]) -> None:
         self.__locale = value
 
+    @property
+    def origin(self) -> Optional[str]:
+        """
+        | merchant site's origin.
+
+        Type: str
+        """
+        return self.__origin
+
+    @origin.setter
+    def origin(self, value: Optional[str]) -> None:
+        self.__origin = value
+
     @property
     def tokens(self) -> Optional[List[str]]:
         """
@@ -40,6 +54,8 @@ class CreateHostedFieldsSessionRequest(DataObject):
         dictionary = super(CreateHostedFieldsSessionRequest, self).to_dictionary()
         if self.locale is not None:
             dictionary['locale'] = self.locale
+        if self.origin is not None:
+            dictionary['origin'] = self.origin
         if self.tokens is not None:
             dictionary['tokens'] = []
             for element in self.tokens:
@@ -51,6 +67,8 @@ class CreateHostedFieldsSessionRequest(DataObject):
         super(CreateHostedFieldsSessionRequest, self).from_dictionary(dictionary)
         if 'locale' in dictionary:
             self.locale = dictionary['locale']
+        if 'origin' in dictionary:
+            self.origin = dictionary['origin']
         if 'tokens' in dictionary:
             if not isinstance(dictionary['tokens'], list):
                 raise TypeError('value \'{}\' is not a list'.format(dictionary['tokens']))

{onlinepayments_sdk_python3-8.4.0 → onlinepayments_sdk_python3-8.5.0}/onlinepayments/sdk/domain/create_hosted_fields_session_response.py

@@ -10,11 +10,25 @@ from .session_data import SessionData
 
 class CreateHostedFieldsSessionResponse(DataObject):
 
+    __hosted_fields_session_id: Optional[str] = None
     __invalid_tokens: Optional[List[str]] = None
     __sdk_sri: Optional[str] = None
     __sdk_url: Optional[str] = None
     __session_data: Optional[SessionData] = None
 
+    @property
+    def hosted_fields_session_id(self) -> Optional[str]:
+        """
+        | Id of the created session
+
+        Type: str
+        """
+        return self.__hosted_fields_session_id
+
+    @hosted_fields_session_id.setter
+    def hosted_fields_session_id(self, value: Optional[str]) -> None:
+        self.__hosted_fields_session_id = value
+
     @property
     def invalid_tokens(self) -> Optional[List[str]]:
         """
@@ -69,6 +83,8 @@ class CreateHostedFieldsSessionResponse(DataObject):
 
     def to_dictionary(self) -> dict:
         dictionary = super(CreateHostedFieldsSessionResponse, self).to_dictionary()
+        if self.hosted_fields_session_id is not None:
+            dictionary['hostedFieldsSessionId'] = self.hosted_fields_session_id
         if self.invalid_tokens is not None:
             dictionary['invalidTokens'] = []
             for element in self.invalid_tokens:
@@ -84,6 +100,8 @@ class CreateHostedFieldsSessionResponse(DataObject):
 
     def from_dictionary(self, dictionary: dict) -> 'CreateHostedFieldsSessionResponse':
         super(CreateHostedFieldsSessionResponse, self).from_dictionary(dictionary)
+        if 'hostedFieldsSessionId' in dictionary:
+            self.hosted_fields_session_id = dictionary['hostedFieldsSessionId']
         if 'invalidTokens' in dictionary:
             if not isinstance(dictionary['invalidTokens'], list):
                 raise TypeError('value \'{}\' is not a list'.format(dictionary['invalidTokens']))

{onlinepayments_sdk_python3-8.4.0 → onlinepayments_sdk_python3-8.5.0}/onlinepayments/sdk/domain/create_mandate_request.py

@@ -120,7 +120,7 @@ class CreateMandateRequest(DataObject):
         * TICK_BOX
         * AIS
         
-        | Refer to the support page to determine the applicable signature types.
+        | Not all signature types are applicable to all merchants. Please visit the support page to determine the applicable signature types.
 
         Type: str
         """

{onlinepayments_sdk_python3-8.4.0 → onlinepayments_sdk_python3-8.5.0}/onlinepayments/sdk/domain/create_mandate_with_return_url.py

@@ -120,7 +120,7 @@ class CreateMandateWithReturnUrl(DataObject):
         * TICK_BOX
         * AIS
         
-        | Refer to the support page to determine the applicable signature types.
+        | Not all signature types are applicable to all merchants. Please visit the support page to determine the applicable signature types.
 
         Type: str
         """

{onlinepayments_sdk_python3-8.4.0 → onlinepayments_sdk_python3-8.5.0}/onlinepayments/sdk/domain/create_payout_request.py

@@ -50,36 +50,7 @@ class CreatePayoutRequest(DataObject):
     @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.
+        | **Deprecated**: It is recommended to use the new merchantReconciliationReference for the same usage, and the new softDescriptor on top only in case you start needing another specific value to be pushed to the cardholder statement.
 
         Type: str
         """

onlinepayments_sdk_python3-8.5.0/onlinepayments/sdk/domain/cursor_pagination_info.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class CursorPaginationInfo(DataObject):
+
+    __has_more: Optional[bool] = None
+    __next_cursor: Optional[str] = None
+
+    @property
+    def has_more(self) -> Optional[bool]:
+        """
+        | Indicates whether more results are available
+
+        Type: bool
+        """
+        return self.__has_more
+
+    @has_more.setter
+    def has_more(self, value: Optional[bool]) -> None:
+        self.__has_more = value
+
+    @property
+    def next_cursor(self) -> Optional[str]:
+        """
+        | Opaque cursor for retrieving the next page. Null if no more results available.
+
+        Type: str
+        """
+        return self.__next_cursor
+
+    @next_cursor.setter
+    def next_cursor(self, value: Optional[str]) -> None:
+        self.__next_cursor = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CursorPaginationInfo, self).to_dictionary()
+        if self.has_more is not None:
+            dictionary['hasMore'] = self.has_more
+        if self.next_cursor is not None:
+            dictionary['nextCursor'] = self.next_cursor
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CursorPaginationInfo':
+        super(CursorPaginationInfo, self).from_dictionary(dictionary)
+        if 'hasMore' in dictionary:
+            self.has_more = dictionary['hasMore']
+        if 'nextCursor' in dictionary:
+            self.next_cursor = dictionary['nextCursor']
+        return self

{onlinepayments_sdk_python3-8.4.0 → onlinepayments_sdk_python3-8.5.0}/onlinepayments/sdk/domain/mandate_contact_details.py

@@ -10,6 +10,7 @@ from .data_object import DataObject
 class MandateContactDetails(DataObject):
 
     __email_address: Optional[str] = None
+    __phone_number: Optional[str] = None
 
     @property
     def email_address(self) -> Optional[str]:
@@ -24,14 +25,31 @@ class MandateContactDetails(DataObject):
     def email_address(self, value: Optional[str]) -> None:
         self.__email_address = value
 
+    @property
+    def phone_number(self) -> Optional[str]:
+        """
+        | International version of the phone number of the customer including the leading + (i.e. +4917612345678)
+
+        Type: str
+        """
+        return self.__phone_number
+
+    @phone_number.setter
+    def phone_number(self, value: Optional[str]) -> None:
+        self.__phone_number = value
+
     def to_dictionary(self) -> dict:
         dictionary = super(MandateContactDetails, self).to_dictionary()
         if self.email_address is not None:
             dictionary['emailAddress'] = self.email_address
+        if self.phone_number is not None:
+            dictionary['phoneNumber'] = self.phone_number
         return dictionary
 
     def from_dictionary(self, dictionary: dict) -> 'MandateContactDetails':
         super(MandateContactDetails, self).from_dictionary(dictionary)
         if 'emailAddress' in dictionary:
             self.email_address = dictionary['emailAddress']
+        if 'phoneNumber' in dictionary:
+            self.phone_number = dictionary['phoneNumber']
         return self

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

@@ -0,0 +1,156 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class OperationPaymentReferences(DataObject):
+
+    __merchant_comment: Optional[str] = None
+    __merchant_reconciliation_reference: Optional[str] = None
+    __merchant_reference: Optional[str] = None
+    __operation_group_reference: Optional[str] = None
+    __soft_descriptor: Optional[str] = None
+    __structured_creditor_reference: Optional[str] = None
+
+    @property
+    def merchant_comment(self) -> Optional[str]:
+        """
+        | It allows you to store additional information for the transaction. This is typically used in case you need additional data field on top of the other ones, such as merchantAdditionalReference. This data is not sent to the acquirer, and is used for reporting purpose.
+
+        Type: str
+        """
+        return self.__merchant_comment
+
+    @merchant_comment.setter
+    def merchant_comment(self, value: Optional[str]) -> None:
+        self.__merchant_comment = value
+
+    @property
+    def merchant_reconciliation_reference(self) -> Optional[str]:
+        """
+        | It allows you to store additional information for the transaction. This is sent to the acquirer (if it accepts it), and is typically to be used for reconciliation purpose . As this information appears in reporting, please do not encode any sensitive data.
+
+        Type: str
+        """
+        return self.__merchant_reconciliation_reference
+
+    @merchant_reconciliation_reference.setter
+    def merchant_reconciliation_reference(self, value: Optional[str]) -> None:
+        self.__merchant_reconciliation_reference = 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
+
+    @property
+    def operation_group_reference(self) -> Optional[str]:
+        """
+        | An identifier for a group of transactions. This reference helps to link multiple related transactions together, facilitating easier reconciliation and tracking.
+
+        Type: str
+        """
+        return self.__operation_group_reference
+
+    @operation_group_reference.setter
+    def operation_group_reference(self, value: Optional[str]) -> None:
+        self.__operation_group_reference = value
+
+    @property
+    def soft_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.__soft_descriptor
+
+    @soft_descriptor.setter
+    def soft_descriptor(self, value: Optional[str]) -> None:
+        self.__soft_descriptor = value
+
+    @property
+    def structured_creditor_reference(self) -> Optional[str]:
+        """
+        | Creditor Reference to use where applicable for invoicing related to the transaction, in accordance with ISO 11649. Might require merchant specific setup to enable and is subject to agreement with the acquirer.
+
+        Type: str
+        """
+        return self.__structured_creditor_reference
+
+    @structured_creditor_reference.setter
+    def structured_creditor_reference(self, value: Optional[str]) -> None:
+        self.__structured_creditor_reference = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(OperationPaymentReferences, self).to_dictionary()
+        if self.merchant_comment is not None:
+            dictionary['merchantComment'] = self.merchant_comment
+        if self.merchant_reconciliation_reference is not None:
+            dictionary['merchantReconciliationReference'] = self.merchant_reconciliation_reference
+        if self.merchant_reference is not None:
+            dictionary['merchantReference'] = self.merchant_reference
+        if self.operation_group_reference is not None:
+            dictionary['operationGroupReference'] = self.operation_group_reference
+        if self.soft_descriptor is not None:
+            dictionary['softDescriptor'] = self.soft_descriptor
+        if self.structured_creditor_reference is not None:
+            dictionary['structuredCreditorReference'] = self.structured_creditor_reference
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'OperationPaymentReferences':
+        super(OperationPaymentReferences, self).from_dictionary(dictionary)
+        if 'merchantComment' in dictionary:
+            self.merchant_comment = dictionary['merchantComment']
+        if 'merchantReconciliationReference' in dictionary:
+            self.merchant_reconciliation_reference = dictionary['merchantReconciliationReference']
+        if 'merchantReference' in dictionary:
+            self.merchant_reference = dictionary['merchantReference']
+        if 'operationGroupReference' in dictionary:
+            self.operation_group_reference = dictionary['operationGroupReference']
+        if 'softDescriptor' in dictionary:
+            self.soft_descriptor = dictionary['softDescriptor']
+        if 'structuredCreditorReference' in dictionary:
+            self.structured_creditor_reference = dictionary['structuredCreditorReference']
+        return self