onlinepayments-sdk-python3 4.23.0__zip → 5.1.0__zip

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

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .data_object import DataObject
+
+
+class Feedbacks(DataObject):
+
+    __webhook_url: Optional[str] = None
+    __webhooks_urls: Optional[List[str]] = None
+
+    @property
+    def webhook_url(self) -> Optional[str]:
+        """
+        | The URL where the webhook will be dispatched for all status change events related to this payment.
+
+        Type: str
+
+        Deprecated; The URL where the webhook will be dispatched for all status change events related to this payment.
+        """
+        return self.__webhook_url
+
+    @webhook_url.setter
+    def webhook_url(self, value: Optional[str]) -> None:
+        self.__webhook_url = value
+
+    @property
+    def webhooks_urls(self) -> Optional[List[str]]:
+        """
+        | The list of the URLs where the webhook will be dispatched for all status change events related to this payment.
+
+        Type: list[str]
+        """
+        return self.__webhooks_urls
+
+    @webhooks_urls.setter
+    def webhooks_urls(self, value: Optional[List[str]]) -> None:
+        self.__webhooks_urls = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(Feedbacks, self).to_dictionary()
+        if self.webhook_url is not None:
+            dictionary['webhookUrl'] = self.webhook_url
+        if self.webhooks_urls is not None:
+            dictionary['webhooksUrls'] = []
+            for element in self.webhooks_urls:
+                if element is not None:
+                    dictionary['webhooksUrls'].append(element)
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'Feedbacks':
+        super(Feedbacks, self).from_dictionary(dictionary)
+        if 'webhookUrl' in dictionary:
+            self.webhook_url = dictionary['webhookUrl']
+        if 'webhooksUrls' in dictionary:
+            if not isinstance(dictionary['webhooksUrls'], list):
+                raise TypeError('value \'{}\' is not a list'.format(dictionary['webhooksUrls']))
+            self.webhooks_urls = []
+            for element in dictionary['webhooksUrls']:
+                self.webhooks_urls.append(element)
+        return self

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

@@ -1,27 +1,28 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
+from .data_object import DataObject
 
 
 class FixedListValidator(DataObject):
-    __allowed_values = None
+
+    __allowed_values: Optional[List[str]] = None
 
     @property
-    def allowed_values(self) -> List[str]:
+    def allowed_values(self) -> Optional[List[str]]:
         """
         Type: list[str]
         """
         return self.__allowed_values
 
     @allowed_values.setter
-    def allowed_values(self, value: List[str]):
+    def allowed_values(self, value: Optional[List[str]]) -> None:
         self.__allowed_values = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(FixedListValidator, self).to_dictionary()
         if self.allowed_values is not None:
             dictionary['allowedValues'] = []
@@ -30,7 +31,7 @@ class FixedListValidator(DataObject):
                     dictionary['allowedValues'].append(element)
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'FixedListValidator':
         super(FixedListValidator, self).from_dictionary(dictionary)
         if 'allowedValues' in dictionary:
             if not isinstance(dictionary['allowedValues'], list):

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

@@ -1,23 +1,20 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from typing import List
+from typing import List, Optional
 
-from onlinepayments.sdk.data_object import DataObject
+from .data_object import DataObject
 
 
 class FraudFields(DataObject):
-    """
-    | Object containing additional data that will be used to assess the risk of fraud
-    """
 
-    __black_list_data = None
-    __customer_ip_address = None
-    __product_categories = None
+    __black_list_data: Optional[str] = None
+    __customer_ip_address: Optional[str] = None
+    __product_categories: Optional[List[str]] = None
 
     @property
-    def black_list_data(self) -> str:
+    def black_list_data(self) -> Optional[str]:
         """
         | Additional black list input
 
@@ -26,26 +23,28 @@ class FraudFields(DataObject):
         return self.__black_list_data
 
     @black_list_data.setter
-    def black_list_data(self, value: str):
+    def black_list_data(self, value: Optional[str]) -> None:
         self.__black_list_data = value
 
     @property
-    def customer_ip_address(self) -> str:
+    def customer_ip_address(self) -> Optional[str]:
         """
         | Deprecated: Use order.customer.device.ipAddress instead.
-        
+        |
         | The IP Address of the customer that is making the payment
 
         Type: str
+
+        Deprecated; Use order.customer.device.ipAddress instead.  The IP Address of the customer that is making the payment
         """
         return self.__customer_ip_address
 
     @customer_ip_address.setter
-    def customer_ip_address(self, value: str):
+    def customer_ip_address(self, value: Optional[str]) -> None:
         self.__customer_ip_address = value
 
     @property
-    def product_categories(self) -> List[str]:
+    def product_categories(self) -> Optional[List[str]]:
         """
         | List of product categories that are being purchased.
 
