/** * @api.video/nodejs-client * api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. * * The version of the OpenAPI document: 1 * * * NOTE: This class is auto generated. * Do not edit the class manually. */ import HttpClient, { ApiResponseHeaders } from '../HttpClient'; import SummariesListResponse from '../model/SummariesListResponse'; import Summary from '../model/Summary'; import SummaryCreationPayload from '../model/SummaryCreationPayload'; import SummarySource from '../model/SummarySource'; import SummaryUpdatePayload from '../model/SummaryUpdatePayload'; /** * no description */ export default class SummariesApi { private httpClient; constructor(httpClient: HttpClient); /** * Generate an abstract and key takeaways for a video. * Generate video summary * @param summaryCreationPayload */ create(summaryCreationPayload: SummaryCreationPayload): Promise; /** * Generate an abstract and key takeaways for a video. * Generate video summary * @param summaryCreationPayload */ createWithResponseHeaders(summaryCreationPayload: SummaryCreationPayload): Promise<{ headers: ApiResponseHeaders; body: Summary; }>; /** * Update details for a summary. * Update summary details * @param summaryId The unique identifier of the summary source you want to update. * @param summaryUpdatePayload */ update(summaryId: string, summaryUpdatePayload?: SummaryUpdatePayload): Promise; /** * Update details for a summary. * Update summary details * @param summaryId The unique identifier of the summary source you want to update. * @param summaryUpdatePayload */ updateWithResponseHeaders(summaryId: string, summaryUpdatePayload?: SummaryUpdatePayload): Promise<{ headers: ApiResponseHeaders; body: SummarySource; }>; /** * Delete a summary tied to a video. * Delete video summary * @param summaryId The unique identifier of the summary you want to delete. */ delete(summaryId: string): Promise; /** * Delete a summary tied to a video. * Delete video summary * @param summaryId The unique identifier of the summary you want to delete. */ deleteWithResponseHeaders(summaryId: string): Promise<{ headers: ApiResponseHeaders; body: void; }>; /** * List all summarries for your videos in a project. * List summaries * @param {Object} searchParams * @param { string } searchParams.videoId Use this parameter to filter for a summary that belongs to a specific video. * @param { 'auto' | 'api' } searchParams.origin Use this parameter to filter for summaries based on the way they were created: automatically or manually via the API. * @param { 'missing' | 'waiting' | 'failed' | 'completed' | 'unprocessable' } searchParams.sourceStatus Use this parameter to filter for summaries based on the current status of the summary source. These are the available statuses: `missing`: the input for a summary is not present. `waiting` : the input video is being processed and a summary will be generated. `failed`: a technical issue prevented summary generation. `completed`: the summary is generated. `unprocessable`: the API rules the source video to be unsuitable for summary generation. An example for this is an input video that has no audio. * @param { 'createdAt' | 'updatedAt' | 'videoId' } searchParams.sortBy Use this parameter to choose which field the API will use to sort the response data. The default is `value`. These are the available fields to sort by: - `createdAt`: Sorts the results based on date and timestamps when summaries were created. - `updatedAt`: Sorts the results based on date and timestamps when summaries were last updated. - `videoId`: Sorts the results based on video IDs. * @param { 'asc' | 'desc' } searchParams.sortOrder Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. * @param { number } searchParams.currentPage Choose the number of search results to return per page. Minimum value: 1 * @param { number } searchParams.pageSize Results per page. Allowed values 1-100, default is 25. */ list(args: { videoId?: string; origin?: 'auto' | 'api'; sourceStatus?: 'missing' | 'waiting' | 'failed' | 'completed' | 'unprocessable'; sortBy?: 'createdAt' | 'updatedAt' | 'videoId'; sortOrder?: 'asc' | 'desc'; currentPage?: number; pageSize?: number; }): Promise; /** * List all summarries for your videos in a project. * List summaries * @param {Object} searchParams * @param { string } searchParams.videoId Use this parameter to filter for a summary that belongs to a specific video. * @param { 'auto' | 'api' } searchParams.origin Use this parameter to filter for summaries based on the way they were created: automatically or manually via the API. * @param { 'missing' | 'waiting' | 'failed' | 'completed' | 'unprocessable' } searchParams.sourceStatus Use this parameter to filter for summaries based on the current status of the summary source. These are the available statuses: `missing`: the input for a summary is not present. `waiting` : the input video is being processed and a summary will be generated. `failed`: a technical issue prevented summary generation. `completed`: the summary is generated. `unprocessable`: the API rules the source video to be unsuitable for summary generation. An example for this is an input video that has no audio. * @param { 'createdAt' | 'updatedAt' | 'videoId' } searchParams.sortBy Use this parameter to choose which field the API will use to sort the response data. The default is `value`. These are the available fields to sort by: - `createdAt`: Sorts the results based on date and timestamps when summaries were created. - `updatedAt`: Sorts the results based on date and timestamps when summaries were last updated. - `videoId`: Sorts the results based on video IDs. * @param { 'asc' | 'desc' } searchParams.sortOrder Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. * @param { number } searchParams.currentPage Choose the number of search results to return per page. Minimum value: 1 * @param { number } searchParams.pageSize Results per page. Allowed values 1-100, default is 25. */ listWithResponseHeaders({ videoId, origin, sourceStatus, sortBy, sortOrder, currentPage, pageSize, }: { videoId?: string; origin?: 'auto' | 'api'; sourceStatus?: 'missing' | 'waiting' | 'failed' | 'completed' | 'unprocessable'; sortBy?: 'createdAt' | 'updatedAt' | 'videoId'; sortOrder?: 'asc' | 'desc'; currentPage?: number; pageSize?: number; }): Promise<{ headers: ApiResponseHeaders; body: SummariesListResponse; }>; /** * Get all details for a summary. * Get summary details * @param summaryId The unique identifier of the summary source you want to retrieve. */ getSummarySource(summaryId: string): Promise; /** * Get all details for a summary. * Get summary details * @param summaryId The unique identifier of the summary source you want to retrieve. */ getSummarySourceWithResponseHeaders(summaryId: string): Promise<{ headers: ApiResponseHeaders; body: SummarySource; }>; }