@bitmovin/api-sdk/dist/encoding/infrastructure/staticIps/StaticIpsApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import BitmovinResponse from '../../../models/BitmovinResponse';
import StaticIp from '../../../models/StaticIp';
import PaginationResponse from '../../../models/PaginationResponse';
import { StaticIpListQueryParams, StaticIpListQueryParamsBuilder } from './StaticIpListQueryParams';
/**
 * StaticIpsApi - object-oriented interface
 * @export
 * @class StaticIpsApi
 * @extends {BaseAPI}
 */
export default class StaticIpsApi extends BaseAPI {
    constructor(configuration: Configuration);
    /**
     * @summary Add Static IP Address
     * @param {StaticIp} staticIp The static ip to be created
     * @throws {BitmovinError}
     * @memberof StaticIpsApi
     */
    create(staticIp?: StaticIp): Promise<StaticIp>;
    /**
     * @summary Delete Static IP Address
     * @param {string} id Id of the Static IP Address
     * @throws {BitmovinError}
     * @memberof StaticIpsApi
     */
    delete(id: string): Promise<BitmovinResponse>;
    /**
     * @summary Static IP Address Details
     * @param {string} id Id of the Static IP Address
     * @throws {BitmovinError}
     * @memberof StaticIpsApi
     */
    get(id: string): Promise<StaticIp>;
    /**
     * @summary List all Static IP Addresses
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof StaticIpsApi
     */
    list(queryParameters?: StaticIpListQueryParams | ((q: StaticIpListQueryParamsBuilder) => StaticIpListQueryParamsBuilder)): Promise<PaginationResponse<StaticIp>>;
}