@botpress/api 0.29.4 → 0.29.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +366 -65
- package/dist/src/gen/state.d.ts +286 -0
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +351 -7
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -2336,6 +2336,63 @@ export declare const state: {
|
|
|
2336
2336
|
maxLength: number;
|
|
2337
2337
|
description: string;
|
|
2338
2338
|
};
|
|
2339
|
+
interfaces: {
|
|
2340
|
+
type: "object";
|
|
2341
|
+
additionalProperties: {
|
|
2342
|
+
type: "object";
|
|
2343
|
+
properties: {
|
|
2344
|
+
id: {
|
|
2345
|
+
type: "string";
|
|
2346
|
+
minLength: number;
|
|
2347
|
+
maxLength: number;
|
|
2348
|
+
};
|
|
2349
|
+
entities: {
|
|
2350
|
+
type: "object";
|
|
2351
|
+
additionalProperties: {
|
|
2352
|
+
type: "object";
|
|
2353
|
+
properties: {
|
|
2354
|
+
name: {
|
|
2355
|
+
type: "string";
|
|
2356
|
+
maxLength: number;
|
|
2357
|
+
};
|
|
2358
|
+
};
|
|
2359
|
+
required: string[];
|
|
2360
|
+
additionalProperties: false;
|
|
2361
|
+
};
|
|
2362
|
+
};
|
|
2363
|
+
actions: {
|
|
2364
|
+
type: "object";
|
|
2365
|
+
additionalProperties: {
|
|
2366
|
+
type: "object";
|
|
2367
|
+
properties: {
|
|
2368
|
+
name: {
|
|
2369
|
+
type: "string";
|
|
2370
|
+
maxLength: number;
|
|
2371
|
+
};
|
|
2372
|
+
};
|
|
2373
|
+
required: string[];
|
|
2374
|
+
additionalProperties: false;
|
|
2375
|
+
};
|
|
2376
|
+
};
|
|
2377
|
+
events: {
|
|
2378
|
+
type: "object";
|
|
2379
|
+
additionalProperties: {
|
|
2380
|
+
type: "object";
|
|
2381
|
+
properties: {
|
|
2382
|
+
name: {
|
|
2383
|
+
type: "string";
|
|
2384
|
+
maxLength: number;
|
|
2385
|
+
};
|
|
2386
|
+
};
|
|
2387
|
+
required: string[];
|
|
2388
|
+
additionalProperties: false;
|
|
2389
|
+
};
|
|
2390
|
+
};
|
|
2391
|
+
};
|
|
2392
|
+
required: string[];
|
|
2393
|
+
additionalProperties: false;
|
|
2394
|
+
};
|
|
2395
|
+
};
|
|
2339
2396
|
configuration: {
|
|
2340
2397
|
type: "object";
|
|
2341
2398
|
properties: {
|
|
@@ -2775,6 +2832,63 @@ export declare const state: {
|
|
|
2775
2832
|
maxLength: number;
|
|
2776
2833
|
description: string;
|
|
2777
2834
|
};
|
|
2835
|
+
interfaces: {
|
|
2836
|
+
type: "object";
|
|
2837
|
+
additionalProperties: {
|
|
2838
|
+
type: "object";
|
|
2839
|
+
properties: {
|
|
2840
|
+
id: {
|
|
2841
|
+
type: "string";
|
|
2842
|
+
minLength: number;
|
|
2843
|
+
maxLength: number;
|
|
2844
|
+
};
|
|
2845
|
+
entities: {
|
|
2846
|
+
type: "object";
|
|
2847
|
+
additionalProperties: {
|
|
2848
|
+
type: "object";
|
|
2849
|
+
properties: {
|
|
2850
|
+
name: {
|
|
2851
|
+
type: "string";
|
|
2852
|
+
maxLength: number;
|
|
2853
|
+
};
|
|
2854
|
+
};
|
|
2855
|
+
required: string[];
|
|
2856
|
+
additionalProperties: false;
|
|
2857
|
+
};
|
|
2858
|
+
};
|
|
2859
|
+
actions: {
|
|
2860
|
+
type: "object";
|
|
2861
|
+
additionalProperties: {
|
|
2862
|
+
type: "object";
|
|
2863
|
+
properties: {
|
|
2864
|
+
name: {
|
|
2865
|
+
type: "string";
|
|
2866
|
+
maxLength: number;
|
|
2867
|
+
};
|
|
2868
|
+
};
|
|
2869
|
+
required: string[];
|
|
2870
|
+
additionalProperties: false;
|
|
2871
|
+
};
|
|
2872
|
+
};
|
|
2873
|
+
events: {
|
|
2874
|
+
type: "object";
|
|
2875
|
+
additionalProperties: {
|
|
2876
|
+
type: "object";
|
|
2877
|
+
properties: {
|
|
2878
|
+
name: {
|
|
2879
|
+
type: "string";
|
|
2880
|
+
maxLength: number;
|
|
2881
|
+
};
|
|
2882
|
+
};
|
|
2883
|
+
required: string[];
|
|
2884
|
+
additionalProperties: false;
|
|
2885
|
+
};
|
|
2886
|
+
};
|
|
2887
|
+
};
|
|
2888
|
+
required: string[];
|
|
2889
|
+
additionalProperties: false;
|
|
2890
|
+
};
|
|
2891
|
+
};
|
|
2778
2892
|
configuration: {
|
|
2779
2893
|
type: "object";
|
|
2780
2894
|
properties: {
|
|
@@ -5949,6 +6063,63 @@ export declare const state: {
|
|
|
5949
6063
|
maxLength: number;
|
|
5950
6064
|
description: string;
|
|
5951
6065
|
};
|
|
6066
|
+
interfaces: {
|
|
6067
|
+
type: "object";
|
|
6068
|
+
additionalProperties: {
|
|
6069
|
+
type: "object";
|
|
6070
|
+
properties: {
|
|
6071
|
+
id: {
|
|
6072
|
+
type: "string";
|
|
6073
|
+
minLength: number;
|
|
6074
|
+
maxLength: number;
|
|
6075
|
+
};
|
|
6076
|
+
entities: {
|
|
6077
|
+
type: "object";
|
|
6078
|
+
additionalProperties: {
|
|
6079
|
+
type: "object";
|
|
6080
|
+
properties: {
|
|
6081
|
+
name: {
|
|
6082
|
+
type: "string";
|
|
6083
|
+
maxLength: number;
|
|
6084
|
+
};
|
|
6085
|
+
};
|
|
6086
|
+
required: string[];
|
|
6087
|
+
additionalProperties: false;
|
|
6088
|
+
};
|
|
6089
|
+
};
|
|
6090
|
+
actions: {
|
|
6091
|
+
type: "object";
|
|
6092
|
+
additionalProperties: {
|
|
6093
|
+
type: "object";
|
|
6094
|
+
properties: {
|
|
6095
|
+
name: {
|
|
6096
|
+
type: "string";
|
|
6097
|
+
maxLength: number;
|
|
6098
|
+
};
|
|
6099
|
+
};
|
|
6100
|
+
required: string[];
|
|
6101
|
+
additionalProperties: false;
|
|
6102
|
+
};
|
|
6103
|
+
};
|
|
6104
|
+
events: {
|
|
6105
|
+
type: "object";
|
|
6106
|
+
additionalProperties: {
|
|
6107
|
+
type: "object";
|
|
6108
|
+
properties: {
|
|
6109
|
+
name: {
|
|
6110
|
+
type: "string";
|
|
6111
|
+
maxLength: number;
|
|
6112
|
+
};
|
|
6113
|
+
};
|
|
6114
|
+
required: string[];
|
|
6115
|
+
additionalProperties: false;
|
|
6116
|
+
};
|
|
6117
|
+
};
|
|
6118
|
+
};
|
|
6119
|
+
required: string[];
|
|
6120
|
+
additionalProperties: false;
|
|
6121
|
+
};
|
|
6122
|
+
};
|
|
5952
6123
|
configuration: {
|
|
5953
6124
|
type: "object";
|
|
5954
6125
|
properties: {
|
|
@@ -6648,6 +6819,64 @@ export declare const state: {
|
|
|
6648
6819
|
additionalProperties: false;
|
|
6649
6820
|
};
|
|
6650
6821
|
};
|
|
6822
|
+
interfaces: {
|
|
6823
|
+
type: "object";
|
|
6824
|
+
additionalProperties: {
|
|
6825
|
+
type: "object";
|
|
6826
|
+
properties: {
|
|
6827
|
+
id: {
|
|
6828
|
+
type: "string";
|
|
6829
|
+
minLength: number;
|
|
6830
|
+
maxLength: number;
|
|
6831
|
+
};
|
|
6832
|
+
entities: {
|
|
6833
|
+
type: "object";
|
|
6834
|
+
additionalProperties: {
|
|
6835
|
+
type: "object";
|
|
6836
|
+
properties: {
|
|
6837
|
+
name: {
|
|
6838
|
+
type: "string";
|
|
6839
|
+
maxLength: number;
|
|
6840
|
+
};
|
|
6841
|
+
};
|
|
6842
|
+
required: string[];
|
|
6843
|
+
additionalProperties: false;
|
|
6844
|
+
};
|
|
6845
|
+
};
|
|
6846
|
+
actions: {
|
|
6847
|
+
type: "object";
|
|
6848
|
+
additionalProperties: {
|
|
6849
|
+
type: "object";
|
|
6850
|
+
properties: {
|
|
6851
|
+
name: {
|
|
6852
|
+
type: "string";
|
|
6853
|
+
maxLength: number;
|
|
6854
|
+
};
|
|
6855
|
+
};
|
|
6856
|
+
required: string[];
|
|
6857
|
+
additionalProperties: false;
|
|
6858
|
+
};
|
|
6859
|
+
};
|
|
6860
|
+
events: {
|
|
6861
|
+
type: "object";
|
|
6862
|
+
additionalProperties: {
|
|
6863
|
+
type: "object";
|
|
6864
|
+
properties: {
|
|
6865
|
+
name: {
|
|
6866
|
+
type: "string";
|
|
6867
|
+
maxLength: number;
|
|
6868
|
+
};
|
|
6869
|
+
};
|
|
6870
|
+
required: string[];
|
|
6871
|
+
additionalProperties: false;
|
|
6872
|
+
};
|
|
6873
|
+
};
|
|
6874
|
+
};
|
|
6875
|
+
required: string[];
|
|
6876
|
+
nullable: true;
|
|
6877
|
+
additionalProperties: false;
|
|
6878
|
+
};
|
|
6879
|
+
};
|
|
6651
6880
|
secrets: {
|
|
6652
6881
|
type: "object";
|
|
6653
6882
|
additionalProperties: {
|
|
@@ -9313,6 +9542,63 @@ export declare const state: {
|
|
|
9313
9542
|
maxLength: number;
|
|
9314
9543
|
description: string;
|
|
9315
9544
|
};
|
|
9545
|
+
interfaces: {
|
|
9546
|
+
type: "object";
|
|
9547
|
+
additionalProperties: {
|
|
9548
|
+
type: "object";
|
|
9549
|
+
properties: {
|
|
9550
|
+
id: {
|
|
9551
|
+
type: "string";
|
|
9552
|
+
minLength: number;
|
|
9553
|
+
maxLength: number;
|
|
9554
|
+
};
|
|
9555
|
+
entities: {
|
|
9556
|
+
type: "object";
|
|
9557
|
+
additionalProperties: {
|
|
9558
|
+
type: "object";
|
|
9559
|
+
properties: {
|
|
9560
|
+
name: {
|
|
9561
|
+
type: "string";
|
|
9562
|
+
maxLength: number;
|
|
9563
|
+
};
|
|
9564
|
+
};
|
|
9565
|
+
required: string[];
|
|
9566
|
+
additionalProperties: false;
|
|
9567
|
+
};
|
|
9568
|
+
};
|
|
9569
|
+
actions: {
|
|
9570
|
+
type: "object";
|
|
9571
|
+
additionalProperties: {
|
|
9572
|
+
type: "object";
|
|
9573
|
+
properties: {
|
|
9574
|
+
name: {
|
|
9575
|
+
type: "string";
|
|
9576
|
+
maxLength: number;
|
|
9577
|
+
};
|
|
9578
|
+
};
|
|
9579
|
+
required: string[];
|
|
9580
|
+
additionalProperties: false;
|
|
9581
|
+
};
|
|
9582
|
+
};
|
|
9583
|
+
events: {
|
|
9584
|
+
type: "object";
|
|
9585
|
+
additionalProperties: {
|
|
9586
|
+
type: "object";
|
|
9587
|
+
properties: {
|
|
9588
|
+
name: {
|
|
9589
|
+
type: "string";
|
|
9590
|
+
maxLength: number;
|
|
9591
|
+
};
|
|
9592
|
+
};
|
|
9593
|
+
required: string[];
|
|
9594
|
+
additionalProperties: false;
|
|
9595
|
+
};
|
|
9596
|
+
};
|
|
9597
|
+
};
|
|
9598
|
+
required: string[];
|
|
9599
|
+
additionalProperties: false;
|
|
9600
|
+
};
|
|
9601
|
+
};
|
|
9316
9602
|
configuration: {
|
|
9317
9603
|
type: "object";
|
|
9318
9604
|
properties: {
|
package/package.json
CHANGED
package/src/gen/metadata.json
CHANGED
|
@@ -1 +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":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","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":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"
|
|
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":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","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":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Office, HTML, CSV, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.","name":"files","operations":["createFile","deleteFile","listFiles","getFile","updateFile","searchFiles"],"schema":"File"}],"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 related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"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."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}
|