onlinepayments-sdk-python3 4.23.0__zip → 5.1.0__zip

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/amount_breakdown.py

@@ -1,63 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-
-
-class AmountBreakdown(DataObject):
-    """
-    | Determines the type of the amount.
-    """
-
-    __amount = None
-    __type = None
-
-    @property
-    def amount(self) -> int:
-        """
-        | Amount in cents and always having 2 decimals
-
-        Type: int
-        """
-        return self.__amount
-
-    @amount.setter
-    def amount(self, value: int):
-        self.__amount = value
-
-    @property
-    def type(self) -> str:
-        """
-        | Type of the amount. Each type is only allowed to be provided once. Allowed values:
-        |  * AIRPORT_TAX - The amount of tax paid for the airport, with the last 2 digits implied as decimal places.
-        |  * CONSUMPTION_TAX - The amount of consumption tax paid by the customer, with the last 2 digits implied as decimal places.
-        |  * DISCOUNT - Discount on the entire transaction, with the last 2 digits implied as decimal places.
-        |  * DUTY - Duty on the entire transaction, with the last 2 digits implied as decimal places.
-        |  * SHIPPING - Shipping cost on the entire transaction, with the last 2 digits implied as decimal places.
-        |  * VAT - Total amount of VAT paid on the transaction, with the last 2 digits implied as decimal places.
-        |  * BASE_AMOUNT - Order amount excluding all taxes, discount & shipping costs, with the last 2 digits implied as decimal places. Note: BASE_AMOUNT is only supported by the payment platform.
-
-        Type: str
-        """
-        return self.__type
-
-    @type.setter
-    def type(self, value: str):
-        self.__type = value
-
-    def to_dictionary(self):
-        dictionary = super(AmountBreakdown, self).to_dictionary()
-        if self.amount is not None:
-            dictionary['amount'] = self.amount
-        if self.type is not None:
-            dictionary['type'] = self.type
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(AmountBreakdown, self).from_dictionary(dictionary)
-        if 'amount' in dictionary:
-            self.amount = dictionary['amount']
-        if 'type' in dictionary:
-            self.type = dictionary['type']
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/capture_payment_request.py

@@ -1,76 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.payment_references import PaymentReferences
-
-
-class CapturePaymentRequest(DataObject):
-    __amount = None
-    __is_final = None
-    __references = None
-
-    @property
-    def amount(self) -> int:
-        """
-        | Here you can specify the amount that you want to capture (specified in cents, where single digit currencies are presumed to have 2 digits). The amount can be lower than the amount that was authorized, but not higher. 
-        |  If left empty, the full amount will be captured and the request will be final. 
-        |  If the full amount is captured, the request will also be final.
-
-        Type: int
-        """
-        return self.__amount
-
-    @amount.setter
-    def amount(self, value: int):
-        self.__amount = value
-
-    @property
-    def is_final(self) -> bool:
-        """
-        | This property indicates whether this will be the final operation. The default value for this property is false.
-
-        Type: bool
-        """
-        return self.__is_final
-
-    @is_final.setter
-    def is_final(self, value: bool):
-        self.__is_final = value
-
-    @property
-    def references(self) -> PaymentReferences:
-        """
-        | Object that holds all reference properties that are linked to this transaction
-
-        Type: :class:`onlinepayments.sdk.domain.payment_references.PaymentReferences`
-        """
-        return self.__references
-
-    @references.setter
-    def references(self, value: PaymentReferences):
-        self.__references = value
-
-    def to_dictionary(self):
-        dictionary = super(CapturePaymentRequest, self).to_dictionary()
-        if self.amount is not None:
-            dictionary['amount'] = self.amount
-        if self.is_final is not None:
-            dictionary['isFinal'] = self.is_final
-        if self.references is not None:
-            dictionary['references'] = self.references.to_dictionary()
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(CapturePaymentRequest, self).from_dictionary(dictionary)
-        if 'amount' in dictionary:
-            self.amount = dictionary['amount']
-        if 'isFinal' in dictionary:
-            self.is_final = dictionary['isFinal']
-        if 'references' in dictionary:
-            if not isinstance(dictionary['references'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['references']))
-            value = PaymentReferences()
-            self.references = value.from_dictionary(dictionary['references'])
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/capture_status_output.py

