Package video.api.client.api.clients

Class AdvancedAuthenticationApi

java.lang.Object

video.api.client.api.clients.AdvancedAuthenticationApi

public class AdvancedAuthenticationApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AdvancedAuthenticationApi()	Constructor for AdvancedAuthenticationApi production environment where API key is not required.
AdvancedAuthenticationApi(String basePath)	Constructor for AdvancedAuthenticationApi with custom API base path where API key is not required.
AdvancedAuthenticationApi(String apiKey, String basePath)	Constructor for AdvancedAuthenticationApi with custom API base path
AdvancedAuthenticationApi(String apiKey, Environment environment)	Constructor for AdvancedAuthenticationApi with custom API base path
AdvancedAuthenticationApi(ApiClient apiClient)
AdvancedAuthenticationApi(Environment environment)	Constructor for AdvancedAuthenticationApi with custom API base path where API key is not required.

Method Summary

Modifier and Type	Method	Description
AccessToken	authenticate(AuthenticatePayload authenticatePayload)	Get Bearer Token Returns a bearer token that can be used to authenticate other endpoint.
okhttp3.Call	authenticateAsync(AuthenticatePayload authenticatePayload, ApiCallback<AccessToken> _callback)	Get Bearer Token (asynchronously) Returns a bearer token that can be used to authenticate other endpoint.
ApiResponse<AccessToken>	authenticateWithHttpInfo(AuthenticatePayload authenticatePayload)	Get Bearer Token Returns a bearer token that can be used to authenticate other endpoint.
ApiClient	getApiClient()
AccessToken	refresh(RefreshTokenPayload refreshTokenPayload)	Refresh Bearer Token Accepts the old bearer token and returns a new bearer token that can be used to authenticate other endpoint.
okhttp3.Call	refreshAsync(RefreshTokenPayload refreshTokenPayload, ApiCallback<AccessToken> _callback)	Refresh Bearer Token (asynchronously) Accepts the old bearer token and returns a new bearer token that can be used to authenticate other endpoint.
ApiResponse<AccessToken>	refreshWithHttpInfo(RefreshTokenPayload refreshTokenPayload)	Refresh Bearer Token Accepts the old bearer token and returns a new bearer token that can be used to authenticate other endpoint.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdvancedAuthenticationApi

public AdvancedAuthenticationApi(ApiClient apiClient)

AdvancedAuthenticationApi

public AdvancedAuthenticationApi()

Constructor for AdvancedAuthenticationApi production environment where API key is not required.

AdvancedAuthenticationApi

public AdvancedAuthenticationApi(String basePath)

Constructor for AdvancedAuthenticationApi with custom API base path where API key is not required.

Parameters:

basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

AdvancedAuthenticationApi

public AdvancedAuthenticationApi(Environment environment)

Constructor for AdvancedAuthenticationApi with custom API base path where API key is not required.

Parameters:

environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

AdvancedAuthenticationApi

public AdvancedAuthenticationApi(String apiKey,
                                 String basePath)

Constructor for AdvancedAuthenticationApi with custom API base path

Parameters:

apiKey - the api key to use to authenticate to the API

basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.

AdvancedAuthenticationApi

public AdvancedAuthenticationApi(String apiKey,
                                 Environment environment)

Constructor for AdvancedAuthenticationApi with custom API base path

Parameters:

apiKey - the api key to use to authenticate to the API

environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

authenticate

public AccessToken authenticate(AuthenticatePayload authenticatePayload)
                         throws ApiException

Get Bearer Token Returns a bearer token that can be used to authenticate other endpoint. You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).

Parameters:

authenticatePayload - (required)

Returns:

AccessToken

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

authenticateWithHttpInfo

public ApiResponse<AccessToken> authenticateWithHttpInfo(AuthenticatePayload authenticatePayload)
                                                  throws ApiException

Get Bearer Token Returns a bearer token that can be used to authenticate other endpoint. You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).

Parameters:

authenticatePayload - (required)

Returns:

ApiResponse<AccessToken>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

authenticateAsync

public okhttp3.Call authenticateAsync(AuthenticatePayload authenticatePayload,
                                      ApiCallback<AccessToken> _callback)
                               throws ApiException

Get Bearer Token (asynchronously) Returns a bearer token that can be used to authenticate other endpoint. You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).

Parameters:

authenticatePayload - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

refresh

public AccessToken refresh(RefreshTokenPayload refreshTokenPayload)
                    throws ApiException

Refresh Bearer Token Accepts the old bearer token and returns a new bearer token that can be used to authenticate other endpoint. You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).

Parameters:

refreshTokenPayload - (required)

Returns:

AccessToken

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

refreshWithHttpInfo

public ApiResponse<AccessToken> refreshWithHttpInfo(RefreshTokenPayload refreshTokenPayload)
                                             throws ApiException

Refresh Bearer Token Accepts the old bearer token and returns a new bearer token that can be used to authenticate other endpoint. You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).

Parameters:

refreshTokenPayload - (required)

Returns:

ApiResponse<AccessToken>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

refreshAsync

public okhttp3.Call refreshAsync(RefreshTokenPayload refreshTokenPayload,
                                 ApiCallback<AccessToken> _callback)
                          throws ApiException

Refresh Bearer Token (asynchronously) Accepts the old bearer token and returns a new bearer token that can be used to authenticate other endpoint. You can find the tutorial on using the disposable bearer token [here](https://docs.api.video/reference/disposable-bearer-token-authentication).

Parameters:

refreshTokenPayload - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-