@ipcom/asterisk-ari 0.0.139 → 0.0.140

package/dist/types/ari-client/ariClient.d.ts

@@ -6,51 +6,100 @@ import { type ChannelInstance, Channels } from "./resources/channels.js";
 import { Endpoints } from "./resources/endpoints";
 import { type PlaybackInstance, Playbacks } from "./resources/playbacks";
 import { Sounds } from "./resources/sounds";
+/**
+ * Main client class for interacting with the Asterisk REST Interface (ARI).
+ * Provides access to various ARI resources and WebSocket event handling capabilities.
+ *
+ * @example
+ * ```typescript
+ * const client = new AriClient({
+ *   host: 'localhost',
+ *   port: 8088,
+ *   username: 'user',
+ *   password: 'secret'
+ * });
+ * ```
+ */
 export declare class AriClient {
-    private config;
+    private readonly config;
     private readonly baseClient;
     private webSocketClient?;
-    channels: Channels;
-    endpoints: Endpoints;
-    applications: Applications;
-    playbacks: Playbacks;
-    sounds: Sounds;
-    asterisk: Asterisk;
-    bridges: Bridges;
+    readonly channels: Channels;
+    readonly endpoints: Endpoints;
+    readonly applications: Applications;
+    readonly playbacks: Playbacks;
+    readonly sounds: Sounds;
+    readonly asterisk: Asterisk;
+    readonly bridges: Bridges;
+    /**
+     * Creates a new instance of the ARI client.
+     *
+     * @param {AriClientConfig} config - Configuration options for the ARI client
+     * @throws {Error} If required configuration parameters are missing
+     */
     constructor(config: AriClientConfig);
     /**
-     * Inicializa uma conexão WebSocket.
+     * Initializes a WebSocket connection for receiving events.
+     *
+     * @param {string[]} apps - List of application names to subscribe to
+     * @param {WebSocketEventType[]} [subscribedEvents] - Optional list of specific event types to subscribe to
+     * @returns {Promise<void>} Resolves when connection is established
+     * @throws {Error} If connection fails or if WebSocket is already connected
      */
     connectWebSocket(apps: string[], subscribedEvents?: WebSocketEventType[]): Promise<void>;
     /**
-     * Adiciona um listener para eventos do WebSocket.
+     * Registers an event listener for WebSocket events.
+     *
+     * @param {T} event - The event type to listen for
+     * @param {Function} listener - Callback function for handling the event
+     * @throws {Error} If WebSocket is not connected
      */
     on<T extends WebSocketEvent["type"]>(event: T, listener: (data: Extract<WebSocketEvent, {
         type: T;
     }>) => void): void;
     /**
-     * Adiciona um listener único para eventos do WebSocket.
+     * Registers a one-time event listener for WebSocket events.
+     *
+     * @param {T} event - The event type to listen for
+     * @param {Function} listener - Callback function for handling the event
+     * @throws {Error} If WebSocket is not connected
      */
     once<T extends WebSocketEvent["type"]>(event: T, listener: (data: Extract<WebSocketEvent, {
         type: T;
     }>) => void): void;
     /**
-     * Remove um listener para eventos do WebSocket.
+     * Removes an event listener for WebSocket events.
+     *
+     * @param {T} event - The event type to remove listener for
+     * @param {Function} listener - The listener function to remove
      */
     off<T extends WebSocketEvent["type"]>(event: T, listener: (data: Extract<WebSocketEvent, {
         type: T;
     }>) => void): void;
     /**
-     * Fecha a conexão WebSocket.
+     * Closes the WebSocket connection if one exists.
      */
     closeWebSocket(): void;
     /**
-     * Inicializa uma nova instância de `ChannelInstance` para manipular canais localmente.
+     * Creates or retrieves a Channel instance.
+     *
+     * @param {string} [channelId] - Optional ID of an existing channel
+     * @returns {ChannelInstance} A new or existing channel instance
      */
     Channel(channelId?: string): ChannelInstance;
     /**
-     * Inicializa uma nova instância de `PlaybackInstance` para manipular playbacks.
+     * Creates or retrieves a Playback instance.
+     *
+     * @param {string} [playbackId] - Optional ID of an existing playback
+     * @param {string} [_app] - Optional application name (deprecated)
+     * @returns {PlaybackInstance} A new or existing playback instance
      */
     Playback(playbackId?: string, _app?: string): PlaybackInstance;
+    /**
+     * Gets the current WebSocket connection status.
+     *
+     * @returns {boolean} True if WebSocket is connected, false otherwise
+     */
+    isWebSocketConnected(): boolean;
 }
 //# sourceMappingURL=ariClient.d.ts.map

