Package video.api.client.api.clients

Class UploadTokensApi

  • public class UploadTokensApi
extends Object

    • Constructor Detail

      • UploadTokensApi

        public UploadTokensApi​(ApiClient apiClient)

      • UploadTokensApi

        public UploadTokensApi()
        Constructor for UploadTokensApi production environment where API key is not required.

      • UploadTokensApi

        public UploadTokensApi​(String basePath)
        Constructor for UploadTokensApi 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.

      • UploadTokensApi

        public UploadTokensApi​(Environment environment)
        Constructor for UploadTokensApi with custom API base path where API key is not required.
        Parameters:
        environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

      • UploadTokensApi

        public UploadTokensApi​(String apiKey,
                       String basePath)
        Constructor for UploadTokensApi 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.

      • UploadTokensApi

        public UploadTokensApi​(String apiKey,
                       Environment environment)
        Constructor for UploadTokensApi 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)

      • createToken

        public UploadToken createToken​(TokenCreationPayload tokenCreationPayload)
                        throws ApiException
        Generate an upload token Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/reference/upload-tokens)
        Parameters:
        tokenCreationPayload - (required)
        Returns:
        UploadToken
        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 -

      • createTokenWithHttpInfo

        public ApiResponse<UploadToken> createTokenWithHttpInfo​(TokenCreationPayload tokenCreationPayload)
                                                 throws ApiException
        Generate an upload token Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/reference/upload-tokens)
        Parameters:
        tokenCreationPayload - (required)
        Returns:
        ApiResponse<UploadToken>
        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 -

      • createTokenAsync

        public okhttp3.Call createTokenAsync​(TokenCreationPayload tokenCreationPayload,
                                     ApiCallback<UploadToken> _callback)
                              throws ApiException
        Generate an upload token (asynchronously) Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/reference/upload-tokens)
        Parameters:
        tokenCreationPayload - (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 -

      • getToken

        public UploadToken getToken​(String uploadToken)
                     throws ApiException
        Retrieve upload token Retrieve details about a specific upload token by id.
        Parameters:
        uploadToken - The unique identifier for the token you want information about. (required)
        Returns:
        UploadToken
        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 -
        404 Not Found -

      • getTokenWithHttpInfo

        public ApiResponse<UploadToken> getTokenWithHttpInfo​(String uploadToken)
                                              throws ApiException
        Retrieve upload token Retrieve details about a specific upload token by id.
        Parameters:
        uploadToken - The unique identifier for the token you want information about. (required)
        Returns:
        ApiResponse<UploadToken>
        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 -
        404 Not Found -

      • getTokenAsync

        public okhttp3.Call getTokenAsync​(String uploadToken,
                                  ApiCallback<UploadToken> _callback)
                           throws ApiException
        Retrieve upload token (asynchronously) Retrieve details about a specific upload token by id.
        Parameters:
        uploadToken - The unique identifier for the token you want information about. (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 -
        404 Not Found -

      • deleteToken

        public void deleteToken​(String uploadToken)
                 throws ApiException
        Delete an upload token Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.
        Parameters:
        uploadToken - The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication. (required)
        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
        204 No Content -
        404 Not Found -

      • deleteTokenWithHttpInfo

        public ApiResponse<Void> deleteTokenWithHttpInfo​(String uploadToken)
                                          throws ApiException
        Delete an upload token Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.
        Parameters:
        uploadToken - The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication. (required)
        Returns:
        ApiResponse<Void>
        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
        204 No Content -
        404 Not Found -

      • deleteTokenAsync

        public okhttp3.Call deleteTokenAsync​(String uploadToken,
                                     ApiCallback<Void> _callback)
                              throws ApiException
        Delete an upload token (asynchronously) Delete an existing upload token. This is especially useful for tokens you may have created that do not expire.
        Parameters:
        uploadToken - The unique identifier for the upload token you want to delete. Deleting a token will make it so the token can no longer be used for authentication. (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
        204 No Content -
        404 Not Found -

      • list

        public UploadTokensApi.APIlistRequest list()
        List all active upload tokens Retrieve a list of all currently active delegated tokens.
        Returns:
        APIlistRequest
        Http Response Details:
        Status Code Description Response Headers
        200 Success -