@bitmovin/api-sdk/dist/encoding/outputs/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 FtpOutput from '../../../models/FtpOutput';
import PaginationResponse from '../../../models/PaginationResponse';
import { FtpOutputListQueryParams, FtpOutputListQueryParamsBuilder } from './FtpOutputListQueryParams';
/**
 * FtpApi - object-oriented interface
 * @export
 * @class FtpApi
 * @extends {BaseAPI}
 */
export default class FtpApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create FTP Output
     * @param {FtpOutput} ftpOutput The FTP output to be created
     * @throws {BitmovinError}
     * @memberof FtpApi
     */
    create(ftpOutput?: FtpOutput): Promise<FtpOutput>;
    /**
     * @summary Delete FTP Output
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof FtpApi
     */
    delete(outputId: string): Promise<FtpOutput>;
    /**
     * @summary FTP Output Details
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof FtpApi
     */
    get(outputId: string): Promise<FtpOutput>;
    /**
     * @summary List FTP Outputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof FtpApi
     */
    list(queryParameters?: FtpOutputListQueryParams | ((q: FtpOutputListQueryParamsBuilder) => FtpOutputListQueryParamsBuilder)): Promise<PaginationResponse<FtpOutput>>;
}