twilio 5.3.0 → 5.3.1

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

@@ -0,0 +1,385 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V1 from "../V1";
+import { ChunkListInstance } from "./knowledge/chunk";
+export declare class AssistantsV1ServiceCreateKnowledgeRequest {
+    /**
+     * The Assistant ID.
+     */
+    "assistantId"?: string;
+    /**
+     * The description of the knowledge source.
+     */
+    "description"?: string;
+    /**
+     * The details of the knowledge source based on the type.
+     */
+    "knowledgeSourceDetails"?: Record<string, object>;
+    /**
+     * The name of the tool.
+     */
+    "name": string;
+    "policy"?: AssistantsV1ServiceCreatePolicyRequest;
+    /**
+     * The type of the knowledge source.
+     */
+    "type": string;
+}
+export declare class AssistantsV1ServiceCreatePolicyRequest {
+    /**
+     * The description of the policy.
+     */
+    "description"?: string;
+    /**
+     * The Policy ID.
+     */
+    "id"?: string;
+    /**
+     * The name of the policy.
+     */
+    "name"?: string;
+    "policyDetails": any | null;
+    /**
+     * The description of the policy.
+     */
+    "type"?: string;
+}
+export declare class AssistantsV1ServiceUpdateKnowledgeRequest {
+    /**
+     * The description of the knowledge source.
+     */
+    "description"?: string;
+    /**
+     * The details of the knowledge source based on the type.
+     */
+    "knowledgeSourceDetails"?: Record<string, object>;
+    /**
+     * The name of the knowledge source.
+     */
+    "name"?: string;
+    "policy"?: AssistantsV1ServiceCreatePolicyRequest;
+    /**
+     * The description of the knowledge source.
+     */
+    "type"?: string;
+}
+/**
+ * Options to pass to update a KnowledgeInstance
+ */
+export interface KnowledgeContextUpdateOptions {
+    /**  */
+    assistantsV1ServiceUpdateKnowledgeRequest?: AssistantsV1ServiceUpdateKnowledgeRequest;
+}
+/**
+ * Options to pass to create a KnowledgeInstance
+ */
+export interface KnowledgeListInstanceCreateOptions {
+    /**  */
+    assistantsV1ServiceCreateKnowledgeRequest: AssistantsV1ServiceCreateKnowledgeRequest;
+}
+/**
+ * Options to pass to each
+ */
+export interface KnowledgeListInstanceEachOptions {
+    /**  */
+    assistantId?: string;
+    /** 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: KnowledgeInstance, 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 KnowledgeListInstanceOptions {
+    /**  */
+    assistantId?: string;
+    /** 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 KnowledgeListInstancePageOptions {
+    /**  */
+    assistantId?: string;
+    /** 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 KnowledgeContext {
+    chunks: ChunkListInstance;
+    /**
+     * Remove a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    fetch(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Update a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    update(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Update a KnowledgeInstance
+     *
+     * @param params - Body for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    update(params: AssistantsV1ServiceUpdateKnowledgeRequest, callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface KnowledgeContextSolution {
+    id: string;
+}
+export declare class KnowledgeContextImpl implements KnowledgeContext {
+    protected _version: V1;
+    protected _solution: KnowledgeContextSolution;
+    protected _uri: string;
+    protected _chunks?: ChunkListInstance;
+    constructor(_version: V1, id: string);
+    get chunks(): ChunkListInstance;
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    update(params?: AssistantsV1ServiceUpdateKnowledgeRequest | ((error: Error | null, item?: KnowledgeInstance) => any), callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): KnowledgeContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface KnowledgePayload extends TwilioResponsePayload {
+    knowledge: KnowledgeResource[];
+}
+interface KnowledgeResource {
+    description: string;
+    id: string;
+    account_sid: string;
+    knowledge_source_details: Record<string, object>;
+    name: string;
+    status: string;
+    type: string;
+    date_created: Date;
+    date_updated: Date;
+}
+export declare class KnowledgeInstance {
+    protected _version: V1;
+    protected _solution: KnowledgeContextSolution;
+    protected _context?: KnowledgeContext;
+    constructor(_version: V1, payload: KnowledgeResource, id?: string);
+    /**
+     * The type of knowledge source.
+     */
+    description: string;
+    /**
+     * The description of knowledge.
+     */
+    id: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource.
+     */
+    accountSid: string;
+    /**
+     * The details of the knowledge source based on the type.
+     */
+    knowledgeSourceDetails: Record<string, object>;
+    /**
+     * The name of the knowledge source.
+     */
+    name: string;
+    /**
+     * The status of processing the knowledge source (\'QUEUED\', \'PROCESSING\', \'COMPLETED\', \'FAILED\')
+     */
+    status: string;
+    /**
+     * The type of knowledge source (\'Web\', \'Database\', \'Text\', \'File\')
+     */
+    type: string;
+    /**
+     * The date and time in GMT when the Knowledge was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateUpdated: Date;
+    private get _proxy();
+    /**
+     * Remove a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    fetch(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Update a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    update(callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Update a KnowledgeInstance
+     *
+     * @param params - Body for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    update(params: AssistantsV1ServiceUpdateKnowledgeRequest, callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Access the chunks.
+     */
+    chunks(): ChunkListInstance;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        description: string;
+        id: string;
+        accountSid: string;
+        knowledgeSourceDetails: Record<string, object>;
+        name: string;
+        status: string;
+        type: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface KnowledgeSolution {
+}
+export interface KnowledgeListInstance {
+    _version: V1;
+    _solution: KnowledgeSolution;
+    _uri: string;
+    (id: string): KnowledgeContext;
+    get(id: string): KnowledgeContext;
+    /**
+     * Create a KnowledgeInstance
+     *
+     * @param params - Body for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    create(params: AssistantsV1ServiceCreateKnowledgeRequest, callback?: (error: Error | null, item?: KnowledgeInstance) => any): Promise<KnowledgeInstance>;
+    /**
+     * Streams KnowledgeInstance 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 { KnowledgeListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: KnowledgeInstance, done: (err?: Error) => void) => void): void;
+    each(params: KnowledgeListInstanceEachOptions, callback?: (item: KnowledgeInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of KnowledgeInstance 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: KnowledgePage) => any): Promise<KnowledgePage>;
+    /**
+     * Lists KnowledgeInstance 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 { KnowledgeListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: KnowledgeInstance[]) => any): Promise<KnowledgeInstance[]>;
+    list(params: KnowledgeListInstanceOptions, callback?: (error: Error | null, items: KnowledgeInstance[]) => any): Promise<KnowledgeInstance[]>;
+    /**
+     * Retrieve a single page of KnowledgeInstance 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 { KnowledgeListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: KnowledgePage) => any): Promise<KnowledgePage>;
+    page(params: KnowledgeListInstancePageOptions, callback?: (error: Error | null, items: KnowledgePage) => any): Promise<KnowledgePage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function KnowledgeListInstance(version: V1): KnowledgeListInstance;
+export declare class KnowledgePage extends Page<V1, KnowledgePayload, KnowledgeResource, KnowledgeInstance> {
+    /**
+     * Initialize the KnowledgePage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: KnowledgeSolution);
+    /**
+     * Build an instance of KnowledgeInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: KnowledgeResource): KnowledgeInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,273 @@
+"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.KnowledgePage = exports.KnowledgeListInstance = exports.KnowledgeInstance = exports.KnowledgeContextImpl = exports.AssistantsV1ServiceUpdateKnowledgeRequest = exports.AssistantsV1ServiceCreatePolicyRequest = exports.AssistantsV1ServiceCreateKnowledgeRequest = 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 chunk_1 = require("./knowledge/chunk");
+class AssistantsV1ServiceCreateKnowledgeRequest {
+}
+exports.AssistantsV1ServiceCreateKnowledgeRequest = AssistantsV1ServiceCreateKnowledgeRequest;
+class AssistantsV1ServiceCreatePolicyRequest {
+}
+exports.AssistantsV1ServiceCreatePolicyRequest = AssistantsV1ServiceCreatePolicyRequest;
+class AssistantsV1ServiceUpdateKnowledgeRequest {
+}
+exports.AssistantsV1ServiceUpdateKnowledgeRequest = AssistantsV1ServiceUpdateKnowledgeRequest;
+class KnowledgeContextImpl {
+    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 = `/Knowledge/${id}`;
+    }
+    get chunks() {
+        this._chunks =
+            this._chunks || (0, chunk_1.ChunkListInstance)(this._version, this._solution.id);
+        return this._chunks;
+    }
+    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 KnowledgeInstance(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 KnowledgeInstance(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.KnowledgeContextImpl = KnowledgeContextImpl;
+class KnowledgeInstance {
+    constructor(_version, payload, id) {
+        this._version = _version;
+        this.description = payload.description;
+        this.id = payload.id;
+        this.accountSid = payload.account_sid;
+        this.knowledgeSourceDetails = payload.knowledge_source_details;
+        this.name = payload.name;
+        this.status = payload.status;
+        this.type = payload.type;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this._solution = { id: id || this.id };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new KnowledgeContextImpl(this._version, this._solution.id);
+        return this._context;
+    }
+    /**
+     * Remove a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a KnowledgeInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    update(params, callback) {
+        return this._proxy.update(params, callback);
+    }
+    /**
+     * Access the chunks.
+     */
+    chunks() {
+        return this._proxy.chunks;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            description: this.description,
+            id: this.id,
+            accountSid: this.accountSid,
+            knowledgeSourceDetails: this.knowledgeSourceDetails,
+            name: this.name,
+            status: this.status,
+            type: this.type,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.KnowledgeInstance = KnowledgeInstance;
+function KnowledgeListInstance(version) {
+    const instance = ((id) => instance.get(id));
+    instance.get = function get(id) {
+        return new KnowledgeContextImpl(version, id);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Knowledge`;
+    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 KnowledgeInstance(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["assistantId"] !== undefined)
+            data["AssistantId"] = params["assistantId"];
+        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 KnowledgePage(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 KnowledgePage(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.KnowledgeListInstance = KnowledgeListInstance;
+class KnowledgePage extends Page_1.default {
+    /**
+     * Initialize the KnowledgePage
+     *
+     * @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 KnowledgeInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new KnowledgeInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.KnowledgePage = KnowledgePage;