twilio 6.0.0 → 6.0.2

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

@@ -0,0 +1,175 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationInstance = exports.OperationContextImpl = exports.OperationStatusError = exports.OperationResultResourceId = void 0;
+exports.OperationListInstance = OperationListInstance;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class OperationResultResourceId {
+    constructor(payload) {
+        this.type = payload["type"];
+        this.id = payload["id"];
+    }
+}
+exports.OperationResultResourceId = OperationResultResourceId;
+class OperationStatusError {
+    constructor(payload) {
+        this.type = payload["type"];
+        this.title = payload["title"];
+        this.code = payload["code"];
+        this.detail = payload["detail"];
+    }
+}
+exports.OperationStatusError = OperationStatusError;
+class OperationContextImpl {
+    constructor(_version, operationId) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(operationId)) {
+            throw new Error("Parameter 'operationId' is not valid.");
+        }
+        this._solution = { operationId };
+        this._uri = `/ControlPlane/Operations/${operationId}`;
+    }
+    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 OperationInstance(operationVersion, payload, instance._solution.operationId));
+        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 OperationInstance(operationVersion, response.body, instance._solution.operationId),
+        }));
+        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.OperationContextImpl = OperationContextImpl;
+class OperationInstance {
+    constructor(_version, _payload, operationId) {
+        this._version = _version;
+        const payload = _payload;
+        this.operationId = payload.operationId;
+        this.status = payload.status;
+        this.createdAt = deserialize.iso8601DateTime(payload.createdAt);
+        this.statusUrl = payload.statusUrl;
+        this.completedAt = deserialize.iso8601DateTime(payload.completedAt);
+        this.result =
+            payload.result !== null && payload.result !== undefined
+                ? new OperationResultResourceId(payload.result)
+                : null;
+        this.error =
+            payload.error !== null && payload.error !== undefined
+                ? new OperationStatusError(payload.error)
+                : null;
+        this.resultUrl = payload.resultUrl;
+        this._solution = { operationId: operationId };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new OperationContextImpl(this._version, this._solution.operationId);
+        return this._context;
+    }
+    /**
+     * Fetch a OperationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Fetch a OperationInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperationInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback) {
+        return this._proxy.fetchWithHttpInfo(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            operationId: this.operationId,
+            status: this.status,
+            createdAt: this.createdAt,
+            statusUrl: this.statusUrl,
+            completedAt: this.completedAt,
+            result: this.result,
+            error: this.error,
+            resultUrl: this.resultUrl,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.OperationInstance = OperationInstance;
+function OperationListInstance(version) {
+    const instance = ((operationId) => instance.get(operationId));
+    instance.get = function get(operationId) {
+        return new OperationContextImpl(version, operationId);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = ``;
+    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;
+}

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

@@ -0,0 +1,180 @@
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+import { ApiResponse } from "../../../base/ApiResponse";
+export declare class KnowledgeChunkResult {
+    /**
+     * The chunk content.
+     */
+    "content"?: string;
+    /**
+     * The date and time in GMT when the Chunk was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    "createdAt"?: Date;
+    /**
+     * The score associated with the chunk.
+     */
+    "score"?: number;
+    /**
+     * The unique identifier of knowledge source.
+     */
+    "knowledgeId"?: string;
+    constructor(payload: any);
+}
+/**
+ * Request payload for performing semantic search across knowledge sources within the knowledge base..  Allows querying with natural language text and filtering by specific knowledge  sources to find the most relevant content chunks.
+ */
+export declare class KnowledgeSearch {
+    /**
+     * The query to search the knowledge source.
+     */
+    "query": string;
+    /**
+     * The top K results to return.
+     */
+    "top": number;
+    /**
+     * The list of knowledge IDs to search.
+     */
+    "knowledgeIds"?: Array<string>;
+    constructor(payload: any);
+}
+/**
+ * Options to pass to create a SearchInstance
+ */
+export interface SearchContextCreateOptions {
+    /**  */
+    knowledgeSearch?: KnowledgeSearch;
+}
+export interface SearchContext {
+    /**
+     * Create a SearchInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance
+     */
+    create(callback?: (error: Error | null, item?: SearchInstance) => any): Promise<SearchInstance>;
+    /**
+     * Create a SearchInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance
+     */
+    create(params: KnowledgeSearch, headers?: any, callback?: (error: Error | null, item?: SearchInstance) => any): Promise<SearchInstance>;
+    /**
+     * Create a SearchInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance with HTTP metadata
+     */
+    createWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<SearchInstance>) => any): Promise<ApiResponse<SearchInstance>>;
+    /**
+     * Create a SearchInstance and return HTTP info
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance with HTTP metadata
+     */
+    createWithHttpInfo(params: KnowledgeSearch, headers?: any, callback?: (error: Error | null, item?: ApiResponse<SearchInstance>) => any): Promise<ApiResponse<SearchInstance>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface SearchContextSolution {
+    kbId: string;
+}
+export declare class SearchContextImpl implements SearchContext {
+    protected _version: V2;
+    protected _solution: SearchContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, kbId: string);
+    create(params?: KnowledgeSearch | ((error: Error | null, item?: SearchInstance) => any), headers?: any, callback?: (error: Error | null, item?: SearchInstance) => any): Promise<SearchInstance>;
+    createWithHttpInfo(params?: KnowledgeSearch | ((error: Error | null, item?: ApiResponse<SearchInstance>) => any), headers?: any, callback?: (error: Error | null, item?: ApiResponse<SearchInstance>) => any): Promise<ApiResponse<SearchInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): SearchContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface SearchResource {
+    chunks: Array<KnowledgeChunkResult>;
+}
+export declare class SearchInstance {
+    protected _version: V2;
+    protected _solution: SearchContextSolution;
+    protected _context?: SearchContext;
+    constructor(_version: V2, _payload: SearchResource, kbId?: string);
+    chunks: Array<KnowledgeChunkResult>;
+    private get _proxy();
+    /**
+     * Create a SearchInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance
+     */
+    create(callback?: (error: Error | null, item?: SearchInstance) => any): Promise<SearchInstance>;
+    /**
+     * Create a SearchInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance
+     */
+    create(params: KnowledgeSearch, headers?: any, callback?: (error: Error | null, item?: SearchInstance) => any): Promise<SearchInstance>;
+    /**
+     * Create a SearchInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance with HTTP metadata
+     */
+    createWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<SearchInstance>) => any): Promise<ApiResponse<SearchInstance>>;
+    /**
+     * Create a SearchInstance and return HTTP info
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SearchInstance with HTTP metadata
+     */
+    createWithHttpInfo(params: KnowledgeSearch, headers?: any, callback?: (error: Error | null, item?: ApiResponse<SearchInstance>) => any): Promise<ApiResponse<SearchInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        chunks: KnowledgeChunkResult[];
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface SearchSolution {
+}
+export interface SearchListInstance {
+    _version: V2;
+    _solution: SearchSolution;
+    _uri: string;
+    (kbId: string): SearchContext;
+    get(kbId: string): SearchContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function SearchListInstance(version: V2): SearchListInstance;
+export {};

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

@@ -0,0 +1,174 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchInstance = exports.SearchContextImpl = exports.KnowledgeSearch = exports.KnowledgeChunkResult = void 0;
+exports.SearchListInstance = SearchListInstance;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class KnowledgeChunkResult {
+    constructor(payload) {
+        this.content = payload["content"];
+        this.createdAt = payload["createdAt"];
+        this.score = payload["score"];
+        this.knowledgeId = payload["knowledgeId"];
+    }
+}
+exports.KnowledgeChunkResult = KnowledgeChunkResult;
+/**
+ * Request payload for performing semantic search across knowledge sources within the knowledge base..  Allows querying with natural language text and filtering by specific knowledge  sources to find the most relevant content chunks.
+ */
+class KnowledgeSearch {
+    constructor(payload) {
+        this.query = payload["query"];
+        this.top = payload["top"];
+        this.knowledgeIds = payload["knowledgeIds"];
+    }
+}
+exports.KnowledgeSearch = KnowledgeSearch;
+class SearchContextImpl {
+    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 = `/KnowledgeBases/${kbId}/Search`;
+    }
+    create(params, headers, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        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.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new SearchInstance(operationVersion, payload, instance._solution.kbId));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    createWithHttpInfo(params, headers, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        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
+            .createWithResponseInfo({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new SearchInstance(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.SearchContextImpl = SearchContextImpl;
+class SearchInstance {
+    constructor(_version, _payload, kbId) {
+        this._version = _version;
+        const payload = _payload;
+        this.chunks =
+            payload.chunks !== null && payload.chunks !== undefined
+                ? payload.chunks.map((payload) => new KnowledgeChunkResult(payload))
+                : null;
+        this._solution = { kbId: kbId };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new SearchContextImpl(this._version, this._solution.kbId);
+        return this._context;
+    }
+    create(params, callback) {
+        return this._proxy.create(params, callback);
+    }
+    createWithHttpInfo(params, callback) {
+        return this._proxy.createWithHttpInfo(params, callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            chunks: this.chunks,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.SearchInstance = SearchInstance;
+function SearchListInstance(version) {
+    const instance = ((kbId) => instance.get(kbId));
+    instance.get = function get(kbId) {
+        return new SearchContextImpl(version, kbId);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = ``;
+    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;
+}

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

@@ -0,0 +1,76 @@
+import MemoryBase from "../MemoryBase";
+import Version from "../../base/Version";
+import { BulkContext } from "./v1/bulk";
+import { ConversationSummaryListInstance, ConversationSummaryContext } from "./v1/conversationSummary";
+import { DataMappingListInstance, DataMappingContext } from "./v1/dataMapping";
+import { EventListInstance } from "./v1/event";
+import { IdentifierListInstance, IdentifierContext } from "./v1/identifier";
+import { IdentityResolutionSettingContext } from "./v1/identityResolutionSetting";
+import { ImportListInstance, ImportContext } from "./v1/import";
+import { LookupListInstance } from "./v1/lookup";
+import { ObservationListInstance, ObservationContext } from "./v1/observation";
+import { OperationListInstance } from "./v1/operation";
+import { ProfileListInstance, ProfileContext } from "./v1/profile";
+import { RecallListInstance } from "./v1/recall";
+import { RevisionListInstance } from "./v1/revision";
+import { StoreListInstance } from "./v1/store";
+import { TraitListInstance } from "./v1/trait";
+import { TraitGroupListInstance, TraitGroupContext } from "./v1/traitGroup";
+export default class V1 extends Version {
+    /**
+     * Initialize the V1 version of Memory
+     *
+     * @param domain - The Twilio (Twilio.Memory) domain
+     */
+    constructor(domain: MemoryBase);
+    /** operations - { Twilio.Memory.V1.OperationListInstance } resource */
+    protected _operations?: OperationListInstance;
+    /** stores - { Twilio.Memory.V1.StoreListInstance } resource */
+    protected _stores?: StoreListInstance;
+    /** Accessor for bulk resource */
+    bulk(storeId: string): BulkContext;
+    /** Accessor for conversationSummaries resource - list operations */
+    conversationSummaries(storeId: string, profileId: string): ConversationSummaryListInstance;
+    /** Accessor for conversationSummaries resource - instance operations */
+    conversationSummaries(storeId: string, profileId: string, summaryId: string): ConversationSummaryContext;
+    /** Accessor for dataMappings resource - list operations */
+    dataMappings(storeId: string): DataMappingListInstance;
+    /** Accessor for dataMappings resource - instance operations */
+    dataMappings(storeId: string, dataMappingId: string): DataMappingContext;
+    /** Accessor for events resource */
+    events(storeId: string, profileId: string): EventListInstance;
+    /** Accessor for identifiers resource - list operations */
+    identifiers(storeId: string, profileId: string): IdentifierListInstance;
+    /** Accessor for identifiers resource - instance operations */
+    identifiers(storeId: string, profileId: string, idType: string): IdentifierContext;
+    /** Accessor for identityResolutionSettings resource */
+    identityResolutionSettings(storeId: string): IdentityResolutionSettingContext;
+    /** Accessor for imports resource - list operations */
+    imports(storeId: string): ImportListInstance;
+    /** Accessor for imports resource - instance operations */
+    imports(storeId: string, importId: string): ImportContext;
+    /** Accessor for lookup resource */
+    lookup(storeId: string): LookupListInstance;
+    /** Accessor for observations resource - list operations */
+    observations(storeId: string, profileId: string): ObservationListInstance;
+    /** Accessor for observations resource - instance operations */
+    observations(storeId: string, profileId: string, observationId: string): ObservationContext;
+    /** Getter for operations resource */
+    get operations(): OperationListInstance;
+    /** Accessor for profiles resource - list operations */
+    profiles(storeId: string): ProfileListInstance;
+    /** Accessor for profiles resource - instance operations */
+    profiles(storeId: string, profileId: string): ProfileContext;
+    /** Accessor for recall resource */
+    recall(storeId: string, profileId: string): RecallListInstance;
+    /** Accessor for revisions resource */
+    revisions(storeId: string, profileId: string, observationId: string): RevisionListInstance;
+    /** Getter for stores resource */
+    get stores(): StoreListInstance;
+    /** Accessor for traits resource */
+    traits(storeId: string, profileId: string): TraitListInstance;
+    /** Accessor for traitGroups resource - list operations */
+    traitGroups(storeId: string): TraitGroupListInstance;
+    /** Accessor for traitGroups resource - instance operations */
+    traitGroups(storeId: string, traitGroupName: string): TraitGroupContext;
+}