@botpress/api 0.20.0 → 0.21.0

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.
@@ -5834,6 +5834,123 @@ export declare const state: {
5834
5834
  };
5835
5835
  };
5836
5836
  };
5837
+ listIntegrationApiKeys: {
5838
+ name: string;
5839
+ description: string;
5840
+ method: "get";
5841
+ section: "integration";
5842
+ path: string;
5843
+ parameters: {
5844
+ integrationVersionId: {
5845
+ in: "query";
5846
+ description: string;
5847
+ type: "string";
5848
+ required: true;
5849
+ };
5850
+ };
5851
+ response: {
5852
+ description: string;
5853
+ schema: {
5854
+ type: "object";
5855
+ properties: {
5856
+ iaks: {
5857
+ type: "array";
5858
+ items: {
5859
+ type: "object";
5860
+ properties: {
5861
+ id: {
5862
+ type: "string";
5863
+ };
5864
+ createdAt: {
5865
+ type: "string";
5866
+ format: string;
5867
+ };
5868
+ note: {
5869
+ type: "string";
5870
+ };
5871
+ };
5872
+ required: string[];
5873
+ };
5874
+ };
5875
+ };
5876
+ required: string[];
5877
+ title: string;
5878
+ additionalProperties: false;
5879
+ };
5880
+ };
5881
+ };
5882
+ createIntegrationApiKey: {
5883
+ name: string;
5884
+ description: string;
5885
+ method: "post";
5886
+ section: "integration";
5887
+ path: string;
5888
+ requestBody: {
5889
+ description: string;
5890
+ schema: {
5891
+ type: "object";
5892
+ properties: {
5893
+ integrationVersionId: {
5894
+ type: "string";
5895
+ };
5896
+ note: {
5897
+ type: "string";
5898
+ };
5899
+ };
5900
+ required: string[];
5901
+ title: string;
5902
+ additionalProperties: false;
5903
+ };
5904
+ };
5905
+ response: {
5906
+ description: string;
5907
+ schema: {
5908
+ type: "object";
5909
+ properties: {
5910
+ id: {
5911
+ type: "string";
5912
+ };
5913
+ createdAt: {
5914
+ type: "string";
5915
+ format: string;
5916
+ };
5917
+ note: {
5918
+ type: "string";
5919
+ };
5920
+ value: {
5921
+ type: "string";
5922
+ description: string;
5923
+ };
5924
+ };
5925
+ required: string[];
5926
+ title: string;
5927
+ additionalProperties: false;
5928
+ };
5929
+ };
5930
+ parameters: {};
5931
+ };
5932
+ deleteIntegrationApiKey: {
5933
+ name: string;
5934
+ description: string;
5935
+ method: "delete";
5936
+ section: "integration";
5937
+ path: string;
5938
+ parameters: {
5939
+ id: {
5940
+ type: "string";
5941
+ description: string;
5942
+ in: "path";
5943
+ };
5944
+ };
5945
+ response: {
5946
+ description: string;
5947
+ schema: {
5948
+ type: "object";
5949
+ title: string;
5950
+ additionalProperties: false;
5951
+ };
5952
+ };
5953
+ };
5837
5954
  createIntegration: {
5838
5955
  name: string;
5839
5956
  description: string;
@@ -7116,7 +7233,7 @@ export declare const state: {
7116
7233
  in: "header";
7117
7234
  };
7118
7235
  "x-index": {
7119
- type: "string";
7236
+ type: "boolean";
7120
7237
  description: string;
7121
7238
  in: "header";
7122
7239
  };
@@ -7143,19 +7260,25 @@ export declare const state: {
7143
7260
  properties: {
7144
7261
  id: {
7145
7262
  type: "string";
7263
+ description: string;
7146
7264
  };
7147
7265
  botId: {
7148
7266
  type: "string";
7267
+ description: string;
7149
7268
  };
7150
7269
  name: {
7151
7270
  type: "string";
7271
+ description: string;
7272
+ nullable: true;
7152
7273
  };
7153
7274
  size: {
7154
7275
  type: "number";
7276
+ description: string;
7155
7277
  nullable: true;
7156
7278
  };
7157
7279
  contentType: {
7158
7280
  type: "string";
7281
+ description: string;
7159
7282
  };
7160
7283
  tags: {
7161
7284
  type: "object";
@@ -7167,22 +7290,27 @@ export declare const state: {
7167
7290
  };
7168
7291
  createdAt: {
7169
7292
  type: "string";
7293
+ description: string;
7170
7294
  };
7171
7295
  updatedAt: {
7172
7296
  type: "string";
7297
+ description: string;
7173
7298
  };
7174
7299
  accessPolicies: {
7175
7300
  type: "array";
7176
7301
  items: {
7177
7302
  type: "string";
7178
7303
  };
7304
+ description: string;
7179
7305
  };
7180
7306
  indexingStatus: {
7181
7307
  type: "string";
7182
7308
  enum: string[];
7309
+ description: string;
7183
7310
  };
7184
7311
  indexingFailureReason: {
7185
7312
  type: "string";
7313
+ description: string;
7186
7314
  };
7187
7315
  };
7188
7316
  required: string[];
@@ -7258,19 +7386,25 @@ export declare const state: {
7258
7386
  properties: {
7259
7387
  id: {
7260
7388
  type: "string";
7389
+ description: string;
7261
7390
  };
7262
7391
  botId: {
7263
7392
  type: "string";
7393
+ description: string;
7264
7394
  };
7265
7395
  name: {
7266
7396
  type: "string";
7397
+ description: string;
7398
+ nullable: true;
7267
7399
  };
7268
7400
  size: {
7269
7401
  type: "number";
7402
+ description: string;
7270
7403
  nullable: true;
7271
7404
  };
7272
7405
  contentType: {
7273
7406
  type: "string";
7407
+ description: string;
7274
7408
  };
7275
7409
  tags: {
7276
7410
  type: "object";
@@ -7282,22 +7416,27 @@ export declare const state: {
7282
7416
  };
7283
7417
  createdAt: {
7284
7418
  type: "string";
7419
+ description: string;
7285
7420
  };
7286
7421
  updatedAt: {
7287
7422
  type: "string";
7423
+ description: string;
7288
7424
  };
7289
7425
  accessPolicies: {
7290
7426
  type: "array";
7291
7427
  items: {
7292
7428
  type: "string";
7293
7429
  };
7430
+ description: string;
7294
7431
  };
7295
7432
  indexingStatus: {
7296
7433
  type: "string";
7297
7434
  enum: string[];
7435
+ description: string;
7298
7436
  };
7299
7437
  indexingFailureReason: {
7300
7438
  type: "string";
7439
+ description: string;
7301
7440
  };
7302
7441
  };
7303
7442
  required: string[];
@@ -7343,19 +7482,25 @@ export declare const state: {
7343
7482
  properties: {
7344
7483
  id: {
7345
7484
  type: "string";
7485
+ description: string;
7346
7486
  };
7347
7487
  botId: {
7348
7488
  type: "string";
7489
+ description: string;
7349
7490
  };
7350
7491
  name: {
7351
7492
  type: "string";
7493
+ description: string;
7494
+ nullable: true;
7352
7495
  };
7353
7496
  size: {
7354
7497
  type: "number";
7498
+ description: string;
7355
7499
  nullable: true;
7356
7500
  };
7357
7501
  contentType: {
7358
7502
  type: "string";
7503
+ description: string;
7359
7504
  };
7360
7505
  tags: {
7361
7506
  type: "object";
@@ -7367,22 +7512,27 @@ export declare const state: {
7367
7512
  };
7368
7513
  createdAt: {
7369
7514
  type: "string";
7515
+ description: string;
7370
7516
  };
7371
7517
  updatedAt: {
7372
7518
  type: "string";
7519
+ description: string;
7373
7520
  };
7374
7521
  accessPolicies: {
7375
7522
  type: "array";
7376
7523
  items: {
7377
7524
  type: "string";
7378
7525
  };
7526
+ description: string;
7379
7527
  };
7380
7528
  indexingStatus: {
7381
7529
  type: "string";
7382
7530
  enum: string[];
7531
+ description: string;
7383
7532
  };
7384
7533
  indexingFailureReason: {
7385
7534
  type: "string";
7535
+ description: string;
7386
7536
  };
7387
7537
  };
7388
7538
  required: string[];
@@ -7507,12 +7657,12 @@ export declare const state: {
7507
7657
  };
7508
7658
  contextDepth: {
7509
7659
  in: "query";
7510
- type: "string";
7660
+ type: "integer";
7511
7661
  description: string;
7512
7662
  };
7513
7663
  limit: {
7514
7664
  in: "query";
7515
- type: "string";
7665
+ type: "integer";
7516
7666
  description: string;
7517
7667
  };
7518
7668
  };
@@ -7526,22 +7676,44 @@ export declare const state: {
7526
7676
  items: {
7527
7677
  type: "object";
7528
7678
  properties: {
7529
- fileId: {
7679
+ content: {
7530
7680
  type: "string";
7681
+ description: string;
7531
7682
  };
7532
7683
  score: {
7533
7684
  type: "number";
7685
+ description: string;
7534
7686
  };
7535
- content: {
7536
- type: "string";
7537
- };
7538
- tags: {
7687
+ file: {
7539
7688
  type: "object";
7540
- additionalProperties: {
7541
- type: "string";
7542
- maxLength: number;
7689
+ properties: {
7690
+ id: {
7691
+ type: "string";
7692
+ description: string;
7693
+ };
7694
+ name: {
7695
+ type: "string";
7696
+ description: string;
7697
+ nullable: true;
7698
+ };
7699
+ tags: {
7700
+ type: "object";
7701
+ additionalProperties: {
7702
+ type: "string";
7703
+ maxLength: number;
7704
+ };
7705
+ description: string;
7706
+ };
7707
+ createdAt: {
7708
+ type: "string";
7709
+ description: string;
7710
+ };
7711
+ updatedAt: {
7712
+ type: "string";
7713
+ description: string;
7714
+ };
7543
7715
  };
7544
- description: string;
7716
+ required: string[];
7545
7717
  };
7546
7718
  };
7547
7719
  required: string[];
@@ -7627,6 +7799,76 @@ export declare const state: {
7627
7799
  };
7628
7800
  };
7629
7801
  };
7802
+ getOrCreateTable: {
7803
+ name: string;
7804
+ path: string;
7805
+ description: string;
7806
+ parameters: {
7807
+ table: {
7808
+ type: "string";
7809
+ description: string;
7810
+ in: "path";
7811
+ };
7812
+ };
7813
+ method: "post";
7814
+ requestBody: {
7815
+ description: string;
7816
+ schema: {
7817
+ type: "object";
7818
+ properties: {
7819
+ factor: {
7820
+ default: number;
7821
+ type: "number";
7822
+ minimum: number;
7823
+ maximum: number;
7824
+ description: string;
7825
+ };
7826
+ schema: {
7827
+ type: "object";
7828
+ additionalProperties: true;
7829
+ description: string;
7830
+ };
7831
+ tags: {
7832
+ type: "object";
7833
+ additionalProperties: {
7834
+ type: "string";
7835
+ };
7836
+ description: string;
7837
+ };
7838
+ };
7839
+ required: string[];
7840
+ title: string;
7841
+ additionalProperties: false;
7842
+ };
7843
+ };
7844
+ section: "tables";
7845
+ response: {
7846
+ description: string;
7847
+ schema: {
7848
+ type: "object";
7849
+ properties: {
7850
+ table: {
7851
+ $ref: string;
7852
+ };
7853
+ created: {
7854
+ type: "boolean";
7855
+ description: string;
7856
+ };
7857
+ rows: {
7858
+ type: "number";
7859
+ description: string;
7860
+ };
7861
+ indexingCount: {
7862
+ type: "number";
7863
+ description: string;
7864
+ };
7865
+ };
7866
+ required: string[];
7867
+ title: string;
7868
+ additionalProperties: false;
7869
+ };
7870
+ };
7871
+ };
7630
7872
  createTable: {
7631
7873
  name: string;
7632
7874
  path: string;
@@ -7684,6 +7926,59 @@ export declare const state: {
7684
7926
  };
7685
7927
  parameters: {};
7686
7928
  };
7929
+ duplicateTable: {
7930
+ name: string;
7931
+ path: string;
7932
+ description: string;
7933
+ parameters: {
7934
+ sourceTableId: {
7935
+ type: "string";
7936
+ description: string;
7937
+ in: "path";
7938
+ };
7939
+ };
7940
+ method: "post";
7941
+ requestBody: {
7942
+ description: string;
7943
+ schema: {
7944
+ type: "object";
7945
+ properties: {
7946
+ tableName: {
7947
+ type: "string";
7948
+ };
7949
+ schemaOnly: {
7950
+ type: "boolean";
7951
+ description: string;
7952
+ };
7953
+ factor: {
7954
+ type: "number";
7955
+ description: string;
7956
+ };
7957
+ };
7958
+ title: string;
7959
+ additionalProperties: false;
7960
+ };
7961
+ };
7962
+ section: "tables";
7963
+ response: {
7964
+ description: string;
7965
+ schema: {
7966
+ type: "object";
7967
+ properties: {
7968
+ table: {
7969
+ $ref: string;
7970
+ };
7971
+ rows: {
7972
+ type: "number";
7973
+ description: string;
7974
+ };
7975
+ };
7976
+ required: string[];
7977
+ title: string;
7978
+ additionalProperties: false;
7979
+ };
7980
+ };
7981
+ };
7687
7982
  updateTable: {
7688
7983
  name: string;
7689
7984
  path: string;
@@ -8301,13 +8596,16 @@ export declare const state: {
8301
8596
  changeWorkspacePlanBody: true;
8302
8597
  createWorkspaceMemberBody: true;
8303
8598
  updateWorkspaceMemberBody: true;
8599
+ createIntegrationApiKeyBody: true;
8304
8600
  createIntegrationBody: true;
8305
8601
  updateIntegrationBody: true;
8306
8602
  changeAISpendQuotaBody: true;
8307
8603
  introspectBody: true;
8308
8604
  createFileBody: true;
8309
8605
  updateFileMetadataBody: true;
8606
+ getOrCreateTableBody: true;
8310
8607
  createTableBody: true;
8608
+ duplicateTableBody: true;
8311
8609
  updateTableBody: true;
8312
8610
  renameTableColumnBody: true;
8313
8611
  findTableRowsBody: true;
@@ -8399,6 +8697,9 @@ export declare const state: {
8399
8697
  deleteWorkspaceMemberResponse: true;
8400
8698
  createWorkspaceMemberResponse: true;
8401
8699
  updateWorkspaceMemberResponse: true;
8700
+ listIntegrationApiKeysResponse: true;
8701
+ createIntegrationApiKeyResponse: true;
8702
+ deleteIntegrationApiKeyResponse: true;
8402
8703
  createIntegrationResponse: true;
8403
8704
  updateIntegrationResponse: true;
8404
8705
  listIntegrationsResponse: true;
@@ -8420,7 +8721,9 @@ export declare const state: {
8420
8721
  searchFilesResponse: true;
8421
8722
  listTablesResponse: true;
8422
8723
  getTableResponse: true;
8724
+ getOrCreateTableResponse: true;
8423
8725
  createTableResponse: true;
8726
+ duplicateTableResponse: true;
8424
8727
  updateTableResponse: true;
8425
8728
  renameTableColumnResponse: true;
8426
8729
  deleteTableResponse: true;
@@ -10094,19 +10397,25 @@ export declare const state: {
10094
10397
  properties: {
10095
10398
  id: {
10096
10399
  type: "string";
10400
+ description: string;
10097
10401
  };
10098
10402
  botId: {
10099
10403
  type: "string";
10404
+ description: string;
10100
10405
  };
10101
10406
  name: {
10102
10407
  type: "string";
10408
+ description: string;
10409
+ nullable: true;
10103
10410
  };
10104
10411
  size: {
10105
10412
  type: "number";
10413
+ description: string;
10106
10414
  nullable: true;
10107
10415
  };
10108
10416
  contentType: {
10109
10417
  type: "string";
10418
+ description: string;
10110
10419
  };
10111
10420
  tags: {
10112
10421
  type: "object";
@@ -10118,22 +10427,27 @@ export declare const state: {
10118
10427
  };
10119
10428
  createdAt: {
10120
10429
  type: "string";
10430
+ description: string;
10121
10431
  };
10122
10432
  updatedAt: {
10123
10433
  type: "string";
10434
+ description: string;
10124
10435
  };
10125
10436
  accessPolicies: {
10126
10437
  type: "array";
10127
10438
  items: {
10128
10439
  type: "string";
10129
10440
  };
10441
+ description: string;
10130
10442
  };
10131
10443
  indexingStatus: {
10132
10444
  type: "string";
10133
10445
  enum: string[];
10446
+ description: string;
10134
10447
  };
10135
10448
  indexingFailureReason: {
10136
10449
  type: "string";
10450
+ description: string;
10137
10451
  };
10138
10452
  };
10139
10453
  required: string[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.20.0",
3
+ "version": "0.21.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {
@@ -23,6 +23,6 @@
23
23
  "zod": "^3.22.4"
24
24
  },
25
25
  "dependencies": {
26
- "@bpinternal/opapi": "0.8.1"
26
+ "@bpinternal/opapi": "0.9.0"
27
27
  }
28
28
  }
@@ -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":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","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","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","createTable","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","getFileMetadata","getFileContent","updateFileMetadata","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":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","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","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","getFileMetadata","getFileContent","updateFileMetadata","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."}]}