@botpress/api 1.50.0 → 1.52.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.
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /* prettier-ignore */
4
4
  import * as opapi from '@bpinternal/opapi'
5
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version', never, 'bot' | 'integration' | 'interface' | 'plugin' | 'hub' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity'>
5
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version', 'x-workspace-id' | 'x-multiple-integrations', 'bot' | 'integration' | 'interface' | 'plugin' | 'hub' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "runVrl": {
@@ -52,7 +52,20 @@ export const state = {
52
52
  "additionalProperties": false
53
53
  }
54
54
  },
55
- "parameters": {}
55
+ "parameters": {
56
+ "x-workspace-id": {
57
+ "in": "header",
58
+ "type": "string",
59
+ "description": "Workspace ID",
60
+ "required": true
61
+ },
62
+ "x-multiple-integrations": {
63
+ "in": "header",
64
+ "type": "string",
65
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
66
+ "required": false
67
+ }
68
+ }
56
69
  },
57
70
  "getAccount": {
58
71
  "name": "getAccount",
@@ -109,7 +122,17 @@ export const state = {
109
122
  "additionalProperties": false
110
123
  }
111
124
  },
112
- "parameters": {}
125
+ "tags": [
126
+ "documented"
127
+ ],
128
+ "parameters": {
129
+ "x-multiple-integrations": {
130
+ "in": "header",
131
+ "type": "string",
132
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
133
+ "required": false
134
+ }
135
+ }
113
136
  },
114
137
  "updateAccount": {
115
138
  "name": "updateAccount",
@@ -186,7 +209,17 @@ export const state = {
186
209
  "additionalProperties": false
187
210
  }
188
211
  },
189
- "parameters": {}
212
+ "tags": [
213
+ "documented"
214
+ ],
215
+ "parameters": {
216
+ "x-multiple-integrations": {
217
+ "in": "header",
218
+ "type": "string",
219
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
220
+ "required": false
221
+ }
222
+ }
190
223
  },
191
224
  "deleteAccount": {
192
225
  "name": "deleteAccount",
@@ -213,7 +246,14 @@ export const state = {
213
246
  "additionalProperties": false
214
247
  }
215
248
  },
216
- "parameters": {}
249
+ "parameters": {
250
+ "x-multiple-integrations": {
251
+ "in": "header",
252
+ "type": "string",
253
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
254
+ "required": false
255
+ }
256
+ }
217
257
  },
218
258
  "listPersonalAccessTokens": {
219
259
  "name": "listPersonalAccessTokens",
@@ -260,7 +300,14 @@ export const state = {
260
300
  "additionalProperties": false
261
301
  }
262
302
  },
263
- "parameters": {}
303
+ "parameters": {
304
+ "x-multiple-integrations": {
305
+ "in": "header",
306
+ "type": "string",
307
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
308
+ "required": false
309
+ }
310
+ }
264
311
  },
265
312
  "createPersonalAccessToken": {
266
313
  "name": "createPersonalAccessToken",
@@ -327,7 +374,14 @@ export const state = {
327
374
  "additionalProperties": false
328
375
  }
329
376
  },
330
- "parameters": {}
377
+ "parameters": {
378
+ "x-multiple-integrations": {
379
+ "in": "header",
380
+ "type": "string",
381
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
382
+ "required": false
383
+ }
384
+ }
331
385
  },
332
386
  "deletePersonalAccessToken": {
333
387
  "name": "deletePersonalAccessToken",
@@ -343,6 +397,12 @@ export const state = {
343
397
  "type": "string",
344
398
  "description": "ID of Personal Access Token",
345
399
  "in": "path"
400
+ },
401
+ "x-multiple-integrations": {
402
+ "in": "header",
403
+ "type": "string",
404
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
405
+ "required": false
346
406
  }
347
407
  },
348
408
  "response": {
@@ -368,6 +428,12 @@ export const state = {
368
428
  "type": "string",
369
429
  "description": "Preference key",
370
430
  "in": "path"
431
+ },
432
+ "x-multiple-integrations": {
433
+ "in": "header",
434
+ "type": "string",
435
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
436
+ "required": false
371
437
  }
372
438
  },
373
439
  "requestBody": {
@@ -404,6 +470,12 @@ export const state = {
404
470
  "type": "string",
405
471
  "description": "Preference key",
406
472
  "in": "path"
473
+ },
474
+ "x-multiple-integrations": {
475
+ "in": "header",
476
+ "type": "string",
477
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
478
+ "required": false
407
479
  }
408
480
  },
409
481
  "response": {
@@ -503,6 +575,12 @@ export const state = {
503
575
  "asc",
504
576
  "desc"
505
577
  ]
578
+ },
579
+ "x-multiple-integrations": {
580
+ "in": "header",
581
+ "type": "string",
582
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
583
+ "required": false
506
584
  }
507
585
  },
508
586
  "response": {
@@ -683,7 +761,10 @@ export const state = {
683
761
  "title": "listPublicIntegrationsResponse",
684
762
  "additionalProperties": false
685
763
  }
686
- }
764
+ },
765
+ "tags": [
766
+ "documented"
767
+ ]
687
768
  },
688
769
  "getPublicIntegrationById": {
689
770
  "name": "getPublicIntegrationById",
@@ -699,6 +780,12 @@ export const state = {
699
780
  "type": "string",
700
781
  "description": "Integration Version ID",
701
782
  "in": "path"
783
+ },
784
+ "x-multiple-integrations": {
785
+ "in": "header",
786
+ "type": "string",
787
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
788
+ "required": false
702
789
  }
703
790
  },
704
791
  "response": {
@@ -1434,7 +1521,10 @@ export const state = {
1434
1521
  "title": "getPublicIntegrationByIdResponse",
1435
1522
  "additionalProperties": false
1436
1523
  }
1437
- }
1524
+ },
1525
+ "tags": [
1526
+ "documented"
1527
+ ]
1438
1528
  },
1439
1529
  "getPublicIntegration": {
1440
1530
  "name": "getPublicIntegration",
@@ -1455,6 +1545,12 @@ export const state = {
1455
1545
  "type": "string",
1456
1546
  "description": "Integration version. Either a semver version, semver version range, or the constant string \"latest\"",
1457
1547
  "in": "path"
1548
+ },
1549
+ "x-multiple-integrations": {
1550
+ "in": "header",
1551
+ "type": "string",
1552
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
1553
+ "required": false
1458
1554
  }
1459
1555
  },
1460
1556
  "response": {
@@ -2190,7 +2286,10 @@ export const state = {
2190
2286
  "title": "getPublicIntegrationResponse",
2191
2287
  "additionalProperties": false
2192
2288
  }
2193
- }
2289
+ },
2290
+ "tags": [
2291
+ "documented"
2292
+ ]
2194
2293
  },
2195
2294
  "listPublicPlugins": {
2196
2295
  "name": "listPublicPlugins",
@@ -2216,6 +2315,12 @@ export const state = {
2216
2315
  "in": "query",
2217
2316
  "type": "string",
2218
2317
  "description": "Filter a plugin by name and version"
2318
+ },
2319
+ "x-multiple-integrations": {
2320
+ "in": "header",
2321
+ "type": "string",
2322
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
2323
+ "required": false
2219
2324
  }
2220
2325
  },
2221
2326
  "response": {
@@ -2326,6 +2431,12 @@ export const state = {
2326
2431
  "type": "string",
2327
2432
  "description": "Plugin ID",
2328
2433
  "in": "path"
2434
+ },
2435
+ "x-multiple-integrations": {
2436
+ "in": "header",
2437
+ "type": "string",
2438
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
2439
+ "required": false
2329
2440
  }
2330
2441
  },
2331
2442
  "response": {
@@ -2733,6 +2844,12 @@ export const state = {
2733
2844
  },
2734
2845
  "description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
2735
2846
  "required": true
2847
+ },
2848
+ "x-multiple-integrations": {
2849
+ "in": "header",
2850
+ "type": "string",
2851
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
2852
+ "required": false
2736
2853
  }
2737
2854
  },
2738
2855
  "response": {
@@ -3131,6 +3248,12 @@ export const state = {
3131
3248
  "type": "string",
3132
3249
  "description": "Plugin version. Either a semver version, semver version range, or the constant string \"latest\"",
3133
3250
  "in": "path"
3251
+ },
3252
+ "x-multiple-integrations": {
3253
+ "in": "header",
3254
+ "type": "string",
3255
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
3256
+ "required": false
3134
3257
  }
3135
3258
  },
3136
3259
  "response": {
@@ -3533,6 +3656,12 @@ export const state = {
3533
3656
  "browser"
3534
3657
  ],
3535
3658
  "description": "Platform"
3659
+ },
3660
+ "x-multiple-integrations": {
3661
+ "in": "header",
3662
+ "type": "string",
3663
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
3664
+ "required": false
3536
3665
  }
3537
3666
  },
3538
3667
  "response": {
@@ -3576,6 +3705,12 @@ export const state = {
3576
3705
  "in": "query",
3577
3706
  "type": "string",
3578
3707
  "description": "Filter an interface by name and version"
3708
+ },
3709
+ "x-multiple-integrations": {
3710
+ "in": "header",
3711
+ "type": "string",
3712
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
3713
+ "required": false
3579
3714
  }
3580
3715
  },
