twilio 4.6.0 → 4.7.0

package/lib/base/Page.d.ts

@@ -0,0 +1,104 @@
+import Version from "./Version";
+import Response from "../http/response";
+export interface TwilioResponsePayload {
+    [key: string]: any;
+    first_page_uri: string;
+    next_page_uri: string;
+    page: number;
+    page_size: number;
+    previous_page_uri: string;
+    uri: string;
+    meta?: {
+        key?: string;
+        next_page_url?: string;
+        previous_page_url?: string;
+    };
+}
+interface Solution {
+    [name: string]: any;
+}
+export default class Page<TVersion extends Version, TPayload extends TwilioResponsePayload, TResource, TInstance> {
+    nextPageUrl?: string;
+    previousPageUrl?: string;
+    instances: TInstance[];
+    _version: TVersion;
+    _payload: TPayload;
+    _solution: Solution;
+    /**
+     *
+     * Base page object to maintain request state.
+     *
+     * @param version - A twilio version instance
+     * @param response - The http response
+     * @param solution - path solution
+     */
+    constructor(version: TVersion, response: Response<string | TPayload>, solution: Solution);
+    /**
+     * Meta keys returned in a list request
+     *
+     * @constant META_KEYS
+     */
+    static META_KEYS: string[];
+    /**
+     * Get the url of the previous page of records
+     *
+     * @returns url of the previous page, or undefined if the
+     * previous page URI/URL is not defined.
+     */
+    getPreviousPageUrl(): string | undefined;
+    /**
+     * Get the url of the next page of records
+     *
+     * @returns url of the next page, or undefined if the
+     * next page URI/URL is not defined.
+     */
+    getNextPageUrl(): string | undefined;
+    /**
+     * Build a new instance given a json payload
+     *
+     * @param payload - Payload response from the API
+     * @returns instance of a resource
+     */
+    getInstance(payload: any): TInstance;
+    /**
+     * Load a list of records
+     *
+     * @param resources - json payload of records
+     * @returns list of resources
+     */
+    loadInstances(resources: TResource[]): TInstance[];
+    /**
+     * Fetch the next page of records
+     *
+     * @returns promise that resolves to next page of results,
+     * or undefined if there isn't a nextPageUrl undefined.
+     */
+    nextPage(): Promise<Page<TVersion, TPayload, TResource, TInstance>> | undefined;
+    /**
+     * Fetch the previous page of records
+     *
+     * @returns promise that resolves to previous page of
+     * results, or undefined if there isn't a previousPageUrl undefined.
+     */
+    previousPage(): Promise<Page<TVersion, TPayload, TResource, TInstance>> | undefined;
+    /**
+     * Parse json response from API
+     *
+     * @param response - API response
+     *
+     * @throws Error If non 200 status code is returned
+     *
+     * @returns json parsed response
+     */
+    processResponse(response: Response<string | TPayload>): TPayload;
+    /**
+     * Load a page of records
+     *
+     * @param  {object} payload json payload
+     * @return {array} the page of records
+     */
+    loadPage(payload: TPayload): TResource[];
+    forOwn(obj: object, iteratee: (val: any, key: string, object: object) => void): void;
+    toJSON(): object;
+}
+export {};

package/lib/base/Page.js

