public class ListManagementServiceClient extends com.amazon.ask.model.services.BaseServiceClient implements ListManagementService
Constructor and Description |
---|
ListManagementServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration) |
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.
|
public ListManagementServiceClient(com.amazon.ask.model.services.ApiConfiguration apiConfiguration)
public com.amazon.ask.model.services.ApiResponse<AlexaListsMetadata> callGetListsMetadata() throws com.amazon.ask.model.services.ServiceException
callGetListsMetadata
in interface ListManagementService
com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic AlexaListsMetadata getListsMetadata() throws com.amazon.ask.model.services.ServiceException
getListsMetadata
in interface ListManagementService
com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<Void> callDeleteList(String listId) throws com.amazon.ask.model.services.ServiceException
callDeleteList
in interface ListManagementService
listId
- Value of the customer’s listId retrieved from a getListsMetadata call (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic void deleteList(String listId) throws com.amazon.ask.model.services.ServiceException
deleteList
in interface ListManagementService
listId
- Value of the customer’s listId retrieved from a getListsMetadata call (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<Void> callDeleteListItem(String listId, String itemId) throws com.amazon.ask.model.services.ServiceException
callDeleteListItem
in interface ListManagementService
listId
- The customer’s listId is retrieved from a getListsMetadata call. (required)itemId
- The customer’s itemId is retrieved from a GetList call. (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic void deleteListItem(String listId, String itemId) throws com.amazon.ask.model.services.ServiceException
deleteListItem
in interface ListManagementService
listId
- The customer’s listId is retrieved from a getListsMetadata call. (required)itemId
- The customer’s itemId is retrieved from a GetList call. (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<AlexaListItem> callGetListItem(String listId, String itemId) throws com.amazon.ask.model.services.ServiceException
callGetListItem
in interface ListManagementService
listId
- Retrieved from a call to getListsMetadata (required)itemId
- itemId within a list is retrieved from a getList call (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic AlexaListItem getListItem(String listId, String itemId) throws com.amazon.ask.model.services.ServiceException
getListItem
in interface ListManagementService
listId
- Retrieved from a call to getListsMetadata (required)itemId
- itemId within a list is retrieved from a getList call (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<AlexaListItem> callUpdateListItem(String listId, String itemId, UpdateListItemRequest updateListItemRequest) throws com.amazon.ask.model.services.ServiceException
callUpdateListItem
in interface ListManagementService
listId
- Customer’s listId (required)itemId
- itemId to be updated in the list (required)updateListItemRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic AlexaListItem updateListItem(String listId, String itemId, UpdateListItemRequest updateListItemRequest) throws com.amazon.ask.model.services.ServiceException
updateListItem
in interface ListManagementService
listId
- Customer’s listId (required)itemId
- itemId to be updated in the list (required)updateListItemRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<AlexaListItem> callCreateListItem(String listId, CreateListItemRequest createListItemRequest) throws com.amazon.ask.model.services.ServiceException
callCreateListItem
in interface ListManagementService
listId
- The customer’s listId retrieved from a getListsMetadata call. (required)createListItemRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic AlexaListItem createListItem(String listId, CreateListItemRequest createListItemRequest) throws com.amazon.ask.model.services.ServiceException
createListItem
in interface ListManagementService
listId
- The customer’s listId retrieved from a getListsMetadata call. (required)createListItemRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<AlexaListMetadata> callUpdateList(String listId, UpdateListRequest updateListRequest) throws com.amazon.ask.model.services.ServiceException
callUpdateList
in interface ListManagementService
listId
- Value of the customer’s listId retrieved from a getListsMetadata call. (required)updateListRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic AlexaListMetadata updateList(String listId, UpdateListRequest updateListRequest) throws com.amazon.ask.model.services.ServiceException
updateList
in interface ListManagementService
listId
- Value of the customer’s listId retrieved from a getListsMetadata call. (required)updateListRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<AlexaList> callGetList(String listId, String status) throws com.amazon.ask.model.services.ServiceException
callGetList
in interface ListManagementService
listId
- Retrieved from a call to GetListsMetadata to specify the listId in the request path. (required)status
- Specify the status of the list. (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic AlexaList getList(String listId, String status) throws com.amazon.ask.model.services.ServiceException
getList
in interface ListManagementService
listId
- Retrieved from a call to GetListsMetadata to specify the listId in the request path. (required)status
- Specify the status of the list. (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic com.amazon.ask.model.services.ApiResponse<AlexaListMetadata> callCreateList(CreateListRequest createListRequest) throws com.amazon.ask.model.services.ServiceException
callCreateList
in interface ListManagementService
createListRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callpublic AlexaListMetadata createList(CreateListRequest createListRequest) throws com.amazon.ask.model.services.ServiceException
createList
in interface ListManagementService
createListRequest
- (required)com.amazon.ask.model.services.ServiceException
- if fails to make API callCopyright © 2023. All rights reserved.