@@ -54,10 +53,10 @@ class FraudFields(DataObject):
         return self.__product_categories
 
     @product_categories.setter
-    def product_categories(self, value: List[str]):
+    def product_categories(self, value: Optional[List[str]]) -> None:
         self.__product_categories = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(FraudFields, self).to_dictionary()
         if self.black_list_data is not None:
             dictionary['blackListData'] = self.black_list_data
@@ -70,7 +69,7 @@ class FraudFields(DataObject):
                     dictionary['productCategories'].append(element)
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'FraudFields':
         super(FraudFields, self).from_dictionary(dictionary)
         if 'blackListData' in dictionary:
             self.black_list_data = dictionary['blackListData']

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

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class FraudResults(DataObject):
+
+    __fraud_service_result: Optional[str] = None
+
+    @property
+    def fraud_service_result(self) -> Optional[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: Optional[str]) -> None:
+        self.__fraud_service_result = value
+
+    def to_dictionary(self) -> dict:
+        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: dict) -> 'FraudResults':
+        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_python3-5.1.0}/onlinepayments/sdk/domain/g_pay_three_d_secure.py

@@ -1,82 +1,84 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.redirection_data import RedirectionData
+from typing import Optional
+
+from .data_object import DataObject
+from .redirection_data import RedirectionData
 
 
 class GPayThreeDSecure(DataObject):
-    """
-    | Object containing specific data regarding 3-D Secure
-    """
 
-    __challenge_canvas_size = None
-    __challenge_indicator = None
-    __exemption_request = None
-    __redirection_data = None
-    __skip_authentication = None
+    __challenge_canvas_size: Optional[str] = None
+    __challenge_indicator: Optional[str] = None
+    __exemption_request: Optional[str] = None
+    __redirection_data: Optional[RedirectionData] = None
+    __skip_authentication: Optional[bool] = None
 
     @property
-    def challenge_canvas_size(self) -> str:
+    def challenge_canvas_size(self) -> Optional[str]:
         """
         | Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are
-        |    * 250x400 (default)
-        |    * 390x400
-        |    * 500x600
-        |    * 600x400
-        |    * full-screen
+        
+        * 250x400 (default)
+        * 390x400
+        * 500x600
+        * 600x400
+        * full-screen
 
         Type: str
         """
         return self.__challenge_canvas_size
 
     @challenge_canvas_size.setter
-    def challenge_canvas_size(self, value: str):
+    def challenge_canvas_size(self, value: Optional[str]) -> None:
         self.__challenge_canvas_size = value
 
     @property
-    def challenge_indicator(self) -> str:
+    def challenge_indicator(self) -> Optional[str]:
         """
         | Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values:
-        |  * no-preference - You have no preference whether or not to challenge the customer (default)
-        |  * no-challenge-requested - you prefer the cardholder not to be challenged
-        |  * challenge-requested - you prefer the customer to be challenged
-        |  * challenge-required - you require the customer to be challenged
-        |  * no-challenge-requested-risk-analysis-performed – letting the issuer know that you have already assessed the transaction with fraud prevention tool 
-        |  * no-challenge-requested-data-share-only – sharing data only with the DS
-        |  * no-challenge-requested-consumer-authentication-performed – authentication already happened at your side – when login in to your website
-        |  * no-challenge-requested-use-whitelist-exemption – cardholder has whitelisted you at with the issuer
-        |  * challenge-requested-whitelist-prompt-requested – cardholder is trying to whitelist you
-        |  * request-scoring-without-connecting-to-acs – sending information to CB DS for a fraud scoring
+        
+        * no-preference - You have no preference whether or not to challenge the customer (default)
+        * no-challenge-requested - you prefer the cardholder not to be challenged
+        * challenge-requested - you prefer the customer to be challenged
+        * challenge-required - you require the customer to be challenged
+        * no-challenge-requested-risk-analysis-performed – letting the issuer know that you have already assessed the transaction with fraud prevention tool
+        * no-challenge-requested-data-share-only – sharing data only with the DS
+        * no-challenge-requested-consumer-authentication-performed – authentication already happened at your side – when login in to your website
+        * no-challenge-requested-use-whitelist-exemption – cardholder has whitelisted you at with the issuer
+        * challenge-requested-whitelist-prompt-requested – cardholder is trying to whitelist you
+        * request-scoring-without-connecting-to-acs – sending information to CB DS for a fraud scoring
 
         Type: str
         """
         return self.__challenge_indicator
 
     @challenge_indicator.setter