package/dist/types/ari-client/ariClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ariClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/ariClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,eAAe,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,gBAAgB,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C,qBAAa,SAAS;IAYR,OAAO,CAAC,MAAM;IAX1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,eAAe,CAAC,CAAkB;IAEnC,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;gBAEJ,MAAM,EAAE,eAAe;IAe3C;;OAEG;IACU,gBAAgB,CAC3B,IAAI,EAAE,MAAM,EAAE,EACd,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,GACtC,OAAO,CAAC,IAAI,CAAC;IAchB;;OAEG;IACI,EAAE,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACxC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IAIP;;OAEG;IACI,IAAI,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EAC1C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IAIP;;OAEG;IACI,GAAG,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACzC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IAIP;;OAEG;IACI,cAAc,IAAI,IAAI;IAK7B;;OAEG;IAEH,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,eAAe;IAI5C;;OAEG;IACI,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,gBAAgB;CAGtE"}
+{"version":3,"file":"ariClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/ariClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,eAAe,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,gBAAgB,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C;;;;;;;;;;;;;GAaG;AACH,qBAAa,SAAS;IAkBR,OAAO,CAAC,QAAQ,CAAC,MAAM;IAjBnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,eAAe,CAAC,CAAkB;IAE1C,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,YAAY,EAAE,YAAY,CAAC;IAC3C,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC;;;;;OAKG;gBAC0B,MAAM,EAAE,eAAe;IAyBpD;;;;;;;OAOG;IACU,gBAAgB,CACzB,IAAI,EAAE,MAAM,EAAE,EACd,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,GACxC,OAAO,CAAC,IAAI,CAAC;IA0BhB;;;;;;OAMG;IACI,EAAE,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACtC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC/D,IAAI;IAQP;;;;;;OAMG;IACI,IAAI,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACxC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC/D,IAAI;IAQP;;;;;OAKG;IACI,GAAG,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACvC,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC/D,IAAI;IASP;;OAEG;IACI,cAAc,IAAI,IAAI;IAU7B;;;;;OAKG;IACI,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,eAAe;IAInD;;;;;;OAMG;IACI,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,gBAAgB;IAIrE;;;;OAIG;IACI,oBAAoB,IAAI,OAAO;CAGvC"}

package/dist/types/ari-client/baseClient.d.ts

@@ -1,13 +1,29 @@
 import { type AxiosRequestConfig } from "axios";
