onlinepayments-sdk-python3 8.0.0__tar.gz → 8.1.0__tar.gz

{onlinepayments_sdk_python3-8.0.0/onlinepayments_sdk_python3.egg-info → onlinepayments_sdk_python3-8.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: onlinepayments-sdk-python3
-Version: 8.0.0
+Version: 8.1.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-8.0.0 → onlinepayments_sdk_python3-8.1.0}/onlinepayments/sdk/communication/metadata_provider.py

@@ -23,7 +23,7 @@ class MetadataProvider(IMetadataProvider):
     """
     Provides meta info about the server.
     """
-    __sdk_version = "8.0.0"
+    __sdk_version = "8.1.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-8.1.0/onlinepayments/sdk/domain/get_hosted_fields_session_response.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .token_info import TokenInfo
+
+
+class GetHostedFieldsSessionResponse(DataObject):
+
+    __session_id: Optional[str] = None
+    __token: Optional[TokenInfo] = None
+
+    @property
+    def session_id(self) -> Optional[str]:
+        """
+        | The ID of the hosted fields session.
+
+        Type: str
+        """
+        return self.__session_id
+
+    @session_id.setter
+    def session_id(self, value: Optional[str]) -> None:
+        self.__session_id = value
+
+    @property
+    def token(self) -> Optional[TokenInfo]:
+        """
+        | Object containing token information that is used in the hosted fields session
+
+        Type: :class:`onlinepayments.sdk.domain.token_info.TokenInfo`
+        """
+        return self.__token
+
+    @token.setter
+    def token(self, value: Optional[TokenInfo]) -> None:
+        self.__token = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(GetHostedFieldsSessionResponse, self).to_dictionary()
+        if self.session_id is not None:
+            dictionary['sessionId'] = self.session_id
+        if self.token is not None:
+            dictionary['token'] = self.token.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'GetHostedFieldsSessionResponse':
+        super(GetHostedFieldsSessionResponse, self).from_dictionary(dictionary)
+        if 'sessionId' in dictionary:
+            self.session_id = dictionary['sessionId']
+        if 'token' in dictionary:
+            if not isinstance(dictionary['token'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['token']))
+            value = TokenInfo()
+            self.token = value.from_dictionary(dictionary['token'])
+        return self

{onlinepayments_sdk_python3-8.0.0 → onlinepayments_sdk_python3-8.1.0}/onlinepayments/sdk/domain/import_cof_series_request.py

@@ -15,6 +15,7 @@ class ImportCofSeriesRequest(DataObject):
     __payment_product_id: Optional[int] = None
     __scheme_reference_data: Optional[str] = None
     __token_id: Optional[str] = None
+    __transaction_link_identifier: Optional[str] = None
 
     @property
     def card(self) -> Optional[CardDataWithoutCvv]:
@@ -81,6 +82,19 @@ class ImportCofSeriesRequest(DataObject):
     def token_id(self, value: Optional[str]) -> None:
         self.__token_id = value
 
+    @property
+    def transaction_link_identifier(self) -> Optional[str]:
+        """
+        | The Transaction Link Identifier (TLID) of the original Consumer-Initiated Transaction (CIT).
+
+        Type: str
+        """
+        return self.__transaction_link_identifier
+
+    @transaction_link_identifier.setter
+    def transaction_link_identifier(self, value: Optional[str]) -> None:
+        self.__transaction_link_identifier = value
+
     def to_dictionary(self) -> dict:
         dictionary = super(ImportCofSeriesRequest, self).to_dictionary()
         if self.card is not None:
@@ -93,6 +107,8 @@ class ImportCofSeriesRequest(DataObject):
             dictionary['schemeReferenceData'] = self.scheme_reference_data
         if self.token_id is not None:
             dictionary['tokenId'] = self.token_id
+        if self.transaction_link_identifier is not None:
+            dictionary['transactionLinkIdentifier'] = self.transaction_link_identifier
         return dictionary
 
     def from_dictionary(self, dictionary: dict) -> 'ImportCofSeriesRequest':
