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

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../common/BaseAPI';
import Configuration from '../../common/Configuration';
import TypeApi from './type/TypeApi';
import S3Api from './s3/S3Api';
import S3RoleBasedApi from './s3RoleBased/S3RoleBasedApi';
import GenericS3Api from './genericS3/GenericS3Api';
import LocalApi from './local/LocalApi';
import GcsApi from './gcs/GcsApi';
import GcsServiceAccountApi from './gcsServiceAccount/GcsServiceAccountApi';
import AzureApi from './azure/AzureApi';
import FtpApi from './ftp/FtpApi';
import SftpApi from './sftp/SftpApi';
import AkamaiMslApi from './akamaiMsl/AkamaiMslApi';
import AkamaiNetstorageApi from './akamaiNetstorage/AkamaiNetstorageApi';
import LiveMediaIngestApi from './liveMediaIngest/LiveMediaIngestApi';
import CdnApi from './cdn/CdnApi';
import CheckOutputPermissionsRequest from '../../models/CheckOutputPermissionsRequest';
import CheckOutputPermissionsResponse from '../../models/CheckOutputPermissionsResponse';
import Output from '../../models/Output';
import PaginationResponse from '../../models/PaginationResponse';
import { OutputListQueryParams, OutputListQueryParamsBuilder } from './OutputListQueryParams';
/**
 * OutputsApi - object-oriented interface
 * @export
 * @class OutputsApi
 * @extends {BaseAPI}
 */
export default class OutputsApi extends BaseAPI {
    type: TypeApi;
    s3: S3Api;
    s3RoleBased: S3RoleBasedApi;
    genericS3: GenericS3Api;
    local: LocalApi;
    gcs: GcsApi;
    gcsServiceAccount: GcsServiceAccountApi;
    azure: AzureApi;
    ftp: FtpApi;
    sftp: SftpApi;
    akamaiMsl: AkamaiMslApi;
    akamaiNetstorage: AkamaiNetstorageApi;
    liveMediaIngest: LiveMediaIngestApi;
    cdn: CdnApi;
    constructor(configuration: Configuration);
    /**
     * @summary Check output permissions (S3 only)
     * @param {string} outputId Id of the output to be checked. Currently limited to S3 outputs. The access credentials that have been provided for this Output still need to be valid, otherwise the request will fail. If they are not valid any more, create a new Output with new credentials (resources are immutable).
     * @param {CheckOutputPermissionsRequest} [checkOutputPermissionsRequest] Additional parameters for the permissions check
     * @throws {BitmovinError}
     * @memberof OutputsApi
     */
    checkPermissions(outputId: string, checkOutputPermissionsRequest?: CheckOutputPermissionsRequest): Promise<CheckOutputPermissionsResponse>;
    /**
     * @summary Get Output Details
     * @param {string} outputId Id of the wanted output
     * @throws {BitmovinError}
     * @memberof OutputsApi
     */
    get(outputId: string): Promise<Output>;
    /**
     * @summary List all Outputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof OutputsApi
     */
    list(queryParameters?: OutputListQueryParams | ((q: OutputListQueryParamsBuilder) => OutputListQueryParamsBuilder)): Promise<PaginationResponse<Output>>;
}