onlinepayments-sdk-python3 9.0.0__tar.gz → 9.2.0__tar.gz

{onlinepayments_sdk_python3-9.0.0/onlinepayments_sdk_python3.egg-info → onlinepayments_sdk_python3-9.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onlinepayments-sdk-python3
-Version: 9.0.0
+Version: 9.2.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-9.0.0 → onlinepayments_sdk_python3-9.2.0}/onlinepayments/sdk/communication/metadata_provider.py

@@ -23,7 +23,7 @@ class MetadataProvider(IMetadataProvider):
     """
     Provides meta info about the server.
     """
-    __sdk_version = "9.0.0"
+    __sdk_version = "9.2.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-9.0.0 → onlinepayments_sdk_python3-9.2.0}/onlinepayments/sdk/domain/acceptance.py

@@ -12,6 +12,7 @@ class Acceptance(DataObject):
 
     __acceptance_system_application_id: Optional[str] = None
     __authorization_date: Optional[datetime] = None
+    __authorization_message_reference: Optional[str] = None
 
     @property
     def acceptance_system_application_id(self) -> Optional[str]:
@@ -39,12 +40,27 @@ class Acceptance(DataObject):
     def authorization_date(self, value: Optional[datetime]) -> None:
         self.__authorization_date = value
 
+    @property
+    def authorization_message_reference(self) -> Optional[str]:
+        """
+        | Identifier shared with the acquirer during the authorization process. For example, this reference data could be sent by the acquirer in the authorization response, then sent (unchanged) in a subsequent authorization reversal message, to the extent that the acquirer is able to match a reversal message to the associated response message.
+
+        Type: str
+        """
+        return self.__authorization_message_reference
+
+    @authorization_message_reference.setter
+    def authorization_message_reference(self, value: Optional[str]) -> None:
+        self.__authorization_message_reference = value
+
     def to_dictionary(self) -> dict:
         dictionary = super(Acceptance, self).to_dictionary()
         if self.acceptance_system_application_id is not None:
             dictionary['acceptanceSystemApplicationId'] = self.acceptance_system_application_id
         if self.authorization_date is not None:
             dictionary['authorizationDate'] = DataObject.format_datetime(self.authorization_date)
+        if self.authorization_message_reference is not None:
+            dictionary['authorizationMessageReference'] = self.authorization_message_reference
         return dictionary
 
     def from_dictionary(self, dictionary: dict) -> 'Acceptance':
@@ -53,4 +69,6 @@ class Acceptance(DataObject):
             self.acceptance_system_application_id = dictionary['acceptanceSystemApplicationId']
         if 'authorizationDate' in dictionary:
             self.authorization_date = DataObject.parse_datetime(dictionary['authorizationDate'])
+        if 'authorizationMessageReference' in dictionary:
+            self.authorization_message_reference = dictionary['authorizationMessageReference']
         return self

onlinepayments_sdk_python3-9.2.0/onlinepayments/sdk/domain/add_authorization_details_response.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .payment_response import PaymentResponse
+
+
+class AddAuthorizationDetailsResponse(DataObject):
+
+    __payment: Optional[PaymentResponse] = None
+
+    @property
+    def payment(self) -> Optional[PaymentResponse]:
+        """
+        | This object holds the properties related to the payment.
+
+        Type: :class:`onlinepayments.sdk.domain.payment_response.PaymentResponse`
+        """
+        return self.__payment
+
+    @payment.setter
+    def payment(self, value: Optional[PaymentResponse]) -> None:
+        self.__payment = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(AddAuthorizationDetailsResponse, self).to_dictionary()
+        if self.payment is not None:
+            dictionary['payment'] = self.payment.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'AddAuthorizationDetailsResponse':
+        super(AddAuthorizationDetailsResponse, self).from_dictionary(dictionary)
+        if 'payment' in dictionary:
+            if not isinstance(dictionary['payment'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['payment']))
+            value = PaymentResponse()
+            self.payment = value.from_dictionary(dictionary['payment'])
+        return self