@@ -1,38 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-
-
-class CaptureStatusOutput(DataObject):
-    """
-    | This object has the numeric representation of the current capture 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.
-    """
-
-    __status_code = None
-
-    @property
-    def status_code(self) -> int:
-        """
-        | Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the BackOffice and in report files.
-
-        Type: int
-        """
-        return self.__status_code
-
-    @status_code.setter
-    def status_code(self, value: int):
-        self.__status_code = value
-
-    def to_dictionary(self):
-        dictionary = super(CaptureStatusOutput, self).to_dictionary()
-        if self.status_code is not None:
-            dictionary['statusCode'] = self.status_code
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(CaptureStatusOutput, self).from_dictionary(dictionary)
-        if 'statusCode' in dictionary:
-            self.status_code = dictionary['statusCode']
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/card_fraud_results.py

@@ -1,110 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-
-
-class CardFraudResults(DataObject):
-    """
-    | Fraud results contained in the CardFraudResults object
-    """
-
-    __avs_result = None
-    __cvv_result = None
-    __fraud_service_result = None
-
-    @property
-    def avs_result(self) -> str:
-        """
-        |  Result of the Address Verification Service checks. Possible values are: 
-        |  * A - Address (Street) matches, Zip does not 
-        |  * B - Street address match for international transactions—Postal code not verified due to incompatible formats 
-        |  * C - Street address and postal code not verified for international transaction due to incompatible formats 
-        |  * D - Street address and postal code match for international transaction, cardholder name is incorrect 
-        |  * E - AVS error 
-        |  * F - Address does match and five digit ZIP code does match (UK only) 
-        |  * G - Address information is unavailable; international transaction; non-AVS participant 
-        |  * H - Billing address and postal code match, cardholder name is incorrect (Amex) 
-        |  * I - Address information not verified for international transaction 
-        |  * K - Cardholder name matches (Amex) 
-        |  * L - Cardholder name and postal code match (Amex) 
-        |  * M - Cardholder name, street address, and postal code match for international transaction 
-        |  * N - No Match on Address (Street) or Zip 
-        |  * O - Cardholder name and address match (Amex) 
-        |  * P - Postal codes match for international transaction—Street address not verified due to incompatible formats 
-        |  * Q - Billing address matches, cardholder is incorrect (Amex) 
-        |  * R - Retry, System unavailable or Timed out 
-        |  * S - Service not supported by issuer 
-        |  * U - Address information is unavailable 
-        |  * W - 9 digit Zip matches, Address (Street) does not 
-        |  * X - Exact AVS Match 
-        |  * Y - Address (Street) and 5 digit Zip match 
-        |  * Z - 5 digit Zip matches, Address (Street) does not 
-        |  * 0 - No service available
-
-        Type: str
-        """
-        return self.__avs_result
-
-    @avs_result.setter
-    def avs_result(self, value: str):
-        self.__avs_result = value
-
-    @property
-    def cvv_result(self) -> str:
-        """
-        |  Result of the Card Verification Value checks. Possible values are: 
-        |  * M - CVV check performed and valid value 
-        |  * N - CVV checked and no match 
-        |  * P - CVV check not performed, not requested 
-        |  * S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card 
-        |  * U - Issuer not certified for CVV2 
-        |  * Y - Server provider did not respond 
-        |  * 0 - No service available
-
-        Type: str
-        """
-        return self.__cvv_result
-
-    @cvv_result.setter
-    def cvv_result(self, value: str):
-        self.__cvv_result = value
-
-    @property
-    def fraud_service_result(self) -> str:
-        """
-        | Resulting advice of the fraud prevention checks. Possible values are:
-        | * accepted - Based on the checks performed the transaction can be accepted
-        | * challenged - Based on the checks performed the transaction should be manually reviewed
-        | * denied - Based on the checks performed the transaction should be rejected
-        | * no-advice - No fraud check was requested/performed
-        | * error - The fraud check resulted an error. Note that the fraud check was thus not performed.
-
-        Type: str
-        """
-        return self.__fraud_service_result
-
-    @fraud_service_result.setter
-    def fraud_service_result(self, value: str):
-        self.__fraud_service_result = value
-
-    def to_dictionary(self):
-        dictionary = super(CardFraudResults, self).to_dictionary()
-        if self.avs_result is not None:
-            dictionary['avsResult'] = self.avs_result
-        if self.cvv_result is not None:
-            dictionary['cvvResult'] = self.cvv_result
-        if self.fraud_service_result is not None:
-            dictionary['fraudServiceResult'] = self.fraud_service_result
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(CardFraudResults, self).from_dictionary(dictionary)
-        if 'avsResult' in dictionary:
-            self.avs_result = dictionary['avsResult']
-        if 'cvvResult' in dictionary:
-            self.cvv_result = dictionary['cvvResult']
-        if 'fraudServiceResult' in dictionary:
-            self.fraud_service_result = dictionary['fraudServiceResult']
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/create_payout_request.py

