@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
45 lines (44 loc) • 1.75 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import GenericS3Input from '../../../models/GenericS3Input';
import PaginationResponse from '../../../models/PaginationResponse';
import { GenericS3InputListQueryParams, GenericS3InputListQueryParamsBuilder } from './GenericS3InputListQueryParams';
/**
* GenericS3Api - object-oriented interface
* @export
* @class GenericS3Api
* @extends {BaseAPI}
*/
export default class GenericS3Api extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create Generic S3 Input
* @param {GenericS3Input} genericS3Input The GenericS3 input to be created
* @throws {BitmovinError}
* @memberof GenericS3Api
*/
create(genericS3Input?: GenericS3Input): Promise<GenericS3Input>;
/**
* @summary Delete Generic S3 Input
* @param {string} inputId Id of the input
* @throws {BitmovinError}
* @memberof GenericS3Api
*/
delete(inputId: string): Promise<GenericS3Input>;
/**
* @summary Generic S3 Input Details
* @param {string} inputId Id of the input
* @throws {BitmovinError}
* @memberof GenericS3Api
*/
get(inputId: string): Promise<GenericS3Input>;
/**
* @summary List Generic S3 Inputs
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof GenericS3Api
*/
list(queryParameters?: GenericS3InputListQueryParams | ((q: GenericS3InputListQueryParamsBuilder) => GenericS3InputListQueryParamsBuilder)): Promise<PaginationResponse<GenericS3Input>>;
}