twilio 3.73.0 → 3.73.1

package/CHANGES.md

@@ -1,6 +1,23 @@
 twilio-node changelog
 =====================
 
+[2022-01-26] Version 3.73.1
+---------------------------
+**Library - Chore**
+- [PR #727](https://github.com/twilio/twilio-node/pull/727): run audit only on non dev dependencies. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Insights**
+- Added new endpoint to fetch Conference Participant Summary
+- Added new endpoint to fetch Conference Summary
+
+**Messaging**
+- Add government_entity parameter to brand apis
+
+**Verify**
+- Add Access Token fetch endpoint to retrieve a previously created token.
+- Add Access Token payload to the Access Token creation endpoint, including a unique Sid, so it's addressable while it's TTL is valid.
+
+
 [2022-01-12] Version 3.73.0
 ---------------------------
 **Library - Chore**

package/lib/rest/Insights.d.ts

@@ -10,6 +10,7 @@ import Twilio = require('./Twilio');
 import V1 = require('./insights/V1');
 import { CallListInstance } from './insights/v1/call';
 import { CallSummariesListInstance } from './insights/v1/callSummaries';
+import { ConferenceListInstance } from './insights/v1/conference';
 import { RoomListInstance } from './insights/v1/room';
 import { SettingListInstance } from './insights/v1/setting';
 
@@ -24,6 +25,7 @@ declare class Insights extends Domain {
 
   readonly callSummaries: CallSummariesListInstance;
   readonly calls: CallListInstance;
+  readonly conferences: ConferenceListInstance;
   readonly rooms: RoomListInstance;
   readonly settings: SettingListInstance;
   readonly v1: V1;

package/lib/rest/Insights.js

@@ -25,6 +25,7 @@ var V1 = require('./insights/V1');  /* jshint ignore:line */
  * @property {Twilio.Insights.V1.CallList} calls - calls resource
  * @property {Twilio.Insights.V1.CallSummariesList} callSummaries -
  *          callSummaries resource
+ * @property {Twilio.Insights.V1.ConferenceList} conferences - conferences resource
  * @property {Twilio.Insights.V1.RoomList} rooms - rooms resource
  *
  * @param {Twilio} twilio - The twilio client
@@ -69,6 +70,13 @@ Object.defineProperty(Insights.prototype,
     }
 });
 
