onlinepayments-sdk-python3 4.23.0__zip → 5.0.0__zip

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/merchant/tokens/tokens_client.py

@@ -1,14 +1,19 @@
+# -*- coding: utf-8 -*-
 #
-# This class was auto-generated.
+# This file was automatically generated.
 #
+from typing import Mapping, Optional
+
+from .i_tokens_client import ITokensClient
+
 from onlinepayments.sdk.api_resource import ApiResource
 from onlinepayments.sdk.call_context import CallContext
-from onlinepayments.sdk.response_exception import ResponseException
+from onlinepayments.sdk.communication.response_exception import ResponseException
 from onlinepayments.sdk.domain.create_token_request import CreateTokenRequest
 from onlinepayments.sdk.domain.created_token_response import CreatedTokenResponse
 from onlinepayments.sdk.domain.error_response import ErrorResponse
 from onlinepayments.sdk.domain.token_response import TokenResponse
-from onlinepayments.sdk.merchant.tokens.i_tokens_client import ITokensClient
+from onlinepayments.sdk.exception_factory import create_exception
 
 
 class TokensClient(ApiResource, ITokensClient):
@@ -16,109 +21,109 @@ class TokensClient(ApiResource, ITokensClient):
     Tokens client. Thread-safe.
     """
 
-    def __init__(self, parent, path_context):
+    def __init__(self, parent: ApiResource, path_context: Optional[Mapping[str, str]]):
         """
         :param parent:       :class:`onlinepayments.sdk.api_resource.ApiResource`
-        :param path_context: dict[str, str]
+        :param path_context: Mapping[str, str]
         """
-        super(TokensClient, self).__init__(parent, path_context)
+        super(TokensClient, self).__init__(parent=parent, path_context=path_context)
 
-    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
         """
-        uri = self._instantiate_uri("/v2/{merchantId}/tokens", None)
+        path_context = {
+            "tokenId": token_id,
+        }
+        uri = self._instantiate_uri("/v2/{merchantId}/tokens/{tokenId}", path_context)
         try:
-            return self._communicator.post(
-                uri,
-                self._client_headers,
-                None,
-                body,
-                CreatedTokenResponse,
-                context)
+            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 self._create_exception(e.status_code, e.body, error_object, context)
+            raise create_exception(e.status_code, e.body, error_object, context)
 
-    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
         """
         path_context = {
             "tokenId": token_id,
         }
         uri = self._instantiate_uri("/v2/{merchantId}/tokens/{tokenId}", path_context)
         try:
-            return self._communicator.get(
-                uri,
-                self._client_headers,
-                None,
-                TokenResponse,
-                context)
+            return self._communicator.delete(
+                    uri,
+                    self._client_headers,
+                    None,
+                    None,
+                    context)
 
         except ResponseException as e:
             error_type = ErrorResponse
             error_object = self._communicator.marshaller.unmarshal(e.body, error_type)
-            raise self._create_exception(e.status_code, e.body, error_object, context)
+            raise create_exception(e.status_code, e.body, error_object, context)
 
-    def 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
         """
-        path_context = {
-            "tokenId": token_id,
-        }
-        uri = self._instantiate_uri("/v2/{merchantId}/tokens/{tokenId}", path_context)
+        uri = self._instantiate_uri("/v2/{merchantId}/tokens", None)
         try:
-            return self._communicator.delete(
-                uri,
-                self._client_headers,
-                None,
-                None,
-                context)
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    CreatedTokenResponse,
+                    context)
 
         except ResponseException as e:
             error_type = ErrorResponse
             error_object = self._communicator.marshaller.unmarshal(e.body, error_type)
