com.amazon.ask.model.services.listManagement

Class ListManagementServiceClient

java.lang.Object

com.amazon.ask.model.services.BaseServiceClient

com.amazon.ask.model.services.listManagement.ListManagementServiceClient

All Implemented Interfaces:

ListManagementService

public class ListManagementServiceClient
extends com.amazon.ask.model.services.BaseServiceClient
implements ListManagementService

Field Summary

Fields inherited from class com.amazon.ask.model.services.BaseServiceClient

apiClient, apiEndpoint, authorizationValue, serializer

Constructor Summary

Constructors

Constructor and Description
ListManagementServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration)

Method Summary

Modifier and Type	Method and Description
com.amazon.ask.model.services.ApiResponse<AlexaListMetadata>	callCreateList(CreateListRequest createListRequest) This API creates a custom list.
com.amazon.ask.model.services.ApiResponse<AlexaListItem>	callCreateListItem(String listId, CreateListItemRequest createListItemRequest) This API creates an item in an active list or in a default list.
com.amazon.ask.model.services.ApiResponse<Void>	callDeleteList(String listId) This API deletes a customer custom list.
com.amazon.ask.model.services.ApiResponse<Void>	callDeleteListItem(String listId, String itemId) This API deletes an item in the specified list.
com.amazon.ask.model.services.ApiResponse<AlexaList>	callGetList(String listId, String status) Retrieves the list metadata including the items in the list with requested status.
com.amazon.ask.model.services.ApiResponse<AlexaListItem>	callGetListItem(String listId, String itemId) This API can be used to retrieve single item with in any list by listId and itemId.
com.amazon.ask.model.services.ApiResponse<AlexaListsMetadata>	callGetListsMetadata() Retrieves the metadata for all customer lists, including the customer’s default lists.
com.amazon.ask.model.services.ApiResponse<AlexaListMetadata>	callUpdateList(String listId, UpdateListRequest updateListRequest) This API updates a custom list.
com.amazon.ask.model.services.ApiResponse<AlexaListItem>	callUpdateListItem(String listId, String itemId, UpdateListItemRequest updateListItemRequest) API used to update an item value or item status.
AlexaListMetadata	createList(CreateListRequest createListRequest) This API creates a custom list.
AlexaListItem	createListItem(String listId, CreateListItemRequest createListItemRequest) This API creates an item in an active list or in a default list.
void	deleteList(String listId) This API deletes a customer custom list.
void	deleteListItem(String listId, String itemId) This API deletes an item in the specified list.
AlexaList	getList(String listId, String status) Retrieves the list metadata including the items in the list with requested status.
AlexaListItem	getListItem(String listId, String itemId) This API can be used to retrieve single item with in any list by listId and itemId.
AlexaListsMetadata	getListsMetadata() Retrieves the metadata for all customer lists, including the customer’s default lists.
AlexaListMetadata	updateList(String listId, UpdateListRequest updateListRequest) This API updates a custom list.
AlexaListItem	updateListItem(String listId, String itemId, UpdateListItemRequest updateListItemRequest) API used to update an item value or item status.

Methods inherited from class com.amazon.ask.model.services.BaseServiceClient

executeRequest, invoke, invoke

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListManagementServiceClient

public ListManagementServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration)

Method Detail

callGetListsMetadata

public com.amazon.ask.model.services.ApiResponse<AlexaListsMetadata> callGetListsMetadata()
                                                                                   throws com.amazon.ask.model.services.ServiceException

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

Specified by:

callGetListsMetadata in interface ListManagementService

Returns:

com.amazon.ask.model.services.listManagement.AlexaListsMetadata

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getListsMetadata

public AlexaListsMetadata getListsMetadata()
                                    throws com.amazon.ask.model.services.ServiceException

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

Specified by:

getListsMetadata in interface ListManagementService

Returns:

com.amazon.ask.model.services.listManagement.AlexaListsMetadata

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callDeleteList

public com.amazon.ask.model.services.ApiResponse<Void> callDeleteList(String listId)
                                                               throws com.amazon.ask.model.services.ServiceException

This API deletes a customer custom list.

Specified by:

callDeleteList in interface ListManagementService

Parameters:

listId - Value of the customer’s listId retrieved from a getListsMetadata call (required)

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

deleteList

public void deleteList(String listId)
                throws com.amazon.ask.model.services.ServiceException

This API deletes a customer custom list.

Specified by:

deleteList in interface ListManagementService

Parameters:

listId - Value of the customer’s listId retrieved from a getListsMetadata call (required)

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callDeleteListItem

public com.amazon.ask.model.services.ApiResponse<Void> callDeleteListItem(String listId,
                                                                          String itemId)
                                                                   throws com.amazon.ask.model.services.ServiceException

This API deletes an item in the specified list.

Specified by:

callDeleteListItem in interface ListManagementService

Parameters:

listId - The customer’s listId is retrieved from a getListsMetadata call. (required)

itemId - The customer’s itemId is retrieved from a GetList call. (required)

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

deleteListItem