+Object.defineProperty(Insights.prototype,
+  'conferences', {
+    get: function() {
+      return this.v1.conferences;
+    }
+});
+
 Object.defineProperty(Insights.prototype,
   'rooms', {
     get: function() {

package/lib/rest/Supersim.d.ts

@@ -9,6 +9,7 @@ import Domain = require('../base/Domain');
 import Twilio = require('./Twilio');
 import V1 = require('./supersim/V1');
 import { CommandListInstance } from './supersim/v1/command';
+import { EsimProfileListInstance } from './supersim/v1/esimProfile';
 import { FleetListInstance } from './supersim/v1/fleet';
 import { IpCommandListInstance } from './supersim/v1/ipCommand';
 import { NetworkAccessProfileListInstance } from './supersim/v1/networkAccessProfile';
@@ -27,6 +28,7 @@ declare class Supersim extends Domain {
   constructor(twilio: Twilio);
 
   readonly commands: CommandListInstance;
+  readonly esimProfiles: EsimProfileListInstance;
   readonly fleets: FleetListInstance;
   readonly ipCommands: IpCommandListInstance;
   readonly networkAccessProfiles: NetworkAccessProfileListInstance;

package/lib/rest/Supersim.js

@@ -22,6 +22,8 @@ var V1 = require('./supersim/V1');  /* jshint ignore:line */
  *
  * @property {Twilio.Supersim.V1} v1 - v1 version
  * @property {Twilio.Supersim.V1.CommandList} commands - commands resource
+ * @property {Twilio.Supersim.V1.EsimProfileList} esimProfiles -
+ *          esimProfiles resource
  * @property {Twilio.Supersim.V1.FleetList} fleets - fleets resource
  * @property {Twilio.Supersim.V1.IpCommandList} ipCommands - ipCommands resource
  * @property {Twilio.Supersim.V1.NetworkList} networks - networks resource
@@ -60,6 +62,13 @@ Object.defineProperty(Supersim.prototype,
     }
 });
 
+Object.defineProperty(Supersim.prototype,
+  'esimProfiles', {
+    get: function() {
+      return this.v1.esimProfiles;
+    }
+});
+
 Object.defineProperty(Supersim.prototype,
   'fleets', {
     get: function() {

package/lib/rest/flexApi/v1/flexFlow.d.ts

@@ -33,7 +33,7 @@ declare function FlexFlowList(version: V1): FlexFlowListInstance;
  * @property integration.creationOnMessage - Whether to create a Task when the first message arrives
  * @property integration.flowSid - The SID of the Studio Flow
  * @property integration.priority - The Task priority of a new Task
- * @property integration.retryCount - The number of times to retry the webhook if the first attempt fails
+ * @property integration.retryCount - The number of times to retry the Studio Flow or webhook in case of failure
  * @property integration.timeout - The Task timeout in seconds for a new Task
  * @property integration.url - The External Webhook URL
  * @property integration.workflowSid - The Workflow SID for a new Task
@@ -196,7 +196,7 @@ interface FlexFlowListInstance {
  * @property integration.creationOnMessage - Whether to create a Task when the first message arrives
  * @property integration.flowSid - The SID of the Studio Flow
  * @property integration.priority - The Task priority of a new Task
- * @property integration.retryCount - The number of times to retry the webhook if the first attempt fails
+ * @property integration.retryCount - The number of times to retry the Studio Flow or webhook in case of failure
  * @property integration.timeout - The Task timeout in seconds for a new Task
  * @property integration.url - The External Webhook URL
  * @property integration.workflowSid - The Workflow SID for a new Task

package/lib/rest/flexApi/v1/flexFlow.js

@@ -333,7 +333,7 @@ FlexFlowList = function FlexFlowList(version) {
    * @param {boolean} [opts.janitorEnabled] -
    *          Remove active Proxy sessions if the corresponding Task is deleted
    * @param {number} [opts.integration.retryCount] -
-   *          The number of times to retry the webhook if the first attempt fails
+   *          The number of times to retry the Studio Flow or webhook in case of failure
    * @param {function} [callback] - Callback to handle processed record
    *
    * @returns {Promise} Resolves to processed FlexFlowInstance
@@ -608,7 +608,7 @@ FlexFlowInstance.prototype.fetch = function fetch(callback) {
  * @param {boolean} [opts.janitorEnabled] -
  *          Remove active Proxy sessions if the corresponding Task is deleted
  * @param {number} [opts.integration.retryCount] -
- *          The number of times to retry the webhook if the first attempt fails
+ *          The number of times to retry the Studio Flow or webhook in case of failure
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed FlexFlowInstance
@@ -740,7 +740,7 @@ FlexFlowContext.prototype.fetch = function fetch(callback) {
  * @param {boolean} [opts.janitorEnabled] -
  *          Remove active Proxy sessions if the corresponding Task is deleted
  * @param {number} [opts.integration.retryCount] -
- *          The number of times to retry the webhook if the first attempt fails
+ *          The number of times to retry the Studio Flow or webhook in case of failure
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed FlexFlowInstance

package/lib/rest/insights/V1.d.ts

@@ -11,6 +11,8 @@ import { CallList } from './v1/call';
 import { CallListInstance } from './v1/call';
 import { CallSummariesList } from './v1/callSummaries';
 import { CallSummariesListInstance } from './v1/callSummaries';
+import { ConferenceList } from './v1/conference';
+import { ConferenceListInstance } from './v1/conference';
 import { RoomList } from './v1/room';
 import { RoomListInstance } from './v1/room';
 import { SettingList } from './v1/setting';
@@ -27,6 +29,7 @@ declare class V1 extends Version {
 
   readonly callSummaries: CallSummariesListInstance;
   readonly calls: CallListInstance;
+  readonly conferences: ConferenceListInstance;
   readonly rooms: RoomListInstance;
   readonly settings: SettingListInstance;
 }

package/lib/rest/insights/V1.js

@@ -12,6 +12,7 @@
 var _ = require('lodash');  /* jshint ignore:line */
 var CallList = require('./v1/call').CallList;
 var CallSummariesList = require('./v1/callSummaries').CallSummariesList;
+var ConferenceList = require('./v1/conference').ConferenceList;
 var RoomList = require('./v1/room').RoomList;
 var SettingList = require('./v1/setting').SettingList;
 var Version = require('../../base/Version');  /* jshint ignore:line */
@@ -27,6 +28,7 @@ var Version = require('../../base/Version');  /* jshint ignore:line */
  * @property {Twilio.Insights.V1.CallList} calls - calls resource
  * @property {Twilio.Insights.V1.CallSummariesList} callSummaries -
  *          callSummaries resource
+ * @property {Twilio.Insights.V1.ConferenceList} conferences - conferences resource
  * @property {Twilio.Insights.V1.RoomList} rooms - rooms resource
  *
  * @param {Twilio.Insights} domain - The twilio domain
@@ -39,6 +41,7 @@ function V1(domain) {
   this._settings = undefined;
   this._calls = undefined;
   this._callSummaries = undefined;
+  this._conferences = undefined;
   this._rooms = undefined;
 }
 
@@ -69,6 +72,14 @@ Object.defineProperty(V1.prototype,
     }
 });
 
+Object.defineProperty(V1.prototype,
+  'conferences', {
+    get: function() {
+      this._conferences = this._conferences || new ConferenceList(this);
+      return this._conferences;
+    }
+});
+
 Object.defineProperty(V1.prototype,
   'rooms', {
     get: function() {

package/lib/rest/insights/v1/conference/conferenceParticipant.d.ts

@@ -0,0 +1,385 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../../base/Page');
+import Response = require('../../../../http/response');
+import V1 = require('../../V1');
+import { SerializableClass } from '../../../../interfaces';
+
+type ConferenceParticipantCallDirection = 'inbound'|'outbound';
+
+type ConferenceParticipantCallState = 'answered'|'completed'|'busy'|'fail'|'noanswer'|'ringing'|'canceled';
+
+type ConferenceParticipantCallType = 'carrier'|'client'|'sip';
+
+type ConferenceParticipantJitterBufferSize = 'large'|'small'|'medium'|'off';
+
+type ConferenceParticipantRegion = 'us1'|'us2'|'au1'|'br1'|'ie1'|'jp1'|'sg1'|'de1';
+
+/**
+ * Initialize the ConferenceParticipantList
+ *
+ * @param version - Version of the resource
+ * @param conferenceSid - The conference_sid
+ */
+declare function ConferenceParticipantList(version: V1, conferenceSid: string): ConferenceParticipantListInstance;
+
+/**
+ * Options to pass to fetch
+ *
+ * @property events - The events
+ * @property metrics - The metrics
+ */
+interface ConferenceParticipantInstanceFetchOptions {
+  events?: string;
+  metrics?: string;
+}
+
+interface ConferenceParticipantListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): ConferenceParticipantContext;
+  /**
+   * Streams ConferenceParticipantInstance records from the API.
+   *
+   * This operation lazily loads records as efficiently as possible until the limit
+   * is reached.
+   *
+   * The results are passed into the callback function, so this operation is memory
+   * efficient.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Function to process each record
+   */
+  each(callback?: (item: ConferenceParticipantInstance, done: (err?: Error) => void) => void): void;
+  /**
+   * Streams ConferenceParticipantInstance records from the API.
+   *
+   * This operation lazily loads records as efficiently as possible until the limit
+   * is reached.
+   *
+   * The results are passed into the callback function, so this operation is memory
+   * efficient.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param opts - Options for request
+   * @param callback - Function to process each record
+   */
+  each(opts?: ConferenceParticipantListInstanceEachOptions, callback?: (item: ConferenceParticipantInstance, done: (err?: Error) => void) => void): void;
+  /**
+   * Constructs a conference_participant
+   *
+   * @param participantSid - The participant_sid
+   */
+  get(participantSid: string): ConferenceParticipantContext;
+  /**
+   * Retrieve a single target page of ConferenceParticipantInstance records from the
+   * API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Callback to handle list of records
+   */
+  getPage(callback?: (error: Error | null, items: ConferenceParticipantPage) => any): Promise<ConferenceParticipantPage>;
+  /**
+   * Retrieve a single target page of ConferenceParticipantInstance records from the
+   * API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param targetUrl - API-generated URL for the requested results page
+   * @param callback - Callback to handle list of records
+   */
+  getPage(targetUrl?: string, callback?: (error: Error | null, items: ConferenceParticipantPage) => any): Promise<ConferenceParticipantPage>;
+  /**
+   * Lists ConferenceParticipantInstance records from the API as a list.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Callback to handle list of records
+   */
+  list(callback?: (error: Error | null, items: ConferenceParticipantInstance[]) => any): Promise<ConferenceParticipantInstance[]>;
+  /**
+   * Lists ConferenceParticipantInstance records from the API as a list.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle list of records
+   */
+  list(opts?: ConferenceParticipantListInstanceOptions, callback?: (error: Error | null, items: ConferenceParticipantInstance[]) => any): Promise<ConferenceParticipantInstance[]>;
+  /**
+   * Retrieve a single page of ConferenceParticipantInstance records from the API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Callback to handle list of records
+   */
+  page(callback?: (error: Error | null, items: ConferenceParticipantPage) => any): Promise<ConferenceParticipantPage>;
+  /**
+   * Retrieve a single page of ConferenceParticipantInstance records from the API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle list of records
+   */
+  page(opts?: ConferenceParticipantListInstancePageOptions, callback?: (error: Error | null, items: ConferenceParticipantPage) => any): Promise<ConferenceParticipantPage>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to each
+ *
+ * @property callback -
+ *                         Function to process each record. If this and a positional
+ *                         callback are passed, this one will be used
+ * @property done - Function to be called upon completion of streaming
+ * @property events - The events
+ * @property label - The label
+ * @property limit -
+ *                         Upper limit for the number of records to return.
+ *                         each() guarantees never to return more than limit.
+ *                         Default is no limit
+ * @property pageSize -
+ *                         Number of records to fetch per request,
+ *                         when not set will use the default value of 50 records.
+ *                         If no pageSize is defined but a limit is defined,
+ *                         each() will attempt to read the limit with the most efficient
+ *                         page size, i.e. min(limit, 1000)
+ * @property participantSid - The participant_sid
+ */
+interface ConferenceParticipantListInstanceEachOptions {
+  callback?: (item: ConferenceParticipantInstance, done: (err?: Error) => void) => void;
+  done?: Function;
+  events?: string;
+  label?: string;
+  limit?: number;
+  pageSize?: number;
+  participantSid?: string;
+}
+
+/**
+ * Options to pass to list
+ *
+ * @property events - The events
+ * @property label - The label
+ * @property limit -
+ *                         Upper limit for the number of records to return.
+ *                         list() guarantees never to return more than limit.
+ *                         Default is no limit
+ * @property pageSize -
+ *                         Number of records to fetch per request,
+ *                         when not set will use the default value of 50 records.
+ *                         If no page_size is defined but a limit is defined,
+ *                         list() will attempt to read the limit with the most
+ *                         efficient page size, i.e. min(limit, 1000)
+ * @property participantSid - The participant_sid
+ */
+interface ConferenceParticipantListInstanceOptions {
+  events?: string;
+  label?: string;
+  limit?: number;
+  pageSize?: number;
+  participantSid?: string;
+}
+
+/**
+ * Options to pass to page
+ *
+ * @property events - The events
+ * @property label - The label
+ * @property pageNumber - Page Number, this value is simply for client state
+ * @property pageSize - Number of records to return, defaults to 50
+ * @property pageToken - PageToken provided by the API
+ * @property participantSid - The participant_sid
+ */
+interface ConferenceParticipantListInstancePageOptions {
+  events?: string;
+  label?: string;
+  pageNumber?: number;
+  pageSize?: number;
+  pageToken?: string;
+  participantSid?: string;
+}
+
+interface ConferenceParticipantPayload extends ConferenceParticipantResource, Page.TwilioResponsePayload {
+}
+
+interface ConferenceParticipantResource {
+  account_sid: string;
+  agent_audio: boolean;
+  call_direction: ConferenceParticipantCallDirection;
+  call_sid: string;
+  call_state: ConferenceParticipantCallState;
+  call_type: ConferenceParticipantCallType;
+  coached_participants: string[];
+  conference_region: ConferenceParticipantRegion;
+  conference_sid: string;
+  country_code: string;
+  duration_seconds: number;
+  events: object;
+  from: string;
+  is_coach: boolean;
+  is_moderator: boolean;
+  jitter_buffer_size: ConferenceParticipantJitterBufferSize;
+  join_time: Date;
+  label: string;
+  leave_time: Date;
+  metrics: object;
+  outbound_queue_length: number;
+  outbound_time_in_queue: number;
+  participant_region: ConferenceParticipantRegion;
+  participant_sid: string;
+  properties: object;
+  quality_issues: number;
+  to: string;
+  url: string;
+  whisper: string;
+}
+
+interface ConferenceParticipantSolution {
+  conferenceSid?: string;
+}
+
+
+declare class ConferenceParticipantContext {
+  /**
+   * Initialize the ConferenceParticipantContext
+   *
+   * @param version - Version of the resource
+   * @param conferenceSid - The conference_sid
+   * @param participantSid - The participant_sid
+   */
+  constructor(version: V1, conferenceSid: string, participantSid: string);
+
+  /**
+   * fetch a ConferenceParticipantInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: ConferenceParticipantInstance) => any): Promise<ConferenceParticipantInstance>;
+  /**
+   * fetch a ConferenceParticipantInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  fetch(opts?: ConferenceParticipantInstanceFetchOptions, callback?: (error: Error | null, items: ConferenceParticipantInstance) => any): Promise<ConferenceParticipantInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class ConferenceParticipantInstance extends SerializableClass {
+  /**
+   * Initialize the ConferenceParticipantContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param conferenceSid - The conference_sid
+   * @param participantSid - The participant_sid
+   */
+  constructor(version: V1, payload: ConferenceParticipantPayload, conferenceSid: string, participantSid: string);
+
+  private _proxy: ConferenceParticipantContext;
+  accountSid: string;
+  agentAudio: boolean;
+  callDirection: ConferenceParticipantCallDirection;
+  callSid: string;
+  callState: ConferenceParticipantCallState;
+  callType: ConferenceParticipantCallType;
+  coachedParticipants: string[];
+  conferenceRegion: ConferenceParticipantRegion;
+  conferenceSid: string;
+  countryCode: string;
+  durationSeconds: number;
+  events: any;
+  /**
+   * fetch a ConferenceParticipantInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: ConferenceParticipantInstance) => any): Promise<ConferenceParticipantInstance>;
+  /**
+   * fetch a ConferenceParticipantInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  fetch(opts?: ConferenceParticipantInstanceFetchOptions, callback?: (error: Error | null, items: ConferenceParticipantInstance) => any): Promise<ConferenceParticipantInstance>;
+  from: string;
+  isCoach: boolean;
+  isModerator: boolean;
+  jitterBufferSize: ConferenceParticipantJitterBufferSize;
+  joinTime: Date;
+  label: string;
+  leaveTime: Date;
+  metrics: any;
+  outboundQueueLength: number;
+  outboundTimeInQueue: number;
+  participantRegion: ConferenceParticipantRegion;
+  participantSid: string;
+  properties: any;
+  qualityIssues: number;
+  to: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  url: string;
+  whisper: string;
+}
+
+
+declare class ConferenceParticipantPage extends Page<V1, ConferenceParticipantPayload, ConferenceParticipantResource, ConferenceParticipantInstance> {
+  /**
+   * Initialize the ConferenceParticipantPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V1, response: Response<string>, solution: ConferenceParticipantSolution);
+
+  /**
+   * Build an instance of ConferenceParticipantInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: ConferenceParticipantPayload): ConferenceParticipantInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { ConferenceParticipantCallDirection, ConferenceParticipantCallState, ConferenceParticipantCallType, ConferenceParticipantContext, ConferenceParticipantInstance, ConferenceParticipantInstanceFetchOptions, ConferenceParticipantJitterBufferSize, ConferenceParticipantList, ConferenceParticipantListInstance, ConferenceParticipantListInstanceEachOptions, ConferenceParticipantListInstanceOptions, ConferenceParticipantListInstancePageOptions, ConferenceParticipantPage, ConferenceParticipantPayload, ConferenceParticipantRegion, ConferenceParticipantResource, ConferenceParticipantSolution }