@botpress/api 1.3.2 → 1.5.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.
- package/dist/index.js +2771 -884
- package/dist/src/gen/admin/state.d.ts +803 -0
- package/dist/src/gen/files/state.d.ts +4 -0
- package/dist/src/gen/runtime/state.d.ts +4 -0
- package/dist/src/gen/state.d.ts +803 -0
- package/dist/src/gen/tables/state.d.ts +4 -0
- package/package.json +1 -1
- package/src/gen/admin/metadata.json +1 -1
- package/src/gen/admin/openapi.json +1 -1
- package/src/gen/admin/state.ts +950 -14
- package/src/gen/files/openapi.json +1 -1
- package/src/gen/files/state.ts +9 -4
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/runtime/openapi.json +1 -1
- package/src/gen/runtime/state.ts +9 -4
- package/src/gen/state.ts +950 -14
- package/src/gen/tables/openapi.json +1 -1
- package/src/gen/tables/state.ts +9 -4
package/dist/index.js
CHANGED
|
@@ -284643,7 +284643,7 @@ var state = {
|
|
|
284643
284643
|
"title": "Botpress API",
|
|
284644
284644
|
"description": "API for Botpress Cloud",
|
|
284645
284645
|
"server": "https://api.botpress.cloud",
|
|
284646
|
-
"version": "1.
|
|
284646
|
+
"version": "1.5.0",
|
|
284647
284647
|
"prefix": "v1"
|
|
284648
284648
|
},
|
|
284649
284649
|
"errors": [
|
|
@@ -284983,7 +284983,7 @@ var state = {
|
|
|
284983
284983
|
},
|
|
284984
284984
|
"public": {
|
|
284985
284985
|
"type": "boolean",
|
|
284986
|
-
"description": "
|
|
284986
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
284987
284987
|
},
|
|
284988
284988
|
"verificationStatus": {
|
|
284989
284989
|
"type": "string",
|
|
@@ -285996,7 +285996,7 @@ var state = {
|
|
|
285996
285996
|
},
|
|
285997
285997
|
"public": {
|
|
285998
285998
|
"type": "boolean",
|
|
285999
|
-
"description": "
|
|
285999
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
286000
286000
|
},
|
|
286001
286001
|
"verificationStatus": {
|
|
286002
286002
|
"type": "string",
|
|
@@ -286573,6 +286573,10 @@ var state = {
|
|
|
286573
286573
|
"readmeUrl": {
|
|
286574
286574
|
"type": "string",
|
|
286575
286575
|
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
286576
|
+
},
|
|
286577
|
+
"public": {
|
|
286578
|
+
"type": "boolean",
|
|
286579
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
286576
286580
|
}
|
|
286577
286581
|
},
|
|
286578
286582
|
"required": [
|
|
@@ -286591,7 +286595,8 @@ var state = {
|
|
|
286591
286595
|
"title",
|
|
286592
286596
|
"description",
|
|
286593
286597
|
"iconUrl",
|
|
286594
|
-
"readmeUrl"
|
|
286598
|
+
"readmeUrl",
|
|
286599
|
+
"public"
|
|
286595
286600
|
],
|
|
286596
286601
|
"additionalProperties": false
|
|
286597
286602
|
}
|
|
@@ -288832,7 +288837,7 @@ var state2 = {
|
|
|
288832
288837
|
},
|
|
288833
288838
|
"public": {
|
|
288834
288839
|
"type": "boolean",
|
|
288835
|
-
"description": "
|
|
288840
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
288836
288841
|
},
|
|
288837
288842
|
"verificationStatus": {
|
|
288838
288843
|
"type": "string",
|
|
@@ -289564,7 +289569,7 @@ var state2 = {
|
|
|
289564
289569
|
},
|
|
289565
289570
|
"public": {
|
|
289566
289571
|
"type": "boolean",
|
|
289567
|
-
"description": "
|
|
289572
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
289568
289573
|
},
|
|
289569
289574
|
"verificationStatus": {
|
|
289570
289575
|
"type": "string",
|
|
@@ -290281,7 +290286,7 @@ var state2 = {
|
|
|
290281
290286
|
},
|
|
290282
290287
|
"public": {
|
|
290283
290288
|
"type": "boolean",
|
|
290284
|
-
"description": "
|
|
290289
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
290285
290290
|
},
|
|
290286
290291
|
"verificationStatus": {
|
|
290287
290292
|
"type": "string",
|
|
@@ -290377,210 +290382,235 @@ var state2 = {
|
|
|
290377
290382
|
}
|
|
290378
290383
|
}
|
|
290379
290384
|
},
|
|
290380
|
-
"
|
|
290381
|
-
"name": "
|
|
290382
|
-
"description": "
|
|
290383
|
-
"method": "
|
|
290384
|
-
"section": "
|
|
290385
|
-
"path": "/v1/admin/
|
|
290386
|
-
"
|
|
290387
|
-
"
|
|
290385
|
+
"listPublicPlugins": {
|
|
290386
|
+
"name": "listPublicPlugins",
|
|
290387
|
+
"description": "List public plugin",
|
|
290388
|
+
"method": "get",
|
|
290389
|
+
"section": "hub",
|
|
290390
|
+
"path": "/v1/admin/hub/plugins",
|
|
290391
|
+
"disableDefaultParameters": {
|
|
290392
|
+
"x-workspace-id": true
|
|
290393
|
+
},
|
|
290394
|
+
"parameters": {
|
|
290395
|
+
"nextToken": {
|
|
290396
|
+
"in": "query",
|
|
290397
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
290398
|
+
"type": "string"
|
|
290399
|
+
},
|
|
290400
|
+
"name": {
|
|
290401
|
+
"in": "query",
|
|
290402
|
+
"type": "string",
|
|
290403
|
+
"description": "Filter all versions of a plugin by name"
|
|
290404
|
+
},
|
|
290405
|
+
"version": {
|
|
290406
|
+
"in": "query",
|
|
290407
|
+
"type": "string",
|
|
290408
|
+
"description": "Filter a plugin by name and version"
|
|
290409
|
+
}
|
|
290410
|
+
},
|
|
290411
|
+
"response": {
|
|
290412
|
+
"description": "Success",
|
|
290388
290413
|
"schema": {
|
|
290389
290414
|
"type": "object",
|
|
290390
290415
|
"properties": {
|
|
290391
|
-
"
|
|
290392
|
-
"type": "
|
|
290393
|
-
"
|
|
290416
|
+
"plugins": {
|
|
290417
|
+
"type": "array",
|
|
290418
|
+
"items": {
|
|
290394
290419
|
"type": "object",
|
|
290395
290420
|
"properties": {
|
|
290396
|
-
"
|
|
290421
|
+
"id": {
|
|
290397
290422
|
"type": "string",
|
|
290398
|
-
"
|
|
290399
|
-
|
|
290400
|
-
|
|
290401
|
-
"bot",
|
|
290402
|
-
"task"
|
|
290403
|
-
],
|
|
290404
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
290423
|
+
"minLength": 28,
|
|
290424
|
+
"maxLength": 36,
|
|
290425
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
290405
290426
|
},
|
|
290406
|
-
"
|
|
290407
|
-
"type": "
|
|
290408
|
-
"
|
|
290409
|
-
"description": "
|
|
290427
|
+
"createdAt": {
|
|
290428
|
+
"type": "string",
|
|
290429
|
+
"format": "date-time",
|
|
290430
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
290431
|
+
},
|
|
290432
|
+
"updatedAt": {
|
|
290433
|
+
"type": "string",
|
|
290434
|
+
"format": "date-time",
|
|
290435
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
290436
|
+
},
|
|
290437
|
+
"name": {
|
|
290438
|
+
"type": "string",
|
|
290439
|
+
"maxLength": 200,
|
|
290440
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
290441
|
+
},
|
|
290442
|
+
"version": {
|
|
290443
|
+
"type": "string",
|
|
290444
|
+
"maxLength": 200,
|
|
290445
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
290410
290446
|
},
|
|
290411
|
-
"expiry": {
|
|
290412
|
-
"type": "number",
|
|
290413
|
-
"minimum": 1,
|
|
290414
|
-
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
290415
|
-
}
|
|
290416
|
-
},
|
|
290417
|
-
"required": [
|
|
290418
|
-
"type",
|
|
290419
|
-
"schema"
|
|
290420
|
-
],
|
|
290421
|
-
"additionalProperties": false
|
|
290422
|
-
},
|
|
290423
|
-
"description": "A mapping of states to their definition"
|
|
290424
|
-
},
|
|
290425
|
-
"events": {
|
|
290426
|
-
"type": "object",
|
|
290427
|
-
"additionalProperties": {
|
|
290428
|
-
"type": "object",
|
|
290429
|
-
"properties": {
|
|
290430
290447
|
"title": {
|
|
290431
290448
|
"type": "string",
|
|
290449
|
+
"minLength": 1,
|
|
290432
290450
|
"maxLength": 64,
|
|
290433
|
-
"description": "Title of the
|
|
290451
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
290434
290452
|
},
|
|
290435
290453
|
"description": {
|
|
290436
290454
|
"type": "string",
|
|
290437
290455
|
"maxLength": 256,
|
|
290438
|
-
"description": "Description of the
|
|
290456
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
290439
290457
|
},
|
|
290440
|
-
"
|
|
290441
|
-
"type": "
|
|
290442
|
-
"
|
|
290443
|
-
}
|
|
290444
|
-
},
|
|
290445
|
-
"required": [
|
|
290446
|
-
"schema"
|
|
290447
|
-
],
|
|
290448
|
-
"description": "Event Definition",
|
|
290449
|
-
"additionalProperties": false
|
|
290450
|
-
},
|
|
290451
|
-
"description": "Events definition"
|
|
290452
|
-
},
|
|
290453
|
-
"recurringEvents": {
|
|
290454
|
-
"type": "object",
|
|
290455
|
-
"additionalProperties": {
|
|
290456
|
-
"type": "object",
|
|
290457
|
-
"properties": {
|
|
290458
|
-
"schedule": {
|
|
290459
|
-
"type": "object",
|
|
290460
|
-
"properties": {
|
|
290461
|
-
"cron": {
|
|
290462
|
-
"type": "string",
|
|
290463
|
-
"maxLength": 200
|
|
290464
|
-
}
|
|
290465
|
-
},
|
|
290466
|
-
"required": [
|
|
290467
|
-
"cron"
|
|
290468
|
-
],
|
|
290469
|
-
"additionalProperties": false
|
|
290458
|
+
"iconUrl": {
|
|
290459
|
+
"type": "string",
|
|
290460
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
290470
290461
|
},
|
|
290471
|
-
"
|
|
290462
|
+
"readmeUrl": {
|
|
290472
290463
|
"type": "string",
|
|
290473
|
-
"
|
|
290464
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
290474
290465
|
},
|
|
290475
|
-
"
|
|
290476
|
-
"type": "
|
|
290477
|
-
"
|
|
290466
|
+
"public": {
|
|
290467
|
+
"type": "boolean",
|
|
290468
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
290478
290469
|
}
|
|
290479
290470
|
},
|
|
290480
290471
|
"required": [
|
|
290481
|
-
"
|
|
290482
|
-
"
|
|
290483
|
-
"
|
|
290484
|
-
|
|
290485
|
-
|
|
290472
|
+
"id",
|
|
290473
|
+
"createdAt",
|
|
290474
|
+
"updatedAt",
|
|
290475
|
+
"name",
|
|
290476
|
+
"version",
|
|
290477
|
+
"title",
|
|
290478
|
+
"description",
|
|
290479
|
+
"iconUrl",
|
|
290480
|
+
"readmeUrl",
|
|
290481
|
+
"public"
|
|
290482
|
+
]
|
|
290486
290483
|
}
|
|
290487
290484
|
},
|
|
290488
|
-
"
|
|
290485
|
+
"meta": {
|
|
290489
290486
|
"type": "object",
|
|
290490
290487
|
"properties": {
|
|
290491
|
-
"
|
|
290492
|
-
"type": "
|
|
290493
|
-
"
|
|
290494
|
-
"type": "object",
|
|
290495
|
-
"additionalProperties": false
|
|
290496
|
-
},
|
|
290497
|
-
"nullable": true,
|
|
290498
|
-
"description": 'Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.'
|
|
290488
|
+
"nextToken": {
|
|
290489
|
+
"type": "string",
|
|
290490
|
+
"description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
|
|
290499
290491
|
}
|
|
290500
290492
|
},
|
|
290501
|
-
"required": [
|
|
290502
|
-
"events"
|
|
290503
|
-
],
|
|
290504
|
-
"description": "Subscriptions of the bot",
|
|
290505
290493
|
"additionalProperties": false
|
|
290506
|
-
}
|
|
290507
|
-
|
|
290494
|
+
}
|
|
290495
|
+
},
|
|
290496
|
+
"required": [
|
|
290497
|
+
"plugins",
|
|
290498
|
+
"meta"
|
|
290499
|
+
],
|
|
290500
|
+
"title": "listPublicPluginsResponse",
|
|
290501
|
+
"additionalProperties": false
|
|
290502
|
+
}
|
|
290503
|
+
}
|
|
290504
|
+
},
|
|
290505
|
+
"getPublicPluginById": {
|
|
290506
|
+
"name": "getPublicPluginById",
|
|
290507
|
+
"description": "Get public plugin by Id",
|
|
290508
|
+
"method": "get",
|
|
290509
|
+
"section": "hub",
|
|
290510
|
+
"path": "/v1/admin/hub/plugins/{id}",
|
|
290511
|
+
"disableDefaultParameters": {
|
|
290512
|
+
"x-workspace-id": true
|
|
290513
|
+
},
|
|
290514
|
+
"parameters": {
|
|
290515
|
+
"id": {
|
|
290516
|
+
"type": "string",
|
|
290517
|
+
"description": "Plugin ID",
|
|
290518
|
+
"in": "path"
|
|
290519
|
+
}
|
|
290520
|
+
},
|
|
290521
|
+
"response": {
|
|
290522
|
+
"description": "Success",
|
|
290523
|
+
"schema": {
|
|
290524
|
+
"type": "object",
|
|
290525
|
+
"properties": {
|
|
290526
|
+
"plugin": {
|
|
290508
290527
|
"type": "object",
|
|
290509
|
-
"
|
|
290510
|
-
"
|
|
290511
|
-
|
|
290512
|
-
"
|
|
290513
|
-
|
|
290514
|
-
|
|
290515
|
-
|
|
290516
|
-
|
|
290517
|
-
"
|
|
290518
|
-
|
|
290519
|
-
|
|
290520
|
-
|
|
290521
|
-
|
|
290522
|
-
"
|
|
290523
|
-
|
|
290524
|
-
|
|
290525
|
-
|
|
290526
|
-
|
|
290527
|
-
|
|
290528
|
-
"
|
|
290529
|
-
|
|
290530
|
-
|
|
290531
|
-
|
|
290532
|
-
|
|
290533
|
-
|
|
290534
|
-
|
|
290528
|
+
"properties": {
|
|
290529
|
+
"id": {
|
|
290530
|
+
"type": "string",
|
|
290531
|
+
"minLength": 28,
|
|
290532
|
+
"maxLength": 36,
|
|
290533
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
290534
|
+
},
|
|
290535
|
+
"name": {
|
|
290536
|
+
"type": "string",
|
|
290537
|
+
"maxLength": 200,
|
|
290538
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
290539
|
+
},
|
|
290540
|
+
"version": {
|
|
290541
|
+
"type": "string",
|
|
290542
|
+
"maxLength": 200,
|
|
290543
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
290544
|
+
},
|
|
290545
|
+
"createdAt": {
|
|
290546
|
+
"type": "string",
|
|
290547
|
+
"format": "date-time",
|
|
290548
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
290549
|
+
},
|
|
290550
|
+
"updatedAt": {
|
|
290551
|
+
"type": "string",
|
|
290552
|
+
"format": "date-time",
|
|
290553
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
290554
|
+
},
|
|
290555
|
+
"configuration": {
|
|
290556
|
+
"type": "object",
|
|
290557
|
+
"properties": {
|
|
290558
|
+
"title": {
|
|
290559
|
+
"type": "string",
|
|
290560
|
+
"maxLength": 64,
|
|
290561
|
+
"description": "Title of the configuration"
|
|
290535
290562
|
},
|
|
290536
|
-
"
|
|
290537
|
-
"
|
|
290538
|
-
|
|
290539
|
-
|
|
290563
|
+
"description": {
|
|
290564
|
+
"type": "string",
|
|
290565
|
+
"maxLength": 256,
|
|
290566
|
+
"description": "Description of the configuration"
|
|
290567
|
+
},
|
|
290568
|
+
"schema": {
|
|
290569
|
+
"type": "object",
|
|
290570
|
+
"additionalProperties": true,
|
|
290571
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
290572
|
+
}
|
|
290540
290573
|
},
|
|
290541
|
-
"
|
|
290574
|
+
"required": [
|
|
290575
|
+
"schema"
|
|
290576
|
+
],
|
|
290577
|
+
"description": "Configuration definition",
|
|
290578
|
+
"additionalProperties": false
|
|
290579
|
+
},
|
|
290580
|
+
"states": {
|
|
290581
|
+
"type": "object",
|
|
290582
|
+
"additionalProperties": {
|
|
290542
290583
|
"type": "object",
|
|
290543
290584
|
"properties": {
|
|
290585
|
+
"type": {
|
|
290586
|
+
"type": "string",
|
|
290587
|
+
"enum": [
|
|
290588
|
+
"conversation",
|
|
290589
|
+
"user",
|
|
290590
|
+
"bot",
|
|
290591
|
+
"task"
|
|
290592
|
+
],
|
|
290593
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
290594
|
+
},
|
|
290544
290595
|
"schema": {
|
|
290545
290596
|
"type": "object",
|
|
290546
|
-
"additionalProperties": true
|
|
290597
|
+
"additionalProperties": true,
|
|
290598
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
290599
|
+
},
|
|
290600
|
+
"expiry": {
|
|
290601
|
+
"type": "number",
|
|
290602
|
+
"minimum": 1,
|
|
290603
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
290547
290604
|
}
|
|
290548
290605
|
},
|
|
290549
290606
|
"required": [
|
|
290607
|
+
"type",
|
|
290550
290608
|
"schema"
|
|
290551
290609
|
],
|
|
290552
290610
|
"additionalProperties": false
|
|
290553
290611
|
}
|
|
290554
290612
|
},
|
|
290555
|
-
"
|
|
290556
|
-
"input",
|
|
290557
|
-
"output"
|
|
290558
|
-
],
|
|
290559
|
-
"description": "Action definition",
|
|
290560
|
-
"additionalProperties": false
|
|
290561
|
-
},
|
|
290562
|
-
"description": "Actions definition"
|
|
290563
|
-
},
|
|
290564
|
-
"configuration": {
|
|
290565
|
-
"type": "object",
|
|
290566
|
-
"properties": {
|
|
290567
|
-
"data": {
|
|
290568
|
-
"type": "object",
|
|
290569
|
-
"additionalProperties": true,
|
|
290570
|
-
"description": "Configuration data"
|
|
290571
|
-
},
|
|
290572
|
-
"schema": {
|
|
290573
|
-
"type": "object",
|
|
290574
|
-
"additionalProperties": true,
|
|
290575
|
-
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
290576
|
-
}
|
|
290577
|
-
},
|
|
290578
|
-
"additionalProperties": false
|
|
290579
|
-
},
|
|
290580
|
-
"user": {
|
|
290581
|
-
"type": "object",
|
|
290582
|
-
"properties": {
|
|
290583
|
-
"tags": {
|
|
290613
|
+
"events": {
|
|
290584
290614
|
"type": "object",
|
|
290585
290615
|
"additionalProperties": {
|
|
290586
290616
|
"type": "object",
|
|
@@ -290588,25 +290618,26 @@ var state2 = {
|
|
|
290588
290618
|
"title": {
|
|
290589
290619
|
"type": "string",
|
|
290590
290620
|
"maxLength": 64,
|
|
290591
|
-
"description": "Title of the
|
|
290621
|
+
"description": "Title of the event"
|
|
290592
290622
|
},
|
|
290593
290623
|
"description": {
|
|
290594
290624
|
"type": "string",
|
|
290595
290625
|
"maxLength": 256,
|
|
290596
|
-
"description": "Description of the
|
|
290626
|
+
"description": "Description of the event"
|
|
290627
|
+
},
|
|
290628
|
+
"schema": {
|
|
290629
|
+
"type": "object",
|
|
290630
|
+
"additionalProperties": true
|
|
290597
290631
|
}
|
|
290598
290632
|
},
|
|
290599
|
-
"
|
|
290633
|
+
"required": [
|
|
290634
|
+
"schema"
|
|
290635
|
+
],
|
|
290636
|
+
"description": "Event Definition",
|
|
290600
290637
|
"additionalProperties": false
|
|
290601
290638
|
}
|
|
290602
|
-
}
|
|
290603
|
-
|
|
290604
|
-
"additionalProperties": false
|
|
290605
|
-
},
|
|
290606
|
-
"conversation": {
|
|
290607
|
-
"type": "object",
|
|
290608
|
-
"properties": {
|
|
290609
|
-
"tags": {
|
|
290639
|
+
},
|
|
290640
|
+
"actions": {
|
|
290610
290641
|
"type": "object",
|
|
290611
290642
|
"additionalProperties": {
|
|
290612
290643
|
"type": "object",
|
|
@@ -290614,111 +290645,990 @@ var state2 = {
|
|
|
290614
290645
|
"title": {
|
|
290615
290646
|
"type": "string",
|
|
290616
290647
|
"maxLength": 64,
|
|
290617
|
-
"description": "Title of the
|
|
290648
|
+
"description": "Title of the action"
|
|
290618
290649
|
},
|
|
290619
290650
|
"description": {
|
|
290620
290651
|
"type": "string",
|
|
290621
290652
|
"maxLength": 256,
|
|
290622
|
-
"description": "Description of the
|
|
290653
|
+
"description": "Description of the action"
|
|
290654
|
+
},
|
|
290655
|
+
"billable": {
|
|
290656
|
+
"type": "boolean"
|
|
290657
|
+
},
|
|
290658
|
+
"cacheable": {
|
|
290659
|
+
"type": "boolean"
|
|
290660
|
+
},
|
|
290661
|
+
"input": {
|
|
290662
|
+
"type": "object",
|
|
290663
|
+
"properties": {
|
|
290664
|
+
"schema": {
|
|
290665
|
+
"type": "object",
|
|
290666
|
+
"additionalProperties": true
|
|
290667
|
+
}
|
|
290668
|
+
},
|
|
290669
|
+
"required": [
|
|
290670
|
+
"schema"
|
|
290671
|
+
],
|
|
290672
|
+
"additionalProperties": false
|
|
290673
|
+
},
|
|
290674
|
+
"output": {
|
|
290675
|
+
"type": "object",
|
|
290676
|
+
"properties": {
|
|
290677
|
+
"schema": {
|
|
290678
|
+
"type": "object",
|
|
290679
|
+
"additionalProperties": true
|
|
290680
|
+
}
|
|
290681
|
+
},
|
|
290682
|
+
"required": [
|
|
290683
|
+
"schema"
|
|
290684
|
+
],
|
|
290685
|
+
"additionalProperties": false
|
|
290623
290686
|
}
|
|
290624
290687
|
},
|
|
290625
|
-
"
|
|
290688
|
+
"required": [
|
|
290689
|
+
"input",
|
|
290690
|
+
"output"
|
|
290691
|
+
],
|
|
290692
|
+
"description": "Action definition",
|
|
290626
290693
|
"additionalProperties": false
|
|
290627
290694
|
}
|
|
290628
|
-
}
|
|
290629
|
-
|
|
290630
|
-
"additionalProperties": false
|
|
290631
|
-
},
|
|
290632
|
-
"message": {
|
|
290633
|
-
"type": "object",
|
|
290634
|
-
"properties": {
|
|
290635
|
-
"tags": {
|
|
290695
|
+
},
|
|
290696
|
+
"dependencies": {
|
|
290636
290697
|
"type": "object",
|
|
290637
|
-
"
|
|
290638
|
-
"
|
|
290639
|
-
|
|
290640
|
-
"
|
|
290641
|
-
"type": "
|
|
290642
|
-
"
|
|
290643
|
-
|
|
290644
|
-
|
|
290645
|
-
|
|
290646
|
-
|
|
290647
|
-
|
|
290648
|
-
|
|
290698
|
+
"properties": {
|
|
290699
|
+
"interfaces": {
|
|
290700
|
+
"type": "object",
|
|
290701
|
+
"additionalProperties": {
|
|
290702
|
+
"type": "object",
|
|
290703
|
+
"properties": {
|
|
290704
|
+
"id": {
|
|
290705
|
+
"type": "string",
|
|
290706
|
+
"minLength": 28,
|
|
290707
|
+
"maxLength": 36
|
|
290708
|
+
},
|
|
290709
|
+
"name": {
|
|
290710
|
+
"type": "string",
|
|
290711
|
+
"maxLength": 200
|
|
290712
|
+
},
|
|
290713
|
+
"version": {
|
|
290714
|
+
"type": "string",
|
|
290715
|
+
"maxLength": 200
|
|
290716
|
+
}
|
|
290717
|
+
},
|
|
290718
|
+
"required": [
|
|
290719
|
+
"id",
|
|
290720
|
+
"name",
|
|
290721
|
+
"version"
|
|
290722
|
+
],
|
|
290723
|
+
"additionalProperties": false
|
|
290649
290724
|
}
|
|
290650
290725
|
},
|
|
290651
|
-
"
|
|
290652
|
-
|
|
290653
|
-
|
|
290654
|
-
|
|
290655
|
-
|
|
290656
|
-
|
|
290657
|
-
|
|
290658
|
-
|
|
290659
|
-
|
|
290660
|
-
|
|
290661
|
-
|
|
290662
|
-
|
|
290663
|
-
|
|
290664
|
-
|
|
290665
|
-
|
|
290666
|
-
|
|
290667
|
-
|
|
290668
|
-
|
|
290669
|
-
|
|
290670
|
-
|
|
290671
|
-
|
|
290672
|
-
|
|
290673
|
-
|
|
290674
|
-
|
|
290675
|
-
|
|
290676
|
-
|
|
290677
|
-
|
|
290678
|
-
"type": "object",
|
|
290679
|
-
"properties": {
|
|
290680
|
-
"url": {
|
|
290681
|
-
"type": "string"
|
|
290726
|
+
"integrations": {
|
|
290727
|
+
"type": "object",
|
|
290728
|
+
"additionalProperties": {
|
|
290729
|
+
"type": "object",
|
|
290730
|
+
"properties": {
|
|
290731
|
+
"id": {
|
|
290732
|
+
"type": "string",
|
|
290733
|
+
"minLength": 28,
|
|
290734
|
+
"maxLength": 36
|
|
290735
|
+
},
|
|
290736
|
+
"name": {
|
|
290737
|
+
"type": "string",
|
|
290738
|
+
"maxLength": 200
|
|
290739
|
+
},
|
|
290740
|
+
"version": {
|
|
290741
|
+
"type": "string",
|
|
290742
|
+
"maxLength": 200
|
|
290743
|
+
}
|
|
290744
|
+
},
|
|
290745
|
+
"required": [
|
|
290746
|
+
"id",
|
|
290747
|
+
"name",
|
|
290748
|
+
"version"
|
|
290749
|
+
],
|
|
290750
|
+
"additionalProperties": false
|
|
290751
|
+
}
|
|
290752
|
+
}
|
|
290682
290753
|
},
|
|
290683
|
-
"
|
|
290684
|
-
"
|
|
290685
|
-
|
|
290754
|
+
"required": [
|
|
290755
|
+
"interfaces",
|
|
290756
|
+
"integrations"
|
|
290757
|
+
],
|
|
290758
|
+
"additionalProperties": false
|
|
290686
290759
|
},
|
|
290687
|
-
"
|
|
290688
|
-
"
|
|
290689
|
-
"
|
|
290690
|
-
|
|
290691
|
-
|
|
290692
|
-
|
|
290693
|
-
|
|
290694
|
-
|
|
290695
|
-
|
|
290696
|
-
|
|
290697
|
-
|
|
290698
|
-
|
|
290699
|
-
|
|
290700
|
-
|
|
290701
|
-
|
|
290702
|
-
|
|
290703
|
-
|
|
290704
|
-
|
|
290705
|
-
|
|
290706
|
-
|
|
290707
|
-
|
|
290708
|
-
|
|
290709
|
-
|
|
290710
|
-
|
|
290711
|
-
|
|
290712
|
-
|
|
290713
|
-
|
|
290714
|
-
|
|
290715
|
-
|
|
290716
|
-
|
|
290717
|
-
|
|
290718
|
-
|
|
290719
|
-
|
|
290720
|
-
|
|
290721
|
-
|
|
290760
|
+
"user": {
|
|
290761
|
+
"type": "object",
|
|
290762
|
+
"properties": {
|
|
290763
|
+
"tags": {
|
|
290764
|
+
"type": "object",
|
|
290765
|
+
"additionalProperties": {
|
|
290766
|
+
"type": "object",
|
|
290767
|
+
"properties": {
|
|
290768
|
+
"title": {
|
|
290769
|
+
"type": "string",
|
|
290770
|
+
"maxLength": 64,
|
|
290771
|
+
"description": "Title of the tag"
|
|
290772
|
+
},
|
|
290773
|
+
"description": {
|
|
290774
|
+
"type": "string",
|
|
290775
|
+
"maxLength": 256,
|
|
290776
|
+
"description": "Description of the tag"
|
|
290777
|
+
}
|
|
290778
|
+
},
|
|
290779
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
290780
|
+
"additionalProperties": false
|
|
290781
|
+
}
|
|
290782
|
+
}
|
|
290783
|
+
},
|
|
290784
|
+
"required": [
|
|
290785
|
+
"tags"
|
|
290786
|
+
],
|
|
290787
|
+
"description": "User object configuration",
|
|
290788
|
+
"additionalProperties": false
|
|
290789
|
+
},
|
|
290790
|
+
"conversation": {
|
|
290791
|
+
"type": "object",
|
|
290792
|
+
"properties": {
|
|
290793
|
+
"tags": {
|
|
290794
|
+
"type": "object",
|
|
290795
|
+
"additionalProperties": {
|
|
290796
|
+
"type": "object",
|
|
290797
|
+
"properties": {
|
|
290798
|
+
"title": {
|
|
290799
|
+
"type": "string",
|
|
290800
|
+
"maxLength": 64,
|
|
290801
|
+
"description": "Title of the tag"
|
|
290802
|
+
},
|
|
290803
|
+
"description": {
|
|
290804
|
+
"type": "string",
|
|
290805
|
+
"maxLength": 256,
|
|
290806
|
+
"description": "Description of the tag"
|
|
290807
|
+
}
|
|
290808
|
+
},
|
|
290809
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
290810
|
+
"additionalProperties": false
|
|
290811
|
+
}
|
|
290812
|
+
}
|
|
290813
|
+
},
|
|
290814
|
+
"required": [
|
|
290815
|
+
"tags"
|
|
290816
|
+
],
|
|
290817
|
+
"description": "Conversation object configuration",
|
|
290818
|
+
"additionalProperties": false
|
|
290819
|
+
},
|
|
290820
|
+
"title": {
|
|
290821
|
+
"type": "string",
|
|
290822
|
+
"minLength": 1,
|
|
290823
|
+
"maxLength": 64,
|
|
290824
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
290825
|
+
},
|
|
290826
|
+
"description": {
|
|
290827
|
+
"type": "string",
|
|
290828
|
+
"maxLength": 256,
|
|
290829
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
290830
|
+
},
|
|
290831
|
+
"iconUrl": {
|
|
290832
|
+
"type": "string",
|
|
290833
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
290834
|
+
},
|
|
290835
|
+
"readmeUrl": {
|
|
290836
|
+
"type": "string",
|
|
290837
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
290838
|
+
},
|
|
290839
|
+
"public": {
|
|
290840
|
+
"type": "boolean",
|
|
290841
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
290842
|
+
}
|
|
290843
|
+
},
|
|
290844
|
+
"required": [
|
|
290845
|
+
"id",
|
|
290846
|
+
"name",
|
|
290847
|
+
"version",
|
|
290848
|
+
"createdAt",
|
|
290849
|
+
"updatedAt",
|
|
290850
|
+
"configuration",
|
|
290851
|
+
"states",
|
|
290852
|
+
"events",
|
|
290853
|
+
"actions",
|
|
290854
|
+
"dependencies",
|
|
290855
|
+
"user",
|
|
290856
|
+
"conversation",
|
|
290857
|
+
"title",
|
|
290858
|
+
"description",
|
|
290859
|
+
"iconUrl",
|
|
290860
|
+
"readmeUrl",
|
|
290861
|
+
"public"
|
|
290862
|
+
],
|
|
290863
|
+
"additionalProperties": false
|
|
290864
|
+
}
|
|
290865
|
+
},
|
|
290866
|
+
"required": [
|
|
290867
|
+
"plugin"
|
|
290868
|
+
],
|
|
290869
|
+
"title": "getPublicPluginByIdResponse",
|
|
290870
|
+
"additionalProperties": false
|
|
290871
|
+
}
|
|
290872
|
+
}
|
|
290873
|
+
},
|
|
290874
|
+
"getPublicPlugin": {
|
|
290875
|
+
"name": "getPublicPlugin",
|
|
290876
|
+
"description": "Get public plugin by name and version",
|
|
290877
|
+
"method": "get",
|
|
290878
|
+
"section": "hub",
|
|
290879
|
+
"path": "/v1/admin/hub/plugins/{name}/{version}",
|
|
290880
|
+
"disableDefaultParameters": {
|
|
290881
|
+
"x-workspace-id": true
|
|
290882
|
+
},
|
|
290883
|
+
"parameters": {
|
|
290884
|
+
"name": {
|
|
290885
|
+
"type": "string",
|
|
290886
|
+
"description": "Plugin Name",
|
|
290887
|
+
"in": "path"
|
|
290888
|
+
},
|
|
290889
|
+
"version": {
|
|
290890
|
+
"type": "string",
|
|
290891
|
+
"description": "Plugin version.",
|
|
290892
|
+
"in": "path"
|
|
290893
|
+
}
|
|
290894
|
+
},
|
|
290895
|
+
"response": {
|
|
290896
|
+
"description": "Success",
|
|
290897
|
+
"schema": {
|
|
290898
|
+
"type": "object",
|
|
290899
|
+
"properties": {
|
|
290900
|
+
"plugin": {
|
|
290901
|
+
"type": "object",
|
|
290902
|
+
"properties": {
|
|
290903
|
+
"id": {
|
|
290904
|
+
"type": "string",
|
|
290905
|
+
"minLength": 28,
|
|
290906
|
+
"maxLength": 36,
|
|
290907
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
290908
|
+
},
|
|
290909
|
+
"name": {
|
|
290910
|
+
"type": "string",
|
|
290911
|
+
"maxLength": 200,
|
|
290912
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
290913
|
+
},
|
|
290914
|
+
"version": {
|
|
290915
|
+
"type": "string",
|
|
290916
|
+
"maxLength": 200,
|
|
290917
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
290918
|
+
},
|
|
290919
|
+
"createdAt": {
|
|
290920
|
+
"type": "string",
|
|
290921
|
+
"format": "date-time",
|
|
290922
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
290923
|
+
},
|
|
290924
|
+
"updatedAt": {
|
|
290925
|
+
"type": "string",
|
|
290926
|
+
"format": "date-time",
|
|
290927
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
290928
|
+
},
|
|
290929
|
+
"configuration": {
|
|
290930
|
+
"type": "object",
|
|
290931
|
+
"properties": {
|
|
290932
|
+
"title": {
|
|
290933
|
+
"type": "string",
|
|
290934
|
+
"maxLength": 64,
|
|
290935
|
+
"description": "Title of the configuration"
|
|
290936
|
+
},
|
|
290937
|
+
"description": {
|
|
290938
|
+
"type": "string",
|
|
290939
|
+
"maxLength": 256,
|
|
290940
|
+
"description": "Description of the configuration"
|
|
290941
|
+
},
|
|
290942
|
+
"schema": {
|
|
290943
|
+
"type": "object",
|
|
290944
|
+
"additionalProperties": true,
|
|
290945
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
290946
|
+
}
|
|
290947
|
+
},
|
|
290948
|
+
"required": [
|
|
290949
|
+
"schema"
|
|
290950
|
+
],
|
|
290951
|
+
"description": "Configuration definition",
|
|
290952
|
+
"additionalProperties": false
|
|
290953
|
+
},
|
|
290954
|
+
"states": {
|
|
290955
|
+
"type": "object",
|
|
290956
|
+
"additionalProperties": {
|
|
290957
|
+
"type": "object",
|
|
290958
|
+
"properties": {
|
|
290959
|
+
"type": {
|
|
290960
|
+
"type": "string",
|
|
290961
|
+
"enum": [
|
|
290962
|
+
"conversation",
|
|
290963
|
+
"user",
|
|
290964
|
+
"bot",
|
|
290965
|
+
"task"
|
|
290966
|
+
],
|
|
290967
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
290968
|
+
},
|
|
290969
|
+
"schema": {
|
|
290970
|
+
"type": "object",
|
|
290971
|
+
"additionalProperties": true,
|
|
290972
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
290973
|
+
},
|
|
290974
|
+
"expiry": {
|
|
290975
|
+
"type": "number",
|
|
290976
|
+
"minimum": 1,
|
|
290977
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
290978
|
+
}
|
|
290979
|
+
},
|
|
290980
|
+
"required": [
|
|
290981
|
+
"type",
|
|
290982
|
+
"schema"
|
|
290983
|
+
],
|
|
290984
|
+
"additionalProperties": false
|
|
290985
|
+
}
|
|
290986
|
+
},
|
|
290987
|
+
"events": {
|
|
290988
|
+
"type": "object",
|
|
290989
|
+
"additionalProperties": {
|
|
290990
|
+
"type": "object",
|
|
290991
|
+
"properties": {
|
|
290992
|
+
"title": {
|
|
290993
|
+
"type": "string",
|
|
290994
|
+
"maxLength": 64,
|
|
290995
|
+
"description": "Title of the event"
|
|
290996
|
+
},
|
|
290997
|
+
"description": {
|
|
290998
|
+
"type": "string",
|
|
290999
|
+
"maxLength": 256,
|
|
291000
|
+
"description": "Description of the event"
|
|
291001
|
+
},
|
|
291002
|
+
"schema": {
|
|
291003
|
+
"type": "object",
|
|
291004
|
+
"additionalProperties": true
|
|
291005
|
+
}
|
|
291006
|
+
},
|
|
291007
|
+
"required": [
|
|
291008
|
+
"schema"
|
|
291009
|
+
],
|
|
291010
|
+
"description": "Event Definition",
|
|
291011
|
+
"additionalProperties": false
|
|
291012
|
+
}
|
|
291013
|
+
},
|
|
291014
|
+
"actions": {
|
|
291015
|
+
"type": "object",
|
|
291016
|
+
"additionalProperties": {
|
|
291017
|
+
"type": "object",
|
|
291018
|
+
"properties": {
|
|
291019
|
+
"title": {
|
|
291020
|
+
"type": "string",
|
|
291021
|
+
"maxLength": 64,
|
|
291022
|
+
"description": "Title of the action"
|
|
291023
|
+
},
|
|
291024
|
+
"description": {
|
|
291025
|
+
"type": "string",
|
|
291026
|
+
"maxLength": 256,
|
|
291027
|
+
"description": "Description of the action"
|
|
291028
|
+
},
|
|
291029
|
+
"billable": {
|
|
291030
|
+
"type": "boolean"
|
|
291031
|
+
},
|
|
291032
|
+
"cacheable": {
|
|
291033
|
+
"type": "boolean"
|
|
291034
|
+
},
|
|
291035
|
+
"input": {
|
|
291036
|
+
"type": "object",
|
|
291037
|
+
"properties": {
|
|
291038
|
+
"schema": {
|
|
291039
|
+
"type": "object",
|
|
291040
|
+
"additionalProperties": true
|
|
291041
|
+
}
|
|
291042
|
+
},
|
|
291043
|
+
"required": [
|
|
291044
|
+
"schema"
|
|
291045
|
+
],
|
|
291046
|
+
"additionalProperties": false
|
|
291047
|
+
},
|
|
291048
|
+
"output": {
|
|
291049
|
+
"type": "object",
|
|
291050
|
+
"properties": {
|
|
291051
|
+
"schema": {
|
|
291052
|
+
"type": "object",
|
|
291053
|
+
"additionalProperties": true
|
|
291054
|
+
}
|
|
291055
|
+
},
|
|
291056
|
+
"required": [
|
|
291057
|
+
"schema"
|
|
291058
|
+
],
|
|
291059
|
+
"additionalProperties": false
|
|
291060
|
+
}
|
|
291061
|
+
},
|
|
291062
|
+
"required": [
|
|
291063
|
+
"input",
|
|
291064
|
+
"output"
|
|
291065
|
+
],
|
|
291066
|
+
"description": "Action definition",
|
|
291067
|
+
"additionalProperties": false
|
|
291068
|
+
}
|
|
291069
|
+
},
|
|
291070
|
+
"dependencies": {
|
|
291071
|
+
"type": "object",
|
|
291072
|
+
"properties": {
|
|
291073
|
+
"interfaces": {
|
|
291074
|
+
"type": "object",
|
|
291075
|
+
"additionalProperties": {
|
|
291076
|
+
"type": "object",
|
|
291077
|
+
"properties": {
|
|
291078
|
+
"id": {
|
|
291079
|
+
"type": "string",
|
|
291080
|
+
"minLength": 28,
|
|
291081
|
+
"maxLength": 36
|
|
291082
|
+
},
|
|
291083
|
+
"name": {
|
|
291084
|
+
"type": "string",
|
|
291085
|
+
"maxLength": 200
|
|
291086
|
+
},
|
|
291087
|
+
"version": {
|
|
291088
|
+
"type": "string",
|
|
291089
|
+
"maxLength": 200
|
|
291090
|
+
}
|
|
291091
|
+
},
|
|
291092
|
+
"required": [
|
|
291093
|
+
"id",
|
|
291094
|
+
"name",
|
|
291095
|
+
"version"
|
|
291096
|
+
],
|
|
291097
|
+
"additionalProperties": false
|
|
291098
|
+
}
|
|
291099
|
+
},
|
|
291100
|
+
"integrations": {
|
|
291101
|
+
"type": "object",
|
|
291102
|
+
"additionalProperties": {
|
|
291103
|
+
"type": "object",
|
|
291104
|
+
"properties": {
|
|
291105
|
+
"id": {
|
|
291106
|
+
"type": "string",
|
|
291107
|
+
"minLength": 28,
|
|
291108
|
+
"maxLength": 36
|
|
291109
|
+
},
|
|
291110
|
+
"name": {
|
|
291111
|
+
"type": "string",
|
|
291112
|
+
"maxLength": 200
|
|
291113
|
+
},
|
|
291114
|
+
"version": {
|
|
291115
|
+
"type": "string",
|
|
291116
|
+
"maxLength": 200
|
|
291117
|
+
}
|
|
291118
|
+
},
|
|
291119
|
+
"required": [
|
|
291120
|
+
"id",
|
|
291121
|
+
"name",
|
|
291122
|
+
"version"
|
|
291123
|
+
],
|
|
291124
|
+
"additionalProperties": false
|
|
291125
|
+
}
|
|
291126
|
+
}
|
|
291127
|
+
},
|
|
291128
|
+
"required": [
|
|
291129
|
+
"interfaces",
|
|
291130
|
+
"integrations"
|
|
291131
|
+
],
|
|
291132
|
+
"additionalProperties": false
|
|
291133
|
+
},
|
|
291134
|
+
"user": {
|
|
291135
|
+
"type": "object",
|
|
291136
|
+
"properties": {
|
|
291137
|
+
"tags": {
|
|
291138
|
+
"type": "object",
|
|
291139
|
+
"additionalProperties": {
|
|
291140
|
+
"type": "object",
|
|
291141
|
+
"properties": {
|
|
291142
|
+
"title": {
|
|
291143
|
+
"type": "string",
|
|
291144
|
+
"maxLength": 64,
|
|
291145
|
+
"description": "Title of the tag"
|
|
291146
|
+
},
|
|
291147
|
+
"description": {
|
|
291148
|
+
"type": "string",
|
|
291149
|
+
"maxLength": 256,
|
|
291150
|
+
"description": "Description of the tag"
|
|
291151
|
+
}
|
|
291152
|
+
},
|
|
291153
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
291154
|
+
"additionalProperties": false
|
|
291155
|
+
}
|
|
291156
|
+
}
|
|
291157
|
+
},
|
|
291158
|
+
"required": [
|
|
291159
|
+
"tags"
|
|
291160
|
+
],
|
|
291161
|
+
"description": "User object configuration",
|
|
291162
|
+
"additionalProperties": false
|
|
291163
|
+
},
|
|
291164
|
+
"conversation": {
|
|
291165
|
+
"type": "object",
|
|
291166
|
+
"properties": {
|
|
291167
|
+
"tags": {
|
|
291168
|
+
"type": "object",
|
|
291169
|
+
"additionalProperties": {
|
|
291170
|
+
"type": "object",
|
|
291171
|
+
"properties": {
|
|
291172
|
+
"title": {
|
|
291173
|
+
"type": "string",
|
|
291174
|
+
"maxLength": 64,
|
|
291175
|
+
"description": "Title of the tag"
|
|
291176
|
+
},
|
|
291177
|
+
"description": {
|
|
291178
|
+
"type": "string",
|
|
291179
|
+
"maxLength": 256,
|
|
291180
|
+
"description": "Description of the tag"
|
|
291181
|
+
}
|
|
291182
|
+
},
|
|
291183
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
291184
|
+
"additionalProperties": false
|
|
291185
|
+
}
|
|
291186
|
+
}
|
|
291187
|
+
},
|
|
291188
|
+
"required": [
|
|
291189
|
+
"tags"
|
|
291190
|
+
],
|
|
291191
|
+
"description": "Conversation object configuration",
|
|
291192
|
+
"additionalProperties": false
|
|
291193
|
+
},
|
|
291194
|
+
"title": {
|
|
291195
|
+
"type": "string",
|
|
291196
|
+
"minLength": 1,
|
|
291197
|
+
"maxLength": 64,
|
|
291198
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
291199
|
+
},
|
|
291200
|
+
"description": {
|
|
291201
|
+
"type": "string",
|
|
291202
|
+
"maxLength": 256,
|
|
291203
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
291204
|
+
},
|
|
291205
|
+
"iconUrl": {
|
|
291206
|
+
"type": "string",
|
|
291207
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
291208
|
+
},
|
|
291209
|
+
"readmeUrl": {
|
|
291210
|
+
"type": "string",
|
|
291211
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
291212
|
+
},
|
|
291213
|
+
"public": {
|
|
291214
|
+
"type": "boolean",
|
|
291215
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
291216
|
+
}
|
|
291217
|
+
},
|
|
291218
|
+
"required": [
|
|
291219
|
+
"id",
|
|
291220
|
+
"name",
|
|
291221
|
+
"version",
|
|
291222
|
+
"createdAt",
|
|
291223
|
+
"updatedAt",
|
|
291224
|
+
"configuration",
|
|
291225
|
+
"states",
|
|
291226
|
+
"events",
|
|
291227
|
+
"actions",
|
|
291228
|
+
"dependencies",
|
|
291229
|
+
"user",
|
|
291230
|
+
"conversation",
|
|
291231
|
+
"title",
|
|
291232
|
+
"description",
|
|
291233
|
+
"iconUrl",
|
|
291234
|
+
"readmeUrl",
|
|
291235
|
+
"public"
|
|
291236
|
+
],
|
|
291237
|
+
"additionalProperties": false
|
|
291238
|
+
}
|
|
291239
|
+
},
|
|
291240
|
+
"required": [
|
|
291241
|
+
"plugin"
|
|
291242
|
+
],
|
|
291243
|
+
"title": "getPublicPluginResponse",
|
|
291244
|
+
"additionalProperties": false
|
|
291245
|
+
}
|
|
291246
|
+
}
|
|
291247
|
+
},
|
|
291248
|
+
"getPublicPluginCode": {
|
|
291249
|
+
"name": "getPublicPluginCode",
|
|
291250
|
+
"description": "Get public plugin code",
|
|
291251
|
+
"method": "get",
|
|
291252
|
+
"path": "/v1/admin/hub/{id}/code/{platform}",
|
|
291253
|
+
"disableDefaultParameters": {
|
|
291254
|
+
"x-workspace-id": true
|
|
291255
|
+
},
|
|
291256
|
+
"section": "hub",
|
|
291257
|
+
"parameters": {
|
|
291258
|
+
"id": {
|
|
291259
|
+
"in": "path",
|
|
291260
|
+
"type": "string",
|
|
291261
|
+
"description": "Plugin id"
|
|
291262
|
+
},
|
|
291263
|
+
"platform": {
|
|
291264
|
+
"in": "path",
|
|
291265
|
+
"type": "string",
|
|
291266
|
+
"enum": [
|
|
291267
|
+
"node",
|
|
291268
|
+
"browser"
|
|
291269
|
+
],
|
|
291270
|
+
"description": "Platform"
|
|
291271
|
+
}
|
|
291272
|
+
},
|
|
291273
|
+
"response": {
|
|
291274
|
+
"description": "Plugin code",
|
|
291275
|
+
"schema": {
|
|
291276
|
+
"type": "object",
|
|
291277
|
+
"properties": {
|
|
291278
|
+
"code": {
|
|
291279
|
+
"type": "string"
|
|
291280
|
+
}
|
|
291281
|
+
},
|
|
291282
|
+
"required": [
|
|
291283
|
+
"code"
|
|
291284
|
+
],
|
|
291285
|
+
"title": "getPublicPluginCodeResponse",
|
|
291286
|
+
"additionalProperties": false
|
|
291287
|
+
}
|
|
291288
|
+
}
|
|
291289
|
+
},
|
|
291290
|
+
"createBot": {
|
|
291291
|
+
"name": "createBot",
|
|
291292
|
+
"description": "Create bot",
|
|
291293
|
+
"method": "post",
|
|
291294
|
+
"section": "bot",
|
|
291295
|
+
"path": "/v1/admin/bots",
|
|
291296
|
+
"requestBody": {
|
|
291297
|
+
"description": "Bot metadata",
|
|
291298
|
+
"schema": {
|
|
291299
|
+
"type": "object",
|
|
291300
|
+
"properties": {
|
|
291301
|
+
"states": {
|
|
291302
|
+
"type": "object",
|
|
291303
|
+
"additionalProperties": {
|
|
291304
|
+
"type": "object",
|
|
291305
|
+
"properties": {
|
|
291306
|
+
"type": {
|
|
291307
|
+
"type": "string",
|
|
291308
|
+
"enum": [
|
|
291309
|
+
"conversation",
|
|
291310
|
+
"user",
|
|
291311
|
+
"bot",
|
|
291312
|
+
"task"
|
|
291313
|
+
],
|
|
291314
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
291315
|
+
},
|
|
291316
|
+
"schema": {
|
|
291317
|
+
"type": "object",
|
|
291318
|
+
"additionalProperties": true,
|
|
291319
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
291320
|
+
},
|
|
291321
|
+
"expiry": {
|
|
291322
|
+
"type": "number",
|
|
291323
|
+
"minimum": 1,
|
|
291324
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
291325
|
+
}
|
|
291326
|
+
},
|
|
291327
|
+
"required": [
|
|
291328
|
+
"type",
|
|
291329
|
+
"schema"
|
|
291330
|
+
],
|
|
291331
|
+
"additionalProperties": false
|
|
291332
|
+
},
|
|
291333
|
+
"description": "A mapping of states to their definition"
|
|
291334
|
+
},
|
|
291335
|
+
"events": {
|
|
291336
|
+
"type": "object",
|
|
291337
|
+
"additionalProperties": {
|
|
291338
|
+
"type": "object",
|
|
291339
|
+
"properties": {
|
|
291340
|
+
"title": {
|
|
291341
|
+
"type": "string",
|
|
291342
|
+
"maxLength": 64,
|
|
291343
|
+
"description": "Title of the event"
|
|
291344
|
+
},
|
|
291345
|
+
"description": {
|
|
291346
|
+
"type": "string",
|
|
291347
|
+
"maxLength": 256,
|
|
291348
|
+
"description": "Description of the event"
|
|
291349
|
+
},
|
|
291350
|
+
"schema": {
|
|
291351
|
+
"type": "object",
|
|
291352
|
+
"additionalProperties": true
|
|
291353
|
+
}
|
|
291354
|
+
},
|
|
291355
|
+
"required": [
|
|
291356
|
+
"schema"
|
|
291357
|
+
],
|
|
291358
|
+
"description": "Event Definition",
|
|
291359
|
+
"additionalProperties": false
|
|
291360
|
+
},
|
|
291361
|
+
"description": "Events definition"
|
|
291362
|
+
},
|
|
291363
|
+
"recurringEvents": {
|
|
291364
|
+
"type": "object",
|
|
291365
|
+
"additionalProperties": {
|
|
291366
|
+
"type": "object",
|
|
291367
|
+
"properties": {
|
|
291368
|
+
"schedule": {
|
|
291369
|
+
"type": "object",
|
|
291370
|
+
"properties": {
|
|
291371
|
+
"cron": {
|
|
291372
|
+
"type": "string",
|
|
291373
|
+
"maxLength": 200
|
|
291374
|
+
}
|
|
291375
|
+
},
|
|
291376
|
+
"required": [
|
|
291377
|
+
"cron"
|
|
291378
|
+
],
|
|
291379
|
+
"additionalProperties": false
|
|
291380
|
+
},
|
|
291381
|
+
"type": {
|
|
291382
|
+
"type": "string",
|
|
291383
|
+
"maxLength": 200
|
|
291384
|
+
},
|
|
291385
|
+
"payload": {
|
|
291386
|
+
"type": "object",
|
|
291387
|
+
"additionalProperties": true
|
|
291388
|
+
}
|
|
291389
|
+
},
|
|
291390
|
+
"required": [
|
|
291391
|
+
"schedule",
|
|
291392
|
+
"type",
|
|
291393
|
+
"payload"
|
|
291394
|
+
],
|
|
291395
|
+
"additionalProperties": false
|
|
291396
|
+
}
|
|
291397
|
+
},
|
|
291398
|
+
"subscriptions": {
|
|
291399
|
+
"type": "object",
|
|
291400
|
+
"properties": {
|
|
291401
|
+
"events": {
|
|
291402
|
+
"type": "object",
|
|
291403
|
+
"additionalProperties": {
|
|
291404
|
+
"type": "object",
|
|
291405
|
+
"additionalProperties": false
|
|
291406
|
+
},
|
|
291407
|
+
"nullable": true,
|
|
291408
|
+
"description": 'Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.'
|
|
291409
|
+
}
|
|
291410
|
+
},
|
|
291411
|
+
"required": [
|
|
291412
|
+
"events"
|
|
291413
|
+
],
|
|
291414
|
+
"description": "Subscriptions of the bot",
|
|
291415
|
+
"additionalProperties": false
|
|
291416
|
+
},
|
|
291417
|
+
"actions": {
|
|
291418
|
+
"type": "object",
|
|
291419
|
+
"additionalProperties": {
|
|
291420
|
+
"type": "object",
|
|
291421
|
+
"properties": {
|
|
291422
|
+
"title": {
|
|
291423
|
+
"type": "string",
|
|
291424
|
+
"maxLength": 64,
|
|
291425
|
+
"description": "Title of the action"
|
|
291426
|
+
},
|
|
291427
|
+
"description": {
|
|
291428
|
+
"type": "string",
|
|
291429
|
+
"maxLength": 256,
|
|
291430
|
+
"description": "Description of the action"
|
|
291431
|
+
},
|
|
291432
|
+
"billable": {
|
|
291433
|
+
"type": "boolean"
|
|
291434
|
+
},
|
|
291435
|
+
"cacheable": {
|
|
291436
|
+
"type": "boolean"
|
|
291437
|
+
},
|
|
291438
|
+
"input": {
|
|
291439
|
+
"type": "object",
|
|
291440
|
+
"properties": {
|
|
291441
|
+
"schema": {
|
|
291442
|
+
"type": "object",
|
|
291443
|
+
"additionalProperties": true
|
|
291444
|
+
}
|
|
291445
|
+
},
|
|
291446
|
+
"required": [
|
|
291447
|
+
"schema"
|
|
291448
|
+
],
|
|
291449
|
+
"additionalProperties": false
|
|
291450
|
+
},
|
|
291451
|
+
"output": {
|
|
291452
|
+
"type": "object",
|
|
291453
|
+
"properties": {
|
|
291454
|
+
"schema": {
|
|
291455
|
+
"type": "object",
|
|
291456
|
+
"additionalProperties": true
|
|
291457
|
+
}
|
|
291458
|
+
},
|
|
291459
|
+
"required": [
|
|
291460
|
+
"schema"
|
|
291461
|
+
],
|
|
291462
|
+
"additionalProperties": false
|
|
291463
|
+
}
|
|
291464
|
+
},
|
|
291465
|
+
"required": [
|
|
291466
|
+
"input",
|
|
291467
|
+
"output"
|
|
291468
|
+
],
|
|
291469
|
+
"description": "Action definition",
|
|
291470
|
+
"additionalProperties": false
|
|
291471
|
+
},
|
|
291472
|
+
"description": "Actions definition"
|
|
291473
|
+
},
|
|
291474
|
+
"configuration": {
|
|
291475
|
+
"type": "object",
|
|
291476
|
+
"properties": {
|
|
291477
|
+
"data": {
|
|
291478
|
+
"type": "object",
|
|
291479
|
+
"additionalProperties": true,
|
|
291480
|
+
"description": "Configuration data"
|
|
291481
|
+
},
|
|
291482
|
+
"schema": {
|
|
291483
|
+
"type": "object",
|
|
291484
|
+
"additionalProperties": true,
|
|
291485
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
291486
|
+
}
|
|
291487
|
+
},
|
|
291488
|
+
"additionalProperties": false
|
|
291489
|
+
},
|
|
291490
|
+
"user": {
|
|
291491
|
+
"type": "object",
|
|
291492
|
+
"properties": {
|
|
291493
|
+
"tags": {
|
|
291494
|
+
"type": "object",
|
|
291495
|
+
"additionalProperties": {
|
|
291496
|
+
"type": "object",
|
|
291497
|
+
"properties": {
|
|
291498
|
+
"title": {
|
|
291499
|
+
"type": "string",
|
|
291500
|
+
"maxLength": 64,
|
|
291501
|
+
"description": "Title of the tag"
|
|
291502
|
+
},
|
|
291503
|
+
"description": {
|
|
291504
|
+
"type": "string",
|
|
291505
|
+
"maxLength": 256,
|
|
291506
|
+
"description": "Description of the tag"
|
|
291507
|
+
}
|
|
291508
|
+
},
|
|
291509
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
291510
|
+
"additionalProperties": false
|
|
291511
|
+
}
|
|
291512
|
+
}
|
|
291513
|
+
},
|
|
291514
|
+
"additionalProperties": false
|
|
291515
|
+
},
|
|
291516
|
+
"conversation": {
|
|
291517
|
+
"type": "object",
|
|
291518
|
+
"properties": {
|
|
291519
|
+
"tags": {
|
|
291520
|
+
"type": "object",
|
|
291521
|
+
"additionalProperties": {
|
|
291522
|
+
"type": "object",
|
|
291523
|
+
"properties": {
|
|
291524
|
+
"title": {
|
|
291525
|
+
"type": "string",
|
|
291526
|
+
"maxLength": 64,
|
|
291527
|
+
"description": "Title of the tag"
|
|
291528
|
+
},
|
|
291529
|
+
"description": {
|
|
291530
|
+
"type": "string",
|
|
291531
|
+
"maxLength": 256,
|
|
291532
|
+
"description": "Description of the tag"
|
|
291533
|
+
}
|
|
291534
|
+
},
|
|
291535
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
291536
|
+
"additionalProperties": false
|
|
291537
|
+
}
|
|
291538
|
+
}
|
|
291539
|
+
},
|
|
291540
|
+
"additionalProperties": false
|
|
291541
|
+
},
|
|
291542
|
+
"message": {
|
|
291543
|
+
"type": "object",
|
|
291544
|
+
"properties": {
|
|
291545
|
+
"tags": {
|
|
291546
|
+
"type": "object",
|
|
291547
|
+
"additionalProperties": {
|
|
291548
|
+
"type": "object",
|
|
291549
|
+
"properties": {
|
|
291550
|
+
"title": {
|
|
291551
|
+
"type": "string",
|
|
291552
|
+
"maxLength": 64,
|
|
291553
|
+
"description": "Title of the tag"
|
|
291554
|
+
},
|
|
291555
|
+
"description": {
|
|
291556
|
+
"type": "string",
|
|
291557
|
+
"maxLength": 256,
|
|
291558
|
+
"description": "Description of the tag"
|
|
291559
|
+
}
|
|
291560
|
+
},
|
|
291561
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
291562
|
+
"additionalProperties": false
|
|
291563
|
+
}
|
|
291564
|
+
}
|
|
291565
|
+
},
|
|
291566
|
+
"additionalProperties": false
|
|
291567
|
+
},
|
|
291568
|
+
"tags": {
|
|
291569
|
+
"type": "object",
|
|
291570
|
+
"additionalProperties": {
|
|
291571
|
+
"type": "string",
|
|
291572
|
+
"maxLength": 500
|
|
291573
|
+
},
|
|
291574
|
+
"description": "Tags of the [Bot](#schema_bot)"
|
|
291575
|
+
},
|
|
291576
|
+
"code": {
|
|
291577
|
+
"type": "string",
|
|
291578
|
+
"description": "JavaScript code of the bot"
|
|
291579
|
+
},
|
|
291580
|
+
"name": {
|
|
291581
|
+
"type": "string",
|
|
291582
|
+
"minLength": 1,
|
|
291583
|
+
"description": "Optional name for the bot, if not provided will be auto-generated"
|
|
291584
|
+
},
|
|
291585
|
+
"medias": {
|
|
291586
|
+
"type": "array",
|
|
291587
|
+
"items": {
|
|
291588
|
+
"type": "object",
|
|
291589
|
+
"properties": {
|
|
291590
|
+
"url": {
|
|
291591
|
+
"type": "string"
|
|
291592
|
+
},
|
|
291593
|
+
"name": {
|
|
291594
|
+
"type": "string"
|
|
291595
|
+
}
|
|
291596
|
+
},
|
|
291597
|
+
"required": [
|
|
291598
|
+
"url",
|
|
291599
|
+
"name"
|
|
291600
|
+
]
|
|
291601
|
+
},
|
|
291602
|
+
"description": "Media files associated with the [Bot](#schema_bot)"
|
|
291603
|
+
},
|
|
291604
|
+
"url": {
|
|
291605
|
+
"type": "string",
|
|
291606
|
+
"description": "URL of the [Bot](#schema_bot); Only available for dev bots"
|
|
291607
|
+
},
|
|
291608
|
+
"dev": {
|
|
291609
|
+
"type": "boolean",
|
|
291610
|
+
"description": "Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations"
|
|
291611
|
+
}
|
|
291612
|
+
},
|
|
291613
|
+
"title": "createBotBody",
|
|
291614
|
+
"additionalProperties": false
|
|
291615
|
+
}
|
|
291616
|
+
},
|
|
291617
|
+
"response": {
|
|
291618
|
+
"description": "Success",
|
|
291619
|
+
"schema": {
|
|
291620
|
+
"type": "object",
|
|
291621
|
+
"properties": {
|
|
291622
|
+
"bot": {
|
|
291623
|
+
"$ref": "#/components/schemas/Bot"
|
|
291624
|
+
}
|
|
291625
|
+
},
|
|
291626
|
+
"required": [
|
|
291627
|
+
"bot"
|
|
291628
|
+
],
|
|
291629
|
+
"title": "createBotResponse",
|
|
291630
|
+
"additionalProperties": false
|
|
291631
|
+
}
|
|
290722
291632
|
},
|
|
290723
291633
|
"parameters": {}
|
|
290724
291634
|
},
|
|
@@ -294831,7 +295741,7 @@ var state2 = {
|
|
|
294831
295741
|
},
|
|
294832
295742
|
"public": {
|
|
294833
295743
|
"type": "boolean",
|
|
294834
|
-
"description": "
|
|
295744
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
294835
295745
|
},
|
|
294836
295746
|
"layers": {
|
|
294837
295747
|
"type": "array",
|
|
@@ -295397,7 +296307,7 @@ var state2 = {
|
|
|
295397
296307
|
},
|
|
295398
296308
|
"public": {
|
|
295399
296309
|
"type": "boolean",
|
|
295400
|
-
"description": "
|
|
296310
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
295401
296311
|
},
|
|
295402
296312
|
"layers": {
|
|
295403
296313
|
"type": "array",
|
|
@@ -295977,7 +296887,7 @@ var state2 = {
|
|
|
295977
296887
|
},
|
|
295978
296888
|
"public": {
|
|
295979
296889
|
"type": "boolean",
|
|
295980
|
-
"description": "
|
|
296890
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
295981
296891
|
},
|
|
295982
296892
|
"layers": {
|
|
295983
296893
|
"type": "array",
|
|
@@ -296560,7 +297470,7 @@ var state2 = {
|
|
|
296560
297470
|
},
|
|
296561
297471
|
"public": {
|
|
296562
297472
|
"type": "boolean",
|
|
296563
|
-
"description": "
|
|
297473
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
296564
297474
|
},
|
|
296565
297475
|
"layers": {
|
|
296566
297476
|
"type": "array",
|
|
@@ -296732,7 +297642,7 @@ var state2 = {
|
|
|
296732
297642
|
},
|
|
296733
297643
|
"public": {
|
|
296734
297644
|
"type": "boolean",
|
|
296735
|
-
"description": "
|
|
297645
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
296736
297646
|
},
|
|
296737
297647
|
"verificationStatus": {
|
|
296738
297648
|
"type": "string",
|
|
@@ -297939,6 +298849,10 @@ var state2 = {
|
|
|
297939
298849
|
"type": "string",
|
|
297940
298850
|
"maxLength": 256,
|
|
297941
298851
|
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
298852
|
+
},
|
|
298853
|
+
"public": {
|
|
298854
|
+
"type": "boolean",
|
|
298855
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
297942
298856
|
}
|
|
297943
298857
|
},
|
|
297944
298858
|
"required": [
|
|
@@ -298325,6 +299239,10 @@ var state2 = {
|
|
|
298325
299239
|
"type": "string",
|
|
298326
299240
|
"maxLength": 256,
|
|
298327
299241
|
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
299242
|
+
},
|
|
299243
|
+
"public": {
|
|
299244
|
+
"type": "boolean",
|
|
299245
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
298328
299246
|
}
|
|
298329
299247
|
},
|
|
298330
299248
|
"title": "updatePluginBody",
|
|
@@ -298387,6 +299305,11 @@ var state2 = {
|
|
|
298387
299305
|
"in": "query",
|
|
298388
299306
|
"type": "string",
|
|
298389
299307
|
"description": "Filter all versions of a plugin by name"
|
|
299308
|
+
},
|
|
299309
|
+
"version": {
|
|
299310
|
+
"in": "query",
|
|
299311
|
+
"type": "string",
|
|
299312
|
+
"description": "Filter a plugin by name and version"
|
|
298390
299313
|
}
|
|
298391
299314
|
},
|
|
298392
299315
|
"response": {
|
|
@@ -298443,6 +299366,10 @@ var state2 = {
|
|
|
298443
299366
|
"readmeUrl": {
|
|
298444
299367
|
"type": "string",
|
|
298445
299368
|
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
299369
|
+
},
|
|
299370
|
+
"public": {
|
|
299371
|
+
"type": "boolean",
|
|
299372
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
298446
299373
|
}
|
|
298447
299374
|
},
|
|
298448
299375
|
"required": [
|
|
@@ -298454,7 +299381,8 @@ var state2 = {
|
|
|
298454
299381
|
"title",
|
|
298455
299382
|
"description",
|
|
298456
299383
|
"iconUrl",
|
|
298457
|
-
"readmeUrl"
|
|
299384
|
+
"readmeUrl",
|
|
299385
|
+
"public"
|
|
298458
299386
|
]
|
|
298459
299387
|
}
|
|
298460
299388
|
},
|
|
@@ -299014,7 +299942,7 @@ var state2 = {
|
|
|
299014
299942
|
"title": "Botpress API",
|
|
299015
299943
|
"description": "API for Botpress Cloud",
|
|
299016
299944
|
"server": "https://api.botpress.cloud",
|
|
299017
|
-
"version": "1.
|
|
299945
|
+
"version": "1.5.0",
|
|
299018
299946
|
"prefix": "v1"
|
|
299019
299947
|
},
|
|
299020
299948
|
"errors": [
|
|
@@ -299183,6 +300111,10 @@ var state2 = {
|
|
|
299183
300111
|
"listPublicIntegrationsResponse": true,
|
|
299184
300112
|
"getPublicIntegrationByIdResponse": true,
|
|
299185
300113
|
"getPublicIntegrationResponse": true,
|
|
300114
|
+
"listPublicPluginsResponse": true,
|
|
300115
|
+
"getPublicPluginByIdResponse": true,
|
|
300116
|
+
"getPublicPluginResponse": true,
|
|
300117
|
+
"getPublicPluginCodeResponse": true,
|
|
299186
300118
|
"createBotResponse": true,
|
|
299187
300119
|
"updateBotResponse": true,
|
|
299188
300120
|
"transferBotResponse": true,
|
|
@@ -299401,7 +300333,7 @@ var state2 = {
|
|
|
299401
300333
|
},
|
|
299402
300334
|
"public": {
|
|
299403
300335
|
"type": "boolean",
|
|
299404
|
-
"description": "
|
|
300336
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
299405
300337
|
},
|
|
299406
300338
|
"verificationStatus": {
|
|
299407
300339
|
"type": "string",
|
|
@@ -300414,7 +301346,7 @@ var state2 = {
|
|
|
300414
301346
|
},
|
|
300415
301347
|
"public": {
|
|
300416
301348
|
"type": "boolean",
|
|
300417
|
-
"description": "
|
|
301349
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
300418
301350
|
},
|
|
300419
301351
|
"verificationStatus": {
|
|
300420
301352
|
"type": "string",
|
|
@@ -300991,6 +301923,10 @@ var state2 = {
|
|
|
300991
301923
|
"readmeUrl": {
|
|
300992
301924
|
"type": "string",
|
|
300993
301925
|
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
301926
|
+
},
|
|
301927
|
+
"public": {
|
|
301928
|
+
"type": "boolean",
|
|
301929
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
300994
301930
|
}
|
|
300995
301931
|
},
|
|
300996
301932
|
"required": [
|
|
@@ -301009,7 +301945,8 @@ var state2 = {
|
|
|
301009
301945
|
"title",
|
|
301010
301946
|
"description",
|
|
301011
301947
|
"iconUrl",
|
|
301012
|
-
"readmeUrl"
|
|
301948
|
+
"readmeUrl",
|
|
301949
|
+
"public"
|
|
301013
301950
|
],
|
|
301014
301951
|
"additionalProperties": false
|
|
301015
301952
|
}
|
|
@@ -302545,7 +303482,11 @@ var state2 = {
|
|
|
302545
303482
|
"operations": [
|
|
302546
303483
|
"listPublicIntegrations",
|
|
302547
303484
|
"getPublicIntegrationById",
|
|
302548
|
-
"getPublicIntegration"
|
|
303485
|
+
"getPublicIntegration",
|
|
303486
|
+
"listPublicPlugins",
|
|
303487
|
+
"getPublicPluginById",
|
|
303488
|
+
"getPublicPlugin",
|
|
303489
|
+
"getPublicPluginCode"
|
|
302549
303490
|
]
|
|
302550
303491
|
},
|
|
302551
303492
|
{
|
|
@@ -304342,7 +305283,7 @@ var state3 = {
|
|
|
304342
305283
|
"title": "Botpress API",
|
|
304343
305284
|
"description": "API for Botpress Cloud",
|
|
304344
305285
|
"server": "https://api.botpress.cloud",
|
|
304345
|
-
"version": "1.
|
|
305286
|
+
"version": "1.5.0",
|
|
304346
305287
|
"prefix": "v1"
|
|
304347
305288
|
},
|
|
304348
305289
|
"errors": [
|
|
@@ -304633,7 +305574,7 @@ var state3 = {
|
|
|
304633
305574
|
},
|
|
304634
305575
|
"public": {
|
|
304635
305576
|
"type": "boolean",
|
|
304636
|
-
"description": "
|
|
305577
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
304637
305578
|
},
|
|
304638
305579
|
"verificationStatus": {
|
|
304639
305580
|
"type": "string",
|
|
@@ -305646,7 +306587,7 @@ var state3 = {
|
|
|
305646
306587
|
},
|
|
305647
306588
|
"public": {
|
|
305648
306589
|
"type": "boolean",
|
|
305649
|
-
"description": "
|
|
306590
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
305650
306591
|
},
|
|
305651
306592
|
"verificationStatus": {
|
|
305652
306593
|
"type": "string",
|
|
@@ -306223,6 +307164,10 @@ var state3 = {
|
|
|
306223
307164
|
"readmeUrl": {
|
|
306224
307165
|
"type": "string",
|
|
306225
307166
|
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
307167
|
+
},
|
|
307168
|
+
"public": {
|
|
307169
|
+
"type": "boolean",
|
|
307170
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
306226
307171
|
}
|
|
306227
307172
|
},
|
|
306228
307173
|
"required": [
|
|
@@ -306241,7 +307186,8 @@ var state3 = {
|
|
|
306241
307186
|
"title",
|
|
306242
307187
|
"description",
|
|
306243
307188
|
"iconUrl",
|
|
306244
|
-
"readmeUrl"
|
|
307189
|
+
"readmeUrl",
|
|
307190
|
+
"public"
|
|
306245
307191
|
],
|
|
306246
307192
|
"additionalProperties": false
|
|
306247
307193
|
}
|
|
@@ -309132,7 +310078,7 @@ var state4 = {
|
|
|
309132
310078
|
"title": "Botpress API",
|
|
309133
310079
|
"description": "API for Botpress Cloud",
|
|
309134
310080
|
"server": "https://api.botpress.cloud",
|
|
309135
|
-
"version": "1.
|
|
310081
|
+
"version": "1.5.0",
|
|
309136
310082
|
"prefix": "v1"
|
|
309137
310083
|
},
|
|
309138
310084
|
"errors": [
|
|
@@ -309432,7 +310378,7 @@ var state4 = {
|
|
|
309432
310378
|
},
|
|
309433
310379
|
"public": {
|
|
309434
310380
|
"type": "boolean",
|
|
309435
|
-
"description": "
|
|
310381
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
309436
310382
|
},
|
|
309437
310383
|
"verificationStatus": {
|
|
309438
310384
|
"type": "string",
|
|
@@ -310445,7 +311391,7 @@ var state4 = {
|
|
|
310445
311391
|
},
|
|
310446
311392
|
"public": {
|
|
310447
311393
|
"type": "boolean",
|
|
310448
|
-
"description": "
|
|
311394
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
310449
311395
|
},
|
|
310450
311396
|
"verificationStatus": {
|
|
310451
311397
|
"type": "string",
|
|
@@ -311022,6 +311968,10 @@ var state4 = {
|
|
|
311022
311968
|
"readmeUrl": {
|
|
311023
311969
|
"type": "string",
|
|
311024
311970
|
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
311971
|
+
},
|
|
311972
|
+
"public": {
|
|
311973
|
+
"type": "boolean",
|
|
311974
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
311025
311975
|
}
|
|
311026
311976
|
},
|
|
311027
311977
|
"required": [
|
|
@@ -311040,7 +311990,8 @@ var state4 = {
|
|
|
311040
311990
|
"title",
|
|
311041
311991
|
"description",
|
|
311042
311992
|
"iconUrl",
|
|
311043
|
-
"readmeUrl"
|
|
311993
|
+
"readmeUrl",
|
|
311994
|
+
"public"
|
|
311044
311995
|
],
|
|
311045
311996
|
"additionalProperties": false
|
|
311046
311997
|
}
|
|
@@ -315842,7 +316793,7 @@ var state5 = {
|
|
|
315842
316793
|
},
|
|
315843
316794
|
"public": {
|
|
315844
316795
|
"type": "boolean",
|
|
315845
|
-
"description": "
|
|
316796
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
315846
316797
|
},
|
|
315847
316798
|
"verificationStatus": {
|
|
315848
316799
|
"type": "string",
|
|
@@ -315852,125 +316803,842 @@ var state5 = {
|
|
|
315852
316803
|
"approved",
|
|
315853
316804
|
"rejected"
|
|
315854
316805
|
],
|
|
315855
|
-
"description": "Status of the integration version verification"
|
|
315856
|
-
},
|
|
315857
|
-
"ownerWorkspace": {
|
|
316806
|
+
"description": "Status of the integration version verification"
|
|
316807
|
+
},
|
|
316808
|
+
"ownerWorkspace": {
|
|
316809
|
+
"type": "object",
|
|
316810
|
+
"properties": {
|
|
316811
|
+
"id": {
|
|
316812
|
+
"type": "string"
|
|
316813
|
+
},
|
|
316814
|
+
"handle": {
|
|
316815
|
+
"type": "string",
|
|
316816
|
+
"nullable": true
|
|
316817
|
+
},
|
|
316818
|
+
"name": {
|
|
316819
|
+
"type": "string"
|
|
316820
|
+
}
|
|
316821
|
+
},
|
|
316822
|
+
"required": [
|
|
316823
|
+
"id",
|
|
316824
|
+
"handle",
|
|
316825
|
+
"name"
|
|
316826
|
+
]
|
|
316827
|
+
},
|
|
316828
|
+
"meta": {
|
|
316829
|
+
"type": "object",
|
|
316830
|
+
"properties": {
|
|
316831
|
+
"installs": {
|
|
316832
|
+
"type": "number"
|
|
316833
|
+
},
|
|
316834
|
+
"views": {
|
|
316835
|
+
"type": "number"
|
|
316836
|
+
}
|
|
316837
|
+
},
|
|
316838
|
+
"required": [
|
|
316839
|
+
"installs",
|
|
316840
|
+
"views"
|
|
316841
|
+
]
|
|
316842
|
+
},
|
|
316843
|
+
"matchedOn": {
|
|
316844
|
+
"type": "object",
|
|
316845
|
+
"properties": {
|
|
316846
|
+
"name": {
|
|
316847
|
+
"type": "boolean",
|
|
316848
|
+
"description": "Whether the integration name matched the search term"
|
|
316849
|
+
},
|
|
316850
|
+
"title": {
|
|
316851
|
+
"type": "boolean",
|
|
316852
|
+
"description": "Whether the integration title matched the search term"
|
|
316853
|
+
},
|
|
316854
|
+
"description": {
|
|
316855
|
+
"type": "boolean",
|
|
316856
|
+
"description": "Whether the integration description matched the search term"
|
|
316857
|
+
},
|
|
316858
|
+
"actions": {
|
|
316859
|
+
"type": "array",
|
|
316860
|
+
"items": {
|
|
316861
|
+
"type": "string"
|
|
316862
|
+
},
|
|
316863
|
+
"description": "Action names that matched the search term"
|
|
316864
|
+
},
|
|
316865
|
+
"interfaces": {
|
|
316866
|
+
"type": "array",
|
|
316867
|
+
"items": {
|
|
316868
|
+
"type": "string"
|
|
316869
|
+
},
|
|
316870
|
+
"description": "Interface names that matched the search term"
|
|
316871
|
+
}
|
|
316872
|
+
},
|
|
316873
|
+
"description": "Metadata about which fields matched the search criteria"
|
|
316874
|
+
}
|
|
316875
|
+
},
|
|
316876
|
+
"required": [
|
|
316877
|
+
"id",
|
|
316878
|
+
"name",
|
|
316879
|
+
"version",
|
|
316880
|
+
"createdAt",
|
|
316881
|
+
"updatedAt",
|
|
316882
|
+
"title",
|
|
316883
|
+
"description",
|
|
316884
|
+
"iconUrl",
|
|
316885
|
+
"public",
|
|
316886
|
+
"verificationStatus",
|
|
316887
|
+
"ownerWorkspace",
|
|
316888
|
+
"meta"
|
|
316889
|
+
]
|
|
316890
|
+
}
|
|
316891
|
+
},
|
|
316892
|
+
"meta": {
|
|
316893
|
+
"type": "object",
|
|
316894
|
+
"properties": {
|
|
316895
|
+
"nextToken": {
|
|
316896
|
+
"type": "string",
|
|
316897
|
+
"description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
|
|
316898
|
+
}
|
|
316899
|
+
},
|
|
316900
|
+
"additionalProperties": false
|
|
316901
|
+
}
|
|
316902
|
+
},
|
|
316903
|
+
"required": [
|
|
316904
|
+
"integrations",
|
|
316905
|
+
"meta"
|
|
316906
|
+
],
|
|
316907
|
+
"title": "listPublicIntegrationsResponse",
|
|
316908
|
+
"additionalProperties": false
|
|
316909
|
+
}
|
|
316910
|
+
}
|
|
316911
|
+
},
|
|
316912
|
+
"getPublicIntegrationById": {
|
|
316913
|
+
"name": "getPublicIntegrationById",
|
|
316914
|
+
"description": "Get public integration by Id",
|
|
316915
|
+
"method": "get",
|
|
316916
|
+
"section": "hub",
|
|
316917
|
+
"path": "/v1/admin/hub/integrations/{id}",
|
|
316918
|
+
"disableDefaultParameters": {
|
|
316919
|
+
"x-workspace-id": true
|
|
316920
|
+
},
|
|
316921
|
+
"parameters": {
|
|
316922
|
+
"id": {
|
|
316923
|
+
"type": "string",
|
|
316924
|
+
"description": "Integration Version ID",
|
|
316925
|
+
"in": "path"
|
|
316926
|
+
}
|
|
316927
|
+
},
|
|
316928
|
+
"response": {
|
|
316929
|
+
"description": "Success",
|
|
316930
|
+
"schema": {
|
|
316931
|
+
"type": "object",
|
|
316932
|
+
"properties": {
|
|
316933
|
+
"integration": {
|
|
316934
|
+
"type": "object",
|
|
316935
|
+
"properties": {
|
|
316936
|
+
"id": {
|
|
316937
|
+
"type": "string",
|
|
316938
|
+
"minLength": 28,
|
|
316939
|
+
"maxLength": 36,
|
|
316940
|
+
"description": "ID of the [Integration](#schema_integration)"
|
|
316941
|
+
},
|
|
316942
|
+
"createdAt": {
|
|
316943
|
+
"type": "string",
|
|
316944
|
+
"format": "date-time",
|
|
316945
|
+
"description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
316946
|
+
},
|
|
316947
|
+
"updatedAt": {
|
|
316948
|
+
"type": "string",
|
|
316949
|
+
"format": "date-time",
|
|
316950
|
+
"description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
316951
|
+
},
|
|
316952
|
+
"identifier": {
|
|
316953
|
+
"type": "object",
|
|
316954
|
+
"properties": {
|
|
316955
|
+
"fallbackHandlerScript": {
|
|
316956
|
+
"type": "string",
|
|
316957
|
+
"maxLength": 2e3,
|
|
316958
|
+
"description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
|
|
316959
|
+
},
|
|
316960
|
+
"extractScript": {
|
|
316961
|
+
"type": "string",
|
|
316962
|
+
"maxLength": 2e3,
|
|
316963
|
+
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
|
|
316964
|
+
}
|
|
316965
|
+
},
|
|
316966
|
+
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
316967
|
+
"additionalProperties": false
|
|
316968
|
+
},
|
|
316969
|
+
"sandbox": {
|
|
316970
|
+
"type": "object",
|
|
316971
|
+
"properties": {
|
|
316972
|
+
"identifierExtractScript": {
|
|
316973
|
+
"type": "string",
|
|
316974
|
+
"maxLength": 2e3,
|
|
316975
|
+
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
|
|
316976
|
+
},
|
|
316977
|
+
"messageExtractScript": {
|
|
316978
|
+
"type": "string",
|
|
316979
|
+
"maxLength": 2e3,
|
|
316980
|
+
"description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
|
|
316981
|
+
}
|
|
316982
|
+
},
|
|
316983
|
+
"additionalProperties": false
|
|
316984
|
+
},
|
|
316985
|
+
"url": {
|
|
316986
|
+
"type": "string",
|
|
316987
|
+
"maxLength": 2e3,
|
|
316988
|
+
"description": "URL of the [Integration](#schema_integration)"
|
|
316989
|
+
},
|
|
316990
|
+
"name": {
|
|
316991
|
+
"type": "string",
|
|
316992
|
+
"maxLength": 200,
|
|
316993
|
+
"description": "Name of the [Integration](#schema_integration)"
|
|
316994
|
+
},
|
|
316995
|
+
"version": {
|
|
316996
|
+
"type": "string",
|
|
316997
|
+
"maxLength": 200,
|
|
316998
|
+
"description": "Version of the [Integration](#schema_integration)"
|
|
316999
|
+
},
|
|
317000
|
+
"interfaces": {
|
|
317001
|
+
"type": "object",
|
|
317002
|
+
"additionalProperties": {
|
|
317003
|
+
"type": "object",
|
|
317004
|
+
"properties": {
|
|
317005
|
+
"id": {
|
|
317006
|
+
"type": "string",
|
|
317007
|
+
"minLength": 28,
|
|
317008
|
+
"maxLength": 36,
|
|
317009
|
+
"description": "ID of the interface"
|
|
317010
|
+
},
|
|
317011
|
+
"name": {
|
|
317012
|
+
"type": "string",
|
|
317013
|
+
"maxLength": 200,
|
|
317014
|
+
"description": "Name of the interface"
|
|
317015
|
+
},
|
|
317016
|
+
"version": {
|
|
317017
|
+
"type": "string",
|
|
317018
|
+
"maxLength": 200,
|
|
317019
|
+
"description": "Version of the interface"
|
|
317020
|
+
},
|
|
317021
|
+
"entities": {
|
|
317022
|
+
"type": "object",
|
|
317023
|
+
"additionalProperties": {
|
|
317024
|
+
"type": "object",
|
|
317025
|
+
"properties": {
|
|
317026
|
+
"name": {
|
|
317027
|
+
"type": "string",
|
|
317028
|
+
"maxLength": 200
|
|
317029
|
+
}
|
|
317030
|
+
},
|
|
317031
|
+
"required": [
|
|
317032
|
+
"name"
|
|
317033
|
+
],
|
|
317034
|
+
"additionalProperties": false
|
|
317035
|
+
}
|
|
317036
|
+
},
|
|
317037
|
+
"actions": {
|
|
317038
|
+
"type": "object",
|
|
317039
|
+
"additionalProperties": {
|
|
317040
|
+
"type": "object",
|
|
317041
|
+
"properties": {
|
|
317042
|
+
"name": {
|
|
317043
|
+
"type": "string",
|
|
317044
|
+
"maxLength": 200
|
|
317045
|
+
}
|
|
317046
|
+
},
|
|
317047
|
+
"required": [
|
|
317048
|
+
"name"
|
|
317049
|
+
],
|
|
317050
|
+
"additionalProperties": false
|
|
317051
|
+
}
|
|
317052
|
+
},
|
|
317053
|
+
"events": {
|
|
317054
|
+
"type": "object",
|
|
317055
|
+
"additionalProperties": {
|
|
317056
|
+
"type": "object",
|
|
317057
|
+
"properties": {
|
|
317058
|
+
"name": {
|
|
317059
|
+
"type": "string",
|
|
317060
|
+
"maxLength": 200
|
|
317061
|
+
}
|
|
317062
|
+
},
|
|
317063
|
+
"required": [
|
|
317064
|
+
"name"
|
|
317065
|
+
],
|
|
317066
|
+
"additionalProperties": false
|
|
317067
|
+
}
|
|
317068
|
+
},
|
|
317069
|
+
"channels": {
|
|
317070
|
+
"type": "object",
|
|
317071
|
+
"additionalProperties": {
|
|
317072
|
+
"type": "object",
|
|
317073
|
+
"properties": {
|
|
317074
|
+
"name": {
|
|
317075
|
+
"type": "string",
|
|
317076
|
+
"maxLength": 200
|
|
317077
|
+
}
|
|
317078
|
+
},
|
|
317079
|
+
"required": [
|
|
317080
|
+
"name"
|
|
317081
|
+
],
|
|
317082
|
+
"additionalProperties": false
|
|
317083
|
+
}
|
|
317084
|
+
}
|
|
317085
|
+
},
|
|
317086
|
+
"required": [
|
|
317087
|
+
"id",
|
|
317088
|
+
"name",
|
|
317089
|
+
"version",
|
|
317090
|
+
"entities",
|
|
317091
|
+
"actions",
|
|
317092
|
+
"events",
|
|
317093
|
+
"channels"
|
|
317094
|
+
],
|
|
317095
|
+
"additionalProperties": false
|
|
317096
|
+
}
|
|
317097
|
+
},
|
|
317098
|
+
"configuration": {
|
|
317099
|
+
"type": "object",
|
|
317100
|
+
"properties": {
|
|
317101
|
+
"title": {
|
|
317102
|
+
"type": "string",
|
|
317103
|
+
"maxLength": 64,
|
|
317104
|
+
"description": "Title of the configuration"
|
|
317105
|
+
},
|
|
317106
|
+
"description": {
|
|
317107
|
+
"type": "string",
|
|
317108
|
+
"maxLength": 256,
|
|
317109
|
+
"description": "Description of the configuration"
|
|
317110
|
+
},
|
|
317111
|
+
"identifier": {
|
|
317112
|
+
"type": "object",
|
|
317113
|
+
"properties": {
|
|
317114
|
+
"linkTemplateScript": {
|
|
317115
|
+
"type": "string",
|
|
317116
|
+
"maxLength": 2e3
|
|
317117
|
+
},
|
|
317118
|
+
"required": {
|
|
317119
|
+
"type": "boolean"
|
|
317120
|
+
}
|
|
317121
|
+
},
|
|
317122
|
+
"required": [
|
|
317123
|
+
"required"
|
|
317124
|
+
],
|
|
317125
|
+
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
317126
|
+
"additionalProperties": false
|
|
317127
|
+
},
|
|
317128
|
+
"schema": {
|
|
317129
|
+
"type": "object",
|
|
317130
|
+
"additionalProperties": true,
|
|
317131
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
317132
|
+
}
|
|
317133
|
+
},
|
|
317134
|
+
"required": [
|
|
317135
|
+
"identifier",
|
|
317136
|
+
"schema"
|
|
317137
|
+
],
|
|
317138
|
+
"description": "Configuration definition",
|
|
317139
|
+
"additionalProperties": false
|
|
317140
|
+
},
|
|
317141
|
+
"configurations": {
|
|
317142
|
+
"type": "object",
|
|
317143
|
+
"additionalProperties": {
|
|
317144
|
+
"type": "object",
|
|
317145
|
+
"properties": {
|
|
317146
|
+
"title": {
|
|
317147
|
+
"type": "string",
|
|
317148
|
+
"maxLength": 64,
|
|
317149
|
+
"description": "Title of the configuration"
|
|
317150
|
+
},
|
|
317151
|
+
"description": {
|
|
317152
|
+
"type": "string",
|
|
317153
|
+
"maxLength": 256,
|
|
317154
|
+
"description": "Description of the configuration"
|
|
317155
|
+
},
|
|
317156
|
+
"identifier": {
|
|
317157
|
+
"type": "object",
|
|
317158
|
+
"properties": {
|
|
317159
|
+
"linkTemplateScript": {
|
|
317160
|
+
"type": "string",
|
|
317161
|
+
"maxLength": 2e3
|
|
317162
|
+
},
|
|
317163
|
+
"required": {
|
|
317164
|
+
"type": "boolean"
|
|
317165
|
+
}
|
|
317166
|
+
},
|
|
317167
|
+
"required": [
|
|
317168
|
+
"required"
|
|
317169
|
+
],
|
|
317170
|
+
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
317171
|
+
"additionalProperties": false
|
|
317172
|
+
},
|
|
317173
|
+
"schema": {
|
|
317174
|
+
"type": "object",
|
|
317175
|
+
"additionalProperties": true,
|
|
317176
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
317177
|
+
}
|
|
317178
|
+
},
|
|
317179
|
+
"required": [
|
|
317180
|
+
"identifier",
|
|
317181
|
+
"schema"
|
|
317182
|
+
],
|
|
317183
|
+
"description": "Configuration definition",
|
|
317184
|
+
"additionalProperties": false
|
|
317185
|
+
}
|
|
317186
|
+
},
|
|
317187
|
+
"channels": {
|
|
317188
|
+
"type": "object",
|
|
317189
|
+
"additionalProperties": {
|
|
317190
|
+
"type": "object",
|
|
317191
|
+
"properties": {
|
|
317192
|
+
"title": {
|
|
317193
|
+
"type": "string",
|
|
317194
|
+
"maxLength": 64,
|
|
317195
|
+
"description": "Title of the channel"
|
|
317196
|
+
},
|
|
317197
|
+
"description": {
|
|
317198
|
+
"type": "string",
|
|
317199
|
+
"maxLength": 256,
|
|
317200
|
+
"description": "Description of the channel"
|
|
317201
|
+
},
|
|
317202
|
+
"messages": {
|
|
317203
|
+
"type": "object",
|
|
317204
|
+
"additionalProperties": {
|
|
317205
|
+
"type": "object",
|
|
317206
|
+
"properties": {
|
|
317207
|
+
"schema": {
|
|
317208
|
+
"type": "object",
|
|
317209
|
+
"additionalProperties": true
|
|
317210
|
+
}
|
|
317211
|
+
},
|
|
317212
|
+
"required": [
|
|
317213
|
+
"schema"
|
|
317214
|
+
],
|
|
317215
|
+
"description": "Message definition",
|
|
317216
|
+
"additionalProperties": false
|
|
317217
|
+
}
|
|
317218
|
+
},
|
|
317219
|
+
"conversation": {
|
|
317220
|
+
"type": "object",
|
|
317221
|
+
"properties": {
|
|
317222
|
+
"tags": {
|
|
317223
|
+
"type": "object",
|
|
317224
|
+
"additionalProperties": {
|
|
317225
|
+
"type": "object",
|
|
317226
|
+
"properties": {
|
|
317227
|
+
"title": {
|
|
317228
|
+
"type": "string",
|
|
317229
|
+
"maxLength": 64,
|
|
317230
|
+
"description": "Title of the tag"
|
|
317231
|
+
},
|
|
317232
|
+
"description": {
|
|
317233
|
+
"type": "string",
|
|
317234
|
+
"maxLength": 256,
|
|
317235
|
+
"description": "Description of the tag"
|
|
317236
|
+
}
|
|
317237
|
+
},
|
|
317238
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
317239
|
+
"additionalProperties": false
|
|
317240
|
+
}
|
|
317241
|
+
},
|
|
317242
|
+
"creation": {
|
|
317243
|
+
"type": "object",
|
|
317244
|
+
"properties": {
|
|
317245
|
+
"enabled": {
|
|
317246
|
+
"type": "boolean",
|
|
317247
|
+
"description": "Enable conversation creation"
|
|
317248
|
+
},
|
|
317249
|
+
"requiredTags": {
|
|
317250
|
+
"type": "array",
|
|
317251
|
+
"items": {
|
|
317252
|
+
"type": "string"
|
|
317253
|
+
},
|
|
317254
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
317255
|
+
}
|
|
317256
|
+
},
|
|
317257
|
+
"required": [
|
|
317258
|
+
"enabled",
|
|
317259
|
+
"requiredTags"
|
|
317260
|
+
],
|
|
317261
|
+
"description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
|
|
317262
|
+
"additionalProperties": false
|
|
317263
|
+
}
|
|
317264
|
+
},
|
|
317265
|
+
"required": [
|
|
317266
|
+
"tags",
|
|
317267
|
+
"creation"
|
|
317268
|
+
],
|
|
317269
|
+
"description": "Conversation object configuration",
|
|
317270
|
+
"additionalProperties": false
|
|
317271
|
+
},
|
|
317272
|
+
"message": {
|
|
317273
|
+
"type": "object",
|
|
317274
|
+
"properties": {
|
|
317275
|
+
"tags": {
|
|
317276
|
+
"type": "object",
|
|
317277
|
+
"additionalProperties": {
|
|
317278
|
+
"type": "object",
|
|
317279
|
+
"properties": {
|
|
317280
|
+
"title": {
|
|
317281
|
+
"type": "string",
|
|
317282
|
+
"maxLength": 64,
|
|
317283
|
+
"description": "Title of the tag"
|
|
317284
|
+
},
|
|
317285
|
+
"description": {
|
|
317286
|
+
"type": "string",
|
|
317287
|
+
"maxLength": 256,
|
|
317288
|
+
"description": "Description of the tag"
|
|
317289
|
+
}
|
|
317290
|
+
},
|
|
317291
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
317292
|
+
"additionalProperties": false
|
|
317293
|
+
}
|
|
317294
|
+
}
|
|
317295
|
+
},
|
|
317296
|
+
"required": [
|
|
317297
|
+
"tags"
|
|
317298
|
+
],
|
|
317299
|
+
"description": "Message object configuration",
|
|
317300
|
+
"additionalProperties": false
|
|
317301
|
+
}
|
|
317302
|
+
},
|
|
317303
|
+
"required": [
|
|
317304
|
+
"messages",
|
|
317305
|
+
"conversation",
|
|
317306
|
+
"message"
|
|
317307
|
+
],
|
|
317308
|
+
"description": "Channel definition",
|
|
317309
|
+
"additionalProperties": false
|
|
317310
|
+
}
|
|
317311
|
+
},
|
|
317312
|
+
"states": {
|
|
317313
|
+
"type": "object",
|
|
317314
|
+
"additionalProperties": {
|
|
315858
317315
|
"type": "object",
|
|
315859
317316
|
"properties": {
|
|
315860
|
-
"
|
|
315861
|
-
"type": "string"
|
|
315862
|
-
},
|
|
315863
|
-
"handle": {
|
|
317317
|
+
"type": {
|
|
315864
317318
|
"type": "string",
|
|
315865
|
-
"
|
|
317319
|
+
"enum": [
|
|
317320
|
+
"conversation",
|
|
317321
|
+
"user",
|
|
317322
|
+
"integration"
|
|
317323
|
+
],
|
|
317324
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
315866
317325
|
},
|
|
315867
|
-
"
|
|
315868
|
-
"type": "
|
|
317326
|
+
"schema": {
|
|
317327
|
+
"type": "object",
|
|
317328
|
+
"additionalProperties": true,
|
|
317329
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
315869
317330
|
}
|
|
315870
317331
|
},
|
|
315871
317332
|
"required": [
|
|
315872
|
-
"
|
|
315873
|
-
"
|
|
315874
|
-
|
|
315875
|
-
|
|
315876
|
-
|
|
315877
|
-
|
|
317333
|
+
"type",
|
|
317334
|
+
"schema"
|
|
317335
|
+
],
|
|
317336
|
+
"description": "State definition",
|
|
317337
|
+
"additionalProperties": false
|
|
317338
|
+
}
|
|
317339
|
+
},
|
|
317340
|
+
"events": {
|
|
317341
|
+
"type": "object",
|
|
317342
|
+
"additionalProperties": {
|
|
315878
317343
|
"type": "object",
|
|
315879
317344
|
"properties": {
|
|
315880
|
-
"
|
|
315881
|
-
"type": "
|
|
317345
|
+
"title": {
|
|
317346
|
+
"type": "string",
|
|
317347
|
+
"maxLength": 64,
|
|
317348
|
+
"description": "Title of the event"
|
|
315882
317349
|
},
|
|
315883
|
-
"
|
|
315884
|
-
"type": "
|
|
317350
|
+
"description": {
|
|
317351
|
+
"type": "string",
|
|
317352
|
+
"maxLength": 256,
|
|
317353
|
+
"description": "Description of the event"
|
|
317354
|
+
},
|
|
317355
|
+
"schema": {
|
|
317356
|
+
"type": "object",
|
|
317357
|
+
"additionalProperties": true
|
|
315885
317358
|
}
|
|
315886
317359
|
},
|
|
315887
317360
|
"required": [
|
|
315888
|
-
"
|
|
315889
|
-
|
|
315890
|
-
|
|
315891
|
-
|
|
315892
|
-
|
|
317361
|
+
"schema"
|
|
317362
|
+
],
|
|
317363
|
+
"description": "Event Definition",
|
|
317364
|
+
"additionalProperties": false
|
|
317365
|
+
}
|
|
317366
|
+
},
|
|
317367
|
+
"actions": {
|
|
317368
|
+
"type": "object",
|
|
317369
|
+
"additionalProperties": {
|
|
315893
317370
|
"type": "object",
|
|
315894
317371
|
"properties": {
|
|
315895
|
-
"name": {
|
|
315896
|
-
"type": "boolean",
|
|
315897
|
-
"description": "Whether the integration name matched the search term"
|
|
315898
|
-
},
|
|
315899
317372
|
"title": {
|
|
315900
|
-
"type": "
|
|
315901
|
-
"
|
|
317373
|
+
"type": "string",
|
|
317374
|
+
"maxLength": 64,
|
|
317375
|
+
"description": "Title of the action"
|
|
315902
317376
|
},
|
|
315903
317377
|
"description": {
|
|
315904
|
-
"type": "
|
|
315905
|
-
"
|
|
317378
|
+
"type": "string",
|
|
317379
|
+
"maxLength": 256,
|
|
317380
|
+
"description": "Description of the action"
|
|
315906
317381
|
},
|
|
315907
|
-
"
|
|
315908
|
-
"type": "
|
|
315909
|
-
|
|
315910
|
-
|
|
317382
|
+
"billable": {
|
|
317383
|
+
"type": "boolean"
|
|
317384
|
+
},
|
|
317385
|
+
"cacheable": {
|
|
317386
|
+
"type": "boolean"
|
|
317387
|
+
},
|
|
317388
|
+
"input": {
|
|
317389
|
+
"type": "object",
|
|
317390
|
+
"properties": {
|
|
317391
|
+
"schema": {
|
|
317392
|
+
"type": "object",
|
|
317393
|
+
"additionalProperties": true
|
|
317394
|
+
}
|
|
315911
317395
|
},
|
|
315912
|
-
"
|
|
317396
|
+
"required": [
|
|
317397
|
+
"schema"
|
|
317398
|
+
],
|
|
317399
|
+
"additionalProperties": false
|
|
315913
317400
|
},
|
|
315914
|
-
"
|
|
315915
|
-
"type": "
|
|
315916
|
-
"
|
|
315917
|
-
"
|
|
317401
|
+
"output": {
|
|
317402
|
+
"type": "object",
|
|
317403
|
+
"properties": {
|
|
317404
|
+
"schema": {
|
|
317405
|
+
"type": "object",
|
|
317406
|
+
"additionalProperties": true
|
|
317407
|
+
}
|
|
315918
317408
|
},
|
|
315919
|
-
"
|
|
317409
|
+
"required": [
|
|
317410
|
+
"schema"
|
|
317411
|
+
],
|
|
317412
|
+
"additionalProperties": false
|
|
315920
317413
|
}
|
|
315921
317414
|
},
|
|
315922
|
-
"
|
|
317415
|
+
"required": [
|
|
317416
|
+
"input",
|
|
317417
|
+
"output"
|
|
317418
|
+
],
|
|
317419
|
+
"description": "Action definition",
|
|
317420
|
+
"additionalProperties": false
|
|
315923
317421
|
}
|
|
315924
317422
|
},
|
|
315925
|
-
"
|
|
315926
|
-
"
|
|
315927
|
-
"
|
|
315928
|
-
|
|
315929
|
-
|
|
315930
|
-
|
|
315931
|
-
|
|
315932
|
-
|
|
315933
|
-
|
|
315934
|
-
|
|
315935
|
-
|
|
315936
|
-
|
|
315937
|
-
|
|
315938
|
-
|
|
315939
|
-
|
|
315940
|
-
|
|
315941
|
-
|
|
315942
|
-
|
|
315943
|
-
|
|
315944
|
-
|
|
317423
|
+
"user": {
|
|
317424
|
+
"type": "object",
|
|
317425
|
+
"properties": {
|
|
317426
|
+
"tags": {
|
|
317427
|
+
"type": "object",
|
|
317428
|
+
"additionalProperties": {
|
|
317429
|
+
"type": "object",
|
|
317430
|
+
"properties": {
|
|
317431
|
+
"title": {
|
|
317432
|
+
"type": "string",
|
|
317433
|
+
"maxLength": 64,
|
|
317434
|
+
"description": "Title of the tag"
|
|
317435
|
+
},
|
|
317436
|
+
"description": {
|
|
317437
|
+
"type": "string",
|
|
317438
|
+
"maxLength": 256,
|
|
317439
|
+
"description": "Description of the tag"
|
|
317440
|
+
}
|
|
317441
|
+
},
|
|
317442
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
317443
|
+
"additionalProperties": false
|
|
317444
|
+
}
|
|
317445
|
+
},
|
|
317446
|
+
"creation": {
|
|
317447
|
+
"type": "object",
|
|
317448
|
+
"properties": {
|
|
317449
|
+
"enabled": {
|
|
317450
|
+
"type": "boolean",
|
|
317451
|
+
"description": "Enable user creation"
|
|
317452
|
+
},
|
|
317453
|
+
"requiredTags": {
|
|
317454
|
+
"type": "array",
|
|
317455
|
+
"items": {
|
|
317456
|
+
"type": "string"
|
|
317457
|
+
},
|
|
317458
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
317459
|
+
}
|
|
317460
|
+
},
|
|
317461
|
+
"required": [
|
|
317462
|
+
"enabled",
|
|
317463
|
+
"requiredTags"
|
|
317464
|
+
],
|
|
317465
|
+
"description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
|
|
317466
|
+
"additionalProperties": false
|
|
317467
|
+
}
|
|
317468
|
+
},
|
|
317469
|
+
"required": [
|
|
317470
|
+
"tags",
|
|
317471
|
+
"creation"
|
|
317472
|
+
],
|
|
317473
|
+
"description": "User object configuration",
|
|
317474
|
+
"additionalProperties": false
|
|
317475
|
+
},
|
|
317476
|
+
"entities": {
|
|
317477
|
+
"type": "object",
|
|
317478
|
+
"additionalProperties": {
|
|
317479
|
+
"type": "object",
|
|
317480
|
+
"properties": {
|
|
317481
|
+
"title": {
|
|
317482
|
+
"type": "string",
|
|
317483
|
+
"maxLength": 64,
|
|
317484
|
+
"description": "Title of the entity"
|
|
317485
|
+
},
|
|
317486
|
+
"description": {
|
|
317487
|
+
"type": "string",
|
|
317488
|
+
"maxLength": 256,
|
|
317489
|
+
"description": "Description of the entity"
|
|
317490
|
+
},
|
|
317491
|
+
"schema": {
|
|
317492
|
+
"type": "object",
|
|
317493
|
+
"additionalProperties": true
|
|
317494
|
+
}
|
|
317495
|
+
},
|
|
317496
|
+
"required": [
|
|
317497
|
+
"schema"
|
|
317498
|
+
],
|
|
317499
|
+
"description": "Entity definition",
|
|
317500
|
+
"additionalProperties": false
|
|
317501
|
+
}
|
|
317502
|
+
},
|
|
317503
|
+
"dev": {
|
|
317504
|
+
"type": "boolean",
|
|
317505
|
+
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
317506
|
+
},
|
|
317507
|
+
"title": {
|
|
315945
317508
|
"type": "string",
|
|
315946
|
-
"
|
|
317509
|
+
"minLength": 1,
|
|
317510
|
+
"maxLength": 64,
|
|
317511
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
317512
|
+
},
|
|
317513
|
+
"description": {
|
|
317514
|
+
"type": "string",
|
|
317515
|
+
"maxLength": 256,
|
|
317516
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
317517
|
+
},
|
|
317518
|
+
"iconUrl": {
|
|
317519
|
+
"type": "string",
|
|
317520
|
+
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
317521
|
+
},
|
|
317522
|
+
"readmeUrl": {
|
|
317523
|
+
"type": "string",
|
|
317524
|
+
"description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
|
|
317525
|
+
},
|
|
317526
|
+
"public": {
|
|
317527
|
+
"type": "boolean",
|
|
317528
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
317529
|
+
},
|
|
317530
|
+
"verificationStatus": {
|
|
317531
|
+
"type": "string",
|
|
317532
|
+
"enum": [
|
|
317533
|
+
"unapproved",
|
|
317534
|
+
"pending",
|
|
317535
|
+
"approved",
|
|
317536
|
+
"rejected"
|
|
317537
|
+
],
|
|
317538
|
+
"description": "Status of the integration version verification"
|
|
317539
|
+
},
|
|
317540
|
+
"secrets": {
|
|
317541
|
+
"type": "array",
|
|
317542
|
+
"items": {
|
|
317543
|
+
"type": "string"
|
|
317544
|
+
},
|
|
317545
|
+
"description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing."
|
|
317546
|
+
},
|
|
317547
|
+
"ownerWorkspace": {
|
|
317548
|
+
"type": "object",
|
|
317549
|
+
"properties": {
|
|
317550
|
+
"id": {
|
|
317551
|
+
"type": "string"
|
|
317552
|
+
},
|
|
317553
|
+
"handle": {
|
|
317554
|
+
"type": "string",
|
|
317555
|
+
"nullable": true
|
|
317556
|
+
},
|
|
317557
|
+
"name": {
|
|
317558
|
+
"type": "string"
|
|
317559
|
+
}
|
|
317560
|
+
},
|
|
317561
|
+
"required": [
|
|
317562
|
+
"id",
|
|
317563
|
+
"handle",
|
|
317564
|
+
"name"
|
|
317565
|
+
],
|
|
317566
|
+
"additionalProperties": false
|
|
317567
|
+
},
|
|
317568
|
+
"meta": {
|
|
317569
|
+
"type": "object",
|
|
317570
|
+
"properties": {
|
|
317571
|
+
"installs": {
|
|
317572
|
+
"type": "number"
|
|
317573
|
+
},
|
|
317574
|
+
"views": {
|
|
317575
|
+
"type": "number"
|
|
317576
|
+
}
|
|
317577
|
+
},
|
|
317578
|
+
"required": [
|
|
317579
|
+
"installs",
|
|
317580
|
+
"views"
|
|
317581
|
+
],
|
|
317582
|
+
"additionalProperties": false
|
|
315947
317583
|
}
|
|
315948
317584
|
},
|
|
317585
|
+
"required": [
|
|
317586
|
+
"id",
|
|
317587
|
+
"createdAt",
|
|
317588
|
+
"updatedAt",
|
|
317589
|
+
"identifier",
|
|
317590
|
+
"url",
|
|
317591
|
+
"name",
|
|
317592
|
+
"version",
|
|
317593
|
+
"interfaces",
|
|
317594
|
+
"configuration",
|
|
317595
|
+
"configurations",
|
|
317596
|
+
"channels",
|
|
317597
|
+
"states",
|
|
317598
|
+
"events",
|
|
317599
|
+
"actions",
|
|
317600
|
+
"user",
|
|
317601
|
+
"entities",
|
|
317602
|
+
"dev",
|
|
317603
|
+
"title",
|
|
317604
|
+
"description",
|
|
317605
|
+
"iconUrl",
|
|
317606
|
+
"readmeUrl",
|
|
317607
|
+
"public",
|
|
317608
|
+
"verificationStatus",
|
|
317609
|
+
"secrets",
|
|
317610
|
+
"ownerWorkspace",
|
|
317611
|
+
"meta"
|
|
317612
|
+
],
|
|
315949
317613
|
"additionalProperties": false
|
|
315950
317614
|
}
|
|
315951
317615
|
},
|
|
315952
317616
|
"required": [
|
|
315953
|
-
"
|
|
315954
|
-
"meta"
|
|
317617
|
+
"integration"
|
|
315955
317618
|
],
|
|
315956
|
-
"title": "
|
|
317619
|
+
"title": "getPublicIntegrationByIdResponse",
|
|
315957
317620
|
"additionalProperties": false
|
|
315958
317621
|
}
|
|
315959
317622
|
}
|
|
315960
317623
|
},
|
|
315961
|
-
"
|
|
315962
|
-
"name": "
|
|
315963
|
-
"description": "Get public integration by
|
|
317624
|
+
"getPublicIntegration": {
|
|
317625
|
+
"name": "getPublicIntegration",
|
|
317626
|
+
"description": "Get public integration by name and version",
|
|
315964
317627
|
"method": "get",
|
|
315965
317628
|
"section": "hub",
|
|
315966
|
-
"path": "/v1/admin/hub/integrations/{
|
|
317629
|
+
"path": "/v1/admin/hub/integrations/{name}/{version}",
|
|
315967
317630
|
"disableDefaultParameters": {
|
|
315968
317631
|
"x-workspace-id": true
|
|
315969
317632
|
},
|
|
315970
317633
|
"parameters": {
|
|
315971
|
-
"
|
|
317634
|
+
"name": {
|
|
315972
317635
|
"type": "string",
|
|
315973
|
-
"description": "Integration
|
|
317636
|
+
"description": "Integration Name",
|
|
317637
|
+
"in": "path"
|
|
317638
|
+
},
|
|
317639
|
+
"version": {
|
|
317640
|
+
"type": "string",
|
|
317641
|
+
"description": 'Integration version. Either a semver version or tag "latest"',
|
|
315974
317642
|
"in": "path"
|
|
315975
317643
|
}
|
|
315976
317644
|
},
|
|
@@ -316574,7 +318242,7 @@ var state5 = {
|
|
|
316574
318242
|
},
|
|
316575
318243
|
"public": {
|
|
316576
318244
|
"type": "boolean",
|
|
316577
|
-
"description": "
|
|
318245
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
316578
318246
|
},
|
|
316579
318247
|
"verificationStatus": {
|
|
316580
318248
|
"type": "string",
|
|
@@ -316607,87 +318275,202 @@ var state5 = {
|
|
|
316607
318275
|
"type": "string"
|
|
316608
318276
|
}
|
|
316609
318277
|
},
|
|
316610
|
-
"required": [
|
|
316611
|
-
"id",
|
|
316612
|
-
"handle",
|
|
316613
|
-
"name"
|
|
316614
|
-
],
|
|
316615
|
-
"additionalProperties": false
|
|
316616
|
-
},
|
|
316617
|
-
"meta": {
|
|
316618
|
-
"type": "object",
|
|
316619
|
-
"properties": {
|
|
316620
|
-
"installs": {
|
|
316621
|
-
"type": "number"
|
|
316622
|
-
},
|
|
316623
|
-
"views": {
|
|
316624
|
-
"type": "number"
|
|
316625
|
-
}
|
|
318278
|
+
"required": [
|
|
318279
|
+
"id",
|
|
318280
|
+
"handle",
|
|
318281
|
+
"name"
|
|
318282
|
+
],
|
|
318283
|
+
"additionalProperties": false
|
|
318284
|
+
},
|
|
318285
|
+
"meta": {
|
|
318286
|
+
"type": "object",
|
|
318287
|
+
"properties": {
|
|
318288
|
+
"installs": {
|
|
318289
|
+
"type": "number"
|
|
318290
|
+
},
|
|
318291
|
+
"views": {
|
|
318292
|
+
"type": "number"
|
|
318293
|
+
}
|
|
318294
|
+
},
|
|
318295
|
+
"required": [
|
|
318296
|
+
"installs",
|
|
318297
|
+
"views"
|
|
318298
|
+
],
|
|
318299
|
+
"additionalProperties": false
|
|
318300
|
+
}
|
|
318301
|
+
},
|
|
318302
|
+
"required": [
|
|
318303
|
+
"id",
|
|
318304
|
+
"createdAt",
|
|
318305
|
+
"updatedAt",
|
|
318306
|
+
"identifier",
|
|
318307
|
+
"url",
|
|
318308
|
+
"name",
|
|
318309
|
+
"version",
|
|
318310
|
+
"interfaces",
|
|
318311
|
+
"configuration",
|
|
318312
|
+
"configurations",
|
|
318313
|
+
"channels",
|
|
318314
|
+
"states",
|
|
318315
|
+
"events",
|
|
318316
|
+
"actions",
|
|
318317
|
+
"user",
|
|
318318
|
+
"entities",
|
|
318319
|
+
"dev",
|
|
318320
|
+
"title",
|
|
318321
|
+
"description",
|
|
318322
|
+
"iconUrl",
|
|
318323
|
+
"readmeUrl",
|
|
318324
|
+
"public",
|
|
318325
|
+
"verificationStatus",
|
|
318326
|
+
"secrets",
|
|
318327
|
+
"ownerWorkspace",
|
|
318328
|
+
"meta"
|
|
318329
|
+
],
|
|
318330
|
+
"additionalProperties": false
|
|
318331
|
+
}
|
|
318332
|
+
},
|
|
318333
|
+
"required": [
|
|
318334
|
+
"integration"
|
|
318335
|
+
],
|
|
318336
|
+
"title": "getPublicIntegrationResponse",
|
|
318337
|
+
"additionalProperties": false
|
|
318338
|
+
}
|
|
318339
|
+
}
|
|
318340
|
+
},
|
|
318341
|
+
"listPublicPlugins": {
|
|
318342
|
+
"name": "listPublicPlugins",
|
|
318343
|
+
"description": "List public plugin",
|
|
318344
|
+
"method": "get",
|
|
318345
|
+
"section": "hub",
|
|
318346
|
+
"path": "/v1/admin/hub/plugins",
|
|
318347
|
+
"disableDefaultParameters": {
|
|
318348
|
+
"x-workspace-id": true
|
|
318349
|
+
},
|
|
318350
|
+
"parameters": {
|
|
318351
|
+
"nextToken": {
|
|
318352
|
+
"in": "query",
|
|
318353
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
318354
|
+
"type": "string"
|
|
318355
|
+
},
|
|
318356
|
+
"name": {
|
|
318357
|
+
"in": "query",
|
|
318358
|
+
"type": "string",
|
|
318359
|
+
"description": "Filter all versions of a plugin by name"
|
|
318360
|
+
},
|
|
318361
|
+
"version": {
|
|
318362
|
+
"in": "query",
|
|
318363
|
+
"type": "string",
|
|
318364
|
+
"description": "Filter a plugin by name and version"
|
|
318365
|
+
}
|
|
318366
|
+
},
|
|
318367
|
+
"response": {
|
|
318368
|
+
"description": "Success",
|
|
318369
|
+
"schema": {
|
|
318370
|
+
"type": "object",
|
|
318371
|
+
"properties": {
|
|
318372
|
+
"plugins": {
|
|
318373
|
+
"type": "array",
|
|
318374
|
+
"items": {
|
|
318375
|
+
"type": "object",
|
|
318376
|
+
"properties": {
|
|
318377
|
+
"id": {
|
|
318378
|
+
"type": "string",
|
|
318379
|
+
"minLength": 28,
|
|
318380
|
+
"maxLength": 36,
|
|
318381
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
318382
|
+
},
|
|
318383
|
+
"createdAt": {
|
|
318384
|
+
"type": "string",
|
|
318385
|
+
"format": "date-time",
|
|
318386
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
318387
|
+
},
|
|
318388
|
+
"updatedAt": {
|
|
318389
|
+
"type": "string",
|
|
318390
|
+
"format": "date-time",
|
|
318391
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
318392
|
+
},
|
|
318393
|
+
"name": {
|
|
318394
|
+
"type": "string",
|
|
318395
|
+
"maxLength": 200,
|
|
318396
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
318397
|
+
},
|
|
318398
|
+
"version": {
|
|
318399
|
+
"type": "string",
|
|
318400
|
+
"maxLength": 200,
|
|
318401
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
318402
|
+
},
|
|
318403
|
+
"title": {
|
|
318404
|
+
"type": "string",
|
|
318405
|
+
"minLength": 1,
|
|
318406
|
+
"maxLength": 64,
|
|
318407
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
318408
|
+
},
|
|
318409
|
+
"description": {
|
|
318410
|
+
"type": "string",
|
|
318411
|
+
"maxLength": 256,
|
|
318412
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
318413
|
+
},
|
|
318414
|
+
"iconUrl": {
|
|
318415
|
+
"type": "string",
|
|
318416
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
318417
|
+
},
|
|
318418
|
+
"readmeUrl": {
|
|
318419
|
+
"type": "string",
|
|
318420
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
316626
318421
|
},
|
|
316627
|
-
"
|
|
316628
|
-
"
|
|
316629
|
-
"
|
|
316630
|
-
|
|
316631
|
-
|
|
318422
|
+
"public": {
|
|
318423
|
+
"type": "boolean",
|
|
318424
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
318425
|
+
}
|
|
318426
|
+
},
|
|
318427
|
+
"required": [
|
|
318428
|
+
"id",
|
|
318429
|
+
"createdAt",
|
|
318430
|
+
"updatedAt",
|
|
318431
|
+
"name",
|
|
318432
|
+
"version",
|
|
318433
|
+
"title",
|
|
318434
|
+
"description",
|
|
318435
|
+
"iconUrl",
|
|
318436
|
+
"readmeUrl",
|
|
318437
|
+
"public"
|
|
318438
|
+
]
|
|
318439
|
+
}
|
|
318440
|
+
},
|
|
318441
|
+
"meta": {
|
|
318442
|
+
"type": "object",
|
|
318443
|
+
"properties": {
|
|
318444
|
+
"nextToken": {
|
|
318445
|
+
"type": "string",
|
|
318446
|
+
"description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
|
|
316632
318447
|
}
|
|
316633
318448
|
},
|
|
316634
|
-
"required": [
|
|
316635
|
-
"id",
|
|
316636
|
-
"createdAt",
|
|
316637
|
-
"updatedAt",
|
|
316638
|
-
"identifier",
|
|
316639
|
-
"url",
|
|
316640
|
-
"name",
|
|
316641
|
-
"version",
|
|
316642
|
-
"interfaces",
|
|
316643
|
-
"configuration",
|
|
316644
|
-
"configurations",
|
|
316645
|
-
"channels",
|
|
316646
|
-
"states",
|
|
316647
|
-
"events",
|
|
316648
|
-
"actions",
|
|
316649
|
-
"user",
|
|
316650
|
-
"entities",
|
|
316651
|
-
"dev",
|
|
316652
|
-
"title",
|
|
316653
|
-
"description",
|
|
316654
|
-
"iconUrl",
|
|
316655
|
-
"readmeUrl",
|
|
316656
|
-
"public",
|
|
316657
|
-
"verificationStatus",
|
|
316658
|
-
"secrets",
|
|
316659
|
-
"ownerWorkspace",
|
|
316660
|
-
"meta"
|
|
316661
|
-
],
|
|
316662
318449
|
"additionalProperties": false
|
|
316663
318450
|
}
|
|
316664
318451
|
},
|
|
316665
318452
|
"required": [
|
|
316666
|
-
"
|
|
318453
|
+
"plugins",
|
|
318454
|
+
"meta"
|
|
316667
318455
|
],
|
|
316668
|
-
"title": "
|
|
318456
|
+
"title": "listPublicPluginsResponse",
|
|
316669
318457
|
"additionalProperties": false
|
|
316670
318458
|
}
|
|
316671
318459
|
}
|
|
316672
318460
|
},
|
|
316673
|
-
"
|
|
316674
|
-
"name": "
|
|
316675
|
-
"description": "Get public
|
|
318461
|
+
"getPublicPluginById": {
|
|
318462
|
+
"name": "getPublicPluginById",
|
|
318463
|
+
"description": "Get public plugin by Id",
|
|
316676
318464
|
"method": "get",
|
|
316677
318465
|
"section": "hub",
|
|
316678
|
-
"path": "/v1/admin/hub/
|
|
318466
|
+
"path": "/v1/admin/hub/plugins/{id}",
|
|
316679
318467
|
"disableDefaultParameters": {
|
|
316680
318468
|
"x-workspace-id": true
|
|
316681
318469
|
},
|
|
316682
318470
|
"parameters": {
|
|
316683
|
-
"
|
|
316684
|
-
"type": "string",
|
|
316685
|
-
"description": "Integration Name",
|
|
316686
|
-
"in": "path"
|
|
316687
|
-
},
|
|
316688
|
-
"version": {
|
|
318471
|
+
"id": {
|
|
316689
318472
|
"type": "string",
|
|
316690
|
-
"description":
|
|
318473
|
+
"description": "Plugin ID",
|
|
316691
318474
|
"in": "path"
|
|
316692
318475
|
}
|
|
316693
318476
|
},
|
|
@@ -316696,170 +318479,34 @@ var state5 = {
|
|
|
316696
318479
|
"schema": {
|
|
316697
318480
|
"type": "object",
|
|
316698
318481
|
"properties": {
|
|
316699
|
-
"
|
|
318482
|
+
"plugin": {
|
|
316700
318483
|
"type": "object",
|
|
316701
318484
|
"properties": {
|
|
316702
318485
|
"id": {
|
|
316703
318486
|
"type": "string",
|
|
316704
318487
|
"minLength": 28,
|
|
316705
318488
|
"maxLength": 36,
|
|
316706
|
-
"description": "ID of the [
|
|
316707
|
-
},
|
|
316708
|
-
"createdAt": {
|
|
316709
|
-
"type": "string",
|
|
316710
|
-
"format": "date-time",
|
|
316711
|
-
"description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
316712
|
-
},
|
|
316713
|
-
"updatedAt": {
|
|
316714
|
-
"type": "string",
|
|
316715
|
-
"format": "date-time",
|
|
316716
|
-
"description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
316717
|
-
},
|
|
316718
|
-
"identifier": {
|
|
316719
|
-
"type": "object",
|
|
316720
|
-
"properties": {
|
|
316721
|
-
"fallbackHandlerScript": {
|
|
316722
|
-
"type": "string",
|
|
316723
|
-
"maxLength": 2e3,
|
|
316724
|
-
"description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
|
|
316725
|
-
},
|
|
316726
|
-
"extractScript": {
|
|
316727
|
-
"type": "string",
|
|
316728
|
-
"maxLength": 2e3,
|
|
316729
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
|
|
316730
|
-
}
|
|
316731
|
-
},
|
|
316732
|
-
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
316733
|
-
"additionalProperties": false
|
|
316734
|
-
},
|
|
316735
|
-
"sandbox": {
|
|
316736
|
-
"type": "object",
|
|
316737
|
-
"properties": {
|
|
316738
|
-
"identifierExtractScript": {
|
|
316739
|
-
"type": "string",
|
|
316740
|
-
"maxLength": 2e3,
|
|
316741
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
|
|
316742
|
-
},
|
|
316743
|
-
"messageExtractScript": {
|
|
316744
|
-
"type": "string",
|
|
316745
|
-
"maxLength": 2e3,
|
|
316746
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
|
|
316747
|
-
}
|
|
316748
|
-
},
|
|
316749
|
-
"additionalProperties": false
|
|
316750
|
-
},
|
|
316751
|
-
"url": {
|
|
316752
|
-
"type": "string",
|
|
316753
|
-
"maxLength": 2e3,
|
|
316754
|
-
"description": "URL of the [Integration](#schema_integration)"
|
|
318489
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
316755
318490
|
},
|
|
316756
318491
|
"name": {
|
|
316757
318492
|
"type": "string",
|
|
316758
318493
|
"maxLength": 200,
|
|
316759
|
-
"description": "Name of the [
|
|
318494
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
316760
318495
|
},
|
|
316761
318496
|
"version": {
|
|
316762
318497
|
"type": "string",
|
|
316763
318498
|
"maxLength": 200,
|
|
316764
|
-
"description": "Version of the [
|
|
318499
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
316765
318500
|
},
|
|
316766
|
-
"
|
|
316767
|
-
"type": "
|
|
316768
|
-
"
|
|
316769
|
-
|
|
316770
|
-
|
|
316771
|
-
|
|
316772
|
-
|
|
316773
|
-
|
|
316774
|
-
|
|
316775
|
-
"description": "ID of the interface"
|
|
316776
|
-
},
|
|
316777
|
-
"name": {
|
|
316778
|
-
"type": "string",
|
|
316779
|
-
"maxLength": 200,
|
|
316780
|
-
"description": "Name of the interface"
|
|
316781
|
-
},
|
|
316782
|
-
"version": {
|
|
316783
|
-
"type": "string",
|
|
316784
|
-
"maxLength": 200,
|
|
316785
|
-
"description": "Version of the interface"
|
|
316786
|
-
},
|
|
316787
|
-
"entities": {
|
|
316788
|
-
"type": "object",
|
|
316789
|
-
"additionalProperties": {
|
|
316790
|
-
"type": "object",
|
|
316791
|
-
"properties": {
|
|
316792
|
-
"name": {
|
|
316793
|
-
"type": "string",
|
|
316794
|
-
"maxLength": 200
|
|
316795
|
-
}
|
|
316796
|
-
},
|
|
316797
|
-
"required": [
|
|
316798
|
-
"name"
|
|
316799
|
-
],
|
|
316800
|
-
"additionalProperties": false
|
|
316801
|
-
}
|
|
316802
|
-
},
|
|
316803
|
-
"actions": {
|
|
316804
|
-
"type": "object",
|
|
316805
|
-
"additionalProperties": {
|
|
316806
|
-
"type": "object",
|
|
316807
|
-
"properties": {
|
|
316808
|
-
"name": {
|
|
316809
|
-
"type": "string",
|
|
316810
|
-
"maxLength": 200
|
|
316811
|
-
}
|
|
316812
|
-
},
|
|
316813
|
-
"required": [
|
|
316814
|
-
"name"
|
|
316815
|
-
],
|
|
316816
|
-
"additionalProperties": false
|
|
316817
|
-
}
|
|
316818
|
-
},
|
|
316819
|
-
"events": {
|
|
316820
|
-
"type": "object",
|
|
316821
|
-
"additionalProperties": {
|
|
316822
|
-
"type": "object",
|
|
316823
|
-
"properties": {
|
|
316824
|
-
"name": {
|
|
316825
|
-
"type": "string",
|
|
316826
|
-
"maxLength": 200
|
|
316827
|
-
}
|
|
316828
|
-
},
|
|
316829
|
-
"required": [
|
|
316830
|
-
"name"
|
|
316831
|
-
],
|
|
316832
|
-
"additionalProperties": false
|
|
316833
|
-
}
|
|
316834
|
-
},
|
|
316835
|
-
"channels": {
|
|
316836
|
-
"type": "object",
|
|
316837
|
-
"additionalProperties": {
|
|
316838
|
-
"type": "object",
|
|
316839
|
-
"properties": {
|
|
316840
|
-
"name": {
|
|
316841
|
-
"type": "string",
|
|
316842
|
-
"maxLength": 200
|
|
316843
|
-
}
|
|
316844
|
-
},
|
|
316845
|
-
"required": [
|
|
316846
|
-
"name"
|
|
316847
|
-
],
|
|
316848
|
-
"additionalProperties": false
|
|
316849
|
-
}
|
|
316850
|
-
}
|
|
316851
|
-
},
|
|
316852
|
-
"required": [
|
|
316853
|
-
"id",
|
|
316854
|
-
"name",
|
|
316855
|
-
"version",
|
|
316856
|
-
"entities",
|
|
316857
|
-
"actions",
|
|
316858
|
-
"events",
|
|
316859
|
-
"channels"
|
|
316860
|
-
],
|
|
316861
|
-
"additionalProperties": false
|
|
316862
|
-
}
|
|
318501
|
+
"createdAt": {
|
|
318502
|
+
"type": "string",
|
|
318503
|
+
"format": "date-time",
|
|
318504
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
318505
|
+
},
|
|
318506
|
+
"updatedAt": {
|
|
318507
|
+
"type": "string",
|
|
318508
|
+
"format": "date-time",
|
|
318509
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
316863
318510
|
},
|
|
316864
318511
|
"configuration": {
|
|
316865
318512
|
"type": "object",
|
|
@@ -316874,23 +318521,6 @@ var state5 = {
|
|
|
316874
318521
|
"maxLength": 256,
|
|
316875
318522
|
"description": "Description of the configuration"
|
|
316876
318523
|
},
|
|
316877
|
-
"identifier": {
|
|
316878
|
-
"type": "object",
|
|
316879
|
-
"properties": {
|
|
316880
|
-
"linkTemplateScript": {
|
|
316881
|
-
"type": "string",
|
|
316882
|
-
"maxLength": 2e3
|
|
316883
|
-
},
|
|
316884
|
-
"required": {
|
|
316885
|
-
"type": "boolean"
|
|
316886
|
-
}
|
|
316887
|
-
},
|
|
316888
|
-
"required": [
|
|
316889
|
-
"required"
|
|
316890
|
-
],
|
|
316891
|
-
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
316892
|
-
"additionalProperties": false
|
|
316893
|
-
},
|
|
316894
318524
|
"schema": {
|
|
316895
318525
|
"type": "object",
|
|
316896
318526
|
"additionalProperties": true,
|
|
@@ -316898,183 +318528,11 @@ var state5 = {
|
|
|
316898
318528
|
}
|
|
316899
318529
|
},
|
|
316900
318530
|
"required": [
|
|
316901
|
-
"identifier",
|
|
316902
318531
|
"schema"
|
|
316903
318532
|
],
|
|
316904
318533
|
"description": "Configuration definition",
|
|
316905
318534
|
"additionalProperties": false
|
|
316906
318535
|
},
|
|
316907
|
-
"configurations": {
|
|
316908
|
-
"type": "object",
|
|
316909
|
-
"additionalProperties": {
|
|
316910
|
-
"type": "object",
|
|
316911
|
-
"properties": {
|
|
316912
|
-
"title": {
|
|
316913
|
-
"type": "string",
|
|
316914
|
-
"maxLength": 64,
|
|
316915
|
-
"description": "Title of the configuration"
|
|
316916
|
-
},
|
|
316917
|
-
"description": {
|
|
316918
|
-
"type": "string",
|
|
316919
|
-
"maxLength": 256,
|
|
316920
|
-
"description": "Description of the configuration"
|
|
316921
|
-
},
|
|
316922
|
-
"identifier": {
|
|
316923
|
-
"type": "object",
|
|
316924
|
-
"properties": {
|
|
316925
|
-
"linkTemplateScript": {
|
|
316926
|
-
"type": "string",
|
|
316927
|
-
"maxLength": 2e3
|
|
316928
|
-
},
|
|
316929
|
-
"required": {
|
|
316930
|
-
"type": "boolean"
|
|
316931
|
-
}
|
|
316932
|
-
},
|
|
316933
|
-
"required": [
|
|
316934
|
-
"required"
|
|
316935
|
-
],
|
|
316936
|
-
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
316937
|
-
"additionalProperties": false
|
|
316938
|
-
},
|
|
316939
|
-
"schema": {
|
|
316940
|
-
"type": "object",
|
|
316941
|
-
"additionalProperties": true,
|
|
316942
|
-
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
316943
|
-
}
|
|
316944
|
-
},
|
|
316945
|
-
"required": [
|
|
316946
|
-
"identifier",
|
|
316947
|
-
"schema"
|
|
316948
|
-
],
|
|
316949
|
-
"description": "Configuration definition",
|
|
316950
|
-
"additionalProperties": false
|
|
316951
|
-
}
|
|
316952
|
-
},
|
|
316953
|
-
"channels": {
|
|
316954
|
-
"type": "object",
|
|
316955
|
-
"additionalProperties": {
|
|
316956
|
-
"type": "object",
|
|
316957
|
-
"properties": {
|
|
316958
|
-
"title": {
|
|
316959
|
-
"type": "string",
|
|
316960
|
-
"maxLength": 64,
|
|
316961
|
-
"description": "Title of the channel"
|
|
316962
|
-
},
|
|
316963
|
-
"description": {
|
|
316964
|
-
"type": "string",
|
|
316965
|
-
"maxLength": 256,
|
|
316966
|
-
"description": "Description of the channel"
|
|
316967
|
-
},
|
|
316968
|
-
"messages": {
|
|
316969
|
-
"type": "object",
|
|
316970
|
-
"additionalProperties": {
|
|
316971
|
-
"type": "object",
|
|
316972
|
-
"properties": {
|
|
316973
|
-
"schema": {
|
|
316974
|
-
"type": "object",
|
|
316975
|
-
"additionalProperties": true
|
|
316976
|
-
}
|
|
316977
|
-
},
|
|
316978
|
-
"required": [
|
|
316979
|
-
"schema"
|
|
316980
|
-
],
|
|
316981
|
-
"description": "Message definition",
|
|
316982
|
-
"additionalProperties": false
|
|
316983
|
-
}
|
|
316984
|
-
},
|
|
316985
|
-
"conversation": {
|
|
316986
|
-
"type": "object",
|
|
316987
|
-
"properties": {
|
|
316988
|
-
"tags": {
|
|
316989
|
-
"type": "object",
|
|
316990
|
-
"additionalProperties": {
|
|
316991
|
-
"type": "object",
|
|
316992
|
-
"properties": {
|
|
316993
|
-
"title": {
|
|
316994
|
-
"type": "string",
|
|
316995
|
-
"maxLength": 64,
|
|
316996
|
-
"description": "Title of the tag"
|
|
316997
|
-
},
|
|
316998
|
-
"description": {
|
|
316999
|
-
"type": "string",
|
|
317000
|
-
"maxLength": 256,
|
|
317001
|
-
"description": "Description of the tag"
|
|
317002
|
-
}
|
|
317003
|
-
},
|
|
317004
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
317005
|
-
"additionalProperties": false
|
|
317006
|
-
}
|
|
317007
|
-
},
|
|
317008
|
-
"creation": {
|
|
317009
|
-
"type": "object",
|
|
317010
|
-
"properties": {
|
|
317011
|
-
"enabled": {
|
|
317012
|
-
"type": "boolean",
|
|
317013
|
-
"description": "Enable conversation creation"
|
|
317014
|
-
},
|
|
317015
|
-
"requiredTags": {
|
|
317016
|
-
"type": "array",
|
|
317017
|
-
"items": {
|
|
317018
|
-
"type": "string"
|
|
317019
|
-
},
|
|
317020
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
317021
|
-
}
|
|
317022
|
-
},
|
|
317023
|
-
"required": [
|
|
317024
|
-
"enabled",
|
|
317025
|
-
"requiredTags"
|
|
317026
|
-
],
|
|
317027
|
-
"description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
|
|
317028
|
-
"additionalProperties": false
|
|
317029
|
-
}
|
|
317030
|
-
},
|
|
317031
|
-
"required": [
|
|
317032
|
-
"tags",
|
|
317033
|
-
"creation"
|
|
317034
|
-
],
|
|
317035
|
-
"description": "Conversation object configuration",
|
|
317036
|
-
"additionalProperties": false
|
|
317037
|
-
},
|
|
317038
|
-
"message": {
|
|
317039
|
-
"type": "object",
|
|
317040
|
-
"properties": {
|
|
317041
|
-
"tags": {
|
|
317042
|
-
"type": "object",
|
|
317043
|
-
"additionalProperties": {
|
|
317044
|
-
"type": "object",
|
|
317045
|
-
"properties": {
|
|
317046
|
-
"title": {
|
|
317047
|
-
"type": "string",
|
|
317048
|
-
"maxLength": 64,
|
|
317049
|
-
"description": "Title of the tag"
|
|
317050
|
-
},
|
|
317051
|
-
"description": {
|
|
317052
|
-
"type": "string",
|
|
317053
|
-
"maxLength": 256,
|
|
317054
|
-
"description": "Description of the tag"
|
|
317055
|
-
}
|
|
317056
|
-
},
|
|
317057
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
317058
|
-
"additionalProperties": false
|
|
317059
|
-
}
|
|
317060
|
-
}
|
|
317061
|
-
},
|
|
317062
|
-
"required": [
|
|
317063
|
-
"tags"
|
|
317064
|
-
],
|
|
317065
|
-
"description": "Message object configuration",
|
|
317066
|
-
"additionalProperties": false
|
|
317067
|
-
}
|
|
317068
|
-
},
|
|
317069
|
-
"required": [
|
|
317070
|
-
"messages",
|
|
317071
|
-
"conversation",
|
|
317072
|
-
"message"
|
|
317073
|
-
],
|
|
317074
|
-
"description": "Channel definition",
|
|
317075
|
-
"additionalProperties": false
|
|
317076
|
-
}
|
|
317077
|
-
},
|
|
317078
318536
|
"states": {
|
|
317079
318537
|
"type": "object",
|
|
317080
318538
|
"additionalProperties": {
|
|
@@ -317085,21 +318543,26 @@ var state5 = {
|
|
|
317085
318543
|
"enum": [
|
|
317086
318544
|
"conversation",
|
|
317087
318545
|
"user",
|
|
317088
|
-
"
|
|
318546
|
+
"bot",
|
|
318547
|
+
"task"
|
|
317089
318548
|
],
|
|
317090
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
318549
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
317091
318550
|
},
|
|
317092
318551
|
"schema": {
|
|
317093
318552
|
"type": "object",
|
|
317094
318553
|
"additionalProperties": true,
|
|
317095
318554
|
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
318555
|
+
},
|
|
318556
|
+
"expiry": {
|
|
318557
|
+
"type": "number",
|
|
318558
|
+
"minimum": 1,
|
|
318559
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
317096
318560
|
}
|
|
317097
318561
|
},
|
|
317098
318562
|
"required": [
|
|
317099
318563
|
"type",
|
|
317100
318564
|
"schema"
|
|
317101
318565
|
],
|
|
317102
|
-
"description": "State definition",
|
|
317103
318566
|
"additionalProperties": false
|
|
317104
318567
|
}
|
|
317105
318568
|
},
|
|
@@ -317186,6 +318649,70 @@ var state5 = {
|
|
|
317186
318649
|
"additionalProperties": false
|
|
317187
318650
|
}
|
|
317188
318651
|
},
|
|
318652
|
+
"dependencies": {
|
|
318653
|
+
"type": "object",
|
|
318654
|
+
"properties": {
|
|
318655
|
+
"interfaces": {
|
|
318656
|
+
"type": "object",
|
|
318657
|
+
"additionalProperties": {
|
|
318658
|
+
"type": "object",
|
|
318659
|
+
"properties": {
|
|
318660
|
+
"id": {
|
|
318661
|
+
"type": "string",
|
|
318662
|
+
"minLength": 28,
|
|
318663
|
+
"maxLength": 36
|
|
318664
|
+
},
|
|
318665
|
+
"name": {
|
|
318666
|
+
"type": "string",
|
|
318667
|
+
"maxLength": 200
|
|
318668
|
+
},
|
|
318669
|
+
"version": {
|
|
318670
|
+
"type": "string",
|
|
318671
|
+
"maxLength": 200
|
|
318672
|
+
}
|
|
318673
|
+
},
|
|
318674
|
+
"required": [
|
|
318675
|
+
"id",
|
|
318676
|
+
"name",
|
|
318677
|
+
"version"
|
|
318678
|
+
],
|
|
318679
|
+
"additionalProperties": false
|
|
318680
|
+
}
|
|
318681
|
+
},
|
|
318682
|
+
"integrations": {
|
|
318683
|
+
"type": "object",
|
|
318684
|
+
"additionalProperties": {
|
|
318685
|
+
"type": "object",
|
|
318686
|
+
"properties": {
|
|
318687
|
+
"id": {
|
|
318688
|
+
"type": "string",
|
|
318689
|
+
"minLength": 28,
|
|
318690
|
+
"maxLength": 36
|
|
318691
|
+
},
|
|
318692
|
+
"name": {
|
|
318693
|
+
"type": "string",
|
|
318694
|
+
"maxLength": 200
|
|
318695
|
+
},
|
|
318696
|
+
"version": {
|
|
318697
|
+
"type": "string",
|
|
318698
|
+
"maxLength": 200
|
|
318699
|
+
}
|
|
318700
|
+
},
|
|
318701
|
+
"required": [
|
|
318702
|
+
"id",
|
|
318703
|
+
"name",
|
|
318704
|
+
"version"
|
|
318705
|
+
],
|
|
318706
|
+
"additionalProperties": false
|
|
318707
|
+
}
|
|
318708
|
+
}
|
|
318709
|
+
},
|
|
318710
|
+
"required": [
|
|
318711
|
+
"interfaces",
|
|
318712
|
+
"integrations"
|
|
318713
|
+
],
|
|
318714
|
+
"additionalProperties": false
|
|
318715
|
+
},
|
|
317189
318716
|
"user": {
|
|
317190
318717
|
"type": "object",
|
|
317191
318718
|
"properties": {
|
|
@@ -317208,38 +318735,212 @@ var state5 = {
|
|
|
317208
318735
|
"description": "Definition of a tag that can be provided on the object",
|
|
317209
318736
|
"additionalProperties": false
|
|
317210
318737
|
}
|
|
318738
|
+
}
|
|
318739
|
+
},
|
|
318740
|
+
"required": [
|
|
318741
|
+
"tags"
|
|
318742
|
+
],
|
|
318743
|
+
"description": "User object configuration",
|
|
318744
|
+
"additionalProperties": false
|
|
318745
|
+
},
|
|
318746
|
+
"conversation": {
|
|
318747
|
+
"type": "object",
|
|
318748
|
+
"properties": {
|
|
318749
|
+
"tags": {
|
|
318750
|
+
"type": "object",
|
|
318751
|
+
"additionalProperties": {
|
|
318752
|
+
"type": "object",
|
|
318753
|
+
"properties": {
|
|
318754
|
+
"title": {
|
|
318755
|
+
"type": "string",
|
|
318756
|
+
"maxLength": 64,
|
|
318757
|
+
"description": "Title of the tag"
|
|
318758
|
+
},
|
|
318759
|
+
"description": {
|
|
318760
|
+
"type": "string",
|
|
318761
|
+
"maxLength": 256,
|
|
318762
|
+
"description": "Description of the tag"
|
|
318763
|
+
}
|
|
318764
|
+
},
|
|
318765
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
318766
|
+
"additionalProperties": false
|
|
318767
|
+
}
|
|
318768
|
+
}
|
|
318769
|
+
},
|
|
318770
|
+
"required": [
|
|
318771
|
+
"tags"
|
|
318772
|
+
],
|
|
318773
|
+
"description": "Conversation object configuration",
|
|
318774
|
+
"additionalProperties": false
|
|
318775
|
+
},
|
|
318776
|
+
"title": {
|
|
318777
|
+
"type": "string",
|
|
318778
|
+
"minLength": 1,
|
|
318779
|
+
"maxLength": 64,
|
|
318780
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
318781
|
+
},
|
|
318782
|
+
"description": {
|
|
318783
|
+
"type": "string",
|
|
318784
|
+
"maxLength": 256,
|
|
318785
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
318786
|
+
},
|
|
318787
|
+
"iconUrl": {
|
|
318788
|
+
"type": "string",
|
|
318789
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
318790
|
+
},
|
|
318791
|
+
"readmeUrl": {
|
|
318792
|
+
"type": "string",
|
|
318793
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
318794
|
+
},
|
|
318795
|
+
"public": {
|
|
318796
|
+
"type": "boolean",
|
|
318797
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
318798
|
+
}
|
|
318799
|
+
},
|
|
318800
|
+
"required": [
|
|
318801
|
+
"id",
|
|
318802
|
+
"name",
|
|
318803
|
+
"version",
|
|
318804
|
+
"createdAt",
|
|
318805
|
+
"updatedAt",
|
|
318806
|
+
"configuration",
|
|
318807
|
+
"states",
|
|
318808
|
+
"events",
|
|
318809
|
+
"actions",
|
|
318810
|
+
"dependencies",
|
|
318811
|
+
"user",
|
|
318812
|
+
"conversation",
|
|
318813
|
+
"title",
|
|
318814
|
+
"description",
|
|
318815
|
+
"iconUrl",
|
|
318816
|
+
"readmeUrl",
|
|
318817
|
+
"public"
|
|
318818
|
+
],
|
|
318819
|
+
"additionalProperties": false
|
|
318820
|
+
}
|
|
318821
|
+
},
|
|
318822
|
+
"required": [
|
|
318823
|
+
"plugin"
|
|
318824
|
+
],
|
|
318825
|
+
"title": "getPublicPluginByIdResponse",
|
|
318826
|
+
"additionalProperties": false
|
|
318827
|
+
}
|
|
318828
|
+
}
|
|
318829
|
+
},
|
|
318830
|
+
"getPublicPlugin": {
|
|
318831
|
+
"name": "getPublicPlugin",
|
|
318832
|
+
"description": "Get public plugin by name and version",
|
|
318833
|
+
"method": "get",
|
|
318834
|
+
"section": "hub",
|
|
318835
|
+
"path": "/v1/admin/hub/plugins/{name}/{version}",
|
|
318836
|
+
"disableDefaultParameters": {
|
|
318837
|
+
"x-workspace-id": true
|
|
318838
|
+
},
|
|
318839
|
+
"parameters": {
|
|
318840
|
+
"name": {
|
|
318841
|
+
"type": "string",
|
|
318842
|
+
"description": "Plugin Name",
|
|
318843
|
+
"in": "path"
|
|
318844
|
+
},
|
|
318845
|
+
"version": {
|
|
318846
|
+
"type": "string",
|
|
318847
|
+
"description": "Plugin version.",
|
|
318848
|
+
"in": "path"
|
|
318849
|
+
}
|
|
318850
|
+
},
|
|
318851
|
+
"response": {
|
|
318852
|
+
"description": "Success",
|
|
318853
|
+
"schema": {
|
|
318854
|
+
"type": "object",
|
|
318855
|
+
"properties": {
|
|
318856
|
+
"plugin": {
|
|
318857
|
+
"type": "object",
|
|
318858
|
+
"properties": {
|
|
318859
|
+
"id": {
|
|
318860
|
+
"type": "string",
|
|
318861
|
+
"minLength": 28,
|
|
318862
|
+
"maxLength": 36,
|
|
318863
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
318864
|
+
},
|
|
318865
|
+
"name": {
|
|
318866
|
+
"type": "string",
|
|
318867
|
+
"maxLength": 200,
|
|
318868
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
318869
|
+
},
|
|
318870
|
+
"version": {
|
|
318871
|
+
"type": "string",
|
|
318872
|
+
"maxLength": 200,
|
|
318873
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
318874
|
+
},
|
|
318875
|
+
"createdAt": {
|
|
318876
|
+
"type": "string",
|
|
318877
|
+
"format": "date-time",
|
|
318878
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
318879
|
+
},
|
|
318880
|
+
"updatedAt": {
|
|
318881
|
+
"type": "string",
|
|
318882
|
+
"format": "date-time",
|
|
318883
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
318884
|
+
},
|
|
318885
|
+
"configuration": {
|
|
318886
|
+
"type": "object",
|
|
318887
|
+
"properties": {
|
|
318888
|
+
"title": {
|
|
318889
|
+
"type": "string",
|
|
318890
|
+
"maxLength": 64,
|
|
318891
|
+
"description": "Title of the configuration"
|
|
317211
318892
|
},
|
|
317212
|
-
"
|
|
318893
|
+
"description": {
|
|
318894
|
+
"type": "string",
|
|
318895
|
+
"maxLength": 256,
|
|
318896
|
+
"description": "Description of the configuration"
|
|
318897
|
+
},
|
|
318898
|
+
"schema": {
|
|
317213
318899
|
"type": "object",
|
|
317214
|
-
"
|
|
317215
|
-
|
|
317216
|
-
"type": "boolean",
|
|
317217
|
-
"description": "Enable user creation"
|
|
317218
|
-
},
|
|
317219
|
-
"requiredTags": {
|
|
317220
|
-
"type": "array",
|
|
317221
|
-
"items": {
|
|
317222
|
-
"type": "string"
|
|
317223
|
-
},
|
|
317224
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
317225
|
-
}
|
|
317226
|
-
},
|
|
317227
|
-
"required": [
|
|
317228
|
-
"enabled",
|
|
317229
|
-
"requiredTags"
|
|
317230
|
-
],
|
|
317231
|
-
"description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
|
|
317232
|
-
"additionalProperties": false
|
|
318900
|
+
"additionalProperties": true,
|
|
318901
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
317233
318902
|
}
|
|
317234
318903
|
},
|
|
317235
318904
|
"required": [
|
|
317236
|
-
"
|
|
317237
|
-
"creation"
|
|
318905
|
+
"schema"
|
|
317238
318906
|
],
|
|
317239
|
-
"description": "
|
|
318907
|
+
"description": "Configuration definition",
|
|
317240
318908
|
"additionalProperties": false
|
|
317241
318909
|
},
|
|
317242
|
-
"
|
|
318910
|
+
"states": {
|
|
318911
|
+
"type": "object",
|
|
318912
|
+
"additionalProperties": {
|
|
318913
|
+
"type": "object",
|
|
318914
|
+
"properties": {
|
|
318915
|
+
"type": {
|
|
318916
|
+
"type": "string",
|
|
318917
|
+
"enum": [
|
|
318918
|
+
"conversation",
|
|
318919
|
+
"user",
|
|
318920
|
+
"bot",
|
|
318921
|
+
"task"
|
|
318922
|
+
],
|
|
318923
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
318924
|
+
},
|
|
318925
|
+
"schema": {
|
|
318926
|
+
"type": "object",
|
|
318927
|
+
"additionalProperties": true,
|
|
318928
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
318929
|
+
},
|
|
318930
|
+
"expiry": {
|
|
318931
|
+
"type": "number",
|
|
318932
|
+
"minimum": 1,
|
|
318933
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
318934
|
+
}
|
|
318935
|
+
},
|
|
318936
|
+
"required": [
|
|
318937
|
+
"type",
|
|
318938
|
+
"schema"
|
|
318939
|
+
],
|
|
318940
|
+
"additionalProperties": false
|
|
318941
|
+
}
|
|
318942
|
+
},
|
|
318943
|
+
"events": {
|
|
317243
318944
|
"type": "object",
|
|
317244
318945
|
"additionalProperties": {
|
|
317245
318946
|
"type": "object",
|
|
@@ -317247,12 +318948,12 @@ var state5 = {
|
|
|
317247
318948
|
"title": {
|
|
317248
318949
|
"type": "string",
|
|
317249
318950
|
"maxLength": 64,
|
|
317250
|
-
"description": "Title of the
|
|
318951
|
+
"description": "Title of the event"
|
|
317251
318952
|
},
|
|
317252
318953
|
"description": {
|
|
317253
318954
|
"type": "string",
|
|
317254
318955
|
"maxLength": 256,
|
|
317255
|
-
"description": "Description of the
|
|
318956
|
+
"description": "Description of the event"
|
|
317256
318957
|
},
|
|
317257
318958
|
"schema": {
|
|
317258
318959
|
"type": "object",
|
|
@@ -317262,127 +318963,282 @@ var state5 = {
|
|
|
317262
318963
|
"required": [
|
|
317263
318964
|
"schema"
|
|
317264
318965
|
],
|
|
317265
|
-
"description": "
|
|
318966
|
+
"description": "Event Definition",
|
|
317266
318967
|
"additionalProperties": false
|
|
317267
318968
|
}
|
|
317268
318969
|
},
|
|
317269
|
-
"
|
|
317270
|
-
"type": "
|
|
317271
|
-
"
|
|
317272
|
-
|
|
317273
|
-
|
|
317274
|
-
|
|
317275
|
-
|
|
317276
|
-
|
|
317277
|
-
|
|
317278
|
-
|
|
317279
|
-
|
|
317280
|
-
|
|
317281
|
-
|
|
317282
|
-
|
|
317283
|
-
|
|
317284
|
-
|
|
317285
|
-
|
|
317286
|
-
|
|
317287
|
-
|
|
317288
|
-
|
|
317289
|
-
|
|
317290
|
-
|
|
317291
|
-
|
|
317292
|
-
|
|
317293
|
-
|
|
317294
|
-
|
|
317295
|
-
|
|
317296
|
-
|
|
317297
|
-
|
|
317298
|
-
|
|
317299
|
-
|
|
317300
|
-
|
|
317301
|
-
|
|
317302
|
-
|
|
317303
|
-
|
|
317304
|
-
|
|
318970
|
+
"actions": {
|
|
318971
|
+
"type": "object",
|
|
318972
|
+
"additionalProperties": {
|
|
318973
|
+
"type": "object",
|
|
318974
|
+
"properties": {
|
|
318975
|
+
"title": {
|
|
318976
|
+
"type": "string",
|
|
318977
|
+
"maxLength": 64,
|
|
318978
|
+
"description": "Title of the action"
|
|
318979
|
+
},
|
|
318980
|
+
"description": {
|
|
318981
|
+
"type": "string",
|
|
318982
|
+
"maxLength": 256,
|
|
318983
|
+
"description": "Description of the action"
|
|
318984
|
+
},
|
|
318985
|
+
"billable": {
|
|
318986
|
+
"type": "boolean"
|
|
318987
|
+
},
|
|
318988
|
+
"cacheable": {
|
|
318989
|
+
"type": "boolean"
|
|
318990
|
+
},
|
|
318991
|
+
"input": {
|
|
318992
|
+
"type": "object",
|
|
318993
|
+
"properties": {
|
|
318994
|
+
"schema": {
|
|
318995
|
+
"type": "object",
|
|
318996
|
+
"additionalProperties": true
|
|
318997
|
+
}
|
|
318998
|
+
},
|
|
318999
|
+
"required": [
|
|
319000
|
+
"schema"
|
|
319001
|
+
],
|
|
319002
|
+
"additionalProperties": false
|
|
319003
|
+
},
|
|
319004
|
+
"output": {
|
|
319005
|
+
"type": "object",
|
|
319006
|
+
"properties": {
|
|
319007
|
+
"schema": {
|
|
319008
|
+
"type": "object",
|
|
319009
|
+
"additionalProperties": true
|
|
319010
|
+
}
|
|
319011
|
+
},
|
|
319012
|
+
"required": [
|
|
319013
|
+
"schema"
|
|
319014
|
+
],
|
|
319015
|
+
"additionalProperties": false
|
|
319016
|
+
}
|
|
319017
|
+
},
|
|
319018
|
+
"required": [
|
|
319019
|
+
"input",
|
|
319020
|
+
"output"
|
|
319021
|
+
],
|
|
319022
|
+
"description": "Action definition",
|
|
319023
|
+
"additionalProperties": false
|
|
319024
|
+
}
|
|
317305
319025
|
},
|
|
317306
|
-
"
|
|
317307
|
-
"type": "
|
|
317308
|
-
"
|
|
317309
|
-
"
|
|
319026
|
+
"dependencies": {
|
|
319027
|
+
"type": "object",
|
|
319028
|
+
"properties": {
|
|
319029
|
+
"interfaces": {
|
|
319030
|
+
"type": "object",
|
|
319031
|
+
"additionalProperties": {
|
|
319032
|
+
"type": "object",
|
|
319033
|
+
"properties": {
|
|
319034
|
+
"id": {
|
|
319035
|
+
"type": "string",
|
|
319036
|
+
"minLength": 28,
|
|
319037
|
+
"maxLength": 36
|
|
319038
|
+
},
|
|
319039
|
+
"name": {
|
|
319040
|
+
"type": "string",
|
|
319041
|
+
"maxLength": 200
|
|
319042
|
+
},
|
|
319043
|
+
"version": {
|
|
319044
|
+
"type": "string",
|
|
319045
|
+
"maxLength": 200
|
|
319046
|
+
}
|
|
319047
|
+
},
|
|
319048
|
+
"required": [
|
|
319049
|
+
"id",
|
|
319050
|
+
"name",
|
|
319051
|
+
"version"
|
|
319052
|
+
],
|
|
319053
|
+
"additionalProperties": false
|
|
319054
|
+
}
|
|
319055
|
+
},
|
|
319056
|
+
"integrations": {
|
|
319057
|
+
"type": "object",
|
|
319058
|
+
"additionalProperties": {
|
|
319059
|
+
"type": "object",
|
|
319060
|
+
"properties": {
|
|
319061
|
+
"id": {
|
|
319062
|
+
"type": "string",
|
|
319063
|
+
"minLength": 28,
|
|
319064
|
+
"maxLength": 36
|
|
319065
|
+
},
|
|
319066
|
+
"name": {
|
|
319067
|
+
"type": "string",
|
|
319068
|
+
"maxLength": 200
|
|
319069
|
+
},
|
|
319070
|
+
"version": {
|
|
319071
|
+
"type": "string",
|
|
319072
|
+
"maxLength": 200
|
|
319073
|
+
}
|
|
319074
|
+
},
|
|
319075
|
+
"required": [
|
|
319076
|
+
"id",
|
|
319077
|
+
"name",
|
|
319078
|
+
"version"
|
|
319079
|
+
],
|
|
319080
|
+
"additionalProperties": false
|
|
319081
|
+
}
|
|
319082
|
+
}
|
|
317310
319083
|
},
|
|
317311
|
-
"
|
|
319084
|
+
"required": [
|
|
319085
|
+
"interfaces",
|
|
319086
|
+
"integrations"
|
|
319087
|
+
],
|
|
319088
|
+
"additionalProperties": false
|
|
317312
319089
|
},
|
|
317313
|
-
"
|
|
319090
|
+
"user": {
|
|
317314
319091
|
"type": "object",
|
|
317315
319092
|
"properties": {
|
|
317316
|
-
"
|
|
317317
|
-
"type": "
|
|
317318
|
-
|
|
317319
|
-
|
|
317320
|
-
|
|
317321
|
-
|
|
317322
|
-
|
|
317323
|
-
|
|
317324
|
-
|
|
319093
|
+
"tags": {
|
|
319094
|
+
"type": "object",
|
|
319095
|
+
"additionalProperties": {
|
|
319096
|
+
"type": "object",
|
|
319097
|
+
"properties": {
|
|
319098
|
+
"title": {
|
|
319099
|
+
"type": "string",
|
|
319100
|
+
"maxLength": 64,
|
|
319101
|
+
"description": "Title of the tag"
|
|
319102
|
+
},
|
|
319103
|
+
"description": {
|
|
319104
|
+
"type": "string",
|
|
319105
|
+
"maxLength": 256,
|
|
319106
|
+
"description": "Description of the tag"
|
|
319107
|
+
}
|
|
319108
|
+
},
|
|
319109
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
319110
|
+
"additionalProperties": false
|
|
319111
|
+
}
|
|
317325
319112
|
}
|
|
317326
319113
|
},
|
|
317327
319114
|
"required": [
|
|
317328
|
-
"
|
|
317329
|
-
"handle",
|
|
317330
|
-
"name"
|
|
319115
|
+
"tags"
|
|
317331
319116
|
],
|
|
319117
|
+
"description": "User object configuration",
|
|
317332
319118
|
"additionalProperties": false
|
|
317333
319119
|
},
|
|
317334
|
-
"
|
|
319120
|
+
"conversation": {
|
|
317335
319121
|
"type": "object",
|
|
317336
319122
|
"properties": {
|
|
317337
|
-
"
|
|
317338
|
-
"type": "
|
|
317339
|
-
|
|
317340
|
-
|
|
317341
|
-
|
|
319123
|
+
"tags": {
|
|
319124
|
+
"type": "object",
|
|
319125
|
+
"additionalProperties": {
|
|
319126
|
+
"type": "object",
|
|
319127
|
+
"properties": {
|
|
319128
|
+
"title": {
|
|
319129
|
+
"type": "string",
|
|
319130
|
+
"maxLength": 64,
|
|
319131
|
+
"description": "Title of the tag"
|
|
319132
|
+
},
|
|
319133
|
+
"description": {
|
|
319134
|
+
"type": "string",
|
|
319135
|
+
"maxLength": 256,
|
|
319136
|
+
"description": "Description of the tag"
|
|
319137
|
+
}
|
|
319138
|
+
},
|
|
319139
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
319140
|
+
"additionalProperties": false
|
|
319141
|
+
}
|
|
317342
319142
|
}
|
|
317343
319143
|
},
|
|
317344
319144
|
"required": [
|
|
317345
|
-
"
|
|
317346
|
-
"views"
|
|
319145
|
+
"tags"
|
|
317347
319146
|
],
|
|
319147
|
+
"description": "Conversation object configuration",
|
|
317348
319148
|
"additionalProperties": false
|
|
319149
|
+
},
|
|
319150
|
+
"title": {
|
|
319151
|
+
"type": "string",
|
|
319152
|
+
"minLength": 1,
|
|
319153
|
+
"maxLength": 64,
|
|
319154
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
319155
|
+
},
|
|
319156
|
+
"description": {
|
|
319157
|
+
"type": "string",
|
|
319158
|
+
"maxLength": 256,
|
|
319159
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
319160
|
+
},
|
|
319161
|
+
"iconUrl": {
|
|
319162
|
+
"type": "string",
|
|
319163
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
319164
|
+
},
|
|
319165
|
+
"readmeUrl": {
|
|
319166
|
+
"type": "string",
|
|
319167
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
319168
|
+
},
|
|
319169
|
+
"public": {
|
|
319170
|
+
"type": "boolean",
|
|
319171
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
317349
319172
|
}
|
|
317350
319173
|
},
|
|
317351
319174
|
"required": [
|
|
317352
319175
|
"id",
|
|
317353
|
-
"createdAt",
|
|
317354
|
-
"updatedAt",
|
|
317355
|
-
"identifier",
|
|
317356
|
-
"url",
|
|
317357
319176
|
"name",
|
|
317358
319177
|
"version",
|
|
317359
|
-
"
|
|
319178
|
+
"createdAt",
|
|
319179
|
+
"updatedAt",
|
|
317360
319180
|
"configuration",
|
|
317361
|
-
"configurations",
|
|
317362
|
-
"channels",
|
|
317363
319181
|
"states",
|
|
317364
319182
|
"events",
|
|
317365
319183
|
"actions",
|
|
319184
|
+
"dependencies",
|
|
317366
319185
|
"user",
|
|
317367
|
-
"
|
|
317368
|
-
"dev",
|
|
319186
|
+
"conversation",
|
|
317369
319187
|
"title",
|
|
317370
319188
|
"description",
|
|
317371
319189
|
"iconUrl",
|
|
317372
319190
|
"readmeUrl",
|
|
317373
|
-
"public"
|
|
317374
|
-
"verificationStatus",
|
|
317375
|
-
"secrets",
|
|
317376
|
-
"ownerWorkspace",
|
|
317377
|
-
"meta"
|
|
319191
|
+
"public"
|
|
317378
319192
|
],
|
|
317379
319193
|
"additionalProperties": false
|
|
317380
319194
|
}
|
|
317381
319195
|
},
|
|
317382
319196
|
"required": [
|
|
317383
|
-
"
|
|
319197
|
+
"plugin"
|
|
317384
319198
|
],
|
|
317385
|
-
"title": "
|
|
319199
|
+
"title": "getPublicPluginResponse",
|
|
319200
|
+
"additionalProperties": false
|
|
319201
|
+
}
|
|
319202
|
+
}
|
|
319203
|
+
},
|
|
319204
|
+
"getPublicPluginCode": {
|
|
319205
|
+
"name": "getPublicPluginCode",
|
|
319206
|
+
"description": "Get public plugin code",
|
|
319207
|
+
"method": "get",
|
|
319208
|
+
"path": "/v1/admin/hub/{id}/code/{platform}",
|
|
319209
|
+
"disableDefaultParameters": {
|
|
319210
|
+
"x-workspace-id": true
|
|
319211
|
+
},
|
|
319212
|
+
"section": "hub",
|
|
319213
|
+
"parameters": {
|
|
319214
|
+
"id": {
|
|
319215
|
+
"in": "path",
|
|
319216
|
+
"type": "string",
|
|
319217
|
+
"description": "Plugin id"
|
|
319218
|
+
},
|
|
319219
|
+
"platform": {
|
|
319220
|
+
"in": "path",
|
|
319221
|
+
"type": "string",
|
|
319222
|
+
"enum": [
|
|
319223
|
+
"node",
|
|
319224
|
+
"browser"
|
|
319225
|
+
],
|
|
319226
|
+
"description": "Platform"
|
|
319227
|
+
}
|
|
319228
|
+
},
|
|
319229
|
+
"response": {
|
|
319230
|
+
"description": "Plugin code",
|
|
319231
|
+
"schema": {
|
|
319232
|
+
"type": "object",
|
|
319233
|
+
"properties": {
|
|
319234
|
+
"code": {
|
|
319235
|
+
"type": "string"
|
|
319236
|
+
}
|
|
319237
|
+
},
|
|
319238
|
+
"required": [
|
|
319239
|
+
"code"
|
|
319240
|
+
],
|
|
319241
|
+
"title": "getPublicPluginCodeResponse",
|
|
317386
319242
|
"additionalProperties": false
|
|
317387
319243
|
}
|
|
317388
319244
|
}
|
|
@@ -321842,7 +323698,7 @@ var state5 = {
|
|
|
321842
323698
|
},
|
|
321843
323699
|
"public": {
|
|
321844
323700
|
"type": "boolean",
|
|
321845
|
-
"description": "
|
|
323701
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
321846
323702
|
},
|
|
321847
323703
|
"layers": {
|
|
321848
323704
|
"type": "array",
|
|
@@ -322408,7 +324264,7 @@ var state5 = {
|
|
|
322408
324264
|
},
|
|
322409
324265
|
"public": {
|
|
322410
324266
|
"type": "boolean",
|
|
322411
|
-
"description": "
|
|
324267
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
322412
324268
|
},
|
|
322413
324269
|
"layers": {
|
|
322414
324270
|
"type": "array",
|
|
@@ -322988,7 +324844,7 @@ var state5 = {
|
|
|
322988
324844
|
},
|
|
322989
324845
|
"public": {
|
|
322990
324846
|
"type": "boolean",
|
|
322991
|
-
"description": "
|
|
324847
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
322992
324848
|
},
|
|
322993
324849
|
"layers": {
|
|
322994
324850
|
"type": "array",
|
|
@@ -323571,7 +325427,7 @@ var state5 = {
|
|
|
323571
325427
|
},
|
|
323572
325428
|
"public": {
|
|
323573
325429
|
"type": "boolean",
|
|
323574
|
-
"description": "
|
|
325430
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
323575
325431
|
},
|
|
323576
325432
|
"layers": {
|
|
323577
325433
|
"type": "array",
|
|
@@ -323743,7 +325599,7 @@ var state5 = {
|
|
|
323743
325599
|
},
|
|
323744
325600
|
"public": {
|
|
323745
325601
|
"type": "boolean",
|
|
323746
|
-
"description": "
|
|
325602
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
323747
325603
|
},
|
|
323748
325604
|
"verificationStatus": {
|
|
323749
325605
|
"type": "string",
|
|
@@ -324950,6 +326806,10 @@ var state5 = {
|
|
|
324950
326806
|
"type": "string",
|
|
324951
326807
|
"maxLength": 256,
|
|
324952
326808
|
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
326809
|
+
},
|
|
326810
|
+
"public": {
|
|
326811
|
+
"type": "boolean",
|
|
326812
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
324953
326813
|
}
|
|
324954
326814
|
},
|
|
324955
326815
|
"required": [
|
|
@@ -325336,6 +327196,10 @@ var state5 = {
|
|
|
325336
327196
|
"type": "string",
|
|
325337
327197
|
"maxLength": 256,
|
|
325338
327198
|
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
327199
|
+
},
|
|
327200
|
+
"public": {
|
|
327201
|
+
"type": "boolean",
|
|
327202
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
325339
327203
|
}
|
|
325340
327204
|
},
|
|
325341
327205
|
"title": "updatePluginBody",
|
|
@@ -325398,6 +327262,11 @@ var state5 = {
|
|
|
325398
327262
|
"in": "query",
|
|
325399
327263
|
"type": "string",
|
|
325400
327264
|
"description": "Filter all versions of a plugin by name"
|
|
327265
|
+
},
|
|
327266
|
+
"version": {
|
|
327267
|
+
"in": "query",
|
|
327268
|
+
"type": "string",
|
|
327269
|
+
"description": "Filter a plugin by name and version"
|
|
325401
327270
|
}
|
|
325402
327271
|
},
|
|
325403
327272
|
"response": {
|
|
@@ -325454,6 +327323,10 @@ var state5 = {
|
|
|
325454
327323
|
"readmeUrl": {
|
|
325455
327324
|
"type": "string",
|
|
325456
327325
|
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
327326
|
+
},
|
|
327327
|
+
"public": {
|
|
327328
|
+
"type": "boolean",
|
|
327329
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
325457
327330
|
}
|
|
325458
327331
|
},
|
|
325459
327332
|
"required": [
|
|
@@ -325465,7 +327338,8 @@ var state5 = {
|
|
|
325465
327338
|
"title",
|
|
325466
327339
|
"description",
|
|
325467
327340
|
"iconUrl",
|
|
325468
|
-
"readmeUrl"
|
|
327341
|
+
"readmeUrl",
|
|
327342
|
+
"public"
|
|
325469
327343
|
]
|
|
325470
327344
|
}
|
|
325471
327345
|
},
|
|
@@ -328800,7 +330674,7 @@ var state5 = {
|
|
|
328800
330674
|
"title": "Botpress API",
|
|
328801
330675
|
"description": "API for Botpress Cloud",
|
|
328802
330676
|
"server": "https://api.botpress.cloud",
|
|
328803
|
-
"version": "1.
|
|
330677
|
+
"version": "1.5.0",
|
|
328804
330678
|
"prefix": "v1"
|
|
328805
330679
|
},
|
|
328806
330680
|
"errors": [
|
|
@@ -329053,6 +330927,10 @@ var state5 = {
|
|
|
329053
330927
|
"listPublicIntegrationsResponse": true,
|
|
329054
330928
|
"getPublicIntegrationByIdResponse": true,
|
|
329055
330929
|
"getPublicIntegrationResponse": true,
|
|
330930
|
+
"listPublicPluginsResponse": true,
|
|
330931
|
+
"getPublicPluginByIdResponse": true,
|
|
330932
|
+
"getPublicPluginResponse": true,
|
|
330933
|
+
"getPublicPluginCodeResponse": true,
|
|
329056
330934
|
"createBotResponse": true,
|
|
329057
330935
|
"updateBotResponse": true,
|
|
329058
330936
|
"transferBotResponse": true,
|
|
@@ -329302,7 +331180,7 @@ var state5 = {
|
|
|
329302
331180
|
},
|
|
329303
331181
|
"public": {
|
|
329304
331182
|
"type": "boolean",
|
|
329305
|
-
"description": "
|
|
331183
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
329306
331184
|
},
|
|
329307
331185
|
"verificationStatus": {
|
|
329308
331186
|
"type": "string",
|
|
@@ -330315,7 +332193,7 @@ var state5 = {
|
|
|
330315
332193
|
},
|
|
330316
332194
|
"public": {
|
|
330317
332195
|
"type": "boolean",
|
|
330318
|
-
"description": "
|
|
332196
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
330319
332197
|
},
|
|
330320
332198
|
"verificationStatus": {
|
|
330321
332199
|
"type": "string",
|
|
@@ -330892,6 +332770,10 @@ var state5 = {
|
|
|
330892
332770
|
"readmeUrl": {
|
|
330893
332771
|
"type": "string",
|
|
330894
332772
|
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
332773
|
+
},
|
|
332774
|
+
"public": {
|
|
332775
|
+
"type": "boolean",
|
|
332776
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
330895
332777
|
}
|
|
330896
332778
|
},
|
|
330897
332779
|
"required": [
|
|
@@ -330910,7 +332792,8 @@ var state5 = {
|
|
|
330910
332792
|
"title",
|
|
330911
332793
|
"description",
|
|
330912
332794
|
"iconUrl",
|
|
330913
|
-
"readmeUrl"
|
|
332795
|
+
"readmeUrl",
|
|
332796
|
+
"public"
|
|
330914
332797
|
],
|
|
330915
332798
|
"additionalProperties": false
|
|
330916
332799
|
}
|
|
@@ -332483,7 +334366,11 @@ var state5 = {
|
|
|
332483
334366
|
"operations": [
|
|
332484
334367
|
"listPublicIntegrations",
|
|
332485
334368
|
"getPublicIntegrationById",
|
|
332486
|
-
"getPublicIntegration"
|
|
334369
|
+
"getPublicIntegration",
|
|
334370
|
+
"listPublicPlugins",
|
|
334371
|
+
"getPublicPluginById",
|
|
334372
|
+
"getPublicPlugin",
|
|
334373
|
+
"getPublicPluginCode"
|
|
332487
334374
|
]
|
|
332488
334375
|
},
|
|
332489
334376
|
{
|