ask_smapi_model.v1.skill.interaction_model.catalog 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.skill.interaction_model.catalog.catalog_definition_output module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_definition_output.CatalogDefinitionOutput(catalog=None, creation_time=None, total_versions=None)

Bases: object

Catalog request definitions.

Parameters:

• catalog ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.catalog_entity.CatalogEntity) –
• creation_time ((optional) str) – Time of the catalog definition creation.
• total_versions ((optional) str) – Total number of versions.

attribute_map = {'catalog': 'catalog', 'creation_time': 'creationTime', 'total_versions': 'totalVersions'}

deserialized_types = {'catalog': 'ask_smapi_model.v1.skill.interaction_model.catalog.catalog_entity.CatalogEntity', 'creation_time': 'str', 'total_versions': '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.interaction_model.catalog.catalog_entity module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_entity.CatalogEntity(name=None, description=None)

Bases: object

Definition for catalog entity.

Parameters:

• name ((optional) str) – Name of the catalog.
• description ((optional) str) – Description string about the catalog.

attribute_map = {'description': 'description', 'name': 'name'}

deserialized_types = {'description': '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.interaction_model.catalog.catalog_input module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_input.CatalogInput(name=None, description=None)

Bases: object

Definition for catalog input.

Parameters:

• name ((optional) str) – Name of the catalog.
• description ((optional) str) – Description string about the catalog.

attribute_map = {'description': 'description', 'name': 'name'}

deserialized_types = {'description': '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.interaction_model.catalog.catalog_item module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_item.CatalogItem(name=None, description=None, catalog_id=None, links=None)

Bases: object

Definition for catalog entity.

Parameters:

• name ((optional) str) – Name of the catalog.
• description ((optional) str) – Description string about the catalog.
• catalog_id ((optional) str) – Identifier of the catalog, optional in get response as the request already has catalogId.
• links ((optional) ask_smapi_model.v1.links.Links) –

attribute_map = {'catalog_id': 'catalogId', 'description': 'description', 'links': '_links', 'name': 'name'}

deserialized_types = {'catalog_id': 'str', 'description': 'str', 'links': 'ask_smapi_model.v1.links.Links', '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.interaction_model.catalog.catalog_response module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_response.CatalogResponse(catalog_id=None)

Bases: object

CatalogId information.

Parameters:catalog_id ((optional) str) – ID of the catalog created.

attribute_map = {'catalog_id': 'catalogId'}

deserialized_types = {'catalog_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.interaction_model.catalog.catalog_status module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status.CatalogStatus(last_update_request=None)

Bases: object

Defines the structure for catalog status response.

Parameters:last_update_request ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.last_update_request.LastUpdateRequest) –

attribute_map = {'last_update_request': 'lastUpdateRequest'}

deserialized_types = {'last_update_request': 'ask_smapi_model.v1.skill.interaction_model.catalog.last_update_request.LastUpdateRequest'}

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.interaction_model.catalog.catalog_status_type module

class ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status_type.CatalogStatusType

Bases: enum.Enum

Status of last modification request for 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.interaction_model.catalog.definition_data module

class ask_smapi_model.v1.skill.interaction_model.catalog.definition_data.DefinitionData(catalog=None, vendor_id=None)

Bases: object

Catalog request definitions.

Parameters:

• catalog ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.catalog_input.CatalogInput) –
• vendor_id ((optional) str) – The vendorId that the catalog should belong to.

attribute_map = {'catalog': 'catalog', 'vendor_id': 'vendorId'}

deserialized_types = {'catalog': 'ask_smapi_model.v1.skill.interaction_model.catalog.catalog_input.CatalogInput', '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.interaction_model.catalog.last_update_request module

class ask_smapi_model.v1.skill.interaction_model.catalog.last_update_request.LastUpdateRequest(status=None, version=None, errors=None)

Bases: object

Contains attributes related to last modification request of a resource.

Parameters:

• status ((optional) ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status_type.CatalogStatusType) –
• version ((optional) str) – The version id of the entity returned.
• errors ((optional) list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]) –

attribute_map = {'errors': 'errors', 'status': 'status', 'version': 'version'}

deserialized_types = {'errors': 'list[ask_smapi_model.v1.skill.standardized_error.StandardizedError]', 'status': 'ask_smapi_model.v1.skill.interaction_model.catalog.catalog_status_type.CatalogStatusType', '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.interaction_model.catalog.list_catalog_response module

class ask_smapi_model.v1.skill.interaction_model.catalog.list_catalog_response.ListCatalogResponse(links=None, catalogs=None, is_truncated=None, next_token=None, total_count=None)

Bases: object

List of catalog versions of a skill for the vendor.

Parameters:

• links ((optional) ask_smapi_model.v1.links.Links) –
• catalogs ((optional) list[ask_smapi_model.v1.skill.interaction_model.catalog.catalog_item.CatalogItem]) – List of catalogs.
• is_truncated ((optional) bool) –
• next_token ((optional) str) –
• total_count ((optional) int) –

attribute_map = {'catalogs': 'catalogs', 'is_truncated': 'isTruncated', 'links': '_links', 'next_token': 'nextToken', 'total_count': 'totalCount'}

deserialized_types = {'catalogs': 'list[ask_smapi_model.v1.skill.interaction_model.catalog.catalog_item.CatalogItem]', 'is_truncated': 'bool', 'links': 'ask_smapi_model.v1.links.Links', 'next_token': 'str', 'total_count': '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.interaction_model.catalog.update_request module

class ask_smapi_model.v1.skill.interaction_model.catalog.update_request.UpdateRequest(name=None, description=None)

Bases: object

Catalog update request object.

Parameters:

• name ((optional) str) – The catalog name.
• description ((optional) str) – The catalog description with a 255 character maximum.

attribute_map = {'description': 'description', 'name': 'name'}

deserialized_types = {'description': '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