twilio 3.75.0 → 3.76.1

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

@@ -0,0 +1,156 @@
+/**
+ * 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 VerificationAttemptsSummaryChannels = 'sms'|'call'|'email'|'whatsapp';
+
+/**
+ * Initialize the VerificationAttemptsSummaryList
+ *
+ * @param version - Version of the resource
+ */
+declare function VerificationAttemptsSummaryList(version: V2): VerificationAttemptsSummaryListInstance;
+
+/**
+ * Options to pass to fetch
+ *
+ * @property channel - Filter verification attempts considered on the summary by communication channel.
+ * @property country - Filter verification attempts considered on the summary by destination country.
+ * @property dateCreatedAfter - Consider verification attempts create after this date on the summary.
+ * @property dateCreatedBefore - Consider verification attempts created before this date on the summary.
+ * @property destinationPrefix - Filters the attempts considered on the summary by destination prefix.
+ * @property verifyServiceSid - Filter the verification attempts considered on the summary by verify service.
+ */
+interface VerificationAttemptsSummaryInstanceFetchOptions {
+  channel?: VerificationAttemptsSummaryChannels;
+  country?: string;
+  dateCreatedAfter?: Date;
+  dateCreatedBefore?: Date;
+  destinationPrefix?: string;
+  verifyServiceSid?: string;
+}
+
+interface VerificationAttemptsSummaryListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): VerificationAttemptsSummaryContext;
+  /**
+   * Constructs a verification_attempts_summary
+   */
+  get(): VerificationAttemptsSummaryContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+interface VerificationAttemptsSummaryPayload extends VerificationAttemptsSummaryResource, Page.TwilioResponsePayload {
+}
+
+interface VerificationAttemptsSummaryResource {
+  conversion_rate_percentage: number;
+  total_attempts: number;
+  total_converted: number;
+  total_unconverted: number;
+  url: string;
+}
+
+interface VerificationAttemptsSummarySolution {
+}
+
+
+declare class VerificationAttemptsSummaryContext {
+  /**
+   * Initialize the VerificationAttemptsSummaryContext
+   *
+   * @param version - Version of the resource
+   */
+  constructor(version: V2);
+
+  /**
+   * fetch a VerificationAttemptsSummaryInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: VerificationAttemptsSummaryInstance) => any): Promise<VerificationAttemptsSummaryInstance>;
+  /**
+   * fetch a VerificationAttemptsSummaryInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  fetch(opts?: VerificationAttemptsSummaryInstanceFetchOptions, callback?: (error: Error | null, items: VerificationAttemptsSummaryInstance) => any): Promise<VerificationAttemptsSummaryInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class VerificationAttemptsSummaryInstance extends SerializableClass {
+  /**
+   * Initialize the VerificationAttemptsSummaryContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   */
+  constructor(version: V2, payload: VerificationAttemptsSummaryPayload);
+
+  private _proxy: VerificationAttemptsSummaryContext;
+  conversionRatePercentage: number;
+  /**
+   * fetch a VerificationAttemptsSummaryInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: VerificationAttemptsSummaryInstance) => any): Promise<VerificationAttemptsSummaryInstance>;
+  /**
+   * fetch a VerificationAttemptsSummaryInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  fetch(opts?: VerificationAttemptsSummaryInstanceFetchOptions, callback?: (error: Error | null, items: VerificationAttemptsSummaryInstance) => any): Promise<VerificationAttemptsSummaryInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  totalAttempts: number;
+  totalConverted: number;
+  totalUnconverted: number;
+  url: string;
+}
+
+
+declare class VerificationAttemptsSummaryPage extends Page<V2, VerificationAttemptsSummaryPayload, VerificationAttemptsSummaryResource, VerificationAttemptsSummaryInstance> {
+  /**
+   * Initialize the VerificationAttemptsSummaryPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V2, response: Response<string>, solution: VerificationAttemptsSummarySolution);
+
+  /**
+   * Build an instance of VerificationAttemptsSummaryInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: VerificationAttemptsSummaryPayload): VerificationAttemptsSummaryInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { VerificationAttemptsSummaryChannels, VerificationAttemptsSummaryContext, VerificationAttemptsSummaryInstance, VerificationAttemptsSummaryInstanceFetchOptions, VerificationAttemptsSummaryList, VerificationAttemptsSummaryListInstance, VerificationAttemptsSummaryPage, VerificationAttemptsSummaryPayload, VerificationAttemptsSummaryResource, VerificationAttemptsSummarySolution }

package/lib/rest/verify/v2/verificationAttemptsSummary.js

@@ -0,0 +1,362 @@
+'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 VerificationAttemptsSummaryList;
+var VerificationAttemptsSummaryPage;
+var VerificationAttemptsSummaryInstance;
+var VerificationAttemptsSummaryContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the VerificationAttemptsSummaryList
+ *
+ * @constructor Twilio.Verify.V2.VerificationAttemptsSummaryList
+ *
+ * @param {Twilio.Verify.V2} version - Version of the resource
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryList = function
+    VerificationAttemptsSummaryList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function verificationAttemptsSummary
+   * @memberof Twilio.Verify.V2#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Verify.V2.VerificationAttemptsSummaryContext}
+   */
+  /* jshint ignore:end */
+  function VerificationAttemptsSummaryListInstance(sid) {
+    return VerificationAttemptsSummaryListInstance.get(sid);
+  }
+
+  VerificationAttemptsSummaryListInstance._version = version;
+  // Path Solution
+  VerificationAttemptsSummaryListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a verification_attempts_summary
+   *
+   * @function get
+   * @memberof Twilio.Verify.V2.VerificationAttemptsSummaryList#
+   *
+   * @returns {Twilio.Verify.V2.VerificationAttemptsSummaryContext}
+   */
+  /* jshint ignore:end */
+  VerificationAttemptsSummaryListInstance.get = function get() {
+    return new VerificationAttemptsSummaryContext(this._version);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Verify.V2.VerificationAttemptsSummaryList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  VerificationAttemptsSummaryListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  VerificationAttemptsSummaryListInstance[util.inspect.custom] = function
+      inspect(depth, options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return VerificationAttemptsSummaryListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the VerificationAttemptsSummaryPage
+ *
+ * @constructor Twilio.Verify.V2.VerificationAttemptsSummaryPage
+ *
+ * @param {V2} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {VerificationAttemptsSummarySolution} solution - Path solution
+ *
+ * @returns VerificationAttemptsSummaryPage
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryPage = function
+    VerificationAttemptsSummaryPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(VerificationAttemptsSummaryPage.prototype, Page.prototype);
+VerificationAttemptsSummaryPage.prototype.constructor = VerificationAttemptsSummaryPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of VerificationAttemptsSummaryInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Verify.V2.VerificationAttemptsSummaryPage#
+ *
+ * @param {VerificationAttemptsSummaryPayload} payload -
+ *          Payload response from the API
+ *
+ * @returns VerificationAttemptsSummaryInstance
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryPage.prototype.getInstance = function
+    getInstance(payload) {
+  return new VerificationAttemptsSummaryInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Verify.V2.VerificationAttemptsSummaryPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+VerificationAttemptsSummaryPage.prototype[util.inspect.custom] = function
+    inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the VerificationAttemptsSummaryContext
+ *
+ * @constructor Twilio.Verify.V2.VerificationAttemptsSummaryInstance
+ *
+ * @property {number} totalAttempts - Total of attempts made.
+ * @property {number} totalConverted - Total of attempts confirmed by the end user.
+ * @property {number} totalUnconverted -
+ *          Total of attempts made that were not confirmed by the end user.
+ * @property {number} conversionRatePercentage -
+ *          Percentage of the confirmed messages over the total.
+ * @property {string} url - The url
+ *
+ * @param {V2} version - Version of the resource
+ * @param {VerificationAttemptsSummaryPayload} payload - The instance payload
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryInstance = function
+    VerificationAttemptsSummaryInstance(version, payload) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.totalAttempts = deserialize.integer(payload.total_attempts); // jshint ignore:line
+  this.totalConverted = deserialize.integer(payload.total_converted); // jshint ignore:line
+  this.totalUnconverted = deserialize.integer(payload.total_unconverted); // jshint ignore:line
+  this.conversionRatePercentage = deserialize.decimal(payload.conversion_rate_percentage); // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {};
+};
+
+Object.defineProperty(VerificationAttemptsSummaryInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new VerificationAttemptsSummaryContext(this._version);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * fetch a VerificationAttemptsSummaryInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Verify.V2.VerificationAttemptsSummaryInstance#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.verifyServiceSid] -
+ *          Filter the verification attempts considered on the summary by verify service.
+ * @param {Date} [opts.dateCreatedAfter] -
+ *          Consider verification attempts create after this date on the summary.
+ * @param {Date} [opts.dateCreatedBefore] -
+ *          Consider verification attempts created before this date on the summary.
+ * @param {string} [opts.country] -
+ *          Filter verification attempts considered on the summary by destination country.
+ * @param {verification_attempts_summary.channels} [opts.channel] -
+ *          Filter verification attempts considered on the summary by communication channel.
+ * @param {string} [opts.destinationPrefix] -
+ *          Filters the attempts considered on the summary by destination prefix.
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed VerificationAttemptsSummaryInstance
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryInstance.prototype.fetch = function fetch(opts,
+    callback) {
+  return this._proxy.fetch(opts, callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Verify.V2.VerificationAttemptsSummaryInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+VerificationAttemptsSummaryInstance.prototype[util.inspect.custom] = function
+    inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the VerificationAttemptsSummaryContext
+ *
+ * @constructor Twilio.Verify.V2.VerificationAttemptsSummaryContext
+ *
+ * @param {V2} version - Version of the resource
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryContext = function
+    VerificationAttemptsSummaryContext(version) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {};
+  this._uri = `/Attempts/Summary`;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a VerificationAttemptsSummaryInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Verify.V2.VerificationAttemptsSummaryContext#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.verifyServiceSid] -
+ *          Filter the verification attempts considered on the summary by verify service.
+ * @param {Date} [opts.dateCreatedAfter] -
+ *          Consider verification attempts create after this date on the summary.
+ * @param {Date} [opts.dateCreatedBefore] -
+ *          Consider verification attempts created before this date on the summary.
+ * @param {string} [opts.country] -
+ *          Filter verification attempts considered on the summary by destination country.
+ * @param {verification_attempts_summary.channels} [opts.channel] -
+ *          Filter verification attempts considered on the summary by communication channel.
+ * @param {string} [opts.destinationPrefix] -
+ *          Filters the attempts considered on the summary by destination prefix.
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed VerificationAttemptsSummaryInstance
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryContext.prototype.fetch = function fetch(opts,
+    callback) {
+  if (_.isFunction(opts)) {
+    callback = opts;
+    opts = {};
+  }
+  opts = opts || {};
+
+  var deferred = Q.defer();
+  var data = values.of({
+    'VerifyServiceSid': _.get(opts, 'verifyServiceSid'),
+    'DateCreatedAfter': serialize.iso8601DateTime(_.get(opts, 'dateCreatedAfter')),
+    'DateCreatedBefore': serialize.iso8601DateTime(_.get(opts, 'dateCreatedBefore')),
+    'Country': _.get(opts, 'country'),
+    'Channel': _.get(opts, 'channel'),
+    'DestinationPrefix': _.get(opts, 'destinationPrefix')
+  });
+
+  var promise = this._version.fetch({uri: this._uri, method: 'GET', params: data});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new VerificationAttemptsSummaryInstance(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.Verify.V2.VerificationAttemptsSummaryContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+VerificationAttemptsSummaryContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+VerificationAttemptsSummaryContext.prototype[util.inspect.custom] = function
+    inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  VerificationAttemptsSummaryList: VerificationAttemptsSummaryList,
+  VerificationAttemptsSummaryPage: VerificationAttemptsSummaryPage,
+  VerificationAttemptsSummaryInstance: VerificationAttemptsSummaryInstance,
+  VerificationAttemptsSummaryContext: VerificationAttemptsSummaryContext
+};

package/lib/rest/video/v1/composition.d.ts

@@ -267,6 +267,8 @@ interface CompositionResource {
   sid: string;
   size: number;
   status: CompositionStatus;
+  status_callback: string;
+  status_callback_method: string;
   trim: boolean;
   url: string;
   video_layout: object;
@@ -343,6 +345,8 @@ declare class CompositionInstance extends SerializableClass {
   sid: string;
   size: number;
   status: CompositionStatus;
+  statusCallback: string;
+  statusCallbackMethod: string;
   /**
    * Provide a user-friendly representation
    */

package/lib/rest/video/v1/composition.js

@@ -529,6 +529,10 @@ CompositionPage.prototype[util.inspect.custom] = function inspect(depth,
  *          The duration of the composition's media file in seconds
  * @property {string} mediaExternalLocation -
  *          The URL of the media file associated with the composition when stored externally
+ * @property {string} statusCallback -
+ *          The URL called to send status information on every composition event.
+ * @property {string} statusCallbackMethod -
+ *          The HTTP method used to call `status_callback`
  * @property {string} url - The absolute URL of the resource
  * @property {string} links -
  *          The URL of the media file associated with the composition
@@ -559,6 +563,8 @@ CompositionInstance = function CompositionInstance(version, payload, sid) {
   this.size = deserialize.integer(payload.size); // jshint ignore:line
   this.duration = deserialize.integer(payload.duration); // jshint ignore:line
   this.mediaExternalLocation = payload.media_external_location; // jshint ignore:line
+  this.statusCallback = payload.status_callback; // jshint ignore:line
+  this.statusCallbackMethod = payload.status_callback_method; // jshint ignore:line
   this.url = payload.url; // jshint ignore:line
   this.links = payload.links; // jshint ignore:line
 

package/lib/rest/video/v1/recording.d.ts

@@ -248,6 +248,8 @@ interface RecordingResource {
   size: number;
   source_sid: string;
   status: RecordingStatus;
+  status_callback: string;
+  status_callback_method: string;
   track_name: string;
   type: RecordingType;
   url: string;
@@ -321,6 +323,8 @@ declare class RecordingInstance extends SerializableClass {
   size: number;
   sourceSid: string;
   status: RecordingStatus;
+  statusCallback: string;
+  statusCallbackMethod: string;
   /**
    * Provide a user-friendly representation
    */

package/lib/rest/video/v1/recording.js

@@ -465,6 +465,10 @@ RecordingPage.prototype[util.inspect.custom] = function inspect(depth, options)
  *          The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started
  * @property {string} mediaExternalLocation -
  *          The URL of the media file associated with the recording when stored externally
+ * @property {string} statusCallback -
+ *          The URL called to send status information on every recording event.
+ * @property {string} statusCallbackMethod -
+ *          The HTTP method used to call `status_callback`
  * @property {string} links - The URLs of related resources
  *
  * @param {V1} version - Version of the resource
@@ -491,6 +495,8 @@ RecordingInstance = function RecordingInstance(version, payload, sid) {
   this.trackName = payload.track_name; // jshint ignore:line
   this.offset = deserialize.integer(payload.offset); // jshint ignore:line
   this.mediaExternalLocation = payload.media_external_location; // jshint ignore:line
+  this.statusCallback = payload.status_callback; // jshint ignore:line
+  this.statusCallbackMethod = payload.status_callback_method; // jshint ignore:line
   this.links = payload.links; // jshint ignore:line
 
   // Context

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "twilio",
   "description": "A Twilio helper library",
-  "version": "3.75.0",
+  "version": "3.76.1",
   "author": "API Team <api@twilio.com>",
   "contributors": [
     {
@@ -20,7 +20,7 @@
     "url": "https://github.com/twilio/twilio-node.git"
   },
   "dependencies": {
-    "axios": "^0.25.0",
+    "axios": "^0.26.1",
     "dayjs": "^1.8.29",
     "https-proxy-agent": "^5.0.0",
     "jsonwebtoken": "^8.5.1",
@@ -29,7 +29,7 @@
     "qs": "^6.9.4",
     "rootpath": "^0.1.2",
     "scmp": "^2.1.0",
-    "url-parse": "^1.5.6",
+    "url-parse": "^1.5.9",
     "xmlbuilder": "^13.0.2"
   },
   "devDependencies": {