@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
45 lines (44 loc) • 1.61 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import GcsOutput from '../../../models/GcsOutput';
import PaginationResponse from '../../../models/PaginationResponse';
import { GcsOutputListQueryParams, GcsOutputListQueryParamsBuilder } from './GcsOutputListQueryParams';
/**
* GcsApi - object-oriented interface
* @export
* @class GcsApi
* @extends {BaseAPI}
*/
export default class GcsApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create GCS Output
* @param {GcsOutput} gcsOutput The GCS output to be created
* @throws {BitmovinError}
* @memberof GcsApi
*/
create(gcsOutput?: GcsOutput): Promise<GcsOutput>;
/**
* @summary Delete GCS Output
* @param {string} outputId Id of the output
* @throws {BitmovinError}
* @memberof GcsApi
*/
delete(outputId: string): Promise<GcsOutput>;
/**
* @summary GCS Output Details
* @param {string} outputId Id of the output
* @throws {BitmovinError}
* @memberof GcsApi
*/
get(outputId: string): Promise<GcsOutput>;
/**
* @summary List GCS Outputs
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof GcsApi
*/
list(queryParameters?: GcsOutputListQueryParams | ((q: GcsOutputListQueryParamsBuilder) => GcsOutputListQueryParamsBuilder)): Promise<PaginationResponse<GcsOutput>>;
}