twilio 3.77.2 → 3.79.0

package/lib/rest/insights/v1/call.js

@@ -12,6 +12,7 @@
 var Q = require('q');  /* jshint ignore:line */
 var _ = require('lodash');  /* jshint ignore:line */
 var util = require('util');  /* jshint ignore:line */
+var AnnotationList = require('./call/annotation').AnnotationList;
 var CallSummaryList = require('./call/summary').CallSummaryList;
 var EventList = require('./call/event').EventList;
 var MetricList = require('./call/metric').MetricList;
@@ -27,10 +28,6 @@ var CallContext;
 /**
  * Initialize the CallList
  *
- * PLEASE NOTE that this class contains preview products that are subject to
- * change. Use them with caution. If you currently do not have developer preview
- * access, please contact help@twilio.com.
- *
  * @constructor Twilio.Insights.V1.CallList
  *
  * @param {Twilio.Insights.V1} version - Version of the resource
@@ -96,10 +93,6 @@ CallList = function CallList(version) {
 /**
  * Initialize the CallPage
  *
- * PLEASE NOTE that this class contains preview products that are subject to
- * change. Use them with caution. If you currently do not have developer preview
- * access, please contact help@twilio.com.
- *
  * @constructor Twilio.Insights.V1.CallPage
  *
  * @param {V1} version - Version of the resource
@@ -164,10 +157,6 @@ CallPage.prototype[util.inspect.custom] = function inspect(depth, options) {
 /**
  * Initialize the CallContext
  *
- * PLEASE NOTE that this class contains preview products that are subject to
- * change. Use them with caution. If you currently do not have developer preview
- * access, please contact help@twilio.com.
- *
  * @constructor Twilio.Insights.V1.CallInstance
  *
  * @property {string} sid - The sid
@@ -261,6 +250,20 @@ CallInstance.prototype.summary = function summary() {
   return this._proxy.summary;
 };
 
+/* jshint ignore:start */
+/**
+ * Access the annotation
+ *
+ * @function annotation
+ * @memberof Twilio.Insights.V1.CallInstance#
+ *
+ * @returns {Twilio.Insights.V1.CallContext.AnnotationList}
+ */
+/* jshint ignore:end */
+CallInstance.prototype.annotation = function annotation() {
+  return this._proxy.annotation;
+};
+
 /* jshint ignore:start */
 /**
  * Provide a user-friendly representation
@@ -290,16 +293,14 @@ CallInstance.prototype[util.inspect.custom] = function inspect(depth, options) {
 /**
  * Initialize the CallContext
  *
- * PLEASE NOTE that this class contains preview products that are subject to
- * change. Use them with caution. If you currently do not have developer preview
- * access, please contact help@twilio.com.
- *
  * @constructor Twilio.Insights.V1.CallContext
  *
  * @property {Twilio.Insights.V1.CallContext.EventList} events - events resource
  * @property {Twilio.Insights.V1.CallContext.MetricList} metrics - metrics resource
  * @property {Twilio.Insights.V1.CallContext.CallSummaryList} summary -
  *          summary resource
+ * @property {Twilio.Insights.V1.CallContext.AnnotationList} annotation -
+ *          annotation resource
  *
  * @param {V1} version - Version of the resource
  * @param {sid} sid - The sid
@@ -316,6 +317,7 @@ CallContext = function CallContext(version, sid) {
   this._events = undefined;
   this._metrics = undefined;
   this._summary = undefined;
+  this._annotation = undefined;
 };
 
 /* jshint ignore:start */
@@ -379,6 +381,16 @@ Object.defineProperty(CallContext.prototype,
     }
 });
 
+Object.defineProperty(CallContext.prototype,
+  'annotation', {
+    get: function() {
+      if (!this._annotation) {
+        this._annotation = new AnnotationList(this._version, this._solution.sid);
+      }
+      return this._annotation;
+    }
+});
+
 /* jshint ignore:start */
 /**
  * Provide a user-friendly representation

package/lib/rest/lookups/V2.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Lookups = require('../Lookups');
+import Version = require('../../base/Version');
+import { PhoneNumberList } from './v2/phoneNumber';
+import { PhoneNumberListInstance } from './v2/phoneNumber';
+
+
+declare class V2 extends Version {
+  /**
+   * Initialize the V2 version of Lookups
+   *
+   * @param domain - The twilio domain
+   */
+  constructor(domain: Lookups);
+
+  readonly phoneNumbers: PhoneNumberListInstance;
+}
+
+export = V2;

