onlinepayments-sdk-python3 7.1.0__tar.gz → 7.2.0__tar.gz

{onlinepayments_sdk_python3-7.1.0/onlinepayments_sdk_python3.egg-info → onlinepayments_sdk_python3-7.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onlinepayments-sdk-python3
-Version: 7.1.0
+Version: 7.2.0
 Summary: SDK to communicate with the Online Payments platform using the Online Payments Server API
 Home-page: https://github.com/wl-online-payments-direct/sdk-python3
 Author: Worldline Direct support team

{onlinepayments_sdk_python3-7.1.0 → onlinepayments_sdk_python3-7.2.0}/onlinepayments/sdk/call_context.py

@@ -1,7 +1,6 @@
 from typing import Optional
 from datetime import datetime
 
-
 class CallContext(object):
     """
     A call context can be used to send extra information with a request, and to receive extra information from a response.
@@ -11,12 +10,11 @@ class CallContext(object):
     __idempotence_key: Optional[str] = None
     __idempotence_request_timestamp: Optional[int] = None
     __idempotence_response_date_time: Optional[datetime] = None
+    __gzip: Optional[bool] = None
 
-    def __init__(self, idempotence_key: Optional[str] = None):
-        """
-        Sets the idempotence key to use for the next request for which this call context is used.
-        """
+    def __init__(self, idempotence_key: Optional[str] = None, gzip: Optional[bool] = None):
         self.__idempotence_key = idempotence_key
+        self.__gzip = gzip
 
     @property
     def idempotence_key(self) -> Optional[str]:
@@ -60,3 +58,15 @@ class CallContext(object):
         response to the request for which this call context was used.
         """
         self.__idempotence_response_date_time = idempotence_response_date_time
+
+    @property
+    def gzip(self) -> Optional[bool]:
+        """Per-request gzip toggle."""
+        return self.__gzip
+
+    @gzip.setter
+    def gzip(self, enabled: Optional[bool]) -> None:
+        """
+        Sets the gzip field true/false.
+        """
+        self.__gzip = enabled

{onlinepayments_sdk_python3-7.1.0 → onlinepayments_sdk_python3-7.2.0}/onlinepayments/sdk/communication/connection.py

@@ -10,7 +10,7 @@ from onlinepayments.sdk.log.obfuscation_capable import ObfuscationCapable
 
 
 URI = Union[str, ParseResult]
-RequestBody = Union[str, MultipartFormDataObject, None]
+RequestBody = Union[str, bytes, MultipartFormDataObject, None]
 Response = Tuple[int, Mapping[str, str], Iterable[bytes]]
 
 

{onlinepayments_sdk_python3-7.1.0 → onlinepayments_sdk_python3-7.2.0}/onlinepayments/sdk/communication/default_connection.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import math
+import gzip
 import uuid
 from datetime import datetime, timedelta
 from typing import Mapping, Optional, Sequence, Any, Generator
@@ -105,6 +106,13 @@ class DefaultConnection(PooledConnection):
         """
         if isinstance(body, MultipartFormDataObject):
             body = self.__to_multipart_encoder(body)
+
+        headers_dict = {h.name: h.value for h in (request_headers or [])}
+        content_encoding = headers_dict.get('Content-Encoding') or headers_dict.get('content-encoding')
+
+        if body is not None and content_encoding and 'gzip' in content_encoding.lower():
+            body = gzip.compress(body.encode("utf-8"))
+
         return self._request('post', url, request_headers, body)
 
     def put(self, url: URI, request_headers: Sequence[RequestHeader], body: RequestBody) -> Response:

{onlinepayments_sdk_python3-7.1.0 → onlinepayments_sdk_python3-7.2.0}/onlinepayments/sdk/communication/metadata_provider.py

@@ -23,7 +23,7 @@ class MetadataProvider(IMetadataProvider):
     """
     Provides meta info about the server.
     """
-    __sdk_version = "7.1.0"
+    __sdk_version = "7.2.0"
     __server_meta_info_header = "X-GCS-ServerMetaInfo"
     __prohibited_headers = tuple(sorted([__server_meta_info_header, "X-GCS-Idempotence-Key", "Date", "Content-Type", "Authorization"],
                                         key=str.lower))

{onlinepayments_sdk_python3-7.1.0 → onlinepayments_sdk_python3-7.2.0}/onlinepayments/sdk/communicator.py

@@ -186,6 +186,14 @@ class Communicator(ICommunicator):
             request_headers.append(RequestHeader("Content-Type", "application/json"))
             body = self.__marshaller.marshal(request_body)
 
+        if (
+            body is not None
+            and context is not None
+            and context.gzip is True
+            and not isinstance(body, MultipartFormDataObject)
+        ):
+            request_headers.append(RequestHeader("Content-Encoding", "gzip"))
+
         self._add_generic_headers("POST", uri, request_headers, context)
         return self.__connection.post(uri, request_headers, body)
 

onlinepayments_sdk_python3-7.2.0/onlinepayments/sdk/domain/acceptance.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from datetime import datetime
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class Acceptance(DataObject):
+
+    __acceptance_system_application_id: Optional[str] = None
+    __authorization_date: Optional[datetime] = None
+
+    @property
+    def acceptance_system_application_id(self) -> Optional[str]:
+        """
+        | Worldline application identifier used to transmit the authorization request. This data is transmitted as provided in the authorization request and in the response. It is named ITP (Terminal Application Identification at the Point of Acceptance) in the CB2A protocol.
+
+        Type: str
+        """
+        return self.__acceptance_system_application_id
+
+    @acceptance_system_application_id.setter
+    def acceptance_system_application_id(self, value: Optional[str]) -> None:
+        self.__acceptance_system_application_id = value
+
+    @property
+    def authorization_date(self) -> Optional[datetime]:
+        """
+        | It is the authorization processing date and time of the transaction.
+
+        Type: datetime
+        """
+        return self.__authorization_date
+
+    @authorization_date.setter
+    def authorization_date(self, value: Optional[datetime]) -> None:
+        self.__authorization_date = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(Acceptance, self).to_dictionary()
+        if self.acceptance_system_application_id is not None:
+            dictionary['acceptanceSystemApplicationId'] = self.acceptance_system_application_id
+        if self.authorization_date is not None:
+            dictionary['authorizationDate'] = DataObject.format_datetime(self.authorization_date)
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'Acceptance':
+        super(Acceptance, self).from_dictionary(dictionary)
+        if 'acceptanceSystemApplicationId' in dictionary:
+            self.acceptance_system_application_id = dictionary['acceptanceSystemApplicationId']
+        if 'authorizationDate' in dictionary:
+            self.authorization_date = DataObject.parse_datetime(dictionary['authorizationDate'])
+        return self

onlinepayments_sdk_python3-7.2.0/onlinepayments/sdk/domain/batch_metadata.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class BatchMetadata(DataObject):
+
+    __item_count: Optional[int] = None
+    __merchant_batch_reference: Optional[str] = None
+    __operation_type: Optional[str] = None
+
+    @property
+    def item_count(self) -> Optional[int]:
+        """
+        | The total number of items included in the batch submission.
+
+        Type: int
+        """
+        return self.__item_count
+
+    @item_count.setter
+    def item_count(self, value: Optional[int]) -> None:
+        self.__item_count = value
+
+    @property
+    def merchant_batch_reference(self) -> Optional[str]:
+        """
+        | Unique batch reference submitted by the merchant.
+
+        Type: str
+        """
+        return self.__merchant_batch_reference
+
+    @merchant_batch_reference.setter
+    def merchant_batch_reference(self, value: Optional[str]) -> None:
+        self.__merchant_batch_reference = value
+
+    @property
+    def operation_type(self) -> Optional[str]:
+        """
+        | The specific operation type being requested for the batch.
+
+        Type: str
+        """
+        return self.__operation_type
+
+    @operation_type.setter
+    def operation_type(self, value: Optional[str]) -> None:
+        self.__operation_type = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(BatchMetadata, self).to_dictionary()
+        if self.item_count is not None:
+            dictionary['itemCount'] = self.item_count
+        if self.merchant_batch_reference is not None:
+            dictionary['merchantBatchReference'] = self.merchant_batch_reference
+        if self.operation_type is not None:
+            dictionary['operationType'] = self.operation_type
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'BatchMetadata':
+        super(BatchMetadata, self).from_dictionary(dictionary)
+        if 'itemCount' in dictionary:
+            self.item_count = dictionary['itemCount']
+        if 'merchantBatchReference' in dictionary:
+            self.merchant_batch_reference = dictionary['merchantBatchReference']
+        if 'operationType' in dictionary:
+            self.operation_type = dictionary['operationType']
+        return self

onlinepayments_sdk_python3-7.2.0/onlinepayments/sdk/domain/cancel_payment_batch_request.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .cancel_payment_request import CancelPaymentRequest
+from .data_object import DataObject
+
+
+class CancelPaymentBatchRequest(DataObject):
+
+    __cancel: Optional[CancelPaymentRequest] = None
+    __payment_id: Optional[str] = None
+
+    @property
+    def cancel(self) -> Optional[CancelPaymentRequest]:
+        """
+        Type: :class:`onlinepayments.sdk.domain.cancel_payment_request.CancelPaymentRequest`
+        """
+        return self.__cancel
+
+    @cancel.setter
+    def cancel(self, value: Optional[CancelPaymentRequest]) -> None:
+        self.__cancel = value
+
+    @property
+    def payment_id(self) -> Optional[str]:
+        """
+        | This is our unique payment transaction identifier.
+
+        Type: str
+        """
+        return self.__payment_id
+
+    @payment_id.setter
+    def payment_id(self, value: Optional[str]) -> None:
+        self.__payment_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CancelPaymentBatchRequest, self).to_dictionary()
+        if self.cancel is not None:
+            dictionary['cancel'] = self.cancel.to_dictionary()
+        if self.payment_id is not None:
+            dictionary['paymentId'] = self.payment_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CancelPaymentBatchRequest':
+        super(CancelPaymentBatchRequest, self).from_dictionary(dictionary)
+        if 'cancel' in dictionary:
+            if not isinstance(dictionary['cancel'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['cancel']))
+            value = CancelPaymentRequest()
+            self.cancel = value.from_dictionary(dictionary['cancel'])
+        if 'paymentId' in dictionary:
+            self.payment_id = dictionary['paymentId']
+        return self

onlinepayments_sdk_python3-7.2.0/onlinepayments/sdk/domain/capture_payment_batch_request.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .capture_payment_request import CapturePaymentRequest
+from .data_object import DataObject
+
+
+class CapturePaymentBatchRequest(DataObject):
+
+    __capture: Optional[CapturePaymentRequest] = None
+    __payment_id: Optional[str] = None
+
+    @property
+    def capture(self) -> Optional[CapturePaymentRequest]:
+        """
+        Type: :class:`onlinepayments.sdk.domain.capture_payment_request.CapturePaymentRequest`
+        """
+        return self.__capture
+
+    @capture.setter
+    def capture(self, value: Optional[CapturePaymentRequest]) -> None:
+        self.__capture = value
+
+    @property
+    def payment_id(self) -> Optional[str]:
+        """
+        | This is our unique payment transaction identifier.
+
+        Type: str
+        """
+        return self.__payment_id
+
+    @payment_id.setter
+    def payment_id(self, value: Optional[str]) -> None:
+        self.__payment_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(CapturePaymentBatchRequest, self).to_dictionary()
+        if self.capture is not None:
+            dictionary['capture'] = self.capture.to_dictionary()
+        if self.payment_id is not None:
+            dictionary['paymentId'] = self.payment_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'CapturePaymentBatchRequest':
+        super(CapturePaymentBatchRequest, self).from_dictionary(dictionary)
+        if 'capture' in dictionary:
+            if not isinstance(dictionary['capture'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['capture']))
+            value = CapturePaymentRequest()
+            self.capture = value.from_dictionary(dictionary['capture'])
+        if 'paymentId' in dictionary:
+            self.payment_id = dictionary['paymentId']
+        return self

{onlinepayments_sdk_python3-7.1.0 → onlinepayments_sdk_python3-7.2.0}/onlinepayments/sdk/domain/card_payment_method_specific_output.py

@@ -4,6 +4,7 @@
 #
 from typing import Optional
 
+from .acceptance import Acceptance
 from .acquirer_information import AcquirerInformation
 from .card_essentials import CardEssentials
 from .card_fraud_results import CardFraudResults
@@ -20,6 +21,7 @@ from .three_d_secure_results import ThreeDSecureResults
 
 class CardPaymentMethodSpecificOutput(DataObject):
 
+    __acceptance: Optional[Acceptance] = None
     __acquirer_information: Optional[AcquirerInformation] = None
     __authenticated_amount: Optional[int] = None
     __authorisation_code: Optional[str] = None
@@ -41,6 +43,19 @@ class CardPaymentMethodSpecificOutput(DataObject):
     __three_d_secure_results: Optional[ThreeDSecureResults] = None
     __token: Optional[str] = None
 
+    @property
+    def acceptance(self) -> Optional[Acceptance]:
+        """
+        | This object contains the acceptance information for the card payment authorization.
+
+        Type: :class:`onlinepayments.sdk.domain.acceptance.Acceptance`
+        """
+        return self.__acceptance
+
+    @acceptance.setter
+    def acceptance(self, value: Optional[Acceptance]) -> None:
+        self.__acceptance = value
+
     @property
     def acquirer_information(self) -> Optional[AcquirerInformation]:
         """
@@ -303,6 +318,8 @@ class CardPaymentMethodSpecificOutput(DataObject):
 
     def to_dictionary(self) -> dict:
         dictionary = super(CardPaymentMethodSpecificOutput, self).to_dictionary()
+        if self.acceptance is not None:
+            dictionary['acceptance'] = self.acceptance.to_dictionary()
         if self.acquirer_information is not None:
             dictionary['acquirerInformation'] = self.acquirer_information.to_dictionary()
         if self.authenticated_amount is not None:
@@ -347,6 +364,11 @@ class CardPaymentMethodSpecificOutput(DataObject):
 
     def from_dictionary(self, dictionary: dict) -> 'CardPaymentMethodSpecificOutput':
         super(CardPaymentMethodSpecificOutput, self).from_dictionary(dictionary)
+        if 'acceptance' in dictionary:
+            if not isinstance(dictionary['acceptance'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['acceptance']))
+            value = Acceptance()
+            self.acceptance = value.from_dictionary(dictionary['acceptance'])
         if 'acquirerInformation' in dictionary:
             if not isinstance(dictionary['acquirerInformation'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['acquirerInformation']))

onlinepayments_sdk_python3-7.2.0/onlinepayments/sdk/domain/get_batch_status_response.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class GetBatchStatusResponse(DataObject):
+
+    __item_count: Optional[int] = None
+    __merchant_batch_reference: Optional[str] = None
+    __operation_type: Optional[str] = None
+    __status: Optional[str] = None
+
+    @property
+    def item_count(self) -> Optional[int]:
+        """
+        | The total number of items included in the batch submission.
+
+        Type: int
+        """
+        return self.__item_count
+
+    @item_count.setter
+    def item_count(self, value: Optional[int]) -> None:
+        self.__item_count = value
+
+    @property
+    def merchant_batch_reference(self) -> Optional[str]:
+        """
+        | Unique batch reference submitted by the merchant.
+
+        Type: str
+        """
+        return self.__merchant_batch_reference
+
+    @merchant_batch_reference.setter
+    def merchant_batch_reference(self, value: Optional[str]) -> None:
+        self.__merchant_batch_reference = value
+
+    @property
+    def operation_type(self) -> Optional[str]:
+        """
+        | The specific operation type being requested for the batch.
+
+        Type: str
+        """
+        return self.__operation_type
+
+    @operation_type.setter
+    def operation_type(self, value: Optional[str]) -> None:
+        self.__operation_type = value
+
+    @property
+    def status(self) -> Optional[str]:
+        """
+        | The status of the batch.
+
+        Type: str
+        """
+        return self.__status
+
+    @status.setter
+    def status(self, value: Optional[str]) -> None:
+        self.__status = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(GetBatchStatusResponse, self).to_dictionary()
+        if self.item_count is not None:
+            dictionary['itemCount'] = self.item_count
+        if self.merchant_batch_reference is not None:
+            dictionary['merchantBatchReference'] = self.merchant_batch_reference
+        if self.operation_type is not None:
+            dictionary['operationType'] = self.operation_type
+        if self.status is not None:
+            dictionary['status'] = self.status
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'GetBatchStatusResponse':
+        super(GetBatchStatusResponse, self).from_dictionary(dictionary)
+        if 'itemCount' in dictionary:
+            self.item_count = dictionary['itemCount']
+        if 'merchantBatchReference' in dictionary:
+            self.merchant_batch_reference = dictionary['merchantBatchReference']
+        if 'operationType' in dictionary:
+            self.operation_type = dictionary['operationType']
+        if 'status' in dictionary:
+            self.status = dictionary['status']
+        return self

{onlinepayments_sdk_python3-7.1.0 → onlinepayments_sdk_python3-7.2.0}/onlinepayments/sdk/domain/payment_output.py

@@ -2,6 +2,7 @@
 #
 # This file was automatically generated.
 #
+from datetime import datetime
 from typing import Optional
 
 from .amount_of_money import AmountOfMoney
@@ -33,6 +34,7 @@ class PaymentOutput(DataObject):
     __sepa_direct_debit_payment_method_specific_output: Optional[SepaDirectDebitPaymentMethodSpecificOutput] = None
     __shopping_cart_output: Optional[ShoppingCartOutput] = None
     __surcharge_specific_output: Optional[SurchargeSpecificOutput] = None
+    __transaction_date: Optional[datetime] = None
 
     @property
     def acquired_amount(self) -> Optional[AmountOfMoney]:
@@ -218,6 +220,19 @@ class PaymentOutput(DataObject):
     def surcharge_specific_output(self, value: Optional[SurchargeSpecificOutput]) -> None:
         self.__surcharge_specific_output = value
 
+    @property
+    def transaction_date(self) -> Optional[datetime]:
+        """
+        | It is the server-side processing date and time of the transaction.
+
+        Type: datetime
+        """
+        return self.__transaction_date
+
+    @transaction_date.setter
+    def transaction_date(self, value: Optional[datetime]) -> None:
+        self.__transaction_date = value
+
     def to_dictionary(self) -> dict:
         dictionary = super(PaymentOutput, self).to_dictionary()
         if self.acquired_amount is not None:
@@ -248,6 +263,8 @@ class PaymentOutput(DataObject):
             dictionary['shoppingCartOutput'] = self.shopping_cart_output.to_dictionary()
         if self.surcharge_specific_output is not None:
             dictionary['surchargeSpecificOutput'] = self.surcharge_specific_output.to_dictionary()
+        if self.transaction_date is not None:
+            dictionary['transactionDate'] = DataObject.format_datetime(self.transaction_date)
         return dictionary
 
     def from_dictionary(self, dictionary: dict) -> 'PaymentOutput':
@@ -313,4 +330,6 @@ class PaymentOutput(DataObject):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['surchargeSpecificOutput']))
             value = SurchargeSpecificOutput()
             self.surcharge_specific_output = value.from_dictionary(dictionary['surchargeSpecificOutput'])
