@dolbyio/dolbyio-rest-apis-client/dist/media/jobs.d.ts

Node.JS wrapper for the Dolby OptiView REST APIs

import { JwtToken } from './types/jwtToken';
import { ListJobsOptions, ListAllJobsOptions, JobsResponse, Job } from './types/jobs';
/**
 * Query Media Jobs.
 *
 * List of jobs previously submitted, up to the last 31 days.
 *
 * @param accessToken Access token to use for authentication.
 * @param options Options to request the list of jobs.
 *
 * @returns A {@link JobsResponse} object through a {@link Promise}.
 */
export declare const list: (accessToken: JwtToken, options: ListJobsOptions) => Promise<JobsResponse>;
/**
 * Query Media Jobs.
 *
 * List of all jobs previously submitted, up to the last 31 days.
 *
 * @param accessToken Access token to use for authentication.
 * @param options Options to request the list of jobs.
 *
 * @returns An array of {@link Job} objects through a {@link Promise}.
 */
export declare const listAll: (accessToken: JwtToken, options: ListAllJobsOptions) => Promise<Array<Job>>;
/**
 * Requests cancellation of a previously submitted job.
 *
 * @param accessToken Access token to use for authentication.
 * @param jobId Identifier of the job to cancel.
 */
export declare const cancel: (accessToken: JwtToken, jobId: string) => Promise<void>;