@botpress/api 1.4.0 → 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 +2425 -589
- package/dist/src/gen/admin/state.d.ts +787 -0
- package/dist/src/gen/state.d.ts +787 -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 +920 -2
- package/src/gen/files/openapi.json +1 -1
- package/src/gen/files/state.ts +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/runtime/openapi.json +1 -1
- package/src/gen/runtime/state.ts +1 -1
- package/src/gen/state.ts +920 -2
- package/src/gen/tables/openapi.json +1 -1
- package/src/gen/tables/state.ts +1 -1
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": [
|
|
@@ -290382,6 +290382,911 @@ var state2 = {
|
|
|
290382
290382
|
}
|
|
290383
290383
|
}
|
|
290384
290384
|
},
|
|
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",
|
|
290413
|
+
"schema": {
|
|
290414
|
+
"type": "object",
|
|
290415
|
+
"properties": {
|
|
290416
|
+
"plugins": {
|
|
290417
|
+
"type": "array",
|
|
290418
|
+
"items": {
|
|
290419
|
+
"type": "object",
|
|
290420
|
+
"properties": {
|
|
290421
|
+
"id": {
|
|
290422
|
+
"type": "string",
|
|
290423
|
+
"minLength": 28,
|
|
290424
|
+
"maxLength": 36,
|
|
290425
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
290426
|
+
},
|
|
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)"
|
|
290446
|
+
},
|
|
290447
|
+
"title": {
|
|
290448
|
+
"type": "string",
|
|
290449
|
+
"minLength": 1,
|
|
290450
|
+
"maxLength": 64,
|
|
290451
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
290452
|
+
},
|
|
290453
|
+
"description": {
|
|
290454
|
+
"type": "string",
|
|
290455
|
+
"maxLength": 256,
|
|
290456
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
290457
|
+
},
|
|
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"
|
|
290461
|
+
},
|
|
290462
|
+
"readmeUrl": {
|
|
290463
|
+
"type": "string",
|
|
290464
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
290465
|
+
},
|
|
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."
|
|
290469
|
+
}
|
|
290470
|
+
},
|
|
290471
|
+
"required": [
|
|
290472
|
+
"id",
|
|
290473
|
+
"createdAt",
|
|
290474
|
+
"updatedAt",
|
|
290475
|
+
"name",
|
|
290476
|
+
"version",
|
|
290477
|
+
"title",
|
|
290478
|
+
"description",
|
|
290479
|
+
"iconUrl",
|
|
290480
|
+
"readmeUrl",
|
|
290481
|
+
"public"
|
|
290482
|
+
]
|
|
290483
|
+
}
|
|
290484
|
+
},
|
|
290485
|
+
"meta": {
|
|
290486
|
+
"type": "object",
|
|
290487
|
+
"properties": {
|
|
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."
|
|
290491
|
+
}
|
|
290492
|
+
},
|
|
290493
|
+
"additionalProperties": false
|
|
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": {
|
|
290527
|
+
"type": "object",
|
|
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"
|
|
290562
|
+
},
|
|
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
|
+
}
|
|
290573
|
+
},
|
|
290574
|
+
"required": [
|
|
290575
|
+
"schema"
|
|
290576
|
+
],
|
|
290577
|
+
"description": "Configuration definition",
|
|
290578
|
+
"additionalProperties": false
|
|
290579
|
+
},
|
|
290580
|
+
"states": {
|
|
290581
|
+
"type": "object",
|
|
290582
|
+
"additionalProperties": {
|
|
290583
|
+
"type": "object",
|
|
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
|
+
},
|
|
290595
|
+
"schema": {
|
|
290596
|
+
"type": "object",
|
|
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."
|
|
290604
|
+
}
|
|
290605
|
+
},
|
|
290606
|
+
"required": [
|
|
290607
|
+
"type",
|
|
290608
|
+
"schema"
|
|
290609
|
+
],
|
|
290610
|
+
"additionalProperties": false
|
|
290611
|
+
}
|
|
290612
|
+
},
|
|
290613
|
+
"events": {
|
|
290614
|
+
"type": "object",
|
|
290615
|
+
"additionalProperties": {
|
|
290616
|
+
"type": "object",
|
|
290617
|
+
"properties": {
|
|
290618
|
+
"title": {
|
|
290619
|
+
"type": "string",
|
|
290620
|
+
"maxLength": 64,
|
|
290621
|
+
"description": "Title of the event"
|
|
290622
|
+
},
|
|
290623
|
+
"description": {
|
|
290624
|
+
"type": "string",
|
|
290625
|
+
"maxLength": 256,
|
|
290626
|
+
"description": "Description of the event"
|
|
290627
|
+
},
|
|
290628
|
+
"schema": {
|
|
290629
|
+
"type": "object",
|
|
290630
|
+
"additionalProperties": true
|
|
290631
|
+
}
|
|
290632
|
+
},
|
|
290633
|
+
"required": [
|
|
290634
|
+
"schema"
|
|
290635
|
+
],
|
|
290636
|
+
"description": "Event Definition",
|
|
290637
|
+
"additionalProperties": false
|
|
290638
|
+
}
|
|
290639
|
+
},
|
|
290640
|
+
"actions": {
|
|
290641
|
+
"type": "object",
|
|
290642
|
+
"additionalProperties": {
|
|
290643
|
+
"type": "object",
|
|
290644
|
+
"properties": {
|
|
290645
|
+
"title": {
|
|
290646
|
+
"type": "string",
|
|
290647
|
+
"maxLength": 64,
|
|
290648
|
+
"description": "Title of the action"
|
|
290649
|
+
},
|
|
290650
|
+
"description": {
|
|
290651
|
+
"type": "string",
|
|
290652
|
+
"maxLength": 256,
|
|
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
|
|
290686
|
+
}
|
|
290687
|
+
},
|
|
290688
|
+
"required": [
|
|
290689
|
+
"input",
|
|
290690
|
+
"output"
|
|
290691
|
+
],
|
|
290692
|
+
"description": "Action definition",
|
|
290693
|
+
"additionalProperties": false
|
|
290694
|
+
}
|
|
290695
|
+
},
|
|
290696
|
+
"dependencies": {
|
|
290697
|
+
"type": "object",
|
|
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
|
|
290724
|
+
}
|
|
290725
|
+
},
|
|
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
|
+
}
|
|
290753
|
+
},
|
|
290754
|
+
"required": [
|
|
290755
|
+
"interfaces",
|
|
290756
|
+
"integrations"
|
|
290757
|
+
],
|
|
290758
|
+
"additionalProperties": false
|
|
290759
|
+
},
|
|
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
|
+
},
|
|
290385
291290
|
"createBot": {
|
|
290386
291291
|
"name": "createBot",
|
|
290387
291292
|
"description": "Create bot",
|
|
@@ -298400,6 +299305,11 @@ var state2 = {
|
|
|
298400
299305
|
"in": "query",
|
|
298401
299306
|
"type": "string",
|
|
298402
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"
|
|
298403
299313
|
}
|
|
298404
299314
|
},
|
|
298405
299315
|
"response": {
|
|
@@ -299032,7 +299942,7 @@ var state2 = {
|
|
|
299032
299942
|
"title": "Botpress API",
|
|
299033
299943
|
"description": "API for Botpress Cloud",
|
|
299034
299944
|
"server": "https://api.botpress.cloud",
|
|
299035
|
-
"version": "1.
|
|
299945
|
+
"version": "1.5.0",
|
|
299036
299946
|
"prefix": "v1"
|
|
299037
299947
|
},
|
|
299038
299948
|
"errors": [
|
|
@@ -299201,6 +300111,10 @@ var state2 = {
|
|
|
299201
300111
|
"listPublicIntegrationsResponse": true,
|
|
299202
300112
|
"getPublicIntegrationByIdResponse": true,
|
|
299203
300113
|
"getPublicIntegrationResponse": true,
|
|
300114
|
+
"listPublicPluginsResponse": true,
|
|
300115
|
+
"getPublicPluginByIdResponse": true,
|
|
300116
|
+
"getPublicPluginResponse": true,
|
|
300117
|
+
"getPublicPluginCodeResponse": true,
|
|
299204
300118
|
"createBotResponse": true,
|
|
299205
300119
|
"updateBotResponse": true,
|
|
299206
300120
|
"transferBotResponse": true,
|
|
@@ -302568,7 +303482,11 @@ var state2 = {
|
|
|
302568
303482
|
"operations": [
|
|
302569
303483
|
"listPublicIntegrations",
|
|
302570
303484
|
"getPublicIntegrationById",
|
|
302571
|
-
"getPublicIntegration"
|
|
303485
|
+
"getPublicIntegration",
|
|
303486
|
+
"listPublicPlugins",
|
|
303487
|
+
"getPublicPluginById",
|
|
303488
|
+
"getPublicPlugin",
|
|
303489
|
+
"getPublicPluginCode"
|
|
302572
303490
|
]
|
|
302573
303491
|
},
|
|
302574
303492
|
{
|
|
@@ -304365,7 +305283,7 @@ var state3 = {
|
|
|
304365
305283
|
"title": "Botpress API",
|
|
304366
305284
|
"description": "API for Botpress Cloud",
|
|
304367
305285
|
"server": "https://api.botpress.cloud",
|
|
304368
|
-
"version": "1.
|
|
305286
|
+
"version": "1.5.0",
|
|
304369
305287
|
"prefix": "v1"
|
|
304370
305288
|
},
|
|
304371
305289
|
"errors": [
|
|
@@ -309160,7 +310078,7 @@ var state4 = {
|
|
|
309160
310078
|
"title": "Botpress API",
|
|
309161
310079
|
"description": "API for Botpress Cloud",
|
|
309162
310080
|
"server": "https://api.botpress.cloud",
|
|
309163
|
-
"version": "1.
|
|
310081
|
+
"version": "1.5.0",
|
|
309164
310082
|
"prefix": "v1"
|
|
309165
310083
|
},
|
|
309166
310084
|
"errors": [
|
|
@@ -315885,125 +316803,842 @@ var state5 = {
|
|
|
315885
316803
|
"approved",
|
|
315886
316804
|
"rejected"
|
|
315887
316805
|
],
|
|
315888
|
-
"description": "Status of the integration version verification"
|
|
315889
|
-
},
|
|
315890
|
-
"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": {
|
|
315891
317315
|
"type": "object",
|
|
315892
317316
|
"properties": {
|
|
315893
|
-
"
|
|
315894
|
-
"type": "string"
|
|
315895
|
-
},
|
|
315896
|
-
"handle": {
|
|
317317
|
+
"type": {
|
|
315897
317318
|
"type": "string",
|
|
315898
|
-
"
|
|
317319
|
+
"enum": [
|
|
317320
|
+
"conversation",
|
|
317321
|
+
"user",
|
|
317322
|
+
"integration"
|
|
317323
|
+
],
|
|
317324
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
315899
317325
|
},
|
|
315900
|
-
"
|
|
315901
|
-
"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."
|
|
315902
317330
|
}
|
|
315903
317331
|
},
|
|
315904
317332
|
"required": [
|
|
315905
|
-
"
|
|
315906
|
-
"
|
|
315907
|
-
|
|
315908
|
-
|
|
315909
|
-
|
|
315910
|
-
|
|
317333
|
+
"type",
|
|
317334
|
+
"schema"
|
|
317335
|
+
],
|
|
317336
|
+
"description": "State definition",
|
|
317337
|
+
"additionalProperties": false
|
|
317338
|
+
}
|
|
317339
|
+
},
|
|
317340
|
+
"events": {
|
|
317341
|
+
"type": "object",
|
|
317342
|
+
"additionalProperties": {
|
|
315911
317343
|
"type": "object",
|
|
315912
317344
|
"properties": {
|
|
315913
|
-
"
|
|
315914
|
-
"type": "
|
|
317345
|
+
"title": {
|
|
317346
|
+
"type": "string",
|
|
317347
|
+
"maxLength": 64,
|
|
317348
|
+
"description": "Title of the event"
|
|
315915
317349
|
},
|
|
315916
|
-
"
|
|
315917
|
-
"type": "
|
|
317350
|
+
"description": {
|
|
317351
|
+
"type": "string",
|
|
317352
|
+
"maxLength": 256,
|
|
317353
|
+
"description": "Description of the event"
|
|
317354
|
+
},
|
|
317355
|
+
"schema": {
|
|
317356
|
+
"type": "object",
|
|
317357
|
+
"additionalProperties": true
|
|
315918
317358
|
}
|
|
315919
317359
|
},
|
|
315920
317360
|
"required": [
|
|
315921
|
-
"
|
|
315922
|
-
|
|
315923
|
-
|
|
315924
|
-
|
|
315925
|
-
|
|
317361
|
+
"schema"
|
|
317362
|
+
],
|
|
317363
|
+
"description": "Event Definition",
|
|
317364
|
+
"additionalProperties": false
|
|
317365
|
+
}
|
|
317366
|
+
},
|
|
317367
|
+
"actions": {
|
|
317368
|
+
"type": "object",
|
|
317369
|
+
"additionalProperties": {
|
|
315926
317370
|
"type": "object",
|
|
315927
317371
|
"properties": {
|
|
315928
|
-
"name": {
|
|
315929
|
-
"type": "boolean",
|
|
315930
|
-
"description": "Whether the integration name matched the search term"
|
|
315931
|
-
},
|
|
315932
317372
|
"title": {
|
|
315933
|
-
"type": "
|
|
315934
|
-
"
|
|
317373
|
+
"type": "string",
|
|
317374
|
+
"maxLength": 64,
|
|
317375
|
+
"description": "Title of the action"
|
|
315935
317376
|
},
|
|
315936
317377
|
"description": {
|
|
315937
|
-
"type": "
|
|
315938
|
-
"
|
|
317378
|
+
"type": "string",
|
|
317379
|
+
"maxLength": 256,
|
|
317380
|
+
"description": "Description of the action"
|
|
315939
317381
|
},
|
|
315940
|
-
"
|
|
315941
|
-
"type": "
|
|
315942
|
-
|
|
315943
|
-
|
|
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
|
+
}
|
|
315944
317395
|
},
|
|
315945
|
-
"
|
|
317396
|
+
"required": [
|
|
317397
|
+
"schema"
|
|
317398
|
+
],
|
|
317399
|
+
"additionalProperties": false
|
|
315946
317400
|
},
|
|
315947
|
-
"
|
|
315948
|
-
"type": "
|
|
315949
|
-
"
|
|
315950
|
-
"
|
|
317401
|
+
"output": {
|
|
317402
|
+
"type": "object",
|
|
317403
|
+
"properties": {
|
|
317404
|
+
"schema": {
|
|
317405
|
+
"type": "object",
|
|
317406
|
+
"additionalProperties": true
|
|
317407
|
+
}
|
|
315951
317408
|
},
|
|
315952
|
-
"
|
|
317409
|
+
"required": [
|
|
317410
|
+
"schema"
|
|
317411
|
+
],
|
|
317412
|
+
"additionalProperties": false
|
|
315953
317413
|
}
|
|
315954
317414
|
},
|
|
315955
|
-
"
|
|
317415
|
+
"required": [
|
|
317416
|
+
"input",
|
|
317417
|
+
"output"
|
|
317418
|
+
],
|
|
317419
|
+
"description": "Action definition",
|
|
317420
|
+
"additionalProperties": false
|
|
315956
317421
|
}
|
|
315957
317422
|
},
|
|
315958
|
-
"
|
|
315959
|
-
"
|
|
315960
|
-
"
|
|
315961
|
-
|
|
315962
|
-
|
|
315963
|
-
|
|
315964
|
-
|
|
315965
|
-
|
|
315966
|
-
|
|
315967
|
-
|
|
315968
|
-
|
|
315969
|
-
|
|
315970
|
-
|
|
315971
|
-
|
|
315972
|
-
|
|
315973
|
-
|
|
315974
|
-
|
|
315975
|
-
|
|
315976
|
-
|
|
315977
|
-
|
|
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": {
|
|
315978
317508
|
"type": "string",
|
|
315979
|
-
"
|
|
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
|
|
315980
317583
|
}
|
|
315981
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
|
+
],
|
|
315982
317613
|
"additionalProperties": false
|
|
315983
317614
|
}
|
|
315984
317615
|
},
|
|
315985
317616
|
"required": [
|
|
315986
|
-
"
|
|
315987
|
-
"meta"
|
|
317617
|
+
"integration"
|
|
315988
317618
|
],
|
|
315989
|
-
"title": "
|
|
317619
|
+
"title": "getPublicIntegrationByIdResponse",
|
|
315990
317620
|
"additionalProperties": false
|
|
315991
317621
|
}
|
|
315992
317622
|
}
|
|
315993
317623
|
},
|
|
315994
|
-
"
|
|
315995
|
-
"name": "
|
|
315996
|
-
"description": "Get public integration by
|
|
317624
|
+
"getPublicIntegration": {
|
|
317625
|
+
"name": "getPublicIntegration",
|
|
317626
|
+
"description": "Get public integration by name and version",
|
|
315997
317627
|
"method": "get",
|
|
315998
317628
|
"section": "hub",
|
|
315999
|
-
"path": "/v1/admin/hub/integrations/{
|
|
317629
|
+
"path": "/v1/admin/hub/integrations/{name}/{version}",
|
|
316000
317630
|
"disableDefaultParameters": {
|
|
316001
317631
|
"x-workspace-id": true
|
|
316002
317632
|
},
|
|
316003
317633
|
"parameters": {
|
|
316004
|
-
"
|
|
317634
|
+
"name": {
|
|
316005
317635
|
"type": "string",
|
|
316006
|
-
"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"',
|
|
316007
317642
|
"in": "path"
|
|
316008
317643
|
}
|
|
316009
317644
|
},
|
|
@@ -316640,87 +318275,202 @@ var state5 = {
|
|
|
316640
318275
|
"type": "string"
|
|
316641
318276
|
}
|
|
316642
318277
|
},
|
|
316643
|
-
"required": [
|
|
316644
|
-
"id",
|
|
316645
|
-
"handle",
|
|
316646
|
-
"name"
|
|
316647
|
-
],
|
|
316648
|
-
"additionalProperties": false
|
|
316649
|
-
},
|
|
316650
|
-
"meta": {
|
|
316651
|
-
"type": "object",
|
|
316652
|
-
"properties": {
|
|
316653
|
-
"installs": {
|
|
316654
|
-
"type": "number"
|
|
316655
|
-
},
|
|
316656
|
-
"views": {
|
|
316657
|
-
"type": "number"
|
|
316658
|
-
}
|
|
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"
|
|
316659
318421
|
},
|
|
316660
|
-
"
|
|
316661
|
-
"
|
|
316662
|
-
"
|
|
316663
|
-
|
|
316664
|
-
|
|
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."
|
|
316665
318447
|
}
|
|
316666
318448
|
},
|
|
316667
|
-
"required": [
|
|
316668
|
-
"id",
|
|
316669
|
-
"createdAt",
|
|
316670
|
-
"updatedAt",
|
|
316671
|
-
"identifier",
|
|
316672
|
-
"url",
|
|
316673
|
-
"name",
|
|
316674
|
-
"version",
|
|
316675
|
-
"interfaces",
|
|
316676
|
-
"configuration",
|
|
316677
|
-
"configurations",
|
|
316678
|
-
"channels",
|
|
316679
|
-
"states",
|
|
316680
|
-
"events",
|
|
316681
|
-
"actions",
|
|
316682
|
-
"user",
|
|
316683
|
-
"entities",
|
|
316684
|
-
"dev",
|
|
316685
|
-
"title",
|
|
316686
|
-
"description",
|
|
316687
|
-
"iconUrl",
|
|
316688
|
-
"readmeUrl",
|
|
316689
|
-
"public",
|
|
316690
|
-
"verificationStatus",
|
|
316691
|
-
"secrets",
|
|
316692
|
-
"ownerWorkspace",
|
|
316693
|
-
"meta"
|
|
316694
|
-
],
|
|
316695
318449
|
"additionalProperties": false
|
|
316696
318450
|
}
|
|
316697
318451
|
},
|
|
316698
318452
|
"required": [
|
|
316699
|
-
"
|
|
318453
|
+
"plugins",
|
|
318454
|
+
"meta"
|
|
316700
318455
|
],
|
|
316701
|
-
"title": "
|
|
318456
|
+
"title": "listPublicPluginsResponse",
|
|
316702
318457
|
"additionalProperties": false
|
|
316703
318458
|
}
|
|
316704
318459
|
}
|
|
316705
318460
|
},
|
|
316706
|
-
"
|
|
316707
|
-
"name": "
|
|
316708
|
-
"description": "Get public
|
|
318461
|
+
"getPublicPluginById": {
|
|
318462
|
+
"name": "getPublicPluginById",
|
|
318463
|
+
"description": "Get public plugin by Id",
|
|
316709
318464
|
"method": "get",
|
|
316710
318465
|
"section": "hub",
|
|
316711
|
-
"path": "/v1/admin/hub/
|
|
318466
|
+
"path": "/v1/admin/hub/plugins/{id}",
|
|
316712
318467
|
"disableDefaultParameters": {
|
|
316713
318468
|
"x-workspace-id": true
|
|
316714
318469
|
},
|
|
316715
318470
|
"parameters": {
|
|
316716
|
-
"
|
|
316717
|
-
"type": "string",
|
|
316718
|
-
"description": "Integration Name",
|
|
316719
|
-
"in": "path"
|
|
316720
|
-
},
|
|
316721
|
-
"version": {
|
|
318471
|
+
"id": {
|
|
316722
318472
|
"type": "string",
|
|
316723
|
-
"description":
|
|
318473
|
+
"description": "Plugin ID",
|
|
316724
318474
|
"in": "path"
|
|
316725
318475
|
}
|
|
316726
318476
|
},
|
|
@@ -316729,170 +318479,34 @@ var state5 = {
|
|
|
316729
318479
|
"schema": {
|
|
316730
318480
|
"type": "object",
|
|
316731
318481
|
"properties": {
|
|
316732
|
-
"
|
|
318482
|
+
"plugin": {
|
|
316733
318483
|
"type": "object",
|
|
316734
318484
|
"properties": {
|
|
316735
318485
|
"id": {
|
|
316736
318486
|
"type": "string",
|
|
316737
318487
|
"minLength": 28,
|
|
316738
318488
|
"maxLength": 36,
|
|
316739
|
-
"description": "ID of the [
|
|
316740
|
-
},
|
|
316741
|
-
"createdAt": {
|
|
316742
|
-
"type": "string",
|
|
316743
|
-
"format": "date-time",
|
|
316744
|
-
"description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
316745
|
-
},
|
|
316746
|
-
"updatedAt": {
|
|
316747
|
-
"type": "string",
|
|
316748
|
-
"format": "date-time",
|
|
316749
|
-
"description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
316750
|
-
},
|
|
316751
|
-
"identifier": {
|
|
316752
|
-
"type": "object",
|
|
316753
|
-
"properties": {
|
|
316754
|
-
"fallbackHandlerScript": {
|
|
316755
|
-
"type": "string",
|
|
316756
|
-
"maxLength": 2e3,
|
|
316757
|
-
"description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
|
|
316758
|
-
},
|
|
316759
|
-
"extractScript": {
|
|
316760
|
-
"type": "string",
|
|
316761
|
-
"maxLength": 2e3,
|
|
316762
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
|
|
316763
|
-
}
|
|
316764
|
-
},
|
|
316765
|
-
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
316766
|
-
"additionalProperties": false
|
|
316767
|
-
},
|
|
316768
|
-
"sandbox": {
|
|
316769
|
-
"type": "object",
|
|
316770
|
-
"properties": {
|
|
316771
|
-
"identifierExtractScript": {
|
|
316772
|
-
"type": "string",
|
|
316773
|
-
"maxLength": 2e3,
|
|
316774
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
|
|
316775
|
-
},
|
|
316776
|
-
"messageExtractScript": {
|
|
316777
|
-
"type": "string",
|
|
316778
|
-
"maxLength": 2e3,
|
|
316779
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
|
|
316780
|
-
}
|
|
316781
|
-
},
|
|
316782
|
-
"additionalProperties": false
|
|
316783
|
-
},
|
|
316784
|
-
"url": {
|
|
316785
|
-
"type": "string",
|
|
316786
|
-
"maxLength": 2e3,
|
|
316787
|
-
"description": "URL of the [Integration](#schema_integration)"
|
|
318489
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
316788
318490
|
},
|
|
316789
318491
|
"name": {
|
|
316790
318492
|
"type": "string",
|
|
316791
318493
|
"maxLength": 200,
|
|
316792
|
-
"description": "Name of the [
|
|
318494
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
316793
318495
|
},
|
|
316794
318496
|
"version": {
|
|
316795
318497
|
"type": "string",
|
|
316796
318498
|
"maxLength": 200,
|
|
316797
|
-
"description": "Version of the [
|
|
318499
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
316798
318500
|
},
|
|
316799
|
-
"
|
|
316800
|
-
"type": "
|
|
316801
|
-
"
|
|
316802
|
-
|
|
316803
|
-
|
|
316804
|
-
|
|
316805
|
-
|
|
316806
|
-
|
|
316807
|
-
|
|
316808
|
-
"description": "ID of the interface"
|
|
316809
|
-
},
|
|
316810
|
-
"name": {
|
|
316811
|
-
"type": "string",
|
|
316812
|
-
"maxLength": 200,
|
|
316813
|
-
"description": "Name of the interface"
|
|
316814
|
-
},
|
|
316815
|
-
"version": {
|
|
316816
|
-
"type": "string",
|
|
316817
|
-
"maxLength": 200,
|
|
316818
|
-
"description": "Version of the interface"
|
|
316819
|
-
},
|
|
316820
|
-
"entities": {
|
|
316821
|
-
"type": "object",
|
|
316822
|
-
"additionalProperties": {
|
|
316823
|
-
"type": "object",
|
|
316824
|
-
"properties": {
|
|
316825
|
-
"name": {
|
|
316826
|
-
"type": "string",
|
|
316827
|
-
"maxLength": 200
|
|
316828
|
-
}
|
|
316829
|
-
},
|
|
316830
|
-
"required": [
|
|
316831
|
-
"name"
|
|
316832
|
-
],
|
|
316833
|
-
"additionalProperties": false
|
|
316834
|
-
}
|
|
316835
|
-
},
|
|
316836
|
-
"actions": {
|
|
316837
|
-
"type": "object",
|
|
316838
|
-
"additionalProperties": {
|
|
316839
|
-
"type": "object",
|
|
316840
|
-
"properties": {
|
|
316841
|
-
"name": {
|
|
316842
|
-
"type": "string",
|
|
316843
|
-
"maxLength": 200
|
|
316844
|
-
}
|
|
316845
|
-
},
|
|
316846
|
-
"required": [
|
|
316847
|
-
"name"
|
|
316848
|
-
],
|
|
316849
|
-
"additionalProperties": false
|
|
316850
|
-
}
|
|
316851
|
-
},
|
|
316852
|
-
"events": {
|
|
316853
|
-
"type": "object",
|
|
316854
|
-
"additionalProperties": {
|
|
316855
|
-
"type": "object",
|
|
316856
|
-
"properties": {
|
|
316857
|
-
"name": {
|
|
316858
|
-
"type": "string",
|
|
316859
|
-
"maxLength": 200
|
|
316860
|
-
}
|
|
316861
|
-
},
|
|
316862
|
-
"required": [
|
|
316863
|
-
"name"
|
|
316864
|
-
],
|
|
316865
|
-
"additionalProperties": false
|
|
316866
|
-
}
|
|
316867
|
-
},
|
|
316868
|
-
"channels": {
|
|
316869
|
-
"type": "object",
|
|
316870
|
-
"additionalProperties": {
|
|
316871
|
-
"type": "object",
|
|
316872
|
-
"properties": {
|
|
316873
|
-
"name": {
|
|
316874
|
-
"type": "string",
|
|
316875
|
-
"maxLength": 200
|
|
316876
|
-
}
|
|
316877
|
-
},
|
|
316878
|
-
"required": [
|
|
316879
|
-
"name"
|
|
316880
|
-
],
|
|
316881
|
-
"additionalProperties": false
|
|
316882
|
-
}
|
|
316883
|
-
}
|
|
316884
|
-
},
|
|
316885
|
-
"required": [
|
|
316886
|
-
"id",
|
|
316887
|
-
"name",
|
|
316888
|
-
"version",
|
|
316889
|
-
"entities",
|
|
316890
|
-
"actions",
|
|
316891
|
-
"events",
|
|
316892
|
-
"channels"
|
|
316893
|
-
],
|
|
316894
|
-
"additionalProperties": false
|
|
316895
|
-
}
|
|
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"
|
|
316896
318510
|
},
|
|
316897
318511
|
"configuration": {
|
|
316898
318512
|
"type": "object",
|
|
@@ -316907,23 +318521,6 @@ var state5 = {
|
|
|
316907
318521
|
"maxLength": 256,
|
|
316908
318522
|
"description": "Description of the configuration"
|
|
316909
318523
|
},
|
|
316910
|
-
"identifier": {
|
|
316911
|
-
"type": "object",
|
|
316912
|
-
"properties": {
|
|
316913
|
-
"linkTemplateScript": {
|
|
316914
|
-
"type": "string",
|
|
316915
|
-
"maxLength": 2e3
|
|
316916
|
-
},
|
|
316917
|
-
"required": {
|
|
316918
|
-
"type": "boolean"
|
|
316919
|
-
}
|
|
316920
|
-
},
|
|
316921
|
-
"required": [
|
|
316922
|
-
"required"
|
|
316923
|
-
],
|
|
316924
|
-
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
316925
|
-
"additionalProperties": false
|
|
316926
|
-
},
|
|
316927
318524
|
"schema": {
|
|
316928
318525
|
"type": "object",
|
|
316929
318526
|
"additionalProperties": true,
|
|
@@ -316931,183 +318528,11 @@ var state5 = {
|
|
|
316931
318528
|
}
|
|
316932
318529
|
},
|
|
316933
318530
|
"required": [
|
|
316934
|
-
"identifier",
|
|
316935
318531
|
"schema"
|
|
316936
318532
|
],
|
|
316937
318533
|
"description": "Configuration definition",
|
|
316938
318534
|
"additionalProperties": false
|
|
316939
318535
|
},
|
|
316940
|
-
"configurations": {
|
|
316941
|
-
"type": "object",
|
|
316942
|
-
"additionalProperties": {
|
|
316943
|
-
"type": "object",
|
|
316944
|
-
"properties": {
|
|
316945
|
-
"title": {
|
|
316946
|
-
"type": "string",
|
|
316947
|
-
"maxLength": 64,
|
|
316948
|
-
"description": "Title of the configuration"
|
|
316949
|
-
},
|
|
316950
|
-
"description": {
|
|
316951
|
-
"type": "string",
|
|
316952
|
-
"maxLength": 256,
|
|
316953
|
-
"description": "Description of the configuration"
|
|
316954
|
-
},
|
|
316955
|
-
"identifier": {
|
|
316956
|
-
"type": "object",
|
|
316957
|
-
"properties": {
|
|
316958
|
-
"linkTemplateScript": {
|
|
316959
|
-
"type": "string",
|
|
316960
|
-
"maxLength": 2e3
|
|
316961
|
-
},
|
|
316962
|
-
"required": {
|
|
316963
|
-
"type": "boolean"
|
|
316964
|
-
}
|
|
316965
|
-
},
|
|
316966
|
-
"required": [
|
|
316967
|
-
"required"
|
|
316968
|
-
],
|
|
316969
|
-
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
316970
|
-
"additionalProperties": false
|
|
316971
|
-
},
|
|
316972
|
-
"schema": {
|
|
316973
|
-
"type": "object",
|
|
316974
|
-
"additionalProperties": true,
|
|
316975
|
-
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
316976
|
-
}
|
|
316977
|
-
},
|
|
316978
|
-
"required": [
|
|
316979
|
-
"identifier",
|
|
316980
|
-
"schema"
|
|
316981
|
-
],
|
|
316982
|
-
"description": "Configuration definition",
|
|
316983
|
-
"additionalProperties": false
|
|
316984
|
-
}
|
|
316985
|
-
},
|
|
316986
|
-
"channels": {
|
|
316987
|
-
"type": "object",
|
|
316988
|
-
"additionalProperties": {
|
|
316989
|
-
"type": "object",
|
|
316990
|
-
"properties": {
|
|
316991
|
-
"title": {
|
|
316992
|
-
"type": "string",
|
|
316993
|
-
"maxLength": 64,
|
|
316994
|
-
"description": "Title of the channel"
|
|
316995
|
-
},
|
|
316996
|
-
"description": {
|
|
316997
|
-
"type": "string",
|
|
316998
|
-
"maxLength": 256,
|
|
316999
|
-
"description": "Description of the channel"
|
|
317000
|
-
},
|
|
317001
|
-
"messages": {
|
|
317002
|
-
"type": "object",
|
|
317003
|
-
"additionalProperties": {
|
|
317004
|
-
"type": "object",
|
|
317005
|
-
"properties": {
|
|
317006
|
-
"schema": {
|
|
317007
|
-
"type": "object",
|
|
317008
|
-
"additionalProperties": true
|
|
317009
|
-
}
|
|
317010
|
-
},
|
|
317011
|
-
"required": [
|
|
317012
|
-
"schema"
|
|
317013
|
-
],
|
|
317014
|
-
"description": "Message definition",
|
|
317015
|
-
"additionalProperties": false
|
|
317016
|
-
}
|
|
317017
|
-
},
|
|
317018
|
-
"conversation": {
|
|
317019
|
-
"type": "object",
|
|
317020
|
-
"properties": {
|
|
317021
|
-
"tags": {
|
|
317022
|
-
"type": "object",
|
|
317023
|
-
"additionalProperties": {
|
|
317024
|
-
"type": "object",
|
|
317025
|
-
"properties": {
|
|
317026
|
-
"title": {
|
|
317027
|
-
"type": "string",
|
|
317028
|
-
"maxLength": 64,
|
|
317029
|
-
"description": "Title of the tag"
|
|
317030
|
-
},
|
|
317031
|
-
"description": {
|
|
317032
|
-
"type": "string",
|
|
317033
|
-
"maxLength": 256,
|
|
317034
|
-
"description": "Description of the tag"
|
|
317035
|
-
}
|
|
317036
|
-
},
|
|
317037
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
317038
|
-
"additionalProperties": false
|
|
317039
|
-
}
|
|
317040
|
-
},
|
|
317041
|
-
"creation": {
|
|
317042
|
-
"type": "object",
|
|
317043
|
-
"properties": {
|
|
317044
|
-
"enabled": {
|
|
317045
|
-
"type": "boolean",
|
|
317046
|
-
"description": "Enable conversation creation"
|
|
317047
|
-
},
|
|
317048
|
-
"requiredTags": {
|
|
317049
|
-
"type": "array",
|
|
317050
|
-
"items": {
|
|
317051
|
-
"type": "string"
|
|
317052
|
-
},
|
|
317053
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
317054
|
-
}
|
|
317055
|
-
},
|
|
317056
|
-
"required": [
|
|
317057
|
-
"enabled",
|
|
317058
|
-
"requiredTags"
|
|
317059
|
-
],
|
|
317060
|
-
"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.",
|
|
317061
|
-
"additionalProperties": false
|
|
317062
|
-
}
|
|
317063
|
-
},
|
|
317064
|
-
"required": [
|
|
317065
|
-
"tags",
|
|
317066
|
-
"creation"
|
|
317067
|
-
],
|
|
317068
|
-
"description": "Conversation object configuration",
|
|
317069
|
-
"additionalProperties": false
|
|
317070
|
-
},
|
|
317071
|
-
"message": {
|
|
317072
|
-
"type": "object",
|
|
317073
|
-
"properties": {
|
|
317074
|
-
"tags": {
|
|
317075
|
-
"type": "object",
|
|
317076
|
-
"additionalProperties": {
|
|
317077
|
-
"type": "object",
|
|
317078
|
-
"properties": {
|
|
317079
|
-
"title": {
|
|
317080
|
-
"type": "string",
|
|
317081
|
-
"maxLength": 64,
|
|
317082
|
-
"description": "Title of the tag"
|
|
317083
|
-
},
|
|
317084
|
-
"description": {
|
|
317085
|
-
"type": "string",
|
|
317086
|
-
"maxLength": 256,
|
|
317087
|
-
"description": "Description of the tag"
|
|
317088
|
-
}
|
|
317089
|
-
},
|
|
317090
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
317091
|
-
"additionalProperties": false
|
|
317092
|
-
}
|
|
317093
|
-
}
|
|
317094
|
-
},
|
|
317095
|
-
"required": [
|
|
317096
|
-
"tags"
|
|
317097
|
-
],
|
|
317098
|
-
"description": "Message object configuration",
|
|
317099
|
-
"additionalProperties": false
|
|
317100
|
-
}
|
|
317101
|
-
},
|
|
317102
|
-
"required": [
|
|
317103
|
-
"messages",
|
|
317104
|
-
"conversation",
|
|
317105
|
-
"message"
|
|
317106
|
-
],
|
|
317107
|
-
"description": "Channel definition",
|
|
317108
|
-
"additionalProperties": false
|
|
317109
|
-
}
|
|
317110
|
-
},
|
|
317111
318536
|
"states": {
|
|
317112
318537
|
"type": "object",
|
|
317113
318538
|
"additionalProperties": {
|
|
@@ -317118,21 +318543,26 @@ var state5 = {
|
|
|
317118
318543
|
"enum": [
|
|
317119
318544
|
"conversation",
|
|
317120
318545
|
"user",
|
|
317121
|
-
"
|
|
318546
|
+
"bot",
|
|
318547
|
+
"task"
|
|
317122
318548
|
],
|
|
317123
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
318549
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
317124
318550
|
},
|
|
317125
318551
|
"schema": {
|
|
317126
318552
|
"type": "object",
|
|
317127
318553
|
"additionalProperties": true,
|
|
317128
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."
|
|
317129
318560
|
}
|
|
317130
318561
|
},
|
|
317131
318562
|
"required": [
|
|
317132
318563
|
"type",
|
|
317133
318564
|
"schema"
|
|
317134
318565
|
],
|
|
317135
|
-
"description": "State definition",
|
|
317136
318566
|
"additionalProperties": false
|
|
317137
318567
|
}
|
|
317138
318568
|
},
|
|
@@ -317219,6 +318649,70 @@ var state5 = {
|
|
|
317219
318649
|
"additionalProperties": false
|
|
317220
318650
|
}
|
|
317221
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
|
+
},
|
|
317222
318716
|
"user": {
|
|
317223
318717
|
"type": "object",
|
|
317224
318718
|
"properties": {
|
|
@@ -317241,38 +318735,212 @@ var state5 = {
|
|
|
317241
318735
|
"description": "Definition of a tag that can be provided on the object",
|
|
317242
318736
|
"additionalProperties": false
|
|
317243
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"
|
|
317244
318892
|
},
|
|
317245
|
-
"
|
|
318893
|
+
"description": {
|
|
318894
|
+
"type": "string",
|
|
318895
|
+
"maxLength": 256,
|
|
318896
|
+
"description": "Description of the configuration"
|
|
318897
|
+
},
|
|
318898
|
+
"schema": {
|
|
317246
318899
|
"type": "object",
|
|
317247
|
-
"
|
|
317248
|
-
|
|
317249
|
-
"type": "boolean",
|
|
317250
|
-
"description": "Enable user creation"
|
|
317251
|
-
},
|
|
317252
|
-
"requiredTags": {
|
|
317253
|
-
"type": "array",
|
|
317254
|
-
"items": {
|
|
317255
|
-
"type": "string"
|
|
317256
|
-
},
|
|
317257
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
317258
|
-
}
|
|
317259
|
-
},
|
|
317260
|
-
"required": [
|
|
317261
|
-
"enabled",
|
|
317262
|
-
"requiredTags"
|
|
317263
|
-
],
|
|
317264
|
-
"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.",
|
|
317265
|
-
"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`."
|
|
317266
318902
|
}
|
|
317267
318903
|
},
|
|
317268
318904
|
"required": [
|
|
317269
|
-
"
|
|
317270
|
-
"creation"
|
|
318905
|
+
"schema"
|
|
317271
318906
|
],
|
|
317272
|
-
"description": "
|
|
318907
|
+
"description": "Configuration definition",
|
|
317273
318908
|
"additionalProperties": false
|
|
317274
318909
|
},
|
|
317275
|
-
"
|
|
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": {
|
|
317276
318944
|
"type": "object",
|
|
317277
318945
|
"additionalProperties": {
|
|
317278
318946
|
"type": "object",
|
|
@@ -317280,12 +318948,12 @@ var state5 = {
|
|
|
317280
318948
|
"title": {
|
|
317281
318949
|
"type": "string",
|
|
317282
318950
|
"maxLength": 64,
|
|
317283
|
-
"description": "Title of the
|
|
318951
|
+
"description": "Title of the event"
|
|
317284
318952
|
},
|
|
317285
318953
|
"description": {
|
|
317286
318954
|
"type": "string",
|
|
317287
318955
|
"maxLength": 256,
|
|
317288
|
-
"description": "Description of the
|
|
318956
|
+
"description": "Description of the event"
|
|
317289
318957
|
},
|
|
317290
318958
|
"schema": {
|
|
317291
318959
|
"type": "object",
|
|
@@ -317295,127 +318963,282 @@ var state5 = {
|
|
|
317295
318963
|
"required": [
|
|
317296
318964
|
"schema"
|
|
317297
318965
|
],
|
|
317298
|
-
"description": "
|
|
318966
|
+
"description": "Event Definition",
|
|
317299
318967
|
"additionalProperties": false
|
|
317300
318968
|
}
|
|
317301
318969
|
},
|
|
317302
|
-
"
|
|
317303
|
-
"type": "
|
|
317304
|
-
"
|
|
317305
|
-
|
|
317306
|
-
|
|
317307
|
-
|
|
317308
|
-
|
|
317309
|
-
|
|
317310
|
-
|
|
317311
|
-
|
|
317312
|
-
|
|
317313
|
-
|
|
317314
|
-
|
|
317315
|
-
|
|
317316
|
-
|
|
317317
|
-
|
|
317318
|
-
|
|
317319
|
-
|
|
317320
|
-
|
|
317321
|
-
|
|
317322
|
-
|
|
317323
|
-
|
|
317324
|
-
|
|
317325
|
-
|
|
317326
|
-
|
|
317327
|
-
|
|
317328
|
-
|
|
317329
|
-
|
|
317330
|
-
|
|
317331
|
-
|
|
317332
|
-
|
|
317333
|
-
|
|
317334
|
-
|
|
317335
|
-
|
|
317336
|
-
|
|
317337
|
-
|
|
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
|
+
}
|
|
317338
319025
|
},
|
|
317339
|
-
"
|
|
317340
|
-
"type": "
|
|
317341
|
-
"
|
|
317342
|
-
"
|
|
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
|
+
}
|
|
317343
319083
|
},
|
|
317344
|
-
"
|
|
319084
|
+
"required": [
|
|
319085
|
+
"interfaces",
|
|
319086
|
+
"integrations"
|
|
319087
|
+
],
|
|
319088
|
+
"additionalProperties": false
|
|
317345
319089
|
},
|
|
317346
|
-
"
|
|
319090
|
+
"user": {
|
|
317347
319091
|
"type": "object",
|
|
317348
319092
|
"properties": {
|
|
317349
|
-
"
|
|
317350
|
-
"type": "
|
|
317351
|
-
|
|
317352
|
-
|
|
317353
|
-
|
|
317354
|
-
|
|
317355
|
-
|
|
317356
|
-
|
|
317357
|
-
|
|
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
|
+
}
|
|
317358
319112
|
}
|
|
317359
319113
|
},
|
|
317360
319114
|
"required": [
|
|
317361
|
-
"
|
|
317362
|
-
"handle",
|
|
317363
|
-
"name"
|
|
319115
|
+
"tags"
|
|
317364
319116
|
],
|
|
319117
|
+
"description": "User object configuration",
|
|
317365
319118
|
"additionalProperties": false
|
|
317366
319119
|
},
|
|
317367
|
-
"
|
|
319120
|
+
"conversation": {
|
|
317368
319121
|
"type": "object",
|
|
317369
319122
|
"properties": {
|
|
317370
|
-
"
|
|
317371
|
-
"type": "
|
|
317372
|
-
|
|
317373
|
-
|
|
317374
|
-
|
|
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
|
+
}
|
|
317375
319142
|
}
|
|
317376
319143
|
},
|
|
317377
319144
|
"required": [
|
|
317378
|
-
"
|
|
317379
|
-
"views"
|
|
319145
|
+
"tags"
|
|
317380
319146
|
],
|
|
319147
|
+
"description": "Conversation object configuration",
|
|
317381
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."
|
|
317382
319172
|
}
|
|
317383
319173
|
},
|
|
317384
319174
|
"required": [
|
|
317385
319175
|
"id",
|
|
317386
|
-
"createdAt",
|
|
317387
|
-
"updatedAt",
|
|
317388
|
-
"identifier",
|
|
317389
|
-
"url",
|
|
317390
319176
|
"name",
|
|
317391
319177
|
"version",
|
|
317392
|
-
"
|
|
319178
|
+
"createdAt",
|
|
319179
|
+
"updatedAt",
|
|
317393
319180
|
"configuration",
|
|
317394
|
-
"configurations",
|
|
317395
|
-
"channels",
|
|
317396
319181
|
"states",
|
|
317397
319182
|
"events",
|
|
317398
319183
|
"actions",
|
|
319184
|
+
"dependencies",
|
|
317399
319185
|
"user",
|
|
317400
|
-
"
|
|
317401
|
-
"dev",
|
|
319186
|
+
"conversation",
|
|
317402
319187
|
"title",
|
|
317403
319188
|
"description",
|
|
317404
319189
|
"iconUrl",
|
|
317405
319190
|
"readmeUrl",
|
|
317406
|
-
"public"
|
|
317407
|
-
"verificationStatus",
|
|
317408
|
-
"secrets",
|
|
317409
|
-
"ownerWorkspace",
|
|
317410
|
-
"meta"
|
|
319191
|
+
"public"
|
|
317411
319192
|
],
|
|
317412
319193
|
"additionalProperties": false
|
|
317413
319194
|
}
|
|
317414
319195
|
},
|
|
317415
319196
|
"required": [
|
|
317416
|
-
"
|
|
319197
|
+
"plugin"
|
|
317417
319198
|
],
|
|
317418
|
-
"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",
|
|
317419
319242
|
"additionalProperties": false
|
|
317420
319243
|
}
|
|
317421
319244
|
}
|
|
@@ -325439,6 +327262,11 @@ var state5 = {
|
|
|
325439
327262
|
"in": "query",
|
|
325440
327263
|
"type": "string",
|
|
325441
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"
|
|
325442
327270
|
}
|
|
325443
327271
|
},
|
|
325444
327272
|
"response": {
|
|
@@ -328846,7 +330674,7 @@ var state5 = {
|
|
|
328846
330674
|
"title": "Botpress API",
|
|
328847
330675
|
"description": "API for Botpress Cloud",
|
|
328848
330676
|
"server": "https://api.botpress.cloud",
|
|
328849
|
-
"version": "1.
|
|
330677
|
+
"version": "1.5.0",
|
|
328850
330678
|
"prefix": "v1"
|
|
328851
330679
|
},
|
|
328852
330680
|
"errors": [
|
|
@@ -329099,6 +330927,10 @@ var state5 = {
|
|
|
329099
330927
|
"listPublicIntegrationsResponse": true,
|
|
329100
330928
|
"getPublicIntegrationByIdResponse": true,
|
|
329101
330929
|
"getPublicIntegrationResponse": true,
|
|
330930
|
+
"listPublicPluginsResponse": true,
|
|
330931
|
+
"getPublicPluginByIdResponse": true,
|
|
330932
|
+
"getPublicPluginResponse": true,
|
|
330933
|
+
"getPublicPluginCodeResponse": true,
|
|
329102
330934
|
"createBotResponse": true,
|
|
329103
330935
|
"updateBotResponse": true,
|
|
329104
330936
|
"transferBotResponse": true,
|
|
@@ -332534,7 +334366,11 @@ var state5 = {
|
|
|
332534
334366
|
"operations": [
|
|
332535
334367
|
"listPublicIntegrations",
|
|
332536
334368
|
"getPublicIntegrationById",
|
|
332537
|
-
"getPublicIntegration"
|
|
334369
|
+
"getPublicIntegration",
|
|
334370
|
+
"listPublicPlugins",
|
|
334371
|
+
"getPublicPluginById",
|
|
334372
|
+
"getPublicPlugin",
|
|
334373
|
+
"getPublicPluginCode"
|
|
332538
334374
|
]
|
|
332539
334375
|
},
|
|
332540
334376
|
{
|