Package video.api.client.api.clients

Class WatermarksApi

java.lang.Object

video.api.client.api.clients.WatermarksApi

public class WatermarksApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WatermarksApi.APIlistRequest

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	delete(String watermarkId)	Delete a watermark Delete a watermark.
okhttp3.Call	deleteAsync(String watermarkId, ApiCallback<Void> _callback)	Delete a watermark (asynchronously) Delete a watermark.
ApiResponse<Void>	deleteWithHttpInfo(String watermarkId)	Delete a watermark Delete a watermark.
ApiClient	getApiClient()
WatermarksApi.APIlistRequest	list()	List all watermarks List all watermarks associated with your workspace.
void	setApiClient(ApiClient apiClient)
Watermark	upload(File file)	Upload a watermark Create a new watermark by uploading a `JPG` or a `PNG` image.
okhttp3.Call	uploadAsync(File file, ApiCallback<Watermark> _callback)	Upload a watermark (asynchronously) Create a new watermark by uploading a `JPG` or a `PNG` image.
ApiResponse<Watermark>	uploadWithHttpInfo(File file)	Upload a watermark Create a new watermark by uploading a `JPG` or a `PNG` image.

Methods inherited from class java.lang.Object

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

Constructor Detail

WatermarksApi

public WatermarksApi(ApiClient apiClient)

WatermarksApi

public WatermarksApi()

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

WatermarksApi

public WatermarksApi(String basePath)

Constructor for WatermarksApi 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.

WatermarksApi

public WatermarksApi(Environment environment)

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

Parameters:

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

WatermarksApi

public WatermarksApi(String apiKey,
                     String basePath)

Constructor for WatermarksApi 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.

WatermarksApi

public WatermarksApi(String apiKey,
                     Environment environment)

Constructor for WatermarksApi 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)

upload

public Watermark upload(File file)
                 throws ApiException

Upload a watermark Create a new watermark by uploading a `JPG` or a `PNG` image.

Parameters:

file - The `.jpg` or `.png` image to be added as a watermark. (required)

Returns:

Watermark

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	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

uploadWithHttpInfo

public ApiResponse<Watermark> uploadWithHttpInfo(File file)
                                          throws ApiException

Upload a watermark Create a new watermark by uploading a `JPG` or a `PNG` image.

Parameters:

file - The `.jpg` or `.png` image to be added as a watermark. (required)

Returns:

ApiResponse<Watermark>

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	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

uploadAsync

public okhttp3.Call uploadAsync(File file,
                                ApiCallback<Watermark> _callback)
                         throws ApiException

Upload a watermark (asynchronously) Create a new watermark by uploading a `JPG` or a `PNG` image.

Parameters:

file - The `.jpg` or `.png` image to be added as a watermark. (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	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

delete

public void delete(String watermarkId)
            throws ApiException

Delete a watermark Delete a watermark.

Parameters:

watermarkId - The watermark ID for the watermark you want to delete. (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	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

deleteWithHttpInfo

public ApiResponse<Void> deleteWithHttpInfo(String watermarkId)
                                     throws ApiException

Delete a watermark Delete a watermark.

Parameters:

watermarkId - The watermark ID for the watermark you want to delete. (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	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

deleteAsync

public okhttp3.Call deleteAsync(String watermarkId,
                                ApiCallback<Void> _callback)
                         throws ApiException

Delete a watermark (asynchronously) Delete a watermark.

Parameters:

watermarkId - The watermark ID for the watermark you want to delete. (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	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

list

public WatermarksApi.APIlistRequest list()

List all watermarks List all watermarks associated with your workspace.

Returns:

APIlistRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.