twilio 5.5.0 → 5.5.2

package/lib/rest/iam/V1.d.ts

@@ -3,6 +3,7 @@ import Version from "../../base/Version";
 import { ApiKeyListInstance } from "./v1/apiKey";
 import { GetApiKeysListInstance } from "./v1/getApiKeys";
 import { NewApiKeyListInstance } from "./v1/newApiKey";
+import { TokenListInstance } from "./v1/token";
 export default class V1 extends Version {
     /**
      * Initialize the V1 version of Iam
@@ -16,10 +17,14 @@ export default class V1 extends Version {
     protected _getApiKeys?: GetApiKeysListInstance;
     /** newApiKey - { Twilio.Iam.V1.NewApiKeyListInstance } resource */
     protected _newApiKey?: NewApiKeyListInstance;
+    /** token - { Twilio.Iam.V1.TokenListInstance } resource */
+    protected _token?: TokenListInstance;
     /** Getter for apiKey resource */
     get apiKey(): ApiKeyListInstance;
     /** Getter for getApiKeys resource */
     get getApiKeys(): GetApiKeysListInstance;
     /** Getter for newApiKey resource */
     get newApiKey(): NewApiKeyListInstance;
+    /** Getter for token resource */
+    get token(): TokenListInstance;
 }

package/lib/rest/iam/V1.js

@@ -20,6 +20,7 @@ const Version_1 = __importDefault(require("../../base/Version"));
 const apiKey_1 = require("./v1/apiKey");
 const getApiKeys_1 = require("./v1/getApiKeys");
 const newApiKey_1 = require("./v1/newApiKey");
+const token_1 = require("./v1/token");
 class V1 extends Version_1.default {
     /**
      * Initialize the V1 version of Iam
@@ -44,5 +45,10 @@ class V1 extends Version_1.default {
         this._newApiKey = this._newApiKey || (0, newApiKey_1.NewApiKeyListInstance)(this);
         return this._newApiKey;
     }
+    /** Getter for token resource */
+    get token() {
+        this._token = this._token || (0, token_1.TokenListInstance)(this);
+        return this._token;
+    }
 }
 exports.default = V1;

package/lib/rest/iam/v1/token.d.ts