+/**
+ * BaseClient handles HTTP communications with the ARI server.
+ * Provides methods for making HTTP requests and manages authentication and error handling.
+ */
 export declare class BaseClient {
-    private baseUrl;
-    private username;
-    private password;
-    private client;
+    private readonly baseUrl;
+    private readonly username;
+    private readonly password;
+    private readonly client;
+    /**
+     * Creates a new BaseClient instance.
+     *
+     * @param {string} baseUrl - The base URL for the API
+     * @param {string} username - Username for authentication
+     * @param {string} password - Password for authentication
+     * @param {number} [timeout=5000] - Request timeout in milliseconds
+     * @throws {Error} If the base URL format is invalid
+     */
     constructor(baseUrl: string, username: string, password: string, timeout?: number);
+    /**
+     * Gets the base URL of the client.
+     */
     getBaseUrl(): string;
     /**
-     * Retorna as credenciais configuradas.
+     * Gets the configured credentials.
      */
     getCredentials(): {
         baseUrl: string;
@@ -15,45 +31,62 @@ export declare class BaseClient {
         password: string;
     };
     /**
-     * Adds interceptors to the Axios instance.
+     * Adds request and response interceptors to the Axios instance.
      */
     private addInterceptors;
     /**
      * Executes a GET request.
-     * @param path - The API endpoint path.
-     * @param config - Optional Axios request configuration.
+     *
+     * @param path - API endpoint path
+     * @param config - Optional Axios request configuration
+     * @returns Promise with the response data
      */
     get<T>(path: string, config?: AxiosRequestConfig): Promise<T>;
     /**
      * Executes a POST request.
-     * @param path - The API endpoint path.
-     * @param data - Optional payload to send with the request.
-     * @param config - Optional Axios request configuration.
+     *
+     * @param path - API endpoint path
+     * @param data - Request payload
+     * @param config - Optional Axios request configuration
+     * @returns Promise with the response data
      */
-    post<T>(path: string, data?: Record<string, any>, config?: AxiosRequestConfig): Promise<T>;
+    post<T, D = unknown>(path: string, data?: D, config?: AxiosRequestConfig): Promise<T>;
     /**
      * Executes a PUT request.
-     * @param path - The API endpoint path.
-     * @param data - Payload to send with the request.
-     * @param config - Optional Axios request configuration.
+     *
+     * @param path - API endpoint path
+     * @param data - Request payload
+     * @param config - Optional Axios request configuration
+     * @returns Promise with the response data
      */
-    put<T>(path: string, data: Record<string, any>, config?: AxiosRequestConfig): Promise<T>;
+    put<T, D = unknown>(path: string, data: D, config?: AxiosRequestConfig): Promise<T>;
     /**
      * Executes a DELETE request.
-     * @param path - The API endpoint path.
-     * @param config - Optional Axios request configuration.
+     *
+     * @param path - API endpoint path
+     * @param config - Optional Axios request configuration
+     * @returns Promise with the response data
      */
     delete<T>(path: string, config?: AxiosRequestConfig): Promise<T>;
     /**
-     * Handles errors for HTTP requests.
-     * @param error - The error to handle.
+     * Handles and formats error messages from various error types.
+     */
+    private getErrorMessage;
+    /**
+     * Handles errors from HTTP requests.
      */
     private handleRequestError;
     /**
      * Sets custom headers for the client instance.
-     * Useful for adding dynamic tokens or specific API headers.
-     * @param headers - Headers to merge with existing configuration.
      */
     setHeaders(headers: Record<string, string>): void;
+    /**
+     * Gets the current request timeout setting.
+     */
+    getTimeout(): number;
+    /**
+     * Updates the request timeout setting.
+     */
+    setTimeout(timeout: number): void;
 }
 //# sourceMappingURL=baseClient.d.ts.map

package/dist/types/ari-client/baseClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/baseClient.ts"],"names":[],"mappings":"AAAA,OAAc,EAAsB,KAAK,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3E,qBAAa,UAAU;IAInB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,QAAQ;IALlB,OAAO,CAAC,MAAM,CAAgB;gBAGpB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EACxB,OAAO,SAAO;IAkBT,UAAU,IAAI,MAAM;IAI3B;;OAEG;IACI,cAAc,IAAI;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB;IAQD;;OAEG;IACH,OAAO,CAAC,eAAe;IAgDvB;;;;OAIG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IASnE;;;;;OAKG;IACG,IAAI,CAAC,CAAC,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC;IASb;;;;;OAKG;IACG,GAAG,CAAC,CAAC,EACT,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC;IASb;;;;OAIG;IACG,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAStE;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAY1B;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;CAMlD"}
+{"version":3,"file":"baseClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/baseClient.ts"],"names":[],"mappings":"AAAA,OAAc,EAEZ,KAAK,kBAAkB,EAExB,MAAM,OAAO,CAAC;AAiBf;;;GAGG;AACH,qBAAa,UAAU;IAajB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAd7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;;;;;;OAQG;gBAEkB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EACjC,OAAO,SAAO;IAmBlB;;OAEG;IACI,UAAU,IAAI,MAAM;IAI3B;;OAEG;IACI,cAAc,IAAI;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB;IAQD;;OAEG;IACH,OAAO,CAAC,eAAe;IA6CvB;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IASnE;;;;;;;OAOG;IACG,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,EACrB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,CAAC,EACR,MAAM,CAAC,EAAE,kBAAkB,GAC5B,OAAO,CAAC,CAAC,CAAC;IASb;;;;;;;OAOG;IACG,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,EACpB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,MAAM,CAAC,EAAE,kBAAkB,GAC5B,OAAO,CAAC,CAAC,CAAC;IASb;;;;;;OAMG;IACG,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAStE;;OAEG;IACH,OAAO,CAAC,eAAe;IAUvB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAa1B;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAQjD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;CAIlC"}