twilio 4.0.0 → 4.0.1

package/dist/lib/http/request.js

@@ -1,85 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Request {
-    constructor(opts) {
-        opts = opts || {};
-        this.method = opts.method || this.ANY;
-        this.url = opts.url || this.ANY;
-        this.auth = opts.auth || this.ANY;
-        this.params = opts.params || this.ANY;
-        this.data = opts.data || this.ANY;
-        this.headers = opts.headers || this.ANY;
-    }
-    get ANY() {
-        return "*";
-    }
-    attributeEqual(lhs, rhs) {
-        if (lhs === this.ANY || rhs === this.ANY) {
-            return true;
-        }
-        lhs = lhs || undefined;
-        rhs = rhs || undefined;
-        if (typeof lhs !== typeof rhs) {
-            return false;
-        }
-        if (typeof lhs !== "object") {
-            return lhs === rhs;
-        }
-        return (Object.entries(lhs)
-            .sort((a, b) => a[0].localeCompare(b[0]))
-            .toString() ===
-            Object.entries(rhs)
-                .sort((a, b) => a[0].localeCompare(b[0]))
-                .toString());
-    }
-    isEqual(other) {
-        return (this.attributeEqual(this.method, other.method) &&
-            this.attributeEqual(this.url, other.url) &&
-            this.attributeEqual(this.auth, other.auth) &&
-            this.attributeEqual(this.params, other.params) &&
-            this.attributeEqual(this.data, other.data) &&
-            this.attributeEqual(this.headers, other.headers));
-    }
-    toString() {
-        var auth = "";
-        if (this.auth && this.auth !== this.ANY) {
-            auth = this.auth + " ";
-        }
-        var params = "";
-        if (this.params && this.params !== this.ANY) {
-            params =
-                "?" +
-                    Object.keys(this.params)
-                        .map((key) => function () {
-                        return key + "=" + this.params[key];
-                    }.bind(this)())
-                        .join("&");
-        }
-        var data = "";
-        if (this.data && this.data !== this.ANY) {
-            if (this.method === "get") {
-                data = "\n -G";
-            }
-            data =
-                data +
-                    "\n" +
-                    Object.entries(this.data)
-                        .map((d) => {
-                        return " -d " + d[0] + "=" + d[1];
-                    })
-                        .join("\n");
-        }
-        var headers = "";
-        if (this.headers && this.headers !== this.ANY) {
-            headers =
-                "\n" +
-                    Object.entries(this.headers)
-                        .map((header) => {
-                        return " -H " + header[0] + "=" + header[1];
-                    })
-                        .join("\n");
-        }
-        return auth + this.method + " " + this.url + params + data + headers;
-    }
-}
-exports.default = Request;

package/dist/lib/http/response.d.ts

@@ -1,7 +0,0 @@
-export default class Response<TPayload> {
-    statusCode: number;
-    body: TPayload;
-    headers: any;
-    constructor(statusCode: number, body: TPayload, headers: any);
-    toString(): string;
-}

package/dist/lib/http/response.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Response {
-    constructor(statusCode, body, headers) {
-        this.statusCode = statusCode;
-        this.body = body;
-        this.headers = headers;
-    }
-    toString() {
-        return "HTTP " + this.statusCode + " " + this.body;
-    }
-}
-exports.default = Response;

package/dist/lib/index.d.ts

@@ -1,39 +0,0 @@
-import Twilio from "./rest/Twilio";
-import * as webhooks from "./webhooks/webhooks";
-import RequestClient from "./base/RequestClient";
-import { ClientOpts } from "./base/BaseTwilio";
-import AccessToken from "./jwt/AccessToken";
-import ClientCapability from "./jwt/ClientCapability";
-import TaskRouterCapability from "./jwt/taskrouter/TaskRouterCapability";
-import * as taskRouterUtil from "./jwt/taskrouter/util";
-import VoiceResponse from "./twiml/VoiceResponse";
-import MessagingResponse from "./twiml/MessagingResponse";
-import FaxResponse from "./twiml/FaxResponse";
-interface TwilioSDK extends Function {
-    (accountSid?: string, authToken?: string, opts?: ClientOpts): Twilio;
-    Twilio: typeof Twilio;
-    jwt: {
-        AccessToken: typeof AccessToken;
-        ClientCapability: typeof ClientCapability;
-        taskrouter: {
-            TaskRouterCapability: typeof TaskRouterCapability;
-            util: typeof taskRouterUtil;
-        };
-    };
-    twiml: {
-        VoiceResponse: typeof VoiceResponse;
-        MessagingResponse: typeof MessagingResponse;
-        FaxResponse: typeof FaxResponse;
-    };
-    RequestClient: typeof RequestClient;
-    validateBody: typeof webhooks.validateBody;
-    validateRequest: typeof webhooks.validateRequest;
-    validateRequestWithBody: typeof webhooks.validateRequestWithBody;
-    validateExpressRequest: typeof webhooks.validateExpressRequest;
-    validateIncomingRequest: typeof webhooks.validateIncomingRequest;
-    getExpectedBodyHash: typeof webhooks.getExpectedBodyHash;
-    getExpectedTwilioSignature: typeof webhooks.getExpectedTwilioSignature;
-    webhook: typeof webhooks.webhook;
-}
-declare var initializer: TwilioSDK;
-export = initializer;