@@ -110,4 +126,6 @@ class ImportCofSeriesRequest(DataObject):
             self.scheme_reference_data = dictionary['schemeReferenceData']
         if 'tokenId' in dictionary:
             self.token_id = dictionary['tokenId']
+        if 'transactionLinkIdentifier' in dictionary:
+            self.transaction_link_identifier = dictionary['transactionLinkIdentifier']
         return self

onlinepayments_sdk_python3-8.1.0/onlinepayments/sdk/domain/payment_product_session302_specific_input.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProductSession302SpecificInput(DataObject):
+
+    __display_name: Optional[str] = None
+    __domain_name: Optional[str] = None
+
+    @property
+    def display_name(self) -> Optional[str]:
+        """
+        | A human-readable name for the merchant, as it would be displayed to the user within the Apple Pay interface.
+
+        Type: str
+        """
+        return self.__display_name
+
+    @display_name.setter
+    def display_name(self, value: Optional[str]) -> None:
+        self.__display_name = value
+
+    @property
+    def domain_name(self) -> Optional[str]:
+        """
+        | The fully qualified domain name of the web page that will host the Apple Pay session.
+
+        Type: str
+        """
+        return self.__domain_name
+
+    @domain_name.setter
+    def domain_name(self, value: Optional[str]) -> None:
+        self.__domain_name = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProductSession302SpecificInput, self).to_dictionary()
+        if self.display_name is not None:
+            dictionary['displayName'] = self.display_name
+        if self.domain_name is not None:
+            dictionary['domainName'] = self.domain_name
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProductSession302SpecificInput':
+        super(PaymentProductSession302SpecificInput, self).from_dictionary(dictionary)
+        if 'displayName' in dictionary:
+            self.display_name = dictionary['displayName']
+        if 'domainName' in dictionary:
+            self.domain_name = dictionary['domainName']
+        return self

onlinepayments_sdk_python3-8.1.0/onlinepayments/sdk/domain/payment_product_session302_specific_output.py

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class PaymentProductSession302SpecificOutput(DataObject):
+
+    __session: Optional[str] = None
+
+    @property
+    def session(self) -> Optional[str]:
+        """
+        | The payment session object that must be passed to the Apple Pay API on the client side to initialize the Apple Pay payment sheet.
+
+        Type: str
+        """
+        return self.__session
+
+    @session.setter
+    def session(self, value: Optional[str]) -> None:
+        self.__session = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProductSession302SpecificOutput, self).to_dictionary()
+        if self.session is not None:
+            dictionary['session'] = self.session
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProductSession302SpecificOutput':
+        super(PaymentProductSession302SpecificOutput, self).from_dictionary(dictionary)
+        if 'session' in dictionary:
+            self.session = dictionary['session']
+        return self

onlinepayments_sdk_python3-8.1.0/onlinepayments/sdk/domain/payment_product_session_request.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .payment_product_session302_specific_input import PaymentProductSession302SpecificInput
+
+
+class PaymentProductSessionRequest(DataObject):
+
+    __payment_product_session302_specific_input: Optional[PaymentProductSession302SpecificInput] = None
+
+    @property
+    def payment_product_session302_specific_input(self) -> Optional[PaymentProductSession302SpecificInput]:
+        """
+        | The specific input details needed to create a payment product session for Apple Pay (payment product 302).
+
+        Type: :class:`onlinepayments.sdk.domain.payment_product_session302_specific_input.PaymentProductSession302SpecificInput`
+        """
+        return self.__payment_product_session302_specific_input
+
+    @payment_product_session302_specific_input.setter
+    def payment_product_session302_specific_input(self, value: Optional[PaymentProductSession302SpecificInput]) -> None:
+        self.__payment_product_session302_specific_input = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProductSessionRequest, self).to_dictionary()
+        if self.payment_product_session302_specific_input is not None:
+            dictionary['paymentProductSession302SpecificInput'] = self.payment_product_session302_specific_input.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProductSessionRequest':
+        super(PaymentProductSessionRequest, self).from_dictionary(dictionary)
+        if 'paymentProductSession302SpecificInput' in dictionary:
+            if not isinstance(dictionary['paymentProductSession302SpecificInput'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['paymentProductSession302SpecificInput']))
+            value = PaymentProductSession302SpecificInput()
+            self.payment_product_session302_specific_input = value.from_dictionary(dictionary['paymentProductSession302SpecificInput'])
+        return self

