onlinepayments-sdk-python3 4.22.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/products/get_payment_product_networks_params.py

@@ -1,24 +1,25 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.param_request import ParamRequest
-from onlinepayments.sdk.request_param import RequestParam
+from typing import List, Optional
+
+from onlinepayments.sdk.communication.param_request import ParamRequest
+from onlinepayments.sdk.communication.request_param import RequestParam
 
 
 class GetPaymentProductNetworksParams(ParamRequest):
     """
     Query parameters for Get payment product networks
-
     """
 
-    __country_code = None
-    __currency_code = None
-    __amount = None
-    __is_recurring = None
+    __country_code: Optional[str] = None
+    __currency_code: Optional[str] = None
+    __amount: Optional[int] = None
+    __is_recurring: Optional[bool] = None
 
     @property
-    def country_code(self):
+    def country_code(self) -> Optional[str]:
         """
         | ISO 3166-1 alpha-2 country code
 
@@ -27,11 +28,11 @@ class GetPaymentProductNetworksParams(ParamRequest):
         return self.__country_code
 
     @country_code.setter
-    def country_code(self, value):
+    def country_code(self, value: Optional[str]) -> None:
         self.__country_code = value
 
     @property
-    def currency_code(self):
+    def currency_code(self) -> Optional[str]:
         """
         | Three-letter ISO currency code representing the currency for the amount
 
@@ -40,11 +41,11 @@ class GetPaymentProductNetworksParams(ParamRequest):
         return self.__currency_code
 
     @currency_code.setter
-    def currency_code(self, value):
+    def currency_code(self, value: Optional[str]) -> None:
         self.__currency_code = value
 
     @property
-    def amount(self):
+    def amount(self) -> Optional[int]:
         """
         | Amount in cents and always having 2 decimals
 
@@ -53,25 +54,26 @@ class GetPaymentProductNetworksParams(ParamRequest):
         return self.__amount
 
     @amount.setter
-    def amount(self, value):
+    def amount(self, value: Optional[int]) -> None:
         self.__amount = value
 
     @property
-    def is_recurring(self):
+    def is_recurring(self) -> Optional[bool]:
         """
         | This allows you to filter networks based on their support for recurring or not
-        | * true
-        | * false
+        
+        * true
+        * false
 
         Type: bool
         """
         return self.__is_recurring
 
     @is_recurring.setter
-    def is_recurring(self, value):
+    def is_recurring(self, value: Optional[bool]) -> None:
         self.__is_recurring = value
 
-    def to_request_parameters(self):
+    def to_request_parameters(self) -> List[RequestParam]:
         """
         :return: list[RequestParam]
         """

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/products/get_payment_product_params.py

@@ -1,26 +1,27 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.param_request import ParamRequest
-from onlinepayments.sdk.request_param import RequestParam
+from typing import List, Optional
+
+from onlinepayments.sdk.communication.param_request import ParamRequest
+from onlinepayments.sdk.communication.request_param import RequestParam
 
 
 class GetPaymentProductParams(ParamRequest):
     """
     Query parameters for Get payment product
-
     """
 
-    __country_code = None
-    __currency_code = None
-    __locale = None
-    __amount = None
-    __is_recurring = None
-    __hide = None
+    __country_code: Optional[str] = None
+    __currency_code: Optional[str] = None
+    __locale: Optional[str] = None
+    __amount: Optional[int] = None
+    __is_recurring: Optional[bool] = None
+    __hide: Optional[List[str]] = None
 
     @property
-    def country_code(self):
+    def country_code(self) -> Optional[str]:
         """
         | ISO 3166-1 alpha-2 country code of the transaction
 
@@ -29,11 +30,11 @@ class GetPaymentProductParams(ParamRequest):
         return self.__country_code
 
     @country_code.setter
-    def country_code(self, value):
+    def country_code(self, value: Optional[str]) -> None:
         self.__country_code = value
 
     @property
-    def currency_code(self):
+    def currency_code(self) -> Optional[str]:
         """
         | Three-letter ISO currency code representing the currency for the amount
 
@@ -42,11 +43,11 @@ class GetPaymentProductParams(ParamRequest):
         return self.__currency_code
 
     @currency_code.setter
-    def currency_code(self, value):
+    def currency_code(self, value: Optional[str]) -> None:
         self.__currency_code = value
 
     @property
-    def locale(self):
+    def locale(self) -> Optional[str]:
         """
         | Locale used in the GUI towards the consumer.
 