@@ -1,108 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.amount_of_money import AmountOfMoney
-from onlinepayments.sdk.domain.card_payout_method_specific_input import CardPayoutMethodSpecificInput
-from onlinepayments.sdk.domain.omnichannel_payout_specific_input import OmnichannelPayoutSpecificInput
-from onlinepayments.sdk.domain.payment_references import PaymentReferences
-
-
-class CreatePayoutRequest(DataObject):
-    """
-    | Object containing the payout details
-    """
-
-    __amount_of_money = None
-    __card_payout_method_specific_input = None
-    __omnichannel_payout_specific_input = None
-    __references = None
-
-    @property
-    def amount_of_money(self) -> AmountOfMoney:
-        """
-        | Object containing amount and ISO currency code attributes
-
-        Type: :class:`onlinepayments.sdk.domain.amount_of_money.AmountOfMoney`
-        """
-        return self.__amount_of_money
-
-    @amount_of_money.setter
-    def amount_of_money(self, value: AmountOfMoney):
-        self.__amount_of_money = value
-
-    @property
-    def card_payout_method_specific_input(self) -> CardPayoutMethodSpecificInput:
-        """
-        | Object containing the payout details for a card
-
-        Type: :class:`onlinepayments.sdk.domain.card_payout_method_specific_input.CardPayoutMethodSpecificInput`
-        """
-        return self.__card_payout_method_specific_input
-
-    @card_payout_method_specific_input.setter
-    def card_payout_method_specific_input(self, value: CardPayoutMethodSpecificInput):
-        self.__card_payout_method_specific_input = value
-
-    @property
-    def omnichannel_payout_specific_input(self) -> OmnichannelPayoutSpecificInput:
-        """
-        | Object containing the additional payout details for a Omnichannel merchants
-
-        Type: :class:`onlinepayments.sdk.domain.omnichannel_payout_specific_input.OmnichannelPayoutSpecificInput`
-        """
-        return self.__omnichannel_payout_specific_input
-
-    @omnichannel_payout_specific_input.setter
-    def omnichannel_payout_specific_input(self, value: OmnichannelPayoutSpecificInput):
-        self.__omnichannel_payout_specific_input = value
-
-    @property
-    def references(self) -> PaymentReferences:
-        """
-        | Object that holds all reference properties that are linked to this transaction
-
-        Type: :class:`onlinepayments.sdk.domain.payment_references.PaymentReferences`
-        """
-        return self.__references
-
-    @references.setter
-    def references(self, value: PaymentReferences):
-        self.__references = value
-
-    def to_dictionary(self):
-        dictionary = super(CreatePayoutRequest, self).to_dictionary()
-        if self.amount_of_money is not None:
-            dictionary['amountOfMoney'] = self.amount_of_money.to_dictionary()
-        if self.card_payout_method_specific_input is not None:
-            dictionary['cardPayoutMethodSpecificInput'] = self.card_payout_method_specific_input.to_dictionary()
-        if self.omnichannel_payout_specific_input is not None:
-            dictionary['omnichannelPayoutSpecificInput'] = self.omnichannel_payout_specific_input.to_dictionary()
-        if self.references is not None:
-            dictionary['references'] = self.references.to_dictionary()
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(CreatePayoutRequest, self).from_dictionary(dictionary)
-        if 'amountOfMoney' in dictionary:
-            if not isinstance(dictionary['amountOfMoney'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['amountOfMoney']))
-            value = AmountOfMoney()
-            self.amount_of_money = value.from_dictionary(dictionary['amountOfMoney'])
-        if 'cardPayoutMethodSpecificInput' in dictionary:
-            if not isinstance(dictionary['cardPayoutMethodSpecificInput'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['cardPayoutMethodSpecificInput']))
-            value = CardPayoutMethodSpecificInput()
-            self.card_payout_method_specific_input = value.from_dictionary(dictionary['cardPayoutMethodSpecificInput'])
-        if 'omnichannelPayoutSpecificInput' in dictionary:
-            if not isinstance(dictionary['omnichannelPayoutSpecificInput'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['omnichannelPayoutSpecificInput']))
-            value = OmnichannelPayoutSpecificInput()
-            self.omnichannel_payout_specific_input = value.from_dictionary(dictionary['omnichannelPayoutSpecificInput'])
-        if 'references' in dictionary:
-            if not isinstance(dictionary['references'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['references']))
-            value = PaymentReferences()
-            self.references = value.from_dictionary(dictionary['references'])
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/customer_account_authentication.py

