twilio 3.83.3 → 3.84.0

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

@@ -0,0 +1,421 @@
+'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 deserialize = require(
+    '../../../base/deserialize');  /* jshint ignore:line */
+var serialize = require('../../../base/serialize');  /* jshint ignore:line */
+var values = require('../../../base/values');  /* jshint ignore:line */
+
+var DomainConfigList;
+var DomainConfigPage;
+var DomainConfigInstance;
+var DomainConfigContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the DomainConfigList
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Messaging.V1.DomainConfigList
+ *
+ * @param {Twilio.Messaging.V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+DomainConfigList = function DomainConfigList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function domainConfig
+   * @memberof Twilio.Messaging.V1#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Messaging.V1.DomainConfigContext}
+   */
+  /* jshint ignore:end */
+  function DomainConfigListInstance(sid) {
+    return DomainConfigListInstance.get(sid);
+  }
+
+  DomainConfigListInstance._version = version;
+  // Path Solution
+  DomainConfigListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a domain_config
+   *
+   * @function get
+   * @memberof Twilio.Messaging.V1.DomainConfigList#
+   *
+   * @param {string} domainSid -
+   *          Unique string used to identify the domain that this config should be associated with.
+   *
+   * @returns {Twilio.Messaging.V1.DomainConfigContext}
+   */
+  /* jshint ignore:end */
+  DomainConfigListInstance.get = function get(domainSid) {
+    return new DomainConfigContext(this._version, domainSid);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Messaging.V1.DomainConfigList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  DomainConfigListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  DomainConfigListInstance[util.inspect.custom] = function inspect(depth, options)
+      {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return DomainConfigListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the DomainConfigPage
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Messaging.V1.DomainConfigPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {DomainConfigSolution} solution - Path solution
+ *
+ * @returns DomainConfigPage
+ */
+/* jshint ignore:end */
+DomainConfigPage = function DomainConfigPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(DomainConfigPage.prototype, Page.prototype);
+DomainConfigPage.prototype.constructor = DomainConfigPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of DomainConfigInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Messaging.V1.DomainConfigPage#
+ *
+ * @param {DomainConfigPayload} payload - Payload response from the API
+ *
+ * @returns DomainConfigInstance
+ */
+/* jshint ignore:end */
+DomainConfigPage.prototype.getInstance = function getInstance(payload) {
+  return new DomainConfigInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Messaging.V1.DomainConfigPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+DomainConfigPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+DomainConfigPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the DomainConfigContext
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Messaging.V1.DomainConfigInstance
+ *
+ * @property {string} domainSid -
+ *          The unique string that we created to identify the Domain resource.
+ * @property {string} configSid -
+ *          The unique string that we created to identify the Domain config (prefix ZK).
+ * @property {string} messagingServiceSids -
+ *          A list of messagingServiceSids (with prefix MG).
+ * @property {string} fallbackUrl -
+ *          We will redirect requests to urls we are unable to identify to this url.
+ * @property {string} callbackUrl -
+ *          URL to receive click events to your webhook whenever the recipients click on the shortened links.
+ * @property {Date} dateCreated - Date this Domain Config was created.
+ * @property {Date} dateUpdated - Date that this Domain Config was last updated.
+ * @property {string} url - The url
+ *
+ * @param {V1} version - Version of the resource
+ * @param {DomainConfigPayload} payload - The instance payload
+ * @param {sid} domainSid -
+ *          Unique string used to identify the domain that this config should be associated with.
+ */
+/* jshint ignore:end */
+DomainConfigInstance = function DomainConfigInstance(version, payload,
+                                                      domainSid) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.domainSid = payload.domain_sid; // jshint ignore:line
+  this.configSid = payload.config_sid; // jshint ignore:line
+  this.messagingServiceSids = payload.messaging_service_sids; // jshint ignore:line
+  this.fallbackUrl = payload.fallback_url; // jshint ignore:line
+  this.callbackUrl = payload.callback_url; // jshint ignore:line
+  this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
+  this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {domainSid: domainSid || this.domainSid, };
+};
+
+Object.defineProperty(DomainConfigInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new DomainConfigContext(this._version, this._solution.domainSid);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * update a DomainConfigInstance
+ *
+ * @function update
+ * @memberof Twilio.Messaging.V1.DomainConfigInstance#
+ *
+ * @param {object} opts - Options for request
+ * @param {string|list} opts.messagingServiceSids -
+ *          A list of messagingServiceSids (with prefix MG)
+ * @param {string} [opts.fallbackUrl] -
+ *          We will redirect requests to urls we are unable to identify to this url.
+ * @param {string} [opts.callbackUrl] -
+ *          URL to receive click events to your webhook whenever the recipients click on the shortened links
+ * @param {string} [opts.messagingServiceSidsAction] -
+ *          An action type for messaging_service_sids operation (ADD, DELETE, REPLACE)
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed DomainConfigInstance
+ */
+/* jshint ignore:end */
+DomainConfigInstance.prototype.update = function update(opts, callback) {
+  return this._proxy.update(opts, callback);
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a DomainConfigInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Messaging.V1.DomainConfigInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed DomainConfigInstance
+ */
+/* jshint ignore:end */
+DomainConfigInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Messaging.V1.DomainConfigInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+DomainConfigInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+DomainConfigInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the DomainConfigContext
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Messaging.V1.DomainConfigContext
+ *
+ * @param {V1} version - Version of the resource
+ * @param {sid} domainSid -
+ *          Unique string used to identify the domain that this config should be associated with.
+ */
+/* jshint ignore:end */
+DomainConfigContext = function DomainConfigContext(version, domainSid) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {domainSid: domainSid, };
+  this._uri = `/LinkShortening/Domains/${domainSid}/Config`;
+};
+
+/* jshint ignore:start */
+/**
+ * update a DomainConfigInstance
+ *
+ * @function update
+ * @memberof Twilio.Messaging.V1.DomainConfigContext#
+ *
+ * @param {object} opts - Options for request
+ * @param {string|list} opts.messagingServiceSids -
+ *          A list of messagingServiceSids (with prefix MG)
+ * @param {string} [opts.fallbackUrl] -
+ *          We will redirect requests to urls we are unable to identify to this url.
+ * @param {string} [opts.callbackUrl] -
+ *          URL to receive click events to your webhook whenever the recipients click on the shortened links
+ * @param {string} [opts.messagingServiceSidsAction] -
+ *          An action type for messaging_service_sids operation (ADD, DELETE, REPLACE)
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed DomainConfigInstance
+ */
+/* jshint ignore:end */
+DomainConfigContext.prototype.update = function update(opts, callback) {
+  if (_.isUndefined(opts)) {
+    throw new Error('Required parameter "opts" missing.');
+  }
+  if (_.isUndefined(opts['messagingServiceSids'])) {
+    throw new Error('Required parameter "opts[\'messagingServiceSids\']" missing.');
+  }
+
+  var deferred = Q.defer();
+  var data = values.of({
+    'MessagingServiceSids': serialize.map(_.get(opts, 'messagingServiceSids'), function(e) { return e; }),
+    'FallbackUrl': _.get(opts, 'fallbackUrl'),
+    'CallbackUrl': _.get(opts, 'callbackUrl'),
+    'MessagingServiceSidsAction': _.get(opts, 'messagingServiceSidsAction')
+  });
+
+  var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new DomainConfigInstance(this._version, payload, this._solution.domainSid));
+  }.bind(this));
+
+  promise.catch(function(error) {
+    deferred.reject(error);
+  });
+
+  if (_.isFunction(callback)) {
+    deferred.promise.nodeify(callback);
+  }
+
+  return deferred.promise;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a DomainConfigInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Messaging.V1.DomainConfigContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed DomainConfigInstance
+ */
+/* jshint ignore:end */
+DomainConfigContext.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 DomainConfigInstance(this._version, payload, this._solution.domainSid));
+  }.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.DomainConfigContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+DomainConfigContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+DomainConfigContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  DomainConfigList: DomainConfigList,
+  DomainConfigPage: DomainConfigPage,
+  DomainConfigInstance: DomainConfigInstance,
+  DomainConfigContext: DomainConfigContext
+};

