@types/ari-client 2.2.9 → 2.2.11

ari-client/README.md

@@ -8,9 +8,8 @@ This package contains type definitions for ari-client (https://github.com/asteri
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ari-client.
 
 ### Additional Details
- * Last updated: Fri, 01 Sep 2023 01:33:05 GMT
+ * Last updated: Tue, 17 Oct 2023 22:10:13 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
- * Global values: none
 
 # Credits
 These definitions were written by [Dioris Moreno](https://github.com/dioris-moreno).

ari-client/index.d.ts

@@ -1,8 +1,3 @@
-// Type definitions for ari-client 2.2
-// Project: https://github.com/asterisk/node-ari-client
-// Definitions by: Dioris Moreno <https://github.com/dioris-moreno>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
 /// <reference types="node" />
 
 /**
@@ -181,55 +176,55 @@ export interface IndexableObject {
     [key: string]: any;
 }
 /* Event Types */
-export type WebSocketConnectedEventType = 'WebSocketConnected';
-export type WebSocketReconnectingEventType = 'WebSocketReconnecting';
-export type WebSocketMaxRetriesEventType = 'WebSocketMaxRetries';
-export type PongEventType = 'pong';
-export type APILoadErrorEventType = 'APILoadError';
-export type EventsEventType = 'Events';
-export type MessageEventType = 'Message';
-export type MissingParamsEventType = 'MissingParams';
-export type EventEventType = 'Event';
-export type ContactInfoEventType = 'ContactInfo';
-export type PeerEventType = 'Peer';
-export type DeviceStateChangedEventType = 'DeviceStateChanged';
-export type PlaybackStartedEventType = 'PlaybackStarted';
-export type PlaybackContinuingEventType = 'PlaybackContinuing';
-export type PlaybackFinishedEventType = 'PlaybackFinished';
-export type RecordingStartedEventType = 'RecordingStarted';
-export type RecordingFinishedEventType = 'RecordingFinished';
-export type RecordingFailedEventType = 'RecordingFailed';
-export type ApplicationMoveFailedEventType = 'ApplicationMoveFailed';
-export type ApplicationReplacedEventType = 'ApplicationReplaced';
-export type BridgeCreatedEventType = 'BridgeCreated';
-export type BridgeDestroyedEventType = 'BridgeDestroyed';
-export type BridgeMergedEventType = 'BridgeMerged';
-export type BridgeVideoSourceChangedEventType = 'BridgeVideoSourceChanged';
-export type BridgeBlindTransferEventType = 'BridgeBlindTransfer';
-export type BridgeAttendedTransferEventType = 'BridgeAttendedTransfer';
-export type ChannelCreatedEventType = 'ChannelCreated';
-export type ChannelDestroyedEventType = 'ChannelDestroyed';
-export type ChannelEnteredBridgeEventType = 'ChannelEnteredBridge';
-export type ChannelLeftBridgeEventType = 'ChannelLeftBridge';
-export type ChannelStateChangeEventType = 'ChannelStateChange';
-export type ChannelDtmfReceivedEventType = 'ChannelDtmfReceived';
-export type ChannelDialplanEventType = 'ChannelDialplan';
-export type ChannelCallerIdEventType = 'ChannelCallerId';
-export type ChannelUsereventEventType = 'ChannelUserevent';
-export type ChannelHangupRequestEventType = 'ChannelHangupRequest';
-export type ChannelVarsetEventType = 'ChannelVarset';
-export type ChannelHoldEventType = 'ChannelHold';
-export type ChannelUnholdEventType = 'ChannelUnhold';
-export type ChannelTalkingStartedEventType = 'ChannelTalkingStarted';
-export type ChannelTalkingFinishedEventType = 'ChannelTalkingFinished';
-export type ContactStatusChangeEventType = 'ContactStatusChange';
-export type PeerStatusChangeEventType = 'PeerStatusChange';
-export type EndpointStateChangeEventType = 'EndpointStateChange';
-export type DialEventType = 'Dial';
-export type StasisEndEventType = 'StasisEnd';
-export type StasisStartEventType = 'StasisStart';
-export type TextMessageReceivedEventType = 'TextMessageReceived';
-export type ChannelConnectedLineEventType = 'ChannelConnectedLine';
+export type WebSocketConnectedEventType = "WebSocketConnected";
+export type WebSocketReconnectingEventType = "WebSocketReconnecting";
+export type WebSocketMaxRetriesEventType = "WebSocketMaxRetries";
+export type PongEventType = "pong";
+export type APILoadErrorEventType = "APILoadError";
+export type EventsEventType = "Events";
+export type MessageEventType = "Message";
+export type MissingParamsEventType = "MissingParams";
+export type EventEventType = "Event";
+export type ContactInfoEventType = "ContactInfo";
+export type PeerEventType = "Peer";
+export type DeviceStateChangedEventType = "DeviceStateChanged";
+export type PlaybackStartedEventType = "PlaybackStarted";
+export type PlaybackContinuingEventType = "PlaybackContinuing";
+export type PlaybackFinishedEventType = "PlaybackFinished";
+export type RecordingStartedEventType = "RecordingStarted";
+export type RecordingFinishedEventType = "RecordingFinished";
+export type RecordingFailedEventType = "RecordingFailed";
+export type ApplicationMoveFailedEventType = "ApplicationMoveFailed";
+export type ApplicationReplacedEventType = "ApplicationReplaced";
+export type BridgeCreatedEventType = "BridgeCreated";
+export type BridgeDestroyedEventType = "BridgeDestroyed";
+export type BridgeMergedEventType = "BridgeMerged";
+export type BridgeVideoSourceChangedEventType = "BridgeVideoSourceChanged";
+export type BridgeBlindTransferEventType = "BridgeBlindTransfer";
+export type BridgeAttendedTransferEventType = "BridgeAttendedTransfer";
+export type ChannelCreatedEventType = "ChannelCreated";
+export type ChannelDestroyedEventType = "ChannelDestroyed";
+export type ChannelEnteredBridgeEventType = "ChannelEnteredBridge";
+export type ChannelLeftBridgeEventType = "ChannelLeftBridge";
+export type ChannelStateChangeEventType = "ChannelStateChange";
+export type ChannelDtmfReceivedEventType = "ChannelDtmfReceived";
+export type ChannelDialplanEventType = "ChannelDialplan";
+export type ChannelCallerIdEventType = "ChannelCallerId";
+export type ChannelUsereventEventType = "ChannelUserevent";
+export type ChannelHangupRequestEventType = "ChannelHangupRequest";
+export type ChannelVarsetEventType = "ChannelVarset";
+export type ChannelHoldEventType = "ChannelHold";
+export type ChannelUnholdEventType = "ChannelUnhold";
+export type ChannelTalkingStartedEventType = "ChannelTalkingStarted";
+export type ChannelTalkingFinishedEventType = "ChannelTalkingFinished";
+export type ContactStatusChangeEventType = "ContactStatusChange";
+export type PeerStatusChangeEventType = "PeerStatusChange";
+export type EndpointStateChangeEventType = "EndpointStateChange";
+export type DialEventType = "Dial";
+export type StasisEndEventType = "StasisEnd";
+export type StasisStartEventType = "StasisStart";
+export type TextMessageReceivedEventType = "TextMessageReceived";
+export type ChannelConnectedLineEventType = "ChannelConnectedLine";
 export type AnyEventType =
     | WebSocketConnectedEventType
     | WebSocketReconnectingEventType
@@ -312,7 +307,12 @@ export interface Events {
      * @param [params.variables] - The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } }.
      */
     userEvent(
-        params: { eventName: string; application: string; source?: string | string[] | undefined; variables?: Containers | undefined },
+        params: {
+            eventName: string;
+            application: string;
+            source?: string | string[] | undefined;
+            variables?: Containers | undefined;
+        },
         callback: (err: Error) => void,
     ): void;
 
@@ -2018,7 +2018,10 @@ export interface Application extends Resource {
      *
      * @param [params.filter] - Specify which event types to allow/disallow.
      */
-    filter(params: { filter?: IndexableObject | undefined }, callback: (err: Error, application: Application) => void): void;
+    filter(
+        params: { filter?: IndexableObject | undefined },
+        callback: (err: Error, application: Application) => void,
+    ): void;
 
     /**
      * Filter application events types.
@@ -2123,7 +2126,10 @@ export interface Asterisk {
      *
      * @param [params.only] - Filter information returned.
      */
-    getInfo(params: { only?: string | string[] | undefined }, callback: (err: Error, asteriskinfo: AsteriskInfo) => void): void;
+    getInfo(
+        params: { only?: string | string[] | undefined },
+        callback: (err: Error, asteriskinfo: AsteriskInfo) => void,
+    ): void;
 
     /**
      * Gets Asterisk system information.
@@ -2531,7 +2537,9 @@ export interface Bridges {
      * @param [params.bridgeId] - Unique ID to give to the bridge being created.
      * @param [params.name] - Name to give to the bridge being created.
      */
-    create(params?: { type?: string | undefined; bridgeId?: string | undefined; name?: string | undefined }): Promise<Bridge>;
+    create(
+        params?: { type?: string | undefined; bridgeId?: string | undefined; name?: string | undefined },
+    ): Promise<Bridge>;
 
     /**
      * Create a new bridge or updates an existing one.
@@ -2596,7 +2604,13 @@ export interface Bridges {
      * @param [params.mute] - Mute audio from this channel, preventing it to pass through to the bridge.
      */
     addChannel(
-        params: { bridgeId: string; channel: string | string[]; role?: string | undefined; absorbDTMF?: boolean | undefined; mute?: boolean | undefined },
+        params: {
+            bridgeId: string;
+            channel: string | string[];
+            role?: string | undefined;
+            absorbDTMF?: boolean | undefined;
+            mute?: boolean | undefined;
+        },
         callback: (err: Error) => void,
     ): void;
 
@@ -2906,7 +2920,10 @@ export interface Bridge extends Resource {
      * @param [params.type] - Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu).
      * @param [params.name] - Name to give to the bridge being created.
      */
-    create(params: { type?: string | undefined; name?: string | undefined }, callback: (err: Error, bridge: Bridge) => void): void;
+    create(
+        params: { type?: string | undefined; name?: string | undefined },
+        callback: (err: Error, bridge: Bridge) => void,
+    ): void;
 
     /**
      * Create a new bridge.
@@ -2930,7 +2947,10 @@ export interface Bridge extends Resource {
      * @param [params.type] - Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu) to set.
      * @param [params.name] - Set the name of the bridge.
      */
-    createWithId(params: { type?: string | undefined; name?: string | undefined }, callback: (err: Error, bridge: Bridge) => void): void;
+    createWithId(
+        params: { type?: string | undefined; name?: string | undefined },
+        callback: (err: Error, bridge: Bridge) => void,
+    ): void;
 
     /**
      * Create a new bridge or updates an existing one.
@@ -2978,7 +2998,12 @@ export interface Bridge extends Resource {
      * @param [params.mute] - Mute audio from this channel, preventing it to pass through to the bridge.
      */
     addChannel(
-        params: { channel: string | string[]; role?: string | undefined; absorbDTMF?: boolean | undefined; mute?: boolean | undefined },
+        params: {
+            channel: string | string[];
+            role?: string | undefined;
+            absorbDTMF?: boolean | undefined;
+            mute?: boolean | undefined;
+        },
         callback: (err: Error) => void,
     ): void;
 
@@ -3080,7 +3105,13 @@ export interface Bridge extends Resource {
      * @param [params.playbackId] - Playback Id.
      */
     play(
-        params: { media: string | string[]; lang?: string | undefined; offsetms?: number | undefined; skipms?: number | undefined; playbackId?: string | undefined },
+        params: {
+            media: string | string[];
+            lang?: string | undefined;
+            offsetms?: number | undefined;
+            skipms?: number | undefined;
+            playbackId?: string | undefined;
+        },
         callback: (err: Error, playback: Playback) => void,
     ): void;
 
@@ -3115,7 +3146,13 @@ export interface Bridge extends Resource {
      * @param [params.skipms] - Number of milliseconds to skip for forward/reverse operations.
      */
     playWithId(
-        params: { playbackId: string; media: string | string[]; lang?: string | undefined; offsetms?: number | undefined; skipms?: number | undefined },
+        params: {
+            playbackId: string;
+            media: string | string[];
+            lang?: string | undefined;
+            offsetms?: number | undefined;
+            skipms?: number | undefined;
+        },
         callback: (err: Error, playback: Playback) => void,
     ): void;
 
@@ -3447,7 +3484,13 @@ export interface Channels {
      * @param [params.label] - The label to continue to - will supersede priority if both are provided.
      */
     continueInDialplan(
-        params: { channelId: string; context?: string | undefined; extension?: string | undefined; priority?: number | undefined; label?: string | undefined },
+        params: {
+            channelId: string;
+            context?: string | undefined;
+            extension?: string | undefined;
+            priority?: number | undefined;
+            label?: string | undefined;
+        },
         callback: (err: Error) => void,
     ): void;
 
@@ -3475,7 +3518,10 @@ export interface Channels {
      * @param params.app - The channel will be passed to this Stasis application.
      * @param [params.appArgs] - The application arguments to pass to the Stasis application provided by app.
      */
-    move(params: { channelId: string; app: string; appArgs?: string | undefined }, callback: (err: Error) => void): void;
+    move(
+        params: { channelId: string; app: string; appArgs?: string | undefined },
+        callback: (err: Error) => void,
+    ): void;
 
     /**
      * Move the channel from one Stasis application to another.
@@ -3902,7 +3948,14 @@ export interface Channels {
      * @param [params.snoopId] - Unique ID to assign to snooping channel.
      */
     snoopChannel(
-        params: { channelId: string; spy?: string | undefined; whisper?: string | undefined; app: string; appArgs?: string | undefined; snoopId?: string | undefined },
+        params: {
+            channelId: string;
+            spy?: string | undefined;
+            whisper?: string | undefined;
+            app: string;
+            appArgs?: string | undefined;
+            snoopId?: string | undefined;
+        },
         callback: (err: Error, channel: Channel) => void,
     ): void;
 
@@ -3938,7 +3991,14 @@ export interface Channels {
      * @param [params.appArgs] - The application arguments to pass to the Stasis application.
      */
     snoopChannelWithId(
-        params: { channelId: string; snoopId: string; spy?: string | undefined; whisper?: string | undefined; app: string; appArgs?: string | undefined },
+        params: {
+            channelId: string;
+            snoopId: string;
+            spy?: string | undefined;
+            whisper?: string | undefined;
+            app: string;
+            appArgs?: string | undefined;
+        },
         callback: (err: Error, channel: Channel) => void,
     ): void;
 
@@ -3969,7 +4029,10 @@ export interface Channels {
      * @param [params.caller] - Channel ID of caller.
      * @param [params.timeout] - Dial timeout.
      */
-    dial(params: { channelId: string; caller?: string | undefined; timeout?: number | undefined }, callback: (err: Error) => void): void;
+    dial(
+        params: { channelId: string; caller?: string | undefined; timeout?: number | undefined },
+        callback: (err: Error) => void,
+    ): void;
 
     /**
      * Dial a created channel.
@@ -4543,7 +4606,12 @@ export interface Channel extends Resource {
      * @param [params.label] - The label to continue to - will supersede priority if both are provided.
      */
     continueInDialplan(
-        params: { context?: string | undefined; extension?: string | undefined; priority?: number | undefined; label?: string | undefined },
+        params: {
+            context?: string | undefined;
+            extension?: string | undefined;
+            priority?: number | undefined;
+            label?: string | undefined;
+        },
         callback: (err: Error) => void,
     ): void;
 
@@ -4637,7 +4705,13 @@ export interface Channel extends Resource {
      * @param [params.after] - Amount of time to wait after DTMF digits (specified in milliseconds) end.
      */
     sendDTMF(
-        params: { dtmf?: string | undefined; before?: number | undefined; between?: number | undefined; duration?: number | undefined; after?: number | undefined },
+        params: {
+            dtmf?: string | undefined;
+            before?: number | undefined;
+            between?: number | undefined;
+            duration?: number | undefined;
+            after?: number | undefined;
+        },
         callback: (err: Error) => void,
     ): void;
 
@@ -4790,7 +4864,13 @@ export interface Channel extends Resource {
      * @param [params.playbackId] - Playback ID.
      */
     play(
-        params: { media: string | string[]; lang?: string | undefined; offsetms?: number | undefined; skipms?: number | undefined; playbackId?: string | undefined },
+        params: {
+            media: string | string[];
+            lang?: string | undefined;
+            offsetms?: number | undefined;
+            skipms?: number | undefined;
+            playbackId?: string | undefined;
+        },
         playback: Playback,
         callback: (err: Error, playback: Playback) => void,
     ): void;
@@ -4807,7 +4887,13 @@ export interface Channel extends Resource {
      * @param [params.playbackId] - Playback ID.
      */
     play(
-        params: { media: string | string[]; lang?: string | undefined; offsetms?: number | undefined; skipms?: number | undefined; playbackId?: string | undefined },
+        params: {
+            media: string | string[];
+            lang?: string | undefined;
+            offsetms?: number | undefined;
+            skipms?: number | undefined;
+            playbackId?: string | undefined;
+        },
         playback: Playback,
     ): Promise<Playback>;
 
@@ -4823,7 +4909,13 @@ export interface Channel extends Resource {
      * @param [params.skipms] - Number of milliseconds to skip for forward/reverse operations.
      */
     playWithId(
-        params: { playbackId: string; media: string | string[]; lang?: string | undefined; offsetms?: number | undefined; skipms?: number | undefined },
+        params: {
+            playbackId: string;
+            media: string | string[];
+            lang?: string | undefined;
+            offsetms?: number | undefined;
+            skipms?: number | undefined;
+        },
         callback: (err: Error, playback: Playback) => void,
     ): void;
 
@@ -4938,7 +5030,13 @@ export interface Channel extends Resource {
      * @param [params.snoopId] - Unique ID to assign to snooping channel.
      */
     snoopChannel(
-        params: { spy?: string | undefined; whisper?: string | undefined; app: string; appArgs?: string | undefined; snoopId?: string | undefined },
+        params: {
+            spy?: string | undefined;
+            whisper?: string | undefined;
+            app: string;
+            appArgs?: string | undefined;
+            snoopId?: string | undefined;
+        },
         snoopChannel: Channel,
         callback: (err: Error, channel: Channel) => void,
     ): void;
@@ -4954,7 +5052,13 @@ export interface Channel extends Resource {
      * @param [params.snoopId] - Unique ID to assign to snooping channel.
      */
     snoopChannel(
-        params: { spy?: string | undefined; whisper?: string | undefined; app: string; appArgs?: string | undefined; snoopId?: string | undefined },
+        params: {
+            spy?: string | undefined;
+            whisper?: string | undefined;
+            app: string;
+            appArgs?: string | undefined;
+            snoopId?: string | undefined;
+        },
         snoopChannel: Channel,
     ): Promise<Channel>;
 
@@ -4969,7 +5073,13 @@ export interface Channel extends Resource {
      * @param [params.appArgs] - The application arguments to pass to the Stasis application.
      */
     snoopChannelWithId(
-        params: { snoopId: string; spy?: string | undefined; whisper?: string | undefined; app: string; appArgs?: string | undefined },
+        params: {
+            snoopId: string;
+            spy?: string | undefined;
+            whisper?: string | undefined;
+            app: string;
+            appArgs?: string | undefined;
+        },
         callback: (err: Error, channel: Channel) => void,
     ): void;
 
@@ -5219,7 +5329,9 @@ export interface Endpoints {
      * @param [params.variables] - The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various
      * resource types; for example, pjsip and sip resource types will add the key/value pairs as SIP headers.
      */
-    sendMessage(params: { to: string; from: string; body?: string | undefined; variables?: Containers | undefined }): Promise<void>;
+    sendMessage(
+        params: { to: string; from: string; body?: string | undefined; variables?: Containers | undefined },
+    ): Promise<void>;
 
     /**
      * List available endoints for a given endpoint technology.
@@ -5272,7 +5384,13 @@ export interface Endpoints {
      * resource types; for example, pjsip and sip resource types will add the key/value pairs as SIP headers.
      */
     sendMessageToEndpoint(
-        params: { tech: string; resource: string; from: string; body?: string | undefined; variables?: Containers | undefined },
+        params: {
+            tech: string;
+            resource: string;
+            from: string;
+            body?: string | undefined;
+            variables?: Containers | undefined;
+        },
         callback: (err: Error) => void,
     ): void;
 
@@ -5348,7 +5466,9 @@ export interface Endpoint extends Resource {
      * @param [params.variables] - The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various
      * resource types; for example, pjsip and sip resource types will add the key/value pairs as SIP headers.
      */
-    sendMessage(params: { to: string; from: string; body?: string | undefined; variables?: Containers | undefined }): Promise<void>;
+    sendMessage(
+        params: { to: string; from: string; body?: string | undefined; variables?: Containers | undefined },
+    ): Promise<void>;
 
     /**
      * List available endoints for a given endpoint technology.
@@ -5391,7 +5511,9 @@ export interface Endpoint extends Resource {
      * @param [params.variables] - The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various
      * resource types; for example, pjsip and sip resource types will add the key/value pairs as SIP headers.
      */
-    sendMessageToEndpoint(params: { from: string; body?: string | undefined; variables?: Containers | undefined }): Promise<void>;
+    sendMessageToEndpoint(
+        params: { from: string; body?: string | undefined; variables?: Containers | undefined },
+    ): Promise<void>;
 }
 export interface TextMessage {
     /**
@@ -6145,7 +6267,10 @@ export interface Sounds {
      * @param [params.lang] - Lookup sound for a specific language.
      * @param [params.format] - Lookup sound in a specific format.
      */
-    list(params: { lang?: string | undefined; format?: string | undefined }, callback: (err: Error, sounds: Sound[]) => void): void;
+    list(
+        params: { lang?: string | undefined; format?: string | undefined },
+        callback: (err: Error, sounds: Sound[]) => void,
+    ): void;
 
     /**
      * List all sounds.
@@ -6207,7 +6332,10 @@ export interface Sound extends Resource {
      * @param [params.lang] - Lookup sound for a specific language.
      * @param [params.format] - Lookup sound in a specific format.
      */
-    list(params: { lang?: string | undefined; format?: string | undefined }, callback: (err: Error, sounds: Sound[]) => void): void;
+    list(
+        params: { lang?: string | undefined; format?: string | undefined },
+        callback: (err: Error, sounds: Sound[]) => void,
+    ): void;
 
     /**
      * List all sounds.

ari-client/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@types/ari-client",
-    "version": "2.2.9",
+    "version": "2.2.11",
     "description": "TypeScript definitions for ari-client",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ari-client",
     "license": "MIT",
     "contributors": [
         {
             "name": "Dioris Moreno",
-            "url": "https://github.com/dioris-moreno",
-            "githubUsername": "dioris-moreno"
+            "githubUsername": "dioris-moreno",
+            "url": "https://github.com/dioris-moreno"
         }
     ],
     "main": "",
@@ -22,6 +22,6 @@
     "dependencies": {
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "a7ec812ad768ecb5ee09d6af5ea0cca59f3e67270a1461d54fbdba082afee642",
-    "typeScriptVersion": "4.3"
+    "typesPublisherContentHash": "1babd734a52614a7854402ae7ed668bded9aad29b610f777dd6f1abf20aaf20f",
+    "typeScriptVersion": "4.5"
 }