twilio 4.7.2 → 4.9.0

package/lib/base/BaseTwilio.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import RequestClient from "./RequestClient";
 import { HttpMethod } from "../interfaces";
+import { Headers } from "../http/request";
 declare namespace Twilio {
     interface ClientOpts {
         httpClient?: RequestClient;

package/lib/index.d.ts

@@ -1,39 +1,55 @@
-import Twilio from "./rest/Twilio";
+import ITwilio 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 IRequestClient from "./base/RequestClient";
+import type { ClientOpts as IClientOpts } from "./base/BaseTwilio";
+import IAccessToken from "./jwt/AccessToken";
+import IClientCapability from "./jwt/ClientCapability";
+import ITaskRouterCapability 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;
+import IVoiceResponse from "./twiml/VoiceResponse";
+import IMessagingResponse from "./twiml/MessagingResponse";
+import IFaxResponse from "./twiml/FaxResponse";
+declare function TwilioSDK(accountSid?: string, authToken?: string, opts?: IClientOpts): TwilioSDK.Twilio;
+declare namespace TwilioSDK {
+    type Twilio = ITwilio;
+    const Twilio: typeof ITwilio;
+    namespace jwt {
+        type AccessToken = IAccessToken;
+        const AccessToken: typeof IAccessToken;
+        type ClientCapability = IClientCapability;
+        const ClientCapability: typeof IClientCapability;
+        namespace taskrouter {
+            type TaskRouterCapability = ITaskRouterCapability;
+            const TaskRouterCapability: typeof ITaskRouterCapability;
+            const util: typeof taskRouterUtil;
+        }
+    }
+    namespace twiml {
+        type VoiceResponse = IVoiceResponse;
+        const VoiceResponse: typeof IVoiceResponse;
+        type MessagingResponse = IMessagingResponse;
+        const MessagingResponse: typeof IMessagingResponse;
+        type FaxResponse = IFaxResponse;
+        const FaxResponse: typeof IFaxResponse;
+    }
+    type RequestClient = IRequestClient;
+    const RequestClient: typeof IRequestClient;
+    type validateBody = typeof webhooks.validateBody;
+    const validateBody: typeof webhooks.validateBody;
+    type validateRequest = typeof webhooks.validateRequest;
+    const validateRequest: typeof webhooks.validateRequest;
+    type validateRequestWithBody = typeof webhooks.validateRequestWithBody;
+    const validateRequestWithBody: typeof webhooks.validateRequestWithBody;
+    type validateExpressRequest = typeof webhooks.validateExpressRequest;
+    const validateExpressRequest: typeof webhooks.validateExpressRequest;
+    type validateIncomingRequest = typeof webhooks.validateIncomingRequest;
+    const validateIncomingRequest: typeof webhooks.validateIncomingRequest;
+    type getExpectedBodyHash = typeof webhooks.getExpectedBodyHash;
+    const getExpectedBodyHash: typeof webhooks.getExpectedBodyHash;
+    type getExpectedTwilioSignature = typeof webhooks.getExpectedTwilioSignature;
+    const getExpectedTwilioSignature: typeof webhooks.getExpectedTwilioSignature;
+    type webhook = typeof webhooks.webhook;
+    const webhook: typeof webhooks.webhook;
+    type ClientOpts = IClientOpts;
 }
-declare var initializer: TwilioSDK;
-export = initializer;
+export = TwilioSDK;

package/lib/index.js

@@ -36,54 +36,35 @@ 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;
+function TwilioSDK(accountSid, authToken, opts) {
+    return new TwilioSDK.Twilio(accountSid, authToken, opts);
+}
+(function (TwilioSDK) {
+    TwilioSDK.Twilio = Twilio_1.default;
+    let jwt;
+    (function (jwt) {
+        jwt.AccessToken = AccessToken_1.default;
+        jwt.ClientCapability = ClientCapability_1.default;
+        let taskrouter;
+        (function (taskrouter) {
+            taskrouter.TaskRouterCapability = TaskRouterCapability_1.default;
+            taskrouter.util = taskRouterUtil;
+        })(taskrouter = jwt.taskrouter || (jwt.taskrouter = {}));
+    })(jwt = TwilioSDK.jwt || (TwilioSDK.jwt = {}));
+    let twiml;
+    (function (twiml) {
+        twiml.VoiceResponse = VoiceResponse_1.default;
+        twiml.MessagingResponse = MessagingResponse_1.default;
+        twiml.FaxResponse = FaxResponse_1.default;
+    })(twiml = TwilioSDK.twiml || (TwilioSDK.twiml = {}));
+    TwilioSDK.RequestClient = RequestClient_1.default;
+    TwilioSDK.validateBody = webhooks.validateBody;
+    TwilioSDK.validateRequest = webhooks.validateRequest;
+    TwilioSDK.validateRequestWithBody = webhooks.validateRequestWithBody;
+    TwilioSDK.validateExpressRequest = webhooks.validateExpressRequest;
+    TwilioSDK.validateIncomingRequest = webhooks.validateIncomingRequest;
+    TwilioSDK.getExpectedBodyHash = webhooks.getExpectedBodyHash;
+    TwilioSDK.getExpectedTwilioSignature = webhooks.getExpectedTwilioSignature;
+    TwilioSDK.webhook = webhooks.webhook;
+})(TwilioSDK || (TwilioSDK = {}));
+module.exports = TwilioSDK;

package/lib/jwt/AccessToken.d.ts

@@ -1,171 +1,6 @@
-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 {
+declare class AccessToken implements AccessToken.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;
+    static ALGORITHMS: string[];
     accountSid: string;
     keySid: string;
     secret: string;
@@ -173,7 +8,7 @@ export default class AccessToken implements AccessTokenOptions {
     identity: string;
     nbf?: number;
     region?: string;
-    grants: Grant<any, any, any>[];
+    grants: AccessToken.Grant<any, any, any>[];
     /**
      * @param accountSid - The account's unique ID to which access is scoped
      * @param keySid - The signing key's unique ID
@@ -184,8 +19,168 @@ export default class AccessToken implements AccessTokenOptions {
      * @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 {};
+    constructor(accountSid: string, keySid: string, secret: string, options: AccessToken.AccessTokenOptions);
+    addGrant<T extends AccessToken.Grant<any, any, any>>(grant: T): void;
+    toJwt(algorithm?: "HS256" | "HS384" | "HS512"): string;
+}
+declare namespace AccessToken {
+    abstract class Grant<TOptions, TPayload, TKey> {
+        key: TKey;
+        protected constructor(key: TKey);
+        abstract toPayload(): TPayload;
+    }
+    interface TaskRouterGrantOptions {
+        workspaceSid?: string;
+        workerSid?: string;
+        role?: string;
+    }
+    interface TaskRouterGrantPayload {
+        workspace_sid?: string;
+        worker_sid?: string;
+        role?: string;
+    }
+    interface ChatGrantOptions {
+        serviceSid?: string;
+        endpointId?: string;
+        deploymentRoleSid?: string;
+        pushCredentialSid?: string;
+    }
+    interface ChatGrantPayload {
+        service_sid?: string;
+        endpoint_id?: string;
+        deployment_role_sid?: string;
+        push_credential_sid?: string;
+    }
+    interface VideoGrantOptions {
+        room?: string;
+    }
+    interface VideoGrantPayload {
+        room?: string;
+    }
+    interface SyncGrantOptions {
+        serviceSid?: string;
+        endpointId?: string;
+    }
+    interface SyncGrantPayload {
+        service_sid?: string;
+        endpoint_id?: string;
+    }
+    interface VoiceGrantOptions {
+        incomingAllow?: boolean;
+        outgoingApplicationSid?: string;
+        outgoingApplicationParams?: object;
+        pushCredentialSid?: string;
+        endpointId?: string;
+    }
+    interface VoiceGrantPayload {
+        incoming?: {
+            allow: boolean;
+        };
+        outgoing?: {
+            application_sid: string;
+            params?: object;
+        };
+        push_credential_sid?: string;
+        endpoint_id?: string;
+    }
+    interface PlaybackGrantOptions {
+        grant?: object;
+    }
+    interface PlaybackGrantPayload {
+        grant?: object;
+    }
+    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;
+    }
+    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;
+    }
+    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;
+    }
+    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;
+    }
+    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;
+    }
+    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;
+    }
+    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 = AccessToken;