package/dist/lib/index.js

@@ -1,89 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const Twilio_1 = __importDefault(require("./rest/Twilio"));
-const webhooks = __importStar(require("./webhooks/webhooks"));
-const RequestClient_1 = __importDefault(require("./base/RequestClient"));
-const AccessToken_1 = __importDefault(require("./jwt/AccessToken"));
-const ClientCapability_1 = __importDefault(require("./jwt/ClientCapability"));
-const TaskRouterCapability_1 = __importDefault(require("./jwt/taskrouter/TaskRouterCapability"));
-const taskRouterUtil = __importStar(require("./jwt/taskrouter/util"));
-const VoiceResponse_1 = __importDefault(require("./twiml/VoiceResponse"));
-const MessagingResponse_1 = __importDefault(require("./twiml/MessagingResponse"));
-const FaxResponse_1 = __importDefault(require("./twiml/FaxResponse"));
-// Shorthand to automatically create a RestClient
-var initializer = function (accountSid, authToken, opts) {
-    return new Twilio_1.default(accountSid, authToken, opts);
-};
-// Main functional components of the Twilio module
-initializer.Twilio = Twilio_1.default;
-initializer.jwt = {};
-initializer.twiml = {};
-initializer.RequestClient = RequestClient_1.default;
-Object.defineProperty(initializer.jwt, "AccessToken", {
-    get: function () {
-        return AccessToken_1.default;
-    },
-});
-Object.defineProperty(initializer.jwt, "ClientCapability", {
-    get: function () {
-        return ClientCapability_1.default;
-    },
-});
-Object.defineProperty(initializer.jwt, "taskrouter", {
-    get: function () {
-        return {
-            TaskRouterCapability: TaskRouterCapability_1.default,
-            util: taskRouterUtil,
-        };
-    },
-});
-Object.defineProperty(initializer.twiml, "VoiceResponse", {
-    get: function () {
-        return VoiceResponse_1.default;
-    },
-});
-Object.defineProperty(initializer.twiml, "MessagingResponse", {
-    get: function () {
-        return MessagingResponse_1.default;
-    },
-});
-Object.defineProperty(initializer.twiml, "FaxResponse", {
-    get: function () {
-        return FaxResponse_1.default;
-    },
-});
-// Setup webhook helper functionality
-initializer.validateBody = webhooks.validateBody;
-initializer.validateRequest = webhooks.validateRequest;
-initializer.validateRequestWithBody = webhooks.validateRequestWithBody;
-initializer.validateIncomingRequest = webhooks.validateIncomingRequest;
-initializer.validateExpressRequest = webhooks.validateExpressRequest;
-initializer.getExpectedBodyHash = webhooks.getExpectedBodyHash;
-initializer.getExpectedTwilioSignature = webhooks.getExpectedTwilioSignature;
-initializer.webhook = webhooks.webhook;
-module.exports = initializer;

package/dist/lib/interfaces.d.ts