@@ -55,11 +56,11 @@ class GetPaymentProductParams(ParamRequest):
         return self.__locale
 
     @locale.setter
-    def locale(self, value):
+    def locale(self, value: Optional[str]) -> None:
         self.__locale = value
 
     @property
-    def amount(self):
+    def amount(self) -> Optional[int]:
         """
         | Whole amount in cents (not containing any decimals)
 
@@ -68,44 +69,46 @@ class GetPaymentProductParams(ParamRequest):
         return self.__amount
 
     @amount.setter
-    def amount(self, value):
+    def amount(self, value: Optional[int]) -> None:
         self.__amount = value
 
     @property
-    def is_recurring(self):
+    def is_recurring(self) -> Optional[bool]:
         """
         | This allows you to filter payment products based on their support for recurring payments.
-        | * true - return only payment products that support recurring payments,
-        | * false - return all payment products that support one-time transactions. Payment products that support recurring products are usually also part of this list.
+        
+        * true - return only payment products that support recurring payments,
+        * false - return all payment products that support one-time transactions. Payment products that support recurring products are usually also part of this list.
 
         Type: bool
         """
         return self.__is_recurring
 
     @is_recurring.setter
-    def is_recurring(self, value):
+    def is_recurring(self, value: Optional[bool]) -> None:
         self.__is_recurring = value
 
     @property
-    def hide(self):
+    def hide(self) -> Optional[List[str]]:
         """
         | Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
-        | * fields - Do not return any data on fields of the payment product
-        | * accountsOnFile - Do not return any accounts on file data
-        | * translations - Do not return any label texts associated with the payment products
-        | * productsWithoutFields - Do not return products that require any additional data to be captured
-        | * productsWithoutInstructions - Do not return products that show instructions
-        | * productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden
+        
+        * fields - Do not return any data on fields of the payment product
+        * accountsOnFile - Do not return any accounts on file data
+        * translations - Do not return any label texts associated with the payment products
+        * productsWithoutFields - Do not return products that require any additional data to be captured
+        * productsWithoutInstructions - Do not return products that show instructions
+        * productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden
 
         Type: list[str]
         """
         return self.__hide
 
     @hide.setter
-    def hide(self, value):
+    def hide(self, value: Optional[List[str]]) -> None:
         self.__hide = value
 
-    def add_hide(self, value):
+    def add_hide(self, value: str) -> None:
         """
         :param value: str
         """
@@ -113,7 +116,7 @@ class GetPaymentProductParams(ParamRequest):
             self.hide = []
         self.hide.append(value)
 
-    def to_request_parameters(self):
+    def to_request_parameters(self) -> List[RequestParam]:
         """
         :return: list[RequestParam]
         """

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/products/get_payment_products_params.py

@@ -1,26 +1,27 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.param_request import ParamRequest
-from onlinepayments.sdk.request_param import RequestParam
+from typing import List, Optional
+
+from onlinepayments.sdk.communication.param_request import ParamRequest
+from onlinepayments.sdk.communication.request_param import RequestParam
 
 
 class GetPaymentProductsParams(ParamRequest):
     """
     Query parameters for Get payment products
-
     """
 
-    __country_code = None
-    __currency_code = None
-    __locale = None
-    __amount = None
-    __is_recurring = None
-    __hide = None
+    __country_code: Optional[str] = None
+    __currency_code: Optional[str] = None
+    __locale: Optional[str] = None
+    __amount: Optional[int] = None
+    __is_recurring: Optional[bool] = None
+    __hide: Optional[List[str]] = None
 
     @property
-    def country_code(self):
+    def country_code(self) -> Optional[str]:
         """
         | ISO 3166-1 alpha-2 country code of the transaction
 
@@ -29,11 +30,11 @@ class GetPaymentProductsParams(ParamRequest):
         return self.__country_code
 
     @country_code.setter
-    def country_code(self, value):
+    def country_code(self, value: Optional[str]) -> None:
         self.__country_code = value
 
     @property
