twilio 5.3.1 → 5.3.3

package/lib/rest/{preview/deployed_devices/fleet/key.js → assistants/v1/assistant/assistantsKnowledge.js}

@@ -5,7 +5,7 @@
  *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
  *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
  *
- * Twilio - Preview
+ * Twilio - Assistants
  * This is the public Twilio REST API.
  *
  * NOTE: This class is auto generated by OpenAPI Generator.
@@ -16,66 +16,40 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyPage = exports.KeyListInstance = exports.KeyInstance = exports.KeyContextImpl = void 0;
+exports.AssistantsKnowledgePage = exports.AssistantsKnowledgeListInstance = exports.AssistantsKnowledgeInstance = exports.AssistantsKnowledgeContextImpl = void 0;
 const util_1 = require("util");
 const Page_1 = __importDefault(require("../../../../base/Page"));
 const deserialize = require("../../../../base/deserialize");
 const serialize = require("../../../../base/serialize");
 const utility_1 = require("../../../../base/utility");
-class KeyContextImpl {
-    constructor(_version, fleetSid, sid) {
+class AssistantsKnowledgeContextImpl {
+    constructor(_version, assistantId, id) {
         this._version = _version;
-        if (!(0, utility_1.isValidPathParam)(fleetSid)) {
-            throw new Error("Parameter 'fleetSid' is not valid.");
+        if (!(0, utility_1.isValidPathParam)(assistantId)) {
+            throw new Error("Parameter 'assistantId' is not valid.");
         }
-        if (!(0, utility_1.isValidPathParam)(sid)) {
-            throw new Error("Parameter 'sid' is not valid.");
+        if (!(0, utility_1.isValidPathParam)(id)) {
+            throw new Error("Parameter 'id' is not valid.");
         }
-        this._solution = { fleetSid, sid };
-        this._uri = `/Fleets/${fleetSid}/Keys/${sid}`;
+        this._solution = { assistantId, id };
+        this._uri = `/Assistants/${assistantId}/Knowledge/${id}`;
     }
-    remove(callback) {
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.remove({
-            uri: instance._uri,
-            method: "delete",
-        });
-        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
-        return operationPromise;
-    }
-    fetch(callback) {
+    create(callback) {
         const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+        let operationVersion = instance._version, operationPromise = operationVersion.create({
             uri: instance._uri,
-            method: "get",
+            method: "post",
         });
-        operationPromise = operationPromise.then((payload) => new KeyInstance(operationVersion, payload, instance._solution.fleetSid, instance._solution.sid));
+        operationPromise = operationPromise.then((payload) => new AssistantsKnowledgeInstance(operationVersion, payload, instance._solution.assistantId, instance._solution.id));
         operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
         return operationPromise;
     }
-    update(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        if (params["deviceSid"] !== undefined)
-            data["DeviceSid"] = params["deviceSid"];
-        const headers = {};
-        headers["Content-Type"] = "application/x-www-form-urlencoded";
+    remove(callback) {
         const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.update({
+        let operationVersion = instance._version, operationPromise = operationVersion.remove({
             uri: instance._uri,
-            method: "post",
-            data,
-            headers,
+            method: "delete",
         });
-        operationPromise = operationPromise.then((payload) => new KeyInstance(operationVersion, payload, instance._solution.fleetSid, instance._solution.sid));
         operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
         return operationPromise;
     }
@@ -91,49 +65,47 @@ class KeyContextImpl {
         return (0, util_1.inspect)(this.toJSON(), options);
     }
 }
-exports.KeyContextImpl = KeyContextImpl;
-class KeyInstance {
-    constructor(_version, payload, fleetSid, sid) {
+exports.AssistantsKnowledgeContextImpl = AssistantsKnowledgeContextImpl;
+class AssistantsKnowledgeInstance {
+    constructor(_version, payload, assistantId, id) {
         this._version = _version;
-        this.sid = payload.sid;
-        this.url = payload.url;
-        this.friendlyName = payload.friendly_name;
-        this.fleetSid = payload.fleet_sid;
+        this.description = payload.description;
+        this.id = payload.id;
         this.accountSid = payload.account_sid;
-        this.deviceSid = payload.device_sid;
-        this.secret = payload.secret;
+        this.knowledgeSourceDetails = payload.knowledge_source_details;
+        this.name = payload.name;
+        this.status = payload.status;
+        this.type = payload.type;
+        this.url = payload.url;
         this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
         this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
-        this._solution = { fleetSid, sid: sid || this.sid };
+        this._solution = { assistantId, id: id || this.id };
     }
     get _proxy() {
         this._context =
             this._context ||
-                new KeyContextImpl(this._version, this._solution.fleetSid, this._solution.sid);
+                new AssistantsKnowledgeContextImpl(this._version, this._solution.assistantId, this._solution.id);
         return this._context;
     }
     /**
-     * Remove a KeyInstance
+     * Create a AssistantsKnowledgeInstance
      *
      * @param callback - Callback to handle processed record
      *
-     * @returns Resolves to processed boolean
+     * @returns Resolves to processed AssistantsKnowledgeInstance
      */
-    remove(callback) {
-        return this._proxy.remove(callback);
+    create(callback) {
+        return this._proxy.create(callback);
     }
     /**
-     * Fetch a KeyInstance
+     * Remove a AssistantsKnowledgeInstance
      *
      * @param callback - Callback to handle processed record
      *
-     * @returns Resolves to processed KeyInstance
+     * @returns Resolves to processed boolean
      */
-    fetch(callback) {
-        return this._proxy.fetch(callback);
-    }
-    update(params, callback) {
-        return this._proxy.update(params, callback);
+    remove(callback) {
+        return this._proxy.remove(callback);
     }
     /**
      * Provide a user-friendly representation
@@ -142,13 +114,14 @@ class KeyInstance {
      */
     toJSON() {
         return {
-            sid: this.sid,
-            url: this.url,
-            friendlyName: this.friendlyName,
-            fleetSid: this.fleetSid,
+            description: this.description,
+            id: this.id,
             accountSid: this.accountSid,
-            deviceSid: this.deviceSid,
-            secret: this.secret,
+            knowledgeSourceDetails: this.knowledgeSourceDetails,
+            name: this.name,
+            status: this.status,
+            type: this.type,
+            url: this.url,
             dateCreated: this.dateCreated,
             dateUpdated: this.dateUpdated,
         };
@@ -157,43 +130,18 @@ class KeyInstance {
         return (0, util_1.inspect)(this.toJSON(), options);
     }
 }
-exports.KeyInstance = KeyInstance;
-function KeyListInstance(version, fleetSid) {
-    if (!(0, utility_1.isValidPathParam)(fleetSid)) {
-        throw new Error("Parameter 'fleetSid' is not valid.");
-    }
-    const instance = ((sid) => instance.get(sid));
-    instance.get = function get(sid) {
-        return new KeyContextImpl(version, fleetSid, sid);
+exports.AssistantsKnowledgeInstance = AssistantsKnowledgeInstance;
+function AssistantsKnowledgeListInstance(version, assistantId) {
+    if (!(0, utility_1.isValidPathParam)(assistantId)) {
+        throw new Error("Parameter 'assistantId' is not valid.");
+    }
+    const instance = ((id) => instance.get(id));
+    instance.get = function get(id) {
+        return new AssistantsKnowledgeContextImpl(version, assistantId, id);
     };
     instance._version = version;
-    instance._solution = { fleetSid };
-    instance._uri = `/Fleets/${fleetSid}/Keys`;
-    instance.create = function create(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        if (params["deviceSid"] !== undefined)
-            data["DeviceSid"] = params["deviceSid"];
-        const headers = {};
-        headers["Content-Type"] = "application/x-www-form-urlencoded";
-        let operationVersion = version, operationPromise = operationVersion.create({
-            uri: instance._uri,
-            method: "post",
-            data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new KeyInstance(operationVersion, payload, instance._solution.fleetSid));
-        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
-        return operationPromise;
-    };
+    instance._solution = { assistantId };
+    instance._uri = `/Assistants/${assistantId}/Knowledge`;
     instance.page = function page(params, callback) {
         if (params instanceof Function) {
             callback = params;
@@ -203,8 +151,6 @@ function KeyListInstance(version, fleetSid) {
             params = params || {};
         }
         let data = {};
-        if (params["deviceSid"] !== undefined)
-            data["DeviceSid"] = params["deviceSid"];
         if (params["pageSize"] !== undefined)
             data["PageSize"] = params["pageSize"];
         if (params.pageNumber !== undefined)
@@ -218,7 +164,7 @@ function KeyListInstance(version, fleetSid) {
             params: data,
             headers,
         });
-        operationPromise = operationPromise.then((payload) => new KeyPage(operationVersion, payload, instance._solution));
+        operationPromise = operationPromise.then((payload) => new AssistantsKnowledgePage(operationVersion, payload, instance._solution));
         operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
         return operationPromise;
     };
@@ -229,7 +175,7 @@ function KeyListInstance(version, fleetSid) {
             method: "get",
             uri: targetUrl,
         });
-        let pagePromise = operationPromise.then((payload) => new KeyPage(instance._version, payload, instance._solution));
+        let pagePromise = operationPromise.then((payload) => new AssistantsKnowledgePage(instance._version, payload, instance._solution));
         pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
         return pagePromise;
     };
@@ -241,10 +187,10 @@ function KeyListInstance(version, fleetSid) {
     };
     return instance;
 }
-exports.KeyListInstance = KeyListInstance;
-class KeyPage extends Page_1.default {
+exports.AssistantsKnowledgeListInstance = AssistantsKnowledgeListInstance;
+class AssistantsKnowledgePage extends Page_1.default {
     /**
-     * Initialize the KeyPage
+     * Initialize the AssistantsKnowledgePage
      *
      * @param version - Version of the resource
      * @param response - Response from the API
@@ -254,15 +200,15 @@ class KeyPage extends Page_1.default {
         super(version, response, solution);
     }
     /**
-     * Build an instance of KeyInstance
+     * Build an instance of AssistantsKnowledgeInstance
      *
      * @param payload - Payload response from the API
      */
     getInstance(payload) {
-        return new KeyInstance(this._version, payload, this._solution.fleetSid);
+        return new AssistantsKnowledgeInstance(this._version, payload, this._solution.assistantId);
     }
     [util_1.inspect.custom](depth, options) {
         return (0, util_1.inspect)(this.toJSON(), options);
     }
 }
-exports.KeyPage = KeyPage;
+exports.AssistantsKnowledgePage = AssistantsKnowledgePage;

package/lib/rest/assistants/v1/assistant/assistantsTool.d.ts

@@ -0,0 +1,266 @@
+/// <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 AssistantsToolListInstanceEachOptions {
+    /** 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: AssistantsToolInstance, 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 AssistantsToolListInstanceOptions {
+    /** 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 AssistantsToolListInstancePageOptions {
+    /** 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 AssistantsToolContext {
+    /**
+     * Create a AssistantsToolInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AssistantsToolInstance
+     */
+    create(callback?: (error: Error | null, item?: AssistantsToolInstance) => any): Promise<AssistantsToolInstance>;
+    /**
+     * Remove a AssistantsToolInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface AssistantsToolContextSolution {
+    assistantId: string;
+    id: string;
+}
+export declare class AssistantsToolContextImpl implements AssistantsToolContext {
+    protected _version: V1;
+    protected _solution: AssistantsToolContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, assistantId: string, id: string);
+    create(callback?: (error: Error | null, item?: AssistantsToolInstance) => any): Promise<AssistantsToolInstance>;
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): AssistantsToolContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface AssistantsToolPayload extends TwilioResponsePayload {
+    tools: AssistantsToolResource[];
+}
+interface AssistantsToolResource {
+    account_sid: string;
+    description: string;
+    enabled: boolean;
+    id: string;
+    meta: Record<string, object>;
+    name: string;
+    requires_auth: boolean;
+    type: string;
+    url: string;
+    date_created: Date;
+    date_updated: Date;
+}
+export declare class AssistantsToolInstance {
+    protected _version: V1;
+    protected _solution: AssistantsToolContextSolution;
+    protected _context?: AssistantsToolContext;
+    constructor(_version: V1, payload: AssistantsToolResource, assistantId: string, id?: string);
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Tool resource.
+     */
+    accountSid: string;
+    /**
+     * The description of the tool.
+     */
+    description: string;
+    /**
+     * True if the tool is enabled.
+     */
+    enabled: boolean;
+    /**
+     * The tool ID.
+     */
+    id: string;
+    /**
+     * The metadata related to method, url, input_schema to used with the Tool.
+     */
+    meta: Record<string, object>;
+    /**
+     * The name of the tool.
+     */
+    name: string;
+    /**
+     * The authentication requirement for the tool.
+     */
+    requiresAuth: boolean;
+    /**
+     * The type of the tool. (\'WEBHOOK\')
+     */
+    type: string;
+    /**
+     * The url of the tool resource.
+     */
+    url: string;
+    /**
+     * The date and time in GMT when the Tool was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the Tool was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateUpdated: Date;
+    private get _proxy();
+    /**
+     * Create a AssistantsToolInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AssistantsToolInstance
+     */
+    create(callback?: (error: Error | null, item?: AssistantsToolInstance) => any): Promise<AssistantsToolInstance>;
+    /**
+     * Remove a AssistantsToolInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        description: string;
+        enabled: boolean;
+        id: string;
+        meta: Record<string, object>;
+        name: string;
+        requiresAuth: boolean;
+        type: string;
+        url: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface AssistantsToolSolution {
+    assistantId: string;
+}
+export interface AssistantsToolListInstance {
+    _version: V1;
+    _solution: AssistantsToolSolution;
+    _uri: string;
+    (id: string): AssistantsToolContext;
+    get(id: string): AssistantsToolContext;
+    /**
+     * Streams AssistantsToolInstance 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 { AssistantsToolListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: AssistantsToolInstance, done: (err?: Error) => void) => void): void;
+    each(params: AssistantsToolListInstanceEachOptions, callback?: (item: AssistantsToolInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of AssistantsToolInstance 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: AssistantsToolPage) => any): Promise<AssistantsToolPage>;
+    /**
+     * Lists AssistantsToolInstance 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 { AssistantsToolListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: AssistantsToolInstance[]) => any): Promise<AssistantsToolInstance[]>;
+    list(params: AssistantsToolListInstanceOptions, callback?: (error: Error | null, items: AssistantsToolInstance[]) => any): Promise<AssistantsToolInstance[]>;
+    /**
+     * Retrieve a single page of AssistantsToolInstance 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 { AssistantsToolListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: AssistantsToolPage) => any): Promise<AssistantsToolPage>;
+    page(params: AssistantsToolListInstancePageOptions, callback?: (error: Error | null, items: AssistantsToolPage) => any): Promise<AssistantsToolPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function AssistantsToolListInstance(version: V1, assistantId: string): AssistantsToolListInstance;
+export declare class AssistantsToolPage extends Page<V1, AssistantsToolPayload, AssistantsToolResource, AssistantsToolInstance> {
+    /**
+     * Initialize the AssistantsToolPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: AssistantsToolSolution);
+    /**
+     * Build an instance of AssistantsToolInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: AssistantsToolResource): AssistantsToolInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};