ask_sdk_model.interfaces.amazonpay.model.response package

Submodules

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_sdk_model.interfaces.amazonpay.model.response.authorization_details module

class ask_sdk_model.interfaces.amazonpay.model.response.authorization_details.AuthorizationDetails(amazon_authorization_id=None, authorization_reference_id=None, seller_authorization_note=None, authorization_amount=None, captured_amount=None, authorization_fee=None, id_list=None, creation_timestamp=None, expiration_timestamp=None, authorization_status=None, soft_decline=None, capture_now=None, soft_descriptor=None, authorization_billing_address=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details.AuthorizationDetails

This object encapsulates details about an Authorization object including the status, amount captured and fee charged.

Parameters:

• amazon_authorization_id ((optional) str) – This is AmazonPay generated identifier for this authorization transaction.
• authorization_reference_id ((optional) str) – This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
• seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
• authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.response.price.Price) –
• captured_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.response.price.Price) –
• authorization_fee ((optional) ask_sdk_model.interfaces.amazonpay.model.response.price.Price) –
• id_list ((optional) list[str]) – list of AmazonCaptureId identifiers that have been requested on this Authorization object.
• creation_timestamp ((optional) datetime) – This is the time at which the authorization was created.
• expiration_timestamp ((optional) datetime) – This is the time at which the authorization expires.
• authorization_status ((optional) ask_sdk_model.interfaces.amazonpay.model.response.authorization_status.AuthorizationStatus) –
• soft_decline ((optional) bool) – This indicates whether an authorization resulted in a soft decline.
• capture_now ((optional) bool) – This indicates whether a direct capture against the payment contract was specified.
• soft_descriptor ((optional) str) – This is the description to be shown on the buyer's payment instrument statement if AuthorizeAndCapture was chosen.
• authorization_billing_address ((optional) ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination) –

