onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/refunds/i_refunds_client.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+#
+# 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.refunds_response import RefundsResponse
+
+
+class IRefundsClient(ABC):
+    """
+    Refunds client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def get_refunds(self, payment_id: str, context: Optional[CallContext] = None) -> RefundsResponse:
+        """
+        Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
+
+        :param payment_id:  str
+        :param context:     :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.refunds_response.RefundsResponse`
+        :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/refunds/refunds_client.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .i_refunds_client import IRefundsClient
+
+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.refunds_response import RefundsResponse
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class RefundsClient(ApiResource, IRefundsClient):
+    """
+    Refunds 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(RefundsClient, self).__init__(parent=parent, path_context=path_context)
+
+    def get_refunds(self, payment_id: str, context: Optional[CallContext] = None) -> RefundsResponse:
+        """
+        Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
+
+        :param payment_id:  str
+        :param context:     :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.refunds_response.RefundsResponse`
+        :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
+        """
+        path_context = {
+            "paymentId": payment_id,
+        }
+        uri = self._instantiate_uri("/v2/{merchantId}/payments/{paymentId}/refunds", path_context)
+        try:
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    None,
+                    RefundsResponse,
+                    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/services/__init__.py

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

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/services/i_services_client.py

@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+#
+# 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.calculate_surcharge_request import CalculateSurchargeRequest
+from onlinepayments.sdk.domain.calculate_surcharge_response import CalculateSurchargeResponse
+from onlinepayments.sdk.domain.currency_conversion_request import CurrencyConversionRequest
+from onlinepayments.sdk.domain.currency_conversion_response import CurrencyConversionResponse
+from onlinepayments.sdk.domain.get_iin_details_request import GetIINDetailsRequest
+from onlinepayments.sdk.domain.get_iin_details_response import GetIINDetailsResponse
+from onlinepayments.sdk.domain.test_connection import TestConnection
+
+
+class IServicesClient(ABC):
+    """
+    Services client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def test_connection(self, context: Optional[CallContext] = None) -> TestConnection:
+        """
+        Resource /v2/{merchantId}/services/testconnection - Test connection
+
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.test_connection.TestConnection`
+        :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
+        """
+
+    @abstractmethod
+    def get_iin_details(self, body: GetIINDetailsRequest, context: Optional[CallContext] = None) -> GetIINDetailsResponse:
+        """
+        Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
+
+        :param body:     :class:`onlinepayments.sdk.domain.get_iin_details_request.GetIINDetailsRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_iin_details_response.GetIINDetailsResponse`
+        :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
+        """
+
+    @abstractmethod
+    def get_dcc_rate_inquiry(self, body: CurrencyConversionRequest, context: Optional[CallContext] = None) -> CurrencyConversionResponse:
+        """
+        Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
+
+        :param body:     :class:`onlinepayments.sdk.domain.currency_conversion_request.CurrencyConversionRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.currency_conversion_response.CurrencyConversionResponse`
+        :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
+        """
+
+    @abstractmethod
+    def surcharge_calculation(self, body: CalculateSurchargeRequest, context: Optional[CallContext] = None) -> CalculateSurchargeResponse:
+        """
+        Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
+
+        :param body:     :class:`onlinepayments.sdk.domain.calculate_surcharge_request.CalculateSurchargeRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.calculate_surcharge_response.CalculateSurchargeResponse`
+        :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/services/services_client.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .i_services_client import IServicesClient
+
+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.calculate_surcharge_request import CalculateSurchargeRequest
+from onlinepayments.sdk.domain.calculate_surcharge_response import CalculateSurchargeResponse
+from onlinepayments.sdk.domain.currency_conversion_request import CurrencyConversionRequest
+from onlinepayments.sdk.domain.currency_conversion_response import CurrencyConversionResponse
+from onlinepayments.sdk.domain.error_response import ErrorResponse
+from onlinepayments.sdk.domain.get_iin_details_request import GetIINDetailsRequest
+from onlinepayments.sdk.domain.get_iin_details_response import GetIINDetailsResponse
+from onlinepayments.sdk.domain.test_connection import TestConnection
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class ServicesClient(ApiResource, IServicesClient):
+    """
+    Services 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(ServicesClient, self).__init__(parent=parent, path_context=path_context)
+
+    def test_connection(self, context: Optional[CallContext] = None) -> TestConnection:
+        """
+        Resource /v2/{merchantId}/services/testconnection - Test connection
+
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.test_connection.TestConnection`
+        :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/testconnection", None)
+        try:
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    None,
+                    TestConnection,
+                    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)
+
+    def get_iin_details(self, body: GetIINDetailsRequest, context: Optional[CallContext] = None) -> GetIINDetailsResponse:
+        """
+        Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
+
+        :param body:     :class:`onlinepayments.sdk.domain.get_iin_details_request.GetIINDetailsRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_iin_details_response.GetIINDetailsResponse`
+        :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/getIINdetails", None)
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    GetIINDetailsResponse,
+                    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)
+
+    def get_dcc_rate_inquiry(self, body: CurrencyConversionRequest, context: Optional[CallContext] = None) -> CurrencyConversionResponse:
+        """
+        Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
+
+        :param body:     :class:`onlinepayments.sdk.domain.currency_conversion_request.CurrencyConversionRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.currency_conversion_response.CurrencyConversionResponse`
+        :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/dccrate", None)
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    CurrencyConversionResponse,
+                    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)
+
+    def surcharge_calculation(self, body: CalculateSurchargeRequest, context: Optional[CallContext] = None) -> CalculateSurchargeResponse:
+        """
+        Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
+
+        :param body:     :class:`onlinepayments.sdk.domain.calculate_surcharge_request.CalculateSurchargeRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.calculate_surcharge_response.CalculateSurchargeResponse`
+        :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/surchargecalculation", None)
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    CalculateSurchargeResponse,
+                    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/sessions/__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/sessions/i_sessions_client.py

