@ipcom/asterisk-ari 0.0.19 → 0.0.21

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

@@ -2,6 +2,7 @@ import type { Application, ApplicationDetails } from "./interfaces/applications.
 import type { AsteriskInfo, Logging, Module, Variable } from "./interfaces/asterisk.types";
 import type { Channel, ChannelPlayback, ChannelVar, ExternalMediaOptions, OriginateRequest, PlaybackOptions, RTPStats, RecordingOptions, SnoopOptions } from "./interfaces/channels.types";
 import type { Endpoint, EndpointDetails } from "./interfaces/endpoints.types.js";
+import type { WebSocketEvent, WebSocketEventType } from "./interfaces/events.types";
 import type { Playback as APIPlayback, PlaybackControlRequest } from "./interfaces/playbacks.types";
 import type { AriClientConfig } from "./interfaces/requests.js";
 import type { Sound, SoundListRequest } from "./interfaces/sounds.types";
@@ -29,7 +30,7 @@ export declare class AriClient {
      * @param app - The application name to connect to.
      * @returns {Promise<void>} Resolves when the WebSocket connects successfully.
      */
-    connectWebSocket(app: string): Promise<void>;
+    connectWebSocket(app: string, subscribedEvents?: WebSocketEventType[]): Promise<void>;
     /**
      * Ensures the ARI application is registered.
      *
@@ -44,12 +45,16 @@ export declare class AriClient {
      */
     isWebSocketConnected(): boolean;
     /**
-     * Registers a callback for a specific WebSocket event.
+     * Registers a callback function for WebSocket events.
+     * This method allows you to listen for and respond to WebSocket messages
+     * and process specific event types.
      *
-     * @param event - The WebSocket event to listen for.
-     * @param callback - The callback function to execute when the event occurs.
+     * @param callback - The callback function to execute when a WebSocket message is received.
+     *                   The function will receive the parsed event data as its parameter.
+     * @throws {Error} Throws an error if the WebSocket is not connected when trying to register the event.
+     * @returns {void}
      */
-    onWebSocketEvent(event: string, callback: (data: any) => void): void;
+    onWebSocketEvent(callback: (data: WebSocketEvent) => void): void;
     /**
      * Closes the WebSocket connection.
      */
@@ -140,7 +145,14 @@ export declare class AriClient {
      */
     snoopChannelWithId(channelId: string, snoopId: string, options: SnoopOptions): Promise<Channel>;
     /**
-     * Dials a created channel.
+     * Initiates a dial operation on a previously created channel.
+     * This function attempts to connect the specified channel to its configured destination.
+     *
+     * @param channelId - The unique identifier of the channel to dial.
+     * @param caller - Optional. The caller ID to use for the outgoing call. If not provided, the default caller ID for the channel will be used.
+     * @param timeout - Optional. The maximum time in seconds to wait for the dial operation to complete. If not specified, the system's default timeout will be used.
+     * @returns A Promise that resolves when the dial operation has been initiated successfully. Note that this does not guarantee that the call was answered, only that dialing has begun.
+     * @throws Will throw an error if the dial operation fails, e.g., if the channel doesn't exist or is in an invalid state.
      */
     dialChannel(channelId: string, caller?: string, timeout?: number): Promise<void>;
     /**
@@ -164,11 +176,34 @@ export declare class AriClient {
      */
     ringChannel(channelId: string): Promise<void>;
     /**
-     * Stops ringing indication on a channel.
+     * Stops the ringing indication on a specified channel in the Asterisk system.
+     *
+     * This function sends a request to the Asterisk server to cease the ringing
+     * indication on a particular channel. This is typically used when you want to
+     * stop the ringing sound on a channel without answering or hanging up the call.
+     *
+     * @param channelId - The unique identifier of the channel on which to stop the ringing.
+     *                    This should be a string that uniquely identifies the channel in the Asterisk system.
+     *
+     * @returns A Promise that resolves when the ringing has been successfully stopped on the specified channel.
+     *          The promise resolves to void, indicating no specific return value.
+     *          If an error occurs during the operation, the promise will be rejected with an error object.
      */
     stopRingChannel(channelId: string): Promise<void>;
     /**
-     * Sends DTMF to a channel.
+     * Sends DTMF (Dual-Tone Multi-Frequency) tones to a specified channel.
+     *
+     * This function allows sending DTMF tones to a channel, which can be used for various purposes
+     * such as interacting with IVR systems or sending signals during a call.
+     *
+     * @param channelId - The unique identifier of the channel to send DTMF tones to.
+     * @param dtmf - A string representing the DTMF tones to send (e.g., "123#").
+     * @param options - Optional parameters to control the timing of DTMF tones.
+     * @param options.before - The time (in milliseconds) to wait before sending DTMF.
+     * @param options.between - The time (in milliseconds) to wait between each DTMF tone.
+     * @param options.duration - The duration (in milliseconds) of each DTMF tone.
+     * @param options.after - The time (in milliseconds) to wait after sending all DTMF tones.
+     * @returns A Promise that resolves when the DTMF tones have been successfully sent.
      */
     sendDTMF(channelId: string, dtmf: string, options?: {
         before?: number;
@@ -177,26 +212,96 @@ export declare class AriClient {
         after?: number;
     }): Promise<void>;
     /**
-     * Mutes a channel.
+     * Mutes a channel in the Asterisk system.
+     *
+     * This function initiates a mute operation on the specified channel, preventing
+     * audio transmission in the specified direction(s).
+     *
+     * @param channelId - The unique identifier of the channel to be muted.
+     *                    This should be a string that uniquely identifies the channel in the Asterisk system.
+     * @param direction - The direction of audio to mute. Can be one of:
+     *                    - "both": Mute both incoming and outgoing audio (default)
+     *                    - "in": Mute only incoming audio
+     *                    - "out": Mute only outgoing audio
+     *
+     * @returns A Promise that resolves when the mute operation has been successfully completed.
+     *          The promise resolves to void, indicating no specific return value.
+     *          If an error occurs during the operation, the promise will be rejected with an error object.
      */
     muteChannel(channelId: string, direction?: "both" | "in" | "out"): Promise<void>;
     /**
-     * Unmutes a channel.
+     * Unmutes a channel in the Asterisk system.
+     *
+     * This function removes the mute status from a specified channel, allowing audio
+     * transmission to resume in the specified direction(s).
+     *
+     * @param channelId - The unique identifier of the channel to be unmuted.
+     *                    This should be a string that uniquely identifies the channel in the Asterisk system.
+     * @param direction - The direction of audio to unmute. Can be one of:
+     *                    - "both": Unmute both incoming and outgoing audio (default)
+     *                    - "in": Unmute only incoming audio
+     *                    - "out": Unmute only outgoing audio
+     *
+     * @returns A Promise that resolves when the unmute operation has been successfully completed.
+     *          The promise resolves to void, indicating no specific return value.
+     *          If an error occurs during the operation, the promise will be rejected with an error object.
      */
     unmuteChannel(channelId: string, direction?: "both" | "in" | "out"): Promise<void>;
     /**
-     * Puts a channel on hold.
+     * Puts a specified channel on hold.
+     *
+     * This function initiates a hold operation on the specified channel in the Asterisk system.
+     * When a channel is put on hold, typically the audio is muted or replaced with hold music,
+     * depending on the system configuration.
+     *
+     * @param channelId - The unique identifier of the channel to be put on hold.
+     *                    This should be a string that uniquely identifies the channel in the Asterisk system.
+     *
+     * @returns A Promise that resolves when the hold operation has been successfully initiated.
+     *          The promise resolves to void, indicating no specific return value.
+     *          If an error occurs during the operation, the promise will be rejected with an error object.
      */
     holdChannel(channelId: string): Promise<void>;
     /**
-     * Removes a channel from hold.
+     * Removes a specified channel from hold.
+     *
+     * This function initiates an unhold operation on the specified channel in the Asterisk system.
+     * When a channel is taken off hold, it typically resumes normal audio transmission,
+     * allowing the parties to continue their conversation.
+     *
+     * @param channelId - The unique identifier of the channel to be taken off hold.
+     *                    This should be a string that uniquely identifies the channel in the Asterisk system.
+     *
+     * @returns A Promise that resolves when the unhold operation has been successfully initiated.
+     *          The promise resolves to void, indicating no specific return value.
+     *          If an error occurs during the operation, the promise will be rejected with an error object.
      */
     unholdChannel(channelId: string): Promise<void>;
     /**
-     * Creates a new channel using the provided originate request data.
+     * Creates a new channel in the Asterisk system using the provided originate request data.
+     * This function initiates a new communication channel based on the specified parameters.
      *
-     * @param data - The originate request data containing channel creation parameters.
-     * @returns A promise that resolves to the created Channel object.
+     * @param data - An object containing the originate request data for channel creation.
+     *               This includes details such as the endpoint to call, the context to use,
+     *               and any variables to set on the new channel.
+     * @param data.endpoint - The endpoint to call (e.g., "SIP/1234").
+     * @param data.extension - The extension to dial after the channel is created.
+     * @param data.context - The dialplan context to use for the new channel.
+     * @param data.priority - The priority to start at in the dialplan.
+     * @param data.app - The application to execute on the channel (alternative to extension/context/priority).
+     * @param data.appArgs - The arguments to pass to the application, if 'app' is specified.
+     * @param data.callerId - The caller ID to set on the new channel.
+     * @param data.timeout - The timeout (in seconds) to wait for the channel to be answered.
+     * @param data.variables - An object containing key-value pairs of channel variables to set.
+     * @param data.channelId - An optional ID to assign to the new channel.
+     * @param data.otherChannelId - The ID of another channel to bridge with after creation.
+     *
+     * @returns A Promise that resolves to the created Channel object.
+     *          The Channel object contains details about the newly created channel,
+     *          such as its unique identifier, state, and other relevant information.
+     *
+     * @throws Will throw an error if the channel creation fails for any reason,
+     *         such as invalid parameters or system issues.
      */
     createChannel(data: OriginateRequest): Promise<Channel>;
     /**
@@ -272,63 +377,97 @@ export declare class AriClient {
      */
     getPlaybackDetails(playbackId: string): Promise<APIPlayback>;
     /**
-     * Controls a specific playback.
+     * Controls a specific playback in the Asterisk server.
      *
-     * @param playbackId - The unique identifier of the playback.
-     * @param controlRequest - The PlaybackControlRequest containing the control operation.
-     * @returns {Promise<void>} A promise resolving when the control operation is successfully executed.
+     * @param playbackId - The unique identifier of the playback to control.
+     * @param controlRequest - An object containing the control operation details.
+     * @returns A Promise that resolves when the control operation is successfully executed.
      */
     controlPlayback(playbackId: string, controlRequest: PlaybackControlRequest): Promise<void>;
     /**
-     * Stops a specific playback.
+     * Stops a specific playback in the Asterisk server.
      *
-     * @param playbackId - The unique identifier of the playback.
-     * @returns {Promise<void>} A promise resolving when the playback is successfully stopped.
+     * @param playbackId - The unique identifier of the playback to stop.
+     * @returns A Promise that resolves when the playback is successfully stopped.
      */
     stopPlayback(playbackId: string): Promise<void>;
     /**
-     * Lists all available sounds.
+     * Retrieves a list of all available sounds in the Asterisk server.
      *
      * @param params - Optional parameters to filter the list of sounds.
-     * @returns {Promise<Sound[]>} A promise resolving to the list of sounds.
+     * @returns A Promise that resolves to an array of Sound objects representing the available sounds.
      */
     listSounds(params?: SoundListRequest): Promise<Sound[]>;
     /**
-     * Retrieves details of a specific sound.
+     * Retrieves detailed information about a specific sound in the Asterisk server.
      *
-     * @param soundId - The unique identifier of the sound.
-     * @returns {Promise<Sound>} A promise resolving to the sound details.
+     * @param soundId - The unique identifier of the sound to retrieve details for.
+     * @returns A Promise that resolves to a Sound object containing the details of the specified sound.
      */
     getSoundDetails(soundId: string): Promise<Sound>;
     /**
-     * Retrieves information about the Asterisk server.
+     * Retrieves general information about the Asterisk server.
+     *
+     * @returns A Promise that resolves to an AsteriskInfo object containing server information.
      */
     getAsteriskInfo(): Promise<AsteriskInfo>;
     /**
-     * Lists all loaded modules in the Asterisk server.
+     * Retrieves a list of all loaded modules in the Asterisk server.
+     *
+     * @returns A Promise that resolves to an array of Module objects representing the loaded modules.
      */
     listModules(): Promise<Module[]>;
     /**
-     * Manages a specific module in the Asterisk server.
+     * Manages a specific module in the Asterisk server by loading, unloading, or reloading it.
+     *
+     * @param moduleName - The name of the module to manage.
+     * @param action - The action to perform on the module: "load", "unload", or "reload".
+     * @returns A Promise that resolves when the module management action is completed successfully.
      */
     manageModule(moduleName: string, action: "load" | "unload" | "reload"): Promise<void>;
     /**
-     * Retrieves all configured logging channels.
+     * Retrieves a list of all configured logging channels in the Asterisk server.
+     *
+     * @returns A Promise that resolves to an array of Logging objects representing the configured logging channels.
      */
     listLoggingChannels(): Promise<Logging[]>;
     /**
      * Adds or removes a log channel in the Asterisk server.
+     *
+     * @param logChannelName - The name of the log channel to manage.
+     * @param action - The action to perform: "add" to create a new log channel or "remove" to delete an existing one.
+     * @param configuration - Optional configuration object for adding a log channel. Ignored when removing a channel.
+     * @param configuration.type - The type of the log channel.
+     * @param configuration.configuration - Additional configuration details for the log channel.
+     * @returns A Promise that resolves when the log channel management action is completed successfully.
      */
     manageLogChannel(logChannelName: string, action: "add" | "remove", configuration?: {
         type?: string;
         configuration?: string;
     }): Promise<void>;
     /**
-     * Retrieves the value of a global variable.
+     * Retrieves the value of a global variable from the Asterisk server.
+     *
+     * @param variableName - The name of the global variable to retrieve.
+     * @returns A Promise that resolves to a Variable object containing the name and value of the global variable.
      */
     getGlobalVariable(variableName: string): Promise<Variable>;
     /**
-     * Sets a global variable.
+     * Sets a global variable in the Asterisk server.
+     *
+     * This function allows you to set or update the value of a global variable
+     * in the Asterisk server. Global variables are accessible throughout the
+     * entire Asterisk system and can be used for various purposes such as
+     * configuration settings or sharing data between different parts of the system.
+     *
+     * @param variableName - The name of the global variable to set or update.
+     *                       This should be a string identifying the variable uniquely.
+     * @param value - The value to assign to the global variable. This can be any
+     *                string value, including empty strings.
+     * @returns A Promise that resolves when the global variable has been successfully
+     *          set. The promise resolves to void, indicating no specific return value.
+     *          If an error occurs during the operation, the promise will be rejected
+     *          with an error object.
      */
     setGlobalVariable(variableName: string, value: string): Promise<void>;
 }

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":"AAEA,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,YAAY,EACZ,OAAO,EACP,MAAM,EACN,QAAQ,EACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,OAAO,EACP,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACb,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,QAAQ,IAAI,WAAW,EACvB,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAkB,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C,qBAAa,SAAS;IAYR,OAAO,CAAC,MAAM;IAX1B,OAAO,CAAC,QAAQ,CAAgC;IAChD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,cAAc,CAAS;IAExB,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;gBAEN,MAAM,EAAE,eAAe;IAc3C;;;;;OAKG;IACG,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsDlD;;;;;OAKG;IACG,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBrD;;;;OAIG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAOpE;;OAEG;IACH,cAAc,IAAI,IAAI;IAMtB;;;;OAIG;IACH;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAIxC;;OAEG;IACG,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhE;;OAEG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5D;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;OAEG;IACG,uBAAuB,CAC3B,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAUhB;;OAEG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC;IAItB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,eAAe,CAAC;IAI3B;;OAEG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;OAEG;IACG,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D;;OAEG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,eAAe,CAAC;IAI3B;;OAEG;IACG,mBAAmB,CACvB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,qBAAqB,CACzB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,qBAAqB,CACzB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,0BAA0B,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,OAAO,CAAC;IAInB;;OAEG;IACG,YAAY,CAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,OAAO,CAAC;IAInB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,OAAO,CAAC;IAInB;;OAEG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5D;;OAEG;IACG,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1E;;OAEG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzE;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;OAEG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;OAEG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;OAEG;IACG,QAAQ,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,GAAE,MAAM,GAAG,IAAI,GAAG,KAAc,GACxC,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,aAAa,CACjB,SAAS,EAAE,MAAM,EACjB,SAAS,GAAE,MAAM,GAAG,IAAI,GAAG,KAAc,GACxC,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;;;;OAKG;IACG,aAAa,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D;;;;;;;;OAQG;IACG,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;OAMG;IACG,eAAe,CACnB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,OAAO,CAAC;IAMnB;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAI1C;;;;;;OAMG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,eAAe,CAAC;IAI3B;;;;;;;OAOG;IACG,qBAAqB,CACzB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAIhD;;;;;OAKG;IACG,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIzE;;;;;;OAMG;IACG,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzE;;;;;OAKG;IACG,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIlE;;;;;;OAMG;IACG,eAAe,CACnB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,sBAAsB,GACrC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;OAKG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;;;;OAKG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAI7D;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAItD;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC;IAI9C;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAItC;;OAEG;IACG,YAAY,CAChB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GACnC,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,mBAAmB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAI/C;;OAEG;IACG,gBAAgB,CACpB,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,KAAK,GAAG,QAAQ,EACxB,aAAa,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,GACxD,OAAO,CAAC,IAAI,CAAC;IAQhB;;OAEG;IACG,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhE;;OAEG;IACG,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG5E"}
+{"version":3,"file":"ariClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/ariClient.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,YAAY,EACZ,OAAO,EACP,MAAM,EACN,QAAQ,EACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,OAAO,EACP,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACb,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EAChB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EACnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACV,QAAQ,IAAI,WAAW,EACvB,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAkB,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChF,OAAO,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C,qBAAa,SAAS;IAYR,OAAO,CAAC,MAAM;IAX1B,OAAO,CAAC,QAAQ,CAAgC;IAChD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,cAAc,CAAS;IAExB,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;gBAEN,MAAM,EAAE,eAAe;IAc3C;;;;;OAKG;IACG,gBAAgB,CACpB,GAAG,EAAE,MAAM,EACX,gBAAgB,CAAC,EAAE,kBAAkB,EAAE,GACtC,OAAO,CAAC,IAAI,CAAC;IA4DhB;;;;;OAKG;IACG,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBrD;;;;OAIG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;;;;;;;OASG;IACH,gBAAgB,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI;IAUhE;;OAEG;IACH,cAAc,IAAI,IAAI;IAMtB;;;;OAIG;IACH;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAIxC;;OAEG;IACG,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhE;;OAEG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5D;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;OAEG;IACG,uBAAuB,CAC3B,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAUhB;;OAEG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,UAAU,CAAC;IAItB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,eAAe,CAAC;IAI3B;;OAEG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;OAEG;IACG,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D;;OAEG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,eAAe,CAAC;IAI3B;;OAEG;IACG,mBAAmB,CACvB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,qBAAqB,CACzB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,qBAAqB,CACzB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,0BAA0B,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,OAAO,CAAC;IAInB;;OAEG;IACG,YAAY,CAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,OAAO,CAAC;IAInB;;OAEG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;;;;OASG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5D;;OAEG;IACG,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1E;;OAEG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzE;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;OAEG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,GAAE,MAAM,GAAG,IAAI,GAAG,KAAc,GACxC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CACjB,SAAS,EAAE,MAAM,EACjB,SAAS,GAAE,MAAM,GAAG,IAAI,GAAG,KAAc,GACxC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,aAAa,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D;;;;;;;;OAQG;IACG,MAAM,CACV,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;;OAMG;IACG,eAAe,CACnB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,OAAO,CAAC;IAMnB;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAI1C;;;;;;OAMG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,eAAe,CAAC;IAI3B;;;;;;;OAOG;IACG,qBAAqB,CACzB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAIhD;;;;;OAKG;IACG,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIzE;;;;;;OAMG;IACG,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzE;;;;;OAKG;IACG,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIlE;;;;;;OAMG;IACG,eAAe,CACnB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,sBAAsB,GACrC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;;OAKG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;;;;OAKG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAI7D;;;;;OAKG;IACG,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAItD;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC;IAI9C;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAItC;;;;;;OAMG;IACG,YAAY,CAChB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GACnC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAI/C;;;;;;;;;OASG;IACG,gBAAgB,CACpB,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,KAAK,GAAG,QAAQ,EACxB,aAAa,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,GACxD,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;OAKG;IACG,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhE;;;;;;;;;;;;;;;;OAgBG;IACG,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG5E"}

package/dist/types/ari-client/interfaces/applications.types.d.ts

@@ -1,10 +1,9 @@
+import type { WebSocketEvent } from "./events.types";
 export interface Application {
     name: string;
     description?: string;
 }
-export interface ApplicationDetails {
-    name: string;
-    description?: string;
-    subscribedEvents?: string[];
+export interface ApplicationDetails extends Application {
+    subscribedEvents?: WebSocketEvent["type"][];
 }
 //# sourceMappingURL=applications.types.d.ts.map

package/dist/types/ari-client/interfaces/applications.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"applications.types.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/interfaces/applications.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B"}
+{"version":3,"file":"applications.types.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/interfaces/applications.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,gBAAgB,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;CAC7C"}

package/dist/types/ari-client/interfaces/events.types.d.ts

@@ -0,0 +1,58 @@
+import type { Channel } from "./channels.types";
+export type WebSocketEventType = "DeviceStateChanged" | "PlaybackStarted" | "PlaybackContinuing" | "PlaybackFinished" | "RecordingStarted" | "RecordingFinished" | "RecordingFailed" | "ApplicationMoveFailed" | "ApplicationReplaced" | "BridgeCreated" | "BridgeDestroyed" | "BridgeMerged" | "BridgeBlindTransfer" | "BridgeAttendedTransfer" | "BridgeVideoSourceChanged" | "ChannelCreated" | "ChannelDestroyed" | "ChannelEnteredBridge" | "ChannelLeftBridge" | "ChannelStateChange" | "ChannelDtmfReceived" | "ChannelDialplan" | "ChannelCallerId" | "ChannelUserevent" | "ChannelHangupRequest" | "ChannelVarset" | "ChannelTalkingStarted" | "ChannelTalkingFinished" | "ChannelHold" | "ChannelUnhold" | "ContactStatusChange" | "EndpointStateChange" | "Dial" | "StasisEnd" | "StasisStart" | "TextMessageReceived" | "ChannelConnectedLine" | "PeerStatusChange";
+export type WebSocketEvent = {
+    type: "ChannelVarset";
+    variable: string;
+    value: string;
+    channel?: Channel;
+} | {
+    type: "StasisStart";
+    args: string[];
+    channel: Channel;
+    replace_channel?: Channel;
+} | {
+    type: "PlaybackStarted";
+    playbackId: string;
+} | {
+    type: "PlaybackFinished";
+    playbackId: string;
+} | {
+    type: "BridgeCreated";
+    bridgeId: string;
+    bridgeType: string;
+    channels: Channel[];
+} | {
+    type: "BridgeDestroyed";
+    bridgeId: string;
+} | {
+    type: "ChannelCreated";
+    channel: Channel;
+} | {
+    type: "ChannelDestroyed";
+    channel: Channel;
+} | {
+    type: "ApplicationMoveFailed";
+    application: string;
+    channel: Channel;
+} | {
+    type: "RecordingStarted";
+    recordingId: string;
+    name: string;
+} | {
+    type: "RecordingFinished";
+    recordingId: string;
+    name: string;
+} | {
+    type: "RecordingFailed";
+    recordingId: string;
+    name: string;
+    reason: string;
+} | {
+    type: "DeviceStateChanged";
+    device: string;
+    state: string;
+} | {
+    type: string;
+    [key: string]: any;
+};
+//# sourceMappingURL=events.types.d.ts.map

package/dist/types/ari-client/interfaces/events.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/interfaces/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,MAAM,MAAM,kBAAkB,GAC1B,oBAAoB,GACpB,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,GAC1B,gBAAgB,GAChB,kBAAkB,GAClB,sBAAsB,GACtB,mBAAmB,GACnB,oBAAoB,GACpB,qBAAqB,GACrB,iBAAiB,GACjB,iBAAiB,GACjB,kBAAkB,GAClB,sBAAsB,GACtB,eAAe,GACf,uBAAuB,GACvB,wBAAwB,GACxB,aAAa,GACb,eAAe,GACf,qBAAqB,GACrB,qBAAqB,GACrB,MAAM,GACN,WAAW,GACX,aAAa,GACb,qBAAqB,GACrB,sBAAsB,GACtB,kBAAkB,CAAC;AAEvB,MAAM,MAAM,cAAc,GACtB;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACD;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,GACD;IACE,IAAI,EAAE,iBAAiB,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB,GACD;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;CACpB,GACD;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,GACD;IACE,IAAI,EAAE,iBAAiB,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IACE,IAAI,EAAE,uBAAuB,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;CAClB,GACD;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,mBAAmB,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,iBAAiB,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,oBAAoB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,GACD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC"}

package/dist/types/ari-client/interfaces/index.d.ts

@@ -5,4 +5,5 @@ export type { Playback } from "./playbacks.types.js";
 export type { Application } from "./applications.types.js";
 export type { Sound } from "./sounds.types.js";
 export type { AsteriskInfo, Module, Logging, Variable } from "./asterisk.types";
+export type { WebSocketEvent, WebSocketEventType } from "./events.types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/ari-client/interfaces/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/interfaces/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACrE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/interfaces/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACrE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrD,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAChF,YAAY,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/types/ari-client/resources/applications.d.ts

@@ -1,29 +1,34 @@
 import type { BaseClient } from "../baseClient.js";
 import type { Application, ApplicationDetails } from "../interfaces/applications.types.js";
+export interface ApplicationMessage {
+    event: string;
+    data?: Record<string, any>;
+}
 export declare class Applications {
     private client;
     constructor(client: BaseClient);
     /**
      * Lists all applications.
      *
-     * @returns A promise that resolves to an array of Application objects representing all registered applications.
+     * @returns A promise that resolves to an array of Application objects.
      * @throws {Error} If the API response is not an array.
      */
     list(): Promise<Application[]>;
     /**
      * Retrieves details of a specific application.
      *
-     * @param appName - The unique name of the application.
-     * @returns A promise that resolves to an ApplicationDetails object containing the details of the specified application.
+     * @param appName - The name of the application to retrieve details for.
+     * @returns A promise that resolves to an ApplicationDetails object.
+     * @throws {Error} If there's an error fetching the application details.
      */
     getDetails(appName: string): Promise<ApplicationDetails>;
     /**
      * Sends a message to a specific application.
      *
-     * @param appName - The unique name of the application.
-     * @param body - The message body to send.
-     * @returns A promise that resolves when the message is sent successfully.
+     * @param appName - The name of the application to send the message to.
+     * @param body - The message to be sent, containing an event and optional data.
+     * @returns A promise that resolves when the message is successfully sent.
      */
-    sendMessage(appName: string, body: any): Promise<void>;
+    sendMessage(appName: string, body: ApplicationMessage): Promise<void>;
 }
 //# sourceMappingURL=applications.d.ts.map

package/dist/types/ari-client/resources/applications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"applications.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/resources/applications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EACnB,MAAM,qCAAqC,CAAC;AAE7C,qBAAa,YAAY;IACX,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,UAAU;IAEtC;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAUpC;;;;;OAKG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI9D;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CAG7D"}
+{"version":3,"file":"applications.d.ts","sourceRoot":"","sources":["../../../../src/ari-client/resources/applications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EACnB,MAAM,qCAAqC,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B;AAED,qBAAa,YAAY;IACX,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,UAAU;IAEtC;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAUpC;;;;;;OAMG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAW9D;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;CAG5E"}

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

@@ -1,3 +1,4 @@
+import type { WebSocketEvent } from "./interfaces/events.types";
 export declare class WebSocketClient {
     private url;
     private ws;
@@ -7,7 +8,9 @@ export declare class WebSocketClient {
     connect(): Promise<void>;
     reconnect(): Promise<void>;
     isConnected(): boolean;
-    on(event: string, callback: (data: any) => void): void;
+    on<T extends WebSocketEvent["type"]>(event: "message" | "open" | "error" | "close", callback: (data: Extract<WebSocketEvent, {
+        type: T;
+    }>) => void): void;
     send(data: any): void;
     close(): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"websocketClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/websocketClient.ts"],"names":[],"mappings":"AAEA,qBAAa,eAAe;IAKd,OAAO,CAAC,GAAG;IAJvB,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,cAAc,CAAS;gBAEX,GAAG,EAAE,MAAM;IAEzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBxB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAehC,WAAW,IAAI,OAAO;IAItB,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI;IAoBtD,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAYrB,KAAK,IAAI,IAAI;CAOd"}
+{"version":3,"file":"websocketClient.d.ts","sourceRoot":"","sources":["../../../src/ari-client/websocketClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAEhE,qBAAa,eAAe;IAKd,OAAO,CAAC,GAAG;IAJvB,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,cAAc,CAAS;gBAEX,GAAG,EAAE,MAAM;IAEzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBxB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAehC,WAAW,IAAI,OAAO;IAItB,EAAE,CAAC,CAAC,SAAS,cAAc,CAAC,MAAM,CAAC,EACjC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,EAC7C,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,KAAK,IAAI,GAC7D,IAAI;IAwBP,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAYrB,KAAK,IAAI,IAAI;CAOd"}

package/dist/types/index.d.ts

@@ -4,5 +4,6 @@ export { Endpoints } from "./ari-client/resources/endpoints.js";
 export { Applications } from "./ari-client/resources/applications.js";
 export { Sounds } from "./ari-client/resources/sounds.js";
 export { Playbacks } from "./ari-client/resources/playbacks.js";
-export type { AriClientConfig, Channel, Endpoint, Playback, Application, Sound, AsteriskInfo, Module, Logging, Variable, } from "./ari-client/interfaces/index.js";
+export { Asterisk } from "./ari-client/resources/asterisk.js";
+export type { AriClientConfig, Channel, Endpoint, Playback, Application, Sound, AsteriskInfo, Module, Logging, Variable, WebSocketEvent, WebSocketEventType, } from "./ari-client/interfaces/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAGtD,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAGhE,YAAY,EACV,eAAe,EACf,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,KAAK,EACL,YAAY,EACZ,MAAM,EACN,OAAO,EACP,QAAQ,GACT,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAGtD,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAG9D,YAAY,EACV,eAAe,EACf,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,KAAK,EACL,YAAY,EACZ,MAAM,EACN,OAAO,EACP,QAAQ,EACR,cAAc,EACd,kBAAkB,GACnB,MAAM,kCAAkC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ipcom/asterisk-ari",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "type": "module",
   "description": "JavaScript client for Asterisk REST Interface.",
   "homepage": "https://github.com/fabiotheo/ipcom-asterisk-ari",