@@ -1,187 +1,192 @@
-// jscs:disable requireCamelCaseOrUpperCaseIdentifiers
-'use strict';
-
-var _ = require('lodash');
-var RestException = require('./RestException');
-
-/**
- * @constructor
- *
- * @description Base page object to maintain request state.
- *
- * @param {Version} version - A twilio version instance
- * @param {Object} response - The http response
- * @param {Object} solution - path solution
- */
-function Page(version, response, solution) {
-  var payload = this.processResponse(response);
-
-  this._version = version;
-  this._payload = payload;
-  this._solution = solution;
-
-  this.nextPageUrl = this.getNextPageUrl();
-  this.previousPageUrl = this.getPreviousPageUrl();
-
-  this.instances = this.loadInstances(this.loadPage(payload));
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const RestException_1 = __importDefault(require("./RestException"));
+class Page {
+    /**
+     *
+     * Base page object to maintain request state.
+     *
+     * @param version - A twilio version instance
+     * @param response - The http response
+     * @param solution - path solution
+     */
+    constructor(version, response, solution) {
+        let payload = this.processResponse(response);
+        this._version = version;
+        this._payload = payload;
+        this._solution = solution;
+        this.nextPageUrl = this.getNextPageUrl();
+        this.previousPageUrl = this.getPreviousPageUrl();
+        this.instances = this.loadInstances(this.loadPage(payload));
+    }
+    /**
+     * Get the url of the previous page of records
+     *
+     * @returns url of the previous page, or undefined if the
+     * previous page URI/URL is not defined.
+     */
+    getPreviousPageUrl() {
+        if (this._payload.meta &&
+            "previous_page_url" in this._payload.meta &&
+            this._payload.meta.previous_page_url) {
+            // jshint ignore:line
+            return this._payload.meta.previous_page_url; // jshint ignore:line
+        }
+        if ("previous_page_uri" in this._payload &&
+            this._payload.previous_page_uri) {
+            // jshint ignore:line
+            return this._version._domain.absoluteUrl(this._payload.previous_page_uri); // jshint ignore:line
+        }
+        return undefined;
+    }
+    /**
+     * Get the url of the next page of records
+     *
+     * @returns url of the next page, or undefined if the
+     * next page URI/URL is not defined.
+     */
+    getNextPageUrl() {
+        if (this._payload.meta &&
+            "next_page_url" in this._payload.meta &&
+            this._payload.meta.next_page_url) {
+            // jshint ignore:line
+            return this._payload.meta.next_page_url; // jshint ignore:line
+        }
+        if ("next_page_uri" in this._payload && this._payload.next_page_uri) {
+            // jshint ignore:line
+            return this._version._domain.absoluteUrl(this._payload.next_page_uri); // jshint ignore:line
+        }
+        return undefined;
+    }
+    /**
+     * Build a new instance given a json payload
+     *
+     * @param payload - Payload response from the API
+     * @returns instance of a resource
+     */
+    getInstance(payload) {
+        throw new Error("Page.get_instance() must be implemented in the derived class");
+    }
+    /**
+     * Load a list of records
+     *
+     * @param resources - json payload of records
+     * @returns list of resources
+     */
+    loadInstances(resources) {
+        let instances = [];
+        resources.forEach((resource) => {
+            instances.push(this.getInstance(resource));
+        });
+        return instances;
+    }
+    /**
+     * Fetch the next page of records
+     *
+     * @returns promise that resolves to next page of results,
+     * or undefined if there isn't a nextPageUrl undefined.
+     */
+    nextPage() {
+        if (!this.nextPageUrl) {
+            return undefined;
+        }
+        var reqPromise = this._version._domain.twilio.request({
+            method: "get",
+            uri: this.nextPageUrl,
+        });
+        var nextPagePromise = reqPromise.then(function (response) {
+            return new this.constructor(this._version, response, this._solution);
+        }.bind(this));
+        return nextPagePromise;
+    }
+    /**
+     * Fetch the previous page of records
+     *
+     * @returns promise that resolves to previous page of
+     * results, or undefined if there isn't a previousPageUrl undefined.
+     */
+    previousPage() {
+        if (!this.previousPageUrl) {
+            return undefined;
+        }
+        var reqPromise = this._version._domain.twilio.request({
+            method: "get",
+            uri: this.previousPageUrl,
+        });
+        var prevPagePromise = reqPromise.then(function (response) {
+            return new this.constructor(this._version, response, this._solution);
+        }.bind(this));
+        return prevPagePromise;
+    }
+    /**
+     * Parse json response from API
+     *
+     * @param response - API response
+     *
+     * @throws Error If non 200 status code is returned
+     *
+     * @returns json parsed response
+     */
+    processResponse(response) {
+        if (response.statusCode !== 200) {
+            throw new RestException_1.default(response);
+        }
+        if (typeof response.body === "string") {
+            return JSON.parse(response.body);
+        }
+        return response.body;
+    }
+    /**
+     * Load a page of records
+     *
+     * @param  {object} payload json payload
+     * @return {array} the page of records
+     */
+    loadPage(payload) {
+        if (payload.meta?.key) {
+            return payload[payload.meta.key];
+        }
+        const keys = Object.keys(payload).filter((key) => !Page.META_KEYS.includes(key));
+        if (keys.length === 1) {
+            return payload[keys[0]];
+        }
+        throw new Error("Page Records cannot be deserialized");
+    }
+    forOwn(obj, iteratee) {
+        obj = Object(obj);
+        for (const [key, val] of Object.entries(obj)) {
+            iteratee(val, key, obj);
+        }
+    }
+    toJSON() {
+        const clone = {};
+        this.forOwn(this, (value, key) => {
+            if (!key.startsWith("_") && typeof value !== "function") {
+                clone[key] = value;
+            }
+        });
+        return clone;
+    }
 }
-
+exports.default = Page;
 /**
+ * Meta keys returned in a list request
+ *
  * @constant META_KEYS
- * @description meta keys returned in a list request
  */
-Page.prototype.META_KEYS = [
-  'end',
-  'first_page_uri',
-  'last_page_uri',
-  'next_page_uri',
-  'num_pages',
-  'page',
-  'page_size',
-  'previous_page_uri',
-  'start',
-  'total',
-  'uri',
+Page.META_KEYS = [
+    "end",
+    "first_page_uri",
+    "last_page_uri",
+    "next_page_uri",
+    "num_pages",
+    "page",
+    "page_size",
+    "previous_page_uri",
+    "start",
+    "total",
+    "uri",
 ];
-
-/**
- * Get the url of the previous page of records
- *
- * @return {string|undefined} url of the previous page
- */
-Page.prototype.getPreviousPageUrl = function() {
-  if ('meta' in this._payload && 'previous_page_url' in this._payload.meta && this._payload.previous_page_url) { // jshint ignore:line
-    return this._payload.meta.previous_page_url; // jshint ignore:line
-  }
-
-  if ('previous_page_uri' in this._payload && this._payload.previous_page_uri) { // jshint ignore:line
-    return this._version._domain.absoluteUrl(this._payload.previous_page_uri); // jshint ignore:line
-  }
-
-  return undefined;
-};
-
-/**
- * Get the url of the next page of records
- *
- * @return {string|undefined} url of the next page
- */
-Page.prototype.getNextPageUrl = function() {
-  if ('meta' in this._payload && 'next_page_url' in this._payload.meta && this._payload.meta.next_page_url) { // jshint ignore:line
-    return this._payload.meta.next_page_url; // jshint ignore:line
-  }
-
-  if ('next_page_uri' in this._payload && this._payload.next_page_uri) { // jshint ignore:line
-    return this._version._domain.absoluteUrl(this._payload.next_page_uri); // jshint ignore:line
-  }
-
-  return undefined;
-};
-
-/**
- * Build a new instance given a json payload
- * @abstract
- *
- * @param {object} payload - Payload response from the API
- * @return {object} instance of a resource
- */
-Page.prototype.getInstance = function(payload) {
-  throw new Error('Page.get_instance() must be implemented in the derived class');
-};
-
-/**
- * Load a list of records
- *
- * @param  {object} resources json payload of records
- * @return {Array} list of resources
- */
-Page.prototype.loadInstances = function(resources) {
-  return _.map(resources, function(resource) {
-    return this.getInstance(resource);
-  }.bind(this));
-};
-
-/**
- * Fetch the next page of records
- *
- * @return {promise} promise that resolves to next page of results
- */
-Page.prototype.nextPage = function() {
-  if (!this.nextPageUrl) {
-    return undefined;
-  }
-
-  var promise = this._version._domain.twilio.request({
-    method: 'GET',
-    uri: this.nextPageUrl,
-  });
-
-  promise = promise.then(function(response) {
-    return new this.constructor(this._version, response, this._solution);
-  }.bind(this));
-
-  return promise;
-};
-
-/**
- * Fetch the previous page of records
- *
- * @return {promise} promise that resolves to previous page of results
- */
-Page.prototype.previousPage = function() {
-  if (!this.previousPageUrl) {
-    return undefined;
-  }
-
-  var promise = this._version._domain.twilio.request({
-    method: 'GET',
-    uri: this.previousPageUrl,
-  });
-
-  promise = promise.then(function(response) {
-    return new this.constructor(this._version, response, this._solution);
-  }.bind(this));
-
-  return promise;
-};
-
-/**
- * Parse json response from API
- * @throws {Error} If non 200 status code is returned
- *
- * @param  {object} response API response
- * @return {object} json parsed response
- */
-Page.prototype.processResponse = function(response) {
-  if (response.statusCode !== 200) {
-    throw new RestException(response);
-  }
-
-  return JSON.parse(response.body);
-};
-
-/**
- * Load a page of records
- * @throws {Error} If records cannot be deserialized
- *
- * @param  {object} payload json payload
- * @return {array} the page of records
- */
-Page.prototype.loadPage = function(payload) {
-  if ('meta' in payload && 'key' in payload.meta) {
-    return payload[payload.meta.key];
-  }
-
-  var keys = _.chain(payload)
-      .keys()
-      .difference(this.META_KEYS)
-      .value();
-
-  if (keys.length === 1) {
-    return payload[keys[0]];
-  }
-
-  throw new Error('Page Records cannot be deserialized');
-};
-
-module.exports = Page;

package/lib/base/RequestClient.d.ts

@@ -0,0 +1,145 @@
+/// <reference types="node" />
+import { HttpMethod } from "../interfaces";
+import { AxiosInstance } from "axios";
+import Response from "../http/response";
+import Request, { Headers } from "../http/request";
+declare class RequestClient {
+    defaultTimeout: number;
+    axios: AxiosInstance;
+    lastResponse?: Response<any>;
+    lastRequest?: Request<any>;
+    autoRetry: boolean;
+    maxRetryDelay: number;
+    maxRetries: number;
+    /**
+     * Make http request
+     * @param opts - The options passed to https.Agent
+     * @param opts.timeout - https.Agent timeout option. Used as the socket timeout, AND as the default request timeout.
+     * @param opts.keepAlive - https.Agent keepAlive option
+     * @param opts.keepAliveMsecs - https.Agent keepAliveMsecs option
+     * @param opts.maxSockets - https.Agent maxSockets option
+     * @param opts.maxTotalSockets - https.Agent maxTotalSockets option
+     * @param opts.maxFreeSockets - https.Agent maxFreeSockets option
+     * @param opts.scheduling - https.Agent scheduling option
+     * @param opts.autoRetry - Enable auto-retry requests with exponential backoff on 429 responses. Defaults to false.
+     * @param opts.maxRetryDelay - Max retry delay in milliseconds for 429 Too Many Request response retries. Defaults to 3000.
+     * @param opts.maxRetries - Max number of request retries for 429 Too Many Request responses. Defaults to 3.
+     */
+    constructor(opts?: RequestClient.RequestClientOptions);
+    /**
+     * Make http request
+     * @param opts - The options argument
+     * @param opts.method - The http method
+     * @param opts.uri - The request uri
+     * @param opts.username - The username used for auth
+     * @param opts.password - The password used for auth
+     * @param opts.headers - The request headers
+     * @param opts.params - The request params
+     * @param opts.data - The request data
+     * @param opts.timeout - The request timeout in milliseconds (default 30000)
+     * @param opts.allowRedirects - Should the client follow redirects
+     * @param opts.forever - Set to true to use the forever-agent
+     * @param opts.logLevel - Show debug logs
+     */
+    request<TData>(opts: RequestClient.RequestOptions<TData>): Promise<Response<TData>>;
+    filterLoggingHeaders(headers: Headers): string[];
+    private logRequest;
+}
+declare namespace RequestClient {
+    interface RequestOptions<TData = any, TParams = object> {
+        /**
+         * The HTTP method
+         */
+        method: HttpMethod;
+        /**
+         * The request URI
+         */
+        uri: string;
+        /**
+         * The username used for auth
+         */
+        username?: string;
+        /**
+         * The password used for auth
+         */
+        password?: string;
+        /**
+         * The request headers
+         */
+        headers?: Headers;
+        /**
+         * The object of params added as query string to the request
+         */
+        params?: TParams;
+        /**
+         * The form data that should be submitted
+         */
+        data?: TData;
+        /**
+         * The request timeout in milliseconds
+         */
+        timeout?: number;
+        /**
+         * Should the client follow redirects
+         */
+        allowRedirects?: boolean;
+        /**
+         * Set to true to use the forever-agent
+         */
+        forever?: boolean;
+        /**
+         * Set to 'debug' to enable debug logging
+         */
+        logLevel?: string;
+    }
+    interface RequestClientOptions {
+        /**
+         * A timeout in milliseconds. This will be used as the HTTPS agent's socket
+         * timeout, AND as the default request timeout.
+         */
+        timeout?: number;
+        /**
+         * https.Agent keepAlive option
+         */
+        keepAlive?: boolean;
+        /**
+         * https.Agent keepAliveMSecs option
+         */
+        keepAliveMsecs?: number;
+        /**
+         * https.Agent maxSockets option
+         */
+        maxSockets?: number;
+        /**
+         * https.Agent maxTotalSockets option
+         */
+        maxTotalSockets?: number;
+        /**
+         * https.Agent maxFreeSockets option
+         */
+        maxFreeSockets?: number;
+        /**
+         * https.Agent scheduling option
+         */
+        scheduling?: "fifo" | "lifo" | undefined;
+        /**
+         * The private CA certificate bundle (if private SSL certificate)
+         */
+        ca?: string | Buffer;
+        /**
+         * Enable auto-retry with exponential backoff when receiving 429 Errors from
+         * the API. Disabled by default.
+         */
+        autoRetry?: boolean;
+        /**
+         * Maximum retry delay in milliseconds for 429 Error response retries.
+         * Defaults to 3000.
+         */
+        maxRetryDelay?: number;
+        /**
+         * Maximum number of request retries for 429 Error responses. Defaults to 3.
+         */
+        maxRetries?: number;
+    }
+}
+export = RequestClient;