-            raise self._create_exception(e.status_code, e.body, error_object, context)
+            raise create_exception(e.status_code, e.body, error_object, context)

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

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

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/merchant/webhooks/i_webhooks_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.send_test_request import SendTestRequest
+from onlinepayments.sdk.domain.validate_credentials_request import ValidateCredentialsRequest
+from onlinepayments.sdk.domain.validate_credentials_response import ValidateCredentialsResponse
+
+
+class IWebhooksClient(ABC):
+    """
+    Webhooks client interface. Thread-safe.
+    """
+
+    @abstractmethod
+    def validate_webhook_credentials(self, body: ValidateCredentialsRequest, context: Optional[CallContext] = None) -> ValidateCredentialsResponse:
+        """
+        Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials
+
+        :param body:     :class:`onlinepayments.sdk.domain.validate_credentials_request.ValidateCredentialsRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.validate_credentials_response.ValidateCredentialsResponse`
+        :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 send_test_webhook(self, body: SendTestRequest, context: Optional[CallContext] = None) -> None:
+        """
+        Resource /v2/{merchantId}/webhooks/sendtest - Send test
+
+        :param body:     :class:`onlinepayments.sdk.domain.send_test_request.SendTestRequest`
+        :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 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/webhooks/webhooks_client.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Mapping, Optional
+
+from .i_webhooks_client import IWebhooksClient
+
+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.send_test_request import SendTestRequest
+from onlinepayments.sdk.domain.validate_credentials_request import ValidateCredentialsRequest
+from onlinepayments.sdk.domain.validate_credentials_response import ValidateCredentialsResponse
+from onlinepayments.sdk.exception_factory import create_exception
+
+
+class WebhooksClient(ApiResource, IWebhooksClient):
+    """
+    Webhooks 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(WebhooksClient, self).__init__(parent=parent, path_context=path_context)
+
+    def validate_webhook_credentials(self, body: ValidateCredentialsRequest, context: Optional[CallContext] = None) -> ValidateCredentialsResponse:
+        """
+        Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials
+
+        :param body:     :class:`onlinepayments.sdk.domain.validate_credentials_request.ValidateCredentialsRequest`
+        :param context:  :class:`onlinepayments.sdk.call_context.CallContext`
+        :return: :class:`onlinepayments.sdk.domain.validate_credentials_response.ValidateCredentialsResponse`
+        :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}/webhooks/validateCredentials", None)
+        try:
+            return self._communicator.post(
+                    uri,
+                    self._client_headers,
+                    None,
+                    body,
+                    ValidateCredentialsResponse,
+                    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 send_test_webhook(self, body: SendTestRequest, context: Optional[CallContext] = None) -> None:
+        """
+        Resource /v2/{merchantId}/webhooks/sendtest - Send test
+
+        :param body:     :class:`onlinepayments.sdk.domain.send_test_request.SendTestRequest`
+        :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 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}/webhooks/sendtest", None)
+        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)

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/platform_exception.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+
+from onlinepayments.sdk.domain.api_error import APIError
+
+
+class PlatformException(ApiException):
+    """
+    Represents an error response from the payment platform when something went wrong at the payment platform or further downstream.
+    """
+
+    def __init__(self, status_code: int, response_body: str, error_id: Optional[str], errors: Optional[List[APIError]],
+                 message: str = "the payment platform returned an error response"):
+        super(PlatformException, self).__init__(status_code, response_body, error_id, errors, message)

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/proxy_configuration.py

@@ -1,14 +1,15 @@
+from typing import Optional
 from urllib.parse import urlparse
 
 
-class ProxyConfiguration:
+class ProxyConfiguration(object):
     """
     HTTP proxy configuration.
 
     Can be initialised directly from a host and port or can be constructed from a uri using fromuri
     """
 
-    def __init__(self, host, port, scheme="http", username=None, password=None):
+    def __init__(self, host: str, port: int, scheme: str = "http", username: Optional[str] = None, password: Optional[str] = None):
         if not host:
             raise ValueError("host is required")
         if not port:
@@ -22,7 +23,7 @@ class ProxyConfiguration:
         self.__password = password
 
     @staticmethod
-    def from_uri(uri, username=None, password=None):
+    def from_uri(uri: str, username: Optional[str] = None, password: Optional[str] = None) -> 'ProxyConfiguration':
         """
         Constructs a ProxyConfiguration from a URI; if username and/or password
         are given they will be used instead of corresponding data in the URI
@@ -42,46 +43,50 @@ class ProxyConfiguration:
                 port = 443
             else:
                 raise ValueError("unsupported scheme: " + scheme)
-        return ProxyConfiguration(scheme=scheme, host=host, port=port, username=username, password=password)
+        return ProxyConfiguration(scheme=scheme,
+                                  host=host,
+                                  port=port,
+                                  username=username,
+                                  password=password)
 
     @property
-    def scheme(self):
+    def scheme(self) -> str:
         return self.__scheme
 
     @scheme.setter
-    def scheme(self, scheme):
+    def scheme(self, scheme: str) -> None:
         self.__scheme = scheme
 
     @property
-    def host(self):
+    def host(self) -> str:
         return self.__host
 
     @host.setter
-    def host(self, host):
+    def host(self, host: str) -> None:
         self.__host = host
 
     @property
-    def port(self):
+    def port(self) -> int:
         return self.__port
 
     @port.setter
-    def port(self, port):
+    def port(self, port: int) -> None:
         self.__port = port
 
     @property
-    def username(self):
+    def username(self) -> Optional[str]:
         return self.__username
 
     @username.setter
-    def username(self, username):
+    def username(self, username: Optional[str]) -> None:
         self.__username = username
 
     @property
-    def password(self):
+    def password(self) -> Optional[str]:
         return self.__password
 
     @password.setter
-    def password(self, password):
+    def password(self, password: Optional[str]) -> None:
         self.__password = password
 
     def __str__(self):

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/reference_exception.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+
+from onlinepayments.sdk.domain.api_error import APIError
+
+
+class ReferenceException(ApiException):
+    """
+    Represents an error response from the payment 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 payment platform returned a reference error response"):
+        super(ReferenceException, self).__init__(status_code, response_body, error_id, errors, message)

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/validation_exception.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import List, Optional
+
+from .api_exception import ApiException
+
+from onlinepayments.sdk.domain.api_error import APIError
+
+
+class ValidationException(ApiException):
+    """
+    Represents an error response from the payment 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 payment platform returned an incorrect request error response"):
+        super(ValidationException, self).__init__(status_code, response_body, error_id, errors, message)

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/webhooks/api_version_mismatch_exception.py

@@ -3,22 +3,21 @@ class ApiVersionMismatchException(RuntimeError):
     Represents an error because a webhooks event has an API version that this version of the SDK does not support.
     """
 
-    def __init__(self, event_api_version, sdk_api_version):
+    def __init__(self, event_api_version: str, sdk_api_version: str):
         super(ApiVersionMismatchException, self).__init__(
-            "event API version" + event_api_version +
-            " is not compatible with SDK API version" + sdk_api_version)
+            "event API version" + event_api_version + " is not compatible with SDK API version" + sdk_api_version)
         self.__event_api_version = event_api_version
         self.__sdk_api_version = sdk_api_version
 
     @property
-    def event_api_version(self):
+    def event_api_version(self) -> str:
         """
         :return: The API version from the webhooks event.
         """
         return self.__event_api_version
 
     @property
-    def sdk_api_version(self):
+    def sdk_api_version(self) -> str:
         """
         :return: The API version that this version of the SDK supports.
         """

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/webhooks/in_memory_secret_key_store.py

@@ -1,5 +1,5 @@
-from onlinepayments.sdk.webhooks.secret_key_not_available_exception import SecretKeyNotAvailableException
-from onlinepayments.sdk.webhooks.secret_key_store import SecretKeyStore
+from .secret_key_not_available_exception import SecretKeyNotAvailableException
+from .secret_key_store import SecretKeyStore
 
 
 class InMemorySecretKeyStore(SecretKeyStore):
@@ -10,20 +10,19 @@ class InMemorySecretKeyStore(SecretKeyStore):
     """
 
     @staticmethod
-    def INSTANCE():
+    def instance() -> 'InMemorySecretKeyStore':
         return _IN_MEMORY_SECRET_KEY_CACHE_INSTANCE
 
     __store = {}
 
-    def get_secret_key(self, key_id: str):
+    def get_secret_key(self, key_id: str) -> str:
         try:
             secret_key = self.__store[key_id]
         except KeyError:
-            raise SecretKeyNotAvailableException(
-                "could not find secret key for key id " + key_id, key_id)
+            raise SecretKeyNotAvailableException("could not find secret key for key id " + key_id, key_id)
         return secret_key
 
-    def store_secret_key(self, key_id, secret_key):
+    def store_secret_key(self, key_id: str, secret_key: str) -> None:
         """
         Stores the given secret key for the given key ID.
         """
@@ -33,13 +32,13 @@ class InMemorySecretKeyStore(SecretKeyStore):
             raise ValueError("secret_key is required")
         self.__store[key_id] = secret_key
 
-    def remove_secret_key(self, key_id):
+    def remove_secret_key(self, key_id: str) -> None:
         """
         Removes the secret key for the given key ID.
         """
         self.__store.pop(key_id)
 
-    def clear(self):
+    def clear(self) -> None:
         """
         Removes all stored secret keys.
         """

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/webhooks/secret_key_not_available_exception.py

@@ -0,0 +1,18 @@
+from typing import Optional
+
+from .signature_validation_exception import SignatureValidationException
+
+
+class SecretKeyNotAvailableException(SignatureValidationException):
+    """
+    Represents an error that causes a secret key to not be available.
+    """
+
+    def __init__(self, key_id: str, message: Optional[str] = None, cause: Optional[Exception] = None):
+        super(SecretKeyNotAvailableException, self).__init__(message=message,
+                                                             cause=cause)
+        self.__key_id = key_id
+
+    @property
+    def key_id(self) -> str:
+        return self.__key_id

{onlinepayments-sdk-python3-4.23.0 → onlinepayments_sdk_python3-5.0.0}/onlinepayments/sdk/webhooks/secret_key_store.py

@@ -7,9 +7,9 @@ class SecretKeyStore(ABC):
     """
 
     @abstractmethod
-    def get_secret_key(self, key_id: str):
+    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 SecretKeyNotAvailableException: If the secret key for the given key ID is not available.
         """
+        raise NotImplementedError

onlinepayments_sdk_python3-5.0.0/onlinepayments/sdk/webhooks/signature_validation_exception.py

@@ -0,0 +1,17 @@
+from typing import Optional
+
+
+class SignatureValidationException(RuntimeError):
+    """
+    Represents an error while validating webhooks signatures.
+    """
+
+    def __init__(self, message: Optional[str] = None, cause: Optional[Exception] = None):
+        if message and cause:
+            super(SignatureValidationException, self).__init__(message, cause)
+        elif message:
+            super(SignatureValidationException, self).__init__(message)
+        elif cause:
+            super(SignatureValidationException, self).__init__(cause)
+        else:
+            super(SignatureValidationException, self).__init__()