3581
3716
  "response": {
@@ -3686,6 +3821,12 @@ export const state = {
3686
3821
  "type": "string",
3687
3822
  "description": "Interface ID",
3688
3823
  "in": "path"
3824
+ },
3825
+ "x-multiple-integrations": {
3826
+ "in": "header",
3827
+ "type": "string",
3828
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
3829
+ "required": false
3689
3830
  }
3690
3831
  },
3691
3832
  "response": {
@@ -3984,6 +4125,12 @@ export const state = {
3984
4125
  "type": "string",
3985
4126
  "description": "Interface version. Either a semver version, semver version range, or the constant string \"latest\"",
3986
4127
  "in": "path"
4128
+ },
4129
+ "x-multiple-integrations": {
4130
+ "in": "header",
4131
+ "type": "string",
4132
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
4133
+ "required": false
3987
4134
  }
3988
4135
  },
3989
4136
  "response": {
@@ -4622,7 +4769,23 @@ export const state = {
4622
4769
  "additionalProperties": false
4623
4770
  }
4624
4771
  },
4625
- "parameters": {}
4772
+ "tags": [
4773
+ "documented"
4774
+ ],
4775
+ "parameters": {
4776
+ "x-workspace-id": {
4777
+ "in": "header",
4778
+ "type": "string",
4779
+ "description": "Workspace ID",
4780
+ "required": true
4781
+ },
4782
+ "x-multiple-integrations": {
4783
+ "in": "header",
4784
+ "type": "string",
4785
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
4786
+ "required": false
4787
+ }
4788
+ }
4626
4789
  },
4627
4790
  "updateBot": {
4628
4791
  "name": "updateBot",
@@ -4635,6 +4798,18 @@ export const state = {
4635
4798
  "type": "string",
4636
4799
  "description": "Bot ID",
4637
4800
  "in": "path"
4801
+ },
4802
+ "x-workspace-id": {
4803
+ "in": "header",
4804
+ "type": "string",
4805
+ "description": "Workspace ID",
4806
+ "required": true
4807
+ },
4808
+ "x-multiple-integrations": {
4809
+ "in": "header",
4810
+ "type": "string",
4811
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
4812
+ "required": false
4638
4813
  }
4639
4814
  },
4640
4815
  "requestBody": {
@@ -5118,7 +5293,10 @@ export const state = {
5118
5293
  "title": "updateBotResponse",
5119
5294
  "additionalProperties": false
5120
5295
  }
5121
- }
5296
+ },
5297
+ "tags": [
5298
+ "documented"
5299
+ ]
5122
5300
  },
5123
5301
  "transferBot": {
5124
5302
  "name": "transferBot",
@@ -5131,6 +5309,18 @@ export const state = {
5131
5309
  "type": "string",
5132
5310
  "description": "Bot ID",
5133
5311
  "in": "path"
5312
+ },
5313
+ "x-workspace-id": {
5314
+ "in": "header",
5315
+ "type": "string",
5316
+ "description": "Workspace ID",
5317
+ "required": true
5318
+ },
5319
+ "x-multiple-integrations": {
5320
+ "in": "header",
5321
+ "type": "string",
5322
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
5323
+ "required": false
5134
5324
  }
5135
5325
  },
5136
5326
  "requestBody": {
@@ -5205,6 +5395,18 @@ export const state = {
5205
5395
  "asc",
5206
5396
  "desc"
5207
5397
  ]
5398
+ },
5399
+ "x-workspace-id": {
5400
+ "in": "header",
5401
+ "type": "string",
5402
+ "description": "Workspace ID",
5403
+ "required": true
5404
+ },
5405
+ "x-multiple-integrations": {
5406
+ "in": "header",
5407
+ "type": "string",
5408
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
5409
+ "required": false
5208
5410
  }
5209
5411
  },
5210
5412
  "section": "bot",
@@ -5276,7 +5478,10 @@ export const state = {
5276
5478
  "title": "listBotsResponse",
5277
5479
  "additionalProperties": false
5278
5480
  }
5279
- }
5481
+ },
5482
+ "tags": [
5483
+ "documented"
5484
+ ]
5280
5485
  },
5281
5486
  "getBot": {
5282
5487
  "name": "getBot",
@@ -5295,6 +5500,18 @@ export const state = {
5295
5500
  "type": "boolean",
5296
5501
  "required": false,
5297
5502
  "description": "UNUSED. Please ignore this field. It will be removed in the near future."
5503
+ },
5504
+ "x-workspace-id": {
5505
+ "in": "header",
5506
+ "type": "string",
5507
+ "description": "Workspace ID",
5508
+ "required": true
5509
+ },
5510
+ "x-multiple-integrations": {
5511
+ "in": "header",
5512
+ "type": "string",
5513
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
5514
+ "required": false
5298
5515
  }
5299
5516
  },
5300
5517
  "response": {
@@ -5312,7 +5529,10 @@ export const state = {
5312
5529
  "title": "getBotResponse",
5313
5530
  "additionalProperties": false
5314
5531
  }
5315
- }
5532
+ },
5533
+ "tags": [
5534
+ "documented"
5535
+ ]
5316
5536
  },
5317
5537
  "deleteBot": {
5318
5538
  "name": "deleteBot",
@@ -5325,6 +5545,18 @@ export const state = {
5325
5545
  "type": "string",
5326
5546
  "description": "Bot ID",
5327
5547
  "in": "path"
5548
+ },
5549
+ "x-workspace-id": {
5550
+ "in": "header",
5551
+ "type": "string",
5552
+ "description": "Workspace ID",
5553
+ "required": true
5554
+ },
5555
+ "x-multiple-integrations": {
5556
+ "in": "header",
5557
+ "type": "string",
5558
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
5559
+ "required": false
5328
5560
  }
5329
5561
  },
5330
5562
  "response": {
@@ -5334,7 +5566,10 @@ export const state = {
5334
5566
  "title": "deleteBotResponse",
5335
5567
  "additionalProperties": false
5336
5568
  }
5337
- }
5569
+ },
5570
+ "tags": [
5571
+ "documented"
5572
+ ]
5338
5573
  },
5339
5574
  "getBotLogs": {
5340
5575
  "name": "getBotLogs",
@@ -5395,6 +5630,18 @@ export const state = {
5395
5630
  "description": "Token to get the next page of logs",
5396
5631
  "type": "string",
5397
5632
  "required": false
5633
+ },
5634
+ "x-workspace-id": {
5635
+ "in": "header",
5636
+ "type": "string",
5637
+ "description": "Workspace ID",
5638
+ "required": true
5639
+ },
5640
+ "x-multiple-integrations": {
5641
+ "in": "header",
5642
+ "type": "string",
5643
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
5644
+ "required": false
5398
5645
  }
5399
5646
  },
5400
5647
  "response": {
@@ -5443,7 +5690,10 @@ export const state = {
5443
5690
  "title": "getBotLogsResponse",
5444
5691
  "additionalProperties": false
5445
5692
  }
5446
- }
5693
+ },
5694
+ "tags": [
5695
+ "documented"
5696
+ ]
5447
5697
  },
5448
5698
  "getBotWebchat": {
5449
5699
  "name": "getBotWebchat",
@@ -5468,6 +5718,18 @@ export const state = {
5468
5718
  "fullscreen",
5469
5719
  "sharableUrl"
5470
5720
  ]
5721
+ },
5722
+ "x-workspace-id": {
5723
+ "in": "header",
5724
+ "type": "string",
5725
+ "description": "Workspace ID",
5726
+ "required": true
5727
+ },
5728
+ "x-multiple-integrations": {
5729
+ "in": "header",
5730
+ "type": "string",
5731
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
5732
+ "required": false
5471
5733
  }
5472
5734
  },
5473
5735
  "response": {
@@ -5510,6 +5772,18 @@ export const state = {
5510
5772
  "description": "End date/time (inclusive)",
5511
5773
  "type": "string",
5512
5774
  "required": true
5775
+ },
5776
+ "x-workspace-id": {
5777
+ "in": "header",
5778
+ "type": "string",
5779
+ "description": "Workspace ID",
5780
+ "required": true
5781
+ },
5782
+ "x-multiple-integrations": {
5783
+ "in": "header",
5784
+ "type": "string",
5785
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
5786
+ "required": false
5513
5787
  }
5514
5788
  },
5515
5789
  "response": {
@@ -5690,7 +5964,10 @@ export const state = {
5690
5964
  "title": "getBotAnalyticsResponse",
5691
5965
  "additionalProperties": false
5692
5966
  }
5693
- }
5967
+ },
5968
+ "tags": [
5969
+ "documented"
5970
+ ]
5694
5971
  },
5695
5972
  "listActionRuns": {
5696
5973
  "name": "listActionRuns",
@@ -5724,6 +6001,18 @@ export const state = {
5724
6001
  "in": "query",
5725
6002
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
5726
6003
  "type": "string"
6004
+ },
6005
+ "x-workspace-id": {
6006
+ "in": "header",
6007
+ "type": "string",
6008
+ "description": "Workspace ID",
6009
+ "required": true
6010
+ },
6011
+ "x-multiple-integrations": {
6012
+ "in": "header",
6013
+ "type": "string",
6014
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6015
+ "required": false
5727
6016
  }
5728
6017
  },