attribute_map = {'amazon_authorization_id': 'amazonAuthorizationId', 'authorization_amount': 'authorizationAmount', 'authorization_billing_address': 'authorizationBillingAddress', 'authorization_fee': 'authorizationFee', 'authorization_reference_id': 'authorizationReferenceId', 'authorization_status': 'authorizationStatus', 'capture_now': 'captureNow', 'captured_amount': 'capturedAmount', 'creation_timestamp': 'creationTimestamp', 'expiration_timestamp': 'expirationTimestamp', 'id_list': 'idList', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_decline': 'softDecline', 'soft_descriptor': 'softDescriptor'}

deserialized_types = {'amazon_authorization_id': 'str', 'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.response.price.Price', 'authorization_billing_address': 'ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination', 'authorization_fee': 'ask_sdk_model.interfaces.amazonpay.model.response.price.Price', 'authorization_reference_id': 'str', 'authorization_status': 'ask_sdk_model.interfaces.amazonpay.model.response.authorization_status.AuthorizationStatus', 'capture_now': 'bool', 'captured_amount': 'ask_sdk_model.interfaces.amazonpay.model.response.price.Price', 'creation_timestamp': 'datetime', 'expiration_timestamp': 'datetime', 'id_list': 'list[str]', 'seller_authorization_note': 'str', 'soft_decline': 'bool', 'soft_descriptor': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.authorization_status module

class ask_sdk_model.interfaces.amazonpay.model.response.authorization_status.AuthorizationStatus(state=None, reason_code=None, reason_description=None, last_update_timestamp=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus

Indicates the current status of an Authorization object, a Capture object, or a Refund object.

Parameters:

• state ((optional) ask_sdk_model.interfaces.amazonpay.model.response.state.State) –
• reason_code ((optional) str) – The reason that the Authorization object, Capture object, or Refund object is in the current state. For more information, see - https://pay.amazon.com/us/developer/documentation/apireference/201752950
• reason_description ((optional) str) – Reason desciption corresponding to the reason code
• last_update_timestamp ((optional) datetime) – A timestamp that indicates the time when the authorization, capture, or refund state was last updated. In ISO 8601 format

attribute_map = {'last_update_timestamp': 'lastUpdateTimestamp', 'reason_code': 'reasonCode', 'reason_description': 'reasonDescription', 'state': 'state'}

deserialized_types = {'last_update_timestamp': 'datetime', 'reason_code': 'str', 'reason_description': 'str', 'state': 'ask_sdk_model.interfaces.amazonpay.model.response.state.State'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.billing_agreement_details module

class ask_sdk_model.interfaces.amazonpay.model.response.billing_agreement_details.BillingAgreementDetails(billing_agreement_id=None, creation_timestamp=None, destination=None, checkout_language=None, release_environment=None, billing_agreement_status=None, billing_address=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails

The result attributes from successful SetupAmazonPay call.

Parameters:

• billing_agreement_id ((optional) str) – Billing agreement id which can be used for one time and recurring purchases
• creation_timestamp ((optional) datetime) – Time at which billing agreement details created.
• destination ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination) – The default shipping address of the buyer. Returned if needAmazonShippingAddress is set to true.
• checkout_language ((optional) str) – Merchant's preferred language of checkout.
• release_environment ((optional) ask_sdk_model.interfaces.amazonpay.model.response.release_environment.ReleaseEnvironment) –
• billing_agreement_status ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus) –
• billing_address ((optional) ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination) – The Billing Address of the payment instrument associated with Billing Agreement.

attribute_map = {'billing_address': 'billingAddress', 'billing_agreement_id': 'billingAgreementId', 'billing_agreement_status': 'billingAgreementStatus', 'checkout_language': 'checkoutLanguage', 'creation_timestamp': 'creationTimestamp', 'destination': 'destination', 'release_environment': 'releaseEnvironment'}

deserialized_types = {'billing_address': 'ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination', 'billing_agreement_id': 'str', 'billing_agreement_status': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus', 'checkout_language': 'str', 'creation_timestamp': 'datetime', 'destination': 'ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination', 'release_environment': 'ask_sdk_model.interfaces.amazonpay.model.response.release_environment.ReleaseEnvironment'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.destination module

class ask_sdk_model.interfaces.amazonpay.model.response.destination.Destination(name=None, company_name=None, address_line1=None, address_line2=None, address_line3=None, city=None, district_or_county=None, state_or_region=None, postal_code=None, country_code=None, phone=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination

Parameters:

• name ((optional) str) – The name or business name
• company_name ((optional) str) – The company name
• address_line1 ((optional) str) – The first line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• address_line2 ((optional) str) – The second line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• address_line3 ((optional) str) – The third line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
• city ((optional) str) – The city
• district_or_county ((optional) str) – The district or County
• state_or_region ((optional) str) – The state or region. This element is free text and can be either a 2-character code, fully spelled out, or abbreviated. Required. Note :- This response element is returned only in the U.S.
• postal_code ((optional) str) – The postal code.
• country_code ((optional) str) – The country code, in ISO 3166 format
• phone ((optional) str) – The phone number

attribute_map = {'address_line1': 'addressLine1', 'address_line2': 'addressLine2', 'address_line3': 'addressLine3', 'city': 'city', 'company_name': 'companyName', 'country_code': 'countryCode', 'district_or_county': 'districtOrCounty', 'name': 'name', 'phone': 'phone', 'postal_code': 'postalCode', 'state_or_region': 'stateOrRegion'}

deserialized_types = {'address_line1': 'str', 'address_line2': 'str', 'address_line3': 'str', 'city': 'str', 'company_name': 'str', 'country_code': 'str', 'district_or_county': 'str', 'name': 'str', 'phone': 'str', 'postal_code': 'str', 'state_or_region': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.price module

class ask_sdk_model.interfaces.amazonpay.model.response.price.Price(amount=None, currency_code=None)

Bases: ask_sdk_model.interfaces.amazonpay.model.v1.price.Price

This response object specifies amount and currency authorized/captured.

Parameters:

• amount ((optional) str) – Amount authorized/captured.
• currency_code ((optional) str) – Currency code for the amount.

attribute_map = {'amount': 'amount', 'currency_code': 'currencyCode'}

deserialized_types = {'amount': 'str', 'currency_code': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.release_environment module

class ask_sdk_model.interfaces.amazonpay.model.response.release_environment.ReleaseEnvironment

Bases: enum.Enum

Indicates if the contract is for a Live (Production) or Sandbox environment.

Allowed enum values: [LIVE, SANDBOX]

LIVE = 'LIVE'

SANDBOX = 'SANDBOX'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.response.state module

class ask_sdk_model.interfaces.amazonpay.model.response.state.State

Bases: enum.Enum

Indicates the state that the Authorization object is in. For more information see “Authorization states and reason codes” under “States and reason codes” section in Amazon Pay API Reference Guide.

Allowed enum values: [Pending, Open, Declined, Closed]

Closed = 'Closed'

Declined = 'Declined'

Open = 'Open'

Pending = 'Pending'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model