connect-sdk-python3 4.0.0__zip → 4.1.0__zip

connect-sdk-python3-4.1.0/worldline/connect/sdk/v1/merchant/tokens/tokens_client.py

@@ -0,0 +1,213 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+from typing import Mapping, Optional
+
+from worldline.connect.sdk.api_resource import ApiResource
+from worldline.connect.sdk.call_context import CallContext
+from worldline.connect.sdk.communication.response_exception import ResponseException
+from worldline.connect.sdk.v1.domain.approve_token_request import ApproveTokenRequest
+from worldline.connect.sdk.v1.domain.create_token_request import CreateTokenRequest
+from worldline.connect.sdk.v1.domain.create_token_response import CreateTokenResponse
+from worldline.connect.sdk.v1.domain.error_response import ErrorResponse
+from worldline.connect.sdk.v1.domain.token_response import TokenResponse
+from worldline.connect.sdk.v1.domain.update_token_request import UpdateTokenRequest
+from worldline.connect.sdk.v1.merchant.tokens.delete_token_params import DeleteTokenParams
+from worldline.connect.sdk.v1.exception_factory import create_exception
+
+
+class TokensClient(ApiResource):
+    """
+    Tokens client. Thread-safe.
+    """
+
+    def __init__(self, parent: ApiResource, path_context: Optional[Mapping[str, str]]):
+        """
+        :param parent:       :class:`worldline.connect.sdk.api_resource.ApiResource`
+        :param path_context: Mapping[str, str]
+        """
+        super(TokensClient, self).__init__(parent=parent, path_context=path_context)
+
+    def create(self, body: CreateTokenRequest, context: Optional[CallContext] = None) -> CreateTokenResponse:
+        """
+        Resource /{merchantId}/tokens - Create token
+
+        See also https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/python/tokens/create.html
+
+        :param body:     :class:`worldline.connect.sdk.v1.domain.create_token_request.CreateTokenRequest`
+        :param context:  :class:`worldline.connect.sdk.call_context.CallContext`
+        :return: :class:`worldline.connect.sdk.v1.domain.create_token_response.CreateTokenResponse`
+        :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 Worldline Global Collect platform,
+                   the Worldline Global Collect 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 Worldline Global Collect platform returned any other error
+        """
+        uri = self._instantiate_uri("/v1/{merchantId}/tokens", None)
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    CreateTokenResponse,
+                    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(self, token_id: str, context: Optional[CallContext] = None) -> TokenResponse:
+        """
+        Resource /{merchantId}/tokens/{tokenId} - Get token
+
+        See also https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/python/tokens/get.html
+
+        :param token_id:  str
+        :param context:   :class:`worldline.connect.sdk.call_context.CallContext`
+        :return: :class:`worldline.connect.sdk.v1.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 PlatformException: if something went wrong at the Worldline Global Collect platform,
+                   the Worldline Global Collect 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 Worldline Global Collect platform returned any other error
+        """
+        path_context = {
+            "tokenId": token_id,
+        }
+        uri = self._instantiate_uri("/v1/{merchantId}/tokens/{tokenId}", path_context)
+        try:
+            return self._communicator.get(
+                    uri,
+                    self._client_headers,
+                    None,
+                    TokenResponse,
+                    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 update(self, token_id: str, body: UpdateTokenRequest, context: Optional[CallContext] = None) -> None:
+        """
+        Resource /{merchantId}/tokens/{tokenId} - Update token
+
+        See also https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/python/tokens/update.html
+
+        :param token_id:  str
+        :param body:      :class:`worldline.connect.sdk.v1.domain.update_token_request.UpdateTokenRequest`
+        :param context:   :class:`worldline.connect.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 PlatformException: if something went wrong at the Worldline Global Collect platform,
+                   the Worldline Global Collect 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 Worldline Global Collect platform returned any other error
+        """
+        path_context = {
+            "tokenId": token_id,
+        }
+        uri = self._instantiate_uri("/v1/{merchantId}/tokens/{tokenId}", path_context)
+        try:
+            return self._communicator.put(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    None,
+                    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 delete(self, token_id: str, query: DeleteTokenParams, context: Optional[CallContext] = None) -> None:
+        """
+        Resource /{merchantId}/tokens/{tokenId} - Delete token
+
+        See also https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/python/tokens/delete.html
+
+        :param token_id:  str
+        :param query:     :class:`worldline.connect.sdk.v1.merchant.tokens.delete_token_params.DeleteTokenParams`
+        :param context:   :class:`worldline.connect.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 PlatformException: if something went wrong at the Worldline Global Collect platform,
+                   the Worldline Global Collect 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 Worldline Global Collect platform returned any other error
+        """
+        path_context = {
+            "tokenId": token_id,
+        }
+        uri = self._instantiate_uri("/v1/{merchantId}/tokens/{tokenId}", path_context)
+        try:
+            return self._communicator.delete(
+                    uri,
+                    self._client_headers,
+                    query,
+                    None,
+                    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 approvesepadirectdebit(self, token_id: str, body: ApproveTokenRequest, context: Optional[CallContext] = None) -> None:
+        """
+        Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit - Approve SEPA DD mandate
+
+        See also https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/python/tokens/approvesepadirectdebit.html
+
+        :param token_id:  str
+        :param body:      :class:`worldline.connect.sdk.v1.domain.approve_token_request.ApproveTokenRequest`
+        :param context:   :class:`worldline.connect.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 PlatformException: if something went wrong at the Worldline Global Collect platform,
+                   the Worldline Global Collect 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 Worldline Global Collect platform returned any other error
+        """
+        path_context = {
+            "tokenId": token_id,
+        }
+        uri = self._instantiate_uri("/v1/{merchantId}/tokens/{tokenId}/approvesepadirectdebit", path_context)
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    None,
+                    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)

connect-sdk-python3-4.1.0/worldline/connect/sdk/v1/platform_exception.py

@@ -0,0 +1,18 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+from worldline.connect.sdk.v1.domain.api_error import APIError
+
+
+class PlatformException(ApiException):
+    """
+    Represents an error response from the Worldline Global Collect platform when something went wrong at the Worldline Global Collect platform or further downstream.
+    """
+
+    def __init__(self, status_code: int, response_body: str, error_id: Optional[str], errors: Optional[List[APIError]],
+                 message: str = "the Worldline Global Collect platform returned an error response"):
+        super(PlatformException, self).__init__(status_code, response_body, error_id, errors, message)

connect-sdk-python3-4.1.0/worldline/connect/sdk/v1/reference_exception.py

@@ -0,0 +1,18 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+from worldline.connect.sdk.v1.domain.api_error import APIError
+
+
+class ReferenceException(ApiException):
+    """
+    Represents an error response from the Worldline Global Collect platform when a non-existing or removed object is trying to be accessed.
+    """
+
+    def __init__(self, status_code: int, response_body: str, error_id: Optional[str], errors: Optional[List[APIError]],
+                 message: str = "the Worldline Global Collect platform returned a reference error response"):
+        super(ReferenceException, self).__init__(status_code, response_body, error_id, errors, message)

connect-sdk-python3-4.1.0/worldline/connect/sdk/v1/v1_client.py

@@ -0,0 +1,34 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+from typing import Mapping, Optional
+
+from worldline.connect.sdk.api_resource import ApiResource
+from worldline.connect.sdk.v1.merchant.merchant_client import MerchantClient
+
+
+class V1Client(ApiResource):
+    """
+    V1 client.
+
+    Thread-safe.
+    """
+    def __init__(self, parent: ApiResource, path_context: Optional[Mapping[str, str]]):
+        """
+        :param parent:       :class:`worldline.connect.sdk.api_resource.ApiResource`
+        :param path_context: Mapping[str, str]
+        """
+        super(V1Client, self).__init__(parent=parent, path_context=path_context)
+
+    def merchant(self, merchant_id: str) -> MerchantClient:
+        """
+        Resource /{merchantId}
+
+        :param merchant_id:  str
+        :return: :class:`worldline.connect.sdk.v1.merchant.merchant_client.MerchantClient`
+        """
+        sub_context = {
+            "merchantId": merchant_id,
+        }
+        return MerchantClient(self, sub_context)

connect-sdk-python3-4.1.0/worldline/connect/sdk/v1/validation_exception.py

@@ -0,0 +1,18 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+from worldline.connect.sdk.v1.domain.api_error import APIError
+
+
+class ValidationException(ApiException):
+    """
+    Represents an error response from the Worldline Global Collect platform when validation of requests failed.
+    """
+
+    def __init__(self, status_code: int, response_body: str, error_id: Optional[str], errors: Optional[List[APIError]],
+                 message: str = "the Worldline Global Collect platform returned an incorrect request error response"):
+        super(ValidationException, self).__init__(status_code, response_body, error_id, errors, message)

connect-sdk-python3-4.1.0/worldline/connect/sdk/v1/webhooks/webhooks_helper.py

@@ -0,0 +1,53 @@
+#
+# This class was auto-generated from the API references found at
+# https://apireference.connect.worldline-solutions.com/
+#
+from typing import Sequence, Union
+
+from worldline.connect.sdk.communication.request_header import RequestHeader
+from worldline.connect.sdk.json.marshaller import Marshaller
+from worldline.connect.sdk.v1.domain.webhooks_event import WebhooksEvent
+from worldline.connect.sdk.webhooks.api_version_mismatch_exception import ApiVersionMismatchException
+from worldline.connect.sdk.webhooks.secret_key_store import SecretKeyStore
+from worldline.connect.sdk.webhooks.signature_validator import SignatureValidator
+
+
+class WebhooksHelper(object):
+    """
+    Worldline Global Collect platform v1 webhooks helper.
+    """
+
+    def __init__(self, marshaller: Marshaller, secret_key_store: SecretKeyStore):
+        if marshaller is None:
+            raise ValueError("marshaller is requried")
+        self.__marshaller = marshaller
+        self.__signature_validator = SignatureValidator(secret_key_store)
+
+    def unmarshal(self, body: Union[str, bytes], request_headers: Sequence[RequestHeader]) -> WebhooksEvent:
+        """
+        Unmarshals the given body, while also validating it using the given request headers.
+
+        :raise SignatureValidationException: If the body could not be validated successfully.
+        :raise ApiVersionMismatchException: If the resulting event has an API
+         version that this version of the SDK does not support.
+        :return: The body unmarshalled as a WebhooksEvent.
+        """
+        self.__signature_validator.validate(body, request_headers)
+
+        event = self.__marshaller.unmarshal(body.decode('utf-8'), WebhooksEvent)
+        self.__validate_api_version(event)
+        return event
+
+    @staticmethod
+    def __validate_api_version(event: WebhooksEvent) -> None:
+        if "v1" != event.api_version:
+            raise ApiVersionMismatchException(event.api_version, "v1")
+
+    # Used for unit tests
+    @property
+    def marshaller(self) -> Marshaller:
+        return self.__marshaller
+
+    @property
+    def secret_key_store(self) -> SecretKeyStore:
+        return self.__signature_validator.secret_key_store

connect-sdk-python3-4.1.0/worldline/connect/sdk/webhooks/secret_key_store.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+
+class SecretKeyStore(ABC):
+    """
+    A store of secret keys. Implementations could store secret keys in a database, on disk, etc.
+    """
+
+    @abstractmethod
+    def get_secret_key(self, key_id: str) -> str:
+        """
+        :return: The secret key for the given key ID. Never None.
+        :raise SecretKeyNotAvailableException: If the secret key for the given key ID is not available.
+        """
+        raise NotImplementedError

connect-sdk-python3-4.1.0/worldline/connect/sdk/webhooks/signature_validator.py

@@ -0,0 +1,56 @@
+import hmac
+import hashlib
+from base64 import b64encode
+from typing import Union, Sequence
+
+from .secret_key_store import SecretKeyStore
+from .signature_validation_exception import SignatureValidationException
+
+from worldline.connect.sdk.communication.request_header import RequestHeader
+
+
+class SignatureValidator(object):
+    """
+    Validator for webhooks signatures.
+    """
+
+    def __init__(self, secret_key_store: SecretKeyStore):
+        if secret_key_store is None:
+            raise ValueError("secret_key_store is required")
+        self.__secret_key_store = secret_key_store
+
+    def validate(self, body: Union[str, bytes], request_headers: Sequence[RequestHeader]) -> None:
+        """
+        Validates the given body using the given request headers.
+
+        :raise SignatureValidationException: If the body could not be validated successfully.
+        """
+        self.__validate_body(body, request_headers)
+
+    def __validate_body(self, body: Union[str, bytes], request_headers: Sequence[RequestHeader]) -> None:
+        signature = self.__get_header_value(request_headers, "X-GCS-Signature")
+        key_id = self.__get_header_value(request_headers, "X-GCS-KeyId")
+        secret_key = self.__secret_key_store.get_secret_key(key_id)
+        unencoded_result = hmac.new(secret_key.encode("utf-8"), body, hashlib.sha256).digest()
+        expected_signature = b64encode(unencoded_result)
+        is_valid = hmac.compare_digest(signature.encode("utf-8"), expected_signature)
+        if is_valid is False:
+            raise SignatureValidationException("failed to validate signature: " + signature)
+
+    @staticmethod
+    def __get_header_value(request_headers: Sequence[RequestHeader], header_name: str) -> str:
+        value = None
+        for header in request_headers:
+            if header_name.lower() == header.name.lower():
+                if value is None:
+                    value = header.value
+                else:
+                    raise SignatureValidationException("encountered multiple occurrences of header '" + header_name + "'")
+        if value is None:
+            raise SignatureValidationException("could not find header '" + header_name + "'")
+        return value
+
+    # Used for unit tests
+    @property
+    def secret_key_store(self) -> SecretKeyStore:
+        return self.__secret_key_store

connect-sdk-python3-4.0.0/PKG-INFO

@@ -1,136 +0,0 @@
-Metadata-Version: 2.1
-Name: connect-sdk-python3
-Version: 4.0.0
-Summary: SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API
-Home-page: https://github.com/Worldline-Global-Collect/connect-sdk-python3
-Author: Worldline Global Collect
-Author-email: github.connect@worldline.com
-License: MIT
-Keywords: Worldline Global Collect Connect SDK
-Platform: python 3.7
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Office/Business :: Financial
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >= 3.7
-Description-Content-Type: text/x-rst
-License-File: LICENSE.txt
-
-Worldline Connect Python SDK
-============================
-
-Introduction
-------------
-
-The Python SDK helps you to communicate with the `Worldline Connect <https://docs.connect.worldline-solutions.com/>`__ Server API. Its primary features are:
-
--  convenient Python library for the API calls and responses
-
-   -  marshalls Python request objects to HTTP requests
-   -  unmarshalls HTTP responses to Python response objects or Python exceptions
-
--  handling of all the details concerning authentication
--  handling of required metadata
-
-Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.
-
-See the `Worldline Connect Developer Hub <https://docs.connect.worldline-solutions.com/documentation/sdk/server/python/>`__ for more information on how to use the SDK.
-
-Structure of this repository
-----------------------------
-
-This repository consists out of four main components:
-
-#. The source code of the SDK itself: ``/worldline/connect/sdk/``
-#. The source code of the SDK unit tests: ``/tests/unit/``
-#. The source code of the SDK integration tests: ``/tests/integration/``
-#. Usage examples: ``/examples/``
-
-Note that the source code of the unit tests and integration tests and the examples can only be found on GitHub.
-
-Requirements
-------------
-
-Python 3.7 or higher is required. In addition, the following packages are required:
-
--  `requests <https://requests.readthedocs.io/>`__ 2.25.0 or higher
--  `requests-toolbelt <https://toolbelt.readthedocs.io/>`__ 0.8.0 or higher
-
-These packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.
-
-Installation
-------------
-
-To install the SDK using pip, execute the following command:
-
-.. code:: bash
-
-   pip install connect-sdk-python3
-
-Alternatively, you can install the SDK from a source distribution file:
-
-#. Download the latest version of the Python SDK from GitHub. Choose the ``connect-sdk-python3-x.y.z.zip`` file from the `releases <https://github.com/Worldline-Global-Collect/connect-sdk-python3/releases>`__ page, where ``x.y.z`` is the version number.
-
-#. Execute the following command in the folder where the SDK was downloaded to:
-
-   .. code:: bash
-
-      pip install connect-sdk-python3-x.y.z.zip
-
-Uninstalling
-------------
-
-After the Python SDK has been installed, it can be uninstalled using the following command:
-
-.. code:: bash
-
-   pip uninstall connect-sdk-python3
-
-The required packages can be uninstalled in the same way.
-
-Running tests
--------------
-
-There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required.
-First, some environment variables need to be set:
-
--  ``connect.api.apiKeyId`` for the API key id to use. This can be retrieved from the Configuration Center.
--  ``connect.api.secretApiKey`` for the secret API key to use. This can be retrieved from the Configuration Center.
--  ``connect.api.merchantId`` for your merchant ID.
-
-In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the ``tests/resources/configuration.proxy.ini`` file.
-
-In order to run the unit and integration tests, the `mock <https://pypi.python.org/pypi/mock>`__ backport and `mockito <https://pypi.python.org/pypi/mockito>`__ are required. These can be installed using the following command:
-
-.. code:: bash
-
-   pip install mock mockito
-
-The following commands can now be executed from the ``tests`` directory to execute the tests:
-
--  Unit tests:
-
-   .. code:: bash
-
-      python run_unit_tests.py
-
--  Integration tests:
-
-   .. code:: bash
-
-      python run_integration_tests.py
-
--  Both unit and integration tests:
-
-   .. code:: bash
-
-      python run_all_tests.py