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

onlinepayments/sdk/merchant/productgroups/product_groups_client.py

@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .get_product_group_params import GetProductGroupParams
+from .get_product_groups_params import GetProductGroupsParams
+from .i_product_groups_client import IProductGroupsClient
+
+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_payment_product_groups_response import GetPaymentProductGroupsResponse
+from onlinepayments.sdk.domain.payment_product_group import PaymentProductGroup
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class ProductGroupsClient(ApiResource, IProductGroupsClient):
+    """
+    ProductGroups 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(ProductGroupsClient, self).__init__(parent=parent, path_context=path_context)
+
+    def get_product_groups(self, query: GetProductGroupsParams, context: Optional[CallContext] = None) -> GetPaymentProductGroupsResponse:
+        """
+        Resource /v2/{merchantId}/productgroups - Get product groups
+
+        :param query:    :class:`onlinepayments.sdk.merchant.productgroups.get_product_groups_params.GetProductGroupsParams`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.get_payment_product_groups_response.GetPaymentProductGroupsResponse`
+        :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}/productgroups", None)
+
+
+        try:
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    query,
+                    GetPaymentProductGroupsResponse,
+                    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_product_group(self, payment_product_group_id: str, query: GetProductGroupParams, context: Optional[CallContext] = None) -> PaymentProductGroup:
+        """
+        Resource /v2/{merchantId}/productgroups/{paymentProductGroupId} - Get product group
+
+        :param payment_product_group_id:  str
+        :param query:                     :class:`onlinepayments.sdk.merchant.productgroups.get_product_group_params.GetProductGroupParams`
+        :param context:                   :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.payment_product_group.PaymentProductGroup`
+        :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 = {
+            "paymentProductGroupId": payment_product_group_id,
+        }
+        uri = self._instantiate_uri("/v2/{merchantId}/productgroups/{paymentProductGroupId}", path_context)
+
+
+        try:
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    query,
+                    PaymentProductGroup,
+                    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/products/__init__.py

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

onlinepayments/sdk/merchant/products/get_payment_product_networks_params.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+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: Optional[str] = None
+    __currency_code: Optional[str] = None
+    __amount: Optional[int] = None
+    __is_recurring: Optional[bool] = None
+
+    @property
+    def country_code(self) -> Optional[str]:
+        """
+        | ISO 3166-1 alpha-2 country code
+
+        Type: str
+        """
+        return self.__country_code
+
+    @country_code.setter
+    def country_code(self, value: Optional[str]) -> None:
+        self.__country_code = value
+
+    @property
+    def currency_code(self) -> Optional[str]:
+        """
+        | Three-letter ISO currency code representing the currency for the amount
+
+        Type: str
+        """
+        return self.__currency_code
+
+    @currency_code.setter
+    def currency_code(self, value: Optional[str]) -> None:
+        self.__currency_code = value
+
+    @property
+    def amount(self) -> Optional[int]:
+        """
+        | Amount in cents and always having 2 decimals
+
+        Type: int
+        """
+        return self.__amount
+
+    @amount.setter
+    def amount(self, value: Optional[int]) -> None:
+        self.__amount = value
+
+    @property
+    def is_recurring(self) -> Optional[bool]:
+        """
+        | This allows you to filter networks based on their support for recurring or not
+        
+        * true
+        * false
+
+        Type: bool
+        """
+        return self.__is_recurring
+
+    @is_recurring.setter
+    def is_recurring(self, value: Optional[bool]) -> None:
+        self.__is_recurring = value
+
+    def to_request_parameters(self) -> List[RequestParam]:
+        """
+        :return: list[RequestParam]
+        """
+        result = []
+        if self.country_code is not None:
+            result.append(RequestParam("countryCode", self.country_code))
+        if self.currency_code is not None:
+            result.append(RequestParam("currencyCode", self.currency_code))
+        if self.amount is not None:
+            result.append(RequestParam("amount", str(self.amount)))
+        if self.is_recurring is not None:
+            result.append(RequestParam("isRecurring", str(self.is_recurring)))
+        return result

