@botpress/api 1.17.0 → 1.18.1
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 +63 -69
- package/dist/src/gen/admin/state.d.ts +28 -32
- package/dist/src/gen/state.d.ts +28 -32
- package/package.json +1 -1
- package/src/gen/admin/metadata.json +1 -1
- package/src/gen/admin/openapi.json +1 -1
- package/src/gen/admin/state.ts +30 -33
- package/src/gen/files/openapi.json +1 -1
- package/src/gen/files/state.ts +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/runtime/openapi.json +1 -1
- package/src/gen/runtime/state.ts +1 -1
- package/src/gen/state.ts +30 -33
- package/src/gen/tables/openapi.json +1 -1
- package/src/gen/tables/state.ts +1 -1
package/dist/index.js
CHANGED
|
@@ -284126,7 +284126,7 @@ var state = {
|
|
|
284126
284126
|
"title": "Botpress API",
|
|
284127
284127
|
"description": "API for Botpress Cloud",
|
|
284128
284128
|
"server": "https://api.botpress.cloud",
|
|
284129
|
-
"version": "1.
|
|
284129
|
+
"version": "1.18.1",
|
|
284130
284130
|
"prefix": "v1"
|
|
284131
284131
|
},
|
|
284132
284132
|
"errors": [
|
|
@@ -293762,6 +293762,33 @@ var state2 = {
|
|
|
293762
293762
|
}
|
|
293763
293763
|
}
|
|
293764
293764
|
},
|
|
293765
|
+
"unlinkSandboxedConversations": {
|
|
293766
|
+
"name": "unlinkSandboxedConversations",
|
|
293767
|
+
"description": "**EXPERIMENTAL** Unlink all sandboxed conversations for an integration installed in a bot",
|
|
293768
|
+
"method": "delete",
|
|
293769
|
+
"path": "/v1/admin/bots/{botId}/integrations/{integrationId}/sandboxed-conversations",
|
|
293770
|
+
"section": "bot",
|
|
293771
|
+
"parameters": {
|
|
293772
|
+
"botId": {
|
|
293773
|
+
"type": "string",
|
|
293774
|
+
"description": "Bot ID",
|
|
293775
|
+
"in": "path"
|
|
293776
|
+
},
|
|
293777
|
+
"integrationId": {
|
|
293778
|
+
"type": "string",
|
|
293779
|
+
"description": "Integration Version ID",
|
|
293780
|
+
"in": "path"
|
|
293781
|
+
}
|
|
293782
|
+
},
|
|
293783
|
+
"response": {
|
|
293784
|
+
"description": "Success",
|
|
293785
|
+
"schema": {
|
|
293786
|
+
"type": "object",
|
|
293787
|
+
"title": "unlinkSandboxedConversationsResponse",
|
|
293788
|
+
"additionalProperties": false
|
|
293789
|
+
}
|
|
293790
|
+
}
|
|
293791
|
+
},
|
|
293765
293792
|
"listBotApiKeys": {
|
|
293766
293793
|
"name": "listBotApiKeys",
|
|
293767
293794
|
"description": "List BAKs (Bot Api Keys) of a bot",
|
|
@@ -297592,22 +297619,6 @@ var state2 = {
|
|
|
297592
297619
|
"additionalProperties": false
|
|
297593
297620
|
}
|
|
297594
297621
|
},
|
|
297595
|
-
"sandbox": {
|
|
297596
|
-
"type": "object",
|
|
297597
|
-
"properties": {
|
|
297598
|
-
"identifierExtractScript": {
|
|
297599
|
-
"type": "string",
|
|
297600
|
-
"maxLength": 2e3,
|
|
297601
|
-
"nullable": true
|
|
297602
|
-
},
|
|
297603
|
-
"messageExtractScript": {
|
|
297604
|
-
"type": "string",
|
|
297605
|
-
"maxLength": 2e3,
|
|
297606
|
-
"nullable": true
|
|
297607
|
-
}
|
|
297608
|
-
},
|
|
297609
|
-
"additionalProperties": false
|
|
297610
|
-
},
|
|
297611
297622
|
"attributes": {
|
|
297612
297623
|
"type": "object",
|
|
297613
297624
|
"additionalProperties": {
|
|
@@ -298200,22 +298211,6 @@ var state2 = {
|
|
|
298200
298211
|
"additionalProperties": false
|
|
298201
298212
|
}
|
|
298202
298213
|
},
|
|
298203
|
-
"sandbox": {
|
|
298204
|
-
"type": "object",
|
|
298205
|
-
"properties": {
|
|
298206
|
-
"identifierExtractScript": {
|
|
298207
|
-
"type": "string",
|
|
298208
|
-
"maxLength": 2e3,
|
|
298209
|
-
"nullable": true
|
|
298210
|
-
},
|
|
298211
|
-
"messageExtractScript": {
|
|
298212
|
-
"type": "string",
|
|
298213
|
-
"maxLength": 2e3,
|
|
298214
|
-
"nullable": true
|
|
298215
|
-
}
|
|
298216
|
-
},
|
|
298217
|
-
"additionalProperties": false
|
|
298218
|
-
},
|
|
298219
298214
|
"attributes": {
|
|
298220
298215
|
"type": "object",
|
|
298221
298216
|
"additionalProperties": {
|
|
@@ -300949,7 +300944,7 @@ var state2 = {
|
|
|
300949
300944
|
"title": "Botpress API",
|
|
300950
300945
|
"description": "API for Botpress Cloud",
|
|
300951
300946
|
"server": "https://api.botpress.cloud",
|
|
300952
|
-
"version": "1.
|
|
300947
|
+
"version": "1.18.1",
|
|
300953
300948
|
"prefix": "v1"
|
|
300954
300949
|
},
|
|
300955
300950
|
"errors": [
|
|
@@ -301146,6 +301141,7 @@ var state2 = {
|
|
|
301146
301141
|
"createIntegrationShareableIdResponse": true,
|
|
301147
301142
|
"deleteIntegrationShareableIdResponse": true,
|
|
301148
301143
|
"getIntegrationShareableIdResponse": true,
|
|
301144
|
+
"unlinkSandboxedConversationsResponse": true,
|
|
301149
301145
|
"listBotApiKeysResponse": true,
|
|
301150
301146
|
"createBotApiKeyResponse": true,
|
|
301151
301147
|
"deleteBotApiKeyResponse": true,
|
|
@@ -304763,6 +304759,7 @@ var state2 = {
|
|
|
304763
304759
|
"createIntegrationShareableId",
|
|
304764
304760
|
"deleteIntegrationShareableId",
|
|
304765
304761
|
"getIntegrationShareableId",
|
|
304762
|
+
"unlinkSandboxedConversations",
|
|
304766
304763
|
"listBotApiKeys",
|
|
304767
304764
|
"createBotApiKey",
|
|
304768
304765
|
"deleteBotApiKey"
|
|
@@ -306579,7 +306576,7 @@ var state3 = {
|
|
|
306579
306576
|
"title": "Botpress API",
|
|
306580
306577
|
"description": "API for Botpress Cloud",
|
|
306581
306578
|
"server": "https://api.botpress.cloud",
|
|
306582
|
-
"version": "1.
|
|
306579
|
+
"version": "1.18.1",
|
|
306583
306580
|
"prefix": "v1"
|
|
306584
306581
|
},
|
|
306585
306582
|
"errors": [
|
|
@@ -311583,7 +311580,7 @@ var state4 = {
|
|
|
311583
311580
|
"title": "Botpress API",
|
|
311584
311581
|
"description": "API for Botpress Cloud",
|
|
311585
311582
|
"server": "https://api.botpress.cloud",
|
|
311586
|
-
"version": "1.
|
|
311583
|
+
"version": "1.18.1",
|
|
311587
311584
|
"prefix": "v1"
|
|
311588
311585
|
},
|
|
311589
311586
|
"errors": [
|
|
@@ -323737,6 +323734,33 @@ var state5 = {
|
|
|
323737
323734
|
}
|
|
323738
323735
|
}
|
|
323739
323736
|
},
|
|
323737
|
+
"unlinkSandboxedConversations": {
|
|
323738
|
+
"name": "unlinkSandboxedConversations",
|
|
323739
|
+
"description": "**EXPERIMENTAL** Unlink all sandboxed conversations for an integration installed in a bot",
|
|
323740
|
+
"method": "delete",
|
|
323741
|
+
"path": "/v1/admin/bots/{botId}/integrations/{integrationId}/sandboxed-conversations",
|
|
323742
|
+
"section": "bot",
|
|
323743
|
+
"parameters": {
|
|
323744
|
+
"botId": {
|
|
323745
|
+
"type": "string",
|
|
323746
|
+
"description": "Bot ID",
|
|
323747
|
+
"in": "path"
|
|
323748
|
+
},
|
|
323749
|
+
"integrationId": {
|
|
323750
|
+
"type": "string",
|
|
323751
|
+
"description": "Integration Version ID",
|
|
323752
|
+
"in": "path"
|
|
323753
|
+
}
|
|
323754
|
+
},
|
|
323755
|
+
"response": {
|
|
323756
|
+
"description": "Success",
|
|
323757
|
+
"schema": {
|
|
323758
|
+
"type": "object",
|
|
323759
|
+
"title": "unlinkSandboxedConversationsResponse",
|
|
323760
|
+
"additionalProperties": false
|
|
323761
|
+
}
|
|
323762
|
+
}
|
|
323763
|
+
},
|
|
323740
323764
|
"listBotApiKeys": {
|
|
323741
323765
|
"name": "listBotApiKeys",
|
|
323742
323766
|
"description": "List BAKs (Bot Api Keys) of a bot",
|
|
@@ -327568,22 +327592,6 @@ var state5 = {
|
|
|
327568
327592
|
"additionalProperties": false
|
|
327569
327593
|
}
|
|
327570
327594
|
},
|
|
327571
|
-
"sandbox": {
|
|
327572
|
-
"type": "object",
|
|
327573
|
-
"properties": {
|
|
327574
|
-
"identifierExtractScript": {
|
|
327575
|
-
"type": "string",
|
|
327576
|
-
"maxLength": 2e3,
|
|
327577
|
-
"nullable": true
|
|
327578
|
-
},
|
|
327579
|
-
"messageExtractScript": {
|
|
327580
|
-
"type": "string",
|
|
327581
|
-
"maxLength": 2e3,
|
|
327582
|
-
"nullable": true
|
|
327583
|
-
}
|
|
327584
|
-
},
|
|
327585
|
-
"additionalProperties": false
|
|
327586
|
-
},
|
|
327587
327595
|
"attributes": {
|
|
327588
327596
|
"type": "object",
|
|
327589
327597
|
"additionalProperties": {
|
|
@@ -328176,22 +328184,6 @@ var state5 = {
|
|
|
328176
328184
|
"additionalProperties": false
|
|
328177
328185
|
}
|
|
328178
328186
|
},
|
|
328179
|
-
"sandbox": {
|
|
328180
|
-
"type": "object",
|
|
328181
|
-
"properties": {
|
|
328182
|
-
"identifierExtractScript": {
|
|
328183
|
-
"type": "string",
|
|
328184
|
-
"maxLength": 2e3,
|
|
328185
|
-
"nullable": true
|
|
328186
|
-
},
|
|
328187
|
-
"messageExtractScript": {
|
|
328188
|
-
"type": "string",
|
|
328189
|
-
"maxLength": 2e3,
|
|
328190
|
-
"nullable": true
|
|
328191
|
-
}
|
|
328192
|
-
},
|
|
328193
|
-
"additionalProperties": false
|
|
328194
|
-
},
|
|
328195
328187
|
"attributes": {
|
|
328196
328188
|
"type": "object",
|
|
328197
328189
|
"additionalProperties": {
|
|
@@ -333770,7 +333762,7 @@ var state5 = {
|
|
|
333770
333762
|
"title": "Botpress API",
|
|
333771
333763
|
"description": "API for Botpress Cloud",
|
|
333772
333764
|
"server": "https://api.botpress.cloud",
|
|
333773
|
-
"version": "1.
|
|
333765
|
+
"version": "1.18.1",
|
|
333774
333766
|
"prefix": "v1"
|
|
333775
333767
|
},
|
|
333776
333768
|
"errors": [
|
|
@@ -334052,6 +334044,7 @@ var state5 = {
|
|
|
334052
334044
|
"createIntegrationShareableIdResponse": true,
|
|
334053
334045
|
"deleteIntegrationShareableIdResponse": true,
|
|
334054
334046
|
"getIntegrationShareableIdResponse": true,
|
|
334047
|
+
"unlinkSandboxedConversationsResponse": true,
|
|
334055
334048
|
"listBotApiKeysResponse": true,
|
|
334056
334049
|
"createBotApiKeyResponse": true,
|
|
334057
334050
|
"deleteBotApiKeyResponse": true,
|
|
@@ -337755,6 +337748,7 @@ var state5 = {
|
|
|
337755
337748
|
"createIntegrationShareableId",
|
|
337756
337749
|
"deleteIntegrationShareableId",
|
|
337757
337750
|
"getIntegrationShareableId",
|
|
337751
|
+
"unlinkSandboxedConversations",
|
|
337758
337752
|
"listBotApiKeys",
|
|
337759
337753
|
"createBotApiKey",
|
|
337760
337754
|
"deleteBotApiKey"
|
|
@@ -5062,6 +5062,33 @@ export declare const state: {
|
|
|
5062
5062
|
};
|
|
5063
5063
|
};
|
|
5064
5064
|
};
|
|
5065
|
+
unlinkSandboxedConversations: {
|
|
5066
|
+
name: string;
|
|
5067
|
+
description: string;
|
|
5068
|
+
method: "delete";
|
|
5069
|
+
path: string;
|
|
5070
|
+
section: "bot";
|
|
5071
|
+
parameters: {
|
|
5072
|
+
botId: {
|
|
5073
|
+
type: "string";
|
|
5074
|
+
description: string;
|
|
5075
|
+
in: "path";
|
|
5076
|
+
};
|
|
5077
|
+
integrationId: {
|
|
5078
|
+
type: "string";
|
|
5079
|
+
description: string;
|
|
5080
|
+
in: "path";
|
|
5081
|
+
};
|
|
5082
|
+
};
|
|
5083
|
+
response: {
|
|
5084
|
+
description: string;
|
|
5085
|
+
schema: {
|
|
5086
|
+
type: "object";
|
|
5087
|
+
title: string;
|
|
5088
|
+
additionalProperties: false;
|
|
5089
|
+
};
|
|
5090
|
+
};
|
|
5091
|
+
};
|
|
5065
5092
|
listBotApiKeys: {
|
|
5066
5093
|
name: string;
|
|
5067
5094
|
description: string;
|
|
@@ -8392,22 +8419,6 @@ export declare const state: {
|
|
|
8392
8419
|
additionalProperties: false;
|
|
8393
8420
|
};
|
|
8394
8421
|
};
|
|
8395
|
-
sandbox: {
|
|
8396
|
-
type: "object";
|
|
8397
|
-
properties: {
|
|
8398
|
-
identifierExtractScript: {
|
|
8399
|
-
type: "string";
|
|
8400
|
-
maxLength: number;
|
|
8401
|
-
nullable: true;
|
|
8402
|
-
};
|
|
8403
|
-
messageExtractScript: {
|
|
8404
|
-
type: "string";
|
|
8405
|
-
maxLength: number;
|
|
8406
|
-
nullable: true;
|
|
8407
|
-
};
|
|
8408
|
-
};
|
|
8409
|
-
additionalProperties: false;
|
|
8410
|
-
};
|
|
8411
8422
|
attributes: {
|
|
8412
8423
|
type: "object";
|
|
8413
8424
|
additionalProperties: {
|
|
@@ -8962,22 +8973,6 @@ export declare const state: {
|
|
|
8962
8973
|
additionalProperties: false;
|
|
8963
8974
|
};
|
|
8964
8975
|
};
|
|
8965
|
-
sandbox: {
|
|
8966
|
-
type: "object";
|
|
8967
|
-
properties: {
|
|
8968
|
-
identifierExtractScript: {
|
|
8969
|
-
type: "string";
|
|
8970
|
-
maxLength: number;
|
|
8971
|
-
nullable: true;
|
|
8972
|
-
};
|
|
8973
|
-
messageExtractScript: {
|
|
8974
|
-
type: "string";
|
|
8975
|
-
maxLength: number;
|
|
8976
|
-
nullable: true;
|
|
8977
|
-
};
|
|
8978
|
-
};
|
|
8979
|
-
additionalProperties: false;
|
|
8980
|
-
};
|
|
8981
8976
|
attributes: {
|
|
8982
8977
|
type: "object";
|
|
8983
8978
|
additionalProperties: {
|
|
@@ -11537,6 +11532,7 @@ export declare const state: {
|
|
|
11537
11532
|
createIntegrationShareableIdResponse: true;
|
|
11538
11533
|
deleteIntegrationShareableIdResponse: true;
|
|
11539
11534
|
getIntegrationShareableIdResponse: true;
|
|
11535
|
+
unlinkSandboxedConversationsResponse: true;
|
|
11540
11536
|
listBotApiKeysResponse: true;
|
|
11541
11537
|
createBotApiKeyResponse: true;
|
|
11542
11538
|
deleteBotApiKeyResponse: true;
|
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -7411,6 +7411,33 @@ export declare const state: {
|
|
|
7411
7411
|
};
|
|
7412
7412
|
};
|
|
7413
7413
|
};
|
|
7414
|
+
unlinkSandboxedConversations: {
|
|
7415
|
+
name: string;
|
|
7416
|
+
description: string;
|
|
7417
|
+
method: "delete";
|
|
7418
|
+
path: string;
|
|
7419
|
+
section: "bot";
|
|
7420
|
+
parameters: {
|
|
7421
|
+
botId: {
|
|
7422
|
+
type: "string";
|
|
7423
|
+
description: string;
|
|
7424
|
+
in: "path";
|
|
7425
|
+
};
|
|
7426
|
+
integrationId: {
|
|
7427
|
+
type: "string";
|
|
7428
|
+
description: string;
|
|
7429
|
+
in: "path";
|
|
7430
|
+
};
|
|
7431
|
+
};
|
|
7432
|
+
response: {
|
|
7433
|
+
description: string;
|
|
7434
|
+
schema: {
|
|
7435
|
+
type: "object";
|
|
7436
|
+
title: string;
|
|
7437
|
+
additionalProperties: false;
|
|
7438
|
+
};
|
|
7439
|
+
};
|
|
7440
|
+
};
|
|
7414
7441
|
listBotApiKeys: {
|
|
7415
7442
|
name: string;
|
|
7416
7443
|
description: string;
|
|
@@ -10742,22 +10769,6 @@ export declare const state: {
|
|
|
10742
10769
|
additionalProperties: false;
|
|
10743
10770
|
};
|
|
10744
10771
|
};
|
|
10745
|
-
sandbox: {
|
|
10746
|
-
type: "object";
|
|
10747
|
-
properties: {
|
|
10748
|
-
identifierExtractScript: {
|
|
10749
|
-
type: "string";
|
|
10750
|
-
maxLength: number;
|
|
10751
|
-
nullable: true;
|
|
10752
|
-
};
|
|
10753
|
-
messageExtractScript: {
|
|
10754
|
-
type: "string";
|
|
10755
|
-
maxLength: number;
|
|
10756
|
-
nullable: true;
|
|
10757
|
-
};
|
|
10758
|
-
};
|
|
10759
|
-
additionalProperties: false;
|
|
10760
|
-
};
|
|
10761
10772
|
attributes: {
|
|
10762
10773
|
type: "object";
|
|
10763
10774
|
additionalProperties: {
|
|
@@ -11312,22 +11323,6 @@ export declare const state: {
|
|
|
11312
11323
|
additionalProperties: false;
|
|
11313
11324
|
};
|
|
11314
11325
|
};
|
|
11315
|
-
sandbox: {
|
|
11316
|
-
type: "object";
|
|
11317
|
-
properties: {
|
|
11318
|
-
identifierExtractScript: {
|
|
11319
|
-
type: "string";
|
|
11320
|
-
maxLength: number;
|
|
11321
|
-
nullable: true;
|
|
11322
|
-
};
|
|
11323
|
-
messageExtractScript: {
|
|
11324
|
-
type: "string";
|
|
11325
|
-
maxLength: number;
|
|
11326
|
-
nullable: true;
|
|
11327
|
-
};
|
|
11328
|
-
};
|
|
11329
|
-
additionalProperties: false;
|
|
11330
|
-
};
|
|
11331
11326
|
attributes: {
|
|
11332
11327
|
type: "object";
|
|
11333
11328
|
additionalProperties: {
|
|
@@ -16435,6 +16430,7 @@ export declare const state: {
|
|
|
16435
16430
|
createIntegrationShareableIdResponse: true;
|
|
16436
16431
|
deleteIntegrationShareableIdResponse: true;
|
|
16437
16432
|
getIntegrationShareableIdResponse: true;
|
|
16433
|
+
unlinkSandboxedConversationsResponse: true;
|
|
16438
16434
|
listBotApiKeysResponse: true;
|
|
16439
16435
|
createBotApiKeyResponse: true;
|
|
16440
16436
|
deleteBotApiKeyResponse: true;
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"sections":[{"description":"","title":"User","name":"user","operations":[],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":[],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":[],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":[],"schema":"Message"},{"description":"","title":"State","name":"state","operations":[],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration","listPublicPlugins","getPublicPluginById","getPublicPlugin","getPublicPluginCode","listPublicInterfaces","getPublicInterfaceById","getPublicInterface"]},{"description":"","title":"Action","name":"action","operations":[]},{"description":"","title":"Task","name":"task","operations":[],"schema":"Task"},{"description":"","title":"Workflow","name":"workflow","operations":[],"schema":"Workflow"},{"description":"","title":"Tag","name":"tag","operations":[]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","createBotVersion","deployBotVersion","createIntegrationShareableId","deleteIntegrationShareableId","getIntegrationShareableId","listBotApiKeys","createBotApiKey","deleteBotApiKey"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","validateIntegrationCreation","updateIntegration","validateIntegrationUpdate","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration","requestIntegrationVerification"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Plugin","description":"","name":"plugin","operations":["createPlugin","getPlugin","getPluginByName","updatePlugin","deletePlugin","listPlugins","getPluginCode"],"schema":"Plugin"},{"title":"Workspace","description":"","name":"workspace","operations":["listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","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","getMultipleUsages","listUsageActivityDaily"],"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":[],"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 Word, HTML, Markdown, 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":[],"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":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"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":[],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":[],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":[],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":[],"schema":"Message"},{"description":"","title":"State","name":"state","operations":[],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration","listPublicPlugins","getPublicPluginById","getPublicPlugin","getPublicPluginCode","listPublicInterfaces","getPublicInterfaceById","getPublicInterface"]},{"description":"","title":"Action","name":"action","operations":[]},{"description":"","title":"Task","name":"task","operations":[],"schema":"Task"},{"description":"","title":"Workflow","name":"workflow","operations":[],"schema":"Workflow"},{"description":"","title":"Tag","name":"tag","operations":[]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","createBotVersion","deployBotVersion","createIntegrationShareableId","deleteIntegrationShareableId","getIntegrationShareableId","unlinkSandboxedConversations","listBotApiKeys","createBotApiKey","deleteBotApiKey"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","validateIntegrationCreation","updateIntegration","validateIntegrationUpdate","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration","requestIntegrationVerification"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Plugin","description":"","name":"plugin","operations":["createPlugin","getPlugin","getPluginByName","updatePlugin","deletePlugin","listPlugins","getPluginCode"],"schema":"Plugin"},{"title":"Workspace","description":"","name":"workspace","operations":["listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","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","getMultipleUsages","listUsageActivityDaily"],"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":[],"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 Word, HTML, Markdown, 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":[],"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":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"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."}]}
|