@botpress/api 0.27.12 → 0.27.14

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.
@@ -5571,6 +5571,42 @@ export declare const state: {
5571
5571
  };
5572
5572
  };
5573
5573
  };
5574
+ getWorkspaceMember: {
5575
+ name: string;
5576
+ description: string;
5577
+ section: "workspaceMember";
5578
+ method: "get";
5579
+ path: string;
5580
+ response: {
5581
+ description: string;
5582
+ schema: {
5583
+ type: "object";
5584
+ properties: {
5585
+ id: {
5586
+ type: "string";
5587
+ };
5588
+ userId: {
5589
+ type: "string";
5590
+ format: string;
5591
+ };
5592
+ email: {
5593
+ type: "string";
5594
+ };
5595
+ createdAt: {
5596
+ type: "string";
5597
+ };
5598
+ role: {
5599
+ type: "string";
5600
+ enum: string[];
5601
+ };
5602
+ };
5603
+ required: string[];
5604
+ title: string;
5605
+ additionalProperties: false;
5606
+ };
5607
+ };
5608
+ parameters: {};
5609
+ };
5574
5610
  deleteWorkspaceMember: {
5575
5611
  name: string;
5576
5612
  description: string;
@@ -7712,7 +7748,7 @@ export declare const state: {
7712
7748
  type: "number";
7713
7749
  description: string;
7714
7750
  };
7715
- indexingCount: {
7751
+ staleCount: {
7716
7752
  type: "number";
7717
7753
  description: string;
7718
7754
  };
@@ -7763,6 +7799,10 @@ export declare const state: {
7763
7799
  };
7764
7800
  description: string;
7765
7801
  };
7802
+ isComputeEnabled: {
7803
+ type: "boolean";
7804
+ description: string;
7805
+ };
7766
7806
  };
7767
7807
  required: string[];
7768
7808
  title: string;
@@ -7786,7 +7826,7 @@ export declare const state: {
7786
7826
  type: "number";
7787
7827
  description: string;
7788
7828
  };
7789
- indexingCount: {
7829
+ staleCount: {
7790
7830
  type: "number";
7791
7831
  description: string;
7792
7832
  };
@@ -7835,6 +7875,10 @@ export declare const state: {
7835
7875
  };
7836
7876
  description: string;
7837
7877
  };
7878
+ isComputeEnabled: {
7879
+ type: "boolean";
7880
+ description: string;
7881
+ };
7838
7882
  };
7839
7883
  required: string[];
7840
7884
  title: string;
@@ -7949,6 +7993,10 @@ export declare const state: {
7949
7993
  };
7950
7994
  description: string;
7951
7995
  };
7996
+ isComputeEnabled: {
7997
+ type: "boolean";
7998
+ description: string;
7999
+ };
7952
8000
  };
7953
8001
  title: string;
7954
8002
  additionalProperties: false;
@@ -7963,6 +8011,13 @@ export declare const state: {
7963
8011
  table: {
7964
8012
  $ref: string;
7965
8013
  };
8014
+ staleColumns: {
8015
+ type: "array";
8016
+ items: {
8017
+ type: "string";
8018
+ };
8019
+ description: string;
8020
+ };
7966
8021
  };
7967
8022
  required: string[];
7968
8023
  title: string;
@@ -8201,6 +8256,10 @@ export declare const state: {
8201
8256
  minItems: number;
8202
8257
  maxItems: number;
8203
8258
  };
8259
+ waitComputed: {
8260
+ type: "boolean";
8261
+ description: string;
8262
+ };
8204
8263
  };
8205
8264
  required: string[];
8206
8265
  title: string;
@@ -8328,6 +8387,10 @@ export declare const state: {
8328
8387
  maxItems: number;
8329
8388
  description: string;
8330
8389
  };
8390
+ waitComputed: {
8391
+ type: "boolean";
8392
+ description: string;
8393
+ };
8331
8394
  };
8332
8395
  required: string[];
8333
8396
  title: string;
@@ -8405,6 +8468,10 @@ export declare const state: {
8405
8468
  maxLength: number;
8406
8469
  description: string;
8407
8470
  };
8471
+ waitComputed: {
8472
+ type: "boolean";
8473
+ description: string;
8474
+ };
8408
8475
  };
8409
8476
  required: string[];
8410
8477
  title: string;
