onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/payouts/i_payouts_client.py

@@ -1,52 +1,55 @@
+# -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
 from abc import ABC, abstractmethod
+from typing import Optional
 
 from onlinepayments.sdk.call_context import CallContext
 from onlinepayments.sdk.domain.create_payout_request import CreatePayoutRequest
 from onlinepayments.sdk.domain.payout_response import PayoutResponse
 
+
 class IPayoutsClient(ABC):
     """
     Payouts client interface. Thread-safe.
     """
 
     @abstractmethod
-    def create_payout(self, body: CreatePayoutRequest, context: CallContext = None) -> PayoutResponse:
+    def get_payout(self, payout_id: str, context: Optional[CallContext] = None) -> PayoutResponse:
         """
-        Resource /v2/{merchantId}/payouts - Create payout
-
+        Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
 
-        :param body: :class:`onlinepayments.sdk.domain.create_payout_request.CreatePayoutRequest`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
+        :param payout_id:  str
+        :param context:    :class:`onlinepayments.sdk.call_context.CallContext`
         :return: :class:`onlinepayments.sdk.domain.payout_response.PayoutResponse`
-        :raise: DeclinedPayoutException if the payment platform declined / rejected the payout. The payout result will be available from the exception.
-        :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_payout(self, payout_id: str, context: CallContext = None) -> PayoutResponse:
+    def create_payout(self, body: CreatePayoutRequest, context: Optional[CallContext] = None) -> PayoutResponse:
         """
-        Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
-
+        Resource /v2/{merchantId}/payouts - Create payout
 
-        :param payout_id: str
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
+        :param body:     :class:`onlinepayments.sdk.domain.create_payout_request.CreatePayoutRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
         :return: :class:`onlinepayments.sdk.domain.payout_response.PayoutResponse`
-        :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 DeclinedPayoutException: if the payment platform declined / rejected the payout. The payout result will be available from the exception.
+        :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
         """

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/payouts/payouts_client.py

@@ -1,14 +1,19 @@
+# -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
+from typing import Mapping, Optional
+
+from .i_payouts_client import IPayoutsClient
+
 from onlinepayments.sdk.api_resource import ApiResource
 from onlinepayments.sdk.call_context import CallContext
-from onlinepayments.sdk.response_exception import ResponseException
+from onlinepayments.sdk.communication.response_exception import ResponseException
 from onlinepayments.sdk.domain.create_payout_request import CreatePayoutRequest
 from onlinepayments.sdk.domain.error_response import ErrorResponse
 from onlinepayments.sdk.domain.payout_error_response import PayoutErrorResponse
 from onlinepayments.sdk.domain.payout_response import PayoutResponse
-from onlinepayments.sdk.merchant.payouts.i_payouts_client import IPayoutsClient
+from onlinepayments.sdk.exception_factory import create_exception
 
 
 class PayoutsClient(ApiResource, IPayoutsClient):
@@ -16,76 +21,76 @@ class PayoutsClient(ApiResource, IPayoutsClient):
     Payouts client. Thread-safe.
     """
 
-    def __init__(self, parent, path_context):
+    def __init__(self, parent: ApiResource, path_context: Optional[Mapping[str, str]]):
         """
         :param parent:       :class:`onlinepayments.sdk.api_resource.ApiResource`
-        :param path_context: dict[str, str]
+        :param path_context: Mapping[str, str]
         """
-        super(PayoutsClient, self).__init__(parent, path_context)
+        super(PayoutsClient, self).__init__(parent=parent, path_context=path_context)
 
-    def create_payout(self, body: CreatePayoutRequest, context: CallContext = None) -> PayoutResponse:
+    def get_payout(self, payout_id: str, context: Optional[CallContext] = None) -> PayoutResponse:
         """
-        Resource /v2/{merchantId}/payouts - Create payout
-
+        Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
 
-        :param body: :class:`onlinepayments.sdk.domain.create_payout_request.CreatePayoutRequest`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
+        :param payout_id:  str
+        :param context:    :class:`onlinepayments.sdk.call_context.CallContext`
         :return: :class:`onlinepayments.sdk.domain.payout_response.PayoutResponse`
-        :raise: DeclinedPayoutException if the payment platform declined / rejected the payout. The payout result will be available from the exception.
-        :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
         """
-        uri = self._instantiate_uri("/v2/{merchantId}/payouts", None)
+        path_context = {
+            "payoutId": payout_id,
+        }
+        uri = self._instantiate_uri("/v2/{merchantId}/payouts/{payoutId}", path_context)
         try:
-            return self._communicator.post(
-                uri,
-                self._client_headers,
-                None,
-                body,
-                PayoutResponse,
-                context)
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    None,
+                    PayoutResponse,
+                    context)
 
         except ResponseException as e:
-            error_type = PayoutErrorResponse
+            error_type = ErrorResponse
             error_object = self._communicator.marshaller.unmarshal(e.body, error_type)
-            raise self._create_exception(e.status_code, e.body, error_object, context)
+            raise create_exception(e.status_code, e.body, error_object, context)
 
-    def get_payout(self, payout_id: str, context: CallContext = None) -> PayoutResponse:
+    def create_payout(self, body: CreatePayoutRequest, context: Optional[CallContext] = None) -> PayoutResponse:
         """
-        Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
-
+        Resource /v2/{merchantId}/payouts - Create payout
 
-        :param payout_id: str
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
+        :param body:     :class:`onlinepayments.sdk.domain.create_payout_request.CreatePayoutRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
         :return: :class:`onlinepayments.sdk.domain.payout_response.PayoutResponse`