-    def currency_code(self):
+    def currency_code(self) -> Optional[str]:
         """
         | Three-letter ISO currency code representing the currency for the amount
 
@@ -42,11 +43,11 @@ class GetPaymentProductsParams(ParamRequest):
         return self.__currency_code
 
     @currency_code.setter
-    def currency_code(self, value):
+    def currency_code(self, value: Optional[str]) -> None:
         self.__currency_code = value
 
     @property
-    def locale(self):
+    def locale(self) -> Optional[str]:
         """
         | Locale used in the GUI towards the consumer.
 
@@ -55,11 +56,11 @@ class GetPaymentProductsParams(ParamRequest):
         return self.__locale
 
     @locale.setter
-    def locale(self, value):
+    def locale(self, value: Optional[str]) -> None:
         self.__locale = value
 
     @property
-    def amount(self):
+    def amount(self) -> Optional[int]:
         """
         | Whole amount in cents (not containing any decimals)
 
@@ -68,44 +69,46 @@ class GetPaymentProductsParams(ParamRequest):
         return self.__amount
 
     @amount.setter
-    def amount(self, value):
+    def amount(self, value: Optional[int]) -> None:
         self.__amount = value
 
     @property
-    def is_recurring(self):
+    def is_recurring(self) -> Optional[bool]:
         """
         | This allows you to filter payment products based on their support for recurring payments.
-        | * true - return only payment products that support recurring payments,
-        | * false - return all payment products that support one-time transactions. Payment products that support recurring products are usually also part of this list.
+        
+        * true - return only payment products that support recurring payments,
+        * false - return all payment products that support one-time transactions. Payment products that support recurring products are usually also part of this list.
 
         Type: bool
         """
         return self.__is_recurring
 
     @is_recurring.setter
-    def is_recurring(self, value):
+    def is_recurring(self, value: Optional[bool]) -> None:
         self.__is_recurring = value
 
     @property
-    def hide(self):
+    def hide(self) -> Optional[List[str]]:
         """
         | Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client. Possible options are:
-        | * fields - Do not return any data on fields of the payment product
-        | * accountsOnFile - Do not return any accounts on file data
-        | * translations - Do not return any label texts associated with the payment products
-        | * productsWithoutFields - Do not return products that require any additional data to be captured
-        | * productsWithoutInstructions - Do not return products that show instructions
-        | * productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden
+        
+        * fields - Do not return any data on fields of the payment product
+        * accountsOnFile - Do not return any accounts on file data
+        * translations - Do not return any label texts associated with the payment products
+        * productsWithoutFields - Do not return products that require any additional data to be captured
+        * productsWithoutInstructions - Do not return products that show instructions
+        * productsWithRedirects - Do not return products that require a redirect to a 3rd party. Note that products that involve potential redirects related to 3D Secure authentication are not hidden
 
         Type: list[str]
         """
         return self.__hide
 
     @hide.setter
-    def hide(self, value):
+    def hide(self, value: Optional[List[str]]) -> None:
         self.__hide = value
 
-    def add_hide(self, value):
+    def add_hide(self, value: str) -> None:
         """
         :param value: str
         """
@@ -113,7 +116,7 @@ class GetPaymentProductsParams(ParamRequest):
             self.hide = []
         self.hide.append(value)
 
-    def to_request_parameters(self):
+    def to_request_parameters(self) -> List[RequestParam]:
         """
         :return: list[RequestParam]
         """

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/products/get_product_directory_params.py

@@ -1,22 +1,23 @@
 # -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
-from onlinepayments.sdk.param_request import ParamRequest
-from onlinepayments.sdk.request_param import RequestParam
+from typing import List, Optional
+
+from onlinepayments.sdk.communication.param_request import ParamRequest
+from onlinepayments.sdk.communication.request_param import RequestParam
 
 
 class GetProductDirectoryParams(ParamRequest):
     """
     Query parameters for Get payment product directory
-
     """
 
-    __country_code = None
-    __currency_code = None
+    __country_code: Optional[str] = None
+    __currency_code: Optional[str] = None
 
     @property
-    def country_code(self):
+    def country_code(self) -> Optional[str]:
         """
         | ISO 3166-1 alpha-2 country code
 
