Source code for worldline.connect.sdk.v1.domain.cancel_payment_response
# -*- coding: utf-8 -*-
#
# This class was auto-generated from the API references found at
# https://apireference.connect.worldline-solutions.com/
#
from typing import Optional
from worldline.connect.sdk.domain.data_object import DataObject
from worldline.connect.sdk.v1.domain.cancel_payment_card_payment_method_specific_output import CancelPaymentCardPaymentMethodSpecificOutput
from worldline.connect.sdk.v1.domain.cancel_payment_mobile_payment_method_specific_output import CancelPaymentMobilePaymentMethodSpecificOutput
from worldline.connect.sdk.v1.domain.payment import Payment
[docs]
class CancelPaymentResponse(DataObject):
"""
| Response to the cancelation of a payment
"""
__card_payment_method_specific_output: Optional[CancelPaymentCardPaymentMethodSpecificOutput] = None
__mobile_payment_method_specific_output: Optional[CancelPaymentMobilePaymentMethodSpecificOutput] = None
__payment: Optional[Payment] = None
@property
def card_payment_method_specific_output(self) -> Optional[CancelPaymentCardPaymentMethodSpecificOutput]:
"""
| Object that holds specific information on cancelled card payments
Type: :class:`worldline.connect.sdk.v1.domain.cancel_payment_card_payment_method_specific_output.CancelPaymentCardPaymentMethodSpecificOutput`
"""
return self.__card_payment_method_specific_output
@card_payment_method_specific_output.setter
def card_payment_method_specific_output(self, value: Optional[CancelPaymentCardPaymentMethodSpecificOutput]) -> None:
self.__card_payment_method_specific_output = value
@property
def mobile_payment_method_specific_output(self) -> Optional[CancelPaymentMobilePaymentMethodSpecificOutput]:
"""
| Object that holds specific information on cancelled mobile payments
Type: :class:`worldline.connect.sdk.v1.domain.cancel_payment_mobile_payment_method_specific_output.CancelPaymentMobilePaymentMethodSpecificOutput`
"""
return self.__mobile_payment_method_specific_output
@mobile_payment_method_specific_output.setter
def mobile_payment_method_specific_output(self, value: Optional[CancelPaymentMobilePaymentMethodSpecificOutput]) -> None:
self.__mobile_payment_method_specific_output = value
@property
def payment(self) -> Optional[Payment]:
"""
| Object that holds the payment related properties
Type: :class:`worldline.connect.sdk.v1.domain.payment.Payment`
"""
return self.__payment
@payment.setter
def payment(self, value: Optional[Payment]) -> None:
self.__payment = value
[docs]
def to_dictionary(self) -> dict:
dictionary = super(CancelPaymentResponse, self).to_dictionary()
if self.card_payment_method_specific_output is not None:
dictionary['cardPaymentMethodSpecificOutput'] = self.card_payment_method_specific_output.to_dictionary()
if self.mobile_payment_method_specific_output is not None:
dictionary['mobilePaymentMethodSpecificOutput'] = self.mobile_payment_method_specific_output.to_dictionary()
if self.payment is not None:
dictionary['payment'] = self.payment.to_dictionary()
return dictionary
[docs]
def from_dictionary(self, dictionary: dict) -> 'CancelPaymentResponse':
super(CancelPaymentResponse, self).from_dictionary(dictionary)
if 'cardPaymentMethodSpecificOutput' in dictionary:
if not isinstance(dictionary['cardPaymentMethodSpecificOutput'], dict):
raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['cardPaymentMethodSpecificOutput']))
value = CancelPaymentCardPaymentMethodSpecificOutput()
self.card_payment_method_specific_output = value.from_dictionary(dictionary['cardPaymentMethodSpecificOutput'])
if 'mobilePaymentMethodSpecificOutput' in dictionary:
if not isinstance(dictionary['mobilePaymentMethodSpecificOutput'], dict):
raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['mobilePaymentMethodSpecificOutput']))
value = CancelPaymentMobilePaymentMethodSpecificOutput()
self.mobile_payment_method_specific_output = value.from_dictionary(dictionary['mobilePaymentMethodSpecificOutput'])
if 'payment' in dictionary:
if not isinstance(dictionary['payment'], dict):
raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['payment']))
value = Payment()
self.payment = value.from_dictionary(dictionary['payment'])
return self