package/lib/rest/messaging/v1/service/usAppToPerson.d.ts

@@ -165,7 +165,7 @@ interface UsAppToPersonListInstanceCreateOptions {
   hasEmbeddedPhone: boolean;
   helpKeywords?: string | string[];
   helpMessage?: string;
-  messageFlow?: string;
+  messageFlow: string;
   messageSamples: string | string[];
   optInKeywords?: string | string[];
   optInMessage?: string;

package/lib/rest/messaging/v1/service/usAppToPerson.js

@@ -67,13 +67,13 @@ UsAppToPersonList = function UsAppToPersonList(version, messagingServiceSid) {
    * @param {string} opts.brandRegistrationSid - A2P Brand Registration SID
    * @param {string} opts.description -
    *          A short description of what this SMS campaign does
+   * @param {string} opts.messageFlow - The message flow of the campaign
    * @param {string|list} opts.messageSamples - Message samples
    * @param {string} opts.usAppToPersonUsecase - A2P Campaign Use Case.
    * @param {boolean} opts.hasEmbeddedLinks -
    *          Indicates that this SMS campaign will send messages that contain links
    * @param {boolean} opts.hasEmbeddedPhone -
    *          Indicates that this SMS campaign will send messages that contain phone numbers
-   * @param {string} [opts.messageFlow] - The message flow of the campaign
    * @param {string} [opts.optInMessage] - Opt In Message
    * @param {string} [opts.optOutMessage] - Opt Out Message
    * @param {string} [opts.helpMessage] - Help Message
@@ -95,6 +95,9 @@ UsAppToPersonList = function UsAppToPersonList(version, messagingServiceSid) {
     if (_.isUndefined(opts['description'])) {
       throw new Error('Required parameter "opts[\'description\']" missing.');
     }
+    if (_.isUndefined(opts['messageFlow'])) {
+      throw new Error('Required parameter "opts[\'messageFlow\']" missing.');
+    }
     if (_.isUndefined(opts['messageSamples'])) {
       throw new Error('Required parameter "opts[\'messageSamples\']" missing.');
     }
@@ -112,11 +115,11 @@ UsAppToPersonList = function UsAppToPersonList(version, messagingServiceSid) {
     var data = values.of({
       'BrandRegistrationSid': _.get(opts, 'brandRegistrationSid'),
       'Description': _.get(opts, 'description'),
+      'MessageFlow': _.get(opts, 'messageFlow'),
       'MessageSamples': serialize.map(_.get(opts, 'messageSamples'), function(e) { return e; }),
       'UsAppToPersonUsecase': _.get(opts, 'usAppToPersonUsecase'),
       'HasEmbeddedLinks': serialize.bool(_.get(opts, 'hasEmbeddedLinks')),
       'HasEmbeddedPhone': serialize.bool(_.get(opts, 'hasEmbeddedPhone')),
-      'MessageFlow': _.get(opts, 'messageFlow'),
       'OptInMessage': _.get(opts, 'optInMessage'),
       'OptOutMessage': _.get(opts, 'optOutMessage'),
       'HelpMessage': _.get(opts, 'helpMessage'),

package/lib/rest/microvisor/v1/device.d.ts

@@ -212,6 +212,7 @@ interface DeviceResource {
   app: object;
   date_created: Date;
   date_updated: Date;
+  links: string;
   logging: object;
   sid: string;
   unique_name: string;
@@ -286,6 +287,7 @@ declare class DeviceInstance extends SerializableClass {
    * @param callback - Callback to handle processed record
    */
   fetch(callback?: (error: Error | null, items: DeviceInstance) => any): Promise<DeviceInstance>;
+  links: string;
   logging: any;
   sid: string;
   /**

package/lib/rest/microvisor/v1/device.js

@@ -426,6 +426,7 @@ DevicePage.prototype[util.inspect.custom] = function inspect(depth, options) {
  * @property {Date} dateCreated - The date that this Device was created.
  * @property {Date} dateUpdated - The date that this Device was last updated.
  * @property {string} url - The URL of this resource.
+ * @property {string} links - The absolute URLs of related resources
  *
  * @param {V1} version - Version of the resource
  * @param {DevicePayload} payload - The instance payload
@@ -444,6 +445,7 @@ DeviceInstance = function DeviceInstance(version, payload, sid) {
   this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
   this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
   this.url = payload.url; // jshint ignore:line
+  this.links = payload.links; // jshint ignore:line
 
   // Context
   this._context = undefined;

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

@@ -7,6 +7,8 @@
 
 import Oauth = require('../Oauth');
 import Version = require('../../base/Version');
+import { DeviceCodeList } from './v1/deviceCode';
+import { DeviceCodeListInstance } from './v1/deviceCode';
 import { OauthList } from './v1/oauth';
 import { OauthListInstance } from './v1/oauth';
 import { OpenidDiscoveryList } from './v1/openidDiscovery';
@@ -25,6 +27,7 @@ declare class V1 extends Version {
    */
   constructor(domain: Oauth);
 
+  readonly deviceCode: DeviceCodeListInstance;
   readonly oauth: OauthListInstance;
   readonly openidDiscovery: OpenidDiscoveryListInstance;
   readonly token: TokenListInstance;

package/lib/rest/oauth/V1.js

@@ -10,6 +10,7 @@
 /* jshint ignore:end */
 
 var _ = require('lodash');  /* jshint ignore:line */
+var DeviceCodeList = require('./v1/deviceCode').DeviceCodeList;
 var OauthList = require('./v1/oauth').OauthList;
 var OpenidDiscoveryList = require('./v1/openidDiscovery').OpenidDiscoveryList;
 var TokenList = require('./v1/token').TokenList;
@@ -24,6 +25,7 @@ var Version = require('../../base/Version');  /* jshint ignore:line */
  * @constructor Twilio.Oauth.V1
  *
  * @property {Twilio.Oauth.V1.OauthList} oauth - oauth resource
+ * @property {Twilio.Oauth.V1.DeviceCodeList} deviceCode - deviceCode resource
  * @property {Twilio.Oauth.V1.OpenidDiscoveryList} openidDiscovery -
  *          openidDiscovery resource
  * @property {Twilio.Oauth.V1.TokenList} token - token resource
@@ -37,6 +39,7 @@ function V1(domain) {
 
   // Resources
   this._oauth = undefined;
+  this._deviceCode = undefined;
   this._openidDiscovery = undefined;
   this._token = undefined;
   this._userInfo = undefined;
@@ -53,6 +56,14 @@ Object.defineProperty(V1.prototype,
     }
 });
 
+Object.defineProperty(V1.prototype,
+  'deviceCode', {
+    get: function() {
+      this._deviceCode = this._deviceCode || new DeviceCodeList(this);
+      return this._deviceCode;
+    }
+});
+
 Object.defineProperty(V1.prototype,
   'openidDiscovery', {
     get: function() {

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

@@ -0,0 +1,107 @@
+/**
+ * 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 DeviceCodeList
+ *
+ * @param version - Version of the resource
+ */
+declare function DeviceCodeList(version: V1): DeviceCodeListInstance;
+
+interface DeviceCodeListInstance {
+  /**
+   * create a DeviceCodeInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  create(opts: DeviceCodeListInstanceCreateOptions, callback?: (error: Error | null, item: DeviceCodeInstance) => any): Promise<DeviceCodeInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to create
+ *
+ * @property audiences - An array of intended audiences
+ * @property clientSid - A string that uniquely identifies this oauth app
+ * @property scopes - An Array of scopes
+ */
+interface DeviceCodeListInstanceCreateOptions {
+  audiences?: string | string[];
+  clientSid: string;
+  scopes: string | string[];
+}
+
+interface DeviceCodePayload extends DeviceCodeResource, Page.TwilioResponsePayload {
+}
+
+interface DeviceCodeResource {
+  device_code: string;
+  expires_in: number;
+  interval: number;
+  user_code: string;
+  verification_uri: string;
+  verification_uri_complete: string;
+}
+
+interface DeviceCodeSolution {
+}
+
+
+declare class DeviceCodeInstance extends SerializableClass {
+  /**
+   * Initialize the DeviceCodeContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   */
+  constructor(version: V1, payload: DeviceCodePayload);
+
+  deviceCode: string;
+  expiresIn: number;
+  interval: number;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  userCode: string;
+  verificationUri: string;
+  verificationUriComplete: string;
+}
+
+
+declare class DeviceCodePage extends Page<V1, DeviceCodePayload, DeviceCodeResource, DeviceCodeInstance> {
+  /**
+   * Initialize the DeviceCodePage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V1, response: Response<string>, solution: DeviceCodeSolution);
+
+  /**
+   * Build an instance of DeviceCodeInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: DeviceCodePayload): DeviceCodeInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { DeviceCodeInstance, DeviceCodeList, DeviceCodeListInstance, DeviceCodeListInstanceCreateOptions, DeviceCodePage, DeviceCodePayload, DeviceCodeResource, DeviceCodeSolution }