twilio 3.71.1 → 3.71.2

package/CHANGES.md

@@ -1,6 +1,27 @@
 twilio-node changelog
 =====================
 
+[2021-11-17] Version 3.71.2
+---------------------------
+**Library - Fix**
+- [PR #707](https://github.com/twilio/twilio-node/pull/707): make ttl optional in ClientCapabilityOptions. Thanks to [@ghmeier](https://github.com/ghmeier)!
+- [PR #704](https://github.com/twilio/twilio-node/pull/704): git log retrieval issues. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Frontline**
+- Added `is_available` to User's resource
+
+**Messaging**
+- Added GET vetting API
+
+**Verify**
+- Add `WHATSAPP` to the attempts API.
+- Allow to update `config.notification_platform` from `none` to `apn` or `fcm` and viceversa for Verify Push
+- Add `none` as a valid `config.notification_platform` value for Verify Push
+
+**Twiml**
+- Add supported SSML children to `<emphasis>`, `<lang>`, `<p>`, `<prosody>`, `<s>`, and `<w>`.
+
+
 [2021-11-03] Version 3.71.1
 ---------------------------
 **Library - Fix**

package/lib/jwt/ClientCapability.d.ts

@@ -47,7 +47,7 @@ declare namespace ClientCapability {
   export interface ClientCapabilityOptions {
     accountSid: string;
     authToken: string;
-    ttl: number;
+    ttl?: number;
   }
 }
 

package/lib/rest/api/v2010/account/call.d.ts

@@ -192,7 +192,7 @@ interface CallListInstance {
  * @property asyncAmdStatusCallbackMethod - HTTP Method to use with async_amd_status_callback
  * @property byoc - BYOC trunk SID (Beta)
  * @property callReason - Reason for the call (Branded Calls Beta)
- * @property callToken - A token string needed to invoke a forwarded call with a caller-id recieved on a previous incoming call
+ * @property callToken - A token string needed to invoke a forwarded call with a CallerId recieved on a previous incoming call
  * @property callerId - The phone number, SIP address, or Client identifier that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`.
  * @property fallbackMethod - HTTP Method to use with fallback_url
  * @property fallbackUrl - Fallback URL in case of error

package/lib/rest/api/v2010/account/call.js

@@ -121,7 +121,7 @@ CallList = function CallList(version, accountSid) {
    * @param {string} [opts.byoc] - BYOC trunk SID (Beta)
    * @param {string} [opts.callReason] - Reason for the call (Branded Calls Beta)
    * @param {string} [opts.callToken] -
-   *          A token string needed to invoke a forwarded call with a caller-id recieved on a previous incoming call
+   *          A token string needed to invoke a forwarded call with a CallerId recieved on a previous incoming call
    * @param {string} [opts.recordingTrack] - Which track(s) to record
    * @param {number} [opts.timeLimit] - The maximum duration of the call in seconds.
    * @param {string} [opts.url] - The absolute URL that returns TwiML for this call

package/lib/rest/frontlineApi/v1/user.d.ts

@@ -27,11 +27,13 @@ declare function UserList(version: V1): UserListInstance;
  *
  * @property avatar - The avatar URL which will be shown in Frontline application
  * @property friendlyName - The string that you assigned to describe the User
+ * @property isAvailable - Whether the User is available for new conversations
  * @property state - Current state of this user
  */
 interface UserInstanceUpdateOptions {
   avatar?: string;
   friendlyName?: string;
+  isAvailable?: boolean;
   state?: UserStateType;
 }
 
@@ -59,6 +61,7 @@ interface UserResource {
   avatar: string;
   friendly_name: string;
   identity: string;
+  is_available: boolean;
   sid: string;
   state: UserStateType;
   url: string;
@@ -129,6 +132,7 @@ declare class UserInstance extends SerializableClass {
   fetch(callback?: (error: Error | null, items: UserInstance) => any): Promise<UserInstance>;
   friendlyName: string;
   identity: string;
+  isAvailable: boolean;
   sid: string;
   state: UserStateType;
   /**

package/lib/rest/frontlineApi/v1/user.js

@@ -13,6 +13,7 @@ var Q = require('q');  /* jshint ignore:line */
 var _ = require('lodash');  /* jshint ignore:line */
 var util = require('util');  /* jshint ignore:line */
 var Page = require('../../../base/Page');  /* jshint ignore:line */
+var serialize = require('../../../base/serialize');  /* jshint ignore:line */
 var values = require('../../../base/values');  /* jshint ignore:line */
 
 var UserList;
@@ -171,6 +172,8 @@ UserPage.prototype[util.inspect.custom] = function inspect(depth, options) {
  * @property {string} avatar -
  *          The avatar URL which will be shown in Frontline application
  * @property {user.state_type} state - Current state of this user
+ * @property {boolean} isAvailable -
+ *          Whether the User is available for new conversations
  * @property {string} url - An absolute URL for this user.
  *
  * @param {V1} version - Version of the resource
@@ -187,6 +190,7 @@ UserInstance = function UserInstance(version, payload, sid) {
   this.friendlyName = payload.friendly_name; // jshint ignore:line
   this.avatar = payload.avatar; // jshint ignore:line
   this.state = payload.state; // jshint ignore:line
+  this.isAvailable = payload.is_available; // jshint ignore:line
   this.url = payload.url; // jshint ignore:line
 
   // Context
@@ -234,6 +238,8 @@ UserInstance.prototype.fetch = function fetch(callback) {
  * @param {string} [opts.avatar] -
  *          The avatar URL which will be shown in Frontline application
  * @param {user.state_type} [opts.state] - Current state of this user
+ * @param {boolean} [opts.isAvailable] -
+ *          Whether the User is available for new conversations
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed UserInstance
@@ -333,6 +339,8 @@ UserContext.prototype.fetch = function fetch(callback) {
  * @param {string} [opts.avatar] -
  *          The avatar URL which will be shown in Frontline application
  * @param {user.state_type} [opts.state] - Current state of this user
+ * @param {boolean} [opts.isAvailable] -
+ *          Whether the User is available for new conversations
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed UserInstance
@@ -349,7 +357,8 @@ UserContext.prototype.update = function update(opts, callback) {
   var data = values.of({
     'FriendlyName': _.get(opts, 'friendlyName'),
     'Avatar': _.get(opts, 'avatar'),
-    'State': _.get(opts, 'state')
+    'State': _.get(opts, 'state'),
+    'IsAvailable': serialize.bool(_.get(opts, 'isAvailable'))
   });
 
   var promise = this._version.update({uri: this._uri, method: 'POST', data: data});

package/lib/rest/messaging/v1/brandRegistration/brandVetting.d.ts

@@ -24,6 +24,10 @@ type BrandVettingVettingProvider = 'campaign-verify';
 declare function BrandVettingList(version: V1, brandSid: string): BrandVettingListInstance;
 
 interface BrandVettingListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): BrandVettingContext;
   /**
    * create a BrandVettingInstance
    *
@@ -62,6 +66,12 @@ interface BrandVettingListInstance {
    * @param callback - Function to process each record
    */
   each(opts?: BrandVettingListInstanceEachOptions, callback?: (item: BrandVettingInstance, done: (err?: Error) => void) => void): void;
+  /**
+   * Constructs a brand_vetting
+   *
+   * @param brandVettingSid - SID for third-party vetting record
+   */
+  get(brandVettingSid: string): BrandVettingContext;
   /**
    * Retrieve a single target page of BrandVettingInstance records from the API.
    *
@@ -228,6 +238,32 @@ interface BrandVettingSolution {
 }
 
 
+declare class BrandVettingContext {
+  /**
+   * Initialize the BrandVettingContext
+   *
+   * PLEASE NOTE that this class contains beta products that are subject to change.
+   * Use them with caution.
+   *
+   * @param version - Version of the resource
+   * @param brandSid - A2P BrandRegistration Sid
+   * @param brandVettingSid - SID for third-party vetting record
+   */
+  constructor(version: V1, brandSid: string, brandVettingSid: string);
+
+  /**
+   * fetch a BrandVettingInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: BrandVettingInstance) => any): Promise<BrandVettingInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
 declare class BrandVettingInstance extends SerializableClass {
   /**
    * Initialize the BrandVettingContext
@@ -238,14 +274,22 @@ declare class BrandVettingInstance extends SerializableClass {
    * @param version - Version of the resource
    * @param payload - The instance payload
    * @param brandSid - A2P BrandRegistration Sid
+   * @param brandVettingSid - SID for third-party vetting record
    */
-  constructor(version: V1, payload: BrandVettingPayload, brandSid: string);
+  constructor(version: V1, payload: BrandVettingPayload, brandSid: string, brandVettingSid: string);
 
+  private _proxy: BrandVettingContext;
   accountSid: string;
   brandSid: string;
   brandVettingSid: string;
   dateCreated: Date;
   dateUpdated: Date;
+  /**
+   * fetch a BrandVettingInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: BrandVettingInstance) => any): Promise<BrandVettingInstance>;
   /**
    * Provide a user-friendly representation
    */
@@ -283,4 +327,4 @@ declare class BrandVettingPage extends Page<V1, BrandVettingPayload, BrandVettin
   toJSON(): any;
 }
 
-export { BrandVettingInstance, BrandVettingList, BrandVettingListInstance, BrandVettingListInstanceCreateOptions, BrandVettingListInstanceEachOptions, BrandVettingListInstanceOptions, BrandVettingListInstancePageOptions, BrandVettingPage, BrandVettingPayload, BrandVettingResource, BrandVettingSolution, BrandVettingVettingProvider }
+export { BrandVettingContext, BrandVettingInstance, BrandVettingList, BrandVettingListInstance, BrandVettingListInstanceCreateOptions, BrandVettingListInstanceEachOptions, BrandVettingListInstanceOptions, BrandVettingListInstancePageOptions, BrandVettingPage, BrandVettingPayload, BrandVettingResource, BrandVettingSolution, BrandVettingVettingProvider }

package/lib/rest/messaging/v1/brandRegistration/brandVetting.js

@@ -20,6 +20,7 @@ var values = require('../../../../base/values');  /* jshint ignore:line */
 var BrandVettingList;
 var BrandVettingPage;
 var BrandVettingInstance;
+var BrandVettingContext;
 
 /* jshint ignore:start */
 /**
@@ -86,7 +87,12 @@ BrandVettingList = function BrandVettingList(version, brandSid) {
     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
 
     promise = promise.then(function(payload) {
-      deferred.resolve(new BrandVettingInstance(this._version, payload));
+      deferred.resolve(new BrandVettingInstance(
+        this._version,
+        payload,
+        this._solution.brandSid,
+        this._solution.brandVettingSid
+      ));
     }.bind(this));
 
     promise.catch(function(error) {
@@ -349,6 +355,22 @@ BrandVettingList = function BrandVettingList(version, brandSid) {
     return deferred.promise;
   };
 
+  /* jshint ignore:start */
+  /**
+   * Constructs a brand_vetting
+   *
+   * @function get
+   * @memberof Twilio.Messaging.V1.BrandRegistrationContext.BrandVettingList#
+   *
+   * @param {string} brandVettingSid - SID for third-party vetting record
+   *
+   * @returns {Twilio.Messaging.V1.BrandRegistrationContext.BrandVettingContext}
+   */
+  /* jshint ignore:end */
+  BrandVettingListInstance.get = function get(brandVettingSid) {
+    return new BrandVettingContext(this._version, this._solution.brandSid, brandVettingSid);
+  };
+
   /* jshint ignore:start */
   /**
    * Provide a user-friendly representation
@@ -466,10 +488,11 @@ BrandVettingPage.prototype[util.inspect.custom] = function inspect(depth,
  * @param {V1} version - Version of the resource
  * @param {BrandVettingPayload} payload - The instance payload
  * @param {sid} brandSid - A2P BrandRegistration Sid
+ * @param {sid} brandVettingSid - SID for third-party vetting record
  */
 /* jshint ignore:end */
-BrandVettingInstance = function BrandVettingInstance(version, payload, brandSid)
-                                                      {
+BrandVettingInstance = function BrandVettingInstance(version, payload, brandSid,
+                                                      brandVettingSid) {
   this._version = version;
 
   // Marshaled Properties
@@ -486,7 +509,38 @@ BrandVettingInstance = function BrandVettingInstance(version, payload, brandSid)
 
   // Context
   this._context = undefined;
-  this._solution = {brandSid: brandSid, };
+  this._solution = {brandSid: brandSid, brandVettingSid: brandVettingSid || this.brandVettingSid, };
+};
+
+Object.defineProperty(BrandVettingInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new BrandVettingContext(
+          this._version,
+          this._solution.brandSid,
+          this._solution.brandVettingSid
+        );
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * fetch a BrandVettingInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Messaging.V1.BrandRegistrationContext.BrandVettingInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed BrandVettingInstance
+ */
+/* jshint ignore:end */
+BrandVettingInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
 };
 
 /* jshint ignore:start */
@@ -514,8 +568,88 @@ BrandVettingInstance.prototype[util.inspect.custom] = function inspect(depth,
   return util.inspect(this.toJSON(), options);
 };
 
+
+/* jshint ignore:start */
+/**
+ * Initialize the BrandVettingContext
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Messaging.V1.BrandRegistrationContext.BrandVettingContext
+ *
+ * @param {V1} version - Version of the resource
+ * @param {sid} brandSid - A2P BrandRegistration Sid
+ * @param {sid} brandVettingSid - SID for third-party vetting record
+ */
+/* jshint ignore:end */
+BrandVettingContext = function BrandVettingContext(version, brandSid,
+                                                    brandVettingSid) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {brandSid: brandSid, brandVettingSid: brandVettingSid, };
+  this._uri = `/a2p/BrandRegistrations/${brandSid}/Vettings/${brandVettingSid}`;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a BrandVettingInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Messaging.V1.BrandRegistrationContext.BrandVettingContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed BrandVettingInstance
+ */
+/* jshint ignore:end */
+BrandVettingContext.prototype.fetch = function fetch(callback) {
+  var deferred = Q.defer();
+  var promise = this._version.fetch({uri: this._uri, method: 'GET'});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new BrandVettingInstance(
+      this._version,
+      payload,
+      this._solution.brandSid,
+      this._solution.brandVettingSid
+    ));
+  }.bind(this));
+
+  promise.catch(function(error) {
+    deferred.reject(error);
+  });
+
+  if (_.isFunction(callback)) {
+    deferred.promise.nodeify(callback);
+  }
+
+  return deferred.promise;
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Messaging.V1.BrandRegistrationContext.BrandVettingContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+BrandVettingContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+BrandVettingContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
 module.exports = {
   BrandVettingList: BrandVettingList,
   BrandVettingPage: BrandVettingPage,
-  BrandVettingInstance: BrandVettingInstance
+  BrandVettingInstance: BrandVettingInstance,
+  BrandVettingContext: BrandVettingContext
 };

package/lib/rest/verify/v2/service/entity/factor.d.ts

@@ -14,7 +14,7 @@ type FactorFactorStatuses = 'unverified'|'verified';
 
 type FactorFactorTypes = 'push'|'totp';
 
-type FactorNotificationPlatforms = 'apn'|'fcm';
+type FactorNotificationPlatforms = 'apn'|'fcm'|'none';
 
 type FactorTotpAlgorithms = 'sha1'|'sha256'|'sha512';
 
@@ -36,6 +36,7 @@ declare function FactorList(version: V2, serviceSid: string, identity: string):
  * @property authPayload - Optional payload to verify the Factor for the first time
  * @property config.alg - The algorithm used to derive the TOTP codes
  * @property config.codeLength - Number of digits for generated TOTP codes
+ * @property config.notificationPlatform - The transport technology used to generate the Notification Token
  * @property config.notificationToken - For APN, the device token. For FCM, the registration token
  * @property config.sdkVersion - The Verify Push SDK version used to configure the factor
  * @property config.skew - The number of past and future time-steps valid at a given time
@@ -51,6 +52,7 @@ interface FactorInstanceUpdateOptions {
     skew?: number;
     codeLength?: number;
     alg?: FactorTotpAlgorithms;
+    notificationPlatform?: string;
   };
   friendlyName?: string;
 }

package/lib/rest/verify/v2/service/entity/factor.js

@@ -530,6 +530,8 @@ FactorInstance.prototype.fetch = function fetch(callback) {
  *          Number of digits for generated TOTP codes
  * @param {factor.totp_algorithms} [opts.config.alg] -
  *          The algorithm used to derive the TOTP codes
+ * @param {string} [opts.config.notificationPlatform] -
+ *          The transport technology used to generate the Notification Token
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed FactorInstance
@@ -679,6 +681,8 @@ FactorContext.prototype.fetch = function fetch(callback) {
  *          Number of digits for generated TOTP codes
  * @param {factor.totp_algorithms} [opts.config.alg] -
  *          The algorithm used to derive the TOTP codes
+ * @param {string} [opts.config.notificationPlatform] -
+ *          The transport technology used to generate the Notification Token
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed FactorInstance
@@ -700,7 +704,8 @@ FactorContext.prototype.update = function update(opts, callback) {
     'Config.TimeStep': _.get(opts, 'config.timeStep'),
     'Config.Skew': _.get(opts, 'config.skew'),
     'Config.CodeLength': _.get(opts, 'config.codeLength'),
-    'Config.Alg': _.get(opts, 'config.alg')
+    'Config.Alg': _.get(opts, 'config.alg'),
+    'Config.NotificationPlatform': _.get(opts, 'config.notificationPlatform')
   });
 
   var promise = this._version.update({uri: this._uri, method: 'POST', data: data});

package/lib/rest/verify/v2/service/entity/newFactor.d.ts

@@ -14,7 +14,7 @@ type NewFactorFactorStatuses = 'unverified'|'verified';
 
 type NewFactorFactorTypes = 'push'|'totp';
 
-type NewFactorNotificationPlatforms = 'apn'|'fcm';
+type NewFactorNotificationPlatforms = 'apn'|'fcm'|'none';
 
 type NewFactorTotpAlgorithms = 'sha1'|'sha256'|'sha512';
 

package/lib/rest/verify/v2/verificationAttempt.d.ts

@@ -10,7 +10,7 @@ import Response = require('../../../http/response');
 import V2 = require('../V2');
 import { SerializableClass } from '../../../interfaces';
 
-type VerificationAttemptChannels = 'sms'|'call'|'email';
+type VerificationAttemptChannels = 'sms'|'call'|'email'|'whatsapp';
 
 type VerificationAttemptConversionStatus = 'converted'|'unconverted';