@@ -1,64 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-
-
-class CustomerAccountAuthentication(DataObject):
-    """
-    | Object containing data on the authentication used by the customer to access their account
-    """
-
-    __method = None
-    __utc_timestamp = None
-
-    @property
-    def method(self) -> str:
-        """
-        | Authentication used by the customer on your website
-        | Possible values are
-        |  * guest = no login occurred, customer is logged in as guest
-        |  * merchant-credentials = the customer logged in using credentials that are specific to you
-        |  * federated-id = the customer logged in using a federated ID
-        |  * issuer-credentials = the customer logged in using credentials from the card issuer (of the card used in this transaction)
-        |  * third-party-authentication = the customer logged in using third-party authentication
-        |  * fido-authentication = the customer logged in using a FIDO authenticator
-        |  * cico-b-connect-token-for-cb = the customer logged in using Check-in/Check-out b.connect for CB
-
-        Type: str
-        """
-        return self.__method
-
-    @method.setter
-    def method(self, value: str):
-        self.__method = value
-
-    @property
-    def utc_timestamp(self) -> str:
-        """
-        | Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
-
-        Type: str
-        """
-        return self.__utc_timestamp
-
-    @utc_timestamp.setter
-    def utc_timestamp(self, value: str):
-        self.__utc_timestamp = value
-
-    def to_dictionary(self):
-        dictionary = super(CustomerAccountAuthentication, self).to_dictionary()
-        if self.method is not None:
-            dictionary['method'] = self.method
-        if self.utc_timestamp is not None:
-            dictionary['utcTimestamp'] = self.utc_timestamp
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(CustomerAccountAuthentication, self).from_dictionary(dictionary)
-        if 'method' in dictionary:
-            self.method = dictionary['method']
-        if 'utcTimestamp' in dictionary:
-            self.utc_timestamp = dictionary['utcTimestamp']
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/discount.py

@@ -1,44 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-
-
-class Discount(DataObject):
-    """
-    | Object to apply a discount to the total basket by adding a discount line.
-    """
-
-    __amount = None
-
-    @property
-    def amount(self) -> int:
-        """
-        | Amount in the smallest currency unit, i.e.:
-        
-        | * EUR is a 2-decimals currency, the value 1234 will result in EUR 12.34
-        
-        | * KWD is a 3-decimals currency, the value 1234 will result in KWD 1.234
-        
-        | * JPY is a zero-decimal currency, the value 1234 will result in JPY 1234
-
-        Type: int
-        """
-        return self.__amount
-
-    @amount.setter
-    def amount(self, value: int):
-        self.__amount = value
-
-    def to_dictionary(self):
-        dictionary = super(Discount, self).to_dictionary()
-        if self.amount is not None:
-            dictionary['amount'] = self.amount
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(Discount, self).from_dictionary(dictionary)
-        if 'amount' in dictionary:
-            self.amount = dictionary['amount']
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/fraud_results.py