onlinepayments_sdk_python3-8.1.0/onlinepayments/sdk/domain/payment_product_session_response.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+from .payment_product_session302_specific_output import PaymentProductSession302SpecificOutput
+
+
+class PaymentProductSessionResponse(DataObject):
+
+    __payment_product_session302_specific_output: Optional[PaymentProductSession302SpecificOutput] = None
+
+    @property
+    def payment_product_session302_specific_output(self) -> Optional[PaymentProductSession302SpecificOutput]:
+        """
+        | The specific output details of the created payment product session for Apple Pay (payment product 302).
+
+        Type: :class:`onlinepayments.sdk.domain.payment_product_session302_specific_output.PaymentProductSession302SpecificOutput`
+        """
+        return self.__payment_product_session302_specific_output
+
+    @payment_product_session302_specific_output.setter
+    def payment_product_session302_specific_output(self, value: Optional[PaymentProductSession302SpecificOutput]) -> None:
+        self.__payment_product_session302_specific_output = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(PaymentProductSessionResponse, self).to_dictionary()
+        if self.payment_product_session302_specific_output is not None:
+            dictionary['paymentProductSession302SpecificOutput'] = self.payment_product_session302_specific_output.to_dictionary()
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'PaymentProductSessionResponse':
+        super(PaymentProductSessionResponse, self).from_dictionary(dictionary)
+        if 'paymentProductSession302SpecificOutput' in dictionary:
+            if not isinstance(dictionary['paymentProductSession302SpecificOutput'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['paymentProductSession302SpecificOutput']))
+            value = PaymentProductSession302SpecificOutput()
+            self.payment_product_session302_specific_output = value.from_dictionary(dictionary['paymentProductSession302SpecificOutput'])
+        return self

{onlinepayments_sdk_python3-8.0.0 → onlinepayments_sdk_python3-8.1.0}/onlinepayments/sdk/domain/payment_response.py

@@ -6,6 +6,7 @@ from typing import Optional
 
 from .data_object import DataObject
 from .hosted_checkout_specific_output import HostedCheckoutSpecificOutput
+from .operation_output import OperationOutput
 from .payment_output import PaymentOutput
 from .payment_status_output import PaymentStatusOutput
 from .session_details import SessionDetails
@@ -15,6 +16,7 @@ class PaymentResponse(DataObject):
 
     __hosted_checkout_specific_output: Optional[HostedCheckoutSpecificOutput] = None
     __id: Optional[str] = None
+    __operation_output: Optional[OperationOutput] = None
     __payment_output: Optional[PaymentOutput] = None
     __session_details: Optional[SessionDetails] = None
     __status: Optional[str] = None
@@ -46,6 +48,19 @@ class PaymentResponse(DataObject):
     def id(self, value: Optional[str]) -> None:
         self.__id = value
 
