twilio 3.84.0 → 3.84.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2022, Twilio, Inc. <help@twilio.com>
+Copyright (C) 2023, Twilio, Inc. <help@twilio.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/lib/rest/conversations/v1/conversation/message.d.ts

@@ -184,6 +184,8 @@ interface MessageListInstance {
  * @property attributes - A string metadata field you can use to store any data you wish.
  * @property author - The channel specific identifier of the message's author.
  * @property body - The content of the message.
+ * @property contentSid - The unique ID of the multi-channel Rich Content template.
+ * @property contentVariables - A structurally valid JSON string that contains values to resolve Rich Content template variables.
  * @property dateCreated - The date that this resource was created.
  * @property dateUpdated - The date that this resource was last updated.
  * @property mediaSid - The Media SID to be attached to the new Message.
@@ -193,6 +195,8 @@ interface MessageListInstanceCreateOptions {
   attributes?: string;
   author?: string;
   body?: string;
+  contentSid?: string;
+  contentVariables?: string;
   dateCreated?: Date;
   dateUpdated?: Date;
   mediaSid?: string;
@@ -270,6 +274,7 @@ interface MessageResource {
   attributes: string;
   author: string;
   body: string;
+  content_sid: string;
   conversation_sid: string;
   date_created: Date;
   date_updated: Date;
@@ -353,6 +358,7 @@ declare class MessageInstance extends SerializableClass {
   attributes: string;
   author: string;
   body: string;
+  contentSid: string;
   conversationSid: string;
   dateCreated: Date;
   dateUpdated: Date;

package/lib/rest/conversations/v1/conversation/message.js

@@ -72,6 +72,10 @@ MessageList = function MessageList(version, conversationSid) {
    *          A string metadata field you can use to store any data you wish.
    * @param {string} [opts.mediaSid] -
    *          The Media SID to be attached to the new Message.
+   * @param {string} [opts.contentSid] -
+   *          The unique ID of the multi-channel Rich Content template.
+   * @param {string} [opts.contentVariables] -
+   *          A structurally valid JSON string that contains values to resolve Rich Content template variables.
    * @param {message.webhook_enabled_type} [opts.xTwilioWebhookEnabled] -
    *          The X-Twilio-Webhook-Enabled HTTP request header
    * @param {function} [callback] - Callback to handle processed record
@@ -93,7 +97,9 @@ MessageList = function MessageList(version, conversationSid) {
       'DateCreated': serialize.iso8601DateTime(_.get(opts, 'dateCreated')),
       'DateUpdated': serialize.iso8601DateTime(_.get(opts, 'dateUpdated')),
       'Attributes': _.get(opts, 'attributes'),
-      'MediaSid': _.get(opts, 'mediaSid')
+      'MediaSid': _.get(opts, 'mediaSid'),
+      'ContentSid': _.get(opts, 'contentSid'),
+      'ContentVariables': _.get(opts, 'contentVariables')
     });
     var headers = values.of({'X-Twilio-Webhook-Enabled': _.get(opts, 'xTwilioWebhookEnabled')});
 
@@ -501,6 +507,8 @@ MessagePage.prototype[util.inspect.custom] = function inspect(depth, options) {
  * @property {object} delivery -
  *          An object that contains the summary of delivery statuses for the message to non-chat participants.
  * @property {string} links - Absolute URL to access the receipts of this message.
+ * @property {string} contentSid -
+ *          The unique ID of the multi-channel Rich Content template.
  *
  * @param {V1} version - Version of the resource
  * @param {MessagePayload} payload - The instance payload
@@ -528,6 +536,7 @@ MessageInstance = function MessageInstance(version, payload, conversationSid,
   this.url = payload.url; // jshint ignore:line
   this.delivery = payload.delivery; // jshint ignore:line
   this.links = payload.links; // jshint ignore:line
+  this.contentSid = payload.content_sid; // jshint ignore:line
 
   // Context
   this._context = undefined;

package/lib/rest/conversations/v1/service/conversation/message.d.ts

@@ -185,6 +185,8 @@ interface MessageListInstance {
  * @property attributes - A string metadata field you can use to store any data you wish.
  * @property author - The channel specific identifier of the message's author.
  * @property body - The content of the message.
+ * @property contentSid - The unique ID of the multi-channel Rich Content template.
+ * @property contentVariables - A structurally valid JSON string that contains values to resolve Rich Content template variables.
  * @property dateCreated - The date that this resource was created.
  * @property dateUpdated - The date that this resource was last updated.
  * @property mediaSid - The Media SID to be attached to the new Message.
@@ -194,6 +196,8 @@ interface MessageListInstanceCreateOptions {
   attributes?: string;
   author?: string;
   body?: string;
+  contentSid?: string;
+  contentVariables?: string;
   dateCreated?: Date;
   dateUpdated?: Date;
   mediaSid?: string;
@@ -272,6 +276,7 @@ interface MessageResource {
   author: string;
   body: string;
   chat_service_sid: string;
+  content_sid: string;
   conversation_sid: string;
   date_created: Date;
   date_updated: Date;
@@ -359,6 +364,7 @@ declare class MessageInstance extends SerializableClass {
   author: string;
   body: string;
   chatServiceSid: string;
+  contentSid: string;
   conversationSid: string;
   dateCreated: Date;
   dateUpdated: Date;

package/lib/rest/conversations/v1/service/conversation/message.js

@@ -75,6 +75,10 @@ MessageList = function MessageList(version, chatServiceSid, conversationSid) {
    *          A string metadata field you can use to store any data you wish.
    * @param {string} [opts.mediaSid] -
    *          The Media SID to be attached to the new Message.
+   * @param {string} [opts.contentSid] -
+   *          The unique ID of the multi-channel Rich Content template.
+   * @param {string} [opts.contentVariables] -
+   *          A structurally valid JSON string that contains values to resolve Rich Content template variables.
    * @param {message.webhook_enabled_type} [opts.xTwilioWebhookEnabled] -
    *          The X-Twilio-Webhook-Enabled HTTP request header
    * @param {function} [callback] - Callback to handle processed record
@@ -96,7 +100,9 @@ MessageList = function MessageList(version, chatServiceSid, conversationSid) {
       'DateCreated': serialize.iso8601DateTime(_.get(opts, 'dateCreated')),
       'DateUpdated': serialize.iso8601DateTime(_.get(opts, 'dateUpdated')),
       'Attributes': _.get(opts, 'attributes'),
-      'MediaSid': _.get(opts, 'mediaSid')
+      'MediaSid': _.get(opts, 'mediaSid'),
+      'ContentSid': _.get(opts, 'contentSid'),
+      'ContentVariables': _.get(opts, 'contentVariables')
     });
     var headers = values.of({'X-Twilio-Webhook-Enabled': _.get(opts, 'xTwilioWebhookEnabled')});
 
@@ -517,6 +523,8 @@ MessagePage.prototype[util.inspect.custom] = function inspect(depth, options) {
  *          An object that contains the summary of delivery statuses for the message to non-chat participants.
  * @property {string} url - An absolute URL for this message.
  * @property {string} links - Absolute URL to access the receipts of this message.
+ * @property {string} contentSid -
+ *          The unique ID of the multi-channel Rich Content template.
  *
  * @param {V1} version - Version of the resource
  * @param {MessagePayload} payload - The instance payload
@@ -547,6 +555,7 @@ MessageInstance = function MessageInstance(version, payload, chatServiceSid,
   this.delivery = payload.delivery; // jshint ignore:line
   this.url = payload.url; // jshint ignore:line
   this.links = payload.links; // jshint ignore:line
+  this.contentSid = payload.content_sid; // jshint ignore:line
 
   // Context
   this._context = undefined;

package/lib/rest/messaging/v1/tollfreeVerification.d.ts

@@ -24,6 +24,53 @@ type TollfreeVerificationStatus = 'PENDING_REVIEW'|'IN_REVIEW'|'TWILIO_APPROVED'
  */
 declare function TollfreeVerificationList(version: V1): TollfreeVerificationListInstance;
 
+/**
+ * Options to pass to update
+ *
+ * @property additionalInformation - Additional information to be provided for verification
+ * @property businessCity - The city of the business or organization using the Tollfree number
+ * @property businessContactEmail - The email address of the contact for the business or organization using the Tollfree number
+ * @property businessContactFirstName - The first name of the contact for the business or organization using the Tollfree number
+ * @property businessContactLastName - The last name of the contact for the business or organization using the Tollfree number
+ * @property businessContactPhone - The phone number of the contact for the business or organization using the Tollfree number
+ * @property businessCountry - The country of the business or organization using the Tollfree number
+ * @property businessName - The name of the business or organization using the Tollfree number
+ * @property businessPostalCode - The postal code of the business or organization using the Tollfree number
+ * @property businessStateProvinceRegion - The state/province/region of the business or organization using the Tollfree number
+ * @property businessStreetAddress - The address of the business or organization using the Tollfree number
+ * @property businessStreetAddress2 - The address of the business or organization using the Tollfree number
+ * @property businessWebsite - The website of the business or organization using the Tollfree number
+ * @property messageVolume - Estimate monthly volume of messages from the Tollfree Number
+ * @property notificationEmail - The email address to receive the notification about the verification result.
+ * @property optInImageUrls - Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL
+ * @property optInType - Describe how a user opts-in to text messages
+ * @property productionMessageSample - An example of message content, i.e. a sample message
+ * @property useCaseCategories - The category of the use case for the Tollfree Number. List as many are applicable.
+ * @property useCaseSummary - Further explaination on how messaging is used by the business or organization
+ */
+interface TollfreeVerificationInstanceUpdateOptions {
+  additionalInformation?: string;
+  businessCity?: string;
+  businessContactEmail?: string;
+  businessContactFirstName?: string;
+  businessContactLastName?: string;
+  businessContactPhone?: string;
+  businessCountry?: string;
+  businessName?: string;
+  businessPostalCode?: string;
+  businessStateProvinceRegion?: string;
+  businessStreetAddress?: string;
+  businessStreetAddress2?: string;
+  businessWebsite?: string;
+  messageVolume?: string;
+  notificationEmail?: string;
+  optInImageUrls?: string | string[];
+  optInType?: TollfreeVerificationOptInType;
+  productionMessageSample?: string;
+  useCaseCategories?: string | string[];
+  useCaseSummary?: string;
+}
+
 interface TollfreeVerificationListInstance {
   /**
    * @param sid - sid of instance
@@ -329,6 +376,19 @@ declare class TollfreeVerificationContext {
    * Provide a user-friendly representation
    */
   toJSON(): any;
+  /**
+   * update a TollfreeVerificationInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: TollfreeVerificationInstance) => any): Promise<TollfreeVerificationInstance>;
+  /**
+   * update a TollfreeVerificationInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: TollfreeVerificationInstanceUpdateOptions, callback?: (error: Error | null, items: TollfreeVerificationInstance) => any): Promise<TollfreeVerificationInstance>;
 }
 
 
@@ -384,6 +444,19 @@ declare class TollfreeVerificationInstance extends SerializableClass {
   toJSON(): any;
   tollfreePhoneNumberSid: string;
   trustProductSid: string;
+  /**
+   * update a TollfreeVerificationInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: TollfreeVerificationInstance) => any): Promise<TollfreeVerificationInstance>;
+  /**
+   * update a TollfreeVerificationInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: TollfreeVerificationInstanceUpdateOptions, callback?: (error: Error | null, items: TollfreeVerificationInstance) => any): Promise<TollfreeVerificationInstance>;
   url: string;
   useCaseCategories: string[];
   useCaseSummary: string;
@@ -415,4 +488,4 @@ declare class TollfreeVerificationPage extends Page<V1, TollfreeVerificationPayl
   toJSON(): any;
 }
 
-export { TollfreeVerificationContext, TollfreeVerificationInstance, TollfreeVerificationList, TollfreeVerificationListInstance, TollfreeVerificationListInstanceCreateOptions, TollfreeVerificationListInstanceEachOptions, TollfreeVerificationListInstanceOptions, TollfreeVerificationListInstancePageOptions, TollfreeVerificationOptInType, TollfreeVerificationPage, TollfreeVerificationPayload, TollfreeVerificationResource, TollfreeVerificationSolution, TollfreeVerificationStatus }
+export { TollfreeVerificationContext, TollfreeVerificationInstance, TollfreeVerificationInstanceUpdateOptions, TollfreeVerificationList, TollfreeVerificationListInstance, TollfreeVerificationListInstanceCreateOptions, TollfreeVerificationListInstanceEachOptions, TollfreeVerificationListInstanceOptions, TollfreeVerificationListInstancePageOptions, TollfreeVerificationOptInType, TollfreeVerificationPage, TollfreeVerificationPayload, TollfreeVerificationResource, TollfreeVerificationSolution, TollfreeVerificationStatus }

package/lib/rest/messaging/v1/tollfreeVerification.js

@@ -696,6 +696,64 @@ TollfreeVerificationInstance.prototype.fetch = function fetch(callback) {
   return this._proxy.fetch(callback);
 };
 
+/* jshint ignore:start */
+/**
+ * update a TollfreeVerificationInstance
+ *
+ * @function update
+ * @memberof Twilio.Messaging.V1.TollfreeVerificationInstance#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.businessName] -
+ *          The name of the business or organization using the Tollfree number
+ * @param {string} [opts.businessWebsite] -
+ *          The website of the business or organization using the Tollfree number
+ * @param {string} [opts.notificationEmail] -
+ *          The email address to receive the notification about the verification result.
+ * @param {string|list} [opts.useCaseCategories] -
+ *          The category of the use case for the Tollfree Number. List as many are applicable.
+ * @param {string} [opts.useCaseSummary] -
+ *          Further explaination on how messaging is used by the business or organization
+ * @param {string} [opts.productionMessageSample] -
+ *          An example of message content, i.e. a sample message
+ * @param {string|list} [opts.optInImageUrls] -
+ *          Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL
+ * @param {tollfree_verification.opt_in_type} [opts.optInType] -
+ *          Describe how a user opts-in to text messages
+ * @param {string} [opts.messageVolume] -
+ *          Estimate monthly volume of messages from the Tollfree Number
+ * @param {string} [opts.businessStreetAddress] -
+ *          The address of the business or organization using the Tollfree number
+ * @param {string} [opts.businessStreetAddress2] -
+ *          The address of the business or organization using the Tollfree number
+ * @param {string} [opts.businessCity] -
+ *          The city of the business or organization using the Tollfree number
+ * @param {string} [opts.businessStateProvinceRegion] -
+ *          The state/province/region of the business or organization using the Tollfree number
+ * @param {string} [opts.businessPostalCode] -
+ *          The postal code of the business or organization using the Tollfree number
+ * @param {string} [opts.businessCountry] -
+ *          The country of the business or organization using the Tollfree number
+ * @param {string} [opts.additionalInformation] -
+ *          Additional information to be provided for verification
+ * @param {string} [opts.businessContactFirstName] -
+ *          The first name of the contact for the business or organization using the Tollfree number
+ * @param {string} [opts.businessContactLastName] -
+ *          The last name of the contact for the business or organization using the Tollfree number
+ * @param {string} [opts.businessContactEmail] -
+ *          The email address of the contact for the business or organization using the Tollfree number
+ * @param {string} [opts.businessContactPhone] -
+ *          The phone number of the contact for the business or organization using the Tollfree number
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed TollfreeVerificationInstance
+ */
+/* jshint ignore:end */
+TollfreeVerificationInstance.prototype.update = function update(opts, callback)
+    {
+  return this._proxy.update(opts, callback);
+};
+
 /* jshint ignore:start */
 /**
  * Provide a user-friendly representation
@@ -775,6 +833,107 @@ TollfreeVerificationContext.prototype.fetch = function fetch(callback) {
   return deferred.promise;
 };
 
+/* jshint ignore:start */
+/**
+ * update a TollfreeVerificationInstance
+ *
+ * @function update
+ * @memberof Twilio.Messaging.V1.TollfreeVerificationContext#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.businessName] -
+ *          The name of the business or organization using the Tollfree number
+ * @param {string} [opts.businessWebsite] -
+ *          The website of the business or organization using the Tollfree number
+ * @param {string} [opts.notificationEmail] -
+ *          The email address to receive the notification about the verification result.
+ * @param {string|list} [opts.useCaseCategories] -
+ *          The category of the use case for the Tollfree Number. List as many are applicable.
+ * @param {string} [opts.useCaseSummary] -
+ *          Further explaination on how messaging is used by the business or organization
+ * @param {string} [opts.productionMessageSample] -
+ *          An example of message content, i.e. a sample message
+ * @param {string|list} [opts.optInImageUrls] -
+ *          Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL
+ * @param {tollfree_verification.opt_in_type} [opts.optInType] -
+ *          Describe how a user opts-in to text messages
+ * @param {string} [opts.messageVolume] -
+ *          Estimate monthly volume of messages from the Tollfree Number
+ * @param {string} [opts.businessStreetAddress] -
+ *          The address of the business or organization using the Tollfree number
+ * @param {string} [opts.businessStreetAddress2] -
+ *          The address of the business or organization using the Tollfree number
+ * @param {string} [opts.businessCity] -
+ *          The city of the business or organization using the Tollfree number
+ * @param {string} [opts.businessStateProvinceRegion] -
+ *          The state/province/region of the business or organization using the Tollfree number
+ * @param {string} [opts.businessPostalCode] -
+ *          The postal code of the business or organization using the Tollfree number
+ * @param {string} [opts.businessCountry] -
+ *          The country of the business or organization using the Tollfree number
+ * @param {string} [opts.additionalInformation] -
+ *          Additional information to be provided for verification
+ * @param {string} [opts.businessContactFirstName] -
+ *          The first name of the contact for the business or organization using the Tollfree number
+ * @param {string} [opts.businessContactLastName] -
+ *          The last name of the contact for the business or organization using the Tollfree number
+ * @param {string} [opts.businessContactEmail] -
+ *          The email address of the contact for the business or organization using the Tollfree number
+ * @param {string} [opts.businessContactPhone] -
+ *          The phone number of the contact for the business or organization using the Tollfree number
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed TollfreeVerificationInstance
+ */
+/* jshint ignore:end */
+TollfreeVerificationContext.prototype.update = function update(opts, callback) {
+  if (_.isFunction(opts)) {
+    callback = opts;
+    opts = {};
+  }
+  opts = opts || {};
+
+  var deferred = Q.defer();
+  var data = values.of({
+    'BusinessName': _.get(opts, 'businessName'),
+    'BusinessWebsite': _.get(opts, 'businessWebsite'),
+    'NotificationEmail': _.get(opts, 'notificationEmail'),
+    'UseCaseCategories': serialize.map(_.get(opts, 'useCaseCategories'), function(e) { return e; }),
+    'UseCaseSummary': _.get(opts, 'useCaseSummary'),
+    'ProductionMessageSample': _.get(opts, 'productionMessageSample'),
+    'OptInImageUrls': serialize.map(_.get(opts, 'optInImageUrls'), function(e) { return e; }),
+    'OptInType': _.get(opts, 'optInType'),
+    'MessageVolume': _.get(opts, 'messageVolume'),
+    'BusinessStreetAddress': _.get(opts, 'businessStreetAddress'),
+    'BusinessStreetAddress2': _.get(opts, 'businessStreetAddress2'),
+    'BusinessCity': _.get(opts, 'businessCity'),
+    'BusinessStateProvinceRegion': _.get(opts, 'businessStateProvinceRegion'),
+    'BusinessPostalCode': _.get(opts, 'businessPostalCode'),
+    'BusinessCountry': _.get(opts, 'businessCountry'),
+    'AdditionalInformation': _.get(opts, 'additionalInformation'),
+    'BusinessContactFirstName': _.get(opts, 'businessContactFirstName'),
+    'BusinessContactLastName': _.get(opts, 'businessContactLastName'),
+    'BusinessContactEmail': _.get(opts, 'businessContactEmail'),
+    'BusinessContactPhone': _.get(opts, 'businessContactPhone')
+  });
+
+  var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new TollfreeVerificationInstance(this._version, payload, this._solution.sid));
+  }.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

package/lib/rest/supersim/v1/ipCommand.d.ts

@@ -152,7 +152,7 @@ interface IpCommandListInstance {
  * @property callbackMethod - The HTTP method we should use to call callback_url
  * @property callbackUrl - The URL we should call after we have sent the IP Command
  * @property devicePort - The device port to which the IP Command will be sent
- * @property payload - The payload to be delivered to the device
+ * @property payload - The data to be delivered to the device. If payload_type has been specified as binary, payload should be encoded using base64 encoding. Twilio will decode the the binary payload before sending to the device.
  * @property payloadType - Indicates how the payload is encoded
  * @property sim - The sid or unique_name of the Super SIM to send the IP Command to
  */

package/lib/rest/supersim/v1/ipCommand.js

@@ -63,7 +63,8 @@ IpCommandList = function IpCommandList(version) {
    * @param {object} opts - Options for request
    * @param {string} opts.sim -
    *          The sid or unique_name of the Super SIM to send the IP Command to
-   * @param {string} opts.payload - The payload to be delivered to the device
+   * @param {string} opts.payload -
+   *          The data to be delivered to the device. If payload_type has been specified as binary, payload should be encoded using base64 encoding. Twilio will decode the the binary payload before sending to the device.
    * @param {number} opts.devicePort -
    *          The device port to which the IP Command will be sent
    * @param {ip_command.payload_type} [opts.payloadType] -

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "twilio",
   "description": "A Twilio helper library",
-  "version": "3.84.0",
+  "version": "3.84.1",
   "author": "API Team <api@twilio.com>",
   "contributors": [
     {
@@ -56,7 +56,7 @@
     "ci": "npm run nyc && npm run nsp",
     "coverage": "nyc npm test",
     "jsdoc": "jsdoc -r lib -d docs",
-    "nsp": "if [ `npm --version | cut -d'.' -f1` -ge \"6\" ]; then npm audit --production; else echo \"npm audit is not available for npm < 6.0\"; fi",
+    "nsp": "if [ `npm --version | cut -d'.' -f1` -ge \"6\" ]; then npm audit --production || true; else echo \"npm audit is not available for npm < 6.0\"; fi",
     "nyc": "if [ `node --version | cut -d'.' -f1 | cut -c2-` -ge \"8\" ]; then npm run coverage; else npm test; fi"
   },
   "files": [