ask_smapi_model.v1.isp 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_smapi_model.v1.isp.associated_skill_response module¶

class ask_smapi_model.v1.isp.associated_skill_response.AssociatedSkillResponse(associated_skill_ids=None, links=None, is_truncated=None, next_token=None)¶

Bases: object

In-skill product skill association details.

Parameters:	associated_skill_ids ((optional) list[str]) – List of skill IDs that correspond to the skills associated with the in-skill product. The associations are stage specific. A live association is created through successful skill certification. links ((optional) ask_smapi_model.v1.links.Links) – is_truncated ((optional) bool) – next_token ((optional) str) –

attribute_map = {'associated_skill_ids': 'associatedSkillIds', 'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken'}¶

deserialized_types = {'associated_skill_ids': 'list[str]', 'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.create_in_skill_product_request module¶

class ask_smapi_model.v1.isp.create_in_skill_product_request.CreateInSkillProductRequest(vendor_id=None, in_skill_product_definition=None)¶

Bases: object

Parameters:	vendor_id ((optional) str) – ID of the vendor owning the in-skill product. in_skill_product_definition ((optional) ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition) –

attribute_map = {'in_skill_product_definition': 'inSkillProductDefinition', 'vendor_id': 'vendorId'}¶

deserialized_types = {'in_skill_product_definition': 'ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition', 'vendor_id': 'str'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.currency module¶

class ask_smapi_model.v1.isp.currency.Currency¶

Bases: enum.Enum

Currency to use for in-skill product.

Allowed enum values: [USD, GBP, EUR, JPY]

EUR = 'EUR'¶

GBP = 'GBP'¶

JPY = 'JPY'¶

USD = 'USD'¶

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

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

ask_smapi_model.v1.isp.custom_product_prompts module¶

class ask_smapi_model.v1.isp.custom_product_prompts.CustomProductPrompts(purchase_prompt_description=None, bought_confirmation_prompt=None)¶

Bases: object

Custom prompts used for in-skill product purchasing options. Supports Speech Synthesis Markup Language (SSML), which can be used to control pronunciation, intonation, timing, and emotion.

Parameters:	purchase_prompt_description ((optional) str) – Description of in-skill product heard before customer is prompted for purchase. bought_confirmation_prompt ((optional) str) – Confirmation of in-skill product purchase.

attribute_map = {'bought_confirmation_prompt': 'boughtConfirmationPrompt', 'purchase_prompt_description': 'purchasePromptDescription'}¶

deserialized_types = {'bought_confirmation_prompt': 'str', 'purchase_prompt_description': 'str'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.distribution_countries module¶

class ask_smapi_model.v1.isp.distribution_countries.DistributionCountries¶

Bases: enum.Enum

Allowed enum values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SR, SJ, SZ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

AD = 'AD'¶

AE = 'AE'¶

AF = 'AF'¶

AG = 'AG'¶

AI = 'AI'¶

AL = 'AL'¶

AM = 'AM'¶

AN = 'AN'¶

AO = 'AO'¶

AQ = 'AQ'¶

AR = 'AR'¶

AS = 'AS'¶

AT = 'AT'¶

AU = 'AU'¶

AW = 'AW'¶

AX = 'AX'¶

AZ = 'AZ'¶

BA = 'BA'¶

BB = 'BB'¶

BD = 'BD'¶

BE = 'BE'¶

BF = 'BF'¶

BG = 'BG'¶

BH = 'BH'¶

BI = 'BI'¶

BJ = 'BJ'¶

BL = 'BL'¶

BM = 'BM'¶

BN = 'BN'¶

BO = 'BO'¶

BR = 'BR'¶

BS = 'BS'¶

BT = 'BT'¶

BV = 'BV'¶

BW = 'BW'¶

BY = 'BY'¶

BZ = 'BZ'¶

CA = 'CA'¶

CC = 'CC'¶

CD = 'CD'¶

CF = 'CF'¶

CG = 'CG'¶

CH = 'CH'¶

CI = 'CI'¶

CK = 'CK'¶

CL = 'CL'¶

CM = 'CM'¶

CN = 'CN'¶

CO = 'CO'¶

CR = 'CR'¶

CV = 'CV'¶

CX = 'CX'¶

CY = 'CY'¶

CZ = 'CZ'¶

DE = 'DE'¶

DJ = 'DJ'¶

DK = 'DK'¶

DM = 'DM'¶

DO = 'DO'¶

DZ = 'DZ'¶

EC = 'EC'¶

EE = 'EE'¶

EG = 'EG'¶

EH = 'EH'¶

ER = 'ER'¶

ES = 'ES'¶

ET = 'ET'¶

FI = 'FI'¶

FJ = 'FJ'¶

FK = 'FK'¶

FM = 'FM'¶

FO = 'FO'¶

FR = 'FR'¶

GA = 'GA'¶

GB = 'GB'¶

GD = 'GD'¶

GE = 'GE'¶

GF = 'GF'¶

GG = 'GG'¶

GH = 'GH'¶

GI = 'GI'¶

GL = 'GL'¶

GM = 'GM'¶

GN = 'GN'¶

GP = 'GP'¶

GQ = 'GQ'¶

GR = 'GR'¶

GS = 'GS'¶

GT = 'GT'¶

GU = 'GU'¶

GW = 'GW'¶

GY = 'GY'¶

HK = 'HK'¶

HM = 'HM'¶

HN = 'HN'¶

HR = 'HR'¶

HT = 'HT'¶

HU = 'HU'¶

ID = 'ID'¶

IE = 'IE'¶

IL = 'IL'¶

IM = 'IM'¶

IN = 'IN'¶

IO = 'IO'¶

IQ = 'IQ'¶

IS = 'IS'¶

IT = 'IT'¶

JE = 'JE'¶

JM = 'JM'¶

JO = 'JO'¶

JP = 'JP'¶

KE = 'KE'¶

KG = 'KG'¶

KH = 'KH'¶

KI = 'KI'¶

KM = 'KM'¶

KN = 'KN'¶

KR = 'KR'¶

KW = 'KW'¶

KY = 'KY'¶

KZ = 'KZ'¶

LA = 'LA'¶

LB = 'LB'¶

LC = 'LC'¶

LI = 'LI'¶

LK = 'LK'¶

LR = 'LR'¶

LS = 'LS'¶

LT = 'LT'¶

LU = 'LU'¶

LV = 'LV'¶

LY = 'LY'¶

MA = 'MA'¶

MC = 'MC'¶

MD = 'MD'¶

ME = 'ME'¶

MF = 'MF'¶

MG = 'MG'¶

MH = 'MH'¶

MK = 'MK'¶

ML = 'ML'¶

MM = 'MM'¶

MN = 'MN'¶

MO = 'MO'¶

MP = 'MP'¶

MQ = 'MQ'¶

MR = 'MR'¶

MS = 'MS'¶

MT = 'MT'¶

MU = 'MU'¶

MV = 'MV'¶

MW = 'MW'¶

MX = 'MX'¶

MY = 'MY'¶

MZ = 'MZ'¶

NA = 'NA'¶

NC = 'NC'¶

NE = 'NE'¶

NF = 'NF'¶

NG = 'NG'¶

NI = 'NI'¶

NL = 'NL'¶

NO = 'NO'¶

NP = 'NP'¶

NR = 'NR'¶

NU = 'NU'¶

NZ = 'NZ'¶

OM = 'OM'¶

PA = 'PA'¶

PE = 'PE'¶

PF = 'PF'¶

PG = 'PG'¶

PH = 'PH'¶

PK = 'PK'¶

PL = 'PL'¶

PM = 'PM'¶

PN = 'PN'¶

PR = 'PR'¶

PS = 'PS'¶

PT = 'PT'¶

PW = 'PW'¶

PY = 'PY'¶

QA = 'QA'¶

RE = 'RE'¶

RO = 'RO'¶

RS = 'RS'¶

RU = 'RU'¶

RW = 'RW'¶

SA = 'SA'¶

SB = 'SB'¶

SC = 'SC'¶

SE = 'SE'¶

SG = 'SG'¶

SH = 'SH'¶

SI = 'SI'¶

SJ = 'SJ'¶

SK = 'SK'¶

SL = 'SL'¶

SM = 'SM'¶

SN = 'SN'¶

SO = 'SO'¶

SR = 'SR'¶

ST = 'ST'¶

SV = 'SV'¶

SZ = 'SZ'¶

TC = 'TC'¶

TD = 'TD'¶

TF = 'TF'¶

TG = 'TG'¶

TH = 'TH'¶

TJ = 'TJ'¶

TK = 'TK'¶

TL = 'TL'¶

TM = 'TM'¶

TN = 'TN'¶

TO = 'TO'¶

TR = 'TR'¶

TT = 'TT'¶

TV = 'TV'¶

TW = 'TW'¶

TZ = 'TZ'¶

UA = 'UA'¶

UG = 'UG'¶

UM = 'UM'¶

US = 'US'¶

UY = 'UY'¶

UZ = 'UZ'¶

VA = 'VA'¶

VC = 'VC'¶

VE = 'VE'¶

VG = 'VG'¶

VI = 'VI'¶

VN = 'VN'¶

VU = 'VU'¶

WF = 'WF'¶

WS = 'WS'¶

YE = 'YE'¶

YT = 'YT'¶

ZA = 'ZA'¶

ZM = 'ZM'¶

ZW = 'ZW'¶

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

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

ask_smapi_model.v1.isp.editable_state module¶

class ask_smapi_model.v1.isp.editable_state.EditableState¶

Bases: enum.Enum

Whether or not the in-skill product is editable.

Allowed enum values: [EDITABLE, NOT_EDITABLE]

EDITABLE = 'EDITABLE'¶

NOT_EDITABLE = 'NOT_EDITABLE'¶

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

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

ask_smapi_model.v1.isp.in_skill_product_definition module¶

class ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition(version=None, object_type=None, reference_name=None, purchasable_state=None, subscription_information=None, publishing_information=None, privacy_and_compliance=None, testing_instructions=None)¶

Bases: object

Defines the structure for an in-skill product.

Parameters:

version ((optional) str) – Version of in-skill product definition.
object_type ((optional) ask_smapi_model.v1.isp.product_type.ProductType) –
reference_name ((optional) str) – Developer selected in-skill product name. This is for developer reference only, it can be used to filter query results to identify a matching in-skill product.
purchasable_state ((optional) ask_smapi_model.v1.isp.purchasable_state.PurchasableState) –
subscription_information ((optional) ask_smapi_model.v1.isp.subscription_information.SubscriptionInformation) –
publishing_information ((optional) ask_smapi_model.v1.isp.publishing_information.PublishingInformation) –
privacy_and_compliance ((optional) ask_smapi_model.v1.isp.privacy_and_compliance.PrivacyAndCompliance) –
testing_instructions ((optional) str) – Special instructions provided by the developer to test the in-skill product.

attribute_map = {'object_type': 'type', 'privacy_and_compliance': 'privacyAndCompliance', 'publishing_information': 'publishingInformation', 'purchasable_state': 'purchasableState', 'reference_name': 'referenceName', 'subscription_information': 'subscriptionInformation', 'testing_instructions': 'testingInstructions', 'version': 'version'}¶

deserialized_types = {'object_type': 'ask_smapi_model.v1.isp.product_type.ProductType', 'privacy_and_compliance': 'ask_smapi_model.v1.isp.privacy_and_compliance.PrivacyAndCompliance', 'publishing_information': 'ask_smapi_model.v1.isp.publishing_information.PublishingInformation', 'purchasable_state': 'ask_smapi_model.v1.isp.purchasable_state.PurchasableState', 'reference_name': 'str', 'subscription_information': 'ask_smapi_model.v1.isp.subscription_information.SubscriptionInformation', 'testing_instructions': '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_smapi_model.v1.isp.in_skill_product_definition_response module¶

class ask_smapi_model.v1.isp.in_skill_product_definition_response.InSkillProductDefinitionResponse(in_skill_product_definition=None)¶

Bases: object

Defines In-skill product response.

Parameters:	in_skill_product_definition ((optional) ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition) –

attribute_map = {'in_skill_product_definition': 'inSkillProductDefinition'}¶

deserialized_types = {'in_skill_product_definition': 'ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.in_skill_product_summary module¶

class ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary(object_type=None, product_id=None, reference_name=None, last_updated=None, name_by_locale=None, status=None, stage=None, editable_state=None, purchasable_state=None, links=None, pricing=None)¶

Bases: object

Information about the in-skill product that is not editable.

Parameters:

object_type ((optional) ask_smapi_model.v1.isp.product_type.ProductType) –
product_id ((optional) str) – primary identifier of in-skill product.
reference_name ((optional) str) – Developer selected in-skill product name. This is for developer reference only, it can be used to filter query results to identify a matching in-skill product.
last_updated ((optional) datetime) – Date of last update.
name_by_locale ((optional) dict(str, str)) –
status ((optional) ask_smapi_model.v1.isp.status.Status) –
stage ((optional) ask_smapi_model.v1.isp.stage.Stage) –
editable_state ((optional) ask_smapi_model.v1.isp.editable_state.EditableState) –
purchasable_state ((optional) ask_smapi_model.v1.isp.purchasable_state.PurchasableState) –
links ((optional) ask_smapi_model.v1.isp.isp_summary_links.IspSummaryLinks) –
pricing ((optional) dict(str, ask_smapi_model.v1.isp.summary_marketplace_pricing.SummaryMarketplacePricing)) – In-skill product pricing information.

attribute_map = {'editable_state': 'editableState', 'last_updated': 'lastUpdated', 'links': '_links', 'name_by_locale': 'nameByLocale', 'object_type': 'type', 'pricing': 'pricing', 'product_id': 'productId', 'purchasable_state': 'purchasableState', 'reference_name': 'referenceName', 'stage': 'stage', 'status': 'status'}¶

deserialized_types = {'editable_state': 'ask_smapi_model.v1.isp.editable_state.EditableState', 'last_updated': 'datetime', 'links': 'ask_smapi_model.v1.isp.isp_summary_links.IspSummaryLinks', 'name_by_locale': 'dict(str, str)', 'object_type': 'ask_smapi_model.v1.isp.product_type.ProductType', 'pricing': 'dict(str, ask_smapi_model.v1.isp.summary_marketplace_pricing.SummaryMarketplacePricing)', 'product_id': 'str', 'purchasable_state': 'ask_smapi_model.v1.isp.purchasable_state.PurchasableState', 'reference_name': 'str', 'stage': 'ask_smapi_model.v1.isp.stage.Stage', 'status': 'ask_smapi_model.v1.isp.status.Status'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.in_skill_product_summary_response module¶

class ask_smapi_model.v1.isp.in_skill_product_summary_response.InSkillProductSummaryResponse(in_skill_product_summary=None)¶

Bases: object

In-skill product summary response.

Parameters:	in_skill_product_summary ((optional) ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary) –

attribute_map = {'in_skill_product_summary': 'inSkillProductSummary'}¶

deserialized_types = {'in_skill_product_summary': 'ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.isp_summary_links module¶

class ask_smapi_model.v1.isp.isp_summary_links.IspSummaryLinks(object_self=None)¶

Bases: object

Parameters:	object_self ((optional) ask_smapi_model.v1.link.Link) –

attribute_map = {'object_self': 'self'}¶

deserialized_types = {'object_self': 'ask_smapi_model.v1.link.Link'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.list_in_skill_product module¶

class ask_smapi_model.v1.isp.list_in_skill_product.ListInSkillProduct(links=None, in_skill_products=None, is_truncated=None, next_token=None)¶

Bases: object

List of in-skill products.

Parameters:	links ((optional) ask_smapi_model.v1.links.Links) – in_skill_products ((optional) list[ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary]) – Information for each in-skill product. is_truncated ((optional) bool) – next_token ((optional) str) –

attribute_map = {'in_skill_products': 'inSkillProducts', 'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken'}¶

deserialized_types = {'in_skill_products': 'list[ask_smapi_model.v1.isp.in_skill_product_summary.InSkillProductSummary]', 'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.list_in_skill_product_response module¶

class ask_smapi_model.v1.isp.list_in_skill_product_response.ListInSkillProductResponse(in_skill_product_summary_list=None)¶

Bases: object

List of in-skill product response.

Parameters:	in_skill_product_summary_list ((optional) ask_smapi_model.v1.isp.list_in_skill_product.ListInSkillProduct) –

attribute_map = {'in_skill_product_summary_list': 'inSkillProductSummaryList'}¶

deserialized_types = {'in_skill_product_summary_list': 'ask_smapi_model.v1.isp.list_in_skill_product.ListInSkillProduct'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.localized_privacy_and_compliance module¶

class ask_smapi_model.v1.isp.localized_privacy_and_compliance.LocalizedPrivacyAndCompliance(privacy_policy_url=None)¶

Bases: object

Defines the structure for localized privacy and compliance.

Parameters:	privacy_policy_url ((optional) str) – Link to the privacy policy that applies to this in-skill product.

attribute_map = {'privacy_policy_url': 'privacyPolicyUrl'}¶

deserialized_types = {'privacy_policy_url': 'str'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.localized_publishing_information module¶

class ask_smapi_model.v1.isp.localized_publishing_information.LocalizedPublishingInformation(name=None, small_icon_uri=None, large_icon_uri=None, summary=None, description=None, example_phrases=None, keywords=None, custom_product_prompts=None)¶

Bases: object

Defines the structure for locale specific publishing information in the in-skill product definition.

Parameters:

name ((optional) str) – Name of the in-skill product that is heard by customers and displayed in the Alexa app.
small_icon_uri ((optional) str) – Uri for the small icon image of the in-skill product.
large_icon_uri ((optional) str) – Uri for the large icon image of the in-skill product.
summary ((optional) str) – Short description of the in-skill product that displays on the in-skill product list page in the Alexa App.
description ((optional) str) – Description of the in-skill product's purpose and features, and how it works. Should describe any prerequisites like hardware or account requirements and detailed steps for the customer to get started. This description displays to customers on the in-skill product detail card in the Alexa app.
example_phrases ((optional) list[str]) – Example phrases appear on the in-skill product detail page and are the key utterances that customers can say to interact directly with the in-skill product.
keywords ((optional) list[str]) – Search terms that can be used to describe the in-skill product. This helps customers find an in-skill product.
custom_product_prompts ((optional) ask_smapi_model.v1.isp.custom_product_prompts.CustomProductPrompts) –

attribute_map = {'custom_product_prompts': 'customProductPrompts', 'description': 'description', 'example_phrases': 'examplePhrases', 'keywords': 'keywords', 'large_icon_uri': 'largeIconUri', 'name': 'name', 'small_icon_uri': 'smallIconUri', 'summary': 'summary'}¶

deserialized_types = {'custom_product_prompts': 'ask_smapi_model.v1.isp.custom_product_prompts.CustomProductPrompts', 'description': 'str', 'example_phrases': 'list[str]', 'keywords': 'list[str]', 'large_icon_uri': 'str', 'name': 'str', 'small_icon_uri': 'str', 'summary': 'str'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.marketplace_pricing module¶

class ask_smapi_model.v1.isp.marketplace_pricing.MarketplacePricing(release_date=None, default_price_listing=None)¶

Bases: object

In-skill product pricing information for a marketplace.

Parameters:	release_date ((optional) datetime) – Date when in-skill product is available to customers for both purchase and use. Prior to this date the in-skill product will appear unavailable to customers and will not be purchasable. default_price_listing ((optional) ask_smapi_model.v1.isp.price_listing.PriceListing) –

attribute_map = {'default_price_listing': 'defaultPriceListing', 'release_date': 'releaseDate'}¶

deserialized_types = {'default_price_listing': 'ask_smapi_model.v1.isp.price_listing.PriceListing', 'release_date': 'datetime'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.price_listing module¶

class ask_smapi_model.v1.isp.price_listing.PriceListing(price=None, currency=None)¶

Bases: object

Price listing information for in-skill product.

Parameters:	price ((optional) float) – Defines the price of an in-skill product. The list price should be your suggested price, not including any VAT or similar taxes. Taxes are included in the final price to end users. currency ((optional) ask_smapi_model.v1.isp.currency.Currency) –

attribute_map = {'currency': 'currency', 'price': 'price'}¶

deserialized_types = {'currency': 'ask_smapi_model.v1.isp.currency.Currency', 'price': 'float'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.privacy_and_compliance module¶

class ask_smapi_model.v1.isp.privacy_and_compliance.PrivacyAndCompliance(locales=None)¶

Bases: object

Defines the structure for privacy and compliance.

Parameters:	locales ((optional) dict(str, ask_smapi_model.v1.isp.localized_privacy_and_compliance.LocalizedPrivacyAndCompliance)) – Defines the structure for locale specific privacy and compliance.

attribute_map = {'locales': 'locales'}¶

deserialized_types = {'locales': 'dict(str, ask_smapi_model.v1.isp.localized_privacy_and_compliance.LocalizedPrivacyAndCompliance)'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.product_response module¶

class ask_smapi_model.v1.isp.product_response.ProductResponse(product_id=None)¶

Bases: object

Product ID information.

Parameters:	product_id ((optional) str) – ID of the in-skill product created.

attribute_map = {'product_id': 'productId'}¶

deserialized_types = {'product_id': 'str'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.product_type module¶

class ask_smapi_model.v1.isp.product_type.ProductType¶

Bases: enum.Enum

Type of in-skill product.

Allowed enum values: [SUBSCRIPTION, ENTITLEMENT, CONSUMABLE]

CONSUMABLE = 'CONSUMABLE'¶

ENTITLEMENT = 'ENTITLEMENT'¶

SUBSCRIPTION = 'SUBSCRIPTION'¶

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

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

ask_smapi_model.v1.isp.publishing_information module¶

class ask_smapi_model.v1.isp.publishing_information.PublishingInformation(locales=None, distribution_countries=None, pricing=None, tax_information=None)¶

Bases: object

Defines the structure for in-skill product publishing information.

Parameters:

locales ((optional) dict(str, ask_smapi_model.v1.isp.localized_publishing_information.LocalizedPublishingInformation)) – Defines the structure for locale specific publishing information for an in-skill product.
distribution_countries ((optional) list[ask_smapi_model.v1.isp.distribution_countries.DistributionCountries]) – List of countries where the in-skill product is available.
pricing ((optional) dict(str, ask_smapi_model.v1.isp.marketplace_pricing.MarketplacePricing)) – Defines the structure for in-skill product pricing.
tax_information ((optional) ask_smapi_model.v1.isp.tax_information.TaxInformation) –

attribute_map = {'distribution_countries': 'distributionCountries', 'locales': 'locales', 'pricing': 'pricing', 'tax_information': 'taxInformation'}¶

deserialized_types = {'distribution_countries': 'list[ask_smapi_model.v1.isp.distribution_countries.DistributionCountries]', 'locales': 'dict(str, ask_smapi_model.v1.isp.localized_publishing_information.LocalizedPublishingInformation)', 'pricing': 'dict(str, ask_smapi_model.v1.isp.marketplace_pricing.MarketplacePricing)', 'tax_information': 'ask_smapi_model.v1.isp.tax_information.TaxInformation'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.purchasable_state module¶

class ask_smapi_model.v1.isp.purchasable_state.PurchasableState¶

Bases: enum.Enum

Whether or not the in-skill product is purchasable by customers. A product that is not purchasable will prevent new customers from being prompted to purchase the product. Customers who already own the product will see no effect and continue to have access to the product features.

Allowed enum values: [PURCHASABLE, NOT_PURCHASABLE]

NOT_PURCHASABLE = 'NOT_PURCHASABLE'¶

PURCHASABLE = 'PURCHASABLE'¶

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

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

ask_smapi_model.v1.isp.stage module¶

class ask_smapi_model.v1.isp.stage.Stage¶

Bases: enum.Enum

Stage of in-skill product.

Allowed enum values: [development, live]

development = 'development'¶

live = 'live'¶

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

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

ask_smapi_model.v1.isp.status module¶

class ask_smapi_model.v1.isp.status.Status¶

Bases: enum.Enum

Current status of in-skill product.

Allowed enum values: [INCOMPLETE, COMPLETE, CERTIFICATION, PUBLISHED, SUPPRESSED]

CERTIFICATION = 'CERTIFICATION'¶

COMPLETE = 'COMPLETE'¶

INCOMPLETE = 'INCOMPLETE'¶

PUBLISHED = 'PUBLISHED'¶

SUPPRESSED = 'SUPPRESSED'¶

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

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

ask_smapi_model.v1.isp.subscription_information module¶

class ask_smapi_model.v1.isp.subscription_information.SubscriptionInformation(subscription_payment_frequency=None, subscription_trial_period_days=None)¶

Bases: object

Defines the structure for in-skill product subscription information.

Parameters:	subscription_payment_frequency ((optional) ask_smapi_model.v1.isp.subscription_payment_frequency.SubscriptionPaymentFrequency) – subscription_trial_period_days ((optional) int) – Days of free trial period for subscription. Max allowed is 365 days.

attribute_map = {'subscription_payment_frequency': 'subscriptionPaymentFrequency', 'subscription_trial_period_days': 'subscriptionTrialPeriodDays'}¶

deserialized_types = {'subscription_payment_frequency': 'ask_smapi_model.v1.isp.subscription_payment_frequency.SubscriptionPaymentFrequency', 'subscription_trial_period_days': 'int'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.subscription_payment_frequency module¶

class ask_smapi_model.v1.isp.subscription_payment_frequency.SubscriptionPaymentFrequency¶

Bases: enum.Enum

The frequency in which payments are collected for the subscription.

Allowed enum values: [MONTHLY, YEARLY]

MONTHLY = 'MONTHLY'¶

YEARLY = 'YEARLY'¶

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

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

ask_smapi_model.v1.isp.summary_marketplace_pricing module¶

class ask_smapi_model.v1.isp.summary_marketplace_pricing.SummaryMarketplacePricing(release_date=None, default_price_listing=None)¶

Bases: object

Localized in-skill product pricing information.

Parameters:	release_date ((optional) datetime) – Date when in-skill product is available to customers for both purchase and use. Prior to this date the in-skill product will appear unavailable to customers and will not be purchasable. default_price_listing ((optional) ask_smapi_model.v1.isp.summary_price_listing.SummaryPriceListing) –

attribute_map = {'default_price_listing': 'defaultPriceListing', 'release_date': 'releaseDate'}¶

deserialized_types = {'default_price_listing': 'ask_smapi_model.v1.isp.summary_price_listing.SummaryPriceListing', 'release_date': 'datetime'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.summary_price_listing module¶

class ask_smapi_model.v1.isp.summary_price_listing.SummaryPriceListing(price=None, prime_member_price=None, currency=None)¶

Bases: object

Price listing information for in-skill product.

Parameters:	price ((optional) float) – The price of an in-skill product. prime_member_price ((optional) float) – The prime price of an in-skill product. currency ((optional) ask_smapi_model.v1.isp.currency.Currency) –

attribute_map = {'currency': 'currency', 'price': 'price', 'prime_member_price': 'primeMemberPrice'}¶

deserialized_types = {'currency': 'ask_smapi_model.v1.isp.currency.Currency', 'price': 'float', 'prime_member_price': 'float'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.tax_information module¶

class ask_smapi_model.v1.isp.tax_information.TaxInformation(category=None)¶

Bases: object

Defines the structure for in-skill product tax information.

Parameters:	category ((optional) ask_smapi_model.v1.isp.tax_information_category.TaxInformationCategory) –

attribute_map = {'category': 'category'}¶

deserialized_types = {'category': 'ask_smapi_model.v1.isp.tax_information_category.TaxInformationCategory'}¶

supports_multiple_types = False¶

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

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

ask_smapi_model.v1.isp.tax_information_category module¶

class ask_smapi_model.v1.isp.tax_information_category.TaxInformationCategory¶

Bases: enum.Enum

Select tax category that best describes in-skill product. Choice will be validated during certification process.

Allowed enum values: [SOFTWARE, STREAMING_AUDIO, STREAMING_RADIO, INFORMATION_SERVICES, VIDEO, PERIODICALS, NEWSPAPERS]

INFORMATION_SERVICES = 'INFORMATION_SERVICES'¶

NEWSPAPERS = 'NEWSPAPERS'¶

PERIODICALS = 'PERIODICALS'¶

SOFTWARE = 'SOFTWARE'¶

STREAMING_AUDIO = 'STREAMING_AUDIO'¶

STREAMING_RADIO = 'STREAMING_RADIO'¶

VIDEO = 'VIDEO'¶

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

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

ask_smapi_model.v1.isp.update_in_skill_product_request module¶

class ask_smapi_model.v1.isp.update_in_skill_product_request.UpdateInSkillProductRequest(in_skill_product_definition=None)¶

Bases: object

Parameters:	in_skill_product_definition ((optional) ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition) –

attribute_map = {'in_skill_product_definition': 'inSkillProductDefinition'}¶

deserialized_types = {'in_skill_product_definition': 'ask_smapi_model.v1.isp.in_skill_product_definition.InSkillProductDefinition'}¶

supports_multiple_types = False¶

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

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