5729
6018
  "response": {
@@ -5823,6 +6112,18 @@ export const state = {
5823
6112
  "in": "path",
5824
6113
  "description": "Issue ID",
5825
6114
  "type": "string"
6115
+ },
6116
+ "x-workspace-id": {
6117
+ "in": "header",
6118
+ "type": "string",
6119
+ "description": "Workspace ID",
6120
+ "required": true
6121
+ },
6122
+ "x-multiple-integrations": {
6123
+ "in": "header",
6124
+ "type": "string",
6125
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6126
+ "required": false
5826
6127
  }
5827
6128
  },
5828
6129
  "response": {
@@ -5909,7 +6210,10 @@ export const state = {
5909
6210
  "title": "getBotIssueResponse",
5910
6211
  "additionalProperties": false
5911
6212
  }
5912
- }
6213
+ },
6214
+ "tags": [
6215
+ "documented"
6216
+ ]
5913
6217
  },
5914
6218
  "listBotIssues": {
5915
6219
  "name": "listBotIssues",
@@ -5927,6 +6231,18 @@ export const state = {
5927
6231
  "in": "query",
5928
6232
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
5929
6233
  "type": "string"
6234
+ },
6235
+ "x-workspace-id": {
6236
+ "in": "header",
6237
+ "type": "string",
6238
+ "description": "Workspace ID",
6239
+ "required": true
6240
+ },
6241
+ "x-multiple-integrations": {
6242
+ "in": "header",
6243
+ "type": "string",
6244
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6245
+ "required": false
5930
6246
  }
5931
6247
  },
5932
6248
  "response": {
@@ -6025,7 +6341,10 @@ export const state = {
6025
6341
  "title": "listBotIssuesResponse",
6026
6342
  "additionalProperties": false
6027
6343
  }
6028
- }
6344
+ },
6345
+ "tags": [
6346
+ "documented"
6347
+ ]
6029
6348
  },
6030
6349
  "deleteBotIssue": {
6031
6350
  "name": "deleteBotIssue",
@@ -6043,6 +6362,18 @@ export const state = {
6043
6362
  "in": "path",
6044
6363
  "description": "Issue ID",
6045
6364
  "type": "string"
6365
+ },
6366
+ "x-workspace-id": {
6367
+ "in": "header",
6368
+ "type": "string",
6369
+ "description": "Workspace ID",
6370
+ "required": true
6371
+ },
6372
+ "x-multiple-integrations": {
6373
+ "in": "header",
6374
+ "type": "string",
6375
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6376
+ "required": false
6046
6377
  }
6047
6378
  },
6048
6379
  "response": {
@@ -6052,7 +6383,10 @@ export const state = {
6052
6383
  "title": "deleteBotIssueResponse",
6053
6384
  "additionalProperties": false
6054
6385
  }
6055
- }
6386
+ },
6387
+ "tags": [
6388
+ "documented"
6389
+ ]
6056
6390
  },
6057
6391
  "listBotIssueEvents": {
6058
6392
  "name": "listBotIssueEvents",
@@ -6070,6 +6404,18 @@ export const state = {
6070
6404
  "in": "path",
6071
6405
  "description": "Issue ID",
6072
6406
  "type": "string"
6407
+ },
6408
+ "x-workspace-id": {
6409
+ "in": "header",
6410
+ "type": "string",
6411
+ "description": "Workspace ID",
6412
+ "required": true
6413
+ },
6414
+ "x-multiple-integrations": {
6415
+ "in": "header",
6416
+ "type": "string",
6417
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6418
+ "required": false
6073
6419
  }
6074
6420
  },
6075
6421
  "response": {
@@ -6121,7 +6467,10 @@ export const state = {
6121
6467
  "title": "listBotIssueEventsResponse",
6122
6468
  "additionalProperties": false
6123
6469
  }
6124
- }
6470
+ },
6471
+ "tags": [
6472
+ "documented"
6473
+ ]
6125
6474
  },
6126
6475
  "listBotVersions": {
6127
6476
  "name": "listBotVersions",
@@ -6134,6 +6483,18 @@ export const state = {
6134
6483
  "type": "string",
6135
6484
  "description": "Bot ID",
6136
6485
  "in": "path"
6486
+ },
6487
+ "x-workspace-id": {
6488
+ "in": "header",
6489
+ "type": "string",
6490
+ "description": "Workspace ID",
6491
+ "required": true
6492
+ },
6493
+ "x-multiple-integrations": {
6494
+ "in": "header",
6495
+ "type": "string",
6496
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6497
+ "required": false
6137
6498
  }
6138
6499
  },
6139
6500
  "response": {
@@ -6187,6 +6548,18 @@ export const state = {
6187
6548
  "type": "string",
6188
6549
  "description": "Version ID",
6189
6550
  "in": "path"
6551
+ },
6552
+ "x-workspace-id": {
6553
+ "in": "header",
6554
+ "type": "string",
6555
+ "description": "Workspace ID",
6556
+ "required": true
6557
+ },
6558
+ "x-multiple-integrations": {
6559
+ "in": "header",
6560
+ "type": "string",
6561
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6562
+ "required": false
6190
6563
  }
6191
6564
  },
6192
6565
  "response": {
@@ -6218,6 +6591,18 @@ export const state = {
6218
6591
  "type": "string",
6219
6592
  "description": "Bot ID",
6220
6593
  "in": "path"
6594
+ },
6595
+ "x-workspace-id": {
6596
+ "in": "header",
6597
+ "type": "string",
6598
+ "description": "Workspace ID",
6599
+ "required": true
6600
+ },
6601
+ "x-multiple-integrations": {
6602
+ "in": "header",
6603
+ "type": "string",
6604
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6605
+ "required": false
6221
6606
  }
6222
6607
  },
6223
6608
  "response": {
@@ -6240,6 +6625,18 @@ export const state = {
6240
6625
  "type": "string",
6241
6626
  "description": "Bot ID",
6242
6627
  "in": "path"
6628
+ },
6629
+ "x-workspace-id": {
6630
+ "in": "header",
6631
+ "type": "string",
6632
+ "description": "Workspace ID",
6633
+ "required": true
6634
+ },
6635
+ "x-multiple-integrations": {
6636
+ "in": "header",
6637
+ "type": "string",
6638
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6639
+ "required": false
6243
6640
  }
6244
6641
  },
6245
6642
  "requestBody": {
@@ -6279,6 +6676,18 @@ export const state = {
6279
6676
  "type": "string",
6280
6677
  "description": "Bot ID",
6281
6678
  "in": "path"
6679
+ },
6680
+ "x-workspace-id": {
6681
+ "in": "header",
6682
+ "type": "string",
6683
+ "description": "Workspace ID",
6684
+ "required": true
6685
+ },
6686
+ "x-multiple-integrations": {
6687
+ "in": "header",
6688
+ "type": "string",
6689
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6690
+ "required": false
6282
6691
  }
6283
6692
  },
6284
6693
  "requestBody": {
@@ -6344,6 +6753,18 @@ export const state = {
6344
6753
  "type": "string",
6345
6754
  "description": "Bot ID",
6346
6755
  "in": "path"
6756
+ },
6757
+ "x-workspace-id": {
6758
+ "in": "header",
6759
+ "type": "string",
6760
+ "description": "Workspace ID",
6761
+ "required": true
6762
+ },
6763
+ "x-multiple-integrations": {
6764
+ "in": "header",
6765
+ "type": "string",
6766
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6767
+ "required": false
6347
6768
  }
6348
6769
  },
6349
6770
  "requestBody": {
@@ -6392,6 +6813,18 @@ export const state = {
6392
6813
  "in": "query",
6393
6814
  "type": "string",
6394
6815
  "description": "Integration instance alias. If provided, integrationId is ignored."
6816
+ },
6817
+ "x-workspace-id": {
6818
+ "in": "header",
6819
+ "type": "string",
6820
+ "description": "Workspace ID",
6821
+ "required": true
6822
+ },
6823
+ "x-multiple-integrations": {
6824
+ "in": "header",
6825
+ "type": "string",
6826
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6827
+ "required": false
6395
6828
  }
6396
6829
  },
6397
6830
  "requestBody": {
@@ -6417,7 +6850,10 @@ export const state = {
6417
6850
  "title": "createIntegrationShareableIdResponse",
6418
6851
  "additionalProperties": false
6419
6852
  }
6420
- }
6853
+ },
6854
+ "tags": [
6855
+ "experimental"
6856
+ ]
6421
6857
  },
6422
6858
  "deleteIntegrationShareableId": {
6423
6859
  "name": "deleteIntegrationShareableId",
@@ -6440,6 +6876,18 @@ export const state = {
6440
6876
  "in": "query",
6441
6877
  "type": "string",
6442
6878
  "description": "Integration instance alias. If provided, integrationId is ignored."
6879
+ },
6880
+ "x-workspace-id": {
6881
+ "in": "header",
6882
+ "type": "string",
6883
+ "description": "Workspace ID",
6884
+ "required": true
6885
+ },
6886
+ "x-multiple-integrations": {
6887
+ "in": "header",
6888
+ "type": "string",
6889
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6890
+ "required": false
6443
6891
  }
6444
6892
  },
6445
6893
  "response": {
@@ -6449,7 +6897,10 @@ export const state = {
6449
6897
  "title": "deleteIntegrationShareableIdResponse",
6450
6898
  "additionalProperties": false
6451
6899
  }
6452
- }
6900
+ },
6901
+ "tags": [
6902
+ "experimental"
6903
+ ]
6453
6904
  },