-    def challenge_indicator(self, value: str):
+    def challenge_indicator(self, value: Optional[str]) -> None:
         self.__challenge_indicator = value
 
     @property
-    def exemption_request(self) -> str:
+    def exemption_request(self) -> Optional[str]:
         """
         | In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
-        | * none = No exemption requested
-        | * transaction-risk-analysis = Fraud analysis has been done already by your own fraud module and transaction scored as low risk
-        | * low-value = Bellow 30 euros
-        | * whitelist = The cardholder has whitelisted you with their issuer
+        
+        * none = No exemption requested
+        * transaction-risk-analysis = Fraud analysis has been done already by your own fraud module and transaction scored as low risk
+        * low-value = Bellow 30 euros
+        * whitelist = The cardholder has whitelisted you with their issuer
 
         Type: str
         """
         return self.__exemption_request
 
     @exemption_request.setter
-    def exemption_request(self, value: str):
+    def exemption_request(self, value: Optional[str]) -> None:
         self.__exemption_request = value
 
     @property
-    def redirection_data(self) -> RedirectionData:
+    def redirection_data(self) -> Optional[RedirectionData]:
         """
         | Object containing browser specific redirection related data
 
@@ -85,14 +87,14 @@ class GPayThreeDSecure(DataObject):
         return self.__redirection_data
 
     @redirection_data.setter
-    def redirection_data(self, value: RedirectionData):
+    def redirection_data(self, value: Optional[RedirectionData]) -> None:
         self.__redirection_data = value
 
     @property
-    def skip_authentication(self) -> bool:
+    def skip_authentication(self) -> Optional[bool]:
         """
-        | * true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to "recurring"
-        | * false = 3D Secure authentication will not be skipped for this transaction
+        * true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to "recurring"
+        * false = 3D Secure authentication will not be skipped for this transaction
         
         | Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction
 
@@ -101,10 +103,10 @@ class GPayThreeDSecure(DataObject):
         return self.__skip_authentication
 
     @skip_authentication.setter
-    def skip_authentication(self, value: bool):
+    def skip_authentication(self, value: Optional[bool]) -> None:
         self.__skip_authentication = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(GPayThreeDSecure, self).to_dictionary()
         if self.challenge_canvas_size is not None:
             dictionary['challengeCanvasSize'] = self.challenge_canvas_size
@@ -118,7 +120,7 @@ class GPayThreeDSecure(DataObject):
             dictionary['skipAuthentication'] = self.skip_authentication
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'GPayThreeDSecure':
         super(GPayThreeDSecure, self).from_dictionary(dictionary)
         if 'challengeCanvasSize' in dictionary:
             self.challenge_canvas_size = dictionary['challengeCanvasSize']

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

@@ -1,17 +1,20 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.created_payment_output import CreatedPaymentOutput
+from typing import Optional
+
+from .created_payment_output import CreatedPaymentOutput
+from .data_object import DataObject
 
 
 class GetHostedCheckoutResponse(DataObject):
-    __created_payment_output = None
-    __status = None
+
+    __created_payment_output: Optional[CreatedPaymentOutput] = None
+    __status: Optional[str] = None
 
     @property
-    def created_payment_output(self) -> CreatedPaymentOutput:
+    def created_payment_output(self) -> Optional[CreatedPaymentOutput]:
         """
         | This object will return the details of the payment after the payment is cancelled by the customer, rejected or authorized
 
@@ -20,26 +23,27 @@ class GetHostedCheckoutResponse(DataObject):
         return self.__created_payment_output
 
     @created_payment_output.setter
-    def created_payment_output(self, value: CreatedPaymentOutput):
+    def created_payment_output(self, value: Optional[CreatedPaymentOutput]) -> None:
         self.__created_payment_output = value
 
     @property
-    def status(self) -> str:
+    def status(self) -> Optional[str]:
         """
         | This is the status of the hosted checkout. Possible values are:
