Package video.api.client.api.clients

Class SummariesApi

java.lang.Object

video.api.client.api.clients.SummariesApi

public class SummariesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SummariesApi.APIlistRequest

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Summary	create(SummaryCreationPayload summaryCreationPayload)	Generate video summary Generate a title, abstract, and key takeaways for a video.
okhttp3.Call	createAsync(SummaryCreationPayload summaryCreationPayload, ApiCallback<Summary> _callback)	Generate video summary (asynchronously) Generate a title, abstract, and key takeaways for a video.
ApiResponse<Summary>	createWithHttpInfo(SummaryCreationPayload summaryCreationPayload)	Generate video summary Generate a title, abstract, and key takeaways for a video.
void	delete(String summaryId)	Delete video summary Delete a summary tied to a video.
okhttp3.Call	deleteAsync(String summaryId, ApiCallback<Void> _callback)	Delete video summary (asynchronously) Delete a summary tied to a video.
ApiResponse<Void>	deleteWithHttpInfo(String summaryId)	Delete video summary Delete a summary tied to a video.
ApiClient	getApiClient()
SummarySource	getSummarySource(String summaryId)	Get summary details Get all details for a summary.
okhttp3.Call	getSummarySourceAsync(String summaryId, ApiCallback<SummarySource> _callback)	Get summary details (asynchronously) Get all details for a summary.
ApiResponse<SummarySource>	getSummarySourceWithHttpInfo(String summaryId)	Get summary details Get all details for a summary.
SummariesApi.APIlistRequest	list()	List summaries List all summarries for your videos in a project.
void	setApiClient(ApiClient apiClient)
SummarySource	update(String summaryId, SummaryUpdatePayload summaryUpdatePayload)	Update summary details Update details for a summary.
okhttp3.Call	updateAsync(String summaryId, SummaryUpdatePayload summaryUpdatePayload, ApiCallback<SummarySource> _callback)	Update summary details (asynchronously) Update details for a summary.
ApiResponse<SummarySource>	updateWithHttpInfo(String summaryId, SummaryUpdatePayload summaryUpdatePayload)	Update summary details Update details for a summary.

Methods inherited from class java.lang.Object

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

Constructor Detail

SummariesApi

public SummariesApi(ApiClient apiClient)

SummariesApi

public SummariesApi()

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

SummariesApi

public SummariesApi(String basePath)

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

SummariesApi

public SummariesApi(Environment environment)

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

Parameters:

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

SummariesApi

public SummariesApi(String apiKey,
                    String basePath)

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

SummariesApi

public SummariesApi(String apiKey,
                    Environment environment)

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

create

public Summary create(SummaryCreationPayload summaryCreationPayload)
               throws ApiException

Generate video summary Generate a title, abstract, and key takeaways for a video.

Parameters:

summaryCreationPayload - (required)

Returns:

Summary

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
201	Created	* 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.
409	Conflict	* 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.

createWithHttpInfo

public ApiResponse<Summary> createWithHttpInfo(SummaryCreationPayload summaryCreationPayload)
                                        throws ApiException

Generate video summary Generate a title, abstract, and key takeaways for a video.

Parameters:

summaryCreationPayload - (required)

Returns:

ApiResponse<Summary>

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
201	Created	* 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.
409	Conflict	* 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.

createAsync

public okhttp3.Call createAsync(SummaryCreationPayload summaryCreationPayload,
                                ApiCallback<Summary> _callback)
                         throws ApiException

Generate video summary (asynchronously) Generate a title, abstract, and key takeaways for a video.

Parameters:

summaryCreationPayload - (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
201	Created	* 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.
409	Conflict	* 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.

update

public SummarySource update(String summaryId,
                            SummaryUpdatePayload summaryUpdatePayload)
                     throws ApiException

Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`.

Parameters:

summaryId - The unique identifier of the summary source you want to update. (required)

summaryUpdatePayload - (required)

Returns:

SummarySource

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
201	Created	* 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.
409	Conflict	* 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.

updateWithHttpInfo

public ApiResponse<SummarySource> updateWithHttpInfo(String summaryId,
                                                     SummaryUpdatePayload summaryUpdatePayload)
                                              throws ApiException

Update summary details Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`.

Parameters:

summaryId - The unique identifier of the summary source you want to update. (required)

summaryUpdatePayload - (required)

Returns:

ApiResponse<SummarySource>

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
201	Created	* 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.
409	Conflict	* 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.

updateAsync

public okhttp3.Call updateAsync(String summaryId,
                                SummaryUpdatePayload summaryUpdatePayload,
                                ApiCallback<SummarySource> _callback)
                         throws ApiException

Update summary details (asynchronously) Update details for a summary. Note that this operation is only allowed for summary objects where `sourceStatus` is `missing`.

Parameters:

summaryId - The unique identifier of the summary source you want to update. (required)

summaryUpdatePayload - (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
201	Created	* 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.
409	Conflict	* 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 summaryId)
            throws ApiException

Delete video summary Delete a summary tied to a video.

Parameters:

summaryId - The unique identifier of the summary 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.

deleteWithHttpInfo

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

Delete video summary Delete a summary tied to a video.

Parameters:

summaryId - The unique identifier of the summary 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.

deleteAsync

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

Delete video summary (asynchronously) Delete a summary tied to a video.

Parameters:

summaryId - The unique identifier of the summary 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.

list

public SummariesApi.APIlistRequest list()

List summaries List all summarries for your videos in a project.

Returns:

APIlistRequest

Http Response Details:

Status Code	Description	Response Headers
200	Created	* 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.

getSummarySource

public SummarySource getSummarySource(String summaryId)
                               throws ApiException

Get summary details Get all details for a summary.

Parameters:

summaryId - The unique identifier of the summary source you want to retrieve. (required)

Returns:

SummarySource

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.
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.

getSummarySourceWithHttpInfo

public ApiResponse<SummarySource> getSummarySourceWithHttpInfo(String summaryId)
                                                        throws ApiException

Get summary details Get all details for a summary.

Parameters:

summaryId - The unique identifier of the summary source you want to retrieve. (required)

Returns:

ApiResponse<SummarySource>

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.
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.

getSummarySourceAsync

public okhttp3.Call getSummarySourceAsync(String summaryId,
                                          ApiCallback<SummarySource> _callback)
                                   throws ApiException

Get summary details (asynchronously) Get all details for a summary.

Parameters:

summaryId - The unique identifier of the summary source you want to retrieve. (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.
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.