ask_smapi_model.v1.skill package

Subpackages

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.skill.action module

class ask_smapi_model.v1.skill.action.Action

Bases: enum.Enum

Action of a resource.

Allowed enum values: [CREATE, UPDATE, ASSOCIATE, DISASSOCIATE]

ASSOCIATE = 'ASSOCIATE'
CREATE = 'CREATE'
DISASSOCIATE = 'DISASSOCIATE'
UPDATE = 'UPDATE'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.agreement_type module

class ask_smapi_model.v1.skill.agreement_type.AgreementType

Bases: enum.Enum

Type of the agreement that the customer must be compliant to.

Allowed enum values: [EXPORT_COMPLIANCE]

EXPORT_COMPLIANCE = 'EXPORT_COMPLIANCE'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.build_details module

class ask_smapi_model.v1.skill.build_details.BuildDetails(steps=None)

Bases: object

Contains array which describes steps involved in a build. Elements (or build steps) are added to this array as they become IN_PROGRESS.

Parameters:steps ((optional) list[ask_smapi_model.v1.skill.build_step.BuildStep]) – An array where each element represents a build step.
attribute_map = {'steps': 'steps'}
deserialized_types = {'steps': 'list[ask_smapi_model.v1.skill.build_step.BuildStep]'}
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.skill.build_step module

class ask_smapi_model.v1.skill.build_step.BuildStep(name=None, status=None, errors=None)

Bases: object

Describes the status of a build step.

