@bitmovin/api-sdk/dist/analytics/exports/ExportsApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../common/BaseAPI';
import Configuration from '../../common/Configuration';
import AnalyticsExportTask from '../../models/AnalyticsExportTask';
import PaginationResponse from '../../models/PaginationResponse';
import { AnalyticsExportTaskListQueryParams, AnalyticsExportTaskListQueryParamsBuilder } from './AnalyticsExportTaskListQueryParams';
/**
 * ExportsApi - object-oriented interface
 * @export
 * @class ExportsApi
 * @extends {BaseAPI}
 */
export default class ExportsApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Create Export Task
     * @param {AnalyticsExportTask} analyticsExportTask The export task to be created
     * @throws {BitmovinError}
     * @memberof ExportsApi
     */
    create(analyticsExportTask?: AnalyticsExportTask): Promise<AnalyticsExportTask>;
    /**
     * @summary Get export task
     * @param {string} exportTaskId Export task id
     * @throws {BitmovinError}
     * @memberof ExportsApi
     */
    get(exportTaskId: string): Promise<AnalyticsExportTask>;
    /**
     * @summary List Export Tasks
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof ExportsApi
     */
    list(queryParameters?: AnalyticsExportTaskListQueryParams | ((q: AnalyticsExportTaskListQueryParamsBuilder) => AnalyticsExportTaskListQueryParamsBuilder)): Promise<PaginationResponse<AnalyticsExportTask>>;
}