Class ListV4Client

Index

Constructors

Methods

addItems clear create delete getDetails getItemStatus removeItems update updateItems

Constructors

constructor

new ListV4Client(axiosInstance: AxiosInstance): ListV4Client
Parameters
- axiosInstance: AxiosInstance
Returns ListV4Client
- Defined in client/list-v4/index.ts:20

Methods

addItems

addItems(
listId: number,
request: V4AddItemsRequest,
): Promise<V4ListActionResponse>
Add items to a list.
Parameters
- listId: number
- request: V4AddItemsRequest
Returns Promise<V4ListActionResponse>
See
https://developer.themoviedb.org/v4/reference/list-add-items
- Defined in client/list-v4/index.ts:83

clear

clear(listId: number): Promise<V4ClearListResponse>
Clear all items from a list.
Parameters
- listId: number
Returns Promise<V4ClearListResponse>
See
https://developer.themoviedb.org/v4/reference/list-clear
- Defined in client/list-v4/index.ts:128

create

create(request: V4CreateListRequest): Promise<V4CreateListResponse>
Create a new list.
Parameters
- request: V4CreateListRequest
Returns Promise<V4CreateListResponse>
See
https://developer.themoviedb.org/v4/reference/list-create
- Defined in client/list-v4/index.ts:41

delete

delete(listId: number): Promise<V4DeleteListResponse>
Delete a list.
Parameters
- listId: number
Returns Promise<V4DeleteListResponse>
See
https://developer.themoviedb.org/v4/reference/list-delete
- Defined in client/list-v4/index.ts:70

getDetails

getDetails(listId: number, params?: V4ListDetailsParams): Promise<V4ListDetails>
Retrieve a list by id.
Parameters
- listId: number
- Optionalparams: V4ListDetailsParams
Returns Promise<V4ListDetails>
See
https://developer.themoviedb.org/v4/reference/list-details
- Defined in client/list-v4/index.ts:26

getItemStatus

getItemStatus(
listId: number,
params: V4ItemStatusParams,
): Promise<V4ItemStatusResponse>
Check if an item is on a list.
Parameters
- listId: number
- params: V4ItemStatusParams
Returns Promise<V4ItemStatusResponse>
See
https://developer.themoviedb.org/v4/reference/list-item-status
- Defined in client/list-v4/index.ts:141

removeItems

removeItems(
listId: number,
request: V4RemoveItemsRequest,
): Promise<V4ListActionResponse>
Remove items from a list.
Parameters
- listId: number
- request: V4RemoveItemsRequest
Returns Promise<V4ListActionResponse>
See
https://developer.themoviedb.org/v4/reference/list-remove-items
- Defined in client/list-v4/index.ts:113

update

update(
listId: number,
request: V4UpdateListRequest,
): Promise<V4CreateListResponse>
Update the details of a list.
Parameters
- listId: number
- request: V4UpdateListRequest
Returns Promise<V4CreateListResponse>
See
https://developer.themoviedb.org/v4/reference/list-update
- Defined in client/list-v4/index.ts:55

updateItems

updateItems(
listId: number,
request: V4UpdateItemsRequest,
): Promise<V4ListActionResponse>
Update individual items on a list.
Parameters
- listId: number
- request: V4UpdateItemsRequest
Returns Promise<V4ListActionResponse>
See
https://developer.themoviedb.org/v4/reference/list-update-items
- Defined in client/list-v4/index.ts:98