@botpress/api 1.25.0 → 1.27.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 +1533 -615
- package/dist/src/gen/admin/state.d.ts +401 -0
- package/dist/src/gen/state.d.ts +401 -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 +460 -1
- 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 +460 -1
- package/src/gen/tables/openapi.json +1 -1
- package/src/gen/tables/state.ts +1 -1
package/dist/index.js
CHANGED
|
@@ -284652,7 +284652,7 @@ var state = {
|
|
|
284652
284652
|
"title": "Botpress API",
|
|
284653
284653
|
"description": "API for Botpress Cloud",
|
|
284654
284654
|
"server": "https://api.botpress.cloud",
|
|
284655
|
-
"version": "1.
|
|
284655
|
+
"version": "1.27.0",
|
|
284656
284656
|
"prefix": "v1"
|
|
284657
284657
|
},
|
|
284658
284658
|
"errors": [
|
|
@@ -291227,25 +291227,34 @@ var state2 = {
|
|
|
291227
291227
|
}
|
|
291228
291228
|
}
|
|
291229
291229
|
},
|
|
291230
|
-
"
|
|
291231
|
-
"name": "
|
|
291232
|
-
"description": "Get public plugin by
|
|
291230
|
+
"getDereferencedPublicPluginById": {
|
|
291231
|
+
"name": "getDereferencedPublicPluginById",
|
|
291232
|
+
"description": "Get public plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
291233
291233
|
"method": "get",
|
|
291234
291234
|
"section": "hub",
|
|
291235
|
-
"path": "/v1/admin/hub/plugins/{
|
|
291235
|
+
"path": "/v1/admin/hub/plugins/{id}/dereferenced",
|
|
291236
291236
|
"disableDefaultParameters": {
|
|
291237
291237
|
"x-workspace-id": true
|
|
291238
291238
|
},
|
|
291239
291239
|
"parameters": {
|
|
291240
|
-
"
|
|
291240
|
+
"id": {
|
|
291241
291241
|
"type": "string",
|
|
291242
|
-
"description": "Plugin
|
|
291242
|
+
"description": "Plugin ID",
|
|
291243
291243
|
"in": "path"
|
|
291244
291244
|
},
|
|
291245
|
-
"
|
|
291246
|
-
"
|
|
291247
|
-
"
|
|
291248
|
-
"
|
|
291245
|
+
"interfaces": {
|
|
291246
|
+
"in": "query",
|
|
291247
|
+
"type": "object",
|
|
291248
|
+
"schema": {
|
|
291249
|
+
"type": "object",
|
|
291250
|
+
"additionalProperties": {
|
|
291251
|
+
"type": "string",
|
|
291252
|
+
"description": "integration id"
|
|
291253
|
+
},
|
|
291254
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
291255
|
+
},
|
|
291256
|
+
"description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
|
|
291257
|
+
"required": true
|
|
291249
291258
|
}
|
|
291250
291259
|
},
|
|
291251
291260
|
"response": {
|
|
@@ -291620,186 +291629,29 @@ var state2 = {
|
|
|
291620
291629
|
"required": [
|
|
291621
291630
|
"plugin"
|
|
291622
291631
|
],
|
|
291623
|
-
"title": "
|
|
291624
|
-
"additionalProperties": false
|
|
291625
|
-
}
|
|
291626
|
-
}
|
|
291627
|
-
},
|
|
291628
|
-
"getPublicPluginCode": {
|
|
291629
|
-
"name": "getPublicPluginCode",
|
|
291630
|
-
"description": "Get public plugin code",
|
|
291631
|
-
"method": "get",
|
|
291632
|
-
"path": "/v1/admin/hub/plugins/{id}/code/{platform}",
|
|
291633
|
-
"disableDefaultParameters": {
|
|
291634
|
-
"x-workspace-id": true
|
|
291635
|
-
},
|
|
291636
|
-
"section": "hub",
|
|
291637
|
-
"parameters": {
|
|
291638
|
-
"id": {
|
|
291639
|
-
"in": "path",
|
|
291640
|
-
"type": "string",
|
|
291641
|
-
"description": "Plugin id"
|
|
291642
|
-
},
|
|
291643
|
-
"platform": {
|
|
291644
|
-
"in": "path",
|
|
291645
|
-
"type": "string",
|
|
291646
|
-
"enum": [
|
|
291647
|
-
"node",
|
|
291648
|
-
"browser"
|
|
291649
|
-
],
|
|
291650
|
-
"description": "Platform"
|
|
291651
|
-
}
|
|
291652
|
-
},
|
|
291653
|
-
"response": {
|
|
291654
|
-
"description": "Plugin code",
|
|
291655
|
-
"schema": {
|
|
291656
|
-
"type": "object",
|
|
291657
|
-
"properties": {
|
|
291658
|
-
"code": {
|
|
291659
|
-
"type": "string"
|
|
291660
|
-
}
|
|
291661
|
-
},
|
|
291662
|
-
"required": [
|
|
291663
|
-
"code"
|
|
291664
|
-
],
|
|
291665
|
-
"title": "getPublicPluginCodeResponse",
|
|
291632
|
+
"title": "getDereferencedPublicPluginByIdResponse",
|
|
291666
291633
|
"additionalProperties": false
|
|
291667
291634
|
}
|
|
291668
291635
|
}
|
|
291669
291636
|
},
|
|
291670
|
-
"
|
|
291671
|
-
"name": "
|
|
291672
|
-
"description": "
|
|
291637
|
+
"getPublicPlugin": {
|
|
291638
|
+
"name": "getPublicPlugin",
|
|
291639
|
+
"description": "Get public plugin by name and version",
|
|
291673
291640
|
"method": "get",
|
|
291674
291641
|
"section": "hub",
|
|
291675
|
-
"path": "/v1/admin/hub/
|
|
291642
|
+
"path": "/v1/admin/hub/plugins/{name}/{version}",
|
|
291676
291643
|
"disableDefaultParameters": {
|
|
291677
291644
|
"x-workspace-id": true
|
|
291678
291645
|
},
|
|
291679
291646
|
"parameters": {
|
|
291680
|
-
"nextToken": {
|
|
291681
|
-
"in": "query",
|
|
291682
|
-
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
291683
|
-
"type": "string"
|
|
291684
|
-
},
|
|
291685
291647
|
"name": {
|
|
291686
|
-
"in": "query",
|
|
291687
291648
|
"type": "string",
|
|
291688
|
-
"description": "
|
|
291649
|
+
"description": "Plugin Name",
|
|
291650
|
+
"in": "path"
|
|
291689
291651
|
},
|
|
291690
291652
|
"version": {
|
|
291691
|
-
"in": "query",
|
|
291692
|
-
"type": "string",
|
|
291693
|
-
"description": "Filter an interface by name and version"
|
|
291694
|
-
}
|
|
291695
|
-
},
|
|
291696
|
-
"response": {
|
|
291697
|
-
"description": "Success",
|
|
291698
|
-
"schema": {
|
|
291699
|
-
"type": "object",
|
|
291700
|
-
"properties": {
|
|
291701
|
-
"interfaces": {
|
|
291702
|
-
"type": "array",
|
|
291703
|
-
"items": {
|
|
291704
|
-
"type": "object",
|
|
291705
|
-
"properties": {
|
|
291706
|
-
"id": {
|
|
291707
|
-
"type": "string",
|
|
291708
|
-
"minLength": 28,
|
|
291709
|
-
"maxLength": 36,
|
|
291710
|
-
"description": "ID of the [Interface](#schema_interface)"
|
|
291711
|
-
},
|
|
291712
|
-
"createdAt": {
|
|
291713
|
-
"type": "string",
|
|
291714
|
-
"format": "date-time",
|
|
291715
|
-
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
291716
|
-
},
|
|
291717
|
-
"updatedAt": {
|
|
291718
|
-
"type": "string",
|
|
291719
|
-
"format": "date-time",
|
|
291720
|
-
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
291721
|
-
},
|
|
291722
|
-
"name": {
|
|
291723
|
-
"type": "string",
|
|
291724
|
-
"maxLength": 200,
|
|
291725
|
-
"description": "Name of the [Interface](#schema_interface)"
|
|
291726
|
-
},
|
|
291727
|
-
"version": {
|
|
291728
|
-
"type": "string",
|
|
291729
|
-
"maxLength": 200,
|
|
291730
|
-
"description": "Version of the [Interface](#schema_interface)"
|
|
291731
|
-
},
|
|
291732
|
-
"title": {
|
|
291733
|
-
"type": "string",
|
|
291734
|
-
"minLength": 1,
|
|
291735
|
-
"maxLength": 64,
|
|
291736
|
-
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
291737
|
-
},
|
|
291738
|
-
"description": {
|
|
291739
|
-
"type": "string",
|
|
291740
|
-
"maxLength": 256,
|
|
291741
|
-
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
291742
|
-
},
|
|
291743
|
-
"iconUrl": {
|
|
291744
|
-
"type": "string",
|
|
291745
|
-
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
291746
|
-
},
|
|
291747
|
-
"readmeUrl": {
|
|
291748
|
-
"type": "string",
|
|
291749
|
-
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
291750
|
-
},
|
|
291751
|
-
"public": {
|
|
291752
|
-
"type": "boolean",
|
|
291753
|
-
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
291754
|
-
}
|
|
291755
|
-
},
|
|
291756
|
-
"required": [
|
|
291757
|
-
"id",
|
|
291758
|
-
"createdAt",
|
|
291759
|
-
"updatedAt",
|
|
291760
|
-
"name",
|
|
291761
|
-
"version",
|
|
291762
|
-
"title",
|
|
291763
|
-
"description",
|
|
291764
|
-
"iconUrl",
|
|
291765
|
-
"readmeUrl",
|
|
291766
|
-
"public"
|
|
291767
|
-
]
|
|
291768
|
-
}
|
|
291769
|
-
},
|
|
291770
|
-
"meta": {
|
|
291771
|
-
"type": "object",
|
|
291772
|
-
"properties": {
|
|
291773
|
-
"nextToken": {
|
|
291774
|
-
"type": "string",
|
|
291775
|
-
"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."
|
|
291776
|
-
}
|
|
291777
|
-
},
|
|
291778
|
-
"additionalProperties": false
|
|
291779
|
-
}
|
|
291780
|
-
},
|
|
291781
|
-
"required": [
|
|
291782
|
-
"interfaces",
|
|
291783
|
-
"meta"
|
|
291784
|
-
],
|
|
291785
|
-
"title": "listPublicInterfacesResponse",
|
|
291786
|
-
"additionalProperties": false
|
|
291787
|
-
}
|
|
291788
|
-
}
|
|
291789
|
-
},
|
|
291790
|
-
"getPublicInterfaceById": {
|
|
291791
|
-
"name": "getPublicInterfaceById",
|
|
291792
|
-
"description": "Get public interface by Id",
|
|
291793
|
-
"method": "get",
|
|
291794
|
-
"section": "hub",
|
|
291795
|
-
"path": "/v1/admin/hub/interfaces/{id}",
|
|
291796
|
-
"disableDefaultParameters": {
|
|
291797
|
-
"x-workspace-id": true
|
|
291798
|
-
},
|
|
291799
|
-
"parameters": {
|
|
291800
|
-
"id": {
|
|
291801
291653
|
"type": "string",
|
|
291802
|
-
"description": "
|
|
291654
|
+
"description": "Plugin version.",
|
|
291803
291655
|
"in": "path"
|
|
291804
291656
|
}
|
|
291805
291657
|
},
|
|
@@ -291808,59 +291660,90 @@ var state2 = {
|
|
|
291808
291660
|
"schema": {
|
|
291809
291661
|
"type": "object",
|
|
291810
291662
|
"properties": {
|
|
291811
|
-
"
|
|
291663
|
+
"plugin": {
|
|
291812
291664
|
"type": "object",
|
|
291813
291665
|
"properties": {
|
|
291814
291666
|
"id": {
|
|
291815
291667
|
"type": "string",
|
|
291816
291668
|
"minLength": 28,
|
|
291817
291669
|
"maxLength": 36,
|
|
291818
|
-
"description": "ID of the [
|
|
291670
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
291671
|
+
},
|
|
291672
|
+
"name": {
|
|
291673
|
+
"type": "string",
|
|
291674
|
+
"maxLength": 200,
|
|
291675
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
291676
|
+
},
|
|
291677
|
+
"version": {
|
|
291678
|
+
"type": "string",
|
|
291679
|
+
"maxLength": 200,
|
|
291680
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
291819
291681
|
},
|
|
291820
291682
|
"createdAt": {
|
|
291821
291683
|
"type": "string",
|
|
291822
291684
|
"format": "date-time",
|
|
291823
|
-
"description": "Creation date of the [
|
|
291685
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
291824
291686
|
},
|
|
291825
291687
|
"updatedAt": {
|
|
291826
291688
|
"type": "string",
|
|
291827
291689
|
"format": "date-time",
|
|
291828
|
-
"description": "Updating date of the [
|
|
291829
|
-
},
|
|
291830
|
-
"name": {
|
|
291831
|
-
"type": "string",
|
|
291832
|
-
"maxLength": 200,
|
|
291833
|
-
"description": "Name of the [Interface](#schema_interface)"
|
|
291690
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
291834
291691
|
},
|
|
291835
|
-
"
|
|
291836
|
-
"type": "
|
|
291837
|
-
"
|
|
291838
|
-
|
|
291692
|
+
"configuration": {
|
|
291693
|
+
"type": "object",
|
|
291694
|
+
"properties": {
|
|
291695
|
+
"title": {
|
|
291696
|
+
"type": "string",
|
|
291697
|
+
"maxLength": 64,
|
|
291698
|
+
"description": "Title of the configuration"
|
|
291699
|
+
},
|
|
291700
|
+
"description": {
|
|
291701
|
+
"type": "string",
|
|
291702
|
+
"maxLength": 256,
|
|
291703
|
+
"description": "Description of the configuration"
|
|
291704
|
+
},
|
|
291705
|
+
"schema": {
|
|
291706
|
+
"type": "object",
|
|
291707
|
+
"additionalProperties": true,
|
|
291708
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
291709
|
+
}
|
|
291710
|
+
},
|
|
291711
|
+
"required": [
|
|
291712
|
+
"schema"
|
|
291713
|
+
],
|
|
291714
|
+
"description": "Configuration definition",
|
|
291715
|
+
"additionalProperties": false
|
|
291839
291716
|
},
|
|
291840
|
-
"
|
|
291717
|
+
"states": {
|
|
291841
291718
|
"type": "object",
|
|
291842
291719
|
"additionalProperties": {
|
|
291843
291720
|
"type": "object",
|
|
291844
291721
|
"properties": {
|
|
291845
|
-
"
|
|
291846
|
-
"type": "string",
|
|
291847
|
-
"maxLength": 64,
|
|
291848
|
-
"description": "Title of the entity"
|
|
291849
|
-
},
|
|
291850
|
-
"description": {
|
|
291722
|
+
"type": {
|
|
291851
291723
|
"type": "string",
|
|
291852
|
-
"
|
|
291853
|
-
|
|
291724
|
+
"enum": [
|
|
291725
|
+
"conversation",
|
|
291726
|
+
"user",
|
|
291727
|
+
"bot",
|
|
291728
|
+
"task"
|
|
291729
|
+
],
|
|
291730
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
291854
291731
|
},
|
|
291855
291732
|
"schema": {
|
|
291856
291733
|
"type": "object",
|
|
291857
|
-
"additionalProperties": true
|
|
291734
|
+
"additionalProperties": true,
|
|
291735
|
+
"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."
|
|
291736
|
+
},
|
|
291737
|
+
"expiry": {
|
|
291738
|
+
"type": "number",
|
|
291739
|
+
"minimum": 1,
|
|
291740
|
+
"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."
|
|
291858
291741
|
}
|
|
291859
291742
|
},
|
|
291860
291743
|
"required": [
|
|
291744
|
+
"type",
|
|
291861
291745
|
"schema"
|
|
291862
291746
|
],
|
|
291863
|
-
"description": "Entity definition",
|
|
291864
291747
|
"additionalProperties": false
|
|
291865
291748
|
}
|
|
291866
291749
|
},
|
|
@@ -291963,62 +291846,128 @@ var state2 = {
|
|
|
291963
291846
|
"additionalProperties": false
|
|
291964
291847
|
}
|
|
291965
291848
|
},
|
|
291966
|
-
"
|
|
291849
|
+
"dependencies": {
|
|
291967
291850
|
"type": "object",
|
|
291968
|
-
"
|
|
291969
|
-
"
|
|
291970
|
-
|
|
291971
|
-
"
|
|
291972
|
-
"type": "string",
|
|
291973
|
-
"maxLength": 64,
|
|
291974
|
-
"description": "Title of the channel"
|
|
291975
|
-
},
|
|
291976
|
-
"description": {
|
|
291977
|
-
"type": "string",
|
|
291978
|
-
"maxLength": 256,
|
|
291979
|
-
"description": "Description of the channel"
|
|
291980
|
-
},
|
|
291981
|
-
"messages": {
|
|
291851
|
+
"properties": {
|
|
291852
|
+
"interfaces": {
|
|
291853
|
+
"type": "object",
|
|
291854
|
+
"additionalProperties": {
|
|
291982
291855
|
"type": "object",
|
|
291983
|
-
"
|
|
291984
|
-
"
|
|
291985
|
-
|
|
291986
|
-
"
|
|
291987
|
-
|
|
291988
|
-
"additionalProperties": true
|
|
291989
|
-
}
|
|
291856
|
+
"properties": {
|
|
291857
|
+
"id": {
|
|
291858
|
+
"type": "string",
|
|
291859
|
+
"minLength": 28,
|
|
291860
|
+
"maxLength": 36
|
|
291990
291861
|
},
|
|
291991
|
-
"
|
|
291992
|
-
"
|
|
291993
|
-
|
|
291994
|
-
|
|
291995
|
-
"
|
|
291996
|
-
|
|
291862
|
+
"name": {
|
|
291863
|
+
"type": "string",
|
|
291864
|
+
"maxLength": 200
|
|
291865
|
+
},
|
|
291866
|
+
"version": {
|
|
291867
|
+
"type": "string",
|
|
291868
|
+
"maxLength": 200
|
|
291869
|
+
}
|
|
291870
|
+
},
|
|
291871
|
+
"required": [
|
|
291872
|
+
"id",
|
|
291873
|
+
"name",
|
|
291874
|
+
"version"
|
|
291875
|
+
],
|
|
291876
|
+
"additionalProperties": false
|
|
291997
291877
|
}
|
|
291998
291878
|
},
|
|
291999
|
-
"
|
|
292000
|
-
"
|
|
292001
|
-
|
|
292002
|
-
|
|
292003
|
-
|
|
291879
|
+
"integrations": {
|
|
291880
|
+
"type": "object",
|
|
291881
|
+
"additionalProperties": {
|
|
291882
|
+
"type": "object",
|
|
291883
|
+
"properties": {
|
|
291884
|
+
"id": {
|
|
291885
|
+
"type": "string",
|
|
291886
|
+
"minLength": 28,
|
|
291887
|
+
"maxLength": 36
|
|
291888
|
+
},
|
|
291889
|
+
"name": {
|
|
291890
|
+
"type": "string",
|
|
291891
|
+
"maxLength": 200
|
|
291892
|
+
},
|
|
291893
|
+
"version": {
|
|
291894
|
+
"type": "string",
|
|
291895
|
+
"maxLength": 200
|
|
291896
|
+
}
|
|
291897
|
+
},
|
|
291898
|
+
"required": [
|
|
291899
|
+
"id",
|
|
291900
|
+
"name",
|
|
291901
|
+
"version"
|
|
291902
|
+
],
|
|
291903
|
+
"additionalProperties": false
|
|
291904
|
+
}
|
|
291905
|
+
}
|
|
291906
|
+
},
|
|
291907
|
+
"required": [
|
|
291908
|
+
"interfaces",
|
|
291909
|
+
"integrations"
|
|
291910
|
+
],
|
|
291911
|
+
"additionalProperties": false
|
|
292004
291912
|
},
|
|
292005
|
-
"
|
|
291913
|
+
"user": {
|
|
292006
291914
|
"type": "object",
|
|
292007
291915
|
"properties": {
|
|
292008
|
-
"
|
|
292009
|
-
"type": "
|
|
292010
|
-
"
|
|
292011
|
-
|
|
292012
|
-
|
|
292013
|
-
|
|
292014
|
-
|
|
291916
|
+
"tags": {
|
|
291917
|
+
"type": "object",
|
|
291918
|
+
"additionalProperties": {
|
|
291919
|
+
"type": "object",
|
|
291920
|
+
"properties": {
|
|
291921
|
+
"title": {
|
|
291922
|
+
"type": "string",
|
|
291923
|
+
"maxLength": 64,
|
|
291924
|
+
"description": "Title of the tag"
|
|
291925
|
+
},
|
|
291926
|
+
"description": {
|
|
291927
|
+
"type": "string",
|
|
291928
|
+
"maxLength": 256,
|
|
291929
|
+
"description": "Description of the tag"
|
|
291930
|
+
}
|
|
291931
|
+
},
|
|
291932
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
291933
|
+
"additionalProperties": false
|
|
291934
|
+
}
|
|
292015
291935
|
}
|
|
292016
291936
|
},
|
|
292017
291937
|
"required": [
|
|
292018
|
-
"
|
|
292019
|
-
"language"
|
|
291938
|
+
"tags"
|
|
292020
291939
|
],
|
|
292021
|
-
"description": "
|
|
291940
|
+
"description": "User object configuration",
|
|
291941
|
+
"additionalProperties": false
|
|
291942
|
+
},
|
|
291943
|
+
"conversation": {
|
|
291944
|
+
"type": "object",
|
|
291945
|
+
"properties": {
|
|
291946
|
+
"tags": {
|
|
291947
|
+
"type": "object",
|
|
291948
|
+
"additionalProperties": {
|
|
291949
|
+
"type": "object",
|
|
291950
|
+
"properties": {
|
|
291951
|
+
"title": {
|
|
291952
|
+
"type": "string",
|
|
291953
|
+
"maxLength": 64,
|
|
291954
|
+
"description": "Title of the tag"
|
|
291955
|
+
},
|
|
291956
|
+
"description": {
|
|
291957
|
+
"type": "string",
|
|
291958
|
+
"maxLength": 256,
|
|
291959
|
+
"description": "Description of the tag"
|
|
291960
|
+
}
|
|
291961
|
+
},
|
|
291962
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
291963
|
+
"additionalProperties": false
|
|
291964
|
+
}
|
|
291965
|
+
}
|
|
291966
|
+
},
|
|
291967
|
+
"required": [
|
|
291968
|
+
"tags"
|
|
291969
|
+
],
|
|
291970
|
+
"description": "Conversation object configuration",
|
|
292022
291971
|
"additionalProperties": false
|
|
292023
291972
|
},
|
|
292024
291973
|
"attributes": {
|
|
@@ -292033,36 +291982,39 @@ var state2 = {
|
|
|
292033
291982
|
"type": "string",
|
|
292034
291983
|
"minLength": 1,
|
|
292035
291984
|
"maxLength": 64,
|
|
292036
|
-
"description": "Title of the
|
|
291985
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
292037
291986
|
},
|
|
292038
291987
|
"description": {
|
|
292039
291988
|
"type": "string",
|
|
292040
291989
|
"maxLength": 256,
|
|
292041
|
-
"description": "Description of the
|
|
291990
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
292042
291991
|
},
|
|
292043
291992
|
"iconUrl": {
|
|
292044
291993
|
"type": "string",
|
|
292045
|
-
"description": "URL of the icon of the
|
|
291994
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
292046
291995
|
},
|
|
292047
291996
|
"readmeUrl": {
|
|
292048
291997
|
"type": "string",
|
|
292049
|
-
"description": "URL of the readme of the
|
|
291998
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
292050
291999
|
},
|
|
292051
292000
|
"public": {
|
|
292052
292001
|
"type": "boolean",
|
|
292053
|
-
"description": "Indicates if the
|
|
292002
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
292054
292003
|
}
|
|
292055
292004
|
},
|
|
292056
292005
|
"required": [
|
|
292057
292006
|
"id",
|
|
292058
|
-
"createdAt",
|
|
292059
|
-
"updatedAt",
|
|
292060
292007
|
"name",
|
|
292061
292008
|
"version",
|
|
292062
|
-
"
|
|
292009
|
+
"createdAt",
|
|
292010
|
+
"updatedAt",
|
|
292011
|
+
"configuration",
|
|
292012
|
+
"states",
|
|
292063
292013
|
"events",
|
|
292064
292014
|
"actions",
|
|
292065
|
-
"
|
|
292015
|
+
"dependencies",
|
|
292016
|
+
"user",
|
|
292017
|
+
"conversation",
|
|
292066
292018
|
"title",
|
|
292067
292019
|
"description",
|
|
292068
292020
|
"iconUrl",
|
|
@@ -292073,31 +292025,188 @@ var state2 = {
|
|
|
292073
292025
|
}
|
|
292074
292026
|
},
|
|
292075
292027
|
"required": [
|
|
292076
|
-
"
|
|
292028
|
+
"plugin"
|
|
292077
292029
|
],
|
|
292078
|
-
"title": "
|
|
292030
|
+
"title": "getPublicPluginResponse",
|
|
292079
292031
|
"additionalProperties": false
|
|
292080
292032
|
}
|
|
292081
292033
|
}
|
|
292082
292034
|
},
|
|
292083
|
-
"
|
|
292084
|
-
"name": "
|
|
292085
|
-
"description": "Get public
|
|
292035
|
+
"getPublicPluginCode": {
|
|
292036
|
+
"name": "getPublicPluginCode",
|
|
292037
|
+
"description": "Get public plugin code",
|
|
292086
292038
|
"method": "get",
|
|
292039
|
+
"path": "/v1/admin/hub/plugins/{id}/code/{platform}",
|
|
292040
|
+
"disableDefaultParameters": {
|
|
292041
|
+
"x-workspace-id": true
|
|
292042
|
+
},
|
|
292087
292043
|
"section": "hub",
|
|
292088
|
-
"
|
|
292044
|
+
"parameters": {
|
|
292045
|
+
"id": {
|
|
292046
|
+
"in": "path",
|
|
292047
|
+
"type": "string",
|
|
292048
|
+
"description": "Plugin id"
|
|
292049
|
+
},
|
|
292050
|
+
"platform": {
|
|
292051
|
+
"in": "path",
|
|
292052
|
+
"type": "string",
|
|
292053
|
+
"enum": [
|
|
292054
|
+
"node",
|
|
292055
|
+
"browser"
|
|
292056
|
+
],
|
|
292057
|
+
"description": "Platform"
|
|
292058
|
+
}
|
|
292059
|
+
},
|
|
292060
|
+
"response": {
|
|
292061
|
+
"description": "Plugin code",
|
|
292062
|
+
"schema": {
|
|
292063
|
+
"type": "object",
|
|
292064
|
+
"properties": {
|
|
292065
|
+
"code": {
|
|
292066
|
+
"type": "string"
|
|
292067
|
+
}
|
|
292068
|
+
},
|
|
292069
|
+
"required": [
|
|
292070
|
+
"code"
|
|
292071
|
+
],
|
|
292072
|
+
"title": "getPublicPluginCodeResponse",
|
|
292073
|
+
"additionalProperties": false
|
|
292074
|
+
}
|
|
292075
|
+
}
|
|
292076
|
+
},
|
|
292077
|
+
"listPublicInterfaces": {
|
|
292078
|
+
"name": "listPublicInterfaces",
|
|
292079
|
+
"description": "List public interfaces",
|
|
292080
|
+
"method": "get",
|
|
292081
|
+
"section": "hub",
|
|
292082
|
+
"path": "/v1/admin/hub/interfaces",
|
|
292089
292083
|
"disableDefaultParameters": {
|
|
292090
292084
|
"x-workspace-id": true
|
|
292091
292085
|
},
|
|
292092
292086
|
"parameters": {
|
|
292087
|
+
"nextToken": {
|
|
292088
|
+
"in": "query",
|
|
292089
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
292090
|
+
"type": "string"
|
|
292091
|
+
},
|
|
292093
292092
|
"name": {
|
|
292093
|
+
"in": "query",
|
|
292094
292094
|
"type": "string",
|
|
292095
|
-
"description": "
|
|
292096
|
-
"in": "path"
|
|
292095
|
+
"description": "Filter all versions of an interface by name"
|
|
292097
292096
|
},
|
|
292098
292097
|
"version": {
|
|
292098
|
+
"in": "query",
|
|
292099
292099
|
"type": "string",
|
|
292100
|
-
"description": "
|
|
292100
|
+
"description": "Filter an interface by name and version"
|
|
292101
|
+
}
|
|
292102
|
+
},
|
|
292103
|
+
"response": {
|
|
292104
|
+
"description": "Success",
|
|
292105
|
+
"schema": {
|
|
292106
|
+
"type": "object",
|
|
292107
|
+
"properties": {
|
|
292108
|
+
"interfaces": {
|
|
292109
|
+
"type": "array",
|
|
292110
|
+
"items": {
|
|
292111
|
+
"type": "object",
|
|
292112
|
+
"properties": {
|
|
292113
|
+
"id": {
|
|
292114
|
+
"type": "string",
|
|
292115
|
+
"minLength": 28,
|
|
292116
|
+
"maxLength": 36,
|
|
292117
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
292118
|
+
},
|
|
292119
|
+
"createdAt": {
|
|
292120
|
+
"type": "string",
|
|
292121
|
+
"format": "date-time",
|
|
292122
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
292123
|
+
},
|
|
292124
|
+
"updatedAt": {
|
|
292125
|
+
"type": "string",
|
|
292126
|
+
"format": "date-time",
|
|
292127
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
292128
|
+
},
|
|
292129
|
+
"name": {
|
|
292130
|
+
"type": "string",
|
|
292131
|
+
"maxLength": 200,
|
|
292132
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
292133
|
+
},
|
|
292134
|
+
"version": {
|
|
292135
|
+
"type": "string",
|
|
292136
|
+
"maxLength": 200,
|
|
292137
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
292138
|
+
},
|
|
292139
|
+
"title": {
|
|
292140
|
+
"type": "string",
|
|
292141
|
+
"minLength": 1,
|
|
292142
|
+
"maxLength": 64,
|
|
292143
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
292144
|
+
},
|
|
292145
|
+
"description": {
|
|
292146
|
+
"type": "string",
|
|
292147
|
+
"maxLength": 256,
|
|
292148
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
292149
|
+
},
|
|
292150
|
+
"iconUrl": {
|
|
292151
|
+
"type": "string",
|
|
292152
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
292153
|
+
},
|
|
292154
|
+
"readmeUrl": {
|
|
292155
|
+
"type": "string",
|
|
292156
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
292157
|
+
},
|
|
292158
|
+
"public": {
|
|
292159
|
+
"type": "boolean",
|
|
292160
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
292161
|
+
}
|
|
292162
|
+
},
|
|
292163
|
+
"required": [
|
|
292164
|
+
"id",
|
|
292165
|
+
"createdAt",
|
|
292166
|
+
"updatedAt",
|
|
292167
|
+
"name",
|
|
292168
|
+
"version",
|
|
292169
|
+
"title",
|
|
292170
|
+
"description",
|
|
292171
|
+
"iconUrl",
|
|
292172
|
+
"readmeUrl",
|
|
292173
|
+
"public"
|
|
292174
|
+
]
|
|
292175
|
+
}
|
|
292176
|
+
},
|
|
292177
|
+
"meta": {
|
|
292178
|
+
"type": "object",
|
|
292179
|
+
"properties": {
|
|
292180
|
+
"nextToken": {
|
|
292181
|
+
"type": "string",
|
|
292182
|
+
"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."
|
|
292183
|
+
}
|
|
292184
|
+
},
|
|
292185
|
+
"additionalProperties": false
|
|
292186
|
+
}
|
|
292187
|
+
},
|
|
292188
|
+
"required": [
|
|
292189
|
+
"interfaces",
|
|
292190
|
+
"meta"
|
|
292191
|
+
],
|
|
292192
|
+
"title": "listPublicInterfacesResponse",
|
|
292193
|
+
"additionalProperties": false
|
|
292194
|
+
}
|
|
292195
|
+
}
|
|
292196
|
+
},
|
|
292197
|
+
"getPublicInterfaceById": {
|
|
292198
|
+
"name": "getPublicInterfaceById",
|
|
292199
|
+
"description": "Get public interface by Id",
|
|
292200
|
+
"method": "get",
|
|
292201
|
+
"section": "hub",
|
|
292202
|
+
"path": "/v1/admin/hub/interfaces/{id}",
|
|
292203
|
+
"disableDefaultParameters": {
|
|
292204
|
+
"x-workspace-id": true
|
|
292205
|
+
},
|
|
292206
|
+
"parameters": {
|
|
292207
|
+
"id": {
|
|
292208
|
+
"type": "string",
|
|
292209
|
+
"description": "Interface ID",
|
|
292101
292210
|
"in": "path"
|
|
292102
292211
|
}
|
|
292103
292212
|
},
|
|
@@ -292373,121 +292482,419 @@ var state2 = {
|
|
|
292373
292482
|
"required": [
|
|
292374
292483
|
"interface"
|
|
292375
292484
|
],
|
|
292376
|
-
"title": "
|
|
292485
|
+
"title": "getPublicInterfaceByIdResponse",
|
|
292377
292486
|
"additionalProperties": false
|
|
292378
292487
|
}
|
|
292379
292488
|
}
|
|
292380
292489
|
},
|
|
292381
|
-
"
|
|
292382
|
-
"name": "
|
|
292383
|
-
"description": "
|
|
292384
|
-
"method": "
|
|
292385
|
-
"section": "
|
|
292386
|
-
"path": "/v1/admin/
|
|
292387
|
-
"
|
|
292388
|
-
"
|
|
292490
|
+
"getPublicInterface": {
|
|
292491
|
+
"name": "getPublicInterface",
|
|
292492
|
+
"description": "Get public interface by name and version",
|
|
292493
|
+
"method": "get",
|
|
292494
|
+
"section": "hub",
|
|
292495
|
+
"path": "/v1/admin/hub/interfaces/{name}/{version}",
|
|
292496
|
+
"disableDefaultParameters": {
|
|
292497
|
+
"x-workspace-id": true
|
|
292498
|
+
},
|
|
292499
|
+
"parameters": {
|
|
292500
|
+
"name": {
|
|
292501
|
+
"type": "string",
|
|
292502
|
+
"description": "Interface Name",
|
|
292503
|
+
"in": "path"
|
|
292504
|
+
},
|
|
292505
|
+
"version": {
|
|
292506
|
+
"type": "string",
|
|
292507
|
+
"description": "Interface version.",
|
|
292508
|
+
"in": "path"
|
|
292509
|
+
}
|
|
292510
|
+
},
|
|
292511
|
+
"response": {
|
|
292512
|
+
"description": "Success",
|
|
292389
292513
|
"schema": {
|
|
292390
292514
|
"type": "object",
|
|
292391
292515
|
"properties": {
|
|
292392
|
-
"
|
|
292516
|
+
"interface": {
|
|
292393
292517
|
"type": "object",
|
|
292394
|
-
"
|
|
292395
|
-
"
|
|
292396
|
-
|
|
292397
|
-
"
|
|
292398
|
-
|
|
292399
|
-
|
|
292400
|
-
"conversation",
|
|
292401
|
-
"user",
|
|
292402
|
-
"bot",
|
|
292403
|
-
"task"
|
|
292404
|
-
],
|
|
292405
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
292406
|
-
},
|
|
292407
|
-
"schema": {
|
|
292408
|
-
"type": "object",
|
|
292409
|
-
"additionalProperties": true,
|
|
292410
|
-
"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."
|
|
292411
|
-
},
|
|
292412
|
-
"expiry": {
|
|
292413
|
-
"type": "number",
|
|
292414
|
-
"minimum": 1,
|
|
292415
|
-
"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."
|
|
292416
|
-
}
|
|
292518
|
+
"properties": {
|
|
292519
|
+
"id": {
|
|
292520
|
+
"type": "string",
|
|
292521
|
+
"minLength": 28,
|
|
292522
|
+
"maxLength": 36,
|
|
292523
|
+
"description": "ID of the [Interface](#schema_interface)"
|
|
292417
292524
|
},
|
|
292418
|
-
"
|
|
292419
|
-
"type",
|
|
292420
|
-
"
|
|
292421
|
-
|
|
292422
|
-
"additionalProperties": false
|
|
292423
|
-
},
|
|
292424
|
-
"description": "A mapping of states to their definition"
|
|
292425
|
-
},
|
|
292426
|
-
"events": {
|
|
292427
|
-
"type": "object",
|
|
292428
|
-
"additionalProperties": {
|
|
292429
|
-
"type": "object",
|
|
292430
|
-
"properties": {
|
|
292431
|
-
"title": {
|
|
292432
|
-
"type": "string",
|
|
292433
|
-
"maxLength": 64,
|
|
292434
|
-
"description": "Title of the event"
|
|
292435
|
-
},
|
|
292436
|
-
"description": {
|
|
292437
|
-
"type": "string",
|
|
292438
|
-
"maxLength": 256,
|
|
292439
|
-
"description": "Description of the event"
|
|
292440
|
-
},
|
|
292441
|
-
"schema": {
|
|
292442
|
-
"type": "object",
|
|
292443
|
-
"additionalProperties": true
|
|
292444
|
-
},
|
|
292445
|
-
"attributes": {
|
|
292446
|
-
"type": "object",
|
|
292447
|
-
"additionalProperties": {
|
|
292448
|
-
"type": "string",
|
|
292449
|
-
"maxLength": 200
|
|
292450
|
-
},
|
|
292451
|
-
"description": "Optional attributes"
|
|
292452
|
-
}
|
|
292525
|
+
"createdAt": {
|
|
292526
|
+
"type": "string",
|
|
292527
|
+
"format": "date-time",
|
|
292528
|
+
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
292453
292529
|
},
|
|
292454
|
-
"
|
|
292455
|
-
"
|
|
292456
|
-
|
|
292457
|
-
|
|
292458
|
-
|
|
292459
|
-
|
|
292460
|
-
|
|
292461
|
-
|
|
292462
|
-
|
|
292463
|
-
|
|
292464
|
-
|
|
292465
|
-
|
|
292466
|
-
|
|
292467
|
-
"
|
|
292530
|
+
"updatedAt": {
|
|
292531
|
+
"type": "string",
|
|
292532
|
+
"format": "date-time",
|
|
292533
|
+
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
292534
|
+
},
|
|
292535
|
+
"name": {
|
|
292536
|
+
"type": "string",
|
|
292537
|
+
"maxLength": 200,
|
|
292538
|
+
"description": "Name of the [Interface](#schema_interface)"
|
|
292539
|
+
},
|
|
292540
|
+
"version": {
|
|
292541
|
+
"type": "string",
|
|
292542
|
+
"maxLength": 200,
|
|
292543
|
+
"description": "Version of the [Interface](#schema_interface)"
|
|
292544
|
+
},
|
|
292545
|
+
"entities": {
|
|
292546
|
+
"type": "object",
|
|
292547
|
+
"additionalProperties": {
|
|
292468
292548
|
"type": "object",
|
|
292469
292549
|
"properties": {
|
|
292470
|
-
"
|
|
292550
|
+
"title": {
|
|
292471
292551
|
"type": "string",
|
|
292472
|
-
"maxLength":
|
|
292552
|
+
"maxLength": 64,
|
|
292553
|
+
"description": "Title of the entity"
|
|
292554
|
+
},
|
|
292555
|
+
"description": {
|
|
292556
|
+
"type": "string",
|
|
292557
|
+
"maxLength": 256,
|
|
292558
|
+
"description": "Description of the entity"
|
|
292559
|
+
},
|
|
292560
|
+
"schema": {
|
|
292561
|
+
"type": "object",
|
|
292562
|
+
"additionalProperties": true
|
|
292473
292563
|
}
|
|
292474
292564
|
},
|
|
292475
292565
|
"required": [
|
|
292476
|
-
"
|
|
292566
|
+
"schema"
|
|
292477
292567
|
],
|
|
292568
|
+
"description": "Entity definition",
|
|
292478
292569
|
"additionalProperties": false
|
|
292479
|
-
},
|
|
292480
|
-
"type": {
|
|
292481
|
-
"type": "string",
|
|
292482
|
-
"maxLength": 200
|
|
292483
|
-
},
|
|
292484
|
-
"payload": {
|
|
292485
|
-
"type": "object",
|
|
292486
|
-
"additionalProperties": true
|
|
292487
292570
|
}
|
|
292488
292571
|
},
|
|
292489
|
-
"
|
|
292490
|
-
"
|
|
292572
|
+
"events": {
|
|
292573
|
+
"type": "object",
|
|
292574
|
+
"additionalProperties": {
|
|
292575
|
+
"type": "object",
|
|
292576
|
+
"properties": {
|
|
292577
|
+
"title": {
|
|
292578
|
+
"type": "string",
|
|
292579
|
+
"maxLength": 64,
|
|
292580
|
+
"description": "Title of the event"
|
|
292581
|
+
},
|
|
292582
|
+
"description": {
|
|
292583
|
+
"type": "string",
|
|
292584
|
+
"maxLength": 256,
|
|
292585
|
+
"description": "Description of the event"
|
|
292586
|
+
},
|
|
292587
|
+
"schema": {
|
|
292588
|
+
"type": "object",
|
|
292589
|
+
"additionalProperties": true
|
|
292590
|
+
},
|
|
292591
|
+
"attributes": {
|
|
292592
|
+
"type": "object",
|
|
292593
|
+
"additionalProperties": {
|
|
292594
|
+
"type": "string",
|
|
292595
|
+
"maxLength": 200
|
|
292596
|
+
},
|
|
292597
|
+
"description": "Optional attributes"
|
|
292598
|
+
}
|
|
292599
|
+
},
|
|
292600
|
+
"required": [
|
|
292601
|
+
"schema"
|
|
292602
|
+
],
|
|
292603
|
+
"description": "Event Definition",
|
|
292604
|
+
"additionalProperties": false
|
|
292605
|
+
}
|
|
292606
|
+
},
|
|
292607
|
+
"actions": {
|
|
292608
|
+
"type": "object",
|
|
292609
|
+
"additionalProperties": {
|
|
292610
|
+
"type": "object",
|
|
292611
|
+
"properties": {
|
|
292612
|
+
"title": {
|
|
292613
|
+
"type": "string",
|
|
292614
|
+
"maxLength": 64,
|
|
292615
|
+
"description": "Title of the action"
|
|
292616
|
+
},
|
|
292617
|
+
"description": {
|
|
292618
|
+
"type": "string",
|
|
292619
|
+
"maxLength": 256,
|
|
292620
|
+
"description": "Description of the action"
|
|
292621
|
+
},
|
|
292622
|
+
"billable": {
|
|
292623
|
+
"type": "boolean"
|
|
292624
|
+
},
|
|
292625
|
+
"cacheable": {
|
|
292626
|
+
"type": "boolean"
|
|
292627
|
+
},
|
|
292628
|
+
"input": {
|
|
292629
|
+
"type": "object",
|
|
292630
|
+
"properties": {
|
|
292631
|
+
"schema": {
|
|
292632
|
+
"type": "object",
|
|
292633
|
+
"additionalProperties": true
|
|
292634
|
+
}
|
|
292635
|
+
},
|
|
292636
|
+
"required": [
|
|
292637
|
+
"schema"
|
|
292638
|
+
],
|
|
292639
|
+
"additionalProperties": false
|
|
292640
|
+
},
|
|
292641
|
+
"output": {
|
|
292642
|
+
"type": "object",
|
|
292643
|
+
"properties": {
|
|
292644
|
+
"schema": {
|
|
292645
|
+
"type": "object",
|
|
292646
|
+
"additionalProperties": true
|
|
292647
|
+
}
|
|
292648
|
+
},
|
|
292649
|
+
"required": [
|
|
292650
|
+
"schema"
|
|
292651
|
+
],
|
|
292652
|
+
"additionalProperties": false
|
|
292653
|
+
},
|
|
292654
|
+
"attributes": {
|
|
292655
|
+
"type": "object",
|
|
292656
|
+
"additionalProperties": {
|
|
292657
|
+
"type": "string",
|
|
292658
|
+
"maxLength": 200
|
|
292659
|
+
},
|
|
292660
|
+
"description": "Optional attributes"
|
|
292661
|
+
}
|
|
292662
|
+
},
|
|
292663
|
+
"required": [
|
|
292664
|
+
"input",
|
|
292665
|
+
"output"
|
|
292666
|
+
],
|
|
292667
|
+
"description": "Action definition",
|
|
292668
|
+
"additionalProperties": false
|
|
292669
|
+
}
|
|
292670
|
+
},
|
|
292671
|
+
"channels": {
|
|
292672
|
+
"type": "object",
|
|
292673
|
+
"additionalProperties": {
|
|
292674
|
+
"type": "object",
|
|
292675
|
+
"properties": {
|
|
292676
|
+
"title": {
|
|
292677
|
+
"type": "string",
|
|
292678
|
+
"maxLength": 64,
|
|
292679
|
+
"description": "Title of the channel"
|
|
292680
|
+
},
|
|
292681
|
+
"description": {
|
|
292682
|
+
"type": "string",
|
|
292683
|
+
"maxLength": 256,
|
|
292684
|
+
"description": "Description of the channel"
|
|
292685
|
+
},
|
|
292686
|
+
"messages": {
|
|
292687
|
+
"type": "object",
|
|
292688
|
+
"additionalProperties": {
|
|
292689
|
+
"type": "object",
|
|
292690
|
+
"properties": {
|
|
292691
|
+
"schema": {
|
|
292692
|
+
"type": "object",
|
|
292693
|
+
"additionalProperties": true
|
|
292694
|
+
}
|
|
292695
|
+
},
|
|
292696
|
+
"required": [
|
|
292697
|
+
"schema"
|
|
292698
|
+
],
|
|
292699
|
+
"description": "Message definition",
|
|
292700
|
+
"additionalProperties": false
|
|
292701
|
+
}
|
|
292702
|
+
}
|
|
292703
|
+
},
|
|
292704
|
+
"required": [
|
|
292705
|
+
"messages"
|
|
292706
|
+
],
|
|
292707
|
+
"additionalProperties": false
|
|
292708
|
+
}
|
|
292709
|
+
},
|
|
292710
|
+
"nameTemplate": {
|
|
292711
|
+
"type": "object",
|
|
292712
|
+
"properties": {
|
|
292713
|
+
"script": {
|
|
292714
|
+
"type": "string",
|
|
292715
|
+
"maxLength": 2e3
|
|
292716
|
+
},
|
|
292717
|
+
"language": {
|
|
292718
|
+
"type": "string",
|
|
292719
|
+
"maxLength": 200
|
|
292720
|
+
}
|
|
292721
|
+
},
|
|
292722
|
+
"required": [
|
|
292723
|
+
"script",
|
|
292724
|
+
"language"
|
|
292725
|
+
],
|
|
292726
|
+
"description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
|
|
292727
|
+
"additionalProperties": false
|
|
292728
|
+
},
|
|
292729
|
+
"attributes": {
|
|
292730
|
+
"type": "object",
|
|
292731
|
+
"additionalProperties": {
|
|
292732
|
+
"type": "string",
|
|
292733
|
+
"maxLength": 200
|
|
292734
|
+
},
|
|
292735
|
+
"description": "Optional attributes"
|
|
292736
|
+
},
|
|
292737
|
+
"title": {
|
|
292738
|
+
"type": "string",
|
|
292739
|
+
"minLength": 1,
|
|
292740
|
+
"maxLength": 64,
|
|
292741
|
+
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
292742
|
+
},
|
|
292743
|
+
"description": {
|
|
292744
|
+
"type": "string",
|
|
292745
|
+
"maxLength": 256,
|
|
292746
|
+
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
292747
|
+
},
|
|
292748
|
+
"iconUrl": {
|
|
292749
|
+
"type": "string",
|
|
292750
|
+
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
292751
|
+
},
|
|
292752
|
+
"readmeUrl": {
|
|
292753
|
+
"type": "string",
|
|
292754
|
+
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
292755
|
+
},
|
|
292756
|
+
"public": {
|
|
292757
|
+
"type": "boolean",
|
|
292758
|
+
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
292759
|
+
}
|
|
292760
|
+
},
|
|
292761
|
+
"required": [
|
|
292762
|
+
"id",
|
|
292763
|
+
"createdAt",
|
|
292764
|
+
"updatedAt",
|
|
292765
|
+
"name",
|
|
292766
|
+
"version",
|
|
292767
|
+
"entities",
|
|
292768
|
+
"events",
|
|
292769
|
+
"actions",
|
|
292770
|
+
"channels",
|
|
292771
|
+
"title",
|
|
292772
|
+
"description",
|
|
292773
|
+
"iconUrl",
|
|
292774
|
+
"readmeUrl",
|
|
292775
|
+
"public"
|
|
292776
|
+
],
|
|
292777
|
+
"additionalProperties": false
|
|
292778
|
+
}
|
|
292779
|
+
},
|
|
292780
|
+
"required": [
|
|
292781
|
+
"interface"
|
|
292782
|
+
],
|
|
292783
|
+
"title": "getPublicInterfaceResponse",
|
|
292784
|
+
"additionalProperties": false
|
|
292785
|
+
}
|
|
292786
|
+
}
|
|
292787
|
+
},
|
|
292788
|
+
"createBot": {
|
|
292789
|
+
"name": "createBot",
|
|
292790
|
+
"description": "Create bot",
|
|
292791
|
+
"method": "post",
|
|
292792
|
+
"section": "bot",
|
|
292793
|
+
"path": "/v1/admin/bots",
|
|
292794
|
+
"requestBody": {
|
|
292795
|
+
"description": "Bot metadata",
|
|
292796
|
+
"schema": {
|
|
292797
|
+
"type": "object",
|
|
292798
|
+
"properties": {
|
|
292799
|
+
"states": {
|
|
292800
|
+
"type": "object",
|
|
292801
|
+
"additionalProperties": {
|
|
292802
|
+
"type": "object",
|
|
292803
|
+
"properties": {
|
|
292804
|
+
"type": {
|
|
292805
|
+
"type": "string",
|
|
292806
|
+
"enum": [
|
|
292807
|
+
"conversation",
|
|
292808
|
+
"user",
|
|
292809
|
+
"bot",
|
|
292810
|
+
"task"
|
|
292811
|
+
],
|
|
292812
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
292813
|
+
},
|
|
292814
|
+
"schema": {
|
|
292815
|
+
"type": "object",
|
|
292816
|
+
"additionalProperties": true,
|
|
292817
|
+
"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."
|
|
292818
|
+
},
|
|
292819
|
+
"expiry": {
|
|
292820
|
+
"type": "number",
|
|
292821
|
+
"minimum": 1,
|
|
292822
|
+
"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."
|
|
292823
|
+
}
|
|
292824
|
+
},
|
|
292825
|
+
"required": [
|
|
292826
|
+
"type",
|
|
292827
|
+
"schema"
|
|
292828
|
+
],
|
|
292829
|
+
"additionalProperties": false
|
|
292830
|
+
},
|
|
292831
|
+
"description": "A mapping of states to their definition"
|
|
292832
|
+
},
|
|
292833
|
+
"events": {
|
|
292834
|
+
"type": "object",
|
|
292835
|
+
"additionalProperties": {
|
|
292836
|
+
"type": "object",
|
|
292837
|
+
"properties": {
|
|
292838
|
+
"title": {
|
|
292839
|
+
"type": "string",
|
|
292840
|
+
"maxLength": 64,
|
|
292841
|
+
"description": "Title of the event"
|
|
292842
|
+
},
|
|
292843
|
+
"description": {
|
|
292844
|
+
"type": "string",
|
|
292845
|
+
"maxLength": 256,
|
|
292846
|
+
"description": "Description of the event"
|
|
292847
|
+
},
|
|
292848
|
+
"schema": {
|
|
292849
|
+
"type": "object",
|
|
292850
|
+
"additionalProperties": true
|
|
292851
|
+
},
|
|
292852
|
+
"attributes": {
|
|
292853
|
+
"type": "object",
|
|
292854
|
+
"additionalProperties": {
|
|
292855
|
+
"type": "string",
|
|
292856
|
+
"maxLength": 200
|
|
292857
|
+
},
|
|
292858
|
+
"description": "Optional attributes"
|
|
292859
|
+
}
|
|
292860
|
+
},
|
|
292861
|
+
"required": [
|
|
292862
|
+
"schema"
|
|
292863
|
+
],
|
|
292864
|
+
"description": "Event Definition",
|
|
292865
|
+
"additionalProperties": false
|
|
292866
|
+
},
|
|
292867
|
+
"description": "Events definition"
|
|
292868
|
+
},
|
|
292869
|
+
"recurringEvents": {
|
|
292870
|
+
"type": "object",
|
|
292871
|
+
"additionalProperties": {
|
|
292872
|
+
"type": "object",
|
|
292873
|
+
"properties": {
|
|
292874
|
+
"schedule": {
|
|
292875
|
+
"type": "object",
|
|
292876
|
+
"properties": {
|
|
292877
|
+
"cron": {
|
|
292878
|
+
"type": "string",
|
|
292879
|
+
"maxLength": 200
|
|
292880
|
+
}
|
|
292881
|
+
},
|
|
292882
|
+
"required": [
|
|
292883
|
+
"cron"
|
|
292884
|
+
],
|
|
292885
|
+
"additionalProperties": false
|
|
292886
|
+
},
|
|
292887
|
+
"type": {
|
|
292888
|
+
"type": "string",
|
|
292889
|
+
"maxLength": 200
|
|
292890
|
+
},
|
|
292891
|
+
"payload": {
|
|
292892
|
+
"type": "object",
|
|
292893
|
+
"additionalProperties": true
|
|
292894
|
+
}
|
|
292895
|
+
},
|
|
292896
|
+
"required": [
|
|
292897
|
+
"schedule",
|
|
292491
292898
|
"type",
|
|
292492
292899
|
"payload"
|
|
292493
292900
|
],
|
|
@@ -293059,6 +293466,10 @@ var state2 = {
|
|
|
293059
293466
|
"enabled": {
|
|
293060
293467
|
"type": "boolean"
|
|
293061
293468
|
},
|
|
293469
|
+
"integrationId": {
|
|
293470
|
+
"type": "string",
|
|
293471
|
+
"description": "Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance."
|
|
293472
|
+
},
|
|
293062
293473
|
"configurationType": {
|
|
293063
293474
|
"type": "string",
|
|
293064
293475
|
"nullable": true,
|
|
@@ -300666,6 +301077,50 @@ var state2 = {
|
|
|
300666
301077
|
}
|
|
300667
301078
|
}
|
|
300668
301079
|
},
|
|
301080
|
+
"getDereferencedPlugin": {
|
|
301081
|
+
"name": "getDereferencedPlugin",
|
|
301082
|
+
"description": "Get plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
301083
|
+
"method": "get",
|
|
301084
|
+
"section": "plugin",
|
|
301085
|
+
"path": "/v1/admin/plugins/{id}/dereferenced",
|
|
301086
|
+
"parameters": {
|
|
301087
|
+
"id": {
|
|
301088
|
+
"type": "string",
|
|
301089
|
+
"description": "Plugin ID",
|
|
301090
|
+
"in": "path"
|
|
301091
|
+
},
|
|
301092
|
+
"interfaces": {
|
|
301093
|
+
"in": "query",
|
|
301094
|
+
"type": "object",
|
|
301095
|
+
"schema": {
|
|
301096
|
+
"type": "object",
|
|
301097
|
+
"additionalProperties": {
|
|
301098
|
+
"type": "string",
|
|
301099
|
+
"description": "integration id"
|
|
301100
|
+
},
|
|
301101
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
301102
|
+
},
|
|
301103
|
+
"description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
|
|
301104
|
+
"required": true
|
|
301105
|
+
}
|
|
301106
|
+
},
|
|
301107
|
+
"response": {
|
|
301108
|
+
"description": "Get a dereferenced plugin",
|
|
301109
|
+
"schema": {
|
|
301110
|
+
"type": "object",
|
|
301111
|
+
"properties": {
|
|
301112
|
+
"plugin": {
|
|
301113
|
+
"$ref": "#/components/schemas/Plugin"
|
|
301114
|
+
}
|
|
301115
|
+
},
|
|
301116
|
+
"required": [
|
|
301117
|
+
"plugin"
|
|
301118
|
+
],
|
|
301119
|
+
"title": "getDereferencedPluginResponse",
|
|
301120
|
+
"additionalProperties": false
|
|
301121
|
+
}
|
|
301122
|
+
}
|
|
301123
|
+
},
|
|
300669
301124
|
"getPluginByName": {
|
|
300670
301125
|
"name": "getPluginByName",
|
|
300671
301126
|
"description": "Get Plugin by name and version",
|
|
@@ -301752,7 +302207,7 @@ var state2 = {
|
|
|
301752
302207
|
"title": "Botpress API",
|
|
301753
302208
|
"description": "API for Botpress Cloud",
|
|
301754
302209
|
"server": "https://api.botpress.cloud",
|
|
301755
|
-
"version": "1.
|
|
302210
|
+
"version": "1.27.0",
|
|
301756
302211
|
"prefix": "v1"
|
|
301757
302212
|
},
|
|
301758
302213
|
"errors": [
|
|
@@ -301927,6 +302382,7 @@ var state2 = {
|
|
|
301927
302382
|
"getPublicIntegrationResponse": true,
|
|
301928
302383
|
"listPublicPluginsResponse": true,
|
|
301929
302384
|
"getPublicPluginByIdResponse": true,
|
|
302385
|
+
"getDereferencedPublicPluginByIdResponse": true,
|
|
301930
302386
|
"getPublicPluginResponse": true,
|
|
301931
302387
|
"getPublicPluginCodeResponse": true,
|
|
301932
302388
|
"listPublicInterfacesResponse": true,
|
|
@@ -302002,6 +302458,7 @@ var state2 = {
|
|
|
302002
302458
|
"listInterfacesResponse": true,
|
|
302003
302459
|
"createPluginResponse": true,
|
|
302004
302460
|
"getPluginResponse": true,
|
|
302461
|
+
"getDereferencedPluginResponse": true,
|
|
302005
302462
|
"getPluginByNameResponse": true,
|
|
302006
302463
|
"updatePluginResponse": true,
|
|
302007
302464
|
"deletePluginResponse": true,
|
|
@@ -305557,6 +306014,7 @@ var state2 = {
|
|
|
305557
306014
|
"getPublicIntegration",
|
|
305558
306015
|
"listPublicPlugins",
|
|
305559
306016
|
"getPublicPluginById",
|
|
306017
|
+
"getDereferencedPublicPluginById",
|
|
305560
306018
|
"getPublicPlugin",
|
|
305561
306019
|
"getPublicPluginCode",
|
|
305562
306020
|
"listPublicInterfaces",
|
|
@@ -305667,6 +306125,7 @@ var state2 = {
|
|
|
305667
306125
|
"operations": [
|
|
305668
306126
|
"createPlugin",
|
|
305669
306127
|
"getPlugin",
|
|
306128
|
+
"getDereferencedPlugin",
|
|
305670
306129
|
"getPluginByName",
|
|
305671
306130
|
"updatePlugin",
|
|
305672
306131
|
"deletePlugin",
|
|
@@ -307565,7 +308024,7 @@ var state3 = {
|
|
|
307565
308024
|
"title": "Botpress API",
|
|
307566
308025
|
"description": "API for Botpress Cloud",
|
|
307567
308026
|
"server": "https://api.botpress.cloud",
|
|
307568
|
-
"version": "1.
|
|
308027
|
+
"version": "1.27.0",
|
|
307569
308028
|
"prefix": "v1"
|
|
307570
308029
|
},
|
|
307571
308030
|
"errors": [
|
|
@@ -312611,7 +313070,7 @@ var state4 = {
|
|
|
312611
313070
|
"title": "Botpress API",
|
|
312612
313071
|
"description": "API for Botpress Cloud",
|
|
312613
313072
|
"server": "https://api.botpress.cloud",
|
|
312614
|
-
"version": "1.
|
|
313073
|
+
"version": "1.27.0",
|
|
312615
313074
|
"prefix": "v1"
|
|
312616
313075
|
},
|
|
312617
313076
|
"errors": [
|
|
@@ -321002,64 +321461,644 @@ var state5 = {
|
|
|
321002
321461
|
"description": "Definition of a tag that can be provided on the object",
|
|
321003
321462
|
"additionalProperties": false
|
|
321004
321463
|
}
|
|
321005
|
-
},
|
|
321006
|
-
"creation": {
|
|
321007
|
-
"type": "object",
|
|
321008
|
-
"properties": {
|
|
321009
|
-
"enabled": {
|
|
321010
|
-
"type": "boolean",
|
|
321011
|
-
"description": "Enable user creation"
|
|
321012
|
-
},
|
|
321013
|
-
"requiredTags": {
|
|
321014
|
-
"type": "array",
|
|
321015
|
-
"items": {
|
|
321016
|
-
"type": "string"
|
|
321017
|
-
},
|
|
321018
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
321019
|
-
}
|
|
321020
|
-
},
|
|
321021
|
-
"required": [
|
|
321022
|
-
"enabled",
|
|
321023
|
-
"requiredTags"
|
|
321024
|
-
],
|
|
321025
|
-
"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.",
|
|
321026
|
-
"additionalProperties": false
|
|
321464
|
+
},
|
|
321465
|
+
"creation": {
|
|
321466
|
+
"type": "object",
|
|
321467
|
+
"properties": {
|
|
321468
|
+
"enabled": {
|
|
321469
|
+
"type": "boolean",
|
|
321470
|
+
"description": "Enable user creation"
|
|
321471
|
+
},
|
|
321472
|
+
"requiredTags": {
|
|
321473
|
+
"type": "array",
|
|
321474
|
+
"items": {
|
|
321475
|
+
"type": "string"
|
|
321476
|
+
},
|
|
321477
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
321478
|
+
}
|
|
321479
|
+
},
|
|
321480
|
+
"required": [
|
|
321481
|
+
"enabled",
|
|
321482
|
+
"requiredTags"
|
|
321483
|
+
],
|
|
321484
|
+
"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.",
|
|
321485
|
+
"additionalProperties": false
|
|
321486
|
+
}
|
|
321487
|
+
},
|
|
321488
|
+
"required": [
|
|
321489
|
+
"tags",
|
|
321490
|
+
"creation"
|
|
321491
|
+
],
|
|
321492
|
+
"description": "User object configuration",
|
|
321493
|
+
"additionalProperties": false
|
|
321494
|
+
},
|
|
321495
|
+
"entities": {
|
|
321496
|
+
"type": "object",
|
|
321497
|
+
"additionalProperties": {
|
|
321498
|
+
"type": "object",
|
|
321499
|
+
"properties": {
|
|
321500
|
+
"title": {
|
|
321501
|
+
"type": "string",
|
|
321502
|
+
"maxLength": 64,
|
|
321503
|
+
"description": "Title of the entity"
|
|
321504
|
+
},
|
|
321505
|
+
"description": {
|
|
321506
|
+
"type": "string",
|
|
321507
|
+
"maxLength": 256,
|
|
321508
|
+
"description": "Description of the entity"
|
|
321509
|
+
},
|
|
321510
|
+
"schema": {
|
|
321511
|
+
"type": "object",
|
|
321512
|
+
"additionalProperties": true
|
|
321513
|
+
}
|
|
321514
|
+
},
|
|
321515
|
+
"required": [
|
|
321516
|
+
"schema"
|
|
321517
|
+
],
|
|
321518
|
+
"description": "Entity definition",
|
|
321519
|
+
"additionalProperties": false
|
|
321520
|
+
}
|
|
321521
|
+
},
|
|
321522
|
+
"attributes": {
|
|
321523
|
+
"type": "object",
|
|
321524
|
+
"additionalProperties": {
|
|
321525
|
+
"type": "string",
|
|
321526
|
+
"maxLength": 200
|
|
321527
|
+
},
|
|
321528
|
+
"description": "Optional attributes"
|
|
321529
|
+
},
|
|
321530
|
+
"dev": {
|
|
321531
|
+
"type": "boolean",
|
|
321532
|
+
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
321533
|
+
},
|
|
321534
|
+
"title": {
|
|
321535
|
+
"type": "string",
|
|
321536
|
+
"minLength": 1,
|
|
321537
|
+
"maxLength": 64,
|
|
321538
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
321539
|
+
},
|
|
321540
|
+
"description": {
|
|
321541
|
+
"type": "string",
|
|
321542
|
+
"maxLength": 256,
|
|
321543
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
321544
|
+
},
|
|
321545
|
+
"iconUrl": {
|
|
321546
|
+
"type": "string",
|
|
321547
|
+
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
321548
|
+
},
|
|
321549
|
+
"readmeUrl": {
|
|
321550
|
+
"type": "string",
|
|
321551
|
+
"description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
|
|
321552
|
+
},
|
|
321553
|
+
"public": {
|
|
321554
|
+
"type": "boolean",
|
|
321555
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
321556
|
+
},
|
|
321557
|
+
"verificationStatus": {
|
|
321558
|
+
"type": "string",
|
|
321559
|
+
"enum": [
|
|
321560
|
+
"unapproved",
|
|
321561
|
+
"pending",
|
|
321562
|
+
"approved",
|
|
321563
|
+
"rejected"
|
|
321564
|
+
],
|
|
321565
|
+
"description": "Status of the integration version verification"
|
|
321566
|
+
},
|
|
321567
|
+
"secrets": {
|
|
321568
|
+
"type": "array",
|
|
321569
|
+
"items": {
|
|
321570
|
+
"type": "string"
|
|
321571
|
+
},
|
|
321572
|
+
"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."
|
|
321573
|
+
},
|
|
321574
|
+
"ownerWorkspace": {
|
|
321575
|
+
"type": "object",
|
|
321576
|
+
"properties": {
|
|
321577
|
+
"id": {
|
|
321578
|
+
"type": "string"
|
|
321579
|
+
},
|
|
321580
|
+
"handle": {
|
|
321581
|
+
"type": "string",
|
|
321582
|
+
"nullable": true
|
|
321583
|
+
},
|
|
321584
|
+
"name": {
|
|
321585
|
+
"type": "string"
|
|
321586
|
+
}
|
|
321587
|
+
},
|
|
321588
|
+
"required": [
|
|
321589
|
+
"id",
|
|
321590
|
+
"handle",
|
|
321591
|
+
"name"
|
|
321592
|
+
],
|
|
321593
|
+
"additionalProperties": false
|
|
321594
|
+
},
|
|
321595
|
+
"meta": {
|
|
321596
|
+
"type": "object",
|
|
321597
|
+
"properties": {
|
|
321598
|
+
"installs": {
|
|
321599
|
+
"type": "number"
|
|
321600
|
+
},
|
|
321601
|
+
"views": {
|
|
321602
|
+
"type": "number"
|
|
321603
|
+
}
|
|
321604
|
+
},
|
|
321605
|
+
"required": [
|
|
321606
|
+
"installs",
|
|
321607
|
+
"views"
|
|
321608
|
+
],
|
|
321609
|
+
"additionalProperties": false
|
|
321610
|
+
}
|
|
321611
|
+
},
|
|
321612
|
+
"required": [
|
|
321613
|
+
"id",
|
|
321614
|
+
"createdAt",
|
|
321615
|
+
"updatedAt",
|
|
321616
|
+
"identifier",
|
|
321617
|
+
"url",
|
|
321618
|
+
"name",
|
|
321619
|
+
"version",
|
|
321620
|
+
"interfaces",
|
|
321621
|
+
"configuration",
|
|
321622
|
+
"configurations",
|
|
321623
|
+
"channels",
|
|
321624
|
+
"states",
|
|
321625
|
+
"events",
|
|
321626
|
+
"actions",
|
|
321627
|
+
"user",
|
|
321628
|
+
"entities",
|
|
321629
|
+
"dev",
|
|
321630
|
+
"title",
|
|
321631
|
+
"description",
|
|
321632
|
+
"iconUrl",
|
|
321633
|
+
"readmeUrl",
|
|
321634
|
+
"public",
|
|
321635
|
+
"verificationStatus",
|
|
321636
|
+
"secrets",
|
|
321637
|
+
"ownerWorkspace",
|
|
321638
|
+
"meta"
|
|
321639
|
+
],
|
|
321640
|
+
"additionalProperties": false
|
|
321641
|
+
}
|
|
321642
|
+
},
|
|
321643
|
+
"required": [
|
|
321644
|
+
"integration"
|
|
321645
|
+
],
|
|
321646
|
+
"title": "getPublicIntegrationResponse",
|
|
321647
|
+
"additionalProperties": false
|
|
321648
|
+
}
|
|
321649
|
+
}
|
|
321650
|
+
},
|
|
321651
|
+
"listPublicPlugins": {
|
|
321652
|
+
"name": "listPublicPlugins",
|
|
321653
|
+
"description": "List public plugin",
|
|
321654
|
+
"method": "get",
|
|
321655
|
+
"section": "hub",
|
|
321656
|
+
"path": "/v1/admin/hub/plugins",
|
|
321657
|
+
"disableDefaultParameters": {
|
|
321658
|
+
"x-workspace-id": true
|
|
321659
|
+
},
|
|
321660
|
+
"parameters": {
|
|
321661
|
+
"nextToken": {
|
|
321662
|
+
"in": "query",
|
|
321663
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
321664
|
+
"type": "string"
|
|
321665
|
+
},
|
|
321666
|
+
"name": {
|
|
321667
|
+
"in": "query",
|
|
321668
|
+
"type": "string",
|
|
321669
|
+
"description": "Filter all versions of a plugin by name"
|
|
321670
|
+
},
|
|
321671
|
+
"version": {
|
|
321672
|
+
"in": "query",
|
|
321673
|
+
"type": "string",
|
|
321674
|
+
"description": "Filter a plugin by name and version"
|
|
321675
|
+
}
|
|
321676
|
+
},
|
|
321677
|
+
"response": {
|
|
321678
|
+
"description": "Success",
|
|
321679
|
+
"schema": {
|
|
321680
|
+
"type": "object",
|
|
321681
|
+
"properties": {
|
|
321682
|
+
"plugins": {
|
|
321683
|
+
"type": "array",
|
|
321684
|
+
"items": {
|
|
321685
|
+
"type": "object",
|
|
321686
|
+
"properties": {
|
|
321687
|
+
"id": {
|
|
321688
|
+
"type": "string",
|
|
321689
|
+
"minLength": 28,
|
|
321690
|
+
"maxLength": 36,
|
|
321691
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
321692
|
+
},
|
|
321693
|
+
"createdAt": {
|
|
321694
|
+
"type": "string",
|
|
321695
|
+
"format": "date-time",
|
|
321696
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321697
|
+
},
|
|
321698
|
+
"updatedAt": {
|
|
321699
|
+
"type": "string",
|
|
321700
|
+
"format": "date-time",
|
|
321701
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321702
|
+
},
|
|
321703
|
+
"name": {
|
|
321704
|
+
"type": "string",
|
|
321705
|
+
"maxLength": 200,
|
|
321706
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
321707
|
+
},
|
|
321708
|
+
"version": {
|
|
321709
|
+
"type": "string",
|
|
321710
|
+
"maxLength": 200,
|
|
321711
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
321712
|
+
},
|
|
321713
|
+
"title": {
|
|
321714
|
+
"type": "string",
|
|
321715
|
+
"minLength": 1,
|
|
321716
|
+
"maxLength": 64,
|
|
321717
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
321718
|
+
},
|
|
321719
|
+
"description": {
|
|
321720
|
+
"type": "string",
|
|
321721
|
+
"maxLength": 256,
|
|
321722
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
321723
|
+
},
|
|
321724
|
+
"iconUrl": {
|
|
321725
|
+
"type": "string",
|
|
321726
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
321727
|
+
},
|
|
321728
|
+
"readmeUrl": {
|
|
321729
|
+
"type": "string",
|
|
321730
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
321731
|
+
},
|
|
321732
|
+
"public": {
|
|
321733
|
+
"type": "boolean",
|
|
321734
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
321735
|
+
}
|
|
321736
|
+
},
|
|
321737
|
+
"required": [
|
|
321738
|
+
"id",
|
|
321739
|
+
"createdAt",
|
|
321740
|
+
"updatedAt",
|
|
321741
|
+
"name",
|
|
321742
|
+
"version",
|
|
321743
|
+
"title",
|
|
321744
|
+
"description",
|
|
321745
|
+
"iconUrl",
|
|
321746
|
+
"readmeUrl",
|
|
321747
|
+
"public"
|
|
321748
|
+
]
|
|
321749
|
+
}
|
|
321750
|
+
},
|
|
321751
|
+
"meta": {
|
|
321752
|
+
"type": "object",
|
|
321753
|
+
"properties": {
|
|
321754
|
+
"nextToken": {
|
|
321755
|
+
"type": "string",
|
|
321756
|
+
"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."
|
|
321757
|
+
}
|
|
321758
|
+
},
|
|
321759
|
+
"additionalProperties": false
|
|
321760
|
+
}
|
|
321761
|
+
},
|
|
321762
|
+
"required": [
|
|
321763
|
+
"plugins",
|
|
321764
|
+
"meta"
|
|
321765
|
+
],
|
|
321766
|
+
"title": "listPublicPluginsResponse",
|
|
321767
|
+
"additionalProperties": false
|
|
321768
|
+
}
|
|
321769
|
+
}
|
|
321770
|
+
},
|
|
321771
|
+
"getPublicPluginById": {
|
|
321772
|
+
"name": "getPublicPluginById",
|
|
321773
|
+
"description": "Get public plugin by Id",
|
|
321774
|
+
"method": "get",
|
|
321775
|
+
"section": "hub",
|
|
321776
|
+
"path": "/v1/admin/hub/plugins/{id}",
|
|
321777
|
+
"disableDefaultParameters": {
|
|
321778
|
+
"x-workspace-id": true
|
|
321779
|
+
},
|
|
321780
|
+
"parameters": {
|
|
321781
|
+
"id": {
|
|
321782
|
+
"type": "string",
|
|
321783
|
+
"description": "Plugin ID",
|
|
321784
|
+
"in": "path"
|
|
321785
|
+
}
|
|
321786
|
+
},
|
|
321787
|
+
"response": {
|
|
321788
|
+
"description": "Success",
|
|
321789
|
+
"schema": {
|
|
321790
|
+
"type": "object",
|
|
321791
|
+
"properties": {
|
|
321792
|
+
"plugin": {
|
|
321793
|
+
"type": "object",
|
|
321794
|
+
"properties": {
|
|
321795
|
+
"id": {
|
|
321796
|
+
"type": "string",
|
|
321797
|
+
"minLength": 28,
|
|
321798
|
+
"maxLength": 36,
|
|
321799
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
321800
|
+
},
|
|
321801
|
+
"name": {
|
|
321802
|
+
"type": "string",
|
|
321803
|
+
"maxLength": 200,
|
|
321804
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
321805
|
+
},
|
|
321806
|
+
"version": {
|
|
321807
|
+
"type": "string",
|
|
321808
|
+
"maxLength": 200,
|
|
321809
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
321810
|
+
},
|
|
321811
|
+
"createdAt": {
|
|
321812
|
+
"type": "string",
|
|
321813
|
+
"format": "date-time",
|
|
321814
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321815
|
+
},
|
|
321816
|
+
"updatedAt": {
|
|
321817
|
+
"type": "string",
|
|
321818
|
+
"format": "date-time",
|
|
321819
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321820
|
+
},
|
|
321821
|
+
"configuration": {
|
|
321822
|
+
"type": "object",
|
|
321823
|
+
"properties": {
|
|
321824
|
+
"title": {
|
|
321825
|
+
"type": "string",
|
|
321826
|
+
"maxLength": 64,
|
|
321827
|
+
"description": "Title of the configuration"
|
|
321828
|
+
},
|
|
321829
|
+
"description": {
|
|
321830
|
+
"type": "string",
|
|
321831
|
+
"maxLength": 256,
|
|
321832
|
+
"description": "Description of the configuration"
|
|
321833
|
+
},
|
|
321834
|
+
"schema": {
|
|
321835
|
+
"type": "object",
|
|
321836
|
+
"additionalProperties": true,
|
|
321837
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
321838
|
+
}
|
|
321839
|
+
},
|
|
321840
|
+
"required": [
|
|
321841
|
+
"schema"
|
|
321842
|
+
],
|
|
321843
|
+
"description": "Configuration definition",
|
|
321844
|
+
"additionalProperties": false
|
|
321845
|
+
},
|
|
321846
|
+
"states": {
|
|
321847
|
+
"type": "object",
|
|
321848
|
+
"additionalProperties": {
|
|
321849
|
+
"type": "object",
|
|
321850
|
+
"properties": {
|
|
321851
|
+
"type": {
|
|
321852
|
+
"type": "string",
|
|
321853
|
+
"enum": [
|
|
321854
|
+
"conversation",
|
|
321855
|
+
"user",
|
|
321856
|
+
"bot",
|
|
321857
|
+
"task"
|
|
321858
|
+
],
|
|
321859
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
321860
|
+
},
|
|
321861
|
+
"schema": {
|
|
321862
|
+
"type": "object",
|
|
321863
|
+
"additionalProperties": true,
|
|
321864
|
+
"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."
|
|
321865
|
+
},
|
|
321866
|
+
"expiry": {
|
|
321867
|
+
"type": "number",
|
|
321868
|
+
"minimum": 1,
|
|
321869
|
+
"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."
|
|
321870
|
+
}
|
|
321871
|
+
},
|
|
321872
|
+
"required": [
|
|
321873
|
+
"type",
|
|
321874
|
+
"schema"
|
|
321875
|
+
],
|
|
321876
|
+
"additionalProperties": false
|
|
321877
|
+
}
|
|
321878
|
+
},
|
|
321879
|
+
"events": {
|
|
321880
|
+
"type": "object",
|
|
321881
|
+
"additionalProperties": {
|
|
321882
|
+
"type": "object",
|
|
321883
|
+
"properties": {
|
|
321884
|
+
"title": {
|
|
321885
|
+
"type": "string",
|
|
321886
|
+
"maxLength": 64,
|
|
321887
|
+
"description": "Title of the event"
|
|
321888
|
+
},
|
|
321889
|
+
"description": {
|
|
321890
|
+
"type": "string",
|
|
321891
|
+
"maxLength": 256,
|
|
321892
|
+
"description": "Description of the event"
|
|
321893
|
+
},
|
|
321894
|
+
"schema": {
|
|
321895
|
+
"type": "object",
|
|
321896
|
+
"additionalProperties": true
|
|
321897
|
+
},
|
|
321898
|
+
"attributes": {
|
|
321899
|
+
"type": "object",
|
|
321900
|
+
"additionalProperties": {
|
|
321901
|
+
"type": "string",
|
|
321902
|
+
"maxLength": 200
|
|
321903
|
+
},
|
|
321904
|
+
"description": "Optional attributes"
|
|
321905
|
+
}
|
|
321906
|
+
},
|
|
321907
|
+
"required": [
|
|
321908
|
+
"schema"
|
|
321909
|
+
],
|
|
321910
|
+
"description": "Event Definition",
|
|
321911
|
+
"additionalProperties": false
|
|
321912
|
+
}
|
|
321913
|
+
},
|
|
321914
|
+
"actions": {
|
|
321915
|
+
"type": "object",
|
|
321916
|
+
"additionalProperties": {
|
|
321917
|
+
"type": "object",
|
|
321918
|
+
"properties": {
|
|
321919
|
+
"title": {
|
|
321920
|
+
"type": "string",
|
|
321921
|
+
"maxLength": 64,
|
|
321922
|
+
"description": "Title of the action"
|
|
321923
|
+
},
|
|
321924
|
+
"description": {
|
|
321925
|
+
"type": "string",
|
|
321926
|
+
"maxLength": 256,
|
|
321927
|
+
"description": "Description of the action"
|
|
321928
|
+
},
|
|
321929
|
+
"billable": {
|
|
321930
|
+
"type": "boolean"
|
|
321931
|
+
},
|
|
321932
|
+
"cacheable": {
|
|
321933
|
+
"type": "boolean"
|
|
321934
|
+
},
|
|
321935
|
+
"input": {
|
|
321936
|
+
"type": "object",
|
|
321937
|
+
"properties": {
|
|
321938
|
+
"schema": {
|
|
321939
|
+
"type": "object",
|
|
321940
|
+
"additionalProperties": true
|
|
321941
|
+
}
|
|
321942
|
+
},
|
|
321943
|
+
"required": [
|
|
321944
|
+
"schema"
|
|
321945
|
+
],
|
|
321946
|
+
"additionalProperties": false
|
|
321947
|
+
},
|
|
321948
|
+
"output": {
|
|
321949
|
+
"type": "object",
|
|
321950
|
+
"properties": {
|
|
321951
|
+
"schema": {
|
|
321952
|
+
"type": "object",
|
|
321953
|
+
"additionalProperties": true
|
|
321954
|
+
}
|
|
321955
|
+
},
|
|
321956
|
+
"required": [
|
|
321957
|
+
"schema"
|
|
321958
|
+
],
|
|
321959
|
+
"additionalProperties": false
|
|
321960
|
+
},
|
|
321961
|
+
"attributes": {
|
|
321962
|
+
"type": "object",
|
|
321963
|
+
"additionalProperties": {
|
|
321964
|
+
"type": "string",
|
|
321965
|
+
"maxLength": 200
|
|
321966
|
+
},
|
|
321967
|
+
"description": "Optional attributes"
|
|
321968
|
+
}
|
|
321969
|
+
},
|
|
321970
|
+
"required": [
|
|
321971
|
+
"input",
|
|
321972
|
+
"output"
|
|
321973
|
+
],
|
|
321974
|
+
"description": "Action definition",
|
|
321975
|
+
"additionalProperties": false
|
|
321976
|
+
}
|
|
321977
|
+
},
|
|
321978
|
+
"dependencies": {
|
|
321979
|
+
"type": "object",
|
|
321980
|
+
"properties": {
|
|
321981
|
+
"interfaces": {
|
|
321982
|
+
"type": "object",
|
|
321983
|
+
"additionalProperties": {
|
|
321984
|
+
"type": "object",
|
|
321985
|
+
"properties": {
|
|
321986
|
+
"id": {
|
|
321987
|
+
"type": "string",
|
|
321988
|
+
"minLength": 28,
|
|
321989
|
+
"maxLength": 36
|
|
321990
|
+
},
|
|
321991
|
+
"name": {
|
|
321992
|
+
"type": "string",
|
|
321993
|
+
"maxLength": 200
|
|
321994
|
+
},
|
|
321995
|
+
"version": {
|
|
321996
|
+
"type": "string",
|
|
321997
|
+
"maxLength": 200
|
|
321998
|
+
}
|
|
321999
|
+
},
|
|
322000
|
+
"required": [
|
|
322001
|
+
"id",
|
|
322002
|
+
"name",
|
|
322003
|
+
"version"
|
|
322004
|
+
],
|
|
322005
|
+
"additionalProperties": false
|
|
322006
|
+
}
|
|
322007
|
+
},
|
|
322008
|
+
"integrations": {
|
|
322009
|
+
"type": "object",
|
|
322010
|
+
"additionalProperties": {
|
|
322011
|
+
"type": "object",
|
|
322012
|
+
"properties": {
|
|
322013
|
+
"id": {
|
|
322014
|
+
"type": "string",
|
|
322015
|
+
"minLength": 28,
|
|
322016
|
+
"maxLength": 36
|
|
322017
|
+
},
|
|
322018
|
+
"name": {
|
|
322019
|
+
"type": "string",
|
|
322020
|
+
"maxLength": 200
|
|
322021
|
+
},
|
|
322022
|
+
"version": {
|
|
322023
|
+
"type": "string",
|
|
322024
|
+
"maxLength": 200
|
|
322025
|
+
}
|
|
322026
|
+
},
|
|
322027
|
+
"required": [
|
|
322028
|
+
"id",
|
|
322029
|
+
"name",
|
|
322030
|
+
"version"
|
|
322031
|
+
],
|
|
322032
|
+
"additionalProperties": false
|
|
322033
|
+
}
|
|
322034
|
+
}
|
|
322035
|
+
},
|
|
322036
|
+
"required": [
|
|
322037
|
+
"interfaces",
|
|
322038
|
+
"integrations"
|
|
322039
|
+
],
|
|
322040
|
+
"additionalProperties": false
|
|
322041
|
+
},
|
|
322042
|
+
"user": {
|
|
322043
|
+
"type": "object",
|
|
322044
|
+
"properties": {
|
|
322045
|
+
"tags": {
|
|
322046
|
+
"type": "object",
|
|
322047
|
+
"additionalProperties": {
|
|
322048
|
+
"type": "object",
|
|
322049
|
+
"properties": {
|
|
322050
|
+
"title": {
|
|
322051
|
+
"type": "string",
|
|
322052
|
+
"maxLength": 64,
|
|
322053
|
+
"description": "Title of the tag"
|
|
322054
|
+
},
|
|
322055
|
+
"description": {
|
|
322056
|
+
"type": "string",
|
|
322057
|
+
"maxLength": 256,
|
|
322058
|
+
"description": "Description of the tag"
|
|
322059
|
+
}
|
|
322060
|
+
},
|
|
322061
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
322062
|
+
"additionalProperties": false
|
|
322063
|
+
}
|
|
322064
|
+
}
|
|
322065
|
+
},
|
|
322066
|
+
"required": [
|
|
322067
|
+
"tags"
|
|
322068
|
+
],
|
|
322069
|
+
"description": "User object configuration",
|
|
322070
|
+
"additionalProperties": false
|
|
322071
|
+
},
|
|
322072
|
+
"conversation": {
|
|
322073
|
+
"type": "object",
|
|
322074
|
+
"properties": {
|
|
322075
|
+
"tags": {
|
|
322076
|
+
"type": "object",
|
|
322077
|
+
"additionalProperties": {
|
|
322078
|
+
"type": "object",
|
|
322079
|
+
"properties": {
|
|
322080
|
+
"title": {
|
|
322081
|
+
"type": "string",
|
|
322082
|
+
"maxLength": 64,
|
|
322083
|
+
"description": "Title of the tag"
|
|
322084
|
+
},
|
|
322085
|
+
"description": {
|
|
322086
|
+
"type": "string",
|
|
322087
|
+
"maxLength": 256,
|
|
322088
|
+
"description": "Description of the tag"
|
|
322089
|
+
}
|
|
322090
|
+
},
|
|
322091
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
322092
|
+
"additionalProperties": false
|
|
322093
|
+
}
|
|
321027
322094
|
}
|
|
321028
322095
|
},
|
|
321029
322096
|
"required": [
|
|
321030
|
-
"tags"
|
|
321031
|
-
"creation"
|
|
322097
|
+
"tags"
|
|
321032
322098
|
],
|
|
321033
|
-
"description": "
|
|
322099
|
+
"description": "Conversation object configuration",
|
|
321034
322100
|
"additionalProperties": false
|
|
321035
322101
|
},
|
|
321036
|
-
"entities": {
|
|
321037
|
-
"type": "object",
|
|
321038
|
-
"additionalProperties": {
|
|
321039
|
-
"type": "object",
|
|
321040
|
-
"properties": {
|
|
321041
|
-
"title": {
|
|
321042
|
-
"type": "string",
|
|
321043
|
-
"maxLength": 64,
|
|
321044
|
-
"description": "Title of the entity"
|
|
321045
|
-
},
|
|
321046
|
-
"description": {
|
|
321047
|
-
"type": "string",
|
|
321048
|
-
"maxLength": 256,
|
|
321049
|
-
"description": "Description of the entity"
|
|
321050
|
-
},
|
|
321051
|
-
"schema": {
|
|
321052
|
-
"type": "object",
|
|
321053
|
-
"additionalProperties": true
|
|
321054
|
-
}
|
|
321055
|
-
},
|
|
321056
|
-
"required": [
|
|
321057
|
-
"schema"
|
|
321058
|
-
],
|
|
321059
|
-
"description": "Entity definition",
|
|
321060
|
-
"additionalProperties": false
|
|
321061
|
-
}
|
|
321062
|
-
},
|
|
321063
322102
|
"attributes": {
|
|
321064
322103
|
"type": "object",
|
|
321065
322104
|
"additionalProperties": {
|
|
@@ -321068,261 +322107,88 @@ var state5 = {
|
|
|
321068
322107
|
},
|
|
321069
322108
|
"description": "Optional attributes"
|
|
321070
322109
|
},
|
|
321071
|
-
"dev": {
|
|
321072
|
-
"type": "boolean",
|
|
321073
|
-
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
321074
|
-
},
|
|
321075
322110
|
"title": {
|
|
321076
322111
|
"type": "string",
|
|
321077
322112
|
"minLength": 1,
|
|
321078
322113
|
"maxLength": 64,
|
|
321079
|
-
"description": "Title of the
|
|
322114
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
321080
322115
|
},
|
|
321081
322116
|
"description": {
|
|
321082
322117
|
"type": "string",
|
|
321083
322118
|
"maxLength": 256,
|
|
321084
|
-
"description": "Description of the
|
|
322119
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
321085
322120
|
},
|
|
321086
322121
|
"iconUrl": {
|
|
321087
322122
|
"type": "string",
|
|
321088
|
-
"description": "URL of the icon of the
|
|
322123
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
321089
322124
|
},
|
|
321090
322125
|
"readmeUrl": {
|
|
321091
322126
|
"type": "string",
|
|
321092
|
-
"description": "URL of the readme of the
|
|
322127
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
321093
322128
|
},
|
|
321094
322129
|
"public": {
|
|
321095
322130
|
"type": "boolean",
|
|
321096
|
-
"description": "Indicates if the
|
|
321097
|
-
},
|
|
321098
|
-
"verificationStatus": {
|
|
321099
|
-
"type": "string",
|
|
321100
|
-
"enum": [
|
|
321101
|
-
"unapproved",
|
|
321102
|
-
"pending",
|
|
321103
|
-
"approved",
|
|
321104
|
-
"rejected"
|
|
321105
|
-
],
|
|
321106
|
-
"description": "Status of the integration version verification"
|
|
321107
|
-
},
|
|
321108
|
-
"secrets": {
|
|
321109
|
-
"type": "array",
|
|
321110
|
-
"items": {
|
|
321111
|
-
"type": "string"
|
|
321112
|
-
},
|
|
321113
|
-
"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."
|
|
321114
|
-
},
|
|
321115
|
-
"ownerWorkspace": {
|
|
321116
|
-
"type": "object",
|
|
321117
|
-
"properties": {
|
|
321118
|
-
"id": {
|
|
321119
|
-
"type": "string"
|
|
321120
|
-
},
|
|
321121
|
-
"handle": {
|
|
321122
|
-
"type": "string",
|
|
321123
|
-
"nullable": true
|
|
321124
|
-
},
|
|
321125
|
-
"name": {
|
|
321126
|
-
"type": "string"
|
|
321127
|
-
}
|
|
321128
|
-
},
|
|
321129
|
-
"required": [
|
|
321130
|
-
"id",
|
|
321131
|
-
"handle",
|
|
321132
|
-
"name"
|
|
321133
|
-
],
|
|
321134
|
-
"additionalProperties": false
|
|
321135
|
-
},
|
|
321136
|
-
"meta": {
|
|
321137
|
-
"type": "object",
|
|
321138
|
-
"properties": {
|
|
321139
|
-
"installs": {
|
|
321140
|
-
"type": "number"
|
|
321141
|
-
},
|
|
321142
|
-
"views": {
|
|
321143
|
-
"type": "number"
|
|
321144
|
-
}
|
|
321145
|
-
},
|
|
321146
|
-
"required": [
|
|
321147
|
-
"installs",
|
|
321148
|
-
"views"
|
|
321149
|
-
],
|
|
321150
|
-
"additionalProperties": false
|
|
322131
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
321151
322132
|
}
|
|
321152
322133
|
},
|
|
321153
322134
|
"required": [
|
|
321154
322135
|
"id",
|
|
321155
|
-
"createdAt",
|
|
321156
|
-
"updatedAt",
|
|
321157
|
-
"identifier",
|
|
321158
|
-
"url",
|
|
321159
322136
|
"name",
|
|
321160
322137
|
"version",
|
|
321161
|
-
"
|
|
322138
|
+
"createdAt",
|
|
322139
|
+
"updatedAt",
|
|
321162
322140
|
"configuration",
|
|
321163
|
-
"configurations",
|
|
321164
|
-
"channels",
|
|
321165
322141
|
"states",
|
|
321166
322142
|
"events",
|
|
321167
322143
|
"actions",
|
|
322144
|
+
"dependencies",
|
|
321168
322145
|
"user",
|
|
321169
|
-
"
|
|
321170
|
-
"dev",
|
|
322146
|
+
"conversation",
|
|
321171
322147
|
"title",
|
|
321172
322148
|
"description",
|
|
321173
322149
|
"iconUrl",
|
|
321174
322150
|
"readmeUrl",
|
|
321175
|
-
"public"
|
|
321176
|
-
"verificationStatus",
|
|
321177
|
-
"secrets",
|
|
321178
|
-
"ownerWorkspace",
|
|
321179
|
-
"meta"
|
|
322151
|
+
"public"
|
|
321180
322152
|
],
|
|
321181
322153
|
"additionalProperties": false
|
|
321182
322154
|
}
|
|
321183
322155
|
},
|
|
321184
322156
|
"required": [
|
|
321185
|
-
"
|
|
322157
|
+
"plugin"
|
|
321186
322158
|
],
|
|
321187
|
-
"title": "
|
|
322159
|
+
"title": "getPublicPluginByIdResponse",
|
|
321188
322160
|
"additionalProperties": false
|
|
321189
322161
|
}
|
|
321190
322162
|
}
|
|
321191
322163
|
},
|
|
321192
|
-
"
|
|
321193
|
-
"name": "
|
|
321194
|
-
"description": "
|
|
322164
|
+
"getDereferencedPublicPluginById": {
|
|
322165
|
+
"name": "getDereferencedPublicPluginById",
|
|
322166
|
+
"description": "Get public plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
321195
322167
|
"method": "get",
|
|
321196
322168
|
"section": "hub",
|
|
321197
|
-
"path": "/v1/admin/hub/plugins",
|
|
322169
|
+
"path": "/v1/admin/hub/plugins/{id}/dereferenced",
|
|
321198
322170
|
"disableDefaultParameters": {
|
|
321199
322171
|
"x-workspace-id": true
|
|
321200
322172
|
},
|
|
321201
322173
|
"parameters": {
|
|
321202
|
-
"
|
|
321203
|
-
"in": "query",
|
|
321204
|
-
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
321205
|
-
"type": "string"
|
|
321206
|
-
},
|
|
321207
|
-
"name": {
|
|
321208
|
-
"in": "query",
|
|
322174
|
+
"id": {
|
|
321209
322175
|
"type": "string",
|
|
321210
|
-
"description": "
|
|
322176
|
+
"description": "Plugin ID",
|
|
322177
|
+
"in": "path"
|
|
321211
322178
|
},
|
|
321212
|
-
"
|
|
322179
|
+
"interfaces": {
|
|
321213
322180
|
"in": "query",
|
|
321214
|
-
"type": "string",
|
|
321215
|
-
"description": "Filter a plugin by name and version"
|
|
321216
|
-
}
|
|
321217
|
-
},
|
|
321218
|
-
"response": {
|
|
321219
|
-
"description": "Success",
|
|
321220
|
-
"schema": {
|
|
321221
322181
|
"type": "object",
|
|
321222
|
-
"
|
|
321223
|
-
"
|
|
321224
|
-
|
|
321225
|
-
"
|
|
321226
|
-
|
|
321227
|
-
"properties": {
|
|
321228
|
-
"id": {
|
|
321229
|
-
"type": "string",
|
|
321230
|
-
"minLength": 28,
|
|
321231
|
-
"maxLength": 36,
|
|
321232
|
-
"description": "ID of the [Plugin](#schema_plugin)"
|
|
321233
|
-
},
|
|
321234
|
-
"createdAt": {
|
|
321235
|
-
"type": "string",
|
|
321236
|
-
"format": "date-time",
|
|
321237
|
-
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321238
|
-
},
|
|
321239
|
-
"updatedAt": {
|
|
321240
|
-
"type": "string",
|
|
321241
|
-
"format": "date-time",
|
|
321242
|
-
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321243
|
-
},
|
|
321244
|
-
"name": {
|
|
321245
|
-
"type": "string",
|
|
321246
|
-
"maxLength": 200,
|
|
321247
|
-
"description": "Name of the [Plugin](#schema_plugin)"
|
|
321248
|
-
},
|
|
321249
|
-
"version": {
|
|
321250
|
-
"type": "string",
|
|
321251
|
-
"maxLength": 200,
|
|
321252
|
-
"description": "Version of the [Plugin](#schema_plugin)"
|
|
321253
|
-
},
|
|
321254
|
-
"title": {
|
|
321255
|
-
"type": "string",
|
|
321256
|
-
"minLength": 1,
|
|
321257
|
-
"maxLength": 64,
|
|
321258
|
-
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
321259
|
-
},
|
|
321260
|
-
"description": {
|
|
321261
|
-
"type": "string",
|
|
321262
|
-
"maxLength": 256,
|
|
321263
|
-
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
321264
|
-
},
|
|
321265
|
-
"iconUrl": {
|
|
321266
|
-
"type": "string",
|
|
321267
|
-
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
321268
|
-
},
|
|
321269
|
-
"readmeUrl": {
|
|
321270
|
-
"type": "string",
|
|
321271
|
-
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
321272
|
-
},
|
|
321273
|
-
"public": {
|
|
321274
|
-
"type": "boolean",
|
|
321275
|
-
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
321276
|
-
}
|
|
321277
|
-
},
|
|
321278
|
-
"required": [
|
|
321279
|
-
"id",
|
|
321280
|
-
"createdAt",
|
|
321281
|
-
"updatedAt",
|
|
321282
|
-
"name",
|
|
321283
|
-
"version",
|
|
321284
|
-
"title",
|
|
321285
|
-
"description",
|
|
321286
|
-
"iconUrl",
|
|
321287
|
-
"readmeUrl",
|
|
321288
|
-
"public"
|
|
321289
|
-
]
|
|
321290
|
-
}
|
|
322182
|
+
"schema": {
|
|
322183
|
+
"type": "object",
|
|
322184
|
+
"additionalProperties": {
|
|
322185
|
+
"type": "string",
|
|
322186
|
+
"description": "integration id"
|
|
321291
322187
|
},
|
|
321292
|
-
"
|
|
321293
|
-
"type": "object",
|
|
321294
|
-
"properties": {
|
|
321295
|
-
"nextToken": {
|
|
321296
|
-
"type": "string",
|
|
321297
|
-
"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."
|
|
321298
|
-
}
|
|
321299
|
-
},
|
|
321300
|
-
"additionalProperties": false
|
|
321301
|
-
}
|
|
322188
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
321302
322189
|
},
|
|
321303
|
-
"
|
|
321304
|
-
|
|
321305
|
-
"meta"
|
|
321306
|
-
],
|
|
321307
|
-
"title": "listPublicPluginsResponse",
|
|
321308
|
-
"additionalProperties": false
|
|
321309
|
-
}
|
|
321310
|
-
}
|
|
321311
|
-
},
|
|
321312
|
-
"getPublicPluginById": {
|
|
321313
|
-
"name": "getPublicPluginById",
|
|
321314
|
-
"description": "Get public plugin by Id",
|
|
321315
|
-
"method": "get",
|
|
321316
|
-
"section": "hub",
|
|
321317
|
-
"path": "/v1/admin/hub/plugins/{id}",
|
|
321318
|
-
"disableDefaultParameters": {
|
|
321319
|
-
"x-workspace-id": true
|
|
321320
|
-
},
|
|
321321
|
-
"parameters": {
|
|
321322
|
-
"id": {
|
|
321323
|
-
"type": "string",
|
|
321324
|
-
"description": "Plugin ID",
|
|
321325
|
-
"in": "path"
|
|
322190
|
+
"description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
|
|
322191
|
+
"required": true
|
|
321326
322192
|
}
|
|
321327
322193
|
},
|
|
321328
322194
|
"response": {
|
|
@@ -321697,7 +322563,7 @@ var state5 = {
|
|
|
321697
322563
|
"required": [
|
|
321698
322564
|
"plugin"
|
|
321699
322565
|
],
|
|
321700
|
-
"title": "
|
|
322566
|
+
"title": "getDereferencedPublicPluginByIdResponse",
|
|
321701
322567
|
"additionalProperties": false
|
|
321702
322568
|
}
|
|
321703
322569
|
}
|
|
@@ -323534,6 +324400,10 @@ var state5 = {
|
|
|
323534
324400
|
"enabled": {
|
|
323535
324401
|
"type": "boolean"
|
|
323536
324402
|
},
|
|
324403
|
+
"integrationId": {
|
|
324404
|
+
"type": "string",
|
|
324405
|
+
"description": "Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance."
|
|
324406
|
+
},
|
|
323537
324407
|
"configurationType": {
|
|
323538
324408
|
"type": "string",
|
|
323539
324409
|
"nullable": true,
|
|
@@ -331142,6 +332012,50 @@ var state5 = {
|
|
|
331142
332012
|
}
|
|
331143
332013
|
}
|
|
331144
332014
|
},
|
|
332015
|
+
"getDereferencedPlugin": {
|
|
332016
|
+
"name": "getDereferencedPlugin",
|
|
332017
|
+
"description": "Get plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
332018
|
+
"method": "get",
|
|
332019
|
+
"section": "plugin",
|
|
332020
|
+
"path": "/v1/admin/plugins/{id}/dereferenced",
|
|
332021
|
+
"parameters": {
|
|
332022
|
+
"id": {
|
|
332023
|
+
"type": "string",
|
|
332024
|
+
"description": "Plugin ID",
|
|
332025
|
+
"in": "path"
|
|
332026
|
+
},
|
|
332027
|
+
"interfaces": {
|
|
332028
|
+
"in": "query",
|
|
332029
|
+
"type": "object",
|
|
332030
|
+
"schema": {
|
|
332031
|
+
"type": "object",
|
|
332032
|
+
"additionalProperties": {
|
|
332033
|
+
"type": "string",
|
|
332034
|
+
"description": "integration id"
|
|
332035
|
+
},
|
|
332036
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
332037
|
+
},
|
|
332038
|
+
"description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
|
|
332039
|
+
"required": true
|
|
332040
|
+
}
|
|
332041
|
+
},
|
|
332042
|
+
"response": {
|
|
332043
|
+
"description": "Get a dereferenced plugin",
|
|
332044
|
+
"schema": {
|
|
332045
|
+
"type": "object",
|
|
332046
|
+
"properties": {
|
|
332047
|
+
"plugin": {
|
|
332048
|
+
"$ref": "#/components/schemas/Plugin"
|
|
332049
|
+
}
|
|
332050
|
+
},
|
|
332051
|
+
"required": [
|
|
332052
|
+
"plugin"
|
|
332053
|
+
],
|
|
332054
|
+
"title": "getDereferencedPluginResponse",
|
|
332055
|
+
"additionalProperties": false
|
|
332056
|
+
}
|
|
332057
|
+
}
|
|
332058
|
+
},
|
|
331145
332059
|
"getPluginByName": {
|
|
331146
332060
|
"name": "getPluginByName",
|
|
331147
332061
|
"description": "Get Plugin by name and version",
|
|
@@ -335202,7 +336116,7 @@ var state5 = {
|
|
|
335202
336116
|
"title": "Botpress API",
|
|
335203
336117
|
"description": "API for Botpress Cloud",
|
|
335204
336118
|
"server": "https://api.botpress.cloud",
|
|
335205
|
-
"version": "1.
|
|
336119
|
+
"version": "1.27.0",
|
|
335206
336120
|
"prefix": "v1"
|
|
335207
336121
|
},
|
|
335208
336122
|
"errors": [
|
|
@@ -335462,6 +336376,7 @@ var state5 = {
|
|
|
335462
336376
|
"getPublicIntegrationResponse": true,
|
|
335463
336377
|
"listPublicPluginsResponse": true,
|
|
335464
336378
|
"getPublicPluginByIdResponse": true,
|
|
336379
|
+
"getDereferencedPublicPluginByIdResponse": true,
|
|
335465
336380
|
"getPublicPluginResponse": true,
|
|
335466
336381
|
"getPublicPluginCodeResponse": true,
|
|
335467
336382
|
"listPublicInterfacesResponse": true,
|
|
@@ -335537,6 +336452,7 @@ var state5 = {
|
|
|
335537
336452
|
"listInterfacesResponse": true,
|
|
335538
336453
|
"createPluginResponse": true,
|
|
335539
336454
|
"getPluginResponse": true,
|
|
336455
|
+
"getDereferencedPluginResponse": true,
|
|
335540
336456
|
"getPluginByNameResponse": true,
|
|
335541
336457
|
"updatePluginResponse": true,
|
|
335542
336458
|
"deletePluginResponse": true,
|
|
@@ -339161,6 +340077,7 @@ var state5 = {
|
|
|
339161
340077
|
"getPublicIntegration",
|
|
339162
340078
|
"listPublicPlugins",
|
|
339163
340079
|
"getPublicPluginById",
|
|
340080
|
+
"getDereferencedPublicPluginById",
|
|
339164
340081
|
"getPublicPlugin",
|
|
339165
340082
|
"getPublicPluginCode",
|
|
339166
340083
|
"listPublicInterfaces",
|
|
@@ -339288,6 +340205,7 @@ var state5 = {
|
|
|
339288
340205
|
"operations": [
|
|
339289
340206
|
"createPlugin",
|
|
339290
340207
|
"getPlugin",
|
|
340208
|
+
"getDereferencedPlugin",
|
|
339291
340209
|
"getPluginByName",
|
|
339292
340210
|
"updatePlugin",
|
|
339293
340211
|
"deletePlugin",
|