Source code for worldline.acquiring.sdk.v1.domain.api_account_verification_response
# -*- coding: utf-8 -*-
#
# This file was automatically generated.
#
from typing import Optional
from .api_references_for_responses import ApiReferencesForResponses
from .card_payment_data_for_response import CardPaymentDataForResponse
from worldline.acquiring.sdk.domain.data_object import DataObject
[docs]
class ApiAccountVerificationResponse(DataObject):
__authorization_code: Optional[str] = None
__card_payment_data: Optional[CardPaymentDataForResponse] = None
__operation_id: Optional[str] = None
__references: Optional[ApiReferencesForResponses] = None
__responder: Optional[str] = None
__response_code: Optional[str] = None
__response_code_category: Optional[str] = None
__response_code_description: Optional[str] = None
@property
def authorization_code(self) -> Optional[str]:
"""
| Authorization approval code
Type: str
"""
return self.__authorization_code
@authorization_code.setter
def authorization_code(self, value: Optional[str]) -> None:
self.__authorization_code = value
@property
def card_payment_data(self) -> Optional[CardPaymentDataForResponse]:
"""
Type: :class:`worldline.acquiring.sdk.v1.domain.card_payment_data_for_response.CardPaymentDataForResponse`
"""
return self.__card_payment_data
@card_payment_data.setter
def card_payment_data(self, value: Optional[CardPaymentDataForResponse]) -> None:
self.__card_payment_data = value
@property
def operation_id(self) -> Optional[str]:
"""
| A globally unique identifier of the operation, generated by you.
| We advise you to submit a UUID or an identifier composed of an arbitrary string and a UUID/URL-safe Base64 UUID (RFC 4648 ยง5).
| It's used to detect duplicate requests or to reference an operation in technical reversals.
Type: str
"""
return self.__operation_id
@operation_id.setter
def operation_id(self, value: Optional[str]) -> None:
self.__operation_id = value
@property
def references(self) -> Optional[ApiReferencesForResponses]:
"""
| A set of references returned in responses
Type: :class:`worldline.acquiring.sdk.v1.domain.api_references_for_responses.ApiReferencesForResponses`
"""
return self.__references
@references.setter
def references(self, value: Optional[ApiReferencesForResponses]) -> None:
self.__references = value
@property
def responder(self) -> Optional[str]:
"""
| The party that originated the response
Type: str
"""
return self.__responder
@responder.setter
def responder(self, value: Optional[str]) -> None:
self.__responder = value
@property
def response_code(self) -> Optional[str]:
"""
| Numeric response code, e.g. 0000, 0005
Type: str
"""
return self.__response_code
@response_code.setter
def response_code(self, value: Optional[str]) -> None:
self.__response_code = value
@property
def response_code_category(self) -> Optional[str]:
"""
| Category of response code.
Type: str
"""
return self.__response_code_category
@response_code_category.setter
def response_code_category(self, value: Optional[str]) -> None:
self.__response_code_category = value
@property
def response_code_description(self) -> Optional[str]:
"""
| Description of the response code
Type: str
"""
return self.__response_code_description
@response_code_description.setter
def response_code_description(self, value: Optional[str]) -> None:
self.__response_code_description = value
[docs]
def to_dictionary(self) -> dict:
dictionary = super(ApiAccountVerificationResponse, self).to_dictionary()
if self.authorization_code is not None:
dictionary['authorizationCode'] = self.authorization_code
if self.card_payment_data is not None:
dictionary['cardPaymentData'] = self.card_payment_data.to_dictionary()
if self.operation_id is not None:
dictionary['operationId'] = self.operation_id
if self.references is not None:
dictionary['references'] = self.references.to_dictionary()
if self.responder is not None:
dictionary['responder'] = self.responder
if self.response_code is not None:
dictionary['responseCode'] = self.response_code
if self.response_code_category is not None:
dictionary['responseCodeCategory'] = self.response_code_category
if self.response_code_description is not None:
dictionary['responseCodeDescription'] = self.response_code_description
return dictionary
[docs]
def from_dictionary(self, dictionary: dict) -> 'ApiAccountVerificationResponse':
super(ApiAccountVerificationResponse, self).from_dictionary(dictionary)
if 'authorizationCode' in dictionary:
self.authorization_code = dictionary['authorizationCode']
if 'cardPaymentData' in dictionary:
if not isinstance(dictionary['cardPaymentData'], dict):
raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['cardPaymentData']))
value = CardPaymentDataForResponse()
self.card_payment_data = value.from_dictionary(dictionary['cardPaymentData'])
if 'operationId' in dictionary:
self.operation_id = dictionary['operationId']
if 'references' in dictionary:
if not isinstance(dictionary['references'], dict):
raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['references']))
value = ApiReferencesForResponses()
self.references = value.from_dictionary(dictionary['references'])
if 'responder' in dictionary:
self.responder = dictionary['responder']
if 'responseCode' in dictionary:
self.response_code = dictionary['responseCode']
if 'responseCodeCategory' in dictionary:
self.response_code_category = dictionary['responseCodeCategory']
if 'responseCodeDescription' in dictionary:
self.response_code_description = dictionary['responseCodeDescription']
return self