@@ -25,11 +26,11 @@ class GetProductDirectoryParams(ParamRequest):
         return self.__country_code
 
     @country_code.setter
-    def country_code(self, value):
+    def country_code(self, value: Optional[str]) -> None:
         self.__country_code = value
 
     @property
-    def currency_code(self):
+    def currency_code(self) -> Optional[str]:
         """
         | Three-letter ISO currency code representing the currency of the transaction
 
@@ -38,10 +39,10 @@ class GetProductDirectoryParams(ParamRequest):
         return self.__currency_code
 
     @currency_code.setter
-    def currency_code(self, value):
+    def currency_code(self, value: Optional[str]) -> None:
         self.__currency_code = value
 
-    def to_request_parameters(self):
+    def to_request_parameters(self) -> List[RequestParam]:
         """
         :return: list[RequestParam]
         """

{onlinepayments-sdk-python3-4.22.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/products/i_products_client.py

@@ -1,17 +1,21 @@
+# -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
 from abc import ABC, abstractmethod
+from typing import Optional
+
+from .get_payment_product_networks_params import GetPaymentProductNetworksParams
+from .get_payment_product_params import GetPaymentProductParams
+from .get_payment_products_params import GetPaymentProductsParams
+from .get_product_directory_params import GetProductDirectoryParams
 
 from onlinepayments.sdk.call_context import CallContext
 from onlinepayments.sdk.domain.get_payment_products_response import GetPaymentProductsResponse
 from onlinepayments.sdk.domain.payment_product import PaymentProduct
 from onlinepayments.sdk.domain.payment_product_networks_response import PaymentProductNetworksResponse
 from onlinepayments.sdk.domain.product_directory import ProductDirectory
-from onlinepayments.sdk.merchant.products.get_payment_product_networks_params import GetPaymentProductNetworksParams
-from onlinepayments.sdk.merchant.products.get_payment_product_params import GetPaymentProductParams
-from onlinepayments.sdk.merchant.products.get_payment_products_params import GetPaymentProductsParams
-from onlinepayments.sdk.merchant.products.get_product_directory_params import GetProductDirectoryParams
+
 
 class IProductsClient(ABC):
     """
@@ -19,80 +23,80 @@ class IProductsClient(ABC):
     """
 
     @abstractmethod
-    def get_payment_products(self, query: GetPaymentProductsParams, context: CallContext = None) -> GetPaymentProductsResponse:
+    def get_payment_products(self, query: GetPaymentProductsParams, context: Optional[CallContext] = None) -> GetPaymentProductsResponse:
         """
         Resource /v2/{merchantId}/products - Get payment products
 
-
-        :param query: :class:`onlinepayments.sdk.merchant.products.get_payment_products_params.GetPaymentProductsParams`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
+        :param query:    :class:`onlinepayments.sdk.merchant.products.get_payment_products_params.GetPaymentProductsParams`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
         :return: :class:`onlinepayments.sdk.domain.get_payment_products_response.GetPaymentProductsResponse`
-        :raise: ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
-        :raise: AuthorizationException if the request was not allowed (HTTP status code 403)
-        :raise: ReferenceException if an object was attempted to be referenced that doesn't exist or has been removed,
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
                    or there was a conflict (HTTP status code 404, 409 or 410)
-        :raise: PaymentPlatformException if something went wrong at the payment platform,
+        :raise PlatformException: if something went wrong at the payment platform,
                    the payment platform was unable to process a message from a downstream partner/acquirer,
                    or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-        :raise: ApiException if the payment platform returned any other error
+        :raise ApiException: if the payment platform returned any other error
         """
 
     @abstractmethod
-    def get_payment_product(self, payment_product_id: int, query: GetPaymentProductParams, context: CallContext = None) -> PaymentProduct:
+    def get_payment_product(self, payment_product_id: int, query: GetPaymentProductParams, context: Optional[CallContext] = None) -> PaymentProduct:
         """
         Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product
 
-
-        :param payment_product_id: int
-        :param query: :class:`onlinepayments.sdk.merchant.products.get_payment_product_params.GetPaymentProductParams`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
+        :param payment_product_id:  int
+        :param query:               :class:`onlinepayments.sdk.merchant.products.get_payment_product_params.GetPaymentProductParams`
+        :param context:             :class:`onlinepayments.sdk.call_context.CallContext`
         :return: :class:`onlinepayments.sdk.domain.payment_product.PaymentProduct`