@@ -8636,6 +8703,7 @@ export declare const state: {
8636
8703
  deleteWorkspaceResponse: true;
8637
8704
  getAuditRecordsResponse: true;
8638
8705
  listWorkspaceMembersResponse: true;
8706
+ getWorkspaceMemberResponse: true;
8639
8707
  deleteWorkspaceMemberResponse: true;
8640
8708
  createWorkspaceMemberResponse: true;
8641
8709
  updateWorkspaceMemberResponse: true;
@@ -10209,6 +10277,53 @@ export declare const state: {
10209
10277
  type: "boolean";
10210
10278
  description: string;
10211
10279
  };
10280
+ hidden: {
10281
+ type: "boolean";
10282
+ description: string;
10283
+ };
10284
+ order: {
10285
+ type: "number";
10286
+ description: string;
10287
+ };
10288
+ width: {
10289
+ type: "number";
10290
+ description: string;
10291
+ };
10292
+ computed: {
10293
+ type: "object";
10294
+ properties: {
10295
+ action: {
10296
+ type: "string";
10297
+ enum: string[];
10298
+ };
10299
+ dependencies: {
10300
+ default: never[];
10301
+ type: "array";
10302
+ items: {
10303
+ type: "string";
10304
+ };
10305
+ };
10306
+ prompt: {
10307
+ type: "string";
10308
+ description: string;
10309
+ };
10310
+ model: {
10311
+ default: string;
10312
+ type: "string";
10313
+ enum: string[];
10314
+ description: string;
10315
+ };
10316
+ code: {
10317
+ type: "string";
10318
+ description: string;
10319
+ };
10320
+ enabled: {
10321
+ type: "boolean";
10322
+ };
10323
+ };
10324
+ required: string[];
10325
+ additionalProperties: false;
10326
+ };
10212
10327
  typings: {
10213
10328
  type: "string";
10214
10329
  description: string;
@@ -10250,6 +10365,10 @@ export declare const state: {
10250
10365
  };
10251
10366
  description: string;
10252
10367
  };
10368
+ isComputeEnabled: {
10369
+ type: "boolean";
10370
+ description: string;
10371
+ };
10253
10372
  createdAt: {
10254
10373
  type: "string";
10255
10374
  format: string;
@@ -10297,6 +10416,41 @@ export declare const state: {
10297
10416
  type: "string";
10298
10417
  description: string;
10299
10418
  };
10419
+ computed: {
10420
+ type: "object";
10421
+ properties: {
10422
+ action: {
10423
+ type: "string";
10424
+ enum: string[];
10425
+ };
10426
+ dependencies: {
10427
+ default: never[];
10428
+ type: "array";
10429
+ items: {
10430
+ type: "string";
10431
+ };
10432
+ };
10433
+ prompt: {
10434
+ type: "string";
10435
+ description: string;
10436
+ };
10437
+ model: {
10438
+ default: string;
10439
+ type: "string";
10440
+ enum: string[];
10441
+ description: string;
10442
+ };
10443
+ code: {
10444
+ type: "string";
10445
+ description: string;
10446
+ };
10447
+ enabled: {
10448
+ type: "boolean";
10449
+ };
10450
+ };
10451
+ required: string[];
10452
+ additionalProperties: false;
10453
+ };
10300
10454
  schema: {
10301
10455
  type: "object";
10302
10456
  additionalProperties: true;
@@ -10325,6 +10479,35 @@ export declare const state: {
10325
10479
  format: string;
10326
10480
  description: string;
10327
10481
  };
10482
+ computed: {
10483
+ type: "object";
10484
+ additionalProperties: {
10485
+ type: "object";
10486
+ properties: {
10487
+ status: {
10488
+ type: "string";
10489
+ };
10490
+ error: {
10491
+ type: "string";
10492
+ };
10493
+ updatedBy: {
10494
+ type: "string";
10495
+ };
10496
+ updatedAt: {
10497
+ type: "string";
10498
+ };
10499
+ };
10500
+ required: string[];
10501
+ additionalProperties: false;
10502
+ };
10503
+ };
10504
+ stale: {
10505
+ type: "array";
10506
+ items: {
10507
+ type: "string";
10508
+ };
10509
+ description: string;
10510
+ };
10328
10511
  similarity: {
10329
10512
  type: "number";
10330
10513
  description: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.27.12",
3
+ "version": "0.27.14",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {
@@ -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","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","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":"Operations related to file management.","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."}]}
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","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":"Operations related to file management.","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."}]}