twilio 3.83.2 → 3.83.4

package/lib/rest/content/v1/content/approvalFetch.js

@@ -0,0 +1,328 @@
+'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 ApprovalFetchList;
+var ApprovalFetchPage;
+var ApprovalFetchInstance;
+var ApprovalFetchContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the ApprovalFetchList
+ *
+ * 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.Content.V1.ContentContext.ApprovalFetchList
+ *
+ * @param {Twilio.Content.V1} version - Version of the resource
+ * @param {string} sid - The unique string that identifies the Content resource
+ */
+/* jshint ignore:end */
+ApprovalFetchList = function ApprovalFetchList(version, sid) {
+  /* jshint ignore:start */
+  /**
+   * @function approvalFetch
+   * @memberof Twilio.Content.V1.ContentContext#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Content.V1.ContentContext.ApprovalFetchContext}
+   */
+  /* jshint ignore:end */
+  function ApprovalFetchListInstance(sid) {
+    return ApprovalFetchListInstance.get(sid);
+  }
+
+  ApprovalFetchListInstance._version = version;
+  // Path Solution
+  ApprovalFetchListInstance._solution = {sid: sid};
+  /* jshint ignore:start */
+  /**
+   * Constructs a approval_fetch
+   *
+   * @function get
+   * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchList#
+   *
+   * @returns {Twilio.Content.V1.ContentContext.ApprovalFetchContext}
+   */
+  /* jshint ignore:end */
+  ApprovalFetchListInstance.get = function get() {
+    return new ApprovalFetchContext(this._version, this._solution.sid);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  ApprovalFetchListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  ApprovalFetchListInstance[util.inspect.custom] = function inspect(depth,
+      options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return ApprovalFetchListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the ApprovalFetchPage
+ *
+ * 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.Content.V1.ContentContext.ApprovalFetchPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {ApprovalFetchSolution} solution - Path solution
+ *
+ * @returns ApprovalFetchPage
+ */
+/* jshint ignore:end */
+ApprovalFetchPage = function ApprovalFetchPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(ApprovalFetchPage.prototype, Page.prototype);
+ApprovalFetchPage.prototype.constructor = ApprovalFetchPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of ApprovalFetchInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchPage#
+ *
+ * @param {ApprovalFetchPayload} payload - Payload response from the API
+ *
+ * @returns ApprovalFetchInstance
+ */
+/* jshint ignore:end */
+ApprovalFetchPage.prototype.getInstance = function getInstance(payload) {
+  return new ApprovalFetchInstance(this._version, payload, this._solution.sid);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+ApprovalFetchPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+ApprovalFetchPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the ApprovalFetchContext
+ *
+ * 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.Content.V1.ContentContext.ApprovalFetchInstance
+ *
+ * @property {string} sid - The unique string that identifies the Content resource
+ * @property {string} accountSid -
+ *          The SID of the Account that created the Content resource
+ * @property {object} whatsapp -
+ *          Contains the whatsapp approval information for the Content resource
+ * @property {string} url -
+ *          The URL of the resource, relative to `https://content.twilio.com`
+ *
+ * @param {V1} version - Version of the resource
+ * @param {ApprovalFetchPayload} payload - The instance payload
+ * @param {sid} sid - The unique string that identifies the Content resource
+ */
+/* jshint ignore:end */
+ApprovalFetchInstance = function ApprovalFetchInstance(version, payload, sid) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.sid = payload.sid; // jshint ignore:line
+  this.accountSid = payload.account_sid; // jshint ignore:line
+  this.whatsapp = payload.whatsapp; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {sid: sid, };
+};
+
+Object.defineProperty(ApprovalFetchInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new ApprovalFetchContext(this._version, this._solution.sid);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * fetch a ApprovalFetchInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed ApprovalFetchInstance
+ */
+/* jshint ignore:end */
+ApprovalFetchInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+ApprovalFetchInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+ApprovalFetchInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the ApprovalFetchContext
+ *
+ * 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.Content.V1.ContentContext.ApprovalFetchContext
+ *
+ * @param {V1} version - Version of the resource
+ * @param {sid} sid - The unique string that identifies the Content resource
+ */
+/* jshint ignore:end */
+ApprovalFetchContext = function ApprovalFetchContext(version, sid) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {sid: sid, };
+  this._uri = `/Content/${sid}/ApprovalRequests`;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a ApprovalFetchInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed ApprovalFetchInstance
+ */
+/* jshint ignore:end */
+ApprovalFetchContext.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 ApprovalFetchInstance(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
+ *
+ * @function toJSON
+ * @memberof Twilio.Content.V1.ContentContext.ApprovalFetchContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+ApprovalFetchContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+ApprovalFetchContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  ApprovalFetchList: ApprovalFetchList,
+  ApprovalFetchPage: ApprovalFetchPage,
+  ApprovalFetchInstance: ApprovalFetchInstance,
+  ApprovalFetchContext: ApprovalFetchContext
+};

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

@@ -0,0 +1,323 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../base/Page');
+import Response = require('../../../http/response');
+import V1 = require('../V1');
+import { ApprovalFetchList } from './content/approvalFetch';
+import { ApprovalFetchListInstance } from './content/approvalFetch';
+import { SerializableClass } from '../../../interfaces';
+
+/**
+ * Initialize the ContentList
+ *
+ * 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.
+ *
+ * @param version - Version of the resource
+ */
+declare function ContentList(version: V1): ContentListInstance;
+
+interface ContentListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): ContentContext;
+  /**
+   * Streams ContentInstance records from the API.
+   *
+   * This operation lazily loads records as efficiently as possible until the limit
+   * is reached.
+   *
+   * The results are passed into the callback function, so this operation is memory
+   * efficient.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Function to process each record
+   */
+  each(callback?: (item: ContentInstance, done: (err?: Error) => void) => void): void;
+  /**
+   * Streams ContentInstance records from the API.
+   *
+   * This operation lazily loads records as efficiently as possible until the limit
+   * is reached.
+   *
+   * The results are passed into the callback function, so this operation is memory
+   * efficient.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param opts - Options for request
+   * @param callback - Function to process each record
+   */
+  each(opts?: ContentListInstanceEachOptions, callback?: (item: ContentInstance, done: (err?: Error) => void) => void): void;
+  /**
+   * Constructs a content
+   *
+   * @param sid - The unique string that identifies the resource
+   */
+  get(sid: string): ContentContext;
+  /**
+   * Retrieve a single target page of ContentInstance records from the API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Callback to handle list of records
+   */
+  getPage(callback?: (error: Error | null, items: ContentPage) => any): Promise<ContentPage>;
+  /**
+   * Retrieve a single target page of ContentInstance records from the API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param targetUrl - API-generated URL for the requested results page
+   * @param callback - Callback to handle list of records
+   */
+  getPage(targetUrl?: string, callback?: (error: Error | null, items: ContentPage) => any): Promise<ContentPage>;
+  /**
+   * Lists ContentInstance records from the API as a list.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Callback to handle list of records
+   */
+  list(callback?: (error: Error | null, items: ContentInstance[]) => any): Promise<ContentInstance[]>;
+  /**
+   * Lists ContentInstance records from the API as a list.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle list of records
+   */
+  list(opts?: ContentListInstanceOptions, callback?: (error: Error | null, items: ContentInstance[]) => any): Promise<ContentInstance[]>;
+  /**
+   * Retrieve a single page of ContentInstance records from the API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param callback - Callback to handle list of records
+   */
+  page(callback?: (error: Error | null, items: ContentPage) => any): Promise<ContentPage>;
+  /**
+   * Retrieve a single page of ContentInstance records from the API.
+   *
+   * The request is executed immediately.
+   *
+   * If a function is passed as the first argument, it will be used as the callback
+   * function.
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle list of records
+   */
+  page(opts?: ContentListInstancePageOptions, callback?: (error: Error | null, items: ContentPage) => any): Promise<ContentPage>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to each
+ *
+ * @property callback -
+ *                         Function to process each record. If this and a positional
+ *                         callback are passed, this one will be used
+ * @property done - Function to be called upon completion of streaming
+ * @property limit -
+ *                         Upper limit for the number of records to return.
+ *                         each() guarantees never to return more than limit.
+ *                         Default is no limit
+ * @property pageSize -
+ *                         Number of records to fetch per request,
+ *                         when not set will use the default value of 50 records.
+ *                         If no pageSize is defined but a limit is defined,
+ *                         each() will attempt to read the limit with the most efficient
+ *                         page size, i.e. min(limit, 1000)
+ */
+interface ContentListInstanceEachOptions {
+  callback?: (item: ContentInstance, done: (err?: Error) => void) => void;
+  done?: Function;
+  limit?: number;
+  pageSize?: number;
+}
+
+/**
+ * Options to pass to list
+ *
+ * @property limit -
+ *                         Upper limit for the number of records to return.
+ *                         list() guarantees never to return more than limit.
+ *                         Default is no limit
+ * @property pageSize -
+ *                         Number of records to fetch per request,
+ *                         when not set will use the default value of 50 records.
+ *                         If no page_size is defined but a limit is defined,
+ *                         list() will attempt to read the limit with the most
+ *                         efficient page size, i.e. min(limit, 1000)
+ */
+interface ContentListInstanceOptions {
+  limit?: number;
+  pageSize?: number;
+}
+
+/**
+ * Options to pass to page
+ *
+ * @property pageNumber - Page Number, this value is simply for client state
+ * @property pageSize - Number of records to return, defaults to 50
+ * @property pageToken - PageToken provided by the API
+ */
+interface ContentListInstancePageOptions {
+  pageNumber?: number;
+  pageSize?: number;
+  pageToken?: string;
+}
+
+interface ContentPayload extends ContentResource, Page.TwilioResponsePayload {
+}
+
+interface ContentResource {
+  account_sid: string;
+  date_created: Date;
+  date_updated: Date;
+  friendly_name: string;
+  language: string;
+  links: string;
+  sid: string;
+  types: object;
+  url: string;
+  variables: object;
+}
+
+interface ContentSolution {
+}
+
+
+declare class ContentContext {
+  /**
+   * Initialize the ContentContext
+   *
+   * 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.
+   *
+   * @param version - Version of the resource
+   * @param sid - The unique string that identifies the resource
+   */
+  constructor(version: V1, sid: string);
+
+  approvalFetch: ApprovalFetchListInstance;
+  /**
+   * fetch a ContentInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: ContentInstance) => any): Promise<ContentInstance>;
+  /**
+   * remove a ContentInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  remove(callback?: (error: Error | null, items: ContentInstance) => any): Promise<boolean>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class ContentInstance extends SerializableClass {
+  /**
+   * Initialize the ContentContext
+   *
+   * 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.
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param sid - The unique string that identifies the resource
+   */
+  constructor(version: V1, payload: ContentPayload, sid: string);
+
+  private _proxy: ContentContext;
+  accountSid: string;
+  /**
+   * Access the approvalFetch
+   */
+  approvalFetch(): ApprovalFetchListInstance;
+  dateCreated: Date;
+  dateUpdated: Date;
+  /**
+   * fetch a ContentInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: ContentInstance) => any): Promise<ContentInstance>;
+  friendlyName: string;
+  language: string;
+  links: string;
+  /**
+   * remove a ContentInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  remove(callback?: (error: Error | null, items: ContentInstance) => any): Promise<boolean>;
+  sid: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  types: any;
+  url: string;
+  variables: any;
+}
+
+
+declare class ContentPage extends Page<V1, ContentPayload, ContentResource, ContentInstance> {
+  /**
+   * Initialize the ContentPage
+   *
+   * 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.
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V1, response: Response<string>, solution: ContentSolution);
+
+  /**
+   * Build an instance of ContentInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: ContentPayload): ContentInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { ContentContext, ContentInstance, ContentList, ContentListInstance, ContentListInstanceEachOptions, ContentListInstanceOptions, ContentListInstancePageOptions, ContentPage, ContentPayload, ContentResource, ContentSolution }