twilio 5.3.0 → 5.3.1

package/lib/rest/assistants/v1/assistant.js

@@ -0,0 +1,284 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Assistants
+ * 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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssistantPage = exports.AssistantListInstance = exports.AssistantInstance = exports.AssistantContextImpl = exports.AssistantsV1ServiceUpdateAssistantRequest = exports.AssistantsV1ServiceTool = exports.AssistantsV1ServiceSegmentCredential = exports.AssistantsV1ServiceKnowledge = exports.AssistantsV1ServiceCustomerAi = exports.AssistantsV1ServiceCreateAssistantRequest = 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");
+const feedback_1 = require("./assistant/feedback");
+class AssistantsV1ServiceCreateAssistantRequest {
+}
+exports.AssistantsV1ServiceCreateAssistantRequest = AssistantsV1ServiceCreateAssistantRequest;
+class AssistantsV1ServiceCustomerAi {
+}
+exports.AssistantsV1ServiceCustomerAi = AssistantsV1ServiceCustomerAi;
+class AssistantsV1ServiceKnowledge {
+}
+exports.AssistantsV1ServiceKnowledge = AssistantsV1ServiceKnowledge;
+class AssistantsV1ServiceSegmentCredential {
+}
+exports.AssistantsV1ServiceSegmentCredential = AssistantsV1ServiceSegmentCredential;
+class AssistantsV1ServiceTool {
+}
+exports.AssistantsV1ServiceTool = AssistantsV1ServiceTool;
+class AssistantsV1ServiceUpdateAssistantRequest {
+}
+exports.AssistantsV1ServiceUpdateAssistantRequest = AssistantsV1ServiceUpdateAssistantRequest;
+class AssistantContextImpl {
+    constructor(_version, id) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(id)) {
+            throw new Error("Parameter 'id' is not valid.");
+        }
+        this._solution = { id };
+        this._uri = `/Assistants/${id}`;
+    }
+    get feedbacks() {
+        this._feedbacks =
+            this._feedbacks || (0, feedback_1.FeedbackListInstance)(this._version, this._solution.id);
+        return this._feedbacks;
+    }
+    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) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new AssistantInstance(operationVersion, payload, 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 = {};
+        data = params;
+        const headers = {};
+        headers["Content-Type"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "put",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new AssistantInstance(operationVersion, payload, instance._solution.id));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return this._solution;
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AssistantContextImpl = AssistantContextImpl;
+class AssistantInstance {
+    constructor(_version, payload, id) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.customerAi = payload.customer_ai;
+        this.id = payload.id;
+        this.model = payload.model;
+        this.name = payload.name;
+        this.owner = payload.owner;
+        this.personalityPrompt = payload.personality_prompt;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this.knowledge = payload.knowledge;
+        this.tools = payload.tools;
+        this._solution = { id: id || this.id };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new AssistantContextImpl(this._version, this._solution.id);
+        return this._context;
+    }
+    /**
+     * Remove a AssistantInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a AssistantInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AssistantInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    update(params, callback) {
+        return this._proxy.update(params, callback);
+    }
+    /**
+     * Access the feedbacks.
+     */
+    feedbacks() {
+        return this._proxy.feedbacks;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            customerAi: this.customerAi,
+            id: this.id,
+            model: this.model,
+            name: this.name,
+            owner: this.owner,
+            personalityPrompt: this.personalityPrompt,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+            knowledge: this.knowledge,
+            tools: this.tools,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AssistantInstance = AssistantInstance;
+function AssistantListInstance(version) {
+    const instance = ((id) => instance.get(id));
+    instance.get = function get(id) {
+        return new AssistantContextImpl(version, id);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Assistants`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        const headers = {};
+        headers["Content-Type"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new AssistantInstance(operationVersion, payload));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["PageSize"] = params["pageSize"];
+        if (params.pageNumber !== undefined)
+            data["Page"] = params.pageNumber;
+        if (params.pageToken !== undefined)
+            data["PageToken"] = params.pageToken;
+        const headers = {};
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new AssistantPage(operationVersion, payload, instance._solution));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.list = instance._version.list;
+    instance.getPage = function getPage(targetUrl, callback) {
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((payload) => new AssistantPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    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.AssistantListInstance = AssistantListInstance;
+class AssistantPage extends Page_1.default {
+    /**
+     * Initialize the AssistantPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version, response, solution) {
+        super(version, response, solution);
+    }
+    /**
+     * Build an instance of AssistantInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new AssistantInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AssistantPage = AssistantPage;

package/lib/rest/assistants/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 {};

package/lib/rest/assistants/v1/knowledge/chunk.js

@@ -0,0 +1,130 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Assistants
+ * 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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChunkPage = exports.ChunkInstance = exports.ChunkListInstance = 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");
+function ChunkListInstance(version, id) {
+    if (!(0, utility_1.isValidPathParam)(id)) {
+        throw new Error("Parameter 'id' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { id };
+    instance._uri = `/Knowledge/${id}/Chunks`;
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["PageSize"] = params["pageSize"];
+        if (params.pageNumber !== undefined)
+            data["Page"] = params.pageNumber;
+        if (params.pageToken !== undefined)
+            data["PageToken"] = params.pageToken;
+        const headers = {};
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new ChunkPage(operationVersion, payload, instance._solution));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.list = instance._version.list;
+    instance.getPage = function getPage(targetUrl, callback) {
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((payload) => new ChunkPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    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.ChunkListInstance = ChunkListInstance;
+class ChunkInstance {
+    constructor(_version, payload, id) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.content = payload.content;
+        this.metadata = payload.metadata;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            content: this.content,
+            metadata: this.metadata,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ChunkInstance = ChunkInstance;
+class ChunkPage extends Page_1.default {
+    /**
+     * Initialize the ChunkPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version, response, solution) {
+        super(version, response, solution);
+    }
+    /**
+     * Build an instance of ChunkInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new ChunkInstance(this._version, payload, this._solution.id);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ChunkPage = ChunkPage;