twilio 3.82.1 → 3.83.0

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

@@ -0,0 +1,329 @@
+'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 OpenidDiscoveryList;
+var OpenidDiscoveryPage;
+var OpenidDiscoveryInstance;
+var OpenidDiscoveryContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the OpenidDiscoveryList
+ *
+ * @constructor Twilio.Oauth.V1.OpenidDiscoveryList
+ *
+ * @param {Twilio.Oauth.V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+OpenidDiscoveryList = function OpenidDiscoveryList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function openidDiscovery
+   * @memberof Twilio.Oauth.V1#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Oauth.V1.OpenidDiscoveryContext}
+   */
+  /* jshint ignore:end */
+  function OpenidDiscoveryListInstance(sid) {
+    return OpenidDiscoveryListInstance.get(sid);
+  }
+
+  OpenidDiscoveryListInstance._version = version;
+  // Path Solution
+  OpenidDiscoveryListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a openid_discovery
+   *
+   * @function get
+   * @memberof Twilio.Oauth.V1.OpenidDiscoveryList#
+   *
+   * @returns {Twilio.Oauth.V1.OpenidDiscoveryContext}
+   */
+  /* jshint ignore:end */
+  OpenidDiscoveryListInstance.get = function get() {
+    return new OpenidDiscoveryContext(this._version);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Oauth.V1.OpenidDiscoveryList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  OpenidDiscoveryListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  OpenidDiscoveryListInstance[util.inspect.custom] = function inspect(depth,
+      options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return OpenidDiscoveryListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the OpenidDiscoveryPage
+ *
+ * @constructor Twilio.Oauth.V1.OpenidDiscoveryPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {OpenidDiscoverySolution} solution - Path solution
+ *
+ * @returns OpenidDiscoveryPage
+ */
+/* jshint ignore:end */
+OpenidDiscoveryPage = function OpenidDiscoveryPage(version, response, solution)
+                                                    {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(OpenidDiscoveryPage.prototype, Page.prototype);
+OpenidDiscoveryPage.prototype.constructor = OpenidDiscoveryPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of OpenidDiscoveryInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Oauth.V1.OpenidDiscoveryPage#
+ *
+ * @param {OpenidDiscoveryPayload} payload - Payload response from the API
+ *
+ * @returns OpenidDiscoveryInstance
+ */
+/* jshint ignore:end */
+OpenidDiscoveryPage.prototype.getInstance = function getInstance(payload) {
+  return new OpenidDiscoveryInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Oauth.V1.OpenidDiscoveryPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+OpenidDiscoveryPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+OpenidDiscoveryPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the OpenidDiscoveryContext
+ *
+ * @constructor Twilio.Oauth.V1.OpenidDiscoveryInstance
+ *
+ * @property {string} issuer - The issuer URL
+ * @property {string} authorizationEndpoint - The URL of authorization endpoint
+ * @property {string} deviceAuthorizationEndpoint -
+ *          The URL of device code authorization endpoint
+ * @property {string} tokenEndpoint - The URL of token endpoint
+ * @property {string} userinfoEndpoint - The URL of user info endpoint
+ * @property {string} revocationEndpoint - The URL of revocation endpoint
+ * @property {string} jwkUri - The URL of public JWK endpoint
+ * @property {string} responseTypeSupported -
+ *          List of response type supported for identity token
+ * @property {string} subjectTypeSupported -
+ *          List of subject supported for identity token
+ * @property {string} idTokenSigningAlgValuesSupported -
+ *          List of JWS signing algorithms supported for identity token
+ * @property {string} scopesSupported - List of scopes supported identity token
+ * @property {string} claimsSupported - List of claims supported for identity token
+ * @property {string} url - The url
+ *
+ * @param {V1} version - Version of the resource
+ * @param {OpenidDiscoveryPayload} payload - The instance payload
+ */
+/* jshint ignore:end */
+OpenidDiscoveryInstance = function OpenidDiscoveryInstance(version, payload) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.issuer = payload.issuer; // jshint ignore:line
+  this.authorizationEndpoint = payload.authorization_endpoint; // jshint ignore:line
+  this.deviceAuthorizationEndpoint = payload.device_authorization_endpoint; // jshint ignore:line
+  this.tokenEndpoint = payload.token_endpoint; // jshint ignore:line
+  this.userinfoEndpoint = payload.userinfo_endpoint; // jshint ignore:line
+  this.revocationEndpoint = payload.revocation_endpoint; // jshint ignore:line
+  this.jwkUri = payload.jwk_uri; // jshint ignore:line
+  this.responseTypeSupported = payload.response_type_supported; // jshint ignore:line
+  this.subjectTypeSupported = payload.subject_type_supported; // jshint ignore:line
+  this.idTokenSigningAlgValuesSupported = payload.id_token_signing_alg_values_supported; // jshint ignore:line
+  this.scopesSupported = payload.scopes_supported; // jshint ignore:line
+  this.claimsSupported = payload.claims_supported; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {};
+};
+
+Object.defineProperty(OpenidDiscoveryInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new OpenidDiscoveryContext(this._version);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * fetch a OpenidDiscoveryInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Oauth.V1.OpenidDiscoveryInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed OpenidDiscoveryInstance
+ */
+/* jshint ignore:end */
+OpenidDiscoveryInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Oauth.V1.OpenidDiscoveryInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+OpenidDiscoveryInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+OpenidDiscoveryInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the OpenidDiscoveryContext
+ *
+ * @constructor Twilio.Oauth.V1.OpenidDiscoveryContext
+ *
+ * @param {V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+OpenidDiscoveryContext = function OpenidDiscoveryContext(version) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {};
+  this._uri = `/well-known/openid-configuration`;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a OpenidDiscoveryInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Oauth.V1.OpenidDiscoveryContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed OpenidDiscoveryInstance
+ */
+/* jshint ignore:end */
+OpenidDiscoveryContext.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 OpenidDiscoveryInstance(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.OpenidDiscoveryContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+OpenidDiscoveryContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+OpenidDiscoveryContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  OpenidDiscoveryList: OpenidDiscoveryList,
+  OpenidDiscoveryPage: OpenidDiscoveryPage,
+  OpenidDiscoveryInstance: OpenidDiscoveryInstance,
+  OpenidDiscoveryContext: OpenidDiscoveryContext
+};

package/lib/rest/oauth/v1/token.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 TokenList
+ *
+ * @param version - Version of the resource
+ */
+declare function TokenList(version: V1): TokenListInstance;
+
+interface TokenListInstance {
+  /**
+   * create a TokenInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  create(opts: TokenListInstanceCreateOptions, callback?: (error: Error | null, item: TokenInstance) => any): Promise<TokenInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to create
+ *
+ * @property clientSecret - The credential for confidential OAuth App
+ * @property clientSid - A string that uniquely identifies this oauth app
+ * @property code - Jwt token
+ * @property codeVerifier - The cryptographically generated code
+ * @property deviceCode - Jwt token
+ * @property deviceId - An Id of device
+ * @property grantType - A way of representing resource owner's to obtain access token
+ * @property refreshToken - Jwt token
+ */
+interface TokenListInstanceCreateOptions {
+  clientSecret?: string;
+  clientSid: string;
+  code?: string;
+  codeVerifier?: string;
+  deviceCode?: string;
+  deviceId?: string;
+  grantType: string;
+  refreshToken?: string;
+}
+
+interface TokenPayload extends TokenResource, Page.TwilioResponsePayload {
+}
+
+interface TokenResource {
+  access_token: string;
+  access_token_expires_at: Date;
+  id_token: string;
+  refresh_token: string;
+  refresh_token_expires_at: Date;
+}
+
+interface TokenSolution {
+}
+
+
+declare class TokenInstance extends SerializableClass {
+  /**
+   * Initialize the TokenContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   */
+  constructor(version: V1, payload: TokenPayload);
+
+  accessToken: string;
+  accessTokenExpiresAt: Date;
+  idToken: string;
+  refreshToken: string;
+  refreshTokenExpiresAt: Date;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class TokenPage extends Page<V1, TokenPayload, TokenResource, TokenInstance> {
+  /**
+   * Initialize the TokenPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V1, response: Response<string>, solution: TokenSolution);
+
+  /**
+   * Build an instance of TokenInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: TokenPayload): TokenInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { TokenInstance, TokenList, TokenListInstance, TokenListInstanceCreateOptions, TokenPage, TokenPayload, TokenResource, TokenSolution }

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

@@ -0,0 +1,265 @@
+'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 values = require('../../../base/values');  /* jshint ignore:line */
+
+var TokenList;
+var TokenPage;
+var TokenInstance;
+
+/* jshint ignore:start */
+/**
+ * Initialize the TokenList
+ *
+ * @constructor Twilio.Oauth.V1.TokenList
+ *
+ * @param {Twilio.Oauth.V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+TokenList = function TokenList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function token
+   * @memberof Twilio.Oauth.V1#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Oauth.V1.TokenContext}
+   */
+  /* jshint ignore:end */
+  function TokenListInstance(sid) {
+    return TokenListInstance.get(sid);
+  }
+
+  TokenListInstance._version = version;
+  // Path Solution
+  TokenListInstance._solution = {};
+  TokenListInstance._uri = `/token`;
+  /* jshint ignore:start */
+  /**
+   * create a TokenInstance
+   *
+   * @function create
+   * @memberof Twilio.Oauth.V1.TokenList#
+   *
+   * @param {object} opts - Options for request
+   * @param {string} opts.grantType -
+   *          A way of representing resource owner's to obtain access token
+   * @param {string} opts.clientSid -
+   *          A string that uniquely identifies this oauth app
+   * @param {string} [opts.clientSecret] - The credential for confidential OAuth App
+   * @param {string} [opts.code] - Jwt token
+   * @param {string} [opts.codeVerifier] - The cryptographically generated code
+   * @param {string} [opts.deviceCode] - Jwt token
+   * @param {string} [opts.refreshToken] - Jwt token
+   * @param {string} [opts.deviceId] - An Id of device
+   * @param {function} [callback] - Callback to handle processed record
+   *
+   * @returns {Promise} Resolves to processed TokenInstance
+   */
+  /* jshint ignore:end */
+  TokenListInstance.create = function create(opts, callback) {
+    if (_.isUndefined(opts)) {
+      throw new Error('Required parameter "opts" missing.');
+    }
+    if (_.isUndefined(opts['grantType'])) {
+      throw new Error('Required parameter "opts[\'grantType\']" missing.');
+    }
+    if (_.isUndefined(opts['clientSid'])) {
+      throw new Error('Required parameter "opts[\'clientSid\']" missing.');
+    }
+
+    var deferred = Q.defer();
+    var data = values.of({
+      'GrantType': _.get(opts, 'grantType'),
+      'ClientSid': _.get(opts, 'clientSid'),
+      'ClientSecret': _.get(opts, 'clientSecret'),
+      'Code': _.get(opts, 'code'),
+      'CodeVerifier': _.get(opts, 'codeVerifier'),
+      'DeviceCode': _.get(opts, 'deviceCode'),
+      'RefreshToken': _.get(opts, 'refreshToken'),
+      'DeviceId': _.get(opts, 'deviceId')
+    });
+
+    var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
+
+    promise = promise.then(function(payload) {
+      deferred.resolve(new TokenInstance(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.TokenList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  TokenListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  TokenListInstance[util.inspect.custom] = function inspect(depth, options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return TokenListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the TokenPage
+ *
+ * @constructor Twilio.Oauth.V1.TokenPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {TokenSolution} solution - Path solution
+ *
+ * @returns TokenPage
+ */
+/* jshint ignore:end */
+TokenPage = function TokenPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(TokenPage.prototype, Page.prototype);
+TokenPage.prototype.constructor = TokenPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of TokenInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Oauth.V1.TokenPage#
+ *
+ * @param {TokenPayload} payload - Payload response from the API
+ *
+ * @returns TokenInstance
+ */
+/* jshint ignore:end */
+TokenPage.prototype.getInstance = function getInstance(payload) {
+  return new TokenInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Oauth.V1.TokenPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+TokenPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+TokenPage.prototype[util.inspect.custom] = function inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the TokenContext
+ *
+ * @constructor Twilio.Oauth.V1.TokenInstance
+ *
+ * @property {string} accessToken -
+ *          Token which carries the necessary information to access a Twilio resource directly
+ * @property {string} refreshToken -
+ *          Token which carries the information necessary to get a new access token
+ * @property {string} idToken - The id_token
+ * @property {Date} refreshTokenExpiresAt -
+ *          The RFC 2822 date and time in GMT when the refresh token expires
+ * @property {Date} accessTokenExpiresAt -
+ *          The RFC 2822 date and time in GMT when the access token expires
+ *
+ * @param {V1} version - Version of the resource
+ * @param {TokenPayload} payload - The instance payload
+ */
+/* jshint ignore:end */
+TokenInstance = function TokenInstance(version, payload) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.accessToken = payload.access_token; // jshint ignore:line
+  this.refreshToken = payload.refresh_token; // jshint ignore:line
+  this.idToken = payload.id_token; // jshint ignore:line
+  this.refreshTokenExpiresAt = deserialize.iso8601DateTime(payload.refresh_token_expires_at); // jshint ignore:line
+  this.accessTokenExpiresAt = deserialize.iso8601DateTime(payload.access_token_expires_at); // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {};
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Oauth.V1.TokenInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+TokenInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+TokenInstance.prototype[util.inspect.custom] = function inspect(depth, options)
+    {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  TokenList: TokenList,
+  TokenPage: TokenPage,
+  TokenInstance: TokenInstance
+};