@bitmovin/api-sdk/dist/encoding/inputs/local/LocalApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import LocalInput from '../../../models/LocalInput';
import PaginationResponse from '../../../models/PaginationResponse';
import { LocalInputListQueryParams, LocalInputListQueryParamsBuilder } from './LocalInputListQueryParams';
/**
 * LocalApi - object-oriented interface
 * @export
 * @class LocalApi
 * @extends {BaseAPI}
 */
export default class LocalApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Local Input
     * @param {LocalInput} localInput The LocalInput to be created.
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    create(localInput?: LocalInput): Promise<LocalInput>;
    /**
     * @summary Delete Local Input
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    delete(inputId: string): Promise<BitmovinResponse>;
    /**
     * @summary Local Input Details
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    get(inputId: string): Promise<LocalInput>;
    /**
     * @summary List Local Inputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof LocalApi
     */
    list(queryParameters?: LocalInputListQueryParams | ((q: LocalInputListQueryParamsBuilder) => LocalInputListQueryParamsBuilder)): Promise<PaginationResponse<LocalInput>>;
}