@bitmovin/api-sdk/dist/encoding/live/encodings/dnsMappings/DnsMappingsApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../../common/BaseAPI';
import Configuration from '../../../../common/Configuration';
import BitmovinResponse from '../../../../models/BitmovinResponse';
import BitmovinResponseList from '../../../../models/BitmovinResponseList';
import DnsMappingRequest from '../../../../models/DnsMappingRequest';
import DnsMappingResponse from '../../../../models/DnsMappingResponse';
import PaginationResponse from '../../../../models/PaginationResponse';
import { DnsMappingResponseListQueryParams, DnsMappingResponseListQueryParamsBuilder } from './DnsMappingResponseListQueryParams';
/**
 * DnsMappingsApi - object-oriented interface
 * @export
 * @class DnsMappingsApi
 * @extends {BaseAPI}
 */
export default class DnsMappingsApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Create new DNS mapping for encoding
     * @param {string} encodingId Id of the encoding.
     * @param {DnsMappingRequest} dnsMappingRequest The DNS mapping to be created
     * @throws {BitmovinError}
     * @memberof DnsMappingsApi
     */
    create(encodingId: string, dnsMappingRequest?: DnsMappingRequest): Promise<DnsMappingResponse>;
    /**
     * @summary Delete DNS mapping
     * @param {string} encodingId Id of the encoding.
     * @param {string} id Id of the DNS mapping
     * @throws {BitmovinError}
     * @memberof DnsMappingsApi
     */
    delete(encodingId: string, id: string): Promise<BitmovinResponse>;
    /**
     * @summary Delete all DNS mappings for encoding
     * @param {string} encodingId Id of the encoding.
     * @throws {BitmovinError}
     * @memberof DnsMappingsApi
     */
    deleteAll(encodingId: string): Promise<BitmovinResponseList>;
    /**
     * @summary DNS mapping details
     * @param {string} encodingId Id of the encoding.
     * @param {string} id Id of the DNS mapping
     * @throws {BitmovinError}
     * @memberof DnsMappingsApi
     */
    get(encodingId: string, id: string): Promise<DnsMappingResponse>;
    /**
     * @summary List DNS mappings for encoding
     * @param {string} encodingId Id of the encoding.
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof DnsMappingsApi
     */
    list(encodingId: string, queryParameters?: DnsMappingResponseListQueryParams | ((q: DnsMappingResponseListQueryParamsBuilder) => DnsMappingResponseListQueryParamsBuilder)): Promise<PaginationResponse<DnsMappingResponse>>;
}