@bitmovin/api-sdk/dist/encoding/inputs/zixi/ZixiApi.d.ts

Bitmovin JS/TS API SDK

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