Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListManagementServiceClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected apiConfiguration

apiConfiguration: ApiConfiguration

ApiConfiguration instance to provide dependencies for this service client

Private userAgent

userAgent: string

Methods

callCreateList

callCreateListItem

  • Parameters

    • listId: string

      The customer’s listId retrieved from a getListsMetadata call.

    • createListItemRequest: CreateListItemRequest

    Returns Promise<ApiResponse>

callDeleteList

  • Parameters

    • listId: string

      Value of the customer’s listId retrieved from a getListsMetadata call

    Returns Promise<ApiResponse>

callDeleteListItem

  • callDeleteListItem(listId: string, itemId: string): Promise<ApiResponse>

  • Parameters

    • listId: string

      The customer’s listId is retrieved from a getListsMetadata call.

    • itemId: string

      The customer’s itemId is retrieved from a GetList call.

    Returns Promise<ApiResponse>

callGetList

  • callGetList(listId: string, status: string): Promise<ApiResponse>

  • Parameters

    • listId: string

      Retrieved from a call to GetListsMetadata to specify the listId in the request path.

    • status: string

      Specify the status of the list.

    Returns Promise<ApiResponse>

callGetListItem

  • callGetListItem(listId: string, itemId: string): Promise<ApiResponse>

  • Parameters

    • listId: string

      Retrieved from a call to getListsMetadata

    • itemId: string

      itemId within a list is retrieved from a getList call

    Returns Promise<ApiResponse>

callGetListsMetadata

  • Returns Promise<ApiResponse>

callUpdateList

  • Parameters

    • listId: string

      Value of the customer’s listId retrieved from a getListsMetadata call.

    • updateListRequest: UpdateListRequest

    Returns Promise<ApiResponse>

callUpdateListItem

  • Parameters

    • listId: string

      Customer’s listId

    • itemId: string

      itemId to be updated in the list

    • updateListItemRequest: UpdateListItemRequest

    Returns Promise<ApiResponse>

createList

createListItem

  • Parameters

    • listId: string

      The customer’s listId retrieved from a getListsMetadata call.

    • createListItemRequest: CreateListItemRequest

    Returns Promise<AlexaListItem>

deleteList

  • deleteList(listId: string): Promise<void>

  • Parameters

    • listId: string

      Value of the customer’s listId retrieved from a getListsMetadata call

    Returns Promise<void>

deleteListItem

  • deleteListItem(listId: string, itemId: string): Promise<void>

  • Parameters

    • listId: string

      The customer’s listId is retrieved from a getListsMetadata call.

    • itemId: string

      The customer’s itemId is retrieved from a GetList call.

    Returns Promise<void>

getList

  • getList(listId: string, status: string): Promise<AlexaList>

  • Parameters

    • listId: string

      Retrieved from a call to GetListsMetadata to specify the listId in the request path.

    • status: string

      Specify the status of the list.

    Returns Promise<AlexaList>

getListItem

  • getListItem(listId: string, itemId: string): Promise<AlexaListItem>

  • Parameters

    • listId: string

      Retrieved from a call to getListsMetadata

    • itemId: string

      itemId within a list is retrieved from a getList call

    Returns Promise<AlexaListItem>

getListsMetadata

  • Returns Promise<AlexaListsMetadata>

Protected invoke

  • invoke(method: string, endpoint: string, path: string, pathParams: Map<string, string>, queryParams: Array<object>, headerParams: Array<object>, bodyParam: any, errors: Map<number, string>, nonJsonBody?: boolean): Promise<any>

  • Invocation wrapper to implement service operations in generated classes

    Parameters

    • method: string

      HTTP method, such as 'POST', 'GET', 'DELETE', etc.

    • endpoint: string

      base API url

    • path: string

      the path pattern with possible placeholders for path parameters in form {paramName}

    • pathParams: Map<string, string>

      path parameters collection

    • queryParams: Array<object>

      query parameters collection

    • headerParams: Array<object>

      headers collection

    • bodyParam: any

      if body parameter is present it is provided here, otherwise null or undefined

    • errors: Map<number, string>

      maps recognized status codes to messages

    • Optional nonJsonBody: boolean

      if the body is in JSON format

    Returns Promise<any>

updateList

  • Parameters

    • listId: string

      Value of the customer’s listId retrieved from a getListsMetadata call.

    • updateListRequest: UpdateListRequest

    Returns Promise<AlexaListMetadata>

updateListItem

  • Parameters

    • listId: string

      Customer’s listId

    • itemId: string

      itemId to be updated in the list

    • updateListItemRequest: UpdateListItemRequest

    Returns Promise<AlexaListItem>

withRequestInterceptors

  • withRequestInterceptors(...requestInterceptors: Array<function>): BaseServiceClient

withResponseInterceptors

  • withResponseInterceptors(...responseInterceptors: Array<function>): BaseServiceClient