@@ -0,0 +1,88 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V1 from "../V1";
+/**
+ * Options to pass to create a TokenInstance
+ */
+export interface TokenListInstanceCreateOptions {
+    /** Grant type is a credential representing resource owner\\\'s authorization which can be used by client to obtain access token. */
+    grantType: string;
+    /** A 34 character string that uniquely identifies this OAuth App. */
+    clientId: string;
+    /** The credential for confidential OAuth App. */
+    clientSecret?: string;
+    /** JWT token related to the authorization code grant type. */
+    code?: string;
+    /** The redirect uri */
+    redirectUri?: string;
+    /** The targeted audience uri */
+    audience?: string;
+    /** JWT token related to refresh access token. */
+    refreshToken?: string;
+    /** The scope of token */
+    scope?: string;
+}
+export interface TokenSolution {
+}
+export interface TokenListInstance {
+    _version: V1;
+    _solution: TokenSolution;
+    _uri: string;
+    /**
+     * Create a TokenInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed TokenInstance
+     */
+    create(params: TokenListInstanceCreateOptions, callback?: (error: Error | null, item?: TokenInstance) => any): Promise<TokenInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function TokenListInstance(version: V1): TokenListInstance;
+interface TokenResource {
+    access_token: string;
+    refresh_token: string;
+    id_token: string;
+    token_type: string;
+    expires_in: number;
+}
+export declare class TokenInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: TokenResource);
+    /**
+     * Token which carries the necessary information to access a Twilio resource directly.
+     */
+    accessToken: string;
+    /**
+     * Token which carries the information necessary to get a new access token.
+     */
+    refreshToken: string;
+    /**
+     * Token which carries the information necessary of user profile.
+     */
+    idToken: string;
+    /**
+     * Token type
+     */
+    tokenType: string;
+    expiresIn: number;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accessToken: string;
+        refreshToken: string;
+        idToken: string;
+        tokenType: string;
+        expiresIn: number;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,99 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Iam
+ * This is the public Twilio REST API.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenInstance = exports.TokenListInstance = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+function TokenListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/token`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["grantType"] === null || params["grantType"] === undefined) {
+            throw new Error("Required parameter \"params['grantType']\" missing.");
+        }
+        if (params["clientId"] === null || params["clientId"] === undefined) {
+            throw new Error("Required parameter \"params['clientId']\" missing.");
+        }
+        let data = {};
+        data["grant_type"] = params["grantType"];
+        data["client_id"] = params["clientId"];
+        if (params["clientSecret"] !== undefined)
+            data["client_secret"] = params["clientSecret"];
+        if (params["code"] !== undefined)
+            data["code"] = params["code"];
+        if (params["redirectUri"] !== undefined)
+            data["redirect_uri"] = params["redirectUri"];
+        if (params["audience"] !== undefined)
+            data["audience"] = params["audience"];
+        if (params["refreshToken"] !== undefined)
+            data["refresh_token"] = params["refreshToken"];
+        if (params["scope"] !== undefined)
+            data["scope"] = params["scope"];
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new TokenInstance(operationVersion, payload));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.toJSON = function toJSON() {
+        return instance._solution;
+    };
+    instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
+        return (0, util_1.inspect)(instance.toJSON(), options);
+    };
+    return instance;
+}
+exports.TokenListInstance = TokenListInstance;
+class TokenInstance {
+    constructor(_version, payload) {
+        this._version = _version;
+        this.accessToken = payload.access_token;
+        this.refreshToken = payload.refresh_token;
+        this.idToken = payload.id_token;
+        this.tokenType = payload.token_type;
+        this.expiresIn = payload.expires_in;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accessToken: this.accessToken,
+            refreshToken: this.refreshToken,
+            idToken: this.idToken,
+            tokenType: this.tokenType,
+            expiresIn: this.expiresIn,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.TokenInstance = TokenInstance;

package/lib/rest/insights/v1/room/participant.d.ts

@@ -5,8 +5,8 @@ import Response from "../../../../http/response";
 import V1 from "../../V1";
 export type ParticipantCodec = "VP8" | "H264" | "VP9" | "opus";
 export type ParticipantEdgeLocation = "ashburn" | "dublin" | "frankfurt" | "singapore" | "sydney" | "sao_paulo" | "roaming" | "umatilla" | "tokyo";
-export type ParticipantRoomStatus = "in_progress" | "completed";
-export type ParticipantTwilioRealm = "us1" | "us2" | "au1" | "br1" | "ie1" | "jp1" | "sg1" | "in1" | "de1" | "gll" | "stage_us1" | "dev_us1";
+export type ParticipantRoomStatus = "in_progress" | "connected" | "completed" | "disconnected";
+export type ParticipantTwilioRealm = "us1" | "us2" | "au1" | "br1" | "ie1" | "jp1" | "sg1" | "in1" | "de1" | "gll" | "stage_us1" | "dev_us1" | "stage_au1" | "stage_sg1" | "stage_br1" | "stage_in1" | "stage_jp1" | "stage_de1" | "stage_ie1" | "stage_us2" | "dev_us2" | "outside";
 /**
  * Options to pass to each
  */

package/lib/rest/insights/v1/room.d.ts

@@ -8,10 +8,10 @@ export type RoomCodec = "VP8" | "H264" | "VP9" | "opus";
 export type RoomCreatedMethod = "sdk" | "ad_hoc" | "api";
 export type RoomEdgeLocation = "ashburn" | "dublin" | "frankfurt" | "singapore" | "sydney" | "sao_paulo" | "roaming" | "umatilla" | "tokyo";
 export type RoomEndReason = "room_ended_via_api" | "timeout";
-export type RoomProcessingState = "complete" | "in_progress";
+export type RoomProcessingState = "complete" | "in_progress" | "timeout" | "not_started";
 export type RoomRoomStatus = "in_progress" | "completed";
 export type RoomRoomType = "go" | "peer_to_peer" | "group" | "group_small";
-export type RoomTwilioRealm = "us1" | "us2" | "au1" | "br1" | "ie1" | "jp1" | "sg1" | "in1" | "de1" | "gll" | "stage_us1" | "dev_us1";
+export type RoomTwilioRealm = "us1" | "us2" | "au1" | "br1" | "ie1" | "jp1" | "sg1" | "in1" | "de1" | "gll" | "stage_us1" | "stage_us2" | "dev_us1" | "dev_us2" | "stage_de1" | "stage_in1" | "stage_ie1" | "stage_br1" | "stage_au1" | "stage_sg1" | "stage_jp1" | "outside";
 /**
  * Options to pass to each
  */

package/lib/rest/intelligence/v2/customOperator.d.ts

@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V2 from "../V2";
+/**
+ * Custom Operator availability status. Possible values: internal, beta, public, retired.
+ */
 export type CustomOperatorAvailability = "internal" | "beta" | "public" | "retired";
 /**
  * Options to pass to update a CustomOperatorInstance

package/lib/rest/intelligence/v2/operator.d.ts

@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V2 from "../V2";
+/**
+ * Operator availability status. Possible values: internal, beta, public, retired.
+ */
 export type OperatorAvailability = "internal" | "beta" | "public" | "retired";
 /**
  * Options to pass to each

package/lib/rest/intelligence/v2/operatorType.d.ts

@@ -3,8 +3,17 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V2 from "../V2";
+/**
+ * Operator Type availability status. Possible values: internal, beta, general-availability, retired, deprecated.
+ */
 export type OperatorTypeAvailability = "internal" | "beta" | "general-availability" | "retired" | "deprecated";
+/**
+ * Operator Results for this Operator Type will follow this format. Possible values: text-classification, text-extraction, text-extraction-normalized, text-generation.
+ */
 export type OperatorTypeOutputType = "text-classification" | "text-extraction" | "text-extraction-normalized" | "text-generation";
+/**
+ * Operators with this Operator Type are executed using this provider. Possible values: twilio, amazon, openai.
+ */
 export type OperatorTypeProvider = "twilio" | "amazon" | "openai";
 /**
  * Options to pass to each

package/lib/rest/intelligence/v2/prebuiltOperator.d.ts

@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V2 from "../V2";
+/**
+ * Operator availability status. Possible values: internal, beta, public, retired.
+ */
 export type PrebuiltOperatorAvailability = "internal" | "beta" | "public" | "retired";
 /**
  * Options to pass to each

package/lib/rest/intelligence/v2/transcript/operatorResult.d.ts

@@ -3,6 +3,9 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../../base/Page";
 import Response from "../../../../http/response";
 import V2 from "../../V2";
+/**
+ * The type of the applied Language Understanding Operator. One of conversation-classify, utterance-classify, extract, extract-normalize, or pii-extract
+ */
 export type OperatorResultOperatorType = "conversation_classify" | "utterance_classify" | "extract" | "extract_normalize" | "pii_extract" | "text_generation" | "json";
 /**
  * Options to pass to fetch a OperatorResultInstance

package/lib/rest/intelligence/v2/transcript.d.ts

@@ -6,6 +6,9 @@ import V2 from "../V2";
 import { MediaListInstance } from "./transcript/media";
 import { OperatorResultListInstance } from "./transcript/operatorResult";
 import { SentenceListInstance } from "./transcript/sentence";
+/**
+ * The Status of this Transcript. One of `queued`, `in-progress`, `completed`, `failed` or `canceled`.
+ */
 export type TranscriptStatus = "queued" | "in-progress" | "completed" | "failed" | "canceled";
 /**
  * Options to pass to create a TranscriptInstance

package/lib/rest/knowledge/V1.d.ts

@@ -0,0 +1,15 @@
+import KnowledgeBase from "../KnowledgeBase";
+import Version from "../../base/Version";
+import { KnowledgeListInstance } from "./v1/knowledge";
+export default class V1 extends Version {
+    /**
+     * Initialize the V1 version of Knowledge
+     *
+     * @param domain - The Twilio (Twilio.Knowledge) domain
+     */
+    constructor(domain: KnowledgeBase);
+    /** knowledge - { Twilio.Knowledge.V1.KnowledgeListInstance } resource */
+    protected _knowledge?: KnowledgeListInstance;
+    /** Getter for knowledge resource */
+    get knowledge(): KnowledgeListInstance;
+}

package/lib/rest/{preview/Sync.js → knowledge/V1.js}

@@ -5,7 +5,7 @@
  *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
  *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
  *
- * Twilio - Preview
+ * Twilio - Knowledge
  * This is the public Twilio REST API.
  *
  * NOTE: This class is auto generated by OpenAPI Generator.
@@ -17,20 +17,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Version_1 = __importDefault(require("../../base/Version"));
-const service_1 = require("./sync/service");
-class Sync extends Version_1.default {
+const knowledge_1 = require("./v1/knowledge");
+class V1 extends Version_1.default {
     /**
-     * Initialize the Sync version of Preview
+     * Initialize the V1 version of Knowledge
      *
-     * @param domain - The Twilio (Twilio.Preview) domain
+     * @param domain - The Twilio (Twilio.Knowledge) domain
      */
     constructor(domain) {
-        super(domain, "Sync");
+        super(domain, "v1");
     }
-    /** Getter for services resource */
-    get services() {
-        this._services = this._services || (0, service_1.ServiceListInstance)(this);
-        return this._services;
+    /** Getter for knowledge resource */
+    get knowledge() {
+        this._knowledge = this._knowledge || (0, knowledge_1.KnowledgeListInstance)(this);
+        return this._knowledge;
     }
 }
-exports.default = Sync;
+exports.default = V1;

package/lib/rest/knowledge/v1/knowledge/chunk.d.ts

@@ -0,0 +1,167 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import V1 from "../../V1";
+/**
+ * Options to pass to each
+ */
+export interface ChunkListInstanceEachOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: ChunkInstance, done: (err?: Error) => void) => void;
+    /** Function to be called upon completion of streaming */
+    done?: Function;
+    /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to list
+ */
+export interface ChunkListInstanceOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to page
+ */
+export interface ChunkListInstancePageOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
+export interface ChunkSolution {
+    id: string;
+}
+export interface ChunkListInstance {
+    _version: V1;
+    _solution: ChunkSolution;
+    _uri: string;
+    /**
+     * Streams ChunkInstance records from the API.
+     *
+     * This operation lazily loads records as efficiently as possible until the limit
+     * is reached.
+     *
+     * The results are passed into the callback function, so this operation is memory
+     * efficient.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { ChunkListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: ChunkInstance, done: (err?: Error) => void) => void): void;
+    each(params: ChunkListInstanceEachOptions, callback?: (item: ChunkInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of ChunkInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * @param { string } [targetUrl] - API-generated URL for the requested results page
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    getPage(targetUrl: string, callback?: (error: Error | null, items: ChunkPage) => any): Promise<ChunkPage>;
+    /**
+     * Lists ChunkInstance records from the API as a list.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { ChunkListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: ChunkInstance[]) => any): Promise<ChunkInstance[]>;
+    list(params: ChunkListInstanceOptions, callback?: (error: Error | null, items: ChunkInstance[]) => any): Promise<ChunkInstance[]>;
+    /**
+     * Retrieve a single page of ChunkInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { ChunkListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: ChunkPage) => any): Promise<ChunkPage>;
+    page(params: ChunkListInstancePageOptions, callback?: (error: Error | null, items: ChunkPage) => any): Promise<ChunkPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function ChunkListInstance(version: V1, id: string): ChunkListInstance;
+interface ChunkPayload extends TwilioResponsePayload {
+    chunks: ChunkResource[];
+}
+interface ChunkResource {
+    account_sid: string;
+    content: string;
+    metadata: Record<string, object>;
+    date_created: Date;
+    date_updated: Date;
+}
+export declare class ChunkInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: ChunkResource, id: string);
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource.
+     */
+    accountSid: string;
+    /**
+     * The chunk content.
+     */
+    content: string;
+    /**
+     * The metadata of the chunk.
+     */
+    metadata: Record<string, object>;
+    /**
+     * The date and time in GMT when the Chunk was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the Chunk was updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateUpdated: Date;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        content: string;
+        metadata: Record<string, object>;
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class ChunkPage extends Page<V1, ChunkPayload, ChunkResource, ChunkInstance> {
+    /**
+     * Initialize the ChunkPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: ChunkSolution);
+    /**
+     * Build an instance of ChunkInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: ChunkResource): ChunkInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};