-        | * IN_PROGRESS - The checkout is still in progress and has not finished yet
-        | * PAYMENT_CREATED - A payment has been created
-        | * CANCELLED_BY_CONSUMER - The HostedCheckout session have been cancelled by the customer
+        
+        * IN_PROGRESS - The checkout is still in progress and has not finished yet
+        * PAYMENT_CREATED - A payment has been created
+        * CANCELLED_BY_CONSUMER - The HostedCheckout session have been cancelled by the customer
 
         Type: str
         """
         return self.__status
 
     @status.setter
-    def status(self, value: str):
+    def status(self, value: Optional[str]) -> None:
         self.__status = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(GetHostedCheckoutResponse, self).to_dictionary()
         if self.created_payment_output is not None:
             dictionary['createdPaymentOutput'] = self.created_payment_output.to_dictionary()
@@ -47,7 +51,7 @@ class GetHostedCheckoutResponse(DataObject):
             dictionary['status'] = self.status
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'GetHostedCheckoutResponse':
         super(GetHostedCheckoutResponse, self).from_dictionary(dictionary)
         if 'createdPaymentOutput' in dictionary:
             if not isinstance(dictionary['createdPaymentOutput'], dict):

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

@@ -1,43 +1,47 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.token_response import TokenResponse
+from typing import Optional
+
+from .data_object import DataObject
+from .token_response import TokenResponse
 
 
 class GetHostedTokenizationResponse(DataObject):
-    __token = None
-    __token_status = None
+
+    __token: Optional[TokenResponse] = None
+    __token_status: Optional[str] = None
 
     @property
-    def token(self) -> TokenResponse:
+    def token(self) -> Optional[TokenResponse]:
         """
         Type: :class:`onlinepayments.sdk.domain.token_response.TokenResponse`
         """
         return self.__token
 
     @token.setter
-    def token(self, value: TokenResponse):
+    def token(self, value: Optional[TokenResponse]) -> None:
         self.__token = value
 
     @property
-    def token_status(self) -> str:
+    def token_status(self) -> Optional[str]:
         """
         | This is the status of the token in the hosted tokenization session. Possible values are:
-        | * UNCHANGED - The token has not changed
-        | * CREATED - The token has been created
-        | * UPDATED - The token has been updated
+        
+        * UNCHANGED - The token has not changed
+        * CREATED - The token has been created
+        * UPDATED - The token has been updated
 
         Type: str
         """
         return self.__token_status
 
     @token_status.setter
-    def token_status(self, value: str):
+    def token_status(self, value: Optional[str]) -> None:
         self.__token_status = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(GetHostedTokenizationResponse, self).to_dictionary()
         if self.token is not None:
             dictionary['token'] = self.token.to_dictionary()
@@ -45,7 +49,7 @@ class GetHostedTokenizationResponse(DataObject):
             dictionary['tokenStatus'] = self.token_status
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'GetHostedTokenizationResponse':
         super(GetHostedTokenizationResponse, self).from_dictionary(dictionary)
         if 'token' in dictionary:
             if not isinstance(dictionary['token'], dict):

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

@@ -1,21 +1,20 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.data_object import DataObject
-from onlinepayments.sdk.domain.payment_context import PaymentContext
+from typing import Optional
+
+from .data_object import DataObject
+from .payment_context import PaymentContext
 
 
 class GetIINDetailsRequest(DataObject):
-    """
-    | Input for the retrieval of the IIN details request
-    """
 
-    __bin = None
-    __payment_context = None
+    __bin: Optional[str] = None
+    __payment_context: Optional[PaymentContext] = None
 
     @property
-    def bin(self) -> str:
+    def bin(self) -> Optional[str]:
         """
         | The first digits of the credit card number from left to right with a minimum of 6 digits. Providing additional digits (up to 19) can result in more co-brands being returned.
 
@@ -24,21 +23,21 @@ class GetIINDetailsRequest(DataObject):
         return self.__bin
 
     @bin.setter
-    def bin(self, value: str):
+    def bin(self, value: Optional[str]) -> None:
         self.__bin = value
 
     @property
-    def payment_context(self) -> PaymentContext:
+    def payment_context(self) -> Optional[PaymentContext]:
         """
         Type: :class:`onlinepayments.sdk.domain.payment_context.PaymentContext`
         """
         return self.__payment_context
 
     @payment_context.setter
-    def payment_context(self, value: PaymentContext):
+    def payment_context(self, value: Optional[PaymentContext]) -> None:
         self.__payment_context = value
 
-    def to_dictionary(self):
+    def to_dictionary(self) -> dict:
         dictionary = super(GetIINDetailsRequest, self).to_dictionary()
         if self.bin is not None:
             dictionary['bin'] = self.bin
@@ -46,7 +45,7 @@ class GetIINDetailsRequest(DataObject):
             dictionary['paymentContext'] = self.payment_context.to_dictionary()
         return dictionary
 
-    def from_dictionary(self, dictionary):
+    def from_dictionary(self, dictionary: dict) -> 'GetIINDetailsRequest':
         super(GetIINDetailsRequest, self).from_dictionary(dictionary)
         if 'bin' in dictionary:
             self.bin = dictionary['bin']