-        :raise: ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
-        :raise: AuthorizationException if the request was not allowed (HTTP status code 403)
-        :raise: ReferenceException if an object was attempted to be referenced that doesn't exist or has been removed,
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
                    or there was a conflict (HTTP status code 404, 409 or 410)
-        :raise: PaymentPlatformException if something went wrong at the payment platform,
+        :raise PlatformException: if something went wrong at the payment platform,
                    the payment platform was unable to process a message from a downstream partner/acquirer,
                    or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-        :raise: ApiException if the payment platform returned any other error
+        :raise ApiException: if the payment platform returned any other error
         """
 
     @abstractmethod
-    def get_product_directory(self, payment_product_id: int, query: GetProductDirectoryParams, context: CallContext = None) -> ProductDirectory:
+    def get_payment_product_networks(self, payment_product_id: int, query: GetPaymentProductNetworksParams, context: Optional[CallContext] = None) -> PaymentProductNetworksResponse:
         """
-        Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
-
+        Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
 
-        :param payment_product_id: int
-        :param query: :class:`onlinepayments.sdk.merchant.products.get_product_directory_params.GetProductDirectoryParams`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
-        :return: :class:`onlinepayments.sdk.domain.product_directory.ProductDirectory`
-        :raise: ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
-        :raise: AuthorizationException if the request was not allowed (HTTP status code 403)
-        :raise: ReferenceException if an object was attempted to be referenced that doesn't exist or has been removed,
+        :param payment_product_id:  int
+        :param query:               :class:`onlinepayments.sdk.merchant.products.get_payment_product_networks_params.GetPaymentProductNetworksParams`
+        :param context:             :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.payment_product_networks_response.PaymentProductNetworksResponse`
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
                    or there was a conflict (HTTP status code 404, 409 or 410)
-        :raise: PaymentPlatformException if something went wrong at the payment platform,
+        :raise PlatformException: if something went wrong at the payment platform,
                    the payment platform was unable to process a message from a downstream partner/acquirer,
                    or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-        :raise: ApiException if the payment platform returned any other error
+        :raise ApiException: if the payment platform returned any other error
         """
 
     @abstractmethod
-    def get_payment_product_networks(self, payment_product_id: int, query: GetPaymentProductNetworksParams, context: CallContext = None) -> PaymentProductNetworksResponse:
+    def get_product_directory(self, payment_product_id: int, query: GetProductDirectoryParams, context: Optional[CallContext] = None) -> ProductDirectory:
         """
-        Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
-
+        Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
 
-        :param payment_product_id: int
-        :param query: :class:`onlinepayments.sdk.merchant.products.get_payment_product_networks_params.GetPaymentProductNetworksParams`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
-        :return: :class:`onlinepayments.sdk.domain.payment_product_networks_response.PaymentProductNetworksResponse`
-        :raise: ValidationException if the request was not correct and couldn't be processed (HTTP status code 400)
-        :raise: AuthorizationException if the request was not allowed (HTTP status code 403)
-        :raise: ReferenceException if an object was attempted to be referenced that doesn't exist or has been removed,
+        :param payment_product_id:  int
+        :param query:               :class:`onlinepayments.sdk.merchant.products.get_product_directory_params.GetProductDirectoryParams`
+        :param context:             :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.product_directory.ProductDirectory`
+        :raise IdempotenceException: if an idempotent request caused a conflict (HTTP status code 409)
+        :raise ValidationException: if the request was not correct and couldn't be processed (HTTP status code 400)
+        :raise AuthorizationException: if the request was not allowed (HTTP status code 403)
+        :raise ReferenceException: if an object was attempted to be referenced that doesn't exist or has been removed,
                    or there was a conflict (HTTP status code 404, 409 or 410)
-        :raise: PaymentPlatformException if something went wrong at the payment platform,
+        :raise PlatformException: if something went wrong at the payment platform,
                    the payment platform was unable to process a message from a downstream partner/acquirer,
                    or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
-        :raise: ApiException if the payment platform returned any other error
+        :raise ApiException: if the payment platform returned any other error
         """