-        :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 DeclinedPayoutException: if the payment platform declined / rejected the payout. The payout result will be available from the exception.
+        :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
         """
-        path_context = {
-            "payoutId": payout_id,
-        }
-        uri = self._instantiate_uri("/v2/{merchantId}/payouts/{payoutId}", path_context)
+        uri = self._instantiate_uri("/v2/{merchantId}/payouts", None)
         try:
-            return self._communicator.get(
-                uri,
-                self._client_headers,
-                None,
-                PayoutResponse,
-                context)
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    PayoutResponse,
+                    context)
 
         except ResponseException as e:
-            error_type = ErrorResponse
+            error_type = PayoutErrorResponse
             error_object = self._communicator.marshaller.unmarshal(e.body, error_type)
-            raise self._create_exception(e.status_code, e.body, error_object, context)
+            raise create_exception(e.status_code, e.body, error_object, context)

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/privacypolicy/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#

{onlinepayments-sdk-python3-4.23.0/onlinepayments/sdk/merchant/services → onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/privacypolicy}/get_privacy_policy_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 GetPrivacyPolicyParams(ParamRequest):
     """
     Query parameters for Get Privacy Policy
-
     """
 
-    __locale = None
-    __payment_product_id = None
+    __locale: Optional[str] = None
+    __payment_product_id: Optional[int] = None
 
     @property
-    def locale(self):
+    def locale(self) -> Optional[str]:
         """
         | Locale in which the privacy policy will be returned.
 
@@ -25,11 +26,11 @@ class GetPrivacyPolicyParams(ParamRequest):
         return self.__locale
 
     @locale.setter
-    def locale(self, value):
+    def locale(self, value: Optional[str]) -> None:
         self.__locale = value
 
     @property
-    def payment_product_id(self):
+    def payment_product_id(self) -> Optional[int]:
         """
         | ID of the specific payment product for which you wish to retrieve the privacy policy. When none is provided you will receive a complete policy for all the payment methods available for the specified merchantId.
 
@@ -38,10 +39,10 @@ class GetPrivacyPolicyParams(ParamRequest):
         return self.__payment_product_id
 
     @payment_product_id.setter
-    def payment_product_id(self, value):
+    def payment_product_id(self, value: Optional[int]) -> None:
         self.__payment_product_id = value
 
-    def to_request_parameters(self):
+    def to_request_parameters(self) -> List[RequestParam]:
         """
         :return: list[RequestParam]
         """

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/privacypolicy/i_privacy_policy_client.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from .get_privacy_policy_params import GetPrivacyPolicyParams
+
+from onlinepayments.sdk.call_context import CallContext
+from onlinepayments.sdk.domain.get_privacy_policy_response import GetPrivacyPolicyResponse
+
+
+class IPrivacyPolicyClient(ABC):
+    """
+    PrivacyPolicy client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def get_privacy_policy(self, query: GetPrivacyPolicyParams, context: Optional[CallContext] = None) -> GetPrivacyPolicyResponse:
+        """
+        Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
+
+        :param query:    :class:`onlinepayments.sdk.merchant.privacypolicy.get_privacy_policy_params.GetPrivacyPolicyParams`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_privacy_policy_response.GetPrivacyPolicyResponse`
+        :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 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
+        """

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/privacypolicy/privacy_policy_client.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .get_privacy_policy_params import GetPrivacyPolicyParams
+from .i_privacy_policy_client import IPrivacyPolicyClient
+
+from onlinepayments.sdk.api_resource import ApiResource
+from onlinepayments.sdk.call_context import CallContext
+from onlinepayments.sdk.communication.response_exception import ResponseException
+from onlinepayments.sdk.domain.error_response import ErrorResponse
+from onlinepayments.sdk.domain.get_privacy_policy_response import GetPrivacyPolicyResponse
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class PrivacyPolicyClient(ApiResource, IPrivacyPolicyClient):
+    """
+    PrivacyPolicy client. Thread-safe.
+    """
+
+    def __init__(self, parent: ApiResource, path_context: Optional[Mapping[str, str]]):
+        """
+        :param parent:       :class:`onlinepayments.sdk.api_resource.ApiResource`
+        :param path_context: Mapping[str, str]
+        """
+        super(PrivacyPolicyClient, self).__init__(parent=parent, path_context=path_context)
+
+    def get_privacy_policy(self, query: GetPrivacyPolicyParams, context: Optional[CallContext] = None) -> GetPrivacyPolicyResponse:
+        """
+        Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
+
+        :param query:    :class:`onlinepayments.sdk.merchant.privacypolicy.get_privacy_policy_params.GetPrivacyPolicyParams`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_privacy_policy_response.GetPrivacyPolicyResponse`
+        :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 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
+        """
+        uri = self._instantiate_uri("/v2/{merchantId}/services/privacypolicy", None)
+        try:
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    query,
+                    GetPrivacyPolicyResponse,
+                    context)
+
+        except ResponseException as e:
+            error_type = ErrorResponse
+            error_object = self._communicator.marshaller.unmarshal(e.body, error_type)
+            raise create_exception(e.status_code, e.body, error_object, context)

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/productgroups/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/productgroups/get_product_group_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 GetProductGroupParams(ParamRequest):
     """
     Query parameters for Get product group
-
     """
 
-    __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 GetProductGroupParams(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 GetProductGroupParams(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]:
         """
         | Deprecated: This field has no effect.
 
@@ -55,11 +56,11 @@ class GetProductGroupParams(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 GetProductGroupParams(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 GetProductGroupParams(ParamRequest):
             self.hide = []
         self.hide.append(value)
 
-    def to_request_parameters(self):
+    def to_request_parameters(self) -> List[RequestParam]:
         """
         :return: list[RequestParam]
         """