Class AuthV4Client

Index

Constructors

Methods

createAccessToken createRequestToken logout

Constructors

constructor

new AuthV4Client(axiosInstance: AxiosInstance): AuthV4Client
Parameters
- axiosInstance: AxiosInstance
Returns AuthV4Client
- Defined in client/auth-v4/index.ts:12

Methods

createAccessToken

createAccessToken(
request: V4CreateAccessTokenRequest,
): Promise<V4CreateAccessTokenResponse>
Finish the user authentication flow and issue an official user access token.
Parameters
- request: V4CreateAccessTokenRequest
Returns Promise<V4CreateAccessTokenResponse>
See
https://developer.themoviedb.org/v4/reference/auth-create-access-token
- Defined in client/auth-v4/index.ts:32

createRequestToken

createRequestToken(
params?: V4CreateRequestTokenParams,
): Promise<V4CreateRequestTokenResponse>
Generate a new request token to ask a user to approve.
Parameters
- Optionalparams: V4CreateRequestTokenParams
Returns Promise<V4CreateRequestTokenResponse>
See
https://developer.themoviedb.org/v4/reference/auth-create-request-token
- Defined in client/auth-v4/index.ts:18

logout

logout(request: V4LogoutRequest): Promise<V4LogoutResponse>
Log out of a session by invalidating an access token.
Parameters
- request: V4LogoutRequest
Returns Promise<V4LogoutResponse>
See
https://developer.themoviedb.org/v4/reference/auth-logout
- Defined in client/auth-v4/index.ts:46