ask_sdk_model.interfaces.amazonpay.model.request 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.request.authorize_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes(authorization_reference_id=None, authorization_amount=None, transaction_timeout=None, seller_authorization_note=None, soft_descriptor=None, version=None)¶

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This is an object to set the attributes specified in the AuthorizeAttributes table. See the “AuthorizationDetails” section of the Amazon Pay API reference guide for details about this object.

Parameters:

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.
authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.request.price.Price) –
transaction_timeout ((optional) int) – The maximum number of minutes allocated for the Authorize operation call to be processed. After this the authorization is automatically declined and you cannot capture funds against the authorization. The default value for Alexa transactions is 0. In order to speed up checkout time for voice users we recommend to not change this value.
seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
soft_descriptor ((optional) str) – The description to be shown on the user's payment instrument statement if AuthorizeAndCapture is chosen. Format of soft descriptor sent to the payment processor is "AMZ* <soft descriptor specified here>". Default is "AMZ*<SELLER_NAME> amzn.com/ pmts WA". Maximum length can be 16 characters.
version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'authorization_amount': 'authorizationAmount', 'authorization_reference_id': 'authorizationReferenceId', 'object_type': '@type', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_descriptor': 'softDescriptor', 'transaction_timeout': 'transactionTimeout', 'version': '@version'}¶

deserialized_types = {'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'authorization_reference_id': 'str', 'object_type': 'str', 'seller_authorization_note': 'str', 'soft_descriptor': 'str', 'transaction_timeout': 'int', 'version': '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.request.base_amazon_pay_entity module¶

class ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity(object_type=None, version=None)¶

Bases: object

Parameters:	object_type ((optional) str) – version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

Note

This is an abstract class. Use the following mapping, to figure out the model class to be instantiated, that sets @type variable.

SellerBillingAgreementAttributes: ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes,

Price: ask_sdk_model.interfaces.amazonpay.model.request.price.Price,

ChargeAmazonPayRequest: ask_sdk_model.interfaces.amazonpay.request.charge_amazon_pay_request.ChargeAmazonPayRequest,

BillingAgreementAttributes: ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes,

SellerOrderAttributes: ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes,

ProviderAttributes: ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes,

AuthorizeAttributes: ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes,

SetupAmazonPayRequest: ask_sdk_model.interfaces.amazonpay.request.setup_amazon_pay_request.SetupAmazonPayRequest,

ProviderCredit: ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit

attribute_map = {'object_type': '@type', 'version': '@version'}¶

deserialized_types = {'object_type': 'str', 'version': 'str'}¶

discriminator_value_class_map = {'AuthorizeAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.authorize_attributes.AuthorizeAttributes', 'BillingAgreementAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes', 'ChargeAmazonPayRequest': 'ask_sdk_model.interfaces.amazonpay.request.charge_amazon_pay_request.ChargeAmazonPayRequest', 'Price': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'ProviderAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes', 'ProviderCredit': 'ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit', 'SellerBillingAgreementAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes', 'SellerOrderAttributes': 'ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes', 'SetupAmazonPayRequest': 'ask_sdk_model.interfaces.amazonpay.request.setup_amazon_pay_request.SetupAmazonPayRequest'}¶

classmethod get_real_child_model(data)¶: Returns the real base class specified by the discriminator

json_discriminator_key = '@type'¶

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.request.billing_agreement_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_attributes.BillingAgreementAttributes(platform_id=None, seller_note=None, seller_billing_agreement_attributes=None, billing_agreement_type=None, subscription_amount=None, version=None)¶

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

The merchant can choose to set the attributes specified in the BillingAgreementAttributes.

Parameters:

platform_id ((optional) str) – Represents the SellerId of the Solution Provider that developed the eCommerce platform. This value is only used by Solution Providers, for whom it is required. It should not be provided by merchants creating their own custom integration. Do not specify the SellerId of the merchant for this request parameter. If you are a merchant, do not enter a PlatformId.
seller_note ((optional) str) – Represents a description of the billing agreement that is displayed in emails to the buyer.
seller_billing_agreement_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes) –
billing_agreement_type ((optional) ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_type.BillingAgreementType) –
subscription_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.request.price.Price) –
version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'billing_agreement_type': 'billingAgreementType', 'object_type': '@type', 'platform_id': 'platformId', 'seller_billing_agreement_attributes': 'sellerBillingAgreementAttributes', 'seller_note': 'sellerNote', 'subscription_amount': 'subscriptionAmount', 'version': '@version'}¶