6454
6905
  "getIntegrationShareableId": {
6455
6906
  "name": "getIntegrationShareableId",
@@ -6472,6 +6923,18 @@ export const state = {
6472
6923
  "in": "query",
6473
6924
  "type": "string",
6474
6925
  "description": "Integration instance alias. If provided, integrationId is ignored."
6926
+ },
6927
+ "x-workspace-id": {
6928
+ "in": "header",
6929
+ "type": "string",
6930
+ "description": "Workspace ID",
6931
+ "required": true
6932
+ },
6933
+ "x-multiple-integrations": {
6934
+ "in": "header",
6935
+ "type": "string",
6936
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6937
+ "required": false
6475
6938
  }
6476
6939
  },
6477
6940
  "response": {
@@ -6493,7 +6956,10 @@ export const state = {
6493
6956
  "title": "getIntegrationShareableIdResponse",
6494
6957
  "additionalProperties": false
6495
6958
  }
6496
- }
6959
+ },
6960
+ "tags": [
6961
+ "experimental"
6962
+ ]
6497
6963
  },
6498
6964
  "unlinkSandboxedConversations": {
6499
6965
  "name": "unlinkSandboxedConversations",
@@ -6516,6 +6982,18 @@ export const state = {
6516
6982
  "in": "query",
6517
6983
  "type": "string",
6518
6984
  "description": "Integration instance alias. If provided, integrationId is ignored."
6985
+ },
6986
+ "x-workspace-id": {
6987
+ "in": "header",
6988
+ "type": "string",
6989
+ "description": "Workspace ID",
6990
+ "required": true
6991
+ },
6992
+ "x-multiple-integrations": {
6993
+ "in": "header",
6994
+ "type": "string",
6995
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
6996
+ "required": false
6519
6997
  }
6520
6998
  },
6521
6999
  "response": {
@@ -6525,7 +7003,10 @@ export const state = {
6525
7003
  "title": "unlinkSandboxedConversationsResponse",
6526
7004
  "additionalProperties": false
6527
7005
  }
6528
- }
7006
+ },
7007
+ "tags": [
7008
+ "experimental"
7009
+ ]
6529
7010
  },
6530
7011
  "listBotApiKeys": {
6531
7012
  "name": "listBotApiKeys",
@@ -6539,6 +7020,18 @@ export const state = {
6539
7020
  "description": "ID of the bot",
6540
7021
  "type": "string",
6541
7022
  "required": true
7023
+ },
7024
+ "x-workspace-id": {
7025
+ "in": "header",
7026
+ "type": "string",
7027
+ "description": "Workspace ID",
7028
+ "required": true
7029
+ },
7030
+ "x-multiple-integrations": {
7031
+ "in": "header",
7032
+ "type": "string",
7033
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7034
+ "required": false
6542
7035
  }
6543
7036
  },
6544
7037
  "response": {
@@ -6633,7 +7126,20 @@ export const state = {
6633
7126
  "additionalProperties": false
6634
7127
  }
6635
7128
  },
6636
- "parameters": {}
7129
+ "parameters": {
7130
+ "x-workspace-id": {
7131
+ "in": "header",
7132
+ "type": "string",
7133
+ "description": "Workspace ID",
7134
+ "required": true
7135
+ },
7136
+ "x-multiple-integrations": {
7137
+ "in": "header",
7138
+ "type": "string",
7139
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7140
+ "required": false
7141
+ }
7142
+ }
6637
7143
  },
6638
7144
  "deleteBotApiKey": {
6639
7145
  "name": "deleteBotApiKey",
@@ -6646,6 +7152,18 @@ export const state = {
6646
7152
  "type": "string",
6647
7153
  "description": "ID of Bot Api Key",
6648
7154
  "in": "path"
7155
+ },
7156
+ "x-workspace-id": {
7157
+ "in": "header",
7158
+ "type": "string",
7159
+ "description": "Workspace ID",
7160
+ "required": true
7161
+ },
7162
+ "x-multiple-integrations": {
7163
+ "in": "header",
7164
+ "type": "string",
7165
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7166
+ "required": false
6649
7167
  }
6650
7168
  },
6651
7169
  "response": {
@@ -6668,6 +7186,18 @@ export const state = {
6668
7186
  "type": "string",
6669
7187
  "description": "Bot ID",
6670
7188
  "in": "path"
7189
+ },
7190
+ "x-workspace-id": {
7191
+ "in": "header",
7192
+ "type": "string",
7193
+ "description": "Workspace ID",
7194
+ "required": true
7195
+ },
7196
+ "x-multiple-integrations": {
7197
+ "in": "header",
7198
+ "type": "string",
7199
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7200
+ "required": false
6671
7201
  }
6672
7202
  },
6673
7203
  "response": {
@@ -6718,6 +7248,18 @@ export const state = {
6718
7248
  "type": "string",
6719
7249
  "description": "Bot ID",
6720
7250
  "in": "path"
7251
+ },
7252
+ "x-workspace-id": {
7253
+ "in": "header",
7254
+ "type": "string",
7255
+ "description": "Workspace ID",
7256
+ "required": true
7257
+ },
7258
+ "x-multiple-integrations": {
7259
+ "in": "header",
7260
+ "type": "string",
7261
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7262
+ "required": false
6721
7263
  }
6722
7264
  },
6723
7265
  "requestBody": {
@@ -6767,6 +7309,12 @@ export const state = {
6767
7309
  "type": "string",
6768
7310
  "description": "Workspace ID",
6769
7311
  "in": "path"
7312
+ },
7313
+ "x-multiple-integrations": {
7314
+ "in": "header",
7315
+ "type": "string",
7316
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7317
+ "required": false
6770
7318
  }
6771
7319
  },
6772
7320
  "section": "workspace",
@@ -6880,6 +7428,12 @@ export const state = {
6880
7428
  "type": "string",
6881
7429
  "description": "Workspace ID",
6882
7430
  "in": "path"
7431
+ },
7432
+ "x-multiple-integrations": {
7433
+ "in": "header",
7434
+ "type": "string",
7435
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7436
+ "required": false
6883
7437
  }
6884
7438
  },
6885
7439
  "section": "workspace",
@@ -6981,6 +7535,12 @@ export const state = {
6981
7535
  "type": "string",
6982
7536
  "description": "Workspace ID",
6983
7537
  "in": "path"
7538
+ },
7539
+ "x-multiple-integrations": {
7540
+ "in": "header",
7541
+ "type": "string",
7542
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7543
+ "required": false
6984
7544
  }
6985
7545
  },
6986
7546
  "section": "workspace",
@@ -7180,7 +7740,17 @@ export const state = {
7180
7740
  "additionalProperties": false
7181
7741
  }
7182
7742
  },
7183
- "parameters": {}
7743
+ "tags": [
7744
+ "documented"
7745
+ ],
7746
+ "parameters": {
7747
+ "x-multiple-integrations": {
7748
+ "in": "header",
7749
+ "type": "string",
7750
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7751
+ "required": false
7752
+ }
7753
+ }
7184
7754
  },
7185
7755
  "getPublicWorkspace": {
7186
7756
  "name": "getPublicWorkspace",
@@ -7196,6 +7766,12 @@ export const state = {
7196
7766
  "type": "string",
7197
7767
  "description": "Workspace ID",
7198
7768
  "in": "path"
7769
+ },
7770
+ "x-multiple-integrations": {
7771
+ "in": "header",
7772
+ "type": "string",
7773
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7774
+ "required": false
7199
7775
  }
7200
7776
  },
7201
7777
  "response": {
@@ -7252,7 +7828,10 @@ export const state = {
7252
7828
  "title": "getPublicWorkspaceResponse",
7253
7829
  "additionalProperties": false
7254
7830
  }
7255
- }
7831
+ },
7832
+ "tags": [
7833
+ "documented"
7834
+ ]
7256
7835
  },
7257
7836
  "getWorkspace": {
7258
7837
  "name": "getWorkspace",
@@ -7268,6 +7847,12 @@ export const state = {
7268
7847
  "type": "string",
7269
7848
  "description": "Workspace ID",
7270
7849
  "in": "path"
7850
+ },
7851
+ "x-multiple-integrations": {
7852
+ "in": "header",
7853
+ "type": "string",
7854
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
7855
+ "required": false
7271
7856
  }
7272
7857
  },
7273
7858
  "response": {
@@ -7366,7 +7951,10 @@ export const state = {
7366
7951
  "title": "getWorkspaceResponse",
7367
7952
  "additionalProperties": false
7368
7953
  }
7369
- }
7954
+ },
7955
+ "tags": [
7956
+ "documented"
7957
+ ]
7370
7958
  },
7371
7959
  "listWorkspaceUsages": {
7372
7960
  "name": "listWorkspaceUsages",
@@ -7409,6 +7997,12 @@ export const state = {
7409
7997
  "description": "Period to get",
7410
7998
  "type": "string",
7411
7999
  "required": false
8000
+ },
8001
+ "x-multiple-integrations": {
8002
+ "in": "header",
8003
+ "type": "string",
8004
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8005
+ "required": false
7412
8006
  }
7413
8007
  },
