twilio 3.82.2 → 3.83.1

package/lib/rest/api/v2010/account/conference/participant.d.ts

@@ -32,10 +32,10 @@ declare function ParticipantList(version: V2010, accountSid: string, conferenceS
  * @property endConferenceOnExit - Whether to end the conference when the participant leaves
  * @property hold - Whether the participant should be on hold
  * @property holdMethod - The HTTP method we should use to call hold_url
- * @property holdUrl - The URL we call using the `hold_method` for  music that plays when the participant is on hold
+ * @property holdUrl - The URL we call using the `hold_method` for music that plays when the participant is on hold
  * @property muted - Whether the participant should be muted
  * @property waitMethod - The HTTP method we should use to call `wait_url`
- * @property waitUrl - URL that hosts pre-conference hold music
+ * @property waitUrl - The URL we call using the `wait_method` for the music to play while participants are waiting for the conference to start
  */
 interface ParticipantInstanceUpdateOptions {
   announceMethod?: string;

package/lib/rest/api/v2010/account/conference/participant.js

@@ -723,14 +723,15 @@ ParticipantInstance.prototype.fetch = function fetch(callback) {
  * @param {boolean} [opts.muted] - Whether the participant should be muted
  * @param {boolean} [opts.hold] - Whether the participant should be on hold
  * @param {string} [opts.holdUrl] -
- *          The URL we call using the `hold_method` for  music that plays when the participant is on hold
+ *          The URL we call using the `hold_method` for music that plays when the participant is on hold
  * @param {string} [opts.holdMethod] -
  *          The HTTP method we should use to call hold_url
  * @param {string} [opts.announceUrl] -
  *          The URL we call using the `announce_method` for an announcement to the participant
  * @param {string} [opts.announceMethod] -
  *          The HTTP method we should use to call announce_url
- * @param {string} [opts.waitUrl] - URL that hosts pre-conference hold music
+ * @param {string} [opts.waitUrl] -
+ *          The URL we call using the `wait_method` for the music to play while participants are waiting for the conference to start
  * @param {string} [opts.waitMethod] -
  *          The HTTP method we should use to call `wait_url`
  * @param {boolean} [opts.beepOnExit] -
@@ -863,14 +864,15 @@ ParticipantContext.prototype.fetch = function fetch(callback) {
  * @param {boolean} [opts.muted] - Whether the participant should be muted
  * @param {boolean} [opts.hold] - Whether the participant should be on hold
  * @param {string} [opts.holdUrl] -
- *          The URL we call using the `hold_method` for  music that plays when the participant is on hold
+ *          The URL we call using the `hold_method` for music that plays when the participant is on hold
  * @param {string} [opts.holdMethod] -
  *          The HTTP method we should use to call hold_url
  * @param {string} [opts.announceUrl] -
  *          The URL we call using the `announce_method` for an announcement to the participant
  * @param {string} [opts.announceMethod] -
  *          The HTTP method we should use to call announce_url
- * @param {string} [opts.waitUrl] - URL that hosts pre-conference hold music
+ * @param {string} [opts.waitUrl] -
+ *          The URL we call using the `wait_method` for the music to play while participants are waiting for the conference to start
  * @param {string} [opts.waitMethod] -
  *          The HTTP method we should use to call `wait_url`
  * @param {boolean} [opts.beepOnExit] -

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

@@ -175,6 +175,8 @@ interface MessageListInstance {
  * @property attempt - Total numer of attempts made , this inclusive to send out the message
  * @property body - The text of the message you want to send. Can be up to 1,600 characters in length.
  * @property contentRetention - Determines if the message content can be stored or redacted based on privacy settings
+ * @property contentSid - The SID of the preconfigured Content object you want to associate with the message.
+ * @property contentVariables - Key-value pairs of variable names to substitution values, used alongside a content_sid.
  * @property forceDelivery - Reserved
  * @property from - The phone number that initiated the message
  * @property maxPrice - The total maximum price up to 4 decimal places in US dollars acceptable for the message to be delivered.
@@ -185,6 +187,7 @@ interface MessageListInstance {
  * @property scheduleType - Pass the value `fixed` to schedule a message at a fixed time.
  * @property sendAsMms - If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media.
  * @property sendAt - The time that Twilio will send the message. Must be in ISO 8601 format.
+ * @property shortenUrls - Sets whether to shorten and track links included in the body of this message.
  * @property smartEncoded - Whether to detect Unicode characters that have a similar GSM-7 character and replace them
  * @property statusCallback - The URL we should call to send status information to your application
  * @property to - The destination phone number
@@ -196,6 +199,8 @@ interface MessageListInstanceCreateOptions {
   attempt?: number;
   body?: string;
   contentRetention?: MessageContentRetention;
+  contentSid?: string;
+  contentVariables?: string;
   forceDelivery?: boolean;
   from?: string;
   maxPrice?: number;
@@ -206,6 +211,7 @@ interface MessageListInstanceCreateOptions {
   scheduleType?: MessageScheduleType;
   sendAsMms?: boolean;
   sendAt?: Date;
+  shortenUrls?: boolean;
   smartEncoded?: boolean;
   statusCallback?: string;
   to: string;

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

@@ -83,12 +83,18 @@ MessageList = function MessageList(version, accountSid) {
    *          Whether to detect Unicode characters that have a similar GSM-7 character and replace them
    * @param {string|list} [opts.persistentAction] -
    *          Rich actions for Channels Messages.
+   * @param {boolean} [opts.shortenUrls] -
+   *          Sets whether to shorten and track links included in the body of this message.
    * @param {message.schedule_type} [opts.scheduleType] -
    *          Pass the value `fixed` to schedule a message at a fixed time.
    * @param {Date} [opts.sendAt] -
    *          The time that Twilio will send the message. Must be in ISO 8601 format.
    * @param {boolean} [opts.sendAsMms] -
    *          If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media.
+   * @param {string} [opts.contentSid] -
+   *          The SID of the preconfigured Content object you want to associate with the message.
+   * @param {string} [opts.contentVariables] -
+   *          Key-value pairs of variable names to substitution values, used alongside a content_sid.
    * @param {string} [opts.from] - The phone number that initiated the message
    * @param {string} [opts.messagingServiceSid] -
    *          The SID of the Messaging Service you want to associate with the message.
@@ -127,9 +133,12 @@ MessageList = function MessageList(version, accountSid) {
       'AddressRetention': _.get(opts, 'addressRetention'),
       'SmartEncoded': serialize.bool(_.get(opts, 'smartEncoded')),
       'PersistentAction': serialize.map(_.get(opts, 'persistentAction'), function(e) { return e; }),
+      'ShortenUrls': serialize.bool(_.get(opts, 'shortenUrls')),
       'ScheduleType': _.get(opts, 'scheduleType'),
       'SendAt': serialize.iso8601DateTime(_.get(opts, 'sendAt')),
-      'SendAsMms': serialize.bool(_.get(opts, 'sendAsMms'))
+      'SendAsMms': serialize.bool(_.get(opts, 'sendAsMms')),
+      'ContentSid': _.get(opts, 'contentSid'),
+      'ContentVariables': _.get(opts, 'contentVariables')
     });
 
     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});

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

@@ -0,0 +1,34 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Oauth = require('../Oauth');
+import Version = require('../../base/Version');
+import { OauthList } from './v1/oauth';
+import { OauthListInstance } from './v1/oauth';
+import { OpenidDiscoveryList } from './v1/openidDiscovery';
+import { OpenidDiscoveryListInstance } from './v1/openidDiscovery';
+import { TokenList } from './v1/token';
+import { TokenListInstance } from './v1/token';
+import { UserInfoList } from './v1/userInfo';
+import { UserInfoListInstance } from './v1/userInfo';
+
+
+declare class V1 extends Version {
+  /**
+   * Initialize the V1 version of Oauth
+   *
+   * @param domain - The twilio domain
+   */
+  constructor(domain: Oauth);
+
+  readonly oauth: OauthListInstance;
+  readonly openidDiscovery: OpenidDiscoveryListInstance;
+  readonly token: TokenListInstance;
+  readonly userInfo: UserInfoListInstance;
+}
+
+export = V1;

package/lib/rest/oauth/V1.js

@@ -0,0 +1,80 @@
+'use strict';
+
+/* jshint ignore:start */
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+/* jshint ignore:end */
+
+var _ = require('lodash');  /* jshint ignore:line */
+var OauthList = require('./v1/oauth').OauthList;
+var OpenidDiscoveryList = require('./v1/openidDiscovery').OpenidDiscoveryList;
+var TokenList = require('./v1/token').TokenList;
+var UserInfoList = require('./v1/userInfo').UserInfoList;
+var Version = require('../../base/Version');  /* jshint ignore:line */
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the V1 version of Oauth
+ *
+ * @constructor Twilio.Oauth.V1
+ *
+ * @property {Twilio.Oauth.V1.OauthList} oauth - oauth resource
+ * @property {Twilio.Oauth.V1.OpenidDiscoveryList} openidDiscovery -
+ *          openidDiscovery resource
+ * @property {Twilio.Oauth.V1.TokenList} token - token resource
+ * @property {Twilio.Oauth.V1.UserInfoList} userInfo - userInfo resource
+ *
+ * @param {Twilio.Oauth} domain - The twilio domain
+ */
+/* jshint ignore:end */
+function V1(domain) {
+  Version.prototype.constructor.call(this, domain, 'v1');
+
+  // Resources
+  this._oauth = undefined;
+  this._openidDiscovery = undefined;
+  this._token = undefined;
+  this._userInfo = undefined;
+}
+
+_.extend(V1.prototype, Version.prototype);
+V1.prototype.constructor = V1;
+
+Object.defineProperty(V1.prototype,
+  'oauth', {
+    get: function() {
+      this._oauth = this._oauth || new OauthList(this);
+      return this._oauth;
+    }
+});
+
+Object.defineProperty(V1.prototype,
+  'openidDiscovery', {
+    get: function() {
+      this._openidDiscovery = this._openidDiscovery || new OpenidDiscoveryList(this);
+      return this._openidDiscovery;
+    }
+});
+
+Object.defineProperty(V1.prototype,
+  'token', {
+    get: function() {
+      this._token = this._token || new TokenList(this);
+      return this._token;
+    }
+});
+
+Object.defineProperty(V1.prototype,
+  'userInfo', {
+    get: function() {
+      this._userInfo = this._userInfo || new UserInfoList(this);
+      return this._userInfo;
+    }
+});
+
+module.exports = V1;

package/lib/rest/oauth/v1/oauth.d.ts

@@ -0,0 +1,115 @@
+/**
+ * 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';
+
+/**
+ * Initialize the OauthList
+ *
+ * @param version - Version of the resource
+ */
+declare function OauthList(version: V1): OauthListInstance;
+
+interface OauthListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): OauthContext;
+  /**
+   * Constructs a oauth
+   */
+  get(): OauthContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+interface OauthPayload extends OauthResource, Page.TwilioResponsePayload {
+}
+
+interface OauthResource {
+  keys: object;
+  url: string;
+}
+
+interface OauthSolution {
+}
+
+
+declare class OauthContext {
+  /**
+   * Initialize the OauthContext
+   *
+   * @param version - Version of the resource
+   */
+  constructor(version: V1);
+
+  /**
+   * fetch a OauthInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: OauthInstance) => any): Promise<OauthInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class OauthInstance extends SerializableClass {
+  /**
+   * Initialize the OauthContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   */
+  constructor(version: V1, payload: OauthPayload);
+
+  private _proxy: OauthContext;
+  /**
+   * fetch a OauthInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: OauthInstance) => any): Promise<OauthInstance>;
+  keys: any;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  url: string;
+}
+
+
+declare class OauthPage extends Page<V1, OauthPayload, OauthResource, OauthInstance> {
+  /**
+   * Initialize the OauthPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V1, response: Response<string>, solution: OauthSolution);
+
+  /**
+   * Build an instance of OauthInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: OauthPayload): OauthInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { OauthContext, OauthInstance, OauthList, OauthListInstance, OauthPage, OauthPayload, OauthResource, OauthSolution }

package/lib/rest/oauth/v1/oauth.js

@@ -0,0 +1,299 @@
+'use strict';
+
+/* jshint ignore:start */
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+/* jshint ignore:end */
+
+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 values = require('../../../base/values');  /* jshint ignore:line */
+
+var OauthList;
+var OauthPage;
+var OauthInstance;
+var OauthContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the OauthList
+ *
+ * @constructor Twilio.Oauth.V1.OauthList
+ *
+ * @param {Twilio.Oauth.V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+OauthList = function OauthList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function oauth
+   * @memberof Twilio.Oauth.V1#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Oauth.V1.OauthContext}
+   */
+  /* jshint ignore:end */
+  function OauthListInstance(sid) {
+    return OauthListInstance.get(sid);
+  }
+
+  OauthListInstance._version = version;
+  // Path Solution
+  OauthListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a oauth
+   *
+   * @function get
+   * @memberof Twilio.Oauth.V1.OauthList#
+   *
+   * @returns {Twilio.Oauth.V1.OauthContext}
+   */
+  /* jshint ignore:end */
+  OauthListInstance.get = function get() {
+    return new OauthContext(this._version);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Oauth.V1.OauthList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  OauthListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  OauthListInstance[util.inspect.custom] = function inspect(depth, options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return OauthListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the OauthPage
+ *
+ * @constructor Twilio.Oauth.V1.OauthPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {OauthSolution} solution - Path solution
+ *
+ * @returns OauthPage
+ */
+/* jshint ignore:end */
+OauthPage = function OauthPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(OauthPage.prototype, Page.prototype);
+OauthPage.prototype.constructor = OauthPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of OauthInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Oauth.V1.OauthPage#
+ *
+ * @param {OauthPayload} payload - Payload response from the API
+ *
+ * @returns OauthInstance
+ */
+/* jshint ignore:end */
+OauthPage.prototype.getInstance = function getInstance(payload) {
+  return new OauthInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Oauth.V1.OauthPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+OauthPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+OauthPage.prototype[util.inspect.custom] = function inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the OauthContext
+ *
+ * @constructor Twilio.Oauth.V1.OauthInstance
+ *
+ * @property {object} keys - A collection of certificates
+ * @property {string} url - The url
+ *
+ * @param {V1} version - Version of the resource
+ * @param {OauthPayload} payload - The instance payload
+ */
+/* jshint ignore:end */
+OauthInstance = function OauthInstance(version, payload) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.keys = payload.keys; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {};
+};
+
+Object.defineProperty(OauthInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new OauthContext(this._version);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * fetch a OauthInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Oauth.V1.OauthInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed OauthInstance
+ */
+/* jshint ignore:end */
+OauthInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Oauth.V1.OauthInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+OauthInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+OauthInstance.prototype[util.inspect.custom] = function inspect(depth, options)
+    {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the OauthContext
+ *
+ * @constructor Twilio.Oauth.V1.OauthContext
+ *
+ * @param {V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+OauthContext = function OauthContext(version) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {};
+  this._uri = `/certs`;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a OauthInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Oauth.V1.OauthContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed OauthInstance
+ */
+/* jshint ignore:end */
+OauthContext.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 OauthInstance(this._version, payload));
+  }.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.Oauth.V1.OauthContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+OauthContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+OauthContext.prototype[util.inspect.custom] = function inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  OauthList: OauthList,
+  OauthPage: OauthPage,
+  OauthInstance: OauthInstance,
+  OauthContext: OauthContext
+};