@@ -1,94 +0,0 @@
-export type HttpMethod = "get" | "post" | "put" | "patch" | "delete";
-export type Url = string;
-export type PhoneNumber = string;
-export type PhoneNumberCapabilities = {
-    mms: boolean;
-    sms: boolean;
-    voice: boolean;
-    fax: boolean;
-};
-export type Sid = string;
-export interface ListEachOptions<TInstance> {
-    /**
-     * Upper limit for the number of records to return.
-     * each() guarantees never to return more than limit.
-     * Default is no limit
-     */
-    limit?: number;
-    /**
-     * 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)
-     */
-    pageSize?: number;
-    /**
-     * Function to process each record. If this and a positional
-     * callback are passed, this one will be used
-     */
-    callback?: (item: TInstance, done: (err?: Error) => void) => void;
-    /**
-     * Function to be called upon completion of streaming
-     */
-    done?: (err?: Error) => void;
-}
-export interface ListOptions<TInstance> {
-    /**
-     * Upper limit for the number of records to return.
-     * each() guarantees never to return more than limit.
-     * Default is no limit
-     */
-    limit?: number;
-    /**
-     * 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)
-     */
-    pageSize?: number;
-    /**
-     * Callback to handle list of records
-     */
-    callback?: (items: TInstance[]) => void;
-}
-export interface PageOptions<TPage> {
-    /**
-     * PageToken provided by the API
-     */
-    pageToken?: string;
-    /**
-     * Page Number, this value is simply for client state
-     */
-    pageNumber?: number;
-    /**
-     * Number of records to return, defaults to 50
-     */
-    pageSize?: number;
-    /**
-     * Callback to handle list of records
-     */
-    callback?: (page: TPage) => void;
-}
-/**
- * A generic type that returns all property names of a class whose type is not "function"
- */
-export type NonFunctionPropertyNames<T> = {
-    [K in keyof T]: T[K] extends Function ? never : K;
-}[keyof T];
-/**
- * A generic type that returns only properties of a class that are not functions
- */
-export type NonFunctionProperties<T> = Pick<T, NonFunctionPropertyNames<T>>;
-/**
- * A type alias for better readibility
- */
-export type Json<T> = NonFunctionProperties<T>;
-export declare class SerializableClass {
-    /**
-     * Converts the current instance in a regular JSON.
-     * It will be automatically called by JSON.stringify()
-     */
-    toJSON(): Json<this>;
-}

package/dist/lib/interfaces.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/jwt/AccessToken.d.ts