7414
8008
  "response": {
@@ -7472,6 +8066,12 @@ export const state = {
7472
8066
  "description": "Period to get",
7473
8067
  "type": "string",
7474
8068
  "required": false
8069
+ },
8070
+ "x-multiple-integrations": {
8071
+ "in": "header",
8072
+ "type": "string",
8073
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8074
+ "required": false
7475
8075
  }
7476
8076
  },
7477
8077
  "response": {
@@ -7553,7 +8153,14 @@ export const state = {
7553
8153
  "title": "getAllWorkspaceQuotaCompletionResponse"
7554
8154
  }
7555
8155
  },
7556
- "parameters": {}
8156
+ "parameters": {
8157
+ "x-multiple-integrations": {
8158
+ "in": "header",
8159
+ "type": "string",
8160
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8161
+ "required": false
8162
+ }
8163
+ }
7557
8164
  },
7558
8165
  "getWorkspaceQuota": {
7559
8166
  "name": "getWorkspaceQuota",
@@ -7596,6 +8203,12 @@ export const state = {
7596
8203
  "description": "Period to get",
7597
8204
  "type": "string",
7598
8205
  "required": false
8206
+ },
8207
+ "x-multiple-integrations": {
8208
+ "in": "header",
8209
+ "type": "string",
8210
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8211
+ "required": false
7599
8212
  }
7600
8213
  },
7601
8214
  "response": {
@@ -7670,6 +8283,12 @@ export const state = {
7670
8283
  "description": "Period to get",
7671
8284
  "type": "string",
7672
8285
  "required": false
8286
+ },
8287
+ "x-multiple-integrations": {
8288
+ "in": "header",
8289
+ "type": "string",
8290
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8291
+ "required": false
7673
8292
  }
7674
8293
  },
7675
8294
  "response": {
@@ -7740,6 +8359,12 @@ export const state = {
7740
8359
  "type": "string",
7741
8360
  "description": "Workspace ID",
7742
8361
  "in": "path"
8362
+ },
8363
+ "x-multiple-integrations": {
8364
+ "in": "header",
8365
+ "type": "string",
8366
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8367
+ "required": false
7743
8368
  }
7744
8369
  },
7745
8370
  "requestBody": {
@@ -7886,7 +8511,10 @@ export const state = {
7886
8511
  "title": "updateWorkspaceResponse",
7887
8512
  "additionalProperties": false
7888
8513
  }
7889
- }
8514
+ },
8515
+ "tags": [
8516
+ "documented"
8517
+ ]
7890
8518
  },
7891
8519
  "checkHandleAvailability": {
7892
8520
  "name": "checkHandleAvailability",
@@ -7942,7 +8570,14 @@ export const state = {
7942
8570
  "additionalProperties": false
7943
8571
  }
7944
8572
  },
7945
- "parameters": {}
8573
+ "parameters": {
8574
+ "x-multiple-integrations": {
8575
+ "in": "header",
8576
+ "type": "string",
8577
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8578
+ "required": false
8579
+ }
8580
+ }
7946
8581
  },
7947
8582
  "listWorkspaces": {
7948
8583
  "name": "listWorkspaces",
@@ -7964,6 +8599,12 @@ export const state = {
7964
8599
  "description": "Workspace handle",
7965
8600
  "type": "string",
7966
8601
  "required": false
8602
+ },
8603
+ "x-multiple-integrations": {
8604
+ "in": "header",
8605
+ "type": "string",
8606
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8607
+ "required": false
7967
8608
  }
7968
8609
  },
7969
8610
  "response": {
@@ -8085,7 +8726,10 @@ export const state = {
8085
8726
  "title": "listWorkspacesResponse",
8086
8727
  "additionalProperties": false
8087
8728
  }
8088
- }
8729
+ },
8730
+ "tags": [
8731
+ "documented"
8732
+ ]
8089
8733
  },
8090
8734
  "listPublicWorkspaces": {
8091
8735
  "name": "listPublicWorkspaces",
@@ -8113,6 +8757,12 @@ export const state = {
8113
8757
  "description": "Search query",
8114
8758
  "type": "string",
8115
8759
  "required": false
8760
+ },
8761
+ "x-multiple-integrations": {
8762
+ "in": "header",
8763
+ "type": "string",
8764
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8765
+ "required": false
8116
8766
  }
8117
8767
  },
8118
8768
  "response": {
@@ -8192,7 +8842,10 @@ export const state = {
8192
8842
  "title": "listPublicWorkspacesResponse",
8193
8843
  "additionalProperties": false
8194
8844
  }
8195
- }
8845
+ },
8846
+ "tags": [
8847
+ "documented"
8848
+ ]
8196
8849
  },
8197
8850
  "deleteWorkspace": {
8198
8851
  "name": "deleteWorkspace",
@@ -8208,6 +8861,12 @@ export const state = {
8208
8861
  "type": "string",
8209
8862
  "description": "Workspace ID",
8210
8863
  "in": "path"
8864
+ },
8865
+ "x-multiple-integrations": {
8866
+ "in": "header",
8867
+ "type": "string",
8868
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8869
+ "required": false
8211
8870
  }
8212
8871
  },
8213
8872
  "response": {
@@ -8217,7 +8876,10 @@ export const state = {
8217
8876
  "title": "deleteWorkspaceResponse",
8218
8877
  "additionalProperties": false
8219
8878
  }
8220
- }
8879
+ },
8880
+ "tags": [
8881
+ "documented"
8882
+ ]
8221
8883
  },
8222
8884
  "getAuditRecords": {
8223
8885
  "name": "getAuditRecords",
@@ -8235,6 +8897,12 @@ export const state = {
8235
8897
  "type": "string",
8236
8898
  "description": "Workspace ID",
8237
8899
  "in": "path"
8900
+ },
8901
+ "x-multiple-integrations": {
8902
+ "in": "header",
8903
+ "type": "string",
8904
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
8905
+ "required": false
8238
8906
  }
8239
8907
  },
8240
8908
  "disableDefaultParameters": {
@@ -8332,7 +9000,10 @@ export const state = {
8332
9000
  "title": "getAuditRecordsResponse",
8333
9001
  "additionalProperties": false
8334
9002
  }
8335
- }
9003
+ },
9004
+ "tags": [
9005
+ "documented"
9006
+ ]
8336
9007
  },
8337
9008
  "setWorkspacePreference": {
8338
9009
  "name": "setWorkspacePreference",
@@ -8348,6 +9019,12 @@ export const state = {
8348
9019
  "type": "string",
8349
9020
  "description": "Preference key",
8350
9021
  "in": "path"
9022
+ },
9023
+ "x-multiple-integrations": {
9024
+ "in": "header",
9025
+ "type": "string",
9026
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9027
+ "required": false
8351
9028
  }
8352
9029
  },
8353
9030
  "requestBody": {
@@ -8384,6 +9061,12 @@ export const state = {
8384
9061
  "type": "string",
8385
9062
  "description": "Preference key",
8386
9063
  "in": "path"
9064
+ },
9065
+ "x-multiple-integrations": {
9066
+ "in": "header",
9067
+ "type": "string",
9068
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9069
+ "required": false
8387
9070
  }
8388
9071
  },
8389
9072
  "response": {
@@ -8411,6 +9094,18 @@ export const state = {
8411
9094
  "in": "query",
8412
9095
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
8413
9096
  "type": "string"
9097
+ },
9098
+ "x-workspace-id": {
9099
+ "in": "header",
9100
+ "type": "string",
9101
+ "description": "Workspace ID",
9102
+ "required": true
9103
+ },
9104
+ "x-multiple-integrations": {
9105
+ "in": "header",
9106
+ "type": "string",
9107
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9108
+ "required": false
8414
9109
  }
8415
9110
  },
8416
9111
  "response": {
@@ -8481,7 +9176,10 @@ export const state = {
8481
9176
  "title": "listWorkspaceMembersResponse",
8482
9177
  "additionalProperties": false
8483
9178
  }
8484
- }
9179
+ },
9180
+ "tags": [
9181
+ "documented"
9182
+ ]
8485
9183
  },
8486
9184
  "getWorkspaceMember": {
8487
9185
  "name": "getWorkspaceMember",
@@ -8536,7 +9234,23 @@ export const state = {
8536
9234
  "additionalProperties": false
8537
9235
  }
8538
9236
  },
8539
- "parameters": {}
9237
+ "tags": [
9238
+ "documented"
9239
+ ],
9240
+ "parameters": {
9241
+ "x-workspace-id": {
9242
+ "in": "header",
9243
+ "type": "string",
9244
+ "description": "Workspace ID",
9245
+ "required": true
9246
+ },
9247
+ "x-multiple-integrations": {
9248
+ "in": "header",
9249
+ "type": "string",
9250
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9251
+ "required": false
9252
+ }
9253
+ }
8540
9254
  },
8541
9255
  "deleteWorkspaceMember": {
8542
9256
  "name": "deleteWorkspaceMember",
@@ -8549,6 +9263,18 @@ export const state = {
8549
9263
  "type": "string",
8550
9264
  "description": "Workspace member ID",
8551
9265
  "in": "path"
9266
+ },
9267
+ "x-workspace-id": {
9268
+ "in": "header",
9269
+ "type": "string",
9270
+ "description": "Workspace ID",
9271
+ "required": true
9272
+ },
9273
+ "x-multiple-integrations": {
9274
+ "in": "header",
9275
+ "type": "string",
9276
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9277
+ "required": false
8552
9278
  }
8553
9279
  },
