@bitmovin/api-sdk/dist/encoding/inputs/ftp/FtpApi.d.ts

Bitmovin JS/TS API SDK

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