@@ -1,32 +1,35 @@
+# -*- 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.session_request import SessionRequest
 from onlinepayments.sdk.domain.session_response import SessionResponse
 
+
 class ISessionsClient(ABC):
     """
     Sessions client interface. Thread-safe.
     """
 
     @abstractmethod
-    def create_session(self, body: SessionRequest, context: CallContext = None) -> SessionResponse:
+    def create_session(self, body: SessionRequest, context: Optional[CallContext] = None) -> SessionResponse:
         """
         Resource /v2/{merchantId}/sessions - Create session
 
-
-        :param body: :class:`onlinepayments.sdk.domain.session_request.SessionRequest`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
+        :param body:     :class:`onlinepayments.sdk.domain.session_request.SessionRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
         :return: :class:`onlinepayments.sdk.domain.session_response.SessionResponse`
-        :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
         """

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/sessions/sessions_client.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .i_sessions_client import ISessionsClient
+
+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.session_request import SessionRequest
+from onlinepayments.sdk.domain.session_response import SessionResponse
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class SessionsClient(ApiResource, ISessionsClient):
+    """
+    Sessions 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(SessionsClient, self).__init__(parent=parent, path_context=path_context)
+
+    def create_session(self, body: SessionRequest, context: Optional[CallContext] = None) -> SessionResponse:
+        """
+        Resource /v2/{merchantId}/sessions - Create session
+
+        :param body:     :class:`onlinepayments.sdk.domain.session_request.SessionRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.session_response.SessionResponse`
+        :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}/sessions", None)
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    SessionResponse,
+                    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/tokens/__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/tokens/i_tokens_client.py

@@ -1,71 +1,74 @@
+# -*- 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_token_request import CreateTokenRequest
 from onlinepayments.sdk.domain.created_token_response import CreatedTokenResponse
 from onlinepayments.sdk.domain.token_response import TokenResponse
 
+
 class ITokensClient(ABC):
     """
     Tokens client interface. Thread-safe.
     """
 
     @abstractmethod
-    def create_token(self, body: CreateTokenRequest, context: CallContext = None) -> CreatedTokenResponse:
+    def get_token(self, token_id: str, context: Optional[CallContext] = None) -> TokenResponse:
         """
-        Resource /v2/{merchantId}/tokens - Create token
-
+        Resource /v2/{merchantId}/tokens/{tokenId} - Get token
 
-        :param body: :class:`onlinepayments.sdk.domain.create_token_request.CreateTokenRequest`
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
-        :return: :class:`onlinepayments.sdk.domain.created_token_response.CreatedTokenResponse`
-        :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 token_id:  str
+        :param context:   :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.token_response.TokenResponse`
+        :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_token(self, token_id: str, context: CallContext = None) -> TokenResponse:
+    def delete_token(self, token_id: str, context: Optional[CallContext] = None) -> None:
         """
-        Resource /v2/{merchantId}/tokens/{tokenId} - Get token
-
+        Resource /v2/{merchantId}/tokens/{tokenId} - Delete token
 
-        :param token_id: str
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
-        :return: :class:`onlinepayments.sdk.domain.token_response.TokenResponse`
-        :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 token_id:  str
+        :param context:   :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: None
+        :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 delete_token(self, token_id: str, context: CallContext = None) -> None:
+    def create_token(self, body: CreateTokenRequest, context: Optional[CallContext] = None) -> CreatedTokenResponse:
         """
-        Resource /v2/{merchantId}/tokens/{tokenId} - Delete token
-
+        Resource /v2/{merchantId}/tokens - Create token
 
-        :param token_id: str
-        :param context: :class:`onlinepayments.sdk.call_context.CallContext`
-        :return: None
-        :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 body:     :class:`onlinepayments.sdk.domain.create_token_request.CreateTokenRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.created_token_response.CreatedTokenResponse`
+        :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
         """