8554
9280
  "response": {
@@ -8558,7 +9284,10 @@ export const state = {
8558
9284
  "title": "deleteWorkspaceMemberResponse",
8559
9285
  "additionalProperties": false
8560
9286
  }
8561
- }
9287
+ },
9288
+ "tags": [
9289
+ "documented"
9290
+ ]
8562
9291
  },
8563
9292
  "createWorkspaceMember": {
8564
9293
  "name": "createWorkspaceMember",
@@ -8642,7 +9371,23 @@ export const state = {
8642
9371
  "additionalProperties": false
8643
9372
  }
8644
9373
  },
8645
- "parameters": {}
9374
+ "tags": [
9375
+ "documented"
9376
+ ],
9377
+ "parameters": {
9378
+ "x-workspace-id": {
9379
+ "in": "header",
9380
+ "type": "string",
9381
+ "description": "Workspace ID",
9382
+ "required": true
9383
+ },
9384
+ "x-multiple-integrations": {
9385
+ "in": "header",
9386
+ "type": "string",
9387
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9388
+ "required": false
9389
+ }
9390
+ }
8646
9391
  },
8647
9392
  "updateWorkspaceMember": {
8648
9393
  "name": "updateWorkspaceMember",
@@ -8655,6 +9400,18 @@ export const state = {
8655
9400
  "type": "string",
8656
9401
  "description": "Workspace member ID",
8657
9402
  "in": "path"
9403
+ },
9404
+ "x-workspace-id": {
9405
+ "in": "header",
9406
+ "type": "string",
9407
+ "description": "Workspace ID",
9408
+ "required": true
9409
+ },
9410
+ "x-multiple-integrations": {
9411
+ "in": "header",
9412
+ "type": "string",
9413
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9414
+ "required": false
8658
9415
  }
8659
9416
  },
8660
9417
  "requestBody": {
@@ -8724,7 +9481,10 @@ export const state = {
8724
9481
  "title": "updateWorkspaceMemberResponse",
8725
9482
  "additionalProperties": false
8726
9483
  }
8727
- }
9484
+ },
9485
+ "tags": [
9486
+ "documented"
9487
+ ]
8728
9488
  },
8729
9489
  "listIntegrationApiKeys": {
8730
9490
  "name": "listIntegrationApiKeys",
@@ -8738,6 +9498,18 @@ export const state = {
8738
9498
  "description": "ID of the integration",
8739
9499
  "type": "string",
8740
9500
  "required": true
9501
+ },
9502
+ "x-workspace-id": {
9503
+ "in": "header",
9504
+ "type": "string",
9505
+ "description": "Workspace ID",
9506
+ "required": true
9507
+ },
9508
+ "x-multiple-integrations": {
9509
+ "in": "header",
9510
+ "type": "string",
9511
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9512
+ "required": false
8741
9513
  }
8742
9514
  },
8743
9515
  "response": {
@@ -8832,7 +9604,20 @@ export const state = {
8832
9604
  "additionalProperties": false
8833
9605
  }
8834
9606
  },
8835
- "parameters": {}
9607
+ "parameters": {
9608
+ "x-workspace-id": {
9609
+ "in": "header",
9610
+ "type": "string",
9611
+ "description": "Workspace ID",
9612
+ "required": true
9613
+ },
9614
+ "x-multiple-integrations": {
9615
+ "in": "header",
9616
+ "type": "string",
9617
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9618
+ "required": false
9619
+ }
9620
+ }
8836
9621
  },
8837
9622
  "deleteIntegrationApiKey": {
8838
9623
  "name": "deleteIntegrationApiKey",
@@ -8843,8 +9628,20 @@ export const state = {
8843
9628
  "parameters": {
8844
9629
  "id": {
8845
9630
  "type": "string",
8846
- "description": "ID of Integration Api Key",
8847
- "in": "path"
9631
+ "description": "ID of Integration Api Key",
9632
+ "in": "path"
9633
+ },
9634
+ "x-workspace-id": {
9635
+ "in": "header",
9636
+ "type": "string",
9637
+ "description": "Workspace ID",
9638
+ "required": true
9639
+ },
9640
+ "x-multiple-integrations": {
9641
+ "in": "header",
9642
+ "type": "string",
9643
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
9644
+ "required": false
8848
9645
  }
8849
9646
  },
8850
9647
  "response": {
@@ -9470,7 +10267,23 @@ export const state = {
9470
10267
  "additionalProperties": false
9471
10268
  }
9472
10269
  },
9473
- "parameters": {}
10270
+ "tags": [
10271
+ "documented"
10272
+ ],
10273
+ "parameters": {
10274
+ "x-workspace-id": {
10275
+ "in": "header",
10276
+ "type": "string",
10277
+ "description": "Workspace ID",
10278
+ "required": true
10279
+ },
10280
+ "x-multiple-integrations": {
10281
+ "in": "header",
10282
+ "type": "string",
10283
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
10284
+ "required": false
10285
+ }
10286
+ }
9474
10287
  },
9475
10288
  "validateIntegrationCreation": {
9476
10289
  "name": "validateIntegrationCreation",
@@ -10078,7 +10891,23 @@ export const state = {
10078
10891
  "additionalProperties": false
10079
10892
  }
10080
10893
  },
10081
- "parameters": {}
10894
+ "tags": [
10895
+ "documented"
10896
+ ],
10897
+ "parameters": {
10898
+ "x-workspace-id": {
10899
+ "in": "header",
10900
+ "type": "string",
10901
+ "description": "Workspace ID",
10902
+ "required": true
10903
+ },
10904
+ "x-multiple-integrations": {
10905
+ "in": "header",
10906
+ "type": "string",
10907
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
10908
+ "required": false
10909
+ }
10910
+ }
10082
10911
  },
10083
10912
  "updateIntegration": {
10084
10913
  "name": "updateIntegration",
@@ -10091,6 +10920,18 @@ export const state = {
10091
10920
  "type": "string",
10092
10921
  "description": "Integration Version ID",
10093
10922
  "in": "path"
10923
+ },
10924
+ "x-workspace-id": {
10925
+ "in": "header",
10926
+ "type": "string",
10927
+ "description": "Workspace ID",
10928
+ "required": true
10929
+ },
10930
+ "x-multiple-integrations": {
10931
+ "in": "header",
10932
+ "type": "string",
10933
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
10934
+ "required": false
10094
10935
  }
10095
10936
  },
10096
10937
  "requestBody": {
@@ -10700,7 +11541,10 @@ export const state = {
10700
11541
  "title": "updateIntegrationResponse",
10701
11542
  "additionalProperties": false
10702
11543
  }
10703
- }
11544
+ },
11545
+ "tags": [
11546
+ "documented"
11547
+ ]
10704
11548
  },
10705
11549
  "validateIntegrationUpdate": {
10706
11550
  "name": "validateIntegrationUpdate",
@@ -10713,6 +11557,18 @@ export const state = {
10713
11557
  "type": "string",
10714
11558
  "description": "Integration Version ID",
10715
11559
  "in": "path"
11560
+ },
11561
+ "x-workspace-id": {
11562
+ "in": "header",
11563
+ "type": "string",
11564
+ "description": "Workspace ID",
11565
+ "required": true
11566
+ },
11567
+ "x-multiple-integrations": {
11568
+ "in": "header",
11569
+ "type": "string",
11570
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
11571
+ "required": false
10716
11572
  }
10717
11573
  },
10718
11574
  "requestBody": {
@@ -11314,7 +12170,10 @@ export const state = {
11314
12170
  "title": "validateIntegrationUpdateResponse",
11315
12171
  "additionalProperties": false
11316
12172
  }
11317
- }
12173
+ },
12174
+ "tags": [
12175
+ "documented"
12176
+ ]
11318
12177
  },
11319
12178
  "listIntegrations": {
11320
12179
  "name": "listIntegrations",
@@ -11411,6 +12270,18 @@ export const state = {
11411
12270
  "description": "If true, only dev integrations are returned. Otherwise, only production integrations are returned.",
11412
12271
  "type": "boolean",
11413
12272
  "required": false
12273
+ },
12274
+ "x-workspace-id": {
12275
+ "in": "header",
12276
+ "type": "string",
12277
+ "description": "Workspace ID",
12278
+ "required": true
12279
+ },
12280
+ "x-multiple-integrations": {
12281
+ "in": "header",
12282
+ "type": "string",
12283
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
12284
+ "required": false
11414
12285
  }
11415
12286
  },
11416
12287
  "response": {
@@ -11574,7 +12445,10 @@ export const state = {
11574
12445
  "title": "listIntegrationsResponse",
11575
12446
  "additionalProperties": false
11576
12447
  }
11577
- }
12448
+ },
12449
+ "tags": [
12450
+ "documented"
12451
+ ]
11578
12452
  },
11579
12453
  "getIntegration": {
11580
12454
  "name": "getIntegration",
@@ -11587,6 +12461,18 @@ export const state = {
11587
12461
  "type": "string",
11588
12462
  "description": "Integration Version ID",
11589
12463
  "in": "path"
12464
+ },
12465
+ "x-workspace-id": {
12466
+ "in": "header",
12467
+ "type": "string",
12468
+ "description": "Workspace ID",
12469
+ "required": true
12470
+ },
12471
+ "x-multiple-integrations": {
12472
+ "in": "header",
12473
+ "type": "string",
12474
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
12475
+ "required": false
11590
12476
  }
11591
12477
  },
