@bitmovin/api-sdk/dist/encoding/outputs/genericS3/GenericS3Api.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import GenericS3Output from '../../../models/GenericS3Output';
import PaginationResponse from '../../../models/PaginationResponse';
import { GenericS3OutputListQueryParams, GenericS3OutputListQueryParamsBuilder } from './GenericS3OutputListQueryParams';
/**
 * GenericS3Api - object-oriented interface
 * @export
 * @class GenericS3Api
 * @extends {BaseAPI}
 */
export default class GenericS3Api extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Generic S3 Output
     * @param {GenericS3Output} genericS3Output The Generic S3 output to be created
     * @throws {BitmovinError}
     * @memberof GenericS3Api
     */
    create(genericS3Output?: GenericS3Output): Promise<GenericS3Output>;
    /**
     * @summary Delete Generic S3 Output
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof GenericS3Api
     */
    delete(outputId: string): Promise<GenericS3Output>;
    /**
     * @summary Generic S3 Output Details
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof GenericS3Api
     */
    get(outputId: string): Promise<GenericS3Output>;
    /**
     * @summary List Generic S3 Outputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof GenericS3Api
     */
    list(queryParameters?: GenericS3OutputListQueryParams | ((q: GenericS3OutputListQueryParamsBuilder) => GenericS3OutputListQueryParamsBuilder)): Promise<PaginationResponse<GenericS3Output>>;
}