onlinepayments-sdk-python3 7.4.1__py3-none-any.whl

onlinepayments/sdk/merchant/hostedtokenization/hosted_tokenization_client.py

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .i_hosted_tokenization_client import IHostedTokenizationClient
+
+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.create_hosted_tokenization_request import CreateHostedTokenizationRequest
+from onlinepayments.sdk.domain.create_hosted_tokenization_response import CreateHostedTokenizationResponse
+from onlinepayments.sdk.domain.error_response import ErrorResponse
+from onlinepayments.sdk.domain.get_hosted_tokenization_response import GetHostedTokenizationResponse
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class HostedTokenizationClient(ApiResource, IHostedTokenizationClient):
+    """
+    HostedTokenization 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(HostedTokenizationClient, self).__init__(parent=parent, path_context=path_context)
+
+    def create_hosted_tokenization(self, body: CreateHostedTokenizationRequest, context: Optional[CallContext] = None) -> CreateHostedTokenizationResponse:
+        """
+        Resource /v2/{merchantId}/hostedtokenizations - Create hosted tokenization session
+
+        :param body:     :class:`onlinepayments.sdk.domain.create_hosted_tokenization_request.CreateHostedTokenizationRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.create_hosted_tokenization_response.CreateHostedTokenizationResponse`
+        :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}/hostedtokenizations", None)
+
+
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    CreateHostedTokenizationResponse,
+                    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_hosted_tokenization(self, hosted_tokenization_id: str, context: Optional[CallContext] = None) -> GetHostedTokenizationResponse:
+        """
+        Resource /v2/{merchantId}/hostedtokenizations/{hostedTokenizationId} - Get hosted tokenization session
+
+        :param hosted_tokenization_id:  str
+        :param context:                 :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_hosted_tokenization_response.GetHostedTokenizationResponse`
+        :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 = {
+            "hostedTokenizationId": hosted_tokenization_id,
+        }
+        uri = self._instantiate_uri("/v2/{merchantId}/hostedtokenizations/{hostedTokenizationId}", path_context)
+
+
+        try:
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    None,
+                    GetHostedTokenizationResponse,
+                    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/merchant/hostedtokenization/i_hosted_tokenization_client.py

@@ -0,0 +1,55 @@
+# -*- 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.create_hosted_tokenization_request import CreateHostedTokenizationRequest
+from onlinepayments.sdk.domain.create_hosted_tokenization_response import CreateHostedTokenizationResponse
+from onlinepayments.sdk.domain.get_hosted_tokenization_response import GetHostedTokenizationResponse
+
+
+class IHostedTokenizationClient(ABC):
+    """
+    HostedTokenization client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def create_hosted_tokenization(self, body: CreateHostedTokenizationRequest, context: Optional[CallContext] = None) -> CreateHostedTokenizationResponse:
+        """
+        Resource /v2/{merchantId}/hostedtokenizations - Create hosted tokenization session
+
+        :param body:     :class:`onlinepayments.sdk.domain.create_hosted_tokenization_request.CreateHostedTokenizationRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.create_hosted_tokenization_response.CreateHostedTokenizationResponse`
+        :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_hosted_tokenization(self, hosted_tokenization_id: str, context: Optional[CallContext] = None) -> GetHostedTokenizationResponse:
+        """
+        Resource /v2/{merchantId}/hostedtokenizations/{hostedTokenizationId} - Get hosted tokenization session
+
+        :param hosted_tokenization_id:  str
+        :param context:                 :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_hosted_tokenization_response.GetHostedTokenizationResponse`
+        :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/merchant/i_merchant_client.py

@@ -0,0 +1,202 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from onlinepayments.sdk.merchant.captures.i_captures_client import ICapturesClient
+from onlinepayments.sdk.merchant.cofseries.i_cof_series_client import ICofSeriesClient
+from onlinepayments.sdk.merchant.complete.i_complete_client import ICompleteClient
+from onlinepayments.sdk.merchant.hostedcheckout.i_hosted_checkout_client import IHostedCheckoutClient
+from onlinepayments.sdk.merchant.hostedfields.i_hosted_fields_client import IHostedFieldsClient
+from onlinepayments.sdk.merchant.hostedtokenization.i_hosted_tokenization_client import IHostedTokenizationClient
+from onlinepayments.sdk.merchant.mandates.i_mandates_client import IMandatesClient
+from onlinepayments.sdk.merchant.merchantbatch.i_merchant_batch_client import IMerchantBatchClient
+from onlinepayments.sdk.merchant.paymentlinks.i_payment_links_client import IPaymentLinksClient
+from onlinepayments.sdk.merchant.payments.i_payments_client import IPaymentsClient
+from onlinepayments.sdk.merchant.payouts.i_payouts_client import IPayoutsClient
+from onlinepayments.sdk.merchant.privacypolicy.i_privacy_policy_client import IPrivacyPolicyClient
+from onlinepayments.sdk.merchant.productgroups.i_product_groups_client import IProductGroupsClient
+from onlinepayments.sdk.merchant.products.i_products_client import IProductsClient
+from onlinepayments.sdk.merchant.refunds.i_refunds_client import IRefundsClient
+from onlinepayments.sdk.merchant.services.i_services_client import IServicesClient
+from onlinepayments.sdk.merchant.sessions.i_sessions_client import ISessionsClient
+from onlinepayments.sdk.merchant.subsequent.i_subsequent_client import ISubsequentClient
+from onlinepayments.sdk.merchant.tokenization.i_tokenization_client import ITokenizationClient
+from onlinepayments.sdk.merchant.tokens.i_tokens_client import ITokensClient
+from onlinepayments.sdk.merchant.webhooks.i_webhooks_client import IWebhooksClient
+
+
+class IMerchantClient(ABC):
+    """
+    Merchant client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def hosted_checkout(self) -> IHostedCheckoutClient:
+        """
+        Resource /v2/{merchantId}/hostedcheckouts
+
+        :return: :class:`onlinepayments.sdk.merchant.hostedcheckout.i_hosted_checkout_client.IHostedCheckoutClient`
+        """
+
+    @abstractmethod
+    def hosted_tokenization(self) -> IHostedTokenizationClient:
+        """
+        Resource /v2/{merchantId}/hostedtokenizations
+
+        :return: :class:`onlinepayments.sdk.merchant.hostedtokenization.i_hosted_tokenization_client.IHostedTokenizationClient`
+        """
+
+    @abstractmethod
+    def hosted_fields(self) -> IHostedFieldsClient:
+        """
+        Resource /v2/{merchantId}/hostedfields/sessions
+
+        :return: :class:`onlinepayments.sdk.merchant.hostedfields.i_hosted_fields_client.IHostedFieldsClient`
+        """
+
+    @abstractmethod
+    def payments(self) -> IPaymentsClient:
+        """
+        Resource /v2/{merchantId}/payments
+
+        :return: :class:`onlinepayments.sdk.merchant.payments.i_payments_client.IPaymentsClient`
+        """
+
+    @abstractmethod
+    def captures(self) -> ICapturesClient:
+        """
+        Resource /v2/{merchantId}/payments/{paymentId}/captures
+
+        :return: :class:`onlinepayments.sdk.merchant.captures.i_captures_client.ICapturesClient`
+        """
+
+    @abstractmethod
+    def refunds(self) -> IRefundsClient:
+        """
+        Resource /v2/{merchantId}/payments/{paymentId}/refunds
+
+        :return: :class:`onlinepayments.sdk.merchant.refunds.i_refunds_client.IRefundsClient`
+        """
+
+    @abstractmethod
+    def complete(self) -> ICompleteClient:
+        """
+        Resource /v2/{merchantId}/payments/{paymentId}/complete
+
+        :return: :class:`onlinepayments.sdk.merchant.complete.i_complete_client.ICompleteClient`
+        """
+
+    @abstractmethod
+    def subsequent(self) -> ISubsequentClient:
+        """
+        Resource /v2/{merchantId}/payments/{paymentId}/subsequent
+
+        :return: :class:`onlinepayments.sdk.merchant.subsequent.i_subsequent_client.ISubsequentClient`
+        """
+
+    @abstractmethod
+    def product_groups(self) -> IProductGroupsClient:
+        """
+        Resource /v2/{merchantId}/productgroups
+
+        :return: :class:`onlinepayments.sdk.merchant.productgroups.i_product_groups_client.IProductGroupsClient`
+        """
+
+    @abstractmethod
+    def products(self) -> IProductsClient:
+        """
+        Resource /v2/{merchantId}/products
+
+        :return: :class:`onlinepayments.sdk.merchant.products.i_products_client.IProductsClient`
+        """
+
+    @abstractmethod
+    def services(self) -> IServicesClient:
+        """
+        Resource /v2/{merchantId}/services/testconnection
+
+        :return: :class:`onlinepayments.sdk.merchant.services.i_services_client.IServicesClient`
+        """
+
+    @abstractmethod
+    def webhooks(self) -> IWebhooksClient:
+        """
+        Resource /v2/{merchantId}/webhooks/validateCredentials
+
+        :return: :class:`onlinepayments.sdk.merchant.webhooks.i_webhooks_client.IWebhooksClient`
+        """
+
+    @abstractmethod
+    def sessions(self) -> ISessionsClient:
+        """
+        Resource /v2/{merchantId}/sessions
+
+        :return: :class:`onlinepayments.sdk.merchant.sessions.i_sessions_client.ISessionsClient`
+        """
+
+    @abstractmethod
+    def tokens(self) -> ITokensClient:
+        """
+        Resource /v2/{merchantId}/tokens
+
+        :return: :class:`onlinepayments.sdk.merchant.tokens.i_tokens_client.ITokensClient`
+        """
+
+    @abstractmethod
+    def cof_series(self) -> ICofSeriesClient:
+        """
+        Resource /v2/{merchantId}/tokens/importCofSeries
+
+        :return: :class:`onlinepayments.sdk.merchant.cofseries.i_cof_series_client.ICofSeriesClient`
+        """
+
+    @abstractmethod
+    def tokenization(self) -> ITokenizationClient:
+        """
+        Resource /v2/{merchantId}/detokenize/csr
+
+        :return: :class:`onlinepayments.sdk.merchant.tokenization.i_tokenization_client.ITokenizationClient`
+        """
+
+    @abstractmethod
+    def payouts(self) -> IPayoutsClient:
+        """
+        Resource /v2/{merchantId}/payouts
+
+        :return: :class:`onlinepayments.sdk.merchant.payouts.i_payouts_client.IPayoutsClient`
+        """
+
+    @abstractmethod
+    def mandates(self) -> IMandatesClient:
+        """
+        Resource /v2/{merchantId}/mandates
+
+        :return: :class:`onlinepayments.sdk.merchant.mandates.i_mandates_client.IMandatesClient`
+        """
+
+    @abstractmethod
+    def privacy_policy(self) -> IPrivacyPolicyClient:
+        """
+        Resource /v2/{merchantId}/services/privacypolicy
+
+        :return: :class:`onlinepayments.sdk.merchant.privacypolicy.i_privacy_policy_client.IPrivacyPolicyClient`
+        """
+
+    @abstractmethod
+    def payment_links(self) -> IPaymentLinksClient:
+        """
+        Resource /v2/{merchantId}/paymentlinks
+
+        :return: :class:`onlinepayments.sdk.merchant.paymentlinks.i_payment_links_client.IPaymentLinksClient`
+        """
+
+    @abstractmethod
+    def merchant_batch(self) -> IMerchantBatchClient:
+        """
+        Resource /v2/{merchantId}/merchant-batches
+
+        :return: :class:`onlinepayments.sdk.merchant.merchantbatch.i_merchant_batch_client.IMerchantBatchClient`
+        """

onlinepayments/sdk/merchant/mandates/__init__.py

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

onlinepayments/sdk/merchant/mandates/i_mandates_client.py

@@ -0,0 +1,114 @@
+# -*- 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.create_mandate_request import CreateMandateRequest
+from onlinepayments.sdk.domain.create_mandate_response import CreateMandateResponse
+from onlinepayments.sdk.domain.get_mandate_response import GetMandateResponse
+from onlinepayments.sdk.domain.revoke_mandate_request import RevokeMandateRequest
+
+
+class IMandatesClient(ABC):
+    """
+    Mandates client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def create_mandate(self, body: CreateMandateRequest, context: Optional[CallContext] = None) -> CreateMandateResponse:
+        """
+        Resource /v2/{merchantId}/mandates - Create mandate
+
+        :param body:     :class:`onlinepayments.sdk.domain.create_mandate_request.CreateMandateRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.create_mandate_response.CreateMandateResponse`
+        :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_mandate(self, unique_mandate_reference: str, context: Optional[CallContext] = None) -> GetMandateResponse:
+        """
+        Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
+
+        :param unique_mandate_reference:  str
+        :param context:                   :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_mandate_response.GetMandateResponse`
+        :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 block_mandate(self, unique_mandate_reference: str, context: Optional[CallContext] = None) -> GetMandateResponse:
+        """
+        Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/block - Block mandate
+
+        :param unique_mandate_reference:  str
+        :param context:                   :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_mandate_response.GetMandateResponse`
+        :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 unblock_mandate(self, unique_mandate_reference: str, context: Optional[CallContext] = None) -> GetMandateResponse:
+        """
+        Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/unblock - Unblock mandate
+
+        :param unique_mandate_reference:  str
+        :param context:                   :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_mandate_response.GetMandateResponse`
+        :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 revoke_mandate(self, unique_mandate_reference: str, body: RevokeMandateRequest, context: Optional[CallContext] = None) -> GetMandateResponse:
+        """
+        Resource /v2/{merchantId}/mandates/{uniqueMandateReference}/revoke - Revoke mandate
+
+        :param unique_mandate_reference:  str
+        :param body:                      :class:`onlinepayments.sdk.domain.revoke_mandate_request.RevokeMandateRequest`
+        :param context:                   :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_mandate_response.GetMandateResponse`
+        :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
+        """