@bitmovin/api-sdk/dist/encoding/outputs/sftp/SftpApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import SftpOutput from '../../../models/SftpOutput';
import PaginationResponse from '../../../models/PaginationResponse';
import { SftpOutputListQueryParams, SftpOutputListQueryParamsBuilder } from './SftpOutputListQueryParams';
/**
 * SftpApi - object-oriented interface
 * @export
 * @class SftpApi
 * @extends {BaseAPI}
 */
export default class SftpApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create SFTP Output
     * @param {SftpOutput} sftpOutput The SFTP output to be created.
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    create(sftpOutput?: SftpOutput): Promise<SftpOutput>;
    /**
     * @summary Delete SFTP Output
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    delete(outputId: string): Promise<SftpOutput>;
    /**
     * @summary SFTP Output Details
     * @param {string} outputId Id of the output
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    get(outputId: string): Promise<SftpOutput>;
    /**
     * @summary List SFTP Outputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    list(queryParameters?: SftpOutputListQueryParams | ((q: SftpOutputListQueryParamsBuilder) => SftpOutputListQueryParamsBuilder)): Promise<PaginationResponse<SftpOutput>>;
}