package/lib/rest/lookups/V2.js

@@ -0,0 +1,47 @@
+'use strict';
+
+/* jshint ignore:start */
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+/* jshint ignore:end */
+
+var _ = require('lodash');  /* jshint ignore:line */
+var PhoneNumberList = require('./v2/phoneNumber').PhoneNumberList;
+var Version = require('../../base/Version');  /* jshint ignore:line */
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the V2 version of Lookups
+ *
+ * @constructor Twilio.Lookups.V2
+ *
+ * @property {Twilio.Lookups.V2.PhoneNumberList} phoneNumbers -
+ *          phoneNumbers resource
+ *
+ * @param {Twilio.Lookups} domain - The twilio domain
+ */
+/* jshint ignore:end */
+function V2(domain) {
+  Version.prototype.constructor.call(this, domain, 'v2');
+
+  // Resources
+  this._phoneNumbers = undefined;
+}
+
+_.extend(V2.prototype, Version.prototype);
+V2.prototype.constructor = V2;
+
+Object.defineProperty(V2.prototype,
+  'phoneNumbers', {
+    get: function() {
+      this._phoneNumbers = this._phoneNumbers || new PhoneNumberList(this);
+      return this._phoneNumbers;
+    }
+});
+
+module.exports = V2;

package/lib/rest/lookups/v2/phoneNumber.d.ts