Parameters:
attribute_map = {'errors': 'errors', 'name': 'name', 'status': 'status'}
deserialized_types = {'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'name': 'ask_smapi_model.v1.skill.build_step_name.BuildStepName', 'status': 'ask_smapi_model.v1.skill.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.skill.build_step_name module

class ask_smapi_model.v1.skill.build_step_name.BuildStepName

Bases: enum.Enum

Name of the build step. Possible values - * `DIALOG_MODEL_BUILD` - Build status for dialog model. * `LANGUAGE_MODEL_QUICK_BUILD` - Build status for FST model. * `LANGUAGE_MODEL_FULL_BUILD` - Build status for statistical model.

Allowed enum values: [DIALOG_MODEL_BUILD, LANGUAGE_MODEL_QUICK_BUILD, LANGUAGE_MODEL_FULL_BUILD]

DIALOG_MODEL_BUILD = 'DIALOG_MODEL_BUILD'
LANGUAGE_MODEL_FULL_BUILD = 'LANGUAGE_MODEL_FULL_BUILD'
LANGUAGE_MODEL_QUICK_BUILD = 'LANGUAGE_MODEL_QUICK_BUILD'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.create_skill_request module

class ask_smapi_model.v1.skill.create_skill_request.CreateSkillRequest(vendor_id=None, manifest=None, hosting=None)

Bases: object

Parameters:
attribute_map = {'hosting': 'hosting', 'manifest': 'manifest', 'vendor_id': 'vendorId'}
deserialized_types = {'hosting': 'ask_smapi_model.v1.skill.alexa_hosted.hosting_configuration.HostingConfiguration', 'manifest': 'ask_smapi_model.v1.skill.manifest.skill_manifest.SkillManifest', '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.skill.create_skill_response module

class ask_smapi_model.v1.skill.create_skill_response.CreateSkillResponse(skill_id=None)

Bases: object

SkillId information.

Parameters:skill_id ((optional) str) – ID of the skill created.
attribute_map = {'skill_id': 'skillId'}
deserialized_types = {'skill_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.skill.create_skill_with_package_request module

class ask_smapi_model.v1.skill.create_skill_with_package_request.CreateSkillWithPackageRequest(vendor_id=None, location=None)

Bases: object

Parameters:
  • vendor_id ((optional) str) – ID of the vendor owning the skill.
  • location ((optional) str) – The URL for the skill package.
attribute_map = {'location': 'location', 'vendor_id': 'vendorId'}
deserialized_types = {'location': 'str', '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.skill.export_response module

class ask_smapi_model.v1.skill.export_response.ExportResponse(status=None, skill=None)

Bases: object

Parameters:
attribute_map = {'skill': 'skill', 'status': 'status'}
deserialized_types = {'skill': 'ask_smapi_model.v1.skill.export_response_skill.ExportResponseSkill', 'status': 'ask_smapi_model.v1.skill.response_status.ResponseStatus'}
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.skill.export_response_skill module

class ask_smapi_model.v1.skill.export_response_skill.ExportResponseSkill(e_tag=None, location=None, expires_at=None)

Bases: object

Defines the structure of the GetExport response.

Parameters:
  • e_tag ((optional) str) –
  • location ((optional) str) –
  • expires_at ((optional) str) – ExpiresAt timestamp in milliseconds.
attribute_map = {'e_tag': 'eTag', 'expires_at': 'expiresAt', 'location': 'location'}
deserialized_types = {'e_tag': 'str', 'expires_at': 'str', 'location': '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.skill.image_attributes module

class ask_smapi_model.v1.skill.image_attributes.ImageAttributes(dimension=None, size=None)

Bases: object

Set of properties of the image provided by the customer.

Parameters:
attribute_map = {'dimension': 'dimension', 'size': 'size'}
deserialized_types = {'dimension': 'ask_smapi_model.v1.skill.image_dimension.ImageDimension', 'size': 'ask_smapi_model.v1.skill.image_size.ImageSize'}
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.skill.image_dimension module

class ask_smapi_model.v1.skill.image_dimension.ImageDimension(width_in_pixels=None, height_in_pixels=None)

Bases: object

Dimensions of an image.

Parameters:
  • width_in_pixels ((optional) int) – Width of the image in pixels.
  • height_in_pixels ((optional) int) – Height of the image in pixels.
attribute_map = {'height_in_pixels': 'heightInPixels', 'width_in_pixels': 'widthInPixels'}
deserialized_types = {'height_in_pixels': 'int', 'width_in_pixels': '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.skill.image_size module

class ask_smapi_model.v1.skill.image_size.ImageSize(value=None, unit=None)

Bases: object

On disk storage size of image.

Parameters:
attribute_map = {'unit': 'unit', 'value': 'value'}
deserialized_types = {'unit': 'ask_smapi_model.v1.skill.image_size_unit.ImageSizeUnit', 'value': '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.skill.image_size_unit module

class ask_smapi_model.v1.skill.image_size_unit.ImageSizeUnit

Bases: enum.Enum

Unit of measurement for size of image.

Allowed enum values: [MB]

MB = 'MB'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.import_response module

class ask_smapi_model.v1.skill.import_response.ImportResponse(status=None, errors=None, warnings=None, skill=None)

Bases: object

Parameters:
attribute_map = {'errors': 'errors', 'skill': 'skill', 'status': 'status', 'warnings': 'warnings'}
deserialized_types = {'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'skill': 'ask_smapi_model.v1.skill.import_response_skill.ImportResponseSkill', 'status': 'ask_smapi_model.v1.skill.response_status.ResponseStatus', 'warnings': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]'}
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.skill.import_response_skill module

class ask_smapi_model.v1.skill.import_response_skill.ImportResponseSkill(skill_id=None, e_tag=None, resources=None)

Bases: object

Parameters:
attribute_map = {'e_tag': 'eTag', 'resources': 'resources', 'skill_id': 'skillId'}
deserialized_types = {'e_tag': 'str', 'resources': 'list[ask_smapi_model.v1.skill.resource_import_status.ResourceImportStatus]', 'skill_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.skill.instance module

class ask_smapi_model.v1.skill.instance.Instance(property_path=None, data_type=None, value=None)

Bases: object

Structure representing properties of an instance of data. Definition will be either one of a booleanInstance, stringInstance, integerInstance, or compoundInstance.

Parameters:
  • property_path ((optional) str) – Path that uniquely identifies the instance in the resource.
  • data_type ((optional) ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes) –
  • value ((optional) str) – String value of the instance. Incase of null, object or array the value field would be null or not present. Incase of string, boolean or integer dataType it will be the corresponding String value.
attribute_map = {'data_type': 'dataType', 'property_path': 'propertyPath', 'value': 'value'}
deserialized_types = {'data_type': 'ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes', 'property_path': 'str', 'value': '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.skill.interface_definition module

ask_smapi_model.v1.skill.interface_intent module

ask_smapi_model.v1.skill.last_update_request module

ask_smapi_model.v1.skill.list_skill_response module

class ask_smapi_model.v1.skill.list_skill_response.ListSkillResponse(links=None, skills=None, is_truncated=None, next_token=None)

Bases: object

List of skills for the vendor.

Parameters:
  • links ((optional) ask_smapi_model.v1.links.Links) –
  • skills ((optional) list[ask_smapi_model.v1.skill.skill_summary.SkillSummary]) – List of skill summaries. List might contain either one, two or three entries for a given skillId depending on the skill's publication history and the publication method. `Skill containing certified stage` * If a skill was never published to live, this list will contain two entries `:` one with stage 'development' and another with stage 'certified'. Both of these summaries will have same skillId. * For any skill that has been published to 'live', this list will contain three entries `:` one with stage 'development', one with stage `certified` and one with stage 'live'. All of these summaries will have same skillId. `Skill without certified stage` * If a skill was never published to live, this list will contain only one entry for the skill with stage as 'development'. * For any skill that has been published to 'live', this list will contain two entries `:` one with stage 'development' and another with stage 'live'. Both of these summaries will have same skillId.
  • is_truncated ((optional) bool) –
  • next_token ((optional) str) –
attribute_map = {'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken', 'skills': 'skills'}
deserialized_types = {'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'skills': 'list[ask_smapi_model.v1.skill.skill_summary.SkillSummary]'}
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.skill.publication_method module

class ask_smapi_model.v1.skill.publication_method.PublicationMethod

Bases: enum.Enum

Determines if the skill should be submitted only for certification and manually publish later or publish immediately after the skill is certified. Omitting the publication method will default to auto publishing.

Allowed enum values: [MANUAL_PUBLISHING, AUTO_PUBLISHING]

AUTO_PUBLISHING = 'AUTO_PUBLISHING'
MANUAL_PUBLISHING = 'MANUAL_PUBLISHING'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.reason module

class ask_smapi_model.v1.skill.reason.Reason

Bases: enum.Enum

The reason to withdraw.

Allowed enum values: [TEST_SKILL, MORE_FEATURES, DISCOVERED_ISSUE, NOT_RECEIVED_CERTIFICATION_FEEDBACK, NOT_INTEND_TO_PUBLISH, OTHER]

DISCOVERED_ISSUE = 'DISCOVERED_ISSUE'
MORE_FEATURES = 'MORE_FEATURES'
NOT_INTEND_TO_PUBLISH = 'NOT_INTEND_TO_PUBLISH'
NOT_RECEIVED_CERTIFICATION_FEEDBACK = 'NOT_RECEIVED_CERTIFICATION_FEEDBACK'
OTHER = 'OTHER'
TEST_SKILL = 'TEST_SKILL'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.regional_ssl_certificate module

class ask_smapi_model.v1.skill.regional_ssl_certificate.RegionalSSLCertificate(ssl_certificate=None)

Bases: object

Parameters:ssl_certificate ((optional) str) –
attribute_map = {'ssl_certificate': 'sslCertificate'}
deserialized_types = {'ssl_certificate': '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.skill.resource_import_status module

class ask_smapi_model.v1.skill.resource_import_status.ResourceImportStatus(name=None, status=None, action=None, errors=None, warnings=None)

Bases: object

Defines the structure for a resource deployment status.

Parameters:
attribute_map = {'action': 'action', 'errors': 'errors', 'name': 'name', 'status': 'status', 'warnings': 'warnings'}
deserialized_types = {'action': 'ask_smapi_model.v1.skill.action.Action', 'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'name': 'str', 'status': 'ask_smapi_model.v1.skill.response_status.ResponseStatus', 'warnings': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]'}
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.skill.resource_status module

ask_smapi_model.v1.skill.response_status module

class ask_smapi_model.v1.skill.response_status.ResponseStatus

Bases: enum.Enum

Status for a Response resource.

Allowed enum values: [FAILED, IN_PROGRESS, SUCCEEDED, ROLLBACK_SUCCEEDED, ROLLBACK_FAILED, SKIPPED]

FAILED = 'FAILED'
IN_PROGRESS = 'IN_PROGRESS'
ROLLBACK_FAILED = 'ROLLBACK_FAILED'
ROLLBACK_SUCCEEDED = 'ROLLBACK_SUCCEEDED'
SKIPPED = 'SKIPPED'
SUCCEEDED = 'SUCCEEDED'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.skill_interaction_model module

ask_smapi_model.v1.skill.skill_interaction_model_status module

class ask_smapi_model.v1.skill.skill_interaction_model_status.SkillInteractionModelStatus(last_update_request=None, e_tag=None, version=None)

Bases: object

Defines the structure for interaction model build status.

Parameters:
  • last_update_request ((optional) ask_smapi_model.v1.skill.interaction_model_last_update_request.InteractionModelLastUpdateRequest) –
  • e_tag ((optional) str) – An opaque identifier for last successfully updated resource.
  • version ((optional) str) – Version for last successfully built model.
attribute_map = {'e_tag': 'eTag', 'last_update_request': 'lastUpdateRequest', 'version': 'version'}
deserialized_types = {'e_tag': 'str', 'last_update_request': 'ask_smapi_model.v1.skill.interaction_model_last_update_request.InteractionModelLastUpdateRequest', '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.skill.skill_status module

class ask_smapi_model.v1.skill.skill_status.SkillStatus(manifest=None, interaction_model=None, hosted_skill_deployment=None, hosted_skill_provisioning=None)

Bases: object

Defines the structure for skill status response.

Parameters:
  • manifest ((optional) ask_smapi_model.v1.skill.manifest_status.ManifestStatus) –
  • interaction_model ((optional) dict(str, ask_smapi_model.v1.skill.skill_interaction_model_status.SkillInteractionModelStatus)) – Status for available interaction models, keyed by locale.
  • hosted_skill_deployment ((optional) ask_smapi_model.v1.skill.hosted_skill_deployment_status.HostedSkillDeploymentStatus) –
  • hosted_skill_provisioning ((optional) ask_smapi_model.v1.skill.hosted_skill_provisioning_status.HostedSkillProvisioningStatus) –
attribute_map = {'hosted_skill_deployment': 'hostedSkillDeployment', 'hosted_skill_provisioning': 'hostedSkillProvisioning', 'interaction_model': 'interactionModel', 'manifest': 'manifest'}
deserialized_types = {'hosted_skill_deployment': 'ask_smapi_model.v1.skill.hosted_skill_deployment_status.HostedSkillDeploymentStatus', 'hosted_skill_provisioning': 'ask_smapi_model.v1.skill.hosted_skill_provisioning_status.HostedSkillProvisioningStatus', 'interaction_model': 'dict(str, ask_smapi_model.v1.skill.skill_interaction_model_status.SkillInteractionModelStatus)', 'manifest': 'ask_smapi_model.v1.skill.manifest_status.ManifestStatus'}
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.skill.skill_summary module

class ask_smapi_model.v1.skill.skill_summary.SkillSummary(skill_id=None, apis=None, publication_status=None, last_updated=None, name_by_locale=None, asin=None, links=None)

Bases: object

Information about the skills.

Parameters:
  • skill_id ((optional) str) –
  • apis ((optional) list[ask_smapi_model.v1.skill.skill_summary_apis.SkillSummaryApis]) – List of APIs currently implemented by the skill.
  • publication_status ((optional) ask_smapi_model.v1.skill.publication_status.PublicationStatus) –
  • last_updated ((optional) datetime) –
  • name_by_locale ((optional) dict(str, str)) – Name of the skill in skill locales (keys are locale names (e.g. 'en-US') whereas values are name of the skill in that locale.
  • asin ((optional) str) – Amazon Standard Identification Number (ASIN) is unique blocks of 10 letters and/or numbers that identify items. More info about ASIN can be found here: https://www.amazon.com/gp/seller/asin-upc-isbn-info.html ASIN is available for those skills only, that have been published, at least once.
  • links ((optional) ask_smapi_model.v1.links.Links) –
attribute_map = {'apis': 'apis', 'asin': 'asin', 'last_updated': 'lastUpdated', 'links': '_links', 'name_by_locale': 'nameByLocale', 'publication_status': 'publicationStatus', 'skill_id': 'skillId'}
deserialized_types = {'apis': 'list[ask_smapi_model.v1.skill.skill_summary_apis.SkillSummaryApis]', 'asin': 'str', 'last_updated': 'datetime', 'links': 'ask_smapi_model.v1.links.Links', 'name_by_locale': 'dict(str, str)', 'publication_status': 'ask_smapi_model.v1.skill.publication_status.PublicationStatus', 'skill_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.skill.skill_summary_apis module

class ask_smapi_model.v1.skill.skill_summary_apis.SkillSummaryApis

Bases: enum.Enum

Allowed enum values: [custom, smartHome, flashBriefing, video, music, householdList, health, alexaForBusiness]

alexaForBusiness = 'alexaForBusiness'
custom = 'custom'
flashBriefing = 'flashBriefing'
health = 'health'
householdList = 'householdList'
music = 'music'
smartHome = 'smartHome'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

video = 'video'

ask_smapi_model.v1.skill.ssl_certificate_payload module

class ask_smapi_model.v1.skill.ssl_certificate_payload.SSLCertificatePayload(ssl_certificate=None, regions=None)

Bases: object

Parameters:
attribute_map = {'regions': 'regions', 'ssl_certificate': 'sslCertificate'}
deserialized_types = {'regions': 'dict(str, ask_smapi_model.v1.skill.regional_ssl_certificate.RegionalSSLCertificate)', 'ssl_certificate': '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.skill.standardized_error module

class ask_smapi_model.v1.skill.standardized_error.StandardizedError(validation_details=None, code=None, message=None)

Bases: ask_smapi_model.v1.error.Error

Standardized structure which wraps machine parsable and human readable information about an error.

Parameters:
  • validation_details ((optional) ask_smapi_model.v1.skill.validation_details.ValidationDetails) – Standardized, machine readable structure that wraps all the information about a specific occurrence of an error of the type specified by the code.
  • code ((optional) str) – Error code that maps to an error message. Developers with different locales should be able to lookup the error description based on this code.
  • message ((optional) str) – Readable description of error. If standardized, this is generated from the error code and validation details.
attribute_map = {'code': 'code', 'message': 'message', 'validation_details': 'validationDetails'}
deserialized_types = {'code': 'str', 'message': 'str', 'validation_details': 'ask_smapi_model.v1.skill.validation_details.ValidationDetails'}
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.skill.standardized_error_code module

ask_smapi_model.v1.skill.status module

class ask_smapi_model.v1.skill.status.Status

Bases: enum.Enum

Status of a resource.

Allowed enum values: [FAILED, IN_PROGRESS, SUCCEEDED]

FAILED = 'FAILED'
IN_PROGRESS = 'IN_PROGRESS'
SUCCEEDED = 'SUCCEEDED'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.submit_skill_for_certification_request module

class ask_smapi_model.v1.skill.submit_skill_for_certification_request.SubmitSkillForCertificationRequest(publication_method=None, version_message=None)

Bases: object

Parameters:
attribute_map = {'publication_method': 'publicationMethod', 'version_message': 'versionMessage'}
deserialized_types = {'publication_method': 'ask_smapi_model.v1.skill.publication_method.PublicationMethod', 'version_message': '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.skill.update_skill_with_package_request module

class ask_smapi_model.v1.skill.update_skill_with_package_request.UpdateSkillWithPackageRequest(location=None)

Bases: object

Parameters:location ((optional) str) – The URL for the skill package.
attribute_map = {'location': 'location'}
deserialized_types = {'location': '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.skill.upload_response module

class ask_smapi_model.v1.skill.upload_response.UploadResponse(upload_url=None, expires_at=None)

Bases: object

Defines the structure for skill upload response.

Parameters:
  • upload_url ((optional) str) – The upload URL to upload a skill package.
  • expires_at ((optional) datetime) –
attribute_map = {'expires_at': 'expiresAt', 'upload_url': 'uploadUrl'}
deserialized_types = {'expires_at': 'datetime', 'upload_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.skill.validation_data_types module

class ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes

Bases: enum.Enum

Allowed enum values: [object, boolean, integer, array, string, null]

array = 'array'
boolean = 'boolean'
integer = 'integer'
null = 'null'
object = 'object'
string = 'string'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.skill.validation_details module

class ask_smapi_model.v1.skill.validation_details.ValidationDetails(actual_image_attributes=None, actual_number_of_items=None, actual_string_length=None, allowed_content_types=None, allowed_data_types=None, allowed_image_attributes=None, conflicting_instance=None, expected_format=None, expected_instance=None, expected_regex_pattern=None, agreement_type=None, feature=None, inconsistent_endpoint=None, minimum_integer_value=None, minimum_number_of_items=None, minimum_string_length=None, maximum_integer_value=None, maximum_number_of_items=None, maximum_string_length=None, original_endpoint=None, original_instance=None, reason=None, required_property=None, unexpected_property=None)

Bases: object

Standardized, machine readable structure that wraps all the information about a specific occurrence of an error of the type specified by the code.

Parameters:
attribute_map = {'actual_image_attributes': 'actualImageAttributes', 'actual_number_of_items': 'actualNumberOfItems', 'actual_string_length': 'actualStringLength', 'agreement_type': 'agreementType', 'allowed_content_types': 'allowedContentTypes', 'allowed_data_types': 'allowedDataTypes', 'allowed_image_attributes': 'allowedImageAttributes', 'conflicting_instance': 'conflictingInstance', 'expected_format': 'expectedFormat', 'expected_instance': 'expectedInstance', 'expected_regex_pattern': 'expectedRegexPattern', 'feature': 'feature', 'inconsistent_endpoint': 'inconsistentEndpoint', 'maximum_integer_value': 'maximumIntegerValue', 'maximum_number_of_items': 'maximumNumberOfItems', 'maximum_string_length': 'maximumStringLength', 'minimum_integer_value': 'minimumIntegerValue', 'minimum_number_of_items': 'minimumNumberOfItems', 'minimum_string_length': 'minimumStringLength', 'original_endpoint': 'originalEndpoint', 'original_instance': 'originalInstance', 'reason': 'reason', 'required_property': 'requiredProperty', 'unexpected_property': 'unexpectedProperty'}
deserialized_types = {'actual_image_attributes': 'ask_smapi_model.v1.skill.image_attributes.ImageAttributes', 'actual_number_of_items': 'int', 'actual_string_length': 'int', 'agreement_type': 'ask_smapi_model.v1.skill.agreement_type.AgreementType', 'allowed_content_types': 'list[str]', 'allowed_data_types': 'list[ask_smapi_model.v1.skill.validation_data_types.ValidationDataTypes]', 'allowed_image_attributes': 'list[ask_smapi_model.v1.skill.image_attributes.ImageAttributes]', 'conflicting_instance': 'ask_smapi_model.v1.skill.instance.Instance', 'expected_format': 'ask_smapi_model.v1.skill.format.Format', 'expected_instance': 'ask_smapi_model.v1.skill.instance.Instance', 'expected_regex_pattern': 'str', 'feature': 'ask_smapi_model.v1.skill.validation_feature.ValidationFeature', 'inconsistent_endpoint': 'ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint', 'maximum_integer_value': 'int', 'maximum_number_of_items': 'int', 'maximum_string_length': 'int', 'minimum_integer_value': 'int', 'minimum_number_of_items': 'int', 'minimum_string_length': 'int', 'original_endpoint': 'ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint', 'original_instance': 'ask_smapi_model.v1.skill.instance.Instance', 'reason': 'ask_smapi_model.v1.skill.validation_failure_reason.ValidationFailureReason', 'required_property': 'str', 'unexpected_property': '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.skill.validation_endpoint module

class ask_smapi_model.v1.skill.validation_endpoint.ValidationEndpoint(property_path=None, object_type=None, value=None)

Bases: object

Structure representing an endpoint.

Parameters:
  • property_path ((optional) str) – Path to the endpoint URI in the resource.
  • object_type ((optional) str) – Type of the endpoint (https, http, arn etc).
  • value ((optional) str) – Full URI of the endpoint.
attribute_map = {'object_type': 'type', 'property_path': 'propertyPath', 'value': 'value'}
deserialized_types = {'object_type': 'str', 'property_path': 'str', 'value': '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.skill.validation_feature module

class ask_smapi_model.v1.skill.validation_feature.ValidationFeature(name=None, contact=None)

Bases: object

Structure representing a public feature.

Parameters:
  • name ((optional) str) – Name of the feature.
  • contact ((optional) str) – Contact URL or email for the feature.
attribute_map = {'contact': 'contact', 'name': 'name'}
deserialized_types = {'contact': 'str', 'name': '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.skill.withdraw_request module

class ask_smapi_model.v1.skill.withdraw_request.WithdrawRequest(reason=None, message=None)

Bases: object

The payload for the withdraw operation.

Parameters:
attribute_map = {'message': 'message', 'reason': 'reason'}
deserialized_types = {'message': 'str', 'reason': 'ask_smapi_model.v1.skill.reason.Reason'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model