@botpress/api 0.19.2 → 0.19.4

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.
Files changed (6) hide show
  1. package/dist/index.js +107 -195
  2. package/dist/src/gen/state.d.ts +75 -179
  3. package/package.json +1 -1
  4. package/src/gen/metadata.json +1 -1
  5. package/src/gen/openapi.json +1 -1
  6. package/src/gen/state.ts +107 -195
package/dist/src/gen/state.d.ts CHANGED
@@ -2162,6 +2162,10 @@ export declare const state: {
2162
2162
  type: "string";
2163
2163
  description: string;
2164
2164
  };
2165
+ public: {
2166
+ type: "boolean";
2167
+ description: string;
2168
+ };
2165
2169
  ownerWorkspace: {
2166
2170
  type: "object";
2167
2171
  properties: {
@@ -2590,6 +2594,10 @@ export declare const state: {
2590
2594
  type: "string";
2591
2595
  description: string;
2592
2596
  };
2597
+ public: {
2598
+ type: "boolean";
2599
+ description: string;
2600
+ };
2593
2601
  secrets: {
2594
2602
  type: "array";
2595
2603
  items: {
@@ -3021,6 +3029,10 @@ export declare const state: {
3021
3029
  type: "string";
3022
3030
  description: string;
3023
3031
  };
3032
+ public: {
3033
+ type: "boolean";
3034
+ description: string;
3035
+ };
3024
3036
  secrets: {
3025
3037
  type: "array";
3026
3038
  items: {
@@ -6187,6 +6199,10 @@ export declare const state: {
6187
6199
  maxLength: number;
6188
6200
  description: string;
6189
6201
  };
6202
+ public: {
6203
+ type: "boolean";
6204
+ description: string;
6205
+ };
6190
6206
  };
6191
6207
  required: string[];
6192
6208
  title: string;
@@ -6579,6 +6595,10 @@ export declare const state: {
6579
6595
  type: "string";
6580
6596
  description: string;
6581
6597
  };
6598
+ public: {
6599
+ type: "boolean";
6600
+ description: string;
6601
+ };
6582
6602
  };
6583
6603
  title: string;
6584
6604
  additionalProperties: false;
@@ -6679,6 +6699,10 @@ export declare const state: {
6679
6699
  type: "string";
6680
6700
  description: string;
6681
6701
  };
6702
+ public: {
6703
+ type: "boolean";
6704
+ description: string;
6705
+ };
6682
6706
  };
6683
6707
  required: string[];
6684
6708
  };
@@ -7075,7 +7099,7 @@ export declare const state: {
7075
7099
  };
7076
7100
  };
7077
7101
  parameters: {
7078
- "x-filename": {
7102
+ "x-name": {
7079
7103
  type: "string";
7080
7104
  description: string;
7081
7105
  in: "header";
@@ -7106,30 +7130,6 @@ export declare const state: {
7106
7130
  description: string;
7107
7131
  in: "header";
7108
7132
  };
7109
- "x-bot-id": {
7110
- in: "header";
7111
- description: string;
7112
- type: "string";
7113
- required: true;
7114
- };
7115
- "x-integration-id": {
7116
- in: "header";
7117
- description: string;
7118
- type: "string";
7119
- required: false;
7120
- };
7121
- "x-user-id": {
7122
- in: "header";
7123
- description: string;
7124
- type: "string";
7125
- required: false;
7126
- };
7127
- "x-user-role": {
7128
- in: "header";
7129
- description: string;
7130
- type: "string";
7131
- required: false;
7132
- };
7133
7133
  };
7134
7134
  contentType: "*/*";
7135
7135
  section: "files";
@@ -7147,13 +7147,16 @@ export declare const state: {
7147
7147
  botId: {
7148
7148
  type: "string";
7149
7149
  };
7150
- filename: {
7150
+ name: {
7151
7151
  type: "string";
7152
7152
  };
7153
- bytes: {
7153
+ size: {
7154
7154
  type: "number";
7155
7155
  nullable: true;
7156
7156
  };
7157
+ contentType: {
7158
+ type: "string";
7159
+ };
7157
7160
  tags: {
7158
7161
  type: "object";
7159
7162
  additionalProperties: {
@@ -7204,30 +7207,6 @@ export declare const state: {
7204
7207
  description: string;
7205
7208
  in: "path";
7206
7209
  };
7207
- "x-bot-id": {
7208
- in: "header";
7209
- description: string;
7210
- type: "string";
7211
- required: true;
7212
- };
7213
- "x-integration-id": {
7214
- in: "header";
7215
- description: string;
7216
- type: "string";
7217
- required: false;
7218
- };
7219
- "x-user-id": {
7220
- in: "header";
7221
- description: string;
7222
- type: "string";
7223
- required: false;
7224
- };
7225
- "x-user-role": {
7226
- in: "header";
7227
- description: string;
7228
- type: "string";
7229
- required: false;
7230
- };
7231
7210
  };
7232
7211
  response: {
7233
7212
  description: string;
@@ -7250,39 +7229,21 @@ export declare const state: {
7250
7229
  description: string;
7251
7230
  type: "string";
7252
7231
  };
7253
- "x-bot-id": {
7254
- in: "header";
7255
- description: string;
7256
- type: "string";
7257
- required: true;
7258
- };
7259
- "x-integration-id": {
7260
- in: "header";
7261
- description: string;
7262
- type: "string";
7263
- required: false;
7264
- };
7265
- "x-user-id": {
7266
- in: "header";
7267
- description: string;
7268
- type: "string";
7269
- required: false;
7270
- };
7271
- "x-user-role": {
7272
- in: "header";
7273
- description: string;
7274
- type: "string";
7275
- required: false;
7276
- };
7277
7232
  botId: {
7278
7233
  type: "string";
7279
7234
  description: string;
7280
7235
  in: "path";
7281
7236
  };
7282
7237
  tags: {
7283
- type: "string";
7284
7238
  in: "query";
7285
7239
  description: string;
7240
+ type: "object";
7241
+ schema: {
7242
+ type: "object";
7243
+ additionalProperties: {
7244
+ type: "string";
7245
+ };
7246
+ };
7286
7247
  };
7287
7248
  };
7288
7249
  response: {
@@ -7301,13 +7262,24 @@ export declare const state: {
7301
7262
  botId: {
7302
7263
  type: "string";
7303
7264
  };
7304
- filename: {
7265
+ name: {
7305
7266
  type: "string";
7306
7267
  };
7307
- bytes: {
7268
+ size: {
7308
7269
  type: "number";
7309
7270
  nullable: true;
7310
7271
  };
7272
+ contentType: {
7273
+ type: "string";
7274
+ };
7275
+ tags: {
7276
+ type: "object";
7277
+ additionalProperties: {
7278
+ type: "string";
7279
+ maxLength: number;
7280
+ };
7281
+ description: string;
7282
+ };
7311
7283
  createdAt: {
7312
7284
  type: "string";
7313
7285
  };
@@ -7360,30 +7332,6 @@ export declare const state: {
7360
7332
  description: string;
7361
7333
  in: "path";
7362
7334
  };
7363
- "x-bot-id": {
7364
- in: "header";
7365
- description: string;
7366
- type: "string";
7367
- required: true;
7368
- };
7369
- "x-integration-id": {
7370
- in: "header";
7371
- description: string;
7372
- type: "string";
7373
- required: false;
7374
- };
7375
- "x-user-id": {
7376
- in: "header";
7377
- description: string;
7378
- type: "string";
7379
- required: false;
7380
- };
7381
- "x-user-role": {
7382
- in: "header";
7383
- description: string;
7384
- type: "string";
7385
- required: false;
7386
- };
7387
7335
  };
7388
7336
  response: {
7389
7337
  description: string;
@@ -7399,13 +7347,16 @@ export declare const state: {
7399
7347
  botId: {
7400
7348
  type: "string";
7401
7349
  };
7402
- filename: {
7350
+ name: {
7403
7351
  type: "string";
7404
7352
  };
7405
- bytes: {
7353
+ size: {
7406
7354
  type: "number";
7407
7355
  nullable: true;
7408
7356
  };
7357
+ contentType: {
7358
+ type: "string";
7359
+ };
7409
7360
  tags: {
7410
7361
  type: "object";
7411
7362
  additionalProperties: {
@@ -7456,30 +7407,6 @@ export declare const state: {
7456
7407
  description: string;
7457
7408
  in: "path";
7458
7409
  };
7459
- "x-bot-id": {
7460
- in: "header";
7461
- description: string;
7462
- type: "string";
7463
- required: true;
7464
- };
7465
- "x-integration-id": {
7466
- in: "header";
7467
- description: string;
7468
- type: "string";
7469
- required: false;
7470
- };
7471
- "x-user-id": {
7472
- in: "header";
7473
- description: string;
7474
- type: "string";
7475
- required: false;
7476
- };
7477
- "x-user-role": {
7478
- in: "header";
7479
- description: string;
7480
- type: "string";
7481
- required: false;
7482
- };
7483
7410
  };
7484
7411
  response: {
7485
7412
  description: string;
@@ -7509,30 +7436,6 @@ export declare const state: {
7509
7436
  description: string;
7510
7437
  in: "path";
7511
7438
  };
7512
- "x-bot-id": {
7513
- in: "header";
7514
- description: string;
7515
- type: "string";
7516
- required: true;
7517
- };
7518
- "x-integration-id": {
7519
- in: "header";
7520
- description: string;
7521
- type: "string";
7522
- required: false;
7523
- };
7524
- "x-user-id": {
7525
- in: "header";
7526
- description: string;
7527
- type: "string";
7528
- required: false;
7529
- };
7530
- "x-user-role": {
7531
- in: "header";
7532
- description: string;
7533
- type: "string";
7534
- required: false;
7535
- };
7536
7439
  };
7537
7440
  requestBody: {
7538
7441
  description: string;
@@ -7580,39 +7483,21 @@ export declare const state: {
7580
7483
  method: "get";
7581
7484
  section: "files";
7582
7485
  parameters: {
7583
- "x-bot-id": {
7584
- in: "header";
7585
- description: string;
7586
- type: "string";
7587
- required: true;
7588
- };
7589
- "x-integration-id": {
7590
- in: "header";
7591
- description: string;
7592
- type: "string";
7593
- required: false;
7594
- };
7595
- "x-user-id": {
7596
- in: "header";
7597
- description: string;
7598
- type: "string";
7599
- required: false;
7600
- };
7601
- "x-user-role": {
7602
- in: "header";
7603
- description: string;
7604
- type: "string";
7605
- required: false;
7606
- };
7607
7486
  botId: {
7608
7487
  type: "string";
7609
7488
  description: string;
7610
7489
  in: "path";
7611
7490
  };
7612
7491
  tags: {
7613
- type: "string";
7614
7492
  in: "query";
7615
7493
  description: string;
7494
+ type: "object";
7495
+ schema: {
7496
+ type: "object";
7497
+ additionalProperties: {
7498
+ type: "string";
7499
+ };
7500
+ };
7616
7501
  };
7617
7502
  query: {
7618
7503
  in: "query";
@@ -8668,6 +8553,10 @@ export declare const state: {
8668
8553
  type: "string";
8669
8554
  description: string;
8670
8555
  };
8556
+ public: {
8557
+ type: "boolean";
8558
+ description: string;
8559
+ };
8671
8560
  };
8672
8561
  required: string[];
8673
8562
  additionalProperties: false;
@@ -9354,6 +9243,10 @@ export declare const state: {
9354
9243
  type: "string";
9355
9244
  description: string;
9356
9245
  };
9246
+ public: {
9247
+ type: "boolean";
9248
+ description: string;
9249
+ };
9357
9250
  secrets: {
9358
9251
  type: "array";
9359
9252
  items: {
@@ -10200,13 +10093,16 @@ export declare const state: {
10200
10093
  botId: {
10201
10094
  type: "string";
10202
10095
  };
10203
- filename: {
10096
+ name: {
10204
10097
  type: "string";
10205
10098
  };
10206
- bytes: {
10099
+ size: {
10207
10100
  type: "number";
10208
10101
  nullable: true;
10209
10102
  };
10103
+ contentType: {
10104
+ type: "string";
10105
+ };
10210
10106
  tags: {
10211
10107
  type: "object";
10212
10108
  additionalProperties: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.19.2",
3
+ "version": "0.19.4",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {
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","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."}]}
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."}]}