@@ -0,0 +1,180 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../base/Page');
+import Response = require('../../../http/response');
+import V2 = require('../V2');
+import { SerializableClass } from '../../../interfaces';
+
+type PhoneNumberType = 'landline'|'mobile'|'voip';
+
+type PhoneNumberValidationError = 'TOO_SHORT'|'TOO_LONG'|'INVALID_BUT_POSSIBLE'|'INVALID_COUNTRY_CODE'|'INVALID_LENGTH'|'NOT_A_NUMBER';
+
+/**
+ * Initialize the PhoneNumberList
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @param version - Version of the resource
+ */
+declare function PhoneNumberList(version: V2): PhoneNumberListInstance;
+
+/**
+ * Options to pass to fetch
+ *
+ * @property countryCode - Country code for national phone number lookups
+ * @property fields - Fields to return
+ */
+interface PhoneNumberInstanceFetchOptions {
+  countryCode?: string;
+  fields?: string;
+}
+
+interface PhoneNumberListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): PhoneNumberContext;
+  /**
+   * Constructs a phone_number
+   *
+   * @param phoneNumber - Phone number to lookup
+   */
+  get(phoneNumber: string): PhoneNumberContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+interface PhoneNumberPayload extends PhoneNumberResource, Page.TwilioResponsePayload {
+}
+
+interface PhoneNumberResource {
+  call_forwarding: object;
+  caller_name: object;
+  calling_country_code: string;
+  country_code: string;
+  line_type_intelligence: object;
+  live_activity: object;
+  national_format: string;
+  phone_number: string;
+  sim_swap: object;
+  url: string;
+  valid: boolean;
+  validation_errors: PhoneNumberValidationError[];
+}
+
+interface PhoneNumberSolution {
+}
+
+
+declare class PhoneNumberContext {
+  /**
+   * Initialize the PhoneNumberContext
+   *
+   * PLEASE NOTE that this class contains beta products that are subject to change.
+   * Use them with caution.
+   *
+   * @param version - Version of the resource
+   * @param phoneNumber - Phone number to lookup
+   */
+  constructor(version: V2, phoneNumber: string);
+
+  /**
+   * fetch a PhoneNumberInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: PhoneNumberInstance) => any): Promise<PhoneNumberInstance>;
+  /**
+   * fetch a PhoneNumberInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  fetch(opts?: PhoneNumberInstanceFetchOptions, callback?: (error: Error | null, items: PhoneNumberInstance) => any): Promise<PhoneNumberInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class PhoneNumberInstance extends SerializableClass {
+  /**
+   * Initialize the PhoneNumberContext
+   *
+   * PLEASE NOTE that this class contains beta products that are subject to change.
+   * Use them with caution.
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param phoneNumber - Phone number to lookup
+   */
+  constructor(version: V2, payload: PhoneNumberPayload, phoneNumber: string);
+
+  private _proxy: PhoneNumberContext;
+  callForwarding: any;
+  callerName: any;
+  callingCountryCode: string;
+  countryCode: string;
+  /**
+   * fetch a PhoneNumberInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: PhoneNumberInstance) => any): Promise<PhoneNumberInstance>;
+  /**
+   * fetch a PhoneNumberInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  fetch(opts?: PhoneNumberInstanceFetchOptions, callback?: (error: Error | null, items: PhoneNumberInstance) => any): Promise<PhoneNumberInstance>;
+  lineTypeIntelligence: any;
+  liveActivity: any;
+  nationalFormat: string;
+  phoneNumber: string;
+  simSwap: any;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  url: string;
+  valid: boolean;
+  validationErrors: PhoneNumberValidationError[];
+}
+
+
+declare class PhoneNumberPage extends Page<V2, PhoneNumberPayload, PhoneNumberResource, PhoneNumberInstance> {
+  /**
+   * Initialize the PhoneNumberPage
+   *
+   * PLEASE NOTE that this class contains beta products that are subject to change.
+   * Use them with caution.
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V2, response: Response<string>, solution: PhoneNumberSolution);
+
+  /**
+   * Build an instance of PhoneNumberInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: PhoneNumberPayload): PhoneNumberInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { PhoneNumberContext, PhoneNumberInstance, PhoneNumberInstanceFetchOptions, PhoneNumberList, PhoneNumberListInstance, PhoneNumberPage, PhoneNumberPayload, PhoneNumberResource, PhoneNumberSolution, PhoneNumberType, PhoneNumberValidationError }

package/lib/rest/lookups/v2/phoneNumber.js

@@ -0,0 +1,359 @@
+'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 PhoneNumberList;
+var PhoneNumberPage;
+var PhoneNumberInstance;
+var PhoneNumberContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the PhoneNumberList
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Lookups.V2.PhoneNumberList
+ *
+ * @param {Twilio.Lookups.V2} version - Version of the resource
+ */
+/* jshint ignore:end */
+PhoneNumberList = function PhoneNumberList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function phoneNumbers
+   * @memberof Twilio.Lookups.V2#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Lookups.V2.PhoneNumberContext}
+   */
+  /* jshint ignore:end */
+  function PhoneNumberListInstance(sid) {
+    return PhoneNumberListInstance.get(sid);
+  }
+
+  PhoneNumberListInstance._version = version;
+  // Path Solution
+  PhoneNumberListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a phone_number
+   *
+   * @function get
+   * @memberof Twilio.Lookups.V2.PhoneNumberList#
+   *
+   * @param {string} phoneNumber - Phone number to lookup
+   *
+   * @returns {Twilio.Lookups.V2.PhoneNumberContext}
+   */
+  /* jshint ignore:end */
+  PhoneNumberListInstance.get = function get(phoneNumber) {
+    return new PhoneNumberContext(this._version, phoneNumber);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Lookups.V2.PhoneNumberList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  PhoneNumberListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  PhoneNumberListInstance[util.inspect.custom] = function inspect(depth, options)
+      {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return PhoneNumberListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the PhoneNumberPage
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Lookups.V2.PhoneNumberPage
+ *
+ * @param {V2} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {PhoneNumberSolution} solution - Path solution
+ *
+ * @returns PhoneNumberPage
+ */
+/* jshint ignore:end */
+PhoneNumberPage = function PhoneNumberPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(PhoneNumberPage.prototype, Page.prototype);
+PhoneNumberPage.prototype.constructor = PhoneNumberPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of PhoneNumberInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Lookups.V2.PhoneNumberPage#
+ *
+ * @param {PhoneNumberPayload} payload - Payload response from the API
+ *
+ * @returns PhoneNumberInstance
+ */
+/* jshint ignore:end */
+PhoneNumberPage.prototype.getInstance = function getInstance(payload) {
+  return new PhoneNumberInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Lookups.V2.PhoneNumberPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+PhoneNumberPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+PhoneNumberPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the PhoneNumberContext
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Lookups.V2.PhoneNumberInstance
+ *
+ * @property {string} callingCountryCode - International dialing prefix
+ * @property {string} countryCode - Phone number's ISO country code
+ * @property {string} phoneNumber - Phone number in E.164 format
+ * @property {string} nationalFormat - Phone number in national format
+ * @property {boolean} valid - Boolean which indicates if the phone number is valid
+ * @property {phone_number.validation_error} validationErrors -
+ *          Contains reasons why a phone number is invalid
+ * @property {object} callerName - An object that contains caller name information
+ * @property {object} simSwap - An object that contains SIM swap information
+ * @property {object} callForwarding -
+ *          An object that contains call forwarding status information
+ * @property {object} liveActivity -
+ *          An object that contains live activity information
+ * @property {object} lineTypeIntelligence -
+ *          An object that contains line type information
+ * @property {string} url - The absolute URL of the resource
+ *
+ * @param {V2} version - Version of the resource
+ * @param {PhoneNumberPayload} payload - The instance payload
+ * @param {string} phoneNumber - Phone number to lookup
+ */
+/* jshint ignore:end */
+PhoneNumberInstance = function PhoneNumberInstance(version, payload,
+                                                    phoneNumber) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.callingCountryCode = payload.calling_country_code; // jshint ignore:line
+  this.countryCode = payload.country_code; // jshint ignore:line
+  this.phoneNumber = payload.phone_number; // jshint ignore:line
+  this.nationalFormat = payload.national_format; // jshint ignore:line
+  this.valid = payload.valid; // jshint ignore:line
+  this.validationErrors = payload.validation_errors; // jshint ignore:line
+  this.callerName = payload.caller_name; // jshint ignore:line
+  this.simSwap = payload.sim_swap; // jshint ignore:line
+  this.callForwarding = payload.call_forwarding; // jshint ignore:line
+  this.liveActivity = payload.live_activity; // jshint ignore:line
+  this.lineTypeIntelligence = payload.line_type_intelligence; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {phoneNumber: phoneNumber || this.phoneNumber, };
+};
+
+Object.defineProperty(PhoneNumberInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new PhoneNumberContext(this._version, this._solution.phoneNumber);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * fetch a PhoneNumberInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Lookups.V2.PhoneNumberInstance#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.fields] - Fields to return
+ * @param {string} [opts.countryCode] -
+ *          Country code for national phone number lookups
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed PhoneNumberInstance
+ */
+/* jshint ignore:end */
+PhoneNumberInstance.prototype.fetch = function fetch(opts, callback) {
+  return this._proxy.fetch(opts, callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Lookups.V2.PhoneNumberInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+PhoneNumberInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+PhoneNumberInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the PhoneNumberContext
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Lookups.V2.PhoneNumberContext
+ *
+ * @param {V2} version - Version of the resource
+ * @param {string} phoneNumber - Phone number to lookup
+ */
+/* jshint ignore:end */
+PhoneNumberContext = function PhoneNumberContext(version, phoneNumber) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {phoneNumber: phoneNumber, };
+  this._uri = `/PhoneNumbers/${phoneNumber}`;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a PhoneNumberInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Lookups.V2.PhoneNumberContext#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.fields] - Fields to return
+ * @param {string} [opts.countryCode] -
+ *          Country code for national phone number lookups
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed PhoneNumberInstance
+ */
+/* jshint ignore:end */
+PhoneNumberContext.prototype.fetch = function fetch(opts, callback) {
+  if (_.isFunction(opts)) {
+    callback = opts;
+    opts = {};
+  }
+  opts = opts || {};
+
+  var deferred = Q.defer();
+  var data = values.of({'Fields': _.get(opts, 'fields'), 'CountryCode': _.get(opts, 'countryCode')});
+
+  var promise = this._version.fetch({uri: this._uri, method: 'GET', params: data});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new PhoneNumberInstance(this._version, payload, this._solution.phoneNumber));
+  }.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.Lookups.V2.PhoneNumberContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+PhoneNumberContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+PhoneNumberContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  PhoneNumberList: PhoneNumberList,
+  PhoneNumberPage: PhoneNumberPage,
+  PhoneNumberInstance: PhoneNumberInstance,
+  PhoneNumberContext: PhoneNumberContext
+};