@@ -1,191 +0,0 @@
-export declare abstract class Grant<TOptions, TPayload, TKey> {
-    key?: TKey;
-    constructor(opts?: TOptions);
-    abstract toPayload(): TPayload;
-}
-export interface TaskRouterGrantOptions {
-    workspaceSid?: string;
-    workerSid?: string;
-    role?: string;
-}
-export interface TaskRouterGrantPayload {
-    workspace_sid?: string;
-    worker_sid?: string;
-    role?: string;
-}
-export interface ChatGrantOptions {
-    serviceSid?: string;
-    endpointId?: string;
-    deploymentRoleSid?: string;
-    pushCredentialSid?: string;
-}
-export interface ChatGrantPayload {
-    service_sid?: string;
-    endpoint_id?: string;
-    deployment_role_sid?: string;
-    push_credential_sid?: string;
-}
-export interface VideoGrantOptions {
-    room?: string;
-}
-export interface VideoGrantPayload {
-    room?: string;
-}
-export interface SyncGrantOptions {
-    serviceSid?: string;
-    endpointId?: string;
-}
-export interface SyncGrantPayload {
-    service_sid?: string;
-    endpoint_id?: string;
-}
-export interface VoiceGrantOptions {
-    incomingAllow?: boolean;
-    outgoingApplicationSid?: string;
-    outgoingApplicationParams?: object;
-    pushCredentialSid?: string;
-    endpointId?: string;
-}
-export interface VoiceGrantPayload {
-    incoming?: {
-        allow: boolean;
-    };
-    outgoing?: {
-        application_sid: string;
-        params?: object;
-    };
-    push_credential_sid?: string;
-    endpoint_id?: string;
-}
-export interface PlaybackGrantOptions {
-    grant?: object;
-}
-export interface PlaybackGrantPayload {
-    grant?: object;
-}
-export interface AccessTokenOptions {
-    /**
-     * Time to live in seconds
-     */
-    ttl?: number;
-    /**
-     * The identity of the first person. Required.
-     */
-    identity: string;
-    /**
-     * Time from epoch in seconds for not before value
-     */
-    nbf?: number;
-    /**
-     * The region value associated with this account
-     */
-    region?: string;
-}
-type ALGORITHMS = "HS256" | "HS384" | "HS512";
-declare class TaskRouterGrant extends Grant<TaskRouterGrantOptions, TaskRouterGrantPayload, "task_router"> implements TaskRouterGrantOptions {
-    workspaceSid?: string;
-    workerSid?: string;
-    role?: string;
-    /**
-     * @param options - ...
-     * @param options.workspaceSid - The workspace unique ID
-     * @param options.workerSid - The worker unique ID
-     * @param options.role - The role of the grant
-     */
-    constructor(options?: TaskRouterGrantOptions);
-    toPayload(): TaskRouterGrantPayload;
-}
-export declare class ChatGrant extends Grant<ChatGrantOptions, ChatGrantPayload, "chat"> implements ChatGrantOptions {
-    serviceSid?: string;
-    endpointId?: string;
-    deploymentRoleSid?: string;
-    pushCredentialSid?: string;
-    /**
-     * @param options - ...
-     * @param options.serviceSid - The service unique ID
-     * @param options.endpointId - The endpoint ID
-     * @param options.deploymentRoleSid - SID of the deployment role to be
-     *                 assigned to the user
-     * @param options.pushCredentialSid - The Push Credentials SID
-     */
-    constructor(options?: ChatGrantOptions);
-    toPayload(): ChatGrantPayload;
-}
-declare class VideoGrant extends Grant<VideoGrantOptions, VideoGrantPayload, "video"> implements VideoGrantOptions {
-    room?: string;
-    /**
-     * @param options - ...
-     * @param options.room - The Room name or Room sid.
-     */
-    constructor(options?: VideoGrantOptions);
-    toPayload(): VideoGrantPayload;
-}
-declare class SyncGrant extends Grant<SyncGrantOptions, SyncGrantPayload, "data_sync"> implements SyncGrantOptions {
-    serviceSid?: string;
-    endpointId?: string;
-    /**
-     * @param options.serviceSid - The service unique ID
-     * @param options.endpointId - The endpoint ID
-     */
-    constructor(options?: SyncGrantOptions);
-    toPayload(): SyncGrantPayload;
-}
-declare class VoiceGrant extends Grant<VoiceGrantOptions, VoiceGrantPayload, "voice"> implements VoiceGrantOptions {
-    incomingAllow?: boolean;
-    outgoingApplicationSid?: string;
-    outgoingApplicationParams?: object;
-    pushCredentialSid?: string;
-    endpointId?: string;
-    /**
-     * @param options - ...
-     * @param options.incomingAllow - Whether or not this endpoint is allowed to receive incoming calls as grants.identity
-     * @param options.outgoingApplicationSid - application sid to call when placing outgoing call
-     * @param options.outgoingApplicationParams - request params to pass to the application
-     * @param options.pushCredentialSid - Push Credential Sid to use when registering to receive incoming call notifications
-     * @param options.endpointId - Specify an endpoint identifier for this device, which will allow the developer
-     *                 to direct calls to a specific endpoint when multiple devices are associated with a single identity
-     */
-    constructor(options?: VoiceGrantOptions);
-    toPayload(): VoiceGrantPayload;
-}
-declare class PlaybackGrant extends Grant<PlaybackGrantOptions, PlaybackGrantPayload, "player"> implements PlaybackGrantOptions {
-    grant?: object;
-    /**
-     * @param options - ...
-     * @param options.grant - The PlaybackGrant retrieved from Twilio's API
-     */
-    constructor(options?: PlaybackGrantOptions);
-    toPayload(): PlaybackGrantPayload;
-}
-export default class AccessToken implements AccessTokenOptions {
-    static DEFAULT_ALGORITHM: "HS256";
-    static ALGORITHMS: ALGORITHMS[];
-    static ChatGrant: typeof ChatGrant;
-    static VoiceGrant: typeof VoiceGrant;
-    static SyncGrant: typeof SyncGrant;
-    static VideoGrant: typeof VideoGrant;
-    static TaskRouterGrant: typeof TaskRouterGrant;
-    static PlaybackGrant: typeof PlaybackGrant;
-    accountSid: string;
-    keySid: string;
-    secret: string;
-    ttl: number;
-    identity: string;
-    nbf?: number;
-    region?: string;
-    grants: Grant<any, any, any>[];
-    /**
-     * @param accountSid - The account's unique ID to which access is scoped
-     * @param keySid - The signing key's unique ID
-     * @param secret - The secret to sign the token with
-     * @param options - ...
-     * @param options.ttl - Time to live in seconds (default 3600)
-     * @param options.identity - The identity of the first person. Required.
-     * @param options.nbf - Time from epoch in seconds for not before value
-     * @param options.region - The region value associated with this account
-     */
-    constructor(accountSid: string, keySid: string, secret: string, options: AccessTokenOptions);
-    addGrant<T extends Grant<any, any, any>>(grant: T): void;
-    toJwt(algorithm?: ALGORITHMS): string;
-}
-export {};