@botpress/api 0.15.9 → 0.15.11

package/dist/{gen → src/gen}/state.d.ts

@@ -1,5 +1,5 @@
 import * as opapi from "@bpinternal/opapi";
-export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper">;
+export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File" | "Table" | "Column" | "Row", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "tables">;
 export declare const state: {
     operations: {
         createConversation: {
@@ -1438,8 +1438,7 @@ export declare const state: {
                             additionalProperties: true;
                         };
                         result: {
-                            type: "object";
-                            additionalProperties: true;
+                            nullable: true;
                         };
                     };
                     required: string[];
@@ -1613,6 +1612,74 @@ export declare const state: {
                 };
             };
         };
+        setAccountPreference: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            section: "account";
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                key: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        value: {
+                            nullable: true;
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getAccountPreference: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "account";
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                key: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        value: {
+                            nullable: true;
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         listPublicIntegrations: {
             name: string;
             description: string;
@@ -2066,6 +2133,10 @@ export declare const state: {
                         blocked: {
                             type: "boolean";
                         };
+                        alwaysAlive: {
+                            type: "boolean";
+                            description: string;
+                        };
                         user: {
                             type: "object";
                             properties: {
@@ -2273,10 +2344,6 @@ export declare const state: {
                             };
                             description: string;
                         };
-                        alwaysAlive: {
-                            type: "boolean";
-                            description: string;
-                        };
                     };
                     title: string;
                     additionalProperties: false;
@@ -4376,6 +4443,13 @@ export declare const state: {
                             };
                             additionalProperties: false;
                         };
+                        secrets: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
                         code: {
                             type: "string";
                             description: string;
@@ -4738,6 +4812,14 @@ export declare const state: {
                             };
                             additionalProperties: false;
                         };
+                        secrets: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "string";
+                                nullable: true;
+                            };
+                            description: string;
+                        };
                         code: {
                             type: "string";
                             description: string;
@@ -5427,6 +5509,7 @@ export declare const state: {
             configureIntegrationBody: true;
             runVrlBody: true;
             createPersonalAccessTokenBody: true;
+            setAccountPreferenceBody: true;
             createBotBody: true;
             updateBotBody: true;
             transferBotBody: true;
@@ -5479,6 +5562,8 @@ export declare const state: {
             listPersonalAccessTokensResponse: true;
             createPersonalAccessTokenResponse: true;
             deletePersonalAccessTokenResponse: true;
+            setAccountPreferenceResponse: true;
+            getAccountPreferenceResponse: true;
             listPublicIntegrationsResponse: true;
             getPublicIntegrationByIdResponse: true;
             getPublicIntegrationResponse: true;
@@ -5546,6 +5631,9 @@ export declare const state: {
             Message: true;
             State: true;
             File: true;
+            Table: true;
+            Column: true;
+            Row: true;
         };
     };
     schemas: {
@@ -6241,6 +6329,13 @@ export declare const state: {
                         type: "string";
                         description: string;
                     };
+                    secrets: {
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                        description: string;
+                    };
                 };
                 required: string[];
                 additionalProperties: false;
@@ -6750,6 +6845,161 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Table: {
+            section: "tables";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                        description: string;
+                    };
+                    name: {
+                        type: "string";
+                        description: string;
+                    };
+                    factor: {
+                        default: number;
+                        type: "number";
+                        minimum: number;
+                        maximum: number;
+                        description: string;
+                    };
+                    columns: {
+                        type: "array";
+                        items: {
+                            type: "object";
+                            properties: {
+                                id: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                name: {
+                                    type: "string";
+                                    minLength: number;
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                searchable: {
+                                    type: "boolean";
+                                    description: string;
+                                };
+                                type: {
+                                    type: "string";
+                                    enum: string[];
+                                    description: string;
+                                };
+                                typings: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                schema: {
+                                    type: "object";
+                                    properties: {};
+                                    additionalProperties: true;
+                                };
+                            };
+                            required: string[];
+                        };
+                        maxItems: number;
+                        description: string;
+                    };
+                    schema: {
+                        type: "object";
+                        additionalProperties: true;
+                        description: string;
+                    };
+                    tags: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "string";
+                        };
+                        description: string;
+                    };
+                    createdAt: {
+                        type: "string";
+                        description: string;
+                    };
+                    updatedAt: {
+                        type: "string";
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
+        Column: {
+            section: "tables";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                        description: string;
+                    };
+                    name: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    description: {
+                        type: "string";
+                        description: string;
+                    };
+                    searchable: {
+                        type: "boolean";
+                        description: string;
+                    };
+                    type: {
+                        type: "string";
+                        enum: string[];
+                        description: string;
+                    };
+                    typings: {
+                        type: "string";
+                        description: string;
+                    };
+                    schema: {
+                        type: "object";
+                        additionalProperties: true;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
+        Row: {
+            section: "tables";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "number";
+                        description: string;
+                    };
+                    createdAt: {
+                        type: "string";
+                        description: string;
+                    };
+                    updatedAt: {
+                        type: "string";
+                        description: string;
+                    };
+                    similarity: {
+                        type: "number";
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: true;
+            };
+        };
     };
     sections: ({
         description: string;
@@ -6847,6 +7097,12 @@ export declare const state: {
         name: "helper";
         operations: string[];
         schema?: undefined;
+    } | {
+        title: string;
+        description: string;
+        name: "tables";
+        operations: never[];
+        schema: string;
     })[];
     options: {
         allowUnions: false;

package/dist/{index.d.ts → src/index.d.ts}

@@ -1,7 +1,7 @@
 export * from './gen/state';
 export declare const api: {
-    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
-    addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper", Path, "zod-schema">) => void;
+    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File" | "Table" | "Column" | "Row") => import("@bpinternal/opapi").OpenApiZodAny;
+    addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "tables", Path, "zod-schema">) => void;
     exportClient: (dir: string | undefined, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined) => Promise<void>;
     exportTypesBySection: (dir?: string | undefined) => Promise<void>;
     exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@botpress/api",
-  "version": "0.15.9",
+  "version": "0.15.11",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/src/index.d.ts",
   "scripts": {
     "openapi": "es-node openapi/generator.ts && pnpm run build",
     "openapi:lint": "spectral lint --fail-severity warn --ruleset ../../.spectral.yaml src/gen/openapi.json",
@@ -17,9 +17,10 @@
     "@botpress/cloud-manager": "*",
     "@botpress/common": "*",
     "@botpress/storage": "*",
+    "@bpinternal/tables-api": "*",
     "esb-node": "0.0.1",
     "esbuild": "^0.16.10",
-    "zod": "^3.20.6"
+    "zod": "^3.22.4"
   },
   "dependencies": {
     "@bpinternal/opapi": "0.6.3"

package/src/gen/metadata.json

@@ -1 +1 @@
-{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}
+{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Tables","description":"Operations related to table management.","name":"tables","operations":[],"schema":"Table"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}