onlinepayments_sdk_python3-9.2.0/onlinepayments/sdk/domain/amex.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .dpa_data import DpaData
+from .dpa_transaction_options import DpaTransactionOptions
+
+
+class Amex(DataObject):
+
+    __dpa_data: Optional[DpaData] = None
+    __dpa_transaction_options: Optional[DpaTransactionOptions] = None
+    __src_initiator_id: Optional[str] = None
+
+    @property
+    def dpa_data(self) -> Optional[DpaData]:
+        """
+        | DpaData data should be provided to SRC system if srcDpaId is not provided.
+
+        Type: :class:`onlinepayments.sdk.domain.dpa_data.DpaData`
+        """
+        return self.__dpa_data
+
+    @dpa_data.setter
+    def dpa_data(self, value: Optional[DpaData]) -> None:
+        self.__dpa_data = value
+
+    @property
+    def dpa_transaction_options(self) -> Optional[DpaTransactionOptions]:
+        """
+        | DPA configuration data that can override any configuration set before.
+
+        Type: :class:`onlinepayments.sdk.domain.dpa_transaction_options.DpaTransactionOptions`
+        """
+        return self.__dpa_transaction_options
+
+    @dpa_transaction_options.setter
+    def dpa_transaction_options(self, value: Optional[DpaTransactionOptions]) -> None:
+        self.__dpa_transaction_options = value
+
+    @property
+    def src_initiator_id(self) -> Optional[str]:
+        """
+        | SRCI identifier. This is generated by the SRC System during onboarding.
+
+        Type: str
+        """
+        return self.__src_initiator_id
+
+    @src_initiator_id.setter
+    def src_initiator_id(self, value: Optional[str]) -> None:
+        self.__src_initiator_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(Amex, self).to_dictionary()
+        if self.dpa_data is not None:
+            dictionary['dpaData'] = self.dpa_data.to_dictionary()
+        if self.dpa_transaction_options is not None:
+            dictionary['dpaTransactionOptions'] = self.dpa_transaction_options.to_dictionary()
+        if self.src_initiator_id is not None:
+            dictionary['srcInitiatorId'] = self.src_initiator_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'Amex':
+        super(Amex, self).from_dictionary(dictionary)
+        if 'dpaData' in dictionary:
+            if not isinstance(dictionary['dpaData'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['dpaData']))
+            value = DpaData()
+            self.dpa_data = value.from_dictionary(dictionary['dpaData'])
+        if 'dpaTransactionOptions' in dictionary:
+            if not isinstance(dictionary['dpaTransactionOptions'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['dpaTransactionOptions']))
+            value = DpaTransactionOptions()
+            self.dpa_transaction_options = value.from_dictionary(dictionary['dpaTransactionOptions'])
+        if 'srcInitiatorId' in dictionary:
+            self.src_initiator_id = dictionary['srcInitiatorId']
+        return self

onlinepayments_sdk_python3-9.2.0/onlinepayments/sdk/domain/api_parameters.py