onlinepayments/sdk/merchant/products/get_payment_product_params.py

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+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: 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) -> Optional[str]:
+        """
+        | ISO 3166-1 alpha-2 country code of the transaction
+
+        Type: str
+        """
+        return self.__country_code
+
+    @country_code.setter
+    def country_code(self, value: Optional[str]) -> None:
+        self.__country_code = value
+
+    @property
+    def currency_code(self) -> Optional[str]:
+        """
+        | Three-letter ISO currency code representing the currency for the amount
+
+        Type: str
+        """
+        return self.__currency_code
+
+    @currency_code.setter
+    def currency_code(self, value: Optional[str]) -> None:
+        self.__currency_code = value
+
+    @property
+    def locale(self) -> Optional[str]:
+        """
+        | Locale used in the GUI towards the consumer.
+
+        Type: str
+        """
+        return self.__locale
+
+    @locale.setter
+    def locale(self, value: Optional[str]) -> None:
+        self.__locale = value
+
+    @property
+    def amount(self) -> Optional[int]:
+        """
+        | Whole amount in cents (not containing any decimals)
+
+        Type: int
+        """
+        return self.__amount
+
+    @amount.setter
+    def amount(self, value: Optional[int]) -> None:
+        self.__amount = value
+
+    @property
+    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.
+
+        Type: bool
+        """
+        return self.__is_recurring
+
+    @is_recurring.setter
+    def is_recurring(self, value: Optional[bool]) -> None:
+        self.__is_recurring = value
+
+    @property
+    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 third 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: Optional[List[str]]) -> None:
+        self.__hide = value
+
+    def add_hide(self, value: str) -> None:
+        """
+        :param value: str
+        """
+        if self.hide is None:
+            self.hide = []
+        self.hide.append(value)
+
+    def to_request_parameters(self) -> List[RequestParam]:
+        """
+        :return: list[RequestParam]
+        """
+        result = []
+        if self.country_code is not None:
+            result.append(RequestParam("countryCode", self.country_code))
+        if self.currency_code is not None:
+            result.append(RequestParam("currencyCode", self.currency_code))
+        if self.locale is not None:
+            result.append(RequestParam("locale", self.locale))
+        if self.amount is not None:
+            result.append(RequestParam("amount", str(self.amount)))
+        if self.is_recurring is not None:
+            result.append(RequestParam("isRecurring", str(self.is_recurring)))
+        if self.hide is not None:
+            for hide_element in self.hide:
+                if hide_element is not None:
+                    result.append(RequestParam("hide", hide_element))
+        return result

onlinepayments/sdk/merchant/products/get_payment_products_params.py

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+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: 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) -> Optional[str]:
+        """
+        | ISO 3166-1 alpha-2 country code of the transaction
+
+        Type: str
+        """
+        return self.__country_code
+
+    @country_code.setter
+    def country_code(self, value: Optional[str]) -> None:
+        self.__country_code = value
+
+    @property
+    def currency_code(self) -> Optional[str]:
+        """
+        | Three-letter ISO currency code representing the currency for the amount
+
+        Type: str
+        """
+        return self.__currency_code
+
+    @currency_code.setter
+    def currency_code(self, value: Optional[str]) -> None:
+        self.__currency_code = value
+
+    @property
+    def locale(self) -> Optional[str]:
+        """
+        | Locale used in the GUI towards the consumer.
+
+        Type: str
+        """
+        return self.__locale
+
+    @locale.setter
+    def locale(self, value: Optional[str]) -> None:
+        self.__locale = value
+
+    @property
+    def amount(self) -> Optional[int]:
+        """
+        | Whole amount in cents (not containing any decimals)
+
+        Type: int
+        """
+        return self.__amount
+
+    @amount.setter
+    def amount(self, value: Optional[int]) -> None:
+        self.__amount = value
+
+    @property
+    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.
+
+        Type: bool
+        """
+        return self.__is_recurring
+
+    @is_recurring.setter
+    def is_recurring(self, value: Optional[bool]) -> None:
+        self.__is_recurring = value
+
+    @property
+    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 third 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: Optional[List[str]]) -> None:
+        self.__hide = value
+
+    def add_hide(self, value: str) -> None:
+        """
+        :param value: str
+        """
+        if self.hide is None:
+            self.hide = []
+        self.hide.append(value)
+
+    def to_request_parameters(self) -> List[RequestParam]:
+        """
+        :return: list[RequestParam]
+        """
+        result = []
+        if self.country_code is not None:
+            result.append(RequestParam("countryCode", self.country_code))
+        if self.currency_code is not None:
+            result.append(RequestParam("currencyCode", self.currency_code))
+        if self.locale is not None:
+            result.append(RequestParam("locale", self.locale))
+        if self.amount is not None:
+            result.append(RequestParam("amount", str(self.amount)))
+        if self.is_recurring is not None:
+            result.append(RequestParam("isRecurring", str(self.is_recurring)))
+        if self.hide is not None:
+            for hide_element in self.hide:
+                if hide_element is not None:
+                    result.append(RequestParam("hide", hide_element))
+        return result

onlinepayments/sdk/merchant/products/get_product_directory_params.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+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: Optional[str] = None
+    __currency_code: Optional[str] = None
+
+    @property
+    def country_code(self) -> Optional[str]:
+        """
+        | ISO 3166-1 alpha-2 country code
+
+        Type: str
+        """
+        return self.__country_code
+
+    @country_code.setter
+    def country_code(self, value: Optional[str]) -> None:
+        self.__country_code = value
+
+    @property
+    def currency_code(self) -> Optional[str]:
+        """
+        | Three-letter ISO currency code representing the currency of the transaction
+
+        Type: str
+        """
+        return self.__currency_code
+
+    @currency_code.setter
+    def currency_code(self, value: Optional[str]) -> None:
+        self.__currency_code = value
+
+    def to_request_parameters(self) -> List[RequestParam]:
+        """
+        :return: list[RequestParam]
+        """
+        result = []
+        if self.country_code is not None:
+            result.append(RequestParam("countryCode", self.country_code))
+        if self.currency_code is not None:
+            result.append(RequestParam("currencyCode", self.currency_code))
+        return result

onlinepayments/sdk/merchant/products/i_products_client.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+#
+# 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
+
+
+class IProductsClient(ABC):
+    """
+    Products client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    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`
+        :return: :class:`onlinepayments.sdk.domain.get_payment_products_response.GetPaymentProductsResponse`
+        :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_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`
+        :return: :class:`onlinepayments.sdk.domain.payment_product.PaymentProduct`
+        :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_payment_product_networks(self, payment_product_id: int, query: GetPaymentProductNetworksParams, context: Optional[CallContext] = None) -> PaymentProductNetworksResponse:
+        """
+        Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
+
+        :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 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_product_directory(self, payment_product_id: int, query: GetProductDirectoryParams, context: Optional[CallContext] = None) -> ProductDirectory:
+        """
+        Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
+
+        :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 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
+        """