@bitmovin/api-sdk/dist/encoding/inputs/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 SftpInput from '../../../models/SftpInput';
import PaginationResponse from '../../../models/PaginationResponse';
import { SftpInputListQueryParams, SftpInputListQueryParamsBuilder } from './SftpInputListQueryParams';
/**
 * SftpApi - object-oriented interface
 * @export
 * @class SftpApi
 * @extends {BaseAPI}
 */
export default class SftpApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create SFTP Input
     * @param {SftpInput} sftpInput The SFTP input to be created
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    create(sftpInput?: SftpInput): Promise<SftpInput>;
    /**
     * @summary Delete SFTP Input
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    delete(inputId: string): Promise<SftpInput>;
    /**
     * @summary SFTP Input Details
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    get(inputId: string): Promise<SftpInput>;
    /**
     * @summary List SFTP Inputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof SftpApi
     */
    list(queryParameters?: SftpInputListQueryParams | ((q: SftpInputListQueryParamsBuilder) => SftpInputListQueryParamsBuilder)): Promise<PaginationResponse<SftpInput>>;
}