+        if 'transactionDate' in dictionary:
+            self.transaction_date = DataObject.parse_datetime(dictionary['transactionDate'])
         return self

onlinepayments_sdk_python3-7.2.0/onlinepayments/sdk/domain/refund_payment_batch_request.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .refund_request import RefundRequest
+
+
+class RefundPaymentBatchRequest(DataObject):
+
+    __payment_id: Optional[str] = None
+    __refund: Optional[RefundRequest] = None
+
+    @property
+    def payment_id(self) -> Optional[str]:
+        """
+        | This is our unique payment transaction identifier.
+
+        Type: str
+        """
+        return self.__payment_id
+
+    @payment_id.setter
+    def payment_id(self, value: Optional[str]) -> None:
+        self.__payment_id = value
+
+    @property
+    def refund(self) -> Optional[RefundRequest]:
+        """
+        Type: :class:`onlinepayments.sdk.domain.refund_request.RefundRequest`
+        """
+        return self.__refund
+
+    @refund.setter
+    def refund(self, value: Optional[RefundRequest]) -> None:
+        self.__refund = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(RefundPaymentBatchRequest, self).to_dictionary()
+        if self.payment_id is not None:
+            dictionary['paymentId'] = self.payment_id
+        if self.refund is not None:
+            dictionary['refund'] = self.refund.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'RefundPaymentBatchRequest':
+        super(RefundPaymentBatchRequest, self).from_dictionary(dictionary)
+        if 'paymentId' in dictionary:
+            self.payment_id = dictionary['paymentId']
+        if 'refund' in dictionary:
+            if not isinstance(dictionary['refund'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['refund']))
+            value = RefundRequest()
+            self.refund = value.from_dictionary(dictionary['refund'])
+        return self