twilio 6.0.0 → 6.0.2

package/lib/rest/knowledge/v2/knowledgeBasis.js

@@ -0,0 +1,441 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio Knowledge API
+ * APIs for managing knowledge bases and knowledge content for AI-powered applications.
+ *
+ * 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.KnowledgeBasisPage = exports.KnowledgeBasisInstance = exports.KnowledgeBasisContextImpl = exports.UpdateKnowledgeBaseRequest = exports.KnowledgeBaseCore = void 0;
+exports.KnowledgeBasisListInstance = KnowledgeBasisListInstance;
+const util_1 = require("util");
+const TokenPage_1 = __importDefault(require("../../../base/TokenPage"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class KnowledgeBaseCore {
+    constructor(payload) {
+        this.displayName = payload["displayName"];
+        this.description = payload["description"];
+    }
+}
+exports.KnowledgeBaseCore = KnowledgeBaseCore;
+class UpdateKnowledgeBaseRequest {
+    constructor(payload) {
+        this.displayName = payload["displayName"];
+        this.description = payload["description"];
+    }
+}
+exports.UpdateKnowledgeBaseRequest = UpdateKnowledgeBaseRequest;
+class KnowledgeBasisContextImpl {
+    constructor(_version, kbId) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(kbId)) {
+            throw new Error("Parameter 'kbId' is not valid.");
+        }
+        this._solution = { kbId };
+        this._uri = `/ControlPlane/KnowledgeBases/${kbId}`;
+    }
+    remove(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "delete",
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new KnowledgeBasisInstance(operationVersion, payload, instance._solution.kbId));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    removeWithHttpInfo(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version;
+        // DELETE operation that returns a response model
+        let operationPromise = operationVersion
+            .fetchWithResponseInfo({
+            uri: instance._uri,
+            method: "delete",
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new KnowledgeBasisInstance(operationVersion, response.body, instance._solution.kbId),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    fetch(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new KnowledgeBasisInstance(operationVersion, payload, instance._solution.kbId));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    fetchWithHttpInfo(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .fetchWithResponseInfo({
+            uri: instance._uri,
+            method: "get",
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new KnowledgeBasisInstance(operationVersion, response.body, instance._solution.kbId),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    update(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "patch",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new KnowledgeBasisInstance(operationVersion, payload, instance._solution.kbId));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    updateWithHttpInfo(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .updateWithResponseInfo({
+            uri: instance._uri,
+            method: "patch",
+            data,
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new KnowledgeBasisInstance(operationVersion, response.body, instance._solution.kbId),
+        }));
+        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.KnowledgeBasisContextImpl = KnowledgeBasisContextImpl;
+class KnowledgeBasisInstance {
+    constructor(_version, _payload, kbId) {
+        this._version = _version;
+        const payload = _payload;
+        this.message = payload.message;
+        this.displayName = payload.displayName;
+        this.description = payload.description;
+        this.id = payload.id;
+        this.status = payload.status;
+        this.createdAt = deserialize.iso8601DateTime(payload.createdAt);
+        this.updatedAt = deserialize.iso8601DateTime(payload.updatedAt);
+        this.version = deserialize.integer(payload.version);
+        this.statusUrl = payload.statusUrl;
+        this._solution = { kbId: kbId };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new KnowledgeBasisContextImpl(this._version, this._solution.kbId);
+        return this._context;
+    }
+    /**
+     * Remove a KnowledgeBasisInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeBasisInstance
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Remove a KnowledgeBasisInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeBasisInstance with HTTP metadata
+     */
+    removeWithHttpInfo(callback) {
+        return this._proxy.removeWithHttpInfo(callback);
+    }
+    /**
+     * Fetch a KnowledgeBasisInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeBasisInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Fetch a KnowledgeBasisInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed KnowledgeBasisInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback) {
+        return this._proxy.fetchWithHttpInfo(callback);
+    }
+    update(params, callback) {
+        return this._proxy.update(params, callback);
+    }
+    updateWithHttpInfo(params, callback) {
+        return this._proxy.updateWithHttpInfo(params, callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            message: this.message,
+            displayName: this.displayName,
+            description: this.description,
+            id: this.id,
+            status: this.status,
+            createdAt: this.createdAt,
+            updatedAt: this.updatedAt,
+            version: this.version,
+            statusUrl: this.statusUrl,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.KnowledgeBasisInstance = KnowledgeBasisInstance;
+function KnowledgeBasisListInstance(version) {
+    const instance = ((kbId) => instance.get(kbId));
+    instance.get = function get(kbId) {
+        return new KnowledgeBasisContextImpl(version, kbId);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/ControlPlane/KnowledgeBases`;
+    instance.create = function create(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new KnowledgeBasisInstance(operationVersion, payload));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.createWithHttpInfo = function createWithHttpInfo(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .createWithResponseInfo({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new KnowledgeBasisInstance(operationVersion, response.body),
+        }));
+        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["pageToken"] !== undefined)
+            data["pageToken"] = params["pageToken"];
+        if (params["orderBy"] !== undefined)
+            data["orderBy"] = params["orderBy"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new KnowledgeBasisPage(operationVersion, payload, instance._uri, data, 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 KnowledgeBasisPage(instance._version, payload, instance._uri, {}, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    instance.pageWithHttpInfo = function pageWithHttpInfo(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["pageSize"] = params["pageSize"];
+        if (params["pageToken"] !== undefined)
+            data["pageToken"] = params["pageToken"];
+        if (params["orderBy"] !== undefined)
+            data["orderBy"] = params["orderBy"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // For page operations, use page() directly as it already returns { statusCode, body, headers }
+        // IMPORTANT: Pass full response to Page constructor, not response.body
+        let operationPromise = operationVersion
+            .page({ uri: instance._uri, method: "get", params: data, headers })
+            .then((response) => ({
+            statusCode: response.statusCode,
+            headers: response.headers,
+            body: new KnowledgeBasisPage(operationVersion, response, instance._uri, data, instance._solution),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.eachWithHttpInfo = instance._version.eachWithHttpInfo;
+    instance.list = instance._version.list;
+    instance.listWithHttpInfo = instance._version.listWithHttpInfo;
+    instance.getPageWithHttpInfo = function getPageWithHttpInfo(targetUrl, callback) {
+        // Use request() directly as it already returns { statusCode, body, headers }
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((response) => ({
+            statusCode: response.statusCode,
+            headers: response.headers,
+            body: new KnowledgeBasisPage(instance._version, response, instance._uri, {}, 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;
+}
+class KnowledgeBasisPage extends TokenPage_1.default {
+    /**
+     * Initialize the KnowledgeBasisPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param uri - URI of the resource
+     * @param params - Query parameters
+     * @param solution - Path solution
+     */
+    constructor(version, response, uri, params, solution) {
+        super(version, response, uri, params, solution);
+    }
+    /**
+     * Build an instance of KnowledgeBasisInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new KnowledgeBasisInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.KnowledgeBasisPage = KnowledgeBasisPage;

package/lib/rest/knowledge/v2/operation.d.ts

@@ -0,0 +1,162 @@
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+import { ApiResponse } from "../../../base/ApiResponse";
+export declare class OperationResultResourceId {
+    "type": string;
+    /**
+     * The identifier of the created or affected resource.
+     */
+    "id": string;
+    constructor(payload: any);
+}
+export declare class OperationStatusError {
+    /**
+     * A URI reference identifying the problem type.
+     */
+    "type"?: string;
+    /**
+     * A short, human-readable summary of the problem type.
+     */
+    "title"?: string;
+    /**
+     * The numeric Twilio error code.
+     */
+    "code"?: number;
+    /**
+     * A human-readable explanation specific to this occurrence of the problem.
+     */
+    "detail"?: string;
+    constructor(payload: any);
+}
+export interface OperationContext {
+    /**
+     * Fetch a OperationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance
+     */
+    fetch(callback?: (error: Error | null, item?: OperationInstance) => any): Promise<OperationInstance>;
+    /**
+     * Fetch a OperationInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<OperationInstance>) => any): Promise<ApiResponse<OperationInstance>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface OperationContextSolution {
+    operationId: string;
+}
+export declare class OperationContextImpl implements OperationContext {
+    protected _version: V2;
+    protected _solution: OperationContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, operationId: string);
+    fetch(callback?: (error: Error | null, item?: OperationInstance) => any): Promise<OperationInstance>;
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<OperationInstance>) => any): Promise<ApiResponse<OperationInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): OperationContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface OperationResource {
+    operationId: string;
+    status: string;
+    createdAt: Date;
+    statusUrl: string;
+    completedAt: Date;
+    result: OperationResultResourceId;
+    error: OperationStatusError;
+    resultUrl: string;
+}
+export declare class OperationInstance {
+    protected _version: V2;
+    protected _solution: OperationContextSolution;
+    protected _context?: OperationContext;
+    constructor(_version: V2, _payload: OperationResource, operationId?: string);
+    /**
+     * The unique identifier for this operation.
+     */
+    operationId: string;
+    /**
+     * The current status of the operation.
+     */
+    status: string;
+    /**
+     * When the operation was created.
+     */
+    createdAt: Date;
+    /**
+     * URI to check operation status.
+     */
+    statusUrl: string;
+    /**
+     * When the operation completed or failed.
+     */
+    completedAt: Date;
+    result: OperationResultResourceId;
+    error: OperationStatusError;
+    /**
+     * URL to fetch the resulting resource.
+     */
+    resultUrl: string;
+    private get _proxy();
+    /**
+     * Fetch a OperationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance
+     */
+    fetch(callback?: (error: Error | null, item?: OperationInstance) => any): Promise<OperationInstance>;
+    /**
+     * Fetch a OperationInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<OperationInstance>) => any): Promise<ApiResponse<OperationInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        operationId: string;
+        status: string;
+        createdAt: Date;
+        statusUrl: string;
+        completedAt: Date;
+        result: OperationResultResourceId;
+        error: OperationStatusError;
+        resultUrl: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface OperationSolution {
+}
+export interface OperationListInstance {
+    _version: V2;
+    _solution: OperationSolution;
+    _uri: string;
+    (operationId: string): OperationContext;
+    get(operationId: string): OperationContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function OperationListInstance(version: V2): OperationListInstance;
+export {};