ask_sdk_model.services.list_management 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.services.list_management.alexa_list module

class ask_sdk_model.services.list_management.alexa_list.AlexaList(list_id=None, name=None, state=None, version=None, items=None, links=None)

Bases: object

Parameters:
attribute_map = {'items': 'items', 'links': 'links', 'list_id': 'listId', 'name': 'name', 'state': 'state', 'version': 'version'}
deserialized_types = {'items': 'list[ask_sdk_model.services.list_management.alexa_list_item.AlexaListItem]', 'links': 'ask_sdk_model.services.list_management.links.Links', 'list_id': 'str', 'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState', 'version': 'int'}
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.services.list_management.alexa_list_item module

class ask_sdk_model.services.list_management.alexa_list_item.AlexaListItem(id=None, version=None, value=None, status=None, created_time=None, updated_time=None, href=None)

Bases: object

Parameters:
attribute_map = {'created_time': 'createdTime', 'href': 'href', 'id': 'id', 'status': 'status', 'updated_time': 'updatedTime', 'value': 'value', 'version': 'version'}
deserialized_types = {'created_time': 'str', 'href': 'str', 'id': 'str', 'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', 'updated_time': 'str', 'value': 'str', 'version': 'int'}
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.services.list_management.alexa_list_metadata module

class ask_sdk_model.services.list_management.alexa_list_metadata.AlexaListMetadata(list_id=None, name=None, state=None, version=None, status_map=None)

Bases: object

Parameters:
attribute_map = {'list_id': 'listId', 'name': 'name', 'state': 'state', 'status_map': 'statusMap', 'version': 'version'}
deserialized_types = {'list_id': 'str', 'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState', 'status_map': 'list[ask_sdk_model.services.list_management.status.Status]', 'version': 'int'}
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.services.list_management.alexa_lists_metadata module

class ask_sdk_model.services.list_management.alexa_lists_metadata.AlexaListsMetadata(lists=None)

Bases: object

Parameters:lists ((optional) list[ask_sdk_model.services.list_management.alexa_list_metadata.AlexaListMetadata]) –
attribute_map = {'lists': 'lists'}
deserialized_types = {'lists': 'list[ask_sdk_model.services.list_management.alexa_list_metadata.AlexaListMetadata]'}
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.services.list_management.create_list_item_request module

class ask_sdk_model.services.list_management.create_list_item_request.CreateListItemRequest(value=None, status=None)

Bases: object

