@types/ari-client 2.2.3 → 2.2.7

ari-client/README.md

@@ -8,7 +8,7 @@ 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: Wed, 07 Jul 2021 21:44:31 GMT
+ * Last updated: Thu, 25 Nov 2021 21:01:10 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 

ari-client/index.d.ts

@@ -28,22 +28,30 @@ export interface TextMessageVariable {
 }
 
 export interface Client extends Resource {
+    /**
+     *  Creates the WebSocket connection, subscribing to the given apps.
+     *
+     *  @param apps - Name or array of names of the applications to be started.
+     *  @param [subscribeAll] - Subscribe to all Asterisk events (true/false).
+     */
+    start(apps: string | string[], subscribeAll?: boolean): Promise<void>;
+
     /**
      *  Creates the WebSocket connection, subscribing to the given apps.
      *
      *  @param apps - Name or array of names of the applications to be started.
      *  @param subscribeAll - Subscribe to all Asterisk events (true/false).
-     *  @param [callback] - The callback to be called after applications have started.
+     *  @param callback - The callback to be called after applications have started.
      */
-    start(apps: string | string[], subscribeAll: boolean, callback?: (err: Error, ...args: any[]) => void): void;
+    start(apps: string | string[], subscribeAll: boolean, callback: (err: Error, ...args: any[]) => void): void;
 
     /**
      *  Creates the WebSocket connection, subscribing to the given apps.
      *
      *  @param apps - Name or array of names of the applications to be started.
-     *  @param [callback] - The callback to be called after applications have started.
+     *  @param callback - The callback to be called after applications have started.
      */
-    start(apps: string | string[], callback?: (err: Error, ...args: any[]) => void): void;
+    start(apps: string | string[], callback: (err: Error, ...args: any[]) => void): void;
 
     /**
      *  Closes the WebSocket connection.
@@ -173,6 +181,10 @@ 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';
@@ -219,6 +231,11 @@ export type StasisStartEventType = 'StasisStart';
 export type TextMessageReceivedEventType = 'TextMessageReceived';
 export type ChannelConnectedLineEventType = 'ChannelConnectedLine';
 export type AnyEventType =
+    | WebSocketConnectedEventType
+    | WebSocketReconnectingEventType
+    | WebSocketMaxRetriesEventType
+    | PongEventType
+    | APILoadErrorEventType
     | EventsEventType
     | MessageEventType
     | MissingParamsEventType
@@ -892,6 +909,41 @@ export interface ChannelConnectedLine extends Event {
     channel: Channel;
 }
 export interface Resource {
+    /**
+     * The ARI client instance.
+     */
+    _client: Client;
+
+    /**
+     * Error emitted when WebSocket reconnection attempts exceeded MaxRetries.
+     */
+    // tslint:disable-next-line:unified-signatures
+    on(type: WebSocketMaxRetriesEventType, listener: (err: Error) => void): void;
+
+    /**
+     * Error emitted when the WebSocket is reconnecting.
+     */
+    // tslint:disable-next-line:unified-signatures
+    on(type: WebSocketReconnectingEventType, listener: (err: Error) => void): void;
+
+    /**
+     * Event emitted when the WebSocket is connected.
+     */
+    // tslint:disable-next-line:unified-signatures
+    on(type: WebSocketConnectedEventType, listener: () => void): void;
+
+    /**
+     * Event emitted when a WebSocket pong is received.
+     */
+    // tslint:disable-next-line:unified-signatures
+    on(type: PongEventType, listener: () => void): void;
+
+    /**
+     * Error event sent when connection to API fails.
+     */
+    // tslint:disable-next-line:unified-signatures
+    on(type: APILoadErrorEventType, listener: (err: Error) => void): void;
+
     /**
      * Base type for errors and events.
      */
@@ -1138,6 +1190,36 @@ export interface Resource {
      */
     on(event: ChannelConnectedLineEventType, callback: (event: ChannelConnectedLine, channel: Channel) => void): void;
 
+    /**
+     * Error emitted when WebSocket reconnection attempts exceeded MaxRetries.
+     */
+    // tslint:disable-next-line:unified-signatures
+    once(type: WebSocketMaxRetriesEventType, listener: (err: Error) => void): void;
+
+    /**
+     * Error emitted when the WebSocket is reconnecting.
+     */
+    // tslint:disable-next-line:unified-signatures
+    once(type: WebSocketReconnectingEventType, listener: (err: Error) => void): void;
+
+    /**
+     * Event emitted when the WebSocket is connected.
+     */
+    // tslint:disable-next-line:unified-signatures
+    once(type: WebSocketConnectedEventType, listener: () => void): void;
+
+    /**
+     * Event emitted when a WebSocket pong is received.
+     */
+    // tslint:disable-next-line:unified-signatures
+    once(type: PongEventType, listener: () => void): void;
+
+    /**
+     * Error event sent when connection to API fails.
+     */
+    // tslint:disable-next-line:unified-signatures
+    once(type: APILoadErrorEventType, listener: (err: Error) => void): void;
+
     /**
      * Base type for errors and events.
      */
@@ -1393,6 +1475,36 @@ export interface Resource {
      */
     once(event: ChannelConnectedLineEventType, callback: (event: ChannelConnectedLine, channel: Channel) => void): void;
 
+    /**
+     * Error emitted when WebSocket reconnection attempts exceeded MaxRetries.
+     */
+    // tslint:disable-next-line:unified-signatures
+    addListener(type: WebSocketMaxRetriesEventType, listener: (err: Error) => void): void;
+
+    /**
+     * Error emitted when the WebSocket is reconnecting.
+     */
+    // tslint:disable-next-line:unified-signatures
+    addListener(type: WebSocketReconnectingEventType, listener: (err: Error) => void): void;
+
+    /**
+     * Event emitted when the WebSocket is connected.
+     */
+    // tslint:disable-next-line:unified-signatures
+    addListener(type: WebSocketConnectedEventType, listener: () => void): void;
+
+    /**
+     * Event emitted when a WebSocket pong is received.
+     */
+    // tslint:disable-next-line:unified-signatures
+    addListener(type: PongEventType, listener: () => void): void;
+
+    /**
+     * Error event sent when connection to API fails.
+     */
+    // tslint:disable-next-line:unified-signatures
+    addListener(type: APILoadErrorEventType, listener: (err: Error) => void): void;
+
     /**
      * Base type for errors and events.
      */

ari-client/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/ari-client",
-    "version": "2.2.3",
+    "version": "2.2.7",
     "description": "TypeScript definitions for ari-client",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ari-client",
     "license": "MIT",
@@ -22,6 +22,6 @@
     "dependencies": {
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "853108c6c32cb8c693801d2f0b36edf6958b3f74ee822861fc411dc9be54df9e",
-    "typeScriptVersion": "3.6"
+    "typesPublisherContentHash": "9d0c715a527071ed025639308513700a800d8f800663e73aa9f7785246cfb574",
+    "typeScriptVersion": "3.8"
 }