11592
12478
  "response": {
@@ -11604,7 +12490,10 @@ export const state = {
11604
12490
  "title": "getIntegrationResponse",
11605
12491
  "additionalProperties": false
11606
12492
  }
11607
- }
12493
+ },
12494
+ "tags": [
12495
+ "documented"
12496
+ ]
11608
12497
  },
11609
12498
  "getIntegrationLogs": {
11610
12499
  "name": "getIntegrationLogs",
@@ -11659,6 +12548,18 @@ export const state = {
11659
12548
  "description": "Token to get the next page of logs",
11660
12549
  "type": "string",
11661
12550
  "required": false
12551
+ },
12552
+ "x-workspace-id": {
12553
+ "in": "header",
12554
+ "type": "string",
12555
+ "description": "Workspace ID",
12556
+ "required": true
12557
+ },
12558
+ "x-multiple-integrations": {
12559
+ "in": "header",
12560
+ "type": "string",
12561
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
12562
+ "required": false
11662
12563
  }
11663
12564
  },
11664
12565
  "response": {
@@ -11707,7 +12608,10 @@ export const state = {
11707
12608
  "title": "getIntegrationLogsResponse",
11708
12609
  "additionalProperties": false
11709
12610
  }
11710
- }
12611
+ },
12612
+ "tags": [
12613
+ "documented"
12614
+ ]
11711
12615
  },
11712
12616
  "getIntegrationByName": {
11713
12617
  "name": "getIntegrationByName",
@@ -11725,6 +12629,18 @@ export const state = {
11725
12629
  "type": "string",
11726
12630
  "description": "Integration version. Either a semver version, semver version range, or the constant string \"latest\"",
11727
12631
  "in": "path"
12632
+ },
12633
+ "x-workspace-id": {
12634
+ "in": "header",
12635
+ "type": "string",
12636
+ "description": "Workspace ID",
12637
+ "required": true
12638
+ },
12639
+ "x-multiple-integrations": {
12640
+ "in": "header",
12641
+ "type": "string",
12642
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
12643
+ "required": false
11728
12644
  }
11729
12645
  },
11730
12646
  "response": {
@@ -11742,7 +12658,10 @@ export const state = {
11742
12658
  "title": "getIntegrationByNameResponse",
11743
12659
  "additionalProperties": false
11744
12660
  }
11745
- }
12661
+ },
12662
+ "tags": [
12663
+ "documented"
12664
+ ]
11746
12665
  },
11747
12666
  "deleteIntegration": {
11748
12667
  "name": "deleteIntegration",
@@ -11755,6 +12674,18 @@ export const state = {
11755
12674
  "type": "string",
11756
12675
  "description": "Integration Version ID",
11757
12676
  "in": "path"
12677
+ },
12678
+ "x-workspace-id": {
12679
+ "in": "header",
12680
+ "type": "string",
12681
+ "description": "Workspace ID",
12682
+ "required": true
12683
+ },
12684
+ "x-multiple-integrations": {
12685
+ "in": "header",
12686
+ "type": "string",
12687
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
12688
+ "required": false
11758
12689
  }
11759
12690
  },
11760
12691
  "response": {
@@ -11764,7 +12695,10 @@ export const state = {
11764
12695
  "title": "deleteIntegrationResponse",
11765
12696
  "additionalProperties": false
11766
12697
  }
11767
- }
12698
+ },
12699
+ "tags": [
12700
+ "documented"
12701
+ ]
11768
12702
  },
11769
12703
  "requestIntegrationVerification": {
11770
12704
  "name": "requestIntegrationVerification",
@@ -11796,14 +12730,40 @@ export const state = {
11796
12730
  "additionalProperties": false
11797
12731
  }
11798
12732
  },
11799
- "parameters": {}
12733
+ "parameters": {
12734
+ "x-workspace-id": {
12735
+ "in": "header",
12736
+ "type": "string",
12737
+ "description": "Workspace ID",
12738
+ "required": true
12739
+ },
12740
+ "x-multiple-integrations": {
12741
+ "in": "header",
12742
+ "type": "string",
12743
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
12744
+ "required": false
12745
+ }
12746
+ }
11800
12747
  },
11801
12748
  "createInterface": {
11802
12749
  "name": "createInterface",
11803
12750
  "description": "Create Interface",
11804
12751
  "method": "post",
11805
12752
  "path": "/v1/admin/interfaces",
11806
- "parameters": {},
12753
+ "parameters": {
12754
+ "x-workspace-id": {
12755
+ "in": "header",
12756
+ "type": "string",
12757
+ "description": "Workspace ID",
12758
+ "required": true
12759
+ },
12760
+ "x-multiple-integrations": {
12761
+ "in": "header",
12762
+ "type": "string",
12763
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
12764
+ "required": false
12765
+ }
12766
+ },
11807
12767
  "requestBody": {
11808
12768
  "description": "Interface to create",
11809
12769
  "schema": {
@@ -12071,6 +13031,18 @@ export const state = {
12071
13031
  "in": "path",
12072
13032
  "type": "string",
12073
13033
  "description": "Interface id"
13034
+ },
13035
+ "x-workspace-id": {
13036
+ "in": "header",
13037
+ "type": "string",
13038
+ "description": "Workspace ID",
13039
+ "required": true
13040
+ },
13041
+ "x-multiple-integrations": {
13042
+ "in": "header",
13043
+ "type": "string",
13044
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
13045
+ "required": false
12074
13046
  }
12075
13047
  },
12076
13048
  "section": "interface",
@@ -12106,6 +13078,18 @@ export const state = {
12106
13078
  "type": "string",
12107
13079
  "description": "Interface version. Either a semver version, semver version range, or the constant string \"latest\"",
12108
13080
  "in": "path"
13081
+ },
13082
+ "x-workspace-id": {
13083
+ "in": "header",
13084
+ "type": "string",
13085
+ "description": "Workspace ID",
13086
+ "required": true
13087
+ },
13088
+ "x-multiple-integrations": {
13089
+ "in": "header",
13090
+ "type": "string",
13091
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
13092
+ "required": false
12109
13093
  }
12110
13094
  },
12111
13095
  "section": "interface",
@@ -12136,6 +13120,18 @@ export const state = {
12136
13120
  "in": "path",
12137
13121
  "type": "string",
12138
13122
  "description": "Interface id"
13123
+ },
13124
+ "x-workspace-id": {
13125
+ "in": "header",
13126
+ "type": "string",
13127
+ "description": "Workspace ID",
13128
+ "required": true
13129
+ },
13130
+ "x-multiple-integrations": {
13131
+ "in": "header",
13132
+ "type": "string",
13133
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
13134
+ "required": false
12139
13135
  }
12140
13136
  },
12141
13137
  "requestBody": {
@@ -12395,6 +13391,18 @@ export const state = {
12395
13391
  "in": "path",
12396
13392
  "type": "string",
12397
13393
  "description": "Interface id"
13394
+ },
13395
+ "x-workspace-id": {
13396
+ "in": "header",
13397
+ "type": "string",
13398
+ "description": "Workspace ID",
13399
+ "required": true
13400
+ },
13401
+ "x-multiple-integrations": {
13402
+ "in": "header",
13403
+ "type": "string",
13404
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
13405
+ "required": false
12398
13406
  }
12399
13407
  },
12400
13408
  "section": "interface",
@@ -12428,6 +13436,18 @@ export const state = {
12428
13436
  "in": "query",
12429
13437
  "type": "string",
12430
13438
  "description": "Filter an interface by name and version"
13439
+ },
13440
+ "x-workspace-id": {
13441
+ "in": "header",
13442
+ "type": "string",
13443
+ "description": "Workspace ID",
13444
+ "required": true
13445
+ },
13446
+ "x-multiple-integrations": {
13447
+ "in": "header",
13448
+ "type": "string",
13449
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
13450
+ "required": false
12431
13451
  }
12432
13452
  },