Parameters:
attribute_map = {'status': 'status', 'value': 'value'}
deserialized_types = {'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', '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_sdk_model.services.list_management.create_list_request module

class ask_sdk_model.services.list_management.create_list_request.CreateListRequest(name=None, state=None)

Bases: object

Parameters:
attribute_map = {'name': 'name', 'state': 'state'}
deserialized_types = {'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState'}
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.services.list_management.error module

class ask_sdk_model.services.list_management.error.Error(object_type=None, message=None)

Bases: object

Parameters:
  • object_type ((optional) str) –
  • message ((optional) str) –
attribute_map = {'message': 'message', 'object_type': 'type'}
deserialized_types = {'message': 'str', 'object_type': '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.services.list_management.forbidden_error module

class ask_sdk_model.services.list_management.forbidden_error.ForbiddenError(message=None)

Bases: object

Parameters:message ((optional) str) –
attribute_map = {'message': 'Message'}
deserialized_types = {'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_sdk_model.services.list_management.list_body module

class ask_sdk_model.services.list_management.list_body.ListBody(list_id=None)

Bases: object

Parameters:list_id ((optional) str) –
attribute_map = {'list_id': 'listId'}
deserialized_types = {'list_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_sdk_model.services.list_management.list_created_event_request module

class ask_sdk_model.services.list_management.list_created_event_request.ListCreatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • body ((optional) ask_sdk_model.services.list_management.list_body.ListBody) –
  • event_creation_time ((optional) datetime) –
  • event_publishing_time ((optional) datetime) –
attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_body.ListBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}
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.services.list_management.list_deleted_event_request module

class ask_sdk_model.services.list_management.list_deleted_event_request.ListDeletedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • body ((optional) ask_sdk_model.services.list_management.list_body.ListBody) –
  • event_creation_time ((optional) datetime) –
  • event_publishing_time ((optional) datetime) –
attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_body.ListBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}
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.services.list_management.list_item_body module

class ask_sdk_model.services.list_management.list_item_body.ListItemBody(list_id=None, list_item_ids=None)

Bases: object

Parameters:
  • list_id ((optional) str) –
  • list_item_ids ((optional) list[str]) –
attribute_map = {'list_id': 'listId', 'list_item_ids': 'listItemIds'}
deserialized_types = {'list_id': 'str', 'list_item_ids': 'list[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.services.list_management.list_item_state module

class ask_sdk_model.services.list_management.list_item_state.ListItemState

Bases: enum.Enum

Allowed enum values: [active, completed]

active = 'active'
completed = 'completed'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_items_created_event_request module

class ask_sdk_model.services.list_management.list_items_created_event_request.ListItemsCreatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • body ((optional) ask_sdk_model.services.list_management.list_item_body.ListItemBody) –
  • event_creation_time ((optional) datetime) –
  • event_publishing_time ((optional) datetime) –
attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_item_body.ListItemBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}
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.services.list_management.list_items_deleted_event_request module

class ask_sdk_model.services.list_management.list_items_deleted_event_request.ListItemsDeletedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • body ((optional) ask_sdk_model.services.list_management.list_item_body.ListItemBody) –
  • event_creation_time ((optional) datetime) –
  • event_publishing_time ((optional) datetime) –
attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_item_body.ListItemBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}
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.services.list_management.list_items_updated_event_request module

class ask_sdk_model.services.list_management.list_items_updated_event_request.ListItemsUpdatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • body ((optional) ask_sdk_model.services.list_management.list_item_body.ListItemBody) –
  • event_creation_time ((optional) datetime) –
  • event_publishing_time ((optional) datetime) –
attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_item_body.ListItemBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}
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.services.list_management.list_management_service_client module

class ask_sdk_model.services.list_management.list_management_service_client.ListManagementServiceClient(api_configuration, custom_user_agent=None)

Bases: ask_sdk_model.services.base_service_client.BaseServiceClient

ServiceClient for calling the ListManagementService APIs.

Parameters:api_configuration (ask_sdk_model.services.api_configuration.ApiConfiguration) – Instance of ApiConfiguration
create_list(create_list_request, **kwargs)

This API creates a custom list. The new list name must be different than any existing list name.

Parameters:
Return type:

Union[ApiResponse, Error, AlexaListMetadata]
create_list_item(list_id, create_list_item_request, **kwargs)

This API creates an item in an active list or in a default list.

Parameters:
  • list_id (str) – (required) The customer’s listId retrieved from a getListsMetadata call.
  • create_list_item_request (ask_sdk_model.services.list_management.create_list_item_request.CreateListItemRequest) – (required)
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, AlexaListItem, Error]
delete_list(list_id, **kwargs)

This API deletes a customer custom list.

Parameters:
  • list_id (str) – (required) Value of the customer’s listId retrieved from a getListsMetadata call
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, Error]
delete_list_item(list_id, item_id, **kwargs)

This API deletes an item in the specified list.

Parameters:
  • list_id (str) – (required) The customer’s listId is retrieved from a getListsMetadata call.
  • item_id (str) – (required) The customer’s itemId is retrieved from a GetList call.
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, Error]
get_list(list_id, status, **kwargs)

Retrieves the list metadata including the items in the list with requested status.

Parameters:
  • list_id (str) – (required) Retrieved from a call to GetListsMetadata to specify the listId in the request path.
  • status (str) – (required) Specify the status of the list.
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, AlexaList, Error]
get_list_item(list_id, item_id, **kwargs)