@@ -1,43 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-
-
-class FraudResults(DataObject):
-    """
-    | Object containing the results of the fraud screening
-    """
-
-    __fraud_service_result = None
-
-    @property
-    def fraud_service_result(self) -> str:
-        """
-        | Resulting advice of the fraud prevention checks. Possible values are:
-        | * accepted - Based on the checks performed the transaction can be accepted
-        | * challenged - Based on the checks performed the transaction should be manually reviewed
-        | * denied - Based on the checks performed the transaction should be rejected
-        | * no-advice - No fraud check was requested/performed
-        | * error - The fraud check resulted an error. Note that the fraud check was thus not performed.
-
-        Type: str
-        """
-        return self.__fraud_service_result
-
-    @fraud_service_result.setter
-    def fraud_service_result(self, value: str):
-        self.__fraud_service_result = value
-
-    def to_dictionary(self):
-        dictionary = super(FraudResults, self).to_dictionary()
-        if self.fraud_service_result is not None:
-            dictionary['fraudServiceResult'] = self.fraud_service_result
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(FraudResults, self).from_dictionary(dictionary)
-        if 'fraudServiceResult' in dictionary:
-            self.fraud_service_result = dictionary['fraudServiceResult']
-        return self

onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/domain/merchant_action.py

@@ -1,88 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# This class was auto-generated.
-#
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.redirect_data import RedirectData
-from onlinepayments.sdk.domain.show_form_data import ShowFormData
-
-
-class MerchantAction(DataObject):
-    """
-    | Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment
-    """
-
-    __action_type = None
-    __redirect_data = None
-    __show_form_data = None
-
-    @property
-    def action_type(self) -> str:
-        """
-        | Action merchants needs to take in the online payment process. Possible values are: 
-        |  * REDIRECT - The customer needs to be redirected using the details found in redirectData 
-        |  * SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. 
-        |  * SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData 
-        |  * SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData 
-        |  * MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object. 
-        |  * CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
-
-        Type: str
-        """
-        return self.__action_type
-
-    @action_type.setter
-    def action_type(self, value: str):
-        self.__action_type = value
-
-    @property
-    def redirect_data(self) -> RedirectData:
-        """
-        | Object containing all data needed to redirect the customer
-
-        Type: :class:`onlinepayments.sdk.domain.redirect_data.RedirectData`
-        """
-        return self.__redirect_data
-
-    @redirect_data.setter
-    def redirect_data(self, value: RedirectData):
-        self.__redirect_data = value
-
-    @property
-    def show_form_data(self) -> ShowFormData:
-        """
-        | Object returned for the SHOW_FORM actionType.
-
-        Type: :class:`onlinepayments.sdk.domain.show_form_data.ShowFormData`
-        """
-        return self.__show_form_data
-
-    @show_form_data.setter
-    def show_form_data(self, value: ShowFormData):
-        self.__show_form_data = value
-
-    def to_dictionary(self):
-        dictionary = super(MerchantAction, self).to_dictionary()
-        if self.action_type is not None:
-            dictionary['actionType'] = self.action_type
-        if self.redirect_data is not None:
-            dictionary['redirectData'] = self.redirect_data.to_dictionary()
-        if self.show_form_data is not None:
-            dictionary['showFormData'] = self.show_form_data.to_dictionary()
-        return dictionary
-
-    def from_dictionary(self, dictionary):
-        super(MerchantAction, self).from_dictionary(dictionary)
-        if 'actionType' in dictionary:
-            self.action_type = dictionary['actionType']
-        if 'redirectData' in dictionary:
-            if not isinstance(dictionary['redirectData'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['redirectData']))
-            value = RedirectData()
-            self.redirect_data = value.from_dictionary(dictionary['redirectData'])
-        if 'showFormData' in dictionary:
-            if not isinstance(dictionary['showFormData'], dict):
-                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['showFormData']))
-            value = ShowFormData()
-            self.show_form_data = value.from_dictionary(dictionary['showFormData'])
-        return self