/** * Bandwidth * Bandwidth\'s Communication APIs * * The version of the OpenAPI document: 1.0.0 * Contact: letstalk@bandwidth.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { CreateEndpointResponse } from '../models'; import type { CreateWebRtcConnectionRequest } from '../models'; import type { EndpointResponse } from '../models'; import type { EndpointStatusEnum } from '../models'; import type { EndpointTypeEnum } from '../models'; import type { ListEndpointsResponse } from '../models'; /** * EndpointsApi - axios parameter creator */ export declare const EndpointsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new Endpoint for the specified account. * @summary Create Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {CreateWebRtcConnectionRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEndpoint: (accountId: string, body: CreateWebRtcConnectionRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes the specified endpoint. If the endpoint is actively streaming media, the media stream will be terminated. * @summary Delete Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEndpoint: (accountId: string, endpointId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns information about the specified endpoint. * @summary Get Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEndpoint: (accountId: string, endpointId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of endpoints associated with the specified account. * @summary List Endpoints * @param {string} accountId Your Bandwidth Account ID. * @param {EndpointTypeEnum} [type] The type of endpoint. * @param {EndpointStatusEnum} [status] The status of the endpoint. * @param {string} [afterCursor] The cursor to use for pagination. This is the value of the `next` link in the previous response. * @param {number} [limit] The maximum number of endpoints to return in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEndpoints: (accountId: string, type?: EndpointTypeEnum, status?: EndpointStatusEnum, afterCursor?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Updates the BXML for the specified endpoint. * @summary Update Endpoint BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEndpointBxml: (accountId: string, endpointId: string, body: string, options?: RawAxiosRequestConfig) => Promise; }; /** * EndpointsApi - functional programming interface */ export declare const EndpointsApiFp: (configuration?: Configuration) => { /** * Creates a new Endpoint for the specified account. * @summary Create Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {CreateWebRtcConnectionRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEndpoint(accountId: string, body: CreateWebRtcConnectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the specified endpoint. If the endpoint is actively streaming media, the media stream will be terminated. * @summary Delete Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEndpoint(accountId: string, endpointId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about the specified endpoint. * @summary Get Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEndpoint(accountId: string, endpointId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of endpoints associated with the specified account. * @summary List Endpoints * @param {string} accountId Your Bandwidth Account ID. * @param {EndpointTypeEnum} [type] The type of endpoint. * @param {EndpointStatusEnum} [status] The status of the endpoint. * @param {string} [afterCursor] The cursor to use for pagination. This is the value of the `next` link in the previous response. * @param {number} [limit] The maximum number of endpoints to return in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEndpoints(accountId: string, type?: EndpointTypeEnum, status?: EndpointStatusEnum, afterCursor?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the BXML for the specified endpoint. * @summary Update Endpoint BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEndpointBxml(accountId: string, endpointId: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EndpointsApi - factory interface */ export declare const EndpointsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new Endpoint for the specified account. * @summary Create Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {CreateWebRtcConnectionRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEndpoint(accountId: string, body: CreateWebRtcConnectionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the specified endpoint. If the endpoint is actively streaming media, the media stream will be terminated. * @summary Delete Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEndpoint(accountId: string, endpointId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns information about the specified endpoint. * @summary Get Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEndpoint(accountId: string, endpointId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of endpoints associated with the specified account. * @summary List Endpoints * @param {string} accountId Your Bandwidth Account ID. * @param {EndpointTypeEnum} [type] The type of endpoint. * @param {EndpointStatusEnum} [status] The status of the endpoint. * @param {string} [afterCursor] The cursor to use for pagination. This is the value of the `next` link in the previous response. * @param {number} [limit] The maximum number of endpoints to return in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEndpoints(accountId: string, type?: EndpointTypeEnum, status?: EndpointStatusEnum, afterCursor?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the BXML for the specified endpoint. * @summary Update Endpoint BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEndpointBxml(accountId: string, endpointId: string, body: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * EndpointsApi - object-oriented interface */ export declare class EndpointsApi extends BaseAPI { /** * Creates a new Endpoint for the specified account. * @summary Create Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {CreateWebRtcConnectionRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEndpoint(accountId: string, body: CreateWebRtcConnectionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes the specified endpoint. If the endpoint is actively streaming media, the media stream will be terminated. * @summary Delete Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEndpoint(accountId: string, endpointId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns information about the specified endpoint. * @summary Get Endpoint * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEndpoint(accountId: string, endpointId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of endpoints associated with the specified account. * @summary List Endpoints * @param {string} accountId Your Bandwidth Account ID. * @param {EndpointTypeEnum} [type] The type of endpoint. * @param {EndpointStatusEnum} [status] The status of the endpoint. * @param {string} [afterCursor] The cursor to use for pagination. This is the value of the `next` link in the previous response. * @param {number} [limit] The maximum number of endpoints to return in the response. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEndpoints(accountId: string, type?: EndpointTypeEnum, status?: EndpointStatusEnum, afterCursor?: string, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * Updates the BXML for the specified endpoint. * @summary Update Endpoint BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} endpointId BRTC Endpoint ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEndpointBxml(accountId: string, endpointId: string, body: string, options?: RawAxiosRequestConfig): Promise>; }