twilio 4.0.0 → 4.0.1

package/dist/lib/jwt/AccessToken.js

@@ -1,261 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChatGrant = exports.Grant = void 0;
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-class Grant {
-    constructor(opts) { }
-}
-exports.Grant = Grant;
-class TaskRouterGrant extends Grant {
-    /**
-     * @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) {
-        options = options || {};
-        super(options);
-        this.workspaceSid = options.workspaceSid;
-        this.workerSid = options.workerSid;
-        this.role = options.role;
-        this.key = "task_router";
-    }
-    toPayload() {
-        var grant = {};
-        if (this.workspaceSid) {
-            grant.workspace_sid = this.workspaceSid;
-        }
-        if (this.workerSid) {
-            grant.worker_sid = this.workerSid;
-        }
-        if (this.role) {
-            grant.role = this.role;
-        }
-        return grant;
-    }
-}
-class ChatGrant extends Grant {
-    /**
-     * @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) {
-        options = options || {};
-        super(options);
-        this.serviceSid = options.serviceSid;
-        this.endpointId = options.endpointId;
-        this.deploymentRoleSid = options.deploymentRoleSid;
-        this.pushCredentialSid = options.pushCredentialSid;
-        this.key = "chat";
-    }
-    toPayload() {
-        var grant = {};
-        if (this.serviceSid) {
-            grant.service_sid = this.serviceSid;
-        }
-        if (this.endpointId) {
-            grant.endpoint_id = this.endpointId;
-        }
-        if (this.deploymentRoleSid) {
-            grant.deployment_role_sid = this.deploymentRoleSid;
-        }
-        if (this.pushCredentialSid) {
-            grant.push_credential_sid = this.pushCredentialSid;
-        }
-        return grant;
-    }
-}
-exports.ChatGrant = ChatGrant;
-class VideoGrant extends Grant {
-    /**
-     * @param options - ...
-     * @param options.room - The Room name or Room sid.
-     */
-    constructor(options) {
-        options = options || {};
-        super(options);
-        this.room = options.room;
-        this.key = "video";
-    }
-    toPayload() {
-        var grant = {};
-        if (this.room) {
-            grant.room = this.room;
-        }
-        return grant;
-    }
-}
-class SyncGrant extends Grant {
-    /**
-     * @param options.serviceSid - The service unique ID
-     * @param options.endpointId - The endpoint ID
-     */
-    constructor(options) {
-        options = options || {};
-        super(options);
-        this.serviceSid = options.serviceSid;
-        this.endpointId = options.endpointId;
-        this.key = "data_sync";
-    }
-    toPayload() {
-        var grant = {};
-        if (this.serviceSid) {
-            grant.service_sid = this.serviceSid;
-        }
-        if (this.endpointId) {
-            grant.endpoint_id = this.endpointId;
-        }
-        return grant;
-    }
-}
-class VoiceGrant extends Grant {
-    /**
-     * @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) {
-        options = options || {};
-        super(options);
-        this.incomingAllow = options.incomingAllow;
-        this.outgoingApplicationSid = options.outgoingApplicationSid;
-        this.outgoingApplicationParams = options.outgoingApplicationParams;
-        this.pushCredentialSid = options.pushCredentialSid;
-        this.endpointId = options.endpointId;
-        this.key = "voice";
-    }
-    toPayload() {
-        var grant = {};
-        if (this.incomingAllow === true) {
-            grant.incoming = { allow: true };
-        }
-        if (this.outgoingApplicationSid) {
-            grant.outgoing = {
-                application_sid: this.outgoingApplicationSid,
-            };
-            if (this.outgoingApplicationParams) {
-                grant.outgoing.params = this.outgoingApplicationParams;
-            }
-        }
-        if (this.pushCredentialSid) {
-            grant.push_credential_sid = this.pushCredentialSid;
-        }
-        if (this.endpointId) {
-            grant.endpoint_id = this.endpointId;
-        }
-        return grant;
-    }
-}
-class PlaybackGrant extends Grant {
-    /**
-     * @param options - ...
-     * @param options.grant - The PlaybackGrant retrieved from Twilio's API
-     */
-    constructor(options) {
-        options = options || {};
-        super(options);
-        this.grant = options.grant;
-        this.key = "player";
-    }
-    toPayload() {
-        var grant = {};
-        if (this.grant) {
-            grant = this.grant;
-        }
-        return grant;
-    }
-}
-class AccessToken {
-    /**
-     * @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, keySid, secret, options) {
-        if (!accountSid) {
-            throw new Error("accountSid is required");
-        }
-        if (!keySid) {
-            throw new Error("keySid is required");
-        }
-        if (!secret) {
-            throw new Error("secret is required");
-        }
-        if (!options || !options.identity) {
-            throw new Error("identity is required to be specified in options");
-        }
-        this.accountSid = accountSid;
-        this.keySid = keySid;
-        this.secret = secret;
-        this.ttl = options.ttl || 3600;
-        this.identity = options.identity;
-        this.nbf = options.nbf;
-        this.region = options.region;
-        this.grants = [];
-    }
-    addGrant(grant) {
-        this.grants.push(grant);
-    }
-    toJwt(algorithm) {
-        algorithm = algorithm || AccessToken.DEFAULT_ALGORITHM;
-        if (!AccessToken.ALGORITHMS.includes(algorithm)) {
-            throw new Error("Algorithm not supported. Allowed values are " +
-                AccessToken.ALGORITHMS.join(", "));
-        }
-        var grants = {};
-        if (Number.isInteger(this.identity) || typeof this.identity === "string") {
-            grants.identity = String(this.identity);
-        }
-        for (const grant of this.grants) {
-            grants[grant.key] = grant.toPayload();
-        }
-        var now = Math.floor(Date.now() / 1000);
-        var payload = {
-            jti: this.keySid + "-" + now,
-            grants: grants,
-        };
-        if (typeof this.nbf === "number") {
-            payload.nbf = this.nbf;
-        }
-        var header = {
-            cty: "twilio-fpa;v=1",
-            typ: "JWT",
-        };
-        if (this.region && typeof this.region === "string") {
-            header.twr = this.region;
-        }
-        return jsonwebtoken_1.default.sign(payload, this.secret, {
-            header: header,
-            algorithm: algorithm,
-            issuer: this.keySid,
-            subject: this.accountSid,
-            expiresIn: this.ttl,
-        });
-    }
-}
-exports.default = AccessToken;
-AccessToken.DEFAULT_ALGORITHM = "HS256";
-AccessToken.ALGORITHMS = ["HS256", "HS384", "HS512"];
-AccessToken.ChatGrant = ChatGrant;
-AccessToken.VoiceGrant = VoiceGrant;
-AccessToken.SyncGrant = SyncGrant;
-AccessToken.VideoGrant = VideoGrant;
-AccessToken.TaskRouterGrant = TaskRouterGrant;
-AccessToken.PlaybackGrant = PlaybackGrant;

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

@@ -1,61 +0,0 @@
-export interface Scope {
-    scope: string;
-    payload(): string;
-}
-export interface OutgoingClientScopeOptions {
-    applicationSid: string;
-    clientName?: string;
-    params?: object;
-}
-export interface ClientCapabilityOptions {
-    accountSid: string;
-    authToken: string;
-    ttl?: number;
-}
-/**
- * @param filters
- */
-export declare class EventStreamScope implements Scope {
-    scope: string;
-    filters: object;
-    constructor(filters?: object);
-    payload(): string;
-}
-/**
- * @param clientName
- */
-export declare class IncomingClientScope implements Scope {
-    scope: string;
-    clientName: string;
-    constructor(clientName: string);
-    payload(): string;
-}
-export declare class OutgoingClientScope implements Scope {
-    scope: string;
-    applicationSid: string;
-    clientName?: string;
-    params?: object;
-    /**
-     * @param options - ...
-     * @param options.applicationSid - the application sid
-     * @param options.clientName - the client name
-     * @param options.params - parameters
-     */
-    constructor(options: OutgoingClientScopeOptions);
-    payload(): string;
-}
-/**
- * @param options
- */
-export default class ClientCapability {
-    static EventStreamScope: typeof EventStreamScope;
-    static IncomingClientScope: typeof IncomingClientScope;
-    static OutgoingClientScope: typeof OutgoingClientScope;
-    accountSid: string;
-    authToken: string;
-    ttl: number;
-    scopes: Scope[];
-    constructor(options: ClientCapabilityOptions);
-    addScope(scope: Scope): void;
-    toJwt(): string;
-}

package/dist/lib/jwt/ClientCapability.js

@@ -1,122 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OutgoingClientScope = exports.IncomingClientScope = exports.EventStreamScope = void 0;
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-const querystring_1 = __importDefault(require("querystring"));
-/**
- * @param filters
- */
-class EventStreamScope {
-    constructor(filters) {
-        this.scope = "scope:stream:subscribe";
-        this.filters = filters || {};
-    }
-    payload() {
-        var queryArgs = ["path=/2010-04-01/Events"];
-        if (Object.keys(this.filters).length > 0) {
-            var queryParams = Object.entries(this.filters).map((filter) => {
-                return [querystring_1.default.escape(filter[0]), querystring_1.default.escape(filter[1])].join("=");
-            });
-            var filterParams = queryParams.join("&");
-            queryArgs.push(["appParams", querystring_1.default.escape(filterParams)].join("="));
-        }
-        var queryString = queryArgs.join("&");
-        return [this.scope, queryString].join("?");
-    }
-}
-exports.EventStreamScope = EventStreamScope;
-/**
- * @param clientName
- */
-class IncomingClientScope {
-    constructor(clientName) {
-        this.scope = "scope:client:incoming";
-        this.clientName = clientName;
-    }
-    payload() {
-        var query = ["clientName", querystring_1.default.escape(this.clientName)].join("=");
-        return [this.scope, query].join("?");
-    }
-}
-exports.IncomingClientScope = IncomingClientScope;
-class OutgoingClientScope {
-    /**
-     * @param options - ...
-     * @param options.applicationSid - the application sid
-     * @param options.clientName - the client name
-     * @param options.params - parameters
-     */
-    constructor(options) {
-        this.scope = "scope:client:outgoing";
-        if (!options) {
-            throw new Error('Required parameter "options" missing.');
-        }
-        if (typeof options !== "object") {
-            throw new TypeError('Parameter "options" must be a type Object');
-        }
-        if (!options.applicationSid) {
-            throw new Error('Required parameter "options.applicationSid" missing.');
-        }
-        this.applicationSid = options.applicationSid;
-        this.clientName = options.clientName;
-        this.params = options.params;
-    }
-    payload() {
-        var queryArgs = [["appSid", querystring_1.default.escape(this.applicationSid)].join("=")];
-        if (typeof this.clientName === "string") {
-            queryArgs.push(["clientName", querystring_1.default.escape(this.clientName)].join("="));
-        }
-        if (typeof this.params === "object") {
-            var queryParams = Object.entries(this.params).map((param) => {
-                return [querystring_1.default.escape(param[0]), querystring_1.default.escape(param[1])].join("=");
-            });
-            var filterParams = queryParams.join("&");
-            queryArgs.push(["appParams", querystring_1.default.escape(filterParams)].join("="));
-        }
-        var queryString = queryArgs.join("&");
-        return [this.scope, queryString].join("?");
-    }
-}
-exports.OutgoingClientScope = OutgoingClientScope;
-/**
- * @param options
- */
-class ClientCapability {
-    constructor(options) {
-        if (!options) {
-            throw new Error('Required parameter "options" missing.');
-        }
-        if (typeof options !== "object") {
-            throw new TypeError('Parameter "options" must be a type Object');
-        }
-        if (!options.accountSid) {
-            throw new Error('Required parameter "options.accountSid" missing.');
-        }
-        if (!options.authToken) {
-            throw new Error('Required parameter "options.authToken" missing.');
-        }
-        this.accountSid = options.accountSid;
-        this.authToken = options.authToken;
-        this.ttl = options.ttl || 3600;
-        this.scopes = [];
-    }
-    addScope(scope) {
-        this.scopes.push(scope);
-    }
-    toJwt() {
-        const scope = this.scopes.map((scope) => scope.payload()).join(" ");
-        var payload = {
-            scope: scope,
-            iss: this.accountSid,
-            exp: Math.floor(new Date().valueOf() / 1000) + this.ttl,
-        };
-        return jsonwebtoken_1.default.sign(payload, this.authToken);
-    }
-}
-exports.default = ClientCapability;
-ClientCapability.EventStreamScope = EventStreamScope;
-ClientCapability.IncomingClientScope = IncomingClientScope;
-ClientCapability.OutgoingClientScope = OutgoingClientScope;

package/dist/lib/jwt/taskrouter/TaskRouterCapability.d.ts

@@ -1,74 +0,0 @@
-export interface TaskRouterCapabilityOptions {
-    accountSid: string;
-    authToken: string;
-    workspaceSid: string;
-    channelId: string;
-    friendlyName?: string;
-    ttl?: number;
-    version?: string;
-}
-export interface PolicyOptions {
-    /** Policy URL */
-    url?: string;
-    /** HTTP Method */
-    method?: string;
-    /** Request query filter allowances */
-    queryFilter?: object;
-    /** Request post filter allowances */
-    postFilter?: object;
-    /** Allow the policy */
-    allow?: boolean;
-}
-export interface PolicyPayload {
-    url: string;
-    method: string;
-    query_filter: object;
-    post_filter: object;
-    allow: boolean;
-}
-/**
- * Create a new Policy
- */
-export declare class Policy {
-    url: string;
-    method: string;
-    queryFilter: object;
-    postFilter: object;
-    allow: boolean;
-    /**
-     * Create a new Policy instance
-     *
-     * @param options - ...
-     * @param options.url - Policy URL
-     * @param options.method - HTTP Method
-     * @param options.queryFilter - Request query filter allowances
-     * @param options.postFilter - Request post filter allowances
-     * @param options.allowed - Allow the policy
-     */
-    constructor(options?: PolicyOptions);
-    payload(): PolicyPayload;
-}
-export default class TaskRouterCapability {
-    accountSid: string;
-    authToken: string;
-    workspaceSid: string;
-    channelId: string;
-    ttl: number;
-    version: string;
-    policies: Policy[];
-    friendlyName?: string;
-    /**
-     * @param options - ...
-     * @param options.accountSid - account sid
-     * @param options.authToken - auth token
-     * @param options.workspaceSid - workspace sid
-     * @param options.channelId - taskrouter channel id
-     * @param options.friendlyName - friendly name for the jwt
-     * @param options.ttl - time to live
-     * @param options.version - taskrouter version
-     */
-    constructor(options: TaskRouterCapabilityOptions);
-    static Policy: typeof Policy;
-    addPolicy(policy: Policy): void;
-    toJwt(): string;
-}

package/dist/lib/jwt/taskrouter/TaskRouterCapability.js

@@ -1,101 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Policy = void 0;
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-/**
- * Create a new Policy
- */
-class Policy {
-    /**
-     * Create a new Policy instance
-     *
-     * @param options - ...
-     * @param options.url - Policy URL
-     * @param options.method - HTTP Method
-     * @param options.queryFilter - Request query filter allowances
-     * @param options.postFilter - Request post filter allowances
-     * @param options.allowed - Allow the policy
-     */
-    constructor(options) {
-        options = options || {};
-        this.url = options.url || "";
-        this.method = options.method || "GET";
-        this.queryFilter = options.queryFilter || {};
-        this.postFilter = options.postFilter || {};
-        this.allow = options.allow || true;
-    }
-    payload() {
-        return {
-            url: this.url,
-            method: this.method,
-            query_filter: this.queryFilter,
-            post_filter: this.postFilter,
-            allow: this.allow,
-        };
-    }
-}
-exports.Policy = Policy;
-class TaskRouterCapability {
-    /**
-     * @param options - ...
-     * @param options.accountSid - account sid
-     * @param options.authToken - auth token
-     * @param options.workspaceSid - workspace sid
-     * @param options.channelId - taskrouter channel id
-     * @param options.friendlyName - friendly name for the jwt
-     * @param options.ttl - time to live
-     * @param options.version - taskrouter version
-     */
-    constructor(options) {
-        if (!options) {
-            throw new Error('Required parameter "options" missing.');
-        }
-        if (!options.accountSid) {
-            throw new Error('Required parameter "options.accountSid" missing.');
-        }
-        if (!options.authToken) {
-            throw new Error('Required parameter "options.authToken" missing.');
-        }
-        if (!options.workspaceSid) {
-            throw new Error('Required parameter "options.workspaceSid" missing.');
-        }
-        if (!options.channelId) {
-            throw new Error('Required parameter "options.channelId" missing.');
-        }
-        this.accountSid = options.accountSid;
-        this.authToken = options.authToken;
-        this.workspaceSid = options.workspaceSid;
-        this.channelId = options.channelId;
-        this.friendlyName = options.friendlyName;
-        this.ttl = options.ttl || 3600;
-        this.version = options.version || "v1";
-        this.policies = [];
-    }
-    addPolicy(policy) {
-        this.policies.push(policy);
-    }
-    toJwt() {
-        var payload = {
-            iss: this.accountSid,
-            exp: Math.floor(new Date().valueOf() / 1000) + this.ttl,
-            version: this.version,
-            friendly_name: this.friendlyName,
-            account_sid: this.accountSid,
-            channel: this.channelId,
-            workspace_sid: this.workspaceSid,
-            policies: this.policies.map((policy) => policy.payload()),
-        };
-        if (this.channelId.startsWith("WK")) {
-            payload.worker_sid = this.channelId;
-        }
-        else if (this.channelId.startsWith("WQ")) {
-            payload.taskqueue_sid = this.channelId;
-        }
-        return jsonwebtoken_1.default.sign(payload, this.authToken);
-    }
-}
-exports.default = TaskRouterCapability;
-TaskRouterCapability.Policy = Policy;

package/dist/lib/jwt/taskrouter/util.d.ts

@@ -1,66 +0,0 @@
-import { Policy } from "./TaskRouterCapability";
-/**
- * Build the default Policies for a worker
- *
- * @param version - TaskRouter version
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid
- * @returns list of Policies
- */
-export declare function defaultWorkerPolicies(version: string, workspaceSid: string, workerSid: string): Policy[];
-/**
- * Build the default Event Bridge Policies
- *
- * @param accountSid - account sid
- * @param channelId - channel id
- * @returns list of Policies
- */
-export declare function defaultEventBridgePolicies(accountSid: string, channelId: string): Policy[];
-/**
- * Generate TaskRouter workspace url
- *
- * @param workspaceSid - workspace sid or '**' for all workspaces
- * @returns generated url
- */
-export declare function workspacesUrl(workspaceSid?: string): string;
-/**
- * Generate TaskRouter task queue url
- *
- * @param workspaceSid - workspace sid
- * @param taskQueueSid - task queue sid or '**' for all task queues
- * @returns generated url
- */
-export declare function taskQueuesUrl(workspaceSid: string, taskQueueSid?: string): string;
-/**
- * Generate TaskRouter task url
- *
- * @param workspaceSid - workspace sid
- * @param taskSid - task sid or '**' for all tasks
- * @returns generated url
- */
-export declare function tasksUrl(workspaceSid: string, taskSid?: string): string;
-/**
- * Generate TaskRouter activity url
- *
- * @param workspaceSid - workspace sid
- * @param activitySid - activity sid or '**' for all activities
- * @returns generated url
- */
-export declare function activitiesUrl(workspaceSid: string, activitySid?: string): string;
-/**
- * Generate TaskRouter worker url
- *
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid or '**' for all workers
- * @returns generated url
- */
-export declare function workersUrl(workspaceSid: string, workerSid?: string): string;
-/**
- * Generate TaskRouter worker reservation url
- *
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid
- * @param reservationSid - reservation sid or '**' for all reservations
- * @returns generated url
- */
-export declare function reservationsUrl(workspaceSid: string, workerSid: string, reservationSid?: string): string;