12433
13453
  "response": {
@@ -12529,7 +13549,20 @@ export const state = {
12529
13549
  "description": "Create Plugin",
12530
13550
  "method": "post",
12531
13551
  "path": "/v1/admin/plugins",
12532
- "parameters": {},
13552
+ "parameters": {
13553
+ "x-workspace-id": {
13554
+ "in": "header",
13555
+ "type": "string",
13556
+ "description": "Workspace ID",
13557
+ "required": true
13558
+ },
13559
+ "x-multiple-integrations": {
13560
+ "in": "header",
13561
+ "type": "string",
13562
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
13563
+ "required": false
13564
+ }
13565
+ },
12533
13566
  "requestBody": {
12534
13567
  "description": "Plugin to create",
12535
13568
  "schema": {
@@ -12899,6 +13932,18 @@ export const state = {
12899
13932
  "in": "path",
12900
13933
  "type": "string",
12901
13934
  "description": "Plugin id"
13935
+ },
13936
+ "x-workspace-id": {
13937
+ "in": "header",
13938
+ "type": "string",
13939
+ "description": "Workspace ID",
13940
+ "required": true
13941
+ },
13942
+ "x-multiple-integrations": {
13943
+ "in": "header",
13944
+ "type": "string",
13945
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
13946
+ "required": false
12902
13947
  }
12903
13948
  },
12904
13949
  "section": "plugin",
@@ -12944,6 +13989,18 @@ export const state = {
12944
13989
  },
12945
13990
  "description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
12946
13991
  "required": true
13992
+ },
13993
+ "x-workspace-id": {
13994
+ "in": "header",
13995
+ "type": "string",
13996
+ "description": "Workspace ID",
13997
+ "required": true
13998
+ },
13999
+ "x-multiple-integrations": {
14000
+ "in": "header",
14001
+ "type": "string",
14002
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14003
+ "required": false
12947
14004
  }
12948
14005
  },
12949
14006
  "response": {
@@ -12978,6 +14035,18 @@ export const state = {
12978
14035
  "type": "string",
12979
14036
  "description": "Plugin version. Either a semver version, semver version range, or the constant string \"latest\"",
12980
14037
  "in": "path"
14038
+ },
14039
+ "x-workspace-id": {
14040
+ "in": "header",
14041
+ "type": "string",
14042
+ "description": "Workspace ID",
14043
+ "required": true
14044
+ },
14045
+ "x-multiple-integrations": {
14046
+ "in": "header",
14047
+ "type": "string",
14048
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14049
+ "required": false
12981
14050
  }
12982
14051
  },
12983
14052
  "section": "plugin",
@@ -13008,6 +14077,18 @@ export const state = {
13008
14077
  "in": "path",
13009
14078
  "type": "string",
13010
14079
  "description": "Plugin id"
14080
+ },
14081
+ "x-workspace-id": {
14082
+ "in": "header",
14083
+ "type": "string",
14084
+ "description": "Workspace ID",
14085
+ "required": true
14086
+ },
14087
+ "x-multiple-integrations": {
14088
+ "in": "header",
14089
+ "type": "string",
14090
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14091
+ "required": false
13011
14092
  }
13012
14093
  },
13013
14094
  "requestBody": {
@@ -13367,6 +14448,18 @@ export const state = {
13367
14448
  "in": "path",
13368
14449
  "type": "string",
13369
14450
  "description": "Plugin id"
14451
+ },
14452
+ "x-workspace-id": {
14453
+ "in": "header",
14454
+ "type": "string",
14455
+ "description": "Workspace ID",
14456
+ "required": true
14457
+ },
14458
+ "x-multiple-integrations": {
14459
+ "in": "header",
14460
+ "type": "string",
14461
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14462
+ "required": false
13370
14463
  }
13371
14464
  },
13372
14465
  "section": "plugin",
@@ -13400,6 +14493,18 @@ export const state = {
13400
14493
  "in": "query",
13401
14494
  "type": "string",
13402
14495
  "description": "Filter a plugin by name and version"
14496
+ },
14497
+ "x-workspace-id": {
14498
+ "in": "header",
14499
+ "type": "string",
14500
+ "description": "Workspace ID",
14501
+ "required": true
14502
+ },
14503
+ "x-multiple-integrations": {
14504
+ "in": "header",
14505
+ "type": "string",
14506
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14507
+ "required": false
13403
14508
  }
13404
14509
  },
13405
14510
  "response": {
@@ -13516,6 +14621,18 @@ export const state = {
13516
14621
  "browser"
13517
14622
  ],
13518
14623
  "description": "Platform"
14624
+ },
14625
+ "x-workspace-id": {
14626
+ "in": "header",
14627
+ "type": "string",
14628
+ "description": "Workspace ID",
14629
+ "required": true
14630
+ },
14631
+ "x-multiple-integrations": {
14632
+ "in": "header",
14633
+ "type": "string",
14634
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14635
+ "required": false
13519
14636
  }
13520
14637
  },
13521
14638
  "response": {
@@ -13573,6 +14690,18 @@ export const state = {
13573
14690
  "type": "string",
13574
14691
  "description": "ID of a bot or a workspace, depending on the \"type\" parameter",
13575
14692
  "in": "path"
14693
+ },
14694
+ "x-workspace-id": {
14695
+ "in": "header",
14696
+ "type": "string",
14697
+ "description": "Workspace ID",
14698
+ "required": true
14699
+ },
14700
+ "x-multiple-integrations": {
14701
+ "in": "header",
14702
+ "type": "string",
14703
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14704
+ "required": false
13576
14705
  }
13577
14706
  },
13578
14707
  "response": {
@@ -13619,6 +14748,12 @@ export const state = {
13619
14748
  "description": "Period to get",
13620
14749
  "type": "string",
13621
14750
  "required": false
14751
+ },
14752
+ "x-multiple-integrations": {
14753
+ "in": "header",
14754
+ "type": "string",
14755
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14756
+ "required": false
13622
14757
  }
13623
14758
  },
13624
14759
  "response": {
@@ -13672,6 +14807,18 @@ export const state = {
13672
14807
  "type": "string",
13673
14808
  "description": "ID of a bot or a workspace, depending on the \"type\" parameter",
13674
14809
  "in": "path"
14810
+ },
14811
+ "x-workspace-id": {
14812
+ "in": "header",
14813
+ "type": "string",
14814
+ "description": "Workspace ID",
14815
+ "required": true
14816
+ },
14817
+ "x-multiple-integrations": {
14818
+ "in": "header",
14819
+ "type": "string",
14820
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14821
+ "required": false
13675
14822
  }
13676
14823
  },
13677
14824
  "response": {
@@ -13740,6 +14887,18 @@ export const state = {
13740
14887
  "in": "query",
13741
14888
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
13742
14889
  "type": "string"
14890
+ },
14891
+ "x-workspace-id": {
14892
+ "in": "header",
14893
+ "type": "string",
14894
+ "description": "Workspace ID",
14895
+ "required": true
14896
+ },
14897
+ "x-multiple-integrations": {
14898
+ "in": "header",
14899
+ "type": "string",
14900
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
14901
+ "required": false
13743
14902
  }
13744
14903
  },
13745
14904
  "response": {
@@ -13842,6 +15001,18 @@ export const state = {
13842
15001
  "in": "query",
13843
15002
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
13844
15003
  "type": "string"
15004
+ },
15005
+ "x-workspace-id": {
15006
+ "in": "header",
15007
+ "type": "string",
15008
+ "description": "Workspace ID",
15009
+ "required": true
15010
+ },
15011
+ "x-multiple-integrations": {
15012
+ "in": "header",
15013
+ "type": "string",
15014
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
15015
+ "required": false
13845
15016
  }
13846
15017
  },
13847
15018
  "response": {
@@ -13947,7 +15118,20 @@ export const state = {
13947
15118
  "additionalProperties": false
13948
15119
  }
13949
15120
  },
13950
- "parameters": {}
15121
+ "parameters": {
15122
+ "x-workspace-id": {
15123
+ "in": "header",
15124
+ "type": "string",
15125
+ "description": "Workspace ID",
15126
+ "required": true
15127
+ },
15128
+ "x-multiple-integrations": {
15129
+ "in": "header",
15130
+ "type": "string",
15131
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
15132
+ "required": false
15133
+ }
15134
+ }
13951
15135
  },
13952
15136
  "listActivities": {
13953
15137
  "name": "listActivities",
@@ -13975,6 +15159,12 @@ export const state = {
13975
15159
  "description": "ID of the bot to list activities for",
13976
15160
  "type": "string",
13977
15161
  "required": true
15162
+ },
15163
+ "x-multiple-integrations": {
15164
+ "in": "header",
15165
+ "type": "string",
15166
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
15167
+ "required": false
13978
15168
  }
13979
15169
  },
13980
15170
  "response": {
@@ -14056,16 +15246,37 @@ export const state = {
14056
15246
  "additionalProperties": false
14057
15247
  }
14058
15248
  },
14059
- "parameters": {}
15249
+ "parameters": {
15250
+ "x-multiple-integrations": {
15251
+ "in": "header",
15252
+ "type": "string",
15253
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
15254
+ "required": false
15255
+ }
15256
+ }
14060
15257
  }
14061
15258
  },
14062
15259
  "metadata": {
14063
15260
  "title": "Botpress Admin API",
14064
15261
  "description": "API for Botpress Cloud Manager",
14065
15262
  "server": "https://api.botpress.cloud",
14066
- "version": "1.50.0",
15263
+ "version": "1.52.0",
14067
15264
  "prefix": "v1"
14068
15265
  },
15266
+ "defaultParameters": {
15267
+ "x-workspace-id": {
15268
+ "in": "header",
15269
+ "type": "string",
15270
+ "description": "Workspace ID",
15271
+ "required": true
15272
+ },
15273
+ "x-multiple-integrations": {
15274
+ "in": "header",
15275
+ "type": "string",
15276
+ "description": "Whether the client supports bots with multiple instances of the same integration. Set to \"true\" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.",
15277
+ "required": false
15278
+ }
15279
+ },
14069
15280
  "errors": [
14070
15281
  {
14071
15282
  "status": 500,
@@ -16998,5 +18209,8 @@ export const state = {
16998
18209
  ],
16999
18210
  "options": {
17000
18211
  "allowUnions": false
17001
- }
18212
+ },
18213
+ "security": [
18214
+ "BearerAuth"
18215
+ ]
17002
18216
  } satisfies State