@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .amex import Amex
+from .data_object import DataObject
+from .mastercard import Mastercard
+from .payment_product5002default_brand_parameters import PaymentProduct5002defaultBrandParameters
+from .visa import Visa
+
+
+class ApiParameters(DataObject):
+
+    __amex: Optional[Amex] = None
+    __cb: Optional[PaymentProduct5002defaultBrandParameters] = None
+    __eftpos: Optional[PaymentProduct5002defaultBrandParameters] = None
+    __mastercard: Optional[Mastercard] = None
+    __visa: Optional[Visa] = None
+
+    @property
+    def amex(self) -> Optional[Amex]:
+        """
+        | The following fields need to be provided to the amex field within the configuration.
+
+        Type: :class:`onlinepayments.sdk.domain.amex.Amex`
+        """
+        return self.__amex
+
+    @amex.setter
+    def amex(self, value: Optional[Amex]) -> None:
+        self.__amex = value
+
+    @property
+    def cb(self) -> Optional[PaymentProduct5002defaultBrandParameters]:
+        """
+        | The following fields need to be provided to the cb field within the configuration.
+
+        Type: :class:`onlinepayments.sdk.domain.payment_product5002default_brand_parameters.PaymentProduct5002defaultBrandParameters`
+        """
+        return self.__cb
+
+    @cb.setter
+    def cb(self, value: Optional[PaymentProduct5002defaultBrandParameters]) -> None:
+        self.__cb = value
+
+    @property
+    def eftpos(self) -> Optional[PaymentProduct5002defaultBrandParameters]:
+        """
+        | The following fields need to be provided to the eftpos field within the configuration.
+
+        Type: :class:`onlinepayments.sdk.domain.payment_product5002default_brand_parameters.PaymentProduct5002defaultBrandParameters`
+        """
+        return self.__eftpos
+
+    @eftpos.setter
+    def eftpos(self, value: Optional[PaymentProduct5002defaultBrandParameters]) -> None:
+        self.__eftpos = value
+
+    @property
+    def mastercard(self) -> Optional[Mastercard]:
+        """
+        | The following fields need to be provided to the mastercard field within the configuration.
+
+        Type: :class:`onlinepayments.sdk.domain.mastercard.Mastercard`
+        """
+        return self.__mastercard
+
+    @mastercard.setter
+    def mastercard(self, value: Optional[Mastercard]) -> None:
+        self.__mastercard = value
+
+    @property
+    def visa(self) -> Optional[Visa]:
+        """
+        | The following fields need to be provided to the visa field within the configuration.
+
+        Type: :class:`onlinepayments.sdk.domain.visa.Visa`
+        """
+        return self.__visa
+
+    @visa.setter
+    def visa(self, value: Optional[Visa]) -> None:
+        self.__visa = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ApiParameters, self).to_dictionary()
+        if self.amex is not None:
+            dictionary['amex'] = self.amex.to_dictionary()
+        if self.cb is not None:
+            dictionary['cb'] = self.cb.to_dictionary()
+        if self.eftpos is not None:
+            dictionary['eftpos'] = self.eftpos.to_dictionary()
+        if self.mastercard is not None:
+            dictionary['mastercard'] = self.mastercard.to_dictionary()
+        if self.visa is not None:
+            dictionary['visa'] = self.visa.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ApiParameters':
+        super(ApiParameters, self).from_dictionary(dictionary)
+        if 'amex' in dictionary:
+            if not isinstance(dictionary['amex'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['amex']))
+            value = Amex()
+            self.amex = value.from_dictionary(dictionary['amex'])
+        if 'cb' in dictionary:
+            if not isinstance(dictionary['cb'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['cb']))
+            value = PaymentProduct5002defaultBrandParameters()
+            self.cb = value.from_dictionary(dictionary['cb'])
+        if 'eftpos' in dictionary:
+            if not isinstance(dictionary['eftpos'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['eftpos']))
+            value = PaymentProduct5002defaultBrandParameters()
+            self.eftpos = value.from_dictionary(dictionary['eftpos'])
+        if 'mastercard' in dictionary:
+            if not isinstance(dictionary['mastercard'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['mastercard']))
+            value = Mastercard()
+            self.mastercard = value.from_dictionary(dictionary['mastercard'])
+        if 'visa' in dictionary:
+            if not isinstance(dictionary['visa'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['visa']))
+            value = Visa()
+            self.visa = value.from_dictionary(dictionary['visa'])
+        return self

{onlinepayments_sdk_python3-9.0.0 → onlinepayments_sdk_python3-9.2.0}/onlinepayments/sdk/domain/apple_pay_recurring_payment_request.py

@@ -58,7 +58,7 @@ class ApplePayRecurringPaymentRequest(DataObject):
     @property
     def regular_billing(self) -> Optional[ApplePayLineItem]:
         """
-        | Object containing specific data regarding Apple Pay recurring payment.
+        | Object containing specific data regarding Apple Pay recurring regular payment
 
         Type: :class:`onlinepayments.sdk.domain.apple_pay_line_item.ApplePayLineItem`
         """
@@ -71,7 +71,7 @@ class ApplePayRecurringPaymentRequest(DataObject):
     @property
     def trial_billing(self) -> Optional[ApplePayLineItem]:
         """
-        | Object containing specific data regarding Apple Pay recurring payment.
+        | Object containing specific data regarding Apple Pay recurring trial payment
 
         Type: :class:`onlinepayments.sdk.domain.apple_pay_line_item.ApplePayLineItem`
         """