+    @property
+    def operation_output(self) -> Optional[OperationOutput]:
+        """
+        | Object containing operation details
+
+        Type: :class:`onlinepayments.sdk.domain.operation_output.OperationOutput`
+        """
+        return self.__operation_output
+
+    @operation_output.setter
+    def operation_output(self, value: Optional[OperationOutput]) -> None:
+        self.__operation_output = value
+
     @property
     def payment_output(self) -> Optional[PaymentOutput]:
         """
@@ -104,6 +119,8 @@ class PaymentResponse(DataObject):
             dictionary['hostedCheckoutSpecificOutput'] = self.hosted_checkout_specific_output.to_dictionary()
         if self.id is not None:
             dictionary['id'] = self.id
+        if self.operation_output is not None:
+            dictionary['operationOutput'] = self.operation_output.to_dictionary()
         if self.payment_output is not None:
             dictionary['paymentOutput'] = self.payment_output.to_dictionary()
         if self.session_details is not None:
@@ -123,6 +140,11 @@ class PaymentResponse(DataObject):
             self.hosted_checkout_specific_output = value.from_dictionary(dictionary['hostedCheckoutSpecificOutput'])
         if 'id' in dictionary:
             self.id = dictionary['id']
+        if 'operationOutput' in dictionary:
+            if not isinstance(dictionary['operationOutput'], dict):
+                raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['operationOutput']))
+            value = OperationOutput()
+            self.operation_output = value.from_dictionary(dictionary['operationOutput'])
         if 'paymentOutput' in dictionary:
             if not isinstance(dictionary['paymentOutput'], dict):
                 raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['paymentOutput']))

onlinepayments_sdk_python3-8.1.0/onlinepayments/sdk/domain/problem_details_response.py

@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class ProblemDetailsResponse(DataObject):
+
+    __detail: Optional[str] = None
+    __instance: Optional[str] = None
+    __status: Optional[int] = None
+    __title: Optional[str] = None
+    __type: Optional[str] = None
+
+    @property
+    def detail(self) -> Optional[str]:
+        """
+        | A human-readable explanation specific to this occurrence of the problem.
+
+        Type: str
+        """
+        return self.__detail
+
+    @detail.setter
+    def detail(self, value: Optional[str]) -> None:
+        self.__detail = value
+
+    @property
+    def instance(self) -> Optional[str]:
+        """
+        | A URI reference that identifies the specific occurrence of the problem.
+
+        Type: str
+        """
+        return self.__instance
+
+    @instance.setter
+    def instance(self, value: Optional[str]) -> None:
+        self.__instance = value
+
+    @property
+    def status(self) -> Optional[int]:
+        """
+        | The HTTP status code.
+
+        Type: int
+        """
+        return self.__status
+
+    @status.setter
+    def status(self, value: Optional[int]) -> None:
+        self.__status = value
+
+    @property
+    def title(self) -> Optional[str]:
+        """
+        | A short, human-readable summary of the problem type.
+
+        Type: str
+        """
+        return self.__title
+
+    @title.setter
+    def title(self, value: Optional[str]) -> None:
+        self.__title = value
+
+    @property
+    def type(self) -> Optional[str]:
+        """
+        | A URI reference that identifies the problem type.
+
+        Type: str
+        """
+        return self.__type
+
+    @type.setter
+    def type(self, value: Optional[str]) -> None:
+        self.__type = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(ProblemDetailsResponse, self).to_dictionary()
+        if self.detail is not None:
+            dictionary['detail'] = self.detail
+        if self.instance is not None:
+            dictionary['instance'] = self.instance
+        if self.status is not None:
+            dictionary['status'] = self.status
+        if self.title is not None:
+            dictionary['title'] = self.title
+        if self.type is not None:
+            dictionary['type'] = self.type
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'ProblemDetailsResponse':
+        super(ProblemDetailsResponse, self).from_dictionary(dictionary)
+        if 'detail' in dictionary:
+            self.detail = dictionary['detail']
+        if 'instance' in dictionary:
+            self.instance = dictionary['instance']
+        if 'status' in dictionary:
+            self.status = dictionary['status']
+        if 'title' in dictionary:
+            self.title = dictionary['title']
+        if 'type' in dictionary:
+            self.type = dictionary['type']
+        return self

onlinepayments_sdk_python3-8.1.0/onlinepayments/sdk/domain/token_info.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+#
+# This file was automatically generated.
+#
+from typing import Optional
+
+from .data_object import DataObject
+
+
+class TokenInfo(DataObject):
+
+    __expiry_date: Optional[str] = None
+    __is_temporary: Optional[bool] = None
+    __masked_pan: Optional[str] = None
+    __token_id: Optional[str] = None
+
+    @property
+    def expiry_date(self) -> Optional[str]:
+        """
+        | The expiry date of the network token.
+
+        Type: str
+        """
+        return self.__expiry_date
+
+    @expiry_date.setter
+    def expiry_date(self, value: Optional[str]) -> None:
+        self.__expiry_date = value
+
+    @property
+    def is_temporary(self) -> Optional[bool]:
+        """
+        | Temporary tokens have a lifespan of two hours and can only be used once.
+
+        Type: bool
+        """
+        return self.__is_temporary
+
+    @is_temporary.setter
+    def is_temporary(self, value: Optional[bool]) -> None:
+        self.__is_temporary = value
+
+    @property
+    def masked_pan(self) -> Optional[str]:
+        """
+        | The masked Primary Account Number (PAN).
+
+        Type: str
+        """
+        return self.__masked_pan
+
+    @masked_pan.setter
+    def masked_pan(self, value: Optional[str]) -> None:
+        self.__masked_pan = value
+
+    @property
+    def token_id(self) -> Optional[str]:
+        """
+        | ID of the token
+
+        Type: str
+        """
+        return self.__token_id
+
+    @token_id.setter
+    def token_id(self, value: Optional[str]) -> None:
+        self.__token_id = value
+
+    def to_dictionary(self) -> dict:
+        dictionary = super(TokenInfo, self).to_dictionary()
+        if self.expiry_date is not None:
+            dictionary['expiryDate'] = self.expiry_date
+        if self.is_temporary is not None:
+            dictionary['isTemporary'] = self.is_temporary
+        if self.masked_pan is not None:
+            dictionary['maskedPan'] = self.masked_pan
+        if self.token_id is not None:
+            dictionary['tokenId'] = self.token_id
+        return dictionary
+
+    def from_dictionary(self, dictionary: dict) -> 'TokenInfo':
+        super(TokenInfo, self).from_dictionary(dictionary)
+        if 'expiryDate' in dictionary:
+            self.expiry_date = dictionary['expiryDate']
+        if 'isTemporary' in dictionary:
+            self.is_temporary = dictionary['isTemporary']
+        if 'maskedPan' in dictionary:
+            self.masked_pan = dictionary['maskedPan']
+        if 'tokenId' in dictionary:
+            self.token_id = dictionary['tokenId']
+        return self

{onlinepayments_sdk_python3-8.0.0 → onlinepayments_sdk_python3-8.1.0}/onlinepayments/sdk/exception_factory.py

@@ -12,6 +12,7 @@ from .declined_payout_exception import DeclinedPayoutException
 from .declined_refund_exception import DeclinedRefundException
 from .idempotence_exception import IdempotenceException
 from .platform_exception import PlatformException
+from .problem_details_exception import ProblemDetailsException
 from .reference_exception import ReferenceException
 from .validation_exception import ValidationException
 
@@ -19,6 +20,7 @@ from onlinepayments.sdk.domain.api_error import APIError
 from onlinepayments.sdk.domain.error_response import ErrorResponse
 from onlinepayments.sdk.domain.payment_error_response import PaymentErrorResponse
 from onlinepayments.sdk.domain.payout_error_response import PayoutErrorResponse
+from onlinepayments.sdk.domain.problem_details_response import ProblemDetailsResponse
 from onlinepayments.sdk.domain.refund_error_response import RefundErrorResponse
 
 
@@ -57,6 +59,10 @@ def create_exception(status_code: int, body: str, error_object: Any, context: Op
                                            response_body=body,
                                            response=error_object)
         return create_exception_from_response_fields(error_object.error_id, error_object.errors)
+    if isinstance(error_object, ProblemDetailsResponse):
+        return ProblemDetailsException(status_code=status_code,
+                                       response_body=body,
+                                       response=error_object)
     if not isinstance(error_object, ErrorResponse):
         raise ValueError("Unsupported error object encountered: {}".format(error_object.__class__.__name__))