This API can be used to retrieve single item with in any list by listId and itemId. This API can read list items from an archived list. Attempting to read list items from a deleted list return an ObjectNotFound 404 error.

Parameters:
  • list_id (str) – (required) Retrieved from a call to getListsMetadata
  • item_id (str) – (required) itemId within a list is retrieved from a getList call
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, AlexaListItem, Error]
get_lists_metadata(**kwargs)

Retrieves the metadata for all customer lists, including the customer’s default lists.

Parameters:full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:Union[ApiResponse, ForbiddenError, Error, AlexaListsMetadata]
update_list(list_id, update_list_request, **kwargs)

This API updates a custom list. Only the list name or state can be updated. An Alexa customer can turn an archived list into an active one.

Parameters:
  • list_id (str) – (required) Value of the customer’s listId retrieved from a getListsMetadata call.
  • update_list_request (ask_sdk_model.services.list_management.update_list_request.UpdateListRequest) – (required)
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, Error, AlexaListMetadata]
update_list_item(list_id, item_id, update_list_item_request, **kwargs)

API used to update an item value or item status.

Parameters:
  • list_id (str) – (required) Customer’s listId
  • item_id (str) – (required) itemId to be updated in the list
  • update_list_item_request (ask_sdk_model.services.list_management.update_list_item_request.UpdateListItemRequest) – (required)
  • full_response (boolean) – Boolean value to check if response should contain headers and status code information. This value had to be passed through keyword arguments, by default the parameter value is set to False.
Return type:

Union[ApiResponse, AlexaListItem, Error]

ask_sdk_model.services.list_management.list_state module

class ask_sdk_model.services.list_management.list_state.ListState

Bases: enum.Enum

Allowed enum values: [active, archived]

active = 'active'
archived = 'archived'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_sdk_model.services.list_management.list_updated_event_request module

class ask_sdk_model.services.list_management.list_updated_event_request.ListUpdatedEventRequest(request_id=None, timestamp=None, locale=None, body=None, event_creation_time=None, event_publishing_time=None)

Bases: ask_sdk_model.request.Request

Parameters:
  • request_id ((optional) str) – Represents the unique identifier for the specific request.
  • timestamp ((optional) datetime) – Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
  • locale ((optional) str) – A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
  • body ((optional) ask_sdk_model.services.list_management.list_body.ListBody) –
  • event_creation_time ((optional) datetime) –
  • event_publishing_time ((optional) datetime) –
attribute_map = {'body': 'body', 'event_creation_time': 'eventCreationTime', 'event_publishing_time': 'eventPublishingTime', 'locale': 'locale', 'object_type': 'type', 'request_id': 'requestId', 'timestamp': 'timestamp'}
deserialized_types = {'body': 'ask_sdk_model.services.list_management.list_body.ListBody', 'event_creation_time': 'datetime', 'event_publishing_time': 'datetime', 'locale': 'str', 'object_type': 'str', 'request_id': 'str', 'timestamp': 'datetime'}
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.services.list_management.status module

class ask_sdk_model.services.list_management.status.Status(url=None, status=None)

Bases: object

Parameters:
attribute_map = {'status': 'status', 'url': 'url'}
deserialized_types = {'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', '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_sdk_model.services.list_management.update_list_item_request module

class ask_sdk_model.services.list_management.update_list_item_request.UpdateListItemRequest(value=None, status=None, version=None)

Bases: object

Parameters:
attribute_map = {'status': 'status', 'value': 'value', 'version': 'version'}
deserialized_types = {'status': 'ask_sdk_model.services.list_management.list_item_state.ListItemState', 'value': 'str', 'version': 'int'}
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.services.list_management.update_list_request module

class ask_sdk_model.services.list_management.update_list_request.UpdateListRequest(name=None, state=None, version=None)

Bases: object

Parameters:
attribute_map = {'name': 'name', 'state': 'state', 'version': 'version'}
deserialized_types = {'name': 'str', 'state': 'ask_sdk_model.services.list_management.list_state.ListState', 'version': 'int'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model