onlinepayments_sdk_python3-9.2.0/onlinepayments/sdk/domain/authentication_options.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class AuthenticationOptions(DataObject):
+
+    __acquirer_bin: Optional[str] = None
+    __acquirer_merchant_id: Optional[str] = None
+    __merchant_category_code: Optional[str] = None
+    __merchant_country_code: Optional[str] = None
+
+    @property
+    def acquirer_bin(self) -> Optional[str]:
+        """
+        | Acquiring institution identification code as assigned by the 3DS Directory Server receiving the AReq message.
+
+        Type: str
+        """
+        return self.__acquirer_bin
+
+    @acquirer_bin.setter
+    def acquirer_bin(self, value: Optional[str]) -> None:
+        self.__acquirer_bin = value
+
+    @property
+    def acquirer_merchant_id(self) -> Optional[str]:
+        """
+        | Acquiring institution identification code.
+
+        Type: str
+        """
+        return self.__acquirer_merchant_id
+
+    @acquirer_merchant_id.setter
+    def acquirer_merchant_id(self, value: Optional[str]) -> None:
+        self.__acquirer_merchant_id = value
+
+    @property
+    def merchant_category_code(self) -> Optional[str]:
+        """
+        | Code representing merchant’s type of business, product or service.
+
+        Type: str
+        """
+        return self.__merchant_category_code
+
+    @merchant_category_code.setter
+    def merchant_category_code(self, value: Optional[str]) -> None:
+        self.__merchant_category_code = value
+
+    @property
+    def merchant_country_code(self) -> Optional[str]:
+        """
+        | ISO-3166 country code of the merchant.
+
+        Type: str
+        """
+        return self.__merchant_country_code
+
+    @merchant_country_code.setter
+    def merchant_country_code(self, value: Optional[str]) -> None:
+        self.__merchant_country_code = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(AuthenticationOptions, self).to_dictionary()
+        if self.acquirer_bin is not None:
+            dictionary['acquirerBIN'] = self.acquirer_bin
+        if self.acquirer_merchant_id is not None:
+            dictionary['acquirerMerchantId'] = self.acquirer_merchant_id
+        if self.merchant_category_code is not None:
+            dictionary['merchantCategoryCode'] = self.merchant_category_code
+        if self.merchant_country_code is not None:
+            dictionary['merchantCountryCode'] = self.merchant_country_code
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'AuthenticationOptions':
+        super(AuthenticationOptions, self).from_dictionary(dictionary)
+        if 'acquirerBIN' in dictionary:
+            self.acquirer_bin = dictionary['acquirerBIN']
+        if 'acquirerMerchantId' in dictionary:
+            self.acquirer_merchant_id = dictionary['acquirerMerchantId']
+        if 'merchantCategoryCode' in dictionary:
+            self.merchant_category_code = dictionary['merchantCategoryCode']
+        if 'merchantCountryCode' in dictionary:
+            self.merchant_country_code = dictionary['merchantCountryCode']
+        return self

{onlinepayments_sdk_python3-9.0.0 → onlinepayments_sdk_python3-9.2.0}/onlinepayments/sdk/domain/calculate_surcharge_response.py

@@ -15,6 +15,8 @@ class CalculateSurchargeResponse(DataObject):
     @property
     def surcharges(self) -> Optional[List[Surcharge]]:
         """
+        | List of surcharge calculations matching the bin and paymentProductId if supplied
+
         Type: list[:class:`onlinepayments.sdk.domain.surcharge.Surcharge`]
         """
         return self.__surcharges

{onlinepayments_sdk_python3-9.0.0 → onlinepayments_sdk_python3-9.2.0}/onlinepayments/sdk/domain/cancel_payment_request.py

@@ -48,6 +48,8 @@ class CancelPaymentRequest(DataObject):
     @property
     def line_item_details(self) -> Optional[List[LineItemDetail]]:
         """
+        | List of lineItemIds and quantities for capture/refund/cancellation.
+
         Type: list[:class:`onlinepayments.sdk.domain.line_item_detail.LineItemDetail`]
         """
         return self.__line_item_details

{onlinepayments_sdk_python3-9.0.0 → onlinepayments_sdk_python3-9.2.0}/onlinepayments/sdk/domain/capture_output.py

@@ -33,7 +33,7 @@ class CaptureOutput(DataObject):
     @property
     def acquired_amount(self) -> Optional[AmountOfMoney]:
         """
-        | Object containing amount and ISO currency code attributes
+        | Amount that has been acquired by the Acquirer
 
         Type: :class:`onlinepayments.sdk.domain.amount_of_money.AmountOfMoney`
         """

{onlinepayments_sdk_python3-9.0.0 → onlinepayments_sdk_python3-9.2.0}/onlinepayments/sdk/domain/capture_payment_request.py

@@ -49,6 +49,8 @@ class CapturePaymentRequest(DataObject):
     @property
     def line_item_details(self) -> Optional[List[LineItemDetail]]:
         """
+        | List of lineItemIds and quantities for capture/refund/cancellation.
+
         Type: list[:class:`onlinepayments.sdk.domain.line_item_detail.LineItemDetail`]
         """
         return self.__line_item_details