Class ListClient

Index

Constructors

Methods

addMovie checkItemStatus clear create delete getDetails removeMovie

Constructors

constructor

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

Methods

addMovie

addMovie(
params: AddMovieParams,
request: AddMovieRequest,
): Promise<TMDBResponse>
Add a movie to a list.
Parameters
- params: AddMovieParams
- request: AddMovieRequest
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/list-add-movie
- Defined in client/list/index.ts:55

checkItemStatus

checkItemStatus(params: CheckItemStatusParams): Promise<CheckItemStatusResponse>
Check if an item has already been added to the list.
Parameters
- params: CheckItemStatusParams
Returns Promise<CheckItemStatusResponse>
See
https://developer.themoviedb.org/reference/list-check-item-status
- Defined in client/list/index.ts:87

clear

clear(params: ClearListParams): Promise<TMDBResponse>
Clear all items from a list.
Parameters
- params: ClearListParams
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/list-clear
- Defined in client/list/index.ts:103

create

create(
params: CreateListParams,
request: CreateListRequest,
): Promise<CreateListResponse>
Create a new list.
Parameters
- params: CreateListParams
- request: CreateListRequest
Returns Promise<CreateListResponse>
See
https://developer.themoviedb.org/reference/list-create
- Defined in client/list/index.ts:39

delete

delete(params: DeleteListParams): Promise<TMDBResponse>
Delete a list.
Parameters
- params: DeleteListParams
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/list-delete
- Defined in client/list/index.ts:121

getDetails

getDetails(params: ListDetailsParams): Promise<ListDetails>
Get list details by ID.
Parameters
- params: ListDetailsParams
Returns Promise<ListDetails>
See
https://developer.themoviedb.org/reference/list-details
- Defined in client/list/index.ts:26

removeMovie

removeMovie(
params: RemoveMovieParams,
request: RemoveMovieRequest,
): Promise<TMDBResponse>
Remove a movie from a list.
Parameters
- params: RemoveMovieParams
- request: RemoveMovieRequest
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/list-remove-movie
- Defined in client/list/index.ts:71