public void deleteListItem(String listId,
                           String itemId)
                    throws com.amazon.ask.model.services.ServiceException

This API deletes an item in the specified list.

Specified by:

deleteListItem in interface ListManagementService

Parameters:

listId - The customer’s listId is retrieved from a getListsMetadata call. (required)

itemId - The customer’s itemId is retrieved from a GetList call. (required)

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetListItem

public com.amazon.ask.model.services.ApiResponse<AlexaListItem> callGetListItem(String listId,
                                                                                String itemId)
                                                                         throws com.amazon.ask.model.services.ServiceException

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.

Specified by:

callGetListItem in interface ListManagementService

Parameters:

listId - Retrieved from a call to getListsMetadata (required)

itemId - itemId within a list is retrieved from a getList call (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListItem

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getListItem

public AlexaListItem getListItem(String listId,
                                 String itemId)
                          throws com.amazon.ask.model.services.ServiceException

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.

Specified by:

getListItem in interface ListManagementService

Parameters:

listId - Retrieved from a call to getListsMetadata (required)

itemId - itemId within a list is retrieved from a getList call (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListItem

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callUpdateListItem

public com.amazon.ask.model.services.ApiResponse<AlexaListItem> callUpdateListItem(String listId,
                                                                                   String itemId,
                                                                                   UpdateListItemRequest updateListItemRequest)
                                                                            throws com.amazon.ask.model.services.ServiceException

API used to update an item value or item status.

Specified by:

callUpdateListItem in interface ListManagementService

Parameters:

listId - Customer’s listId (required)

itemId - itemId to be updated in the list (required)

updateListItemRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListItem

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

updateListItem

public AlexaListItem updateListItem(String listId,
                                    String itemId,
                                    UpdateListItemRequest updateListItemRequest)
                             throws com.amazon.ask.model.services.ServiceException

API used to update an item value or item status.

Specified by:

updateListItem in interface ListManagementService

Parameters:

listId - Customer’s listId (required)

itemId - itemId to be updated in the list (required)

updateListItemRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListItem

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callCreateListItem

public com.amazon.ask.model.services.ApiResponse<AlexaListItem> callCreateListItem(String listId,
                                                                                   CreateListItemRequest createListItemRequest)
                                                                            throws com.amazon.ask.model.services.ServiceException

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

Specified by:

callCreateListItem in interface ListManagementService

Parameters:

listId - The customer’s listId retrieved from a getListsMetadata call. (required)

createListItemRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListItem

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

createListItem

public AlexaListItem createListItem(String listId,
                                    CreateListItemRequest createListItemRequest)
                             throws com.amazon.ask.model.services.ServiceException

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

Specified by:

createListItem in interface ListManagementService

Parameters:

listId - The customer’s listId retrieved from a getListsMetadata call. (required)

createListItemRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListItem

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callUpdateList

public com.amazon.ask.model.services.ApiResponse<AlexaListMetadata> callUpdateList(String listId,
                                                                                   UpdateListRequest updateListRequest)
                                                                            throws com.amazon.ask.model.services.ServiceException

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.

Specified by:

callUpdateList in interface ListManagementService

Parameters:

listId - Value of the customer’s listId retrieved from a getListsMetadata call. (required)

updateListRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListMetadata

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

updateList

public AlexaListMetadata updateList(String listId,
                                    UpdateListRequest updateListRequest)
                             throws com.amazon.ask.model.services.ServiceException

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.

Specified by:

updateList in interface ListManagementService

Parameters:

listId - Value of the customer’s listId retrieved from a getListsMetadata call. (required)

updateListRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListMetadata

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callGetList

public com.amazon.ask.model.services.ApiResponse<AlexaList> callGetList(String listId,
                                                                        String status)
                                                                 throws com.amazon.ask.model.services.ServiceException

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

Specified by:

callGetList in interface ListManagementService

Parameters:

listId - Retrieved from a call to GetListsMetadata to specify the listId in the request path. (required)

status - Specify the status of the list. (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaList

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

getList

public AlexaList getList(String listId,
                         String status)
                  throws com.amazon.ask.model.services.ServiceException

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

Specified by:

getList in interface ListManagementService

Parameters:

listId - Retrieved from a call to GetListsMetadata to specify the listId in the request path. (required)

status - Specify the status of the list. (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaList

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

callCreateList

public com.amazon.ask.model.services.ApiResponse<AlexaListMetadata> callCreateList(CreateListRequest createListRequest)
                                                                            throws com.amazon.ask.model.services.ServiceException

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

Specified by:

callCreateList in interface ListManagementService

Parameters:

createListRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListMetadata

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call

createList

public AlexaListMetadata createList(CreateListRequest createListRequest)
                             throws com.amazon.ask.model.services.ServiceException

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

Specified by:

createList in interface ListManagementService

Parameters:

createListRequest - (required)

Returns:

com.amazon.ask.model.services.listManagement.AlexaListMetadata

Throws:

com.amazon.ask.model.services.ServiceException - if fails to make API call