deserialized_types = {'billing_agreement_type': 'ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_type.BillingAgreementType', 'object_type': 'str', 'platform_id': 'str', 'seller_billing_agreement_attributes': 'ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes', 'seller_note': 'str', 'subscription_amount': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'version': '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.request.billing_agreement_type module¶

class ask_sdk_model.interfaces.amazonpay.model.request.billing_agreement_type.BillingAgreementType¶

Bases: enum.Enum

This is used to specify applicable billing agreement type. * CustomerInitiatedTransaction – customer is present at the time of processing payment for the order. * MerchantInitiatedTransaction – customer is not present at the time of processing payment for the order.

Allowed enum values: [CustomerInitiatedTransaction, MerchantInitiatedTransaction]

CustomerInitiatedTransaction = 'CustomerInitiatedTransaction'¶

MerchantInitiatedTransaction = 'MerchantInitiatedTransaction'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.payment_action module¶

class ask_sdk_model.interfaces.amazonpay.model.request.payment_action.PaymentAction¶

Bases: enum.Enum

This is used to specify applicable payment action. * Authorize – you want to confirm the order and authorize a certain amount, but you do not want to capture at this time. * AuthorizeAndCapture – you want to confirm the order, authorize for the given amount, and capture the funds.

Allowed enum values: [Authorize, AuthorizeAndCapture]

Authorize = 'Authorize'¶

AuthorizeAndCapture = 'AuthorizeAndCapture'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.request.price module¶

class ask_sdk_model.interfaces.amazonpay.model.request.price.Price(amount=None, currency_code=None, version=None)¶

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This request object specifies amount and currency authorized/captured.

Parameters:	amount ((optional) str) – Amount authorized/captured. currency_code ((optional) str) – Currency code for the amount. version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'amount': 'amount', 'currency_code': 'currencyCode', 'object_type': '@type', 'version': '@version'}¶

deserialized_types = {'amount': 'str', 'currency_code': 'str', 'object_type': 'str', 'version': '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.request.provider_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.request.provider_attributes.ProviderAttributes(provider_id=None, provider_credit_list=None, version=None)¶

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This is required only for Ecommerce provider (Solution provider) use cases.

Parameters:	provider_id ((optional) str) – Solution provider ID. provider_credit_list ((optional) list[ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit]) – List of provider credit. version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'object_type': '@type', 'provider_credit_list': 'providerCreditList', 'provider_id': 'providerId', 'version': '@version'}¶

deserialized_types = {'object_type': 'str', 'provider_credit_list': 'list[ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit]', 'provider_id': 'str', 'version': '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.request.provider_credit module¶

class ask_sdk_model.interfaces.amazonpay.model.request.provider_credit.ProviderCredit(provider_id=None, credit=None, version=None)¶

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

Parameters:	provider_id ((optional) str) – This is required only for Ecommerce provider (Solution provider) use cases. credit ((optional) ask_sdk_model.interfaces.amazonpay.model.request.price.Price) – version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'credit': 'credit', 'object_type': '@type', 'provider_id': 'providerId', 'version': '@version'}¶

deserialized_types = {'credit': 'ask_sdk_model.interfaces.amazonpay.model.request.price.Price', 'object_type': 'str', 'provider_id': 'str', 'version': '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.request.seller_billing_agreement_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.request.seller_billing_agreement_attributes.SellerBillingAgreementAttributes(seller_billing_agreement_id=None, store_name=None, custom_information=None, version=None)¶

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

Provides more context about the billing agreement that is represented by this Billing Agreement object.

Parameters:

seller_billing_agreement_id ((optional) str) – The merchant-specified identifier of this billing agreement. At least one request parameter must be specified. Amazon recommends that you use only the following characters:- lowercase a-z, uppercase A-Z, numbers 0-9, dash (-), underscore (_).
store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
custom_information ((optional) str) – Any additional information that you wish to include with this billing agreement. At least one request parameter must be specified.
version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'custom_information': 'customInformation', 'object_type': '@type', 'seller_billing_agreement_id': 'sellerBillingAgreementId', 'store_name': 'storeName', 'version': '@version'}¶

deserialized_types = {'custom_information': 'str', 'object_type': 'str', 'seller_billing_agreement_id': 'str', 'store_name': 'str', 'version': '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.request.seller_order_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.request.seller_order_attributes.SellerOrderAttributes(seller_order_id=None, store_name=None, custom_information=None, seller_note=None, version=None)¶

Bases: ask_sdk_model.interfaces.amazonpay.model.request.base_amazon_pay_entity.BaseAmazonPayEntity

This object includes elements shown to buyers in emails and in their transaction history. See the “SellerOrderAttributes” section of the Amazon Pay API reference guide for details about this object.

Parameters:

seller_order_id ((optional) str) – The merchant-specified identifier of this order. This is shown to the buyer in their emails and transaction history on the Amazon Pay website.
store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
custom_information ((optional) str) – Any additional information that you want to include with this order reference.
seller_note ((optional) str) – This represents a description of the order that is displayed in emails to the buyer.
version ((optional) str) – Version of the Amazon Pay Entity. Can be 1 or greater.

attribute_map = {'custom_information': 'customInformation', 'object_type': '@type', 'seller_note': 'sellerNote', 'seller_order_id': 'sellerOrderId', 'store_name': 'storeName', 'version': '@version'}¶

deserialized_types = {'custom_information': 'str', 'object_type': 'str', 'seller_note': 'str', 'seller_order_id': 'str', 'store_name': 'str', 'version': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model