@botpress/api 1.24.0 → 1.26.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 +1557 -615
- package/dist/src/gen/admin/state.d.ts +413 -0
- package/dist/src/gen/state.d.ts +413 -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 +472 -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 +472 -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.26.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
|
],
|
|
@@ -297237,6 +297644,10 @@ var state2 = {
|
|
|
297237
297644
|
"additionalProperties": false
|
|
297238
297645
|
}
|
|
297239
297646
|
},
|
|
297647
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
297648
|
+
"type": "boolean",
|
|
297649
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
297650
|
+
},
|
|
297240
297651
|
"secrets": {
|
|
297241
297652
|
"type": "object",
|
|
297242
297653
|
"additionalProperties": {
|
|
@@ -297827,6 +298238,10 @@ var state2 = {
|
|
|
297827
298238
|
"additionalProperties": false
|
|
297828
298239
|
}
|
|
297829
298240
|
},
|
|
298241
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
298242
|
+
"type": "boolean",
|
|
298243
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
298244
|
+
},
|
|
297830
298245
|
"secrets": {
|
|
297831
298246
|
"type": "object",
|
|
297832
298247
|
"additionalProperties": {
|
|
@@ -297990,6 +298405,10 @@ var state2 = {
|
|
|
297990
298405
|
},
|
|
297991
298406
|
"description": "Additional configuration definitions of the integration"
|
|
297992
298407
|
},
|
|
298408
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
298409
|
+
"type": "boolean",
|
|
298410
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
298411
|
+
},
|
|
297993
298412
|
"channels": {
|
|
297994
298413
|
"type": "object",
|
|
297995
298414
|
"additionalProperties": {
|
|
@@ -298582,6 +299001,10 @@ var state2 = {
|
|
|
298582
299001
|
},
|
|
298583
299002
|
"description": "Additional configuration definitions of the integration"
|
|
298584
299003
|
},
|
|
299004
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
299005
|
+
"type": "boolean",
|
|
299006
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
299007
|
+
},
|
|
298585
299008
|
"channels": {
|
|
298586
299009
|
"type": "object",
|
|
298587
299010
|
"additionalProperties": {
|
|
@@ -300650,6 +301073,50 @@ var state2 = {
|
|
|
300650
301073
|
}
|
|
300651
301074
|
}
|
|
300652
301075
|
},
|
|
301076
|
+
"getDereferencedPlugin": {
|
|
301077
|
+
"name": "getDereferencedPlugin",
|
|
301078
|
+
"description": "Get plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
301079
|
+
"method": "get",
|
|
301080
|
+
"section": "plugin",
|
|
301081
|
+
"path": "/v1/admin/plugins/{id}/dereferenced",
|
|
301082
|
+
"parameters": {
|
|
301083
|
+
"id": {
|
|
301084
|
+
"type": "string",
|
|
301085
|
+
"description": "Plugin ID",
|
|
301086
|
+
"in": "path"
|
|
301087
|
+
},
|
|
301088
|
+
"interfaces": {
|
|
301089
|
+
"in": "query",
|
|
301090
|
+
"type": "object",
|
|
301091
|
+
"schema": {
|
|
301092
|
+
"type": "object",
|
|
301093
|
+
"additionalProperties": {
|
|
301094
|
+
"type": "string",
|
|
301095
|
+
"description": "integration id"
|
|
301096
|
+
},
|
|
301097
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
301098
|
+
},
|
|
301099
|
+
"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.",
|
|
301100
|
+
"required": true
|
|
301101
|
+
}
|
|
301102
|
+
},
|
|
301103
|
+
"response": {
|
|
301104
|
+
"description": "Get a dereferenced plugin",
|
|
301105
|
+
"schema": {
|
|
301106
|
+
"type": "object",
|
|
301107
|
+
"properties": {
|
|
301108
|
+
"plugin": {
|
|
301109
|
+
"$ref": "#/components/schemas/Plugin"
|
|
301110
|
+
}
|
|
301111
|
+
},
|
|
301112
|
+
"required": [
|
|
301113
|
+
"plugin"
|
|
301114
|
+
],
|
|
301115
|
+
"title": "getDereferencedPluginResponse",
|
|
301116
|
+
"additionalProperties": false
|
|
301117
|
+
}
|
|
301118
|
+
}
|
|
301119
|
+
},
|
|
300653
301120
|
"getPluginByName": {
|
|
300654
301121
|
"name": "getPluginByName",
|
|
300655
301122
|
"description": "Get Plugin by name and version",
|
|
@@ -301736,7 +302203,7 @@ var state2 = {
|
|
|
301736
302203
|
"title": "Botpress API",
|
|
301737
302204
|
"description": "API for Botpress Cloud",
|
|
301738
302205
|
"server": "https://api.botpress.cloud",
|
|
301739
|
-
"version": "1.
|
|
302206
|
+
"version": "1.26.0",
|
|
301740
302207
|
"prefix": "v1"
|
|
301741
302208
|
},
|
|
301742
302209
|
"errors": [
|
|
@@ -301911,6 +302378,7 @@ var state2 = {
|
|
|
301911
302378
|
"getPublicIntegrationResponse": true,
|
|
301912
302379
|
"listPublicPluginsResponse": true,
|
|
301913
302380
|
"getPublicPluginByIdResponse": true,
|
|
302381
|
+
"getDereferencedPublicPluginByIdResponse": true,
|
|
301914
302382
|
"getPublicPluginResponse": true,
|
|
301915
302383
|
"getPublicPluginCodeResponse": true,
|
|
301916
302384
|
"listPublicInterfacesResponse": true,
|
|
@@ -301986,6 +302454,7 @@ var state2 = {
|
|
|
301986
302454
|
"listInterfacesResponse": true,
|
|
301987
302455
|
"createPluginResponse": true,
|
|
301988
302456
|
"getPluginResponse": true,
|
|
302457
|
+
"getDereferencedPluginResponse": true,
|
|
301989
302458
|
"getPluginByNameResponse": true,
|
|
301990
302459
|
"updatePluginResponse": true,
|
|
301991
302460
|
"deletePluginResponse": true,
|
|
@@ -305541,6 +306010,7 @@ var state2 = {
|
|
|
305541
306010
|
"getPublicIntegration",
|
|
305542
306011
|
"listPublicPlugins",
|
|
305543
306012
|
"getPublicPluginById",
|
|
306013
|
+
"getDereferencedPublicPluginById",
|
|
305544
306014
|
"getPublicPlugin",
|
|
305545
306015
|
"getPublicPluginCode",
|
|
305546
306016
|
"listPublicInterfaces",
|
|
@@ -305651,6 +306121,7 @@ var state2 = {
|
|
|
305651
306121
|
"operations": [
|
|
305652
306122
|
"createPlugin",
|
|
305653
306123
|
"getPlugin",
|
|
306124
|
+
"getDereferencedPlugin",
|
|
305654
306125
|
"getPluginByName",
|
|
305655
306126
|
"updatePlugin",
|
|
305656
306127
|
"deletePlugin",
|
|
@@ -307549,7 +308020,7 @@ var state3 = {
|
|
|
307549
308020
|
"title": "Botpress API",
|
|
307550
308021
|
"description": "API for Botpress Cloud",
|
|
307551
308022
|
"server": "https://api.botpress.cloud",
|
|
307552
|
-
"version": "1.
|
|
308023
|
+
"version": "1.26.0",
|
|
307553
308024
|
"prefix": "v1"
|
|
307554
308025
|
},
|
|
307555
308026
|
"errors": [
|
|
@@ -312595,7 +313066,7 @@ var state4 = {
|
|
|
312595
313066
|
"title": "Botpress API",
|
|
312596
313067
|
"description": "API for Botpress Cloud",
|
|
312597
313068
|
"server": "https://api.botpress.cloud",
|
|
312598
|
-
"version": "1.
|
|
313069
|
+
"version": "1.26.0",
|
|
312599
313070
|
"prefix": "v1"
|
|
312600
313071
|
},
|
|
312601
313072
|
"errors": [
|
|
@@ -320986,64 +321457,644 @@ var state5 = {
|
|
|
320986
321457
|
"description": "Definition of a tag that can be provided on the object",
|
|
320987
321458
|
"additionalProperties": false
|
|
320988
321459
|
}
|
|
320989
|
-
},
|
|
320990
|
-
"creation": {
|
|
320991
|
-
"type": "object",
|
|
320992
|
-
"properties": {
|
|
320993
|
-
"enabled": {
|
|
320994
|
-
"type": "boolean",
|
|
320995
|
-
"description": "Enable user creation"
|
|
320996
|
-
},
|
|
320997
|
-
"requiredTags": {
|
|
320998
|
-
"type": "array",
|
|
320999
|
-
"items": {
|
|
321000
|
-
"type": "string"
|
|
321001
|
-
},
|
|
321002
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
321003
|
-
}
|
|
321004
|
-
},
|
|
321005
|
-
"required": [
|
|
321006
|
-
"enabled",
|
|
321007
|
-
"requiredTags"
|
|
321008
|
-
],
|
|
321009
|
-
"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.",
|
|
321010
|
-
"additionalProperties": false
|
|
321460
|
+
},
|
|
321461
|
+
"creation": {
|
|
321462
|
+
"type": "object",
|
|
321463
|
+
"properties": {
|
|
321464
|
+
"enabled": {
|
|
321465
|
+
"type": "boolean",
|
|
321466
|
+
"description": "Enable user creation"
|
|
321467
|
+
},
|
|
321468
|
+
"requiredTags": {
|
|
321469
|
+
"type": "array",
|
|
321470
|
+
"items": {
|
|
321471
|
+
"type": "string"
|
|
321472
|
+
},
|
|
321473
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
321474
|
+
}
|
|
321475
|
+
},
|
|
321476
|
+
"required": [
|
|
321477
|
+
"enabled",
|
|
321478
|
+
"requiredTags"
|
|
321479
|
+
],
|
|
321480
|
+
"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.",
|
|
321481
|
+
"additionalProperties": false
|
|
321482
|
+
}
|
|
321483
|
+
},
|
|
321484
|
+
"required": [
|
|
321485
|
+
"tags",
|
|
321486
|
+
"creation"
|
|
321487
|
+
],
|
|
321488
|
+
"description": "User object configuration",
|
|
321489
|
+
"additionalProperties": false
|
|
321490
|
+
},
|
|
321491
|
+
"entities": {
|
|
321492
|
+
"type": "object",
|
|
321493
|
+
"additionalProperties": {
|
|
321494
|
+
"type": "object",
|
|
321495
|
+
"properties": {
|
|
321496
|
+
"title": {
|
|
321497
|
+
"type": "string",
|
|
321498
|
+
"maxLength": 64,
|
|
321499
|
+
"description": "Title of the entity"
|
|
321500
|
+
},
|
|
321501
|
+
"description": {
|
|
321502
|
+
"type": "string",
|
|
321503
|
+
"maxLength": 256,
|
|
321504
|
+
"description": "Description of the entity"
|
|
321505
|
+
},
|
|
321506
|
+
"schema": {
|
|
321507
|
+
"type": "object",
|
|
321508
|
+
"additionalProperties": true
|
|
321509
|
+
}
|
|
321510
|
+
},
|
|
321511
|
+
"required": [
|
|
321512
|
+
"schema"
|
|
321513
|
+
],
|
|
321514
|
+
"description": "Entity definition",
|
|
321515
|
+
"additionalProperties": false
|
|
321516
|
+
}
|
|
321517
|
+
},
|
|
321518
|
+
"attributes": {
|
|
321519
|
+
"type": "object",
|
|
321520
|
+
"additionalProperties": {
|
|
321521
|
+
"type": "string",
|
|
321522
|
+
"maxLength": 200
|
|
321523
|
+
},
|
|
321524
|
+
"description": "Optional attributes"
|
|
321525
|
+
},
|
|
321526
|
+
"dev": {
|
|
321527
|
+
"type": "boolean",
|
|
321528
|
+
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
321529
|
+
},
|
|
321530
|
+
"title": {
|
|
321531
|
+
"type": "string",
|
|
321532
|
+
"minLength": 1,
|
|
321533
|
+
"maxLength": 64,
|
|
321534
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
321535
|
+
},
|
|
321536
|
+
"description": {
|
|
321537
|
+
"type": "string",
|
|
321538
|
+
"maxLength": 256,
|
|
321539
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
321540
|
+
},
|
|
321541
|
+
"iconUrl": {
|
|
321542
|
+
"type": "string",
|
|
321543
|
+
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
321544
|
+
},
|
|
321545
|
+
"readmeUrl": {
|
|
321546
|
+
"type": "string",
|
|
321547
|
+
"description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
|
|
321548
|
+
},
|
|
321549
|
+
"public": {
|
|
321550
|
+
"type": "boolean",
|
|
321551
|
+
"description": "Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
321552
|
+
},
|
|
321553
|
+
"verificationStatus": {
|
|
321554
|
+
"type": "string",
|
|
321555
|
+
"enum": [
|
|
321556
|
+
"unapproved",
|
|
321557
|
+
"pending",
|
|
321558
|
+
"approved",
|
|
321559
|
+
"rejected"
|
|
321560
|
+
],
|
|
321561
|
+
"description": "Status of the integration version verification"
|
|
321562
|
+
},
|
|
321563
|
+
"secrets": {
|
|
321564
|
+
"type": "array",
|
|
321565
|
+
"items": {
|
|
321566
|
+
"type": "string"
|
|
321567
|
+
},
|
|
321568
|
+
"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."
|
|
321569
|
+
},
|
|
321570
|
+
"ownerWorkspace": {
|
|
321571
|
+
"type": "object",
|
|
321572
|
+
"properties": {
|
|
321573
|
+
"id": {
|
|
321574
|
+
"type": "string"
|
|
321575
|
+
},
|
|
321576
|
+
"handle": {
|
|
321577
|
+
"type": "string",
|
|
321578
|
+
"nullable": true
|
|
321579
|
+
},
|
|
321580
|
+
"name": {
|
|
321581
|
+
"type": "string"
|
|
321582
|
+
}
|
|
321583
|
+
},
|
|
321584
|
+
"required": [
|
|
321585
|
+
"id",
|
|
321586
|
+
"handle",
|
|
321587
|
+
"name"
|
|
321588
|
+
],
|
|
321589
|
+
"additionalProperties": false
|
|
321590
|
+
},
|
|
321591
|
+
"meta": {
|
|
321592
|
+
"type": "object",
|
|
321593
|
+
"properties": {
|
|
321594
|
+
"installs": {
|
|
321595
|
+
"type": "number"
|
|
321596
|
+
},
|
|
321597
|
+
"views": {
|
|
321598
|
+
"type": "number"
|
|
321599
|
+
}
|
|
321600
|
+
},
|
|
321601
|
+
"required": [
|
|
321602
|
+
"installs",
|
|
321603
|
+
"views"
|
|
321604
|
+
],
|
|
321605
|
+
"additionalProperties": false
|
|
321606
|
+
}
|
|
321607
|
+
},
|
|
321608
|
+
"required": [
|
|
321609
|
+
"id",
|
|
321610
|
+
"createdAt",
|
|
321611
|
+
"updatedAt",
|
|
321612
|
+
"identifier",
|
|
321613
|
+
"url",
|
|
321614
|
+
"name",
|
|
321615
|
+
"version",
|
|
321616
|
+
"interfaces",
|
|
321617
|
+
"configuration",
|
|
321618
|
+
"configurations",
|
|
321619
|
+
"channels",
|
|
321620
|
+
"states",
|
|
321621
|
+
"events",
|
|
321622
|
+
"actions",
|
|
321623
|
+
"user",
|
|
321624
|
+
"entities",
|
|
321625
|
+
"dev",
|
|
321626
|
+
"title",
|
|
321627
|
+
"description",
|
|
321628
|
+
"iconUrl",
|
|
321629
|
+
"readmeUrl",
|
|
321630
|
+
"public",
|
|
321631
|
+
"verificationStatus",
|
|
321632
|
+
"secrets",
|
|
321633
|
+
"ownerWorkspace",
|
|
321634
|
+
"meta"
|
|
321635
|
+
],
|
|
321636
|
+
"additionalProperties": false
|
|
321637
|
+
}
|
|
321638
|
+
},
|
|
321639
|
+
"required": [
|
|
321640
|
+
"integration"
|
|
321641
|
+
],
|
|
321642
|
+
"title": "getPublicIntegrationResponse",
|
|
321643
|
+
"additionalProperties": false
|
|
321644
|
+
}
|
|
321645
|
+
}
|
|
321646
|
+
},
|
|
321647
|
+
"listPublicPlugins": {
|
|
321648
|
+
"name": "listPublicPlugins",
|
|
321649
|
+
"description": "List public plugin",
|
|
321650
|
+
"method": "get",
|
|
321651
|
+
"section": "hub",
|
|
321652
|
+
"path": "/v1/admin/hub/plugins",
|
|
321653
|
+
"disableDefaultParameters": {
|
|
321654
|
+
"x-workspace-id": true
|
|
321655
|
+
},
|
|
321656
|
+
"parameters": {
|
|
321657
|
+
"nextToken": {
|
|
321658
|
+
"in": "query",
|
|
321659
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
321660
|
+
"type": "string"
|
|
321661
|
+
},
|
|
321662
|
+
"name": {
|
|
321663
|
+
"in": "query",
|
|
321664
|
+
"type": "string",
|
|
321665
|
+
"description": "Filter all versions of a plugin by name"
|
|
321666
|
+
},
|
|
321667
|
+
"version": {
|
|
321668
|
+
"in": "query",
|
|
321669
|
+
"type": "string",
|
|
321670
|
+
"description": "Filter a plugin by name and version"
|
|
321671
|
+
}
|
|
321672
|
+
},
|
|
321673
|
+
"response": {
|
|
321674
|
+
"description": "Success",
|
|
321675
|
+
"schema": {
|
|
321676
|
+
"type": "object",
|
|
321677
|
+
"properties": {
|
|
321678
|
+
"plugins": {
|
|
321679
|
+
"type": "array",
|
|
321680
|
+
"items": {
|
|
321681
|
+
"type": "object",
|
|
321682
|
+
"properties": {
|
|
321683
|
+
"id": {
|
|
321684
|
+
"type": "string",
|
|
321685
|
+
"minLength": 28,
|
|
321686
|
+
"maxLength": 36,
|
|
321687
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
321688
|
+
},
|
|
321689
|
+
"createdAt": {
|
|
321690
|
+
"type": "string",
|
|
321691
|
+
"format": "date-time",
|
|
321692
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321693
|
+
},
|
|
321694
|
+
"updatedAt": {
|
|
321695
|
+
"type": "string",
|
|
321696
|
+
"format": "date-time",
|
|
321697
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321698
|
+
},
|
|
321699
|
+
"name": {
|
|
321700
|
+
"type": "string",
|
|
321701
|
+
"maxLength": 200,
|
|
321702
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
321703
|
+
},
|
|
321704
|
+
"version": {
|
|
321705
|
+
"type": "string",
|
|
321706
|
+
"maxLength": 200,
|
|
321707
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
321708
|
+
},
|
|
321709
|
+
"title": {
|
|
321710
|
+
"type": "string",
|
|
321711
|
+
"minLength": 1,
|
|
321712
|
+
"maxLength": 64,
|
|
321713
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
321714
|
+
},
|
|
321715
|
+
"description": {
|
|
321716
|
+
"type": "string",
|
|
321717
|
+
"maxLength": 256,
|
|
321718
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
321719
|
+
},
|
|
321720
|
+
"iconUrl": {
|
|
321721
|
+
"type": "string",
|
|
321722
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
321723
|
+
},
|
|
321724
|
+
"readmeUrl": {
|
|
321725
|
+
"type": "string",
|
|
321726
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
321727
|
+
},
|
|
321728
|
+
"public": {
|
|
321729
|
+
"type": "boolean",
|
|
321730
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
321731
|
+
}
|
|
321732
|
+
},
|
|
321733
|
+
"required": [
|
|
321734
|
+
"id",
|
|
321735
|
+
"createdAt",
|
|
321736
|
+
"updatedAt",
|
|
321737
|
+
"name",
|
|
321738
|
+
"version",
|
|
321739
|
+
"title",
|
|
321740
|
+
"description",
|
|
321741
|
+
"iconUrl",
|
|
321742
|
+
"readmeUrl",
|
|
321743
|
+
"public"
|
|
321744
|
+
]
|
|
321745
|
+
}
|
|
321746
|
+
},
|
|
321747
|
+
"meta": {
|
|
321748
|
+
"type": "object",
|
|
321749
|
+
"properties": {
|
|
321750
|
+
"nextToken": {
|
|
321751
|
+
"type": "string",
|
|
321752
|
+
"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."
|
|
321753
|
+
}
|
|
321754
|
+
},
|
|
321755
|
+
"additionalProperties": false
|
|
321756
|
+
}
|
|
321757
|
+
},
|
|
321758
|
+
"required": [
|
|
321759
|
+
"plugins",
|
|
321760
|
+
"meta"
|
|
321761
|
+
],
|
|
321762
|
+
"title": "listPublicPluginsResponse",
|
|
321763
|
+
"additionalProperties": false
|
|
321764
|
+
}
|
|
321765
|
+
}
|
|
321766
|
+
},
|
|
321767
|
+
"getPublicPluginById": {
|
|
321768
|
+
"name": "getPublicPluginById",
|
|
321769
|
+
"description": "Get public plugin by Id",
|
|
321770
|
+
"method": "get",
|
|
321771
|
+
"section": "hub",
|
|
321772
|
+
"path": "/v1/admin/hub/plugins/{id}",
|
|
321773
|
+
"disableDefaultParameters": {
|
|
321774
|
+
"x-workspace-id": true
|
|
321775
|
+
},
|
|
321776
|
+
"parameters": {
|
|
321777
|
+
"id": {
|
|
321778
|
+
"type": "string",
|
|
321779
|
+
"description": "Plugin ID",
|
|
321780
|
+
"in": "path"
|
|
321781
|
+
}
|
|
321782
|
+
},
|
|
321783
|
+
"response": {
|
|
321784
|
+
"description": "Success",
|
|
321785
|
+
"schema": {
|
|
321786
|
+
"type": "object",
|
|
321787
|
+
"properties": {
|
|
321788
|
+
"plugin": {
|
|
321789
|
+
"type": "object",
|
|
321790
|
+
"properties": {
|
|
321791
|
+
"id": {
|
|
321792
|
+
"type": "string",
|
|
321793
|
+
"minLength": 28,
|
|
321794
|
+
"maxLength": 36,
|
|
321795
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
321796
|
+
},
|
|
321797
|
+
"name": {
|
|
321798
|
+
"type": "string",
|
|
321799
|
+
"maxLength": 200,
|
|
321800
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
321801
|
+
},
|
|
321802
|
+
"version": {
|
|
321803
|
+
"type": "string",
|
|
321804
|
+
"maxLength": 200,
|
|
321805
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
321806
|
+
},
|
|
321807
|
+
"createdAt": {
|
|
321808
|
+
"type": "string",
|
|
321809
|
+
"format": "date-time",
|
|
321810
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321811
|
+
},
|
|
321812
|
+
"updatedAt": {
|
|
321813
|
+
"type": "string",
|
|
321814
|
+
"format": "date-time",
|
|
321815
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321816
|
+
},
|
|
321817
|
+
"configuration": {
|
|
321818
|
+
"type": "object",
|
|
321819
|
+
"properties": {
|
|
321820
|
+
"title": {
|
|
321821
|
+
"type": "string",
|
|
321822
|
+
"maxLength": 64,
|
|
321823
|
+
"description": "Title of the configuration"
|
|
321824
|
+
},
|
|
321825
|
+
"description": {
|
|
321826
|
+
"type": "string",
|
|
321827
|
+
"maxLength": 256,
|
|
321828
|
+
"description": "Description of the configuration"
|
|
321829
|
+
},
|
|
321830
|
+
"schema": {
|
|
321831
|
+
"type": "object",
|
|
321832
|
+
"additionalProperties": true,
|
|
321833
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
321834
|
+
}
|
|
321835
|
+
},
|
|
321836
|
+
"required": [
|
|
321837
|
+
"schema"
|
|
321838
|
+
],
|
|
321839
|
+
"description": "Configuration definition",
|
|
321840
|
+
"additionalProperties": false
|
|
321841
|
+
},
|
|
321842
|
+
"states": {
|
|
321843
|
+
"type": "object",
|
|
321844
|
+
"additionalProperties": {
|
|
321845
|
+
"type": "object",
|
|
321846
|
+
"properties": {
|
|
321847
|
+
"type": {
|
|
321848
|
+
"type": "string",
|
|
321849
|
+
"enum": [
|
|
321850
|
+
"conversation",
|
|
321851
|
+
"user",
|
|
321852
|
+
"bot",
|
|
321853
|
+
"task"
|
|
321854
|
+
],
|
|
321855
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
321856
|
+
},
|
|
321857
|
+
"schema": {
|
|
321858
|
+
"type": "object",
|
|
321859
|
+
"additionalProperties": true,
|
|
321860
|
+
"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."
|
|
321861
|
+
},
|
|
321862
|
+
"expiry": {
|
|
321863
|
+
"type": "number",
|
|
321864
|
+
"minimum": 1,
|
|
321865
|
+
"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."
|
|
321866
|
+
}
|
|
321867
|
+
},
|
|
321868
|
+
"required": [
|
|
321869
|
+
"type",
|
|
321870
|
+
"schema"
|
|
321871
|
+
],
|
|
321872
|
+
"additionalProperties": false
|
|
321873
|
+
}
|
|
321874
|
+
},
|
|
321875
|
+
"events": {
|
|
321876
|
+
"type": "object",
|
|
321877
|
+
"additionalProperties": {
|
|
321878
|
+
"type": "object",
|
|
321879
|
+
"properties": {
|
|
321880
|
+
"title": {
|
|
321881
|
+
"type": "string",
|
|
321882
|
+
"maxLength": 64,
|
|
321883
|
+
"description": "Title of the event"
|
|
321884
|
+
},
|
|
321885
|
+
"description": {
|
|
321886
|
+
"type": "string",
|
|
321887
|
+
"maxLength": 256,
|
|
321888
|
+
"description": "Description of the event"
|
|
321889
|
+
},
|
|
321890
|
+
"schema": {
|
|
321891
|
+
"type": "object",
|
|
321892
|
+
"additionalProperties": true
|
|
321893
|
+
},
|
|
321894
|
+
"attributes": {
|
|
321895
|
+
"type": "object",
|
|
321896
|
+
"additionalProperties": {
|
|
321897
|
+
"type": "string",
|
|
321898
|
+
"maxLength": 200
|
|
321899
|
+
},
|
|
321900
|
+
"description": "Optional attributes"
|
|
321901
|
+
}
|
|
321902
|
+
},
|
|
321903
|
+
"required": [
|
|
321904
|
+
"schema"
|
|
321905
|
+
],
|
|
321906
|
+
"description": "Event Definition",
|
|
321907
|
+
"additionalProperties": false
|
|
321908
|
+
}
|
|
321909
|
+
},
|
|
321910
|
+
"actions": {
|
|
321911
|
+
"type": "object",
|
|
321912
|
+
"additionalProperties": {
|
|
321913
|
+
"type": "object",
|
|
321914
|
+
"properties": {
|
|
321915
|
+
"title": {
|
|
321916
|
+
"type": "string",
|
|
321917
|
+
"maxLength": 64,
|
|
321918
|
+
"description": "Title of the action"
|
|
321919
|
+
},
|
|
321920
|
+
"description": {
|
|
321921
|
+
"type": "string",
|
|
321922
|
+
"maxLength": 256,
|
|
321923
|
+
"description": "Description of the action"
|
|
321924
|
+
},
|
|
321925
|
+
"billable": {
|
|
321926
|
+
"type": "boolean"
|
|
321927
|
+
},
|
|
321928
|
+
"cacheable": {
|
|
321929
|
+
"type": "boolean"
|
|
321930
|
+
},
|
|
321931
|
+
"input": {
|
|
321932
|
+
"type": "object",
|
|
321933
|
+
"properties": {
|
|
321934
|
+
"schema": {
|
|
321935
|
+
"type": "object",
|
|
321936
|
+
"additionalProperties": true
|
|
321937
|
+
}
|
|
321938
|
+
},
|
|
321939
|
+
"required": [
|
|
321940
|
+
"schema"
|
|
321941
|
+
],
|
|
321942
|
+
"additionalProperties": false
|
|
321943
|
+
},
|
|
321944
|
+
"output": {
|
|
321945
|
+
"type": "object",
|
|
321946
|
+
"properties": {
|
|
321947
|
+
"schema": {
|
|
321948
|
+
"type": "object",
|
|
321949
|
+
"additionalProperties": true
|
|
321950
|
+
}
|
|
321951
|
+
},
|
|
321952
|
+
"required": [
|
|
321953
|
+
"schema"
|
|
321954
|
+
],
|
|
321955
|
+
"additionalProperties": false
|
|
321956
|
+
},
|
|
321957
|
+
"attributes": {
|
|
321958
|
+
"type": "object",
|
|
321959
|
+
"additionalProperties": {
|
|
321960
|
+
"type": "string",
|
|
321961
|
+
"maxLength": 200
|
|
321962
|
+
},
|
|
321963
|
+
"description": "Optional attributes"
|
|
321964
|
+
}
|
|
321965
|
+
},
|
|
321966
|
+
"required": [
|
|
321967
|
+
"input",
|
|
321968
|
+
"output"
|
|
321969
|
+
],
|
|
321970
|
+
"description": "Action definition",
|
|
321971
|
+
"additionalProperties": false
|
|
321972
|
+
}
|
|
321973
|
+
},
|
|
321974
|
+
"dependencies": {
|
|
321975
|
+
"type": "object",
|
|
321976
|
+
"properties": {
|
|
321977
|
+
"interfaces": {
|
|
321978
|
+
"type": "object",
|
|
321979
|
+
"additionalProperties": {
|
|
321980
|
+
"type": "object",
|
|
321981
|
+
"properties": {
|
|
321982
|
+
"id": {
|
|
321983
|
+
"type": "string",
|
|
321984
|
+
"minLength": 28,
|
|
321985
|
+
"maxLength": 36
|
|
321986
|
+
},
|
|
321987
|
+
"name": {
|
|
321988
|
+
"type": "string",
|
|
321989
|
+
"maxLength": 200
|
|
321990
|
+
},
|
|
321991
|
+
"version": {
|
|
321992
|
+
"type": "string",
|
|
321993
|
+
"maxLength": 200
|
|
321994
|
+
}
|
|
321995
|
+
},
|
|
321996
|
+
"required": [
|
|
321997
|
+
"id",
|
|
321998
|
+
"name",
|
|
321999
|
+
"version"
|
|
322000
|
+
],
|
|
322001
|
+
"additionalProperties": false
|
|
322002
|
+
}
|
|
322003
|
+
},
|
|
322004
|
+
"integrations": {
|
|
322005
|
+
"type": "object",
|
|
322006
|
+
"additionalProperties": {
|
|
322007
|
+
"type": "object",
|
|
322008
|
+
"properties": {
|
|
322009
|
+
"id": {
|
|
322010
|
+
"type": "string",
|
|
322011
|
+
"minLength": 28,
|
|
322012
|
+
"maxLength": 36
|
|
322013
|
+
},
|
|
322014
|
+
"name": {
|
|
322015
|
+
"type": "string",
|
|
322016
|
+
"maxLength": 200
|
|
322017
|
+
},
|
|
322018
|
+
"version": {
|
|
322019
|
+
"type": "string",
|
|
322020
|
+
"maxLength": 200
|
|
322021
|
+
}
|
|
322022
|
+
},
|
|
322023
|
+
"required": [
|
|
322024
|
+
"id",
|
|
322025
|
+
"name",
|
|
322026
|
+
"version"
|
|
322027
|
+
],
|
|
322028
|
+
"additionalProperties": false
|
|
322029
|
+
}
|
|
322030
|
+
}
|
|
322031
|
+
},
|
|
322032
|
+
"required": [
|
|
322033
|
+
"interfaces",
|
|
322034
|
+
"integrations"
|
|
322035
|
+
],
|
|
322036
|
+
"additionalProperties": false
|
|
322037
|
+
},
|
|
322038
|
+
"user": {
|
|
322039
|
+
"type": "object",
|
|
322040
|
+
"properties": {
|
|
322041
|
+
"tags": {
|
|
322042
|
+
"type": "object",
|
|
322043
|
+
"additionalProperties": {
|
|
322044
|
+
"type": "object",
|
|
322045
|
+
"properties": {
|
|
322046
|
+
"title": {
|
|
322047
|
+
"type": "string",
|
|
322048
|
+
"maxLength": 64,
|
|
322049
|
+
"description": "Title of the tag"
|
|
322050
|
+
},
|
|
322051
|
+
"description": {
|
|
322052
|
+
"type": "string",
|
|
322053
|
+
"maxLength": 256,
|
|
322054
|
+
"description": "Description of the tag"
|
|
322055
|
+
}
|
|
322056
|
+
},
|
|
322057
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
322058
|
+
"additionalProperties": false
|
|
322059
|
+
}
|
|
322060
|
+
}
|
|
322061
|
+
},
|
|
322062
|
+
"required": [
|
|
322063
|
+
"tags"
|
|
322064
|
+
],
|
|
322065
|
+
"description": "User object configuration",
|
|
322066
|
+
"additionalProperties": false
|
|
322067
|
+
},
|
|
322068
|
+
"conversation": {
|
|
322069
|
+
"type": "object",
|
|
322070
|
+
"properties": {
|
|
322071
|
+
"tags": {
|
|
322072
|
+
"type": "object",
|
|
322073
|
+
"additionalProperties": {
|
|
322074
|
+
"type": "object",
|
|
322075
|
+
"properties": {
|
|
322076
|
+
"title": {
|
|
322077
|
+
"type": "string",
|
|
322078
|
+
"maxLength": 64,
|
|
322079
|
+
"description": "Title of the tag"
|
|
322080
|
+
},
|
|
322081
|
+
"description": {
|
|
322082
|
+
"type": "string",
|
|
322083
|
+
"maxLength": 256,
|
|
322084
|
+
"description": "Description of the tag"
|
|
322085
|
+
}
|
|
322086
|
+
},
|
|
322087
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
322088
|
+
"additionalProperties": false
|
|
322089
|
+
}
|
|
321011
322090
|
}
|
|
321012
322091
|
},
|
|
321013
322092
|
"required": [
|
|
321014
|
-
"tags"
|
|
321015
|
-
"creation"
|
|
322093
|
+
"tags"
|
|
321016
322094
|
],
|
|
321017
|
-
"description": "
|
|
322095
|
+
"description": "Conversation object configuration",
|
|
321018
322096
|
"additionalProperties": false
|
|
321019
322097
|
},
|
|
321020
|
-
"entities": {
|
|
321021
|
-
"type": "object",
|
|
321022
|
-
"additionalProperties": {
|
|
321023
|
-
"type": "object",
|
|
321024
|
-
"properties": {
|
|
321025
|
-
"title": {
|
|
321026
|
-
"type": "string",
|
|
321027
|
-
"maxLength": 64,
|
|
321028
|
-
"description": "Title of the entity"
|
|
321029
|
-
},
|
|
321030
|
-
"description": {
|
|
321031
|
-
"type": "string",
|
|
321032
|
-
"maxLength": 256,
|
|
321033
|
-
"description": "Description of the entity"
|
|
321034
|
-
},
|
|
321035
|
-
"schema": {
|
|
321036
|
-
"type": "object",
|
|
321037
|
-
"additionalProperties": true
|
|
321038
|
-
}
|
|
321039
|
-
},
|
|
321040
|
-
"required": [
|
|
321041
|
-
"schema"
|
|
321042
|
-
],
|
|
321043
|
-
"description": "Entity definition",
|
|
321044
|
-
"additionalProperties": false
|
|
321045
|
-
}
|
|
321046
|
-
},
|
|
321047
322098
|
"attributes": {
|
|
321048
322099
|
"type": "object",
|
|
321049
322100
|
"additionalProperties": {
|
|
@@ -321052,261 +322103,88 @@ var state5 = {
|
|
|
321052
322103
|
},
|
|
321053
322104
|
"description": "Optional attributes"
|
|
321054
322105
|
},
|
|
321055
|
-
"dev": {
|
|
321056
|
-
"type": "boolean",
|
|
321057
|
-
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
321058
|
-
},
|
|
321059
322106
|
"title": {
|
|
321060
322107
|
"type": "string",
|
|
321061
322108
|
"minLength": 1,
|
|
321062
322109
|
"maxLength": 64,
|
|
321063
|
-
"description": "Title of the
|
|
322110
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
321064
322111
|
},
|
|
321065
322112
|
"description": {
|
|
321066
322113
|
"type": "string",
|
|
321067
322114
|
"maxLength": 256,
|
|
321068
|
-
"description": "Description of the
|
|
322115
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
321069
322116
|
},
|
|
321070
322117
|
"iconUrl": {
|
|
321071
322118
|
"type": "string",
|
|
321072
|
-
"description": "URL of the icon of the
|
|
322119
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
321073
322120
|
},
|
|
321074
322121
|
"readmeUrl": {
|
|
321075
322122
|
"type": "string",
|
|
321076
|
-
"description": "URL of the readme of the
|
|
322123
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
321077
322124
|
},
|
|
321078
322125
|
"public": {
|
|
321079
322126
|
"type": "boolean",
|
|
321080
|
-
"description": "Indicates if the
|
|
321081
|
-
},
|
|
321082
|
-
"verificationStatus": {
|
|
321083
|
-
"type": "string",
|
|
321084
|
-
"enum": [
|
|
321085
|
-
"unapproved",
|
|
321086
|
-
"pending",
|
|
321087
|
-
"approved",
|
|
321088
|
-
"rejected"
|
|
321089
|
-
],
|
|
321090
|
-
"description": "Status of the integration version verification"
|
|
321091
|
-
},
|
|
321092
|
-
"secrets": {
|
|
321093
|
-
"type": "array",
|
|
321094
|
-
"items": {
|
|
321095
|
-
"type": "string"
|
|
321096
|
-
},
|
|
321097
|
-
"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."
|
|
321098
|
-
},
|
|
321099
|
-
"ownerWorkspace": {
|
|
321100
|
-
"type": "object",
|
|
321101
|
-
"properties": {
|
|
321102
|
-
"id": {
|
|
321103
|
-
"type": "string"
|
|
321104
|
-
},
|
|
321105
|
-
"handle": {
|
|
321106
|
-
"type": "string",
|
|
321107
|
-
"nullable": true
|
|
321108
|
-
},
|
|
321109
|
-
"name": {
|
|
321110
|
-
"type": "string"
|
|
321111
|
-
}
|
|
321112
|
-
},
|
|
321113
|
-
"required": [
|
|
321114
|
-
"id",
|
|
321115
|
-
"handle",
|
|
321116
|
-
"name"
|
|
321117
|
-
],
|
|
321118
|
-
"additionalProperties": false
|
|
321119
|
-
},
|
|
321120
|
-
"meta": {
|
|
321121
|
-
"type": "object",
|
|
321122
|
-
"properties": {
|
|
321123
|
-
"installs": {
|
|
321124
|
-
"type": "number"
|
|
321125
|
-
},
|
|
321126
|
-
"views": {
|
|
321127
|
-
"type": "number"
|
|
321128
|
-
}
|
|
321129
|
-
},
|
|
321130
|
-
"required": [
|
|
321131
|
-
"installs",
|
|
321132
|
-
"views"
|
|
321133
|
-
],
|
|
321134
|
-
"additionalProperties": false
|
|
322127
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
321135
322128
|
}
|
|
321136
322129
|
},
|
|
321137
322130
|
"required": [
|
|
321138
322131
|
"id",
|
|
321139
|
-
"createdAt",
|
|
321140
|
-
"updatedAt",
|
|
321141
|
-
"identifier",
|
|
321142
|
-
"url",
|
|
321143
322132
|
"name",
|
|
321144
322133
|
"version",
|
|
321145
|
-
"
|
|
322134
|
+
"createdAt",
|
|
322135
|
+
"updatedAt",
|
|
321146
322136
|
"configuration",
|
|
321147
|
-
"configurations",
|
|
321148
|
-
"channels",
|
|
321149
322137
|
"states",
|
|
321150
322138
|
"events",
|
|
321151
322139
|
"actions",
|
|
322140
|
+
"dependencies",
|
|
321152
322141
|
"user",
|
|
321153
|
-
"
|
|
321154
|
-
"dev",
|
|
322142
|
+
"conversation",
|
|
321155
322143
|
"title",
|
|
321156
322144
|
"description",
|
|
321157
322145
|
"iconUrl",
|
|
321158
322146
|
"readmeUrl",
|
|
321159
|
-
"public"
|
|
321160
|
-
"verificationStatus",
|
|
321161
|
-
"secrets",
|
|
321162
|
-
"ownerWorkspace",
|
|
321163
|
-
"meta"
|
|
322147
|
+
"public"
|
|
321164
322148
|
],
|
|
321165
322149
|
"additionalProperties": false
|
|
321166
322150
|
}
|
|
321167
322151
|
},
|
|
321168
322152
|
"required": [
|
|
321169
|
-
"
|
|
322153
|
+
"plugin"
|
|
321170
322154
|
],
|
|
321171
|
-
"title": "
|
|
322155
|
+
"title": "getPublicPluginByIdResponse",
|
|
321172
322156
|
"additionalProperties": false
|
|
321173
322157
|
}
|
|
321174
322158
|
}
|
|
321175
322159
|
},
|
|
321176
|
-
"
|
|
321177
|
-
"name": "
|
|
321178
|
-
"description": "
|
|
322160
|
+
"getDereferencedPublicPluginById": {
|
|
322161
|
+
"name": "getDereferencedPublicPluginById",
|
|
322162
|
+
"description": "Get public plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
321179
322163
|
"method": "get",
|
|
321180
322164
|
"section": "hub",
|
|
321181
|
-
"path": "/v1/admin/hub/plugins",
|
|
322165
|
+
"path": "/v1/admin/hub/plugins/{id}/dereferenced",
|
|
321182
322166
|
"disableDefaultParameters": {
|
|
321183
322167
|
"x-workspace-id": true
|
|
321184
322168
|
},
|
|
321185
322169
|
"parameters": {
|
|
321186
|
-
"
|
|
321187
|
-
"in": "query",
|
|
321188
|
-
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
321189
|
-
"type": "string"
|
|
321190
|
-
},
|
|
321191
|
-
"name": {
|
|
321192
|
-
"in": "query",
|
|
322170
|
+
"id": {
|
|
321193
322171
|
"type": "string",
|
|
321194
|
-
"description": "
|
|
322172
|
+
"description": "Plugin ID",
|
|
322173
|
+
"in": "path"
|
|
321195
322174
|
},
|
|
321196
|
-
"
|
|
322175
|
+
"interfaces": {
|
|
321197
322176
|
"in": "query",
|
|
321198
|
-
"type": "string",
|
|
321199
|
-
"description": "Filter a plugin by name and version"
|
|
321200
|
-
}
|
|
321201
|
-
},
|
|
321202
|
-
"response": {
|
|
321203
|
-
"description": "Success",
|
|
321204
|
-
"schema": {
|
|
321205
322177
|
"type": "object",
|
|
321206
|
-
"
|
|
321207
|
-
"
|
|
321208
|
-
|
|
321209
|
-
"
|
|
321210
|
-
|
|
321211
|
-
"properties": {
|
|
321212
|
-
"id": {
|
|
321213
|
-
"type": "string",
|
|
321214
|
-
"minLength": 28,
|
|
321215
|
-
"maxLength": 36,
|
|
321216
|
-
"description": "ID of the [Plugin](#schema_plugin)"
|
|
321217
|
-
},
|
|
321218
|
-
"createdAt": {
|
|
321219
|
-
"type": "string",
|
|
321220
|
-
"format": "date-time",
|
|
321221
|
-
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321222
|
-
},
|
|
321223
|
-
"updatedAt": {
|
|
321224
|
-
"type": "string",
|
|
321225
|
-
"format": "date-time",
|
|
321226
|
-
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
321227
|
-
},
|
|
321228
|
-
"name": {
|
|
321229
|
-
"type": "string",
|
|
321230
|
-
"maxLength": 200,
|
|
321231
|
-
"description": "Name of the [Plugin](#schema_plugin)"
|
|
321232
|
-
},
|
|
321233
|
-
"version": {
|
|
321234
|
-
"type": "string",
|
|
321235
|
-
"maxLength": 200,
|
|
321236
|
-
"description": "Version of the [Plugin](#schema_plugin)"
|
|
321237
|
-
},
|
|
321238
|
-
"title": {
|
|
321239
|
-
"type": "string",
|
|
321240
|
-
"minLength": 1,
|
|
321241
|
-
"maxLength": 64,
|
|
321242
|
-
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
321243
|
-
},
|
|
321244
|
-
"description": {
|
|
321245
|
-
"type": "string",
|
|
321246
|
-
"maxLength": 256,
|
|
321247
|
-
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
321248
|
-
},
|
|
321249
|
-
"iconUrl": {
|
|
321250
|
-
"type": "string",
|
|
321251
|
-
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
321252
|
-
},
|
|
321253
|
-
"readmeUrl": {
|
|
321254
|
-
"type": "string",
|
|
321255
|
-
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
321256
|
-
},
|
|
321257
|
-
"public": {
|
|
321258
|
-
"type": "boolean",
|
|
321259
|
-
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
321260
|
-
}
|
|
321261
|
-
},
|
|
321262
|
-
"required": [
|
|
321263
|
-
"id",
|
|
321264
|
-
"createdAt",
|
|
321265
|
-
"updatedAt",
|
|
321266
|
-
"name",
|
|
321267
|
-
"version",
|
|
321268
|
-
"title",
|
|
321269
|
-
"description",
|
|
321270
|
-
"iconUrl",
|
|
321271
|
-
"readmeUrl",
|
|
321272
|
-
"public"
|
|
321273
|
-
]
|
|
321274
|
-
}
|
|
322178
|
+
"schema": {
|
|
322179
|
+
"type": "object",
|
|
322180
|
+
"additionalProperties": {
|
|
322181
|
+
"type": "string",
|
|
322182
|
+
"description": "integration id"
|
|
321275
322183
|
},
|
|
321276
|
-
"
|
|
321277
|
-
"type": "object",
|
|
321278
|
-
"properties": {
|
|
321279
|
-
"nextToken": {
|
|
321280
|
-
"type": "string",
|
|
321281
|
-
"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."
|
|
321282
|
-
}
|
|
321283
|
-
},
|
|
321284
|
-
"additionalProperties": false
|
|
321285
|
-
}
|
|
322184
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
321286
322185
|
},
|
|
321287
|
-
"
|
|
321288
|
-
|
|
321289
|
-
"meta"
|
|
321290
|
-
],
|
|
321291
|
-
"title": "listPublicPluginsResponse",
|
|
321292
|
-
"additionalProperties": false
|
|
321293
|
-
}
|
|
321294
|
-
}
|
|
321295
|
-
},
|
|
321296
|
-
"getPublicPluginById": {
|
|
321297
|
-
"name": "getPublicPluginById",
|
|
321298
|
-
"description": "Get public plugin by Id",
|
|
321299
|
-
"method": "get",
|
|
321300
|
-
"section": "hub",
|
|
321301
|
-
"path": "/v1/admin/hub/plugins/{id}",
|
|
321302
|
-
"disableDefaultParameters": {
|
|
321303
|
-
"x-workspace-id": true
|
|
321304
|
-
},
|
|
321305
|
-
"parameters": {
|
|
321306
|
-
"id": {
|
|
321307
|
-
"type": "string",
|
|
321308
|
-
"description": "Plugin ID",
|
|
321309
|
-
"in": "path"
|
|
322186
|
+
"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.",
|
|
322187
|
+
"required": true
|
|
321310
322188
|
}
|
|
321311
322189
|
},
|
|
321312
322190
|
"response": {
|
|
@@ -321681,7 +322559,7 @@ var state5 = {
|
|
|
321681
322559
|
"required": [
|
|
321682
322560
|
"plugin"
|
|
321683
322561
|
],
|
|
321684
|
-
"title": "
|
|
322562
|
+
"title": "getDereferencedPublicPluginByIdResponse",
|
|
321685
322563
|
"additionalProperties": false
|
|
321686
322564
|
}
|
|
321687
322565
|
}
|
|
@@ -327697,6 +328575,10 @@ var state5 = {
|
|
|
327697
328575
|
"additionalProperties": false
|
|
327698
328576
|
}
|
|
327699
328577
|
},
|
|
328578
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
328579
|
+
"type": "boolean",
|
|
328580
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
328581
|
+
},
|
|
327700
328582
|
"secrets": {
|
|
327701
328583
|
"type": "object",
|
|
327702
328584
|
"additionalProperties": {
|
|
@@ -328287,6 +329169,10 @@ var state5 = {
|
|
|
328287
329169
|
"additionalProperties": false
|
|
328288
329170
|
}
|
|
328289
329171
|
},
|
|
329172
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
329173
|
+
"type": "boolean",
|
|
329174
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
329175
|
+
},
|
|
328290
329176
|
"secrets": {
|
|
328291
329177
|
"type": "object",
|
|
328292
329178
|
"additionalProperties": {
|
|
@@ -328450,6 +329336,10 @@ var state5 = {
|
|
|
328450
329336
|
},
|
|
328451
329337
|
"description": "Additional configuration definitions of the integration"
|
|
328452
329338
|
},
|
|
329339
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
329340
|
+
"type": "boolean",
|
|
329341
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
329342
|
+
},
|
|
328453
329343
|
"channels": {
|
|
328454
329344
|
"type": "object",
|
|
328455
329345
|
"additionalProperties": {
|
|
@@ -329042,6 +329932,10 @@ var state5 = {
|
|
|
329042
329932
|
},
|
|
329043
329933
|
"description": "Additional configuration definitions of the integration"
|
|
329044
329934
|
},
|
|
329935
|
+
"messageStatusChangeNotificationsEnabled": {
|
|
329936
|
+
"type": "boolean",
|
|
329937
|
+
"description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
|
|
329938
|
+
},
|
|
329045
329939
|
"channels": {
|
|
329046
329940
|
"type": "object",
|
|
329047
329941
|
"additionalProperties": {
|
|
@@ -331110,6 +332004,50 @@ var state5 = {
|
|
|
331110
332004
|
}
|
|
331111
332005
|
}
|
|
331112
332006
|
},
|
|
332007
|
+
"getDereferencedPlugin": {
|
|
332008
|
+
"name": "getDereferencedPlugin",
|
|
332009
|
+
"description": "Get plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
332010
|
+
"method": "get",
|
|
332011
|
+
"section": "plugin",
|
|
332012
|
+
"path": "/v1/admin/plugins/{id}/dereferenced",
|
|
332013
|
+
"parameters": {
|
|
332014
|
+
"id": {
|
|
332015
|
+
"type": "string",
|
|
332016
|
+
"description": "Plugin ID",
|
|
332017
|
+
"in": "path"
|
|
332018
|
+
},
|
|
332019
|
+
"interfaces": {
|
|
332020
|
+
"in": "query",
|
|
332021
|
+
"type": "object",
|
|
332022
|
+
"schema": {
|
|
332023
|
+
"type": "object",
|
|
332024
|
+
"additionalProperties": {
|
|
332025
|
+
"type": "string",
|
|
332026
|
+
"description": "integration id"
|
|
332027
|
+
},
|
|
332028
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
332029
|
+
},
|
|
332030
|
+
"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.",
|
|
332031
|
+
"required": true
|
|
332032
|
+
}
|
|
332033
|
+
},
|
|
332034
|
+
"response": {
|
|
332035
|
+
"description": "Get a dereferenced plugin",
|
|
332036
|
+
"schema": {
|
|
332037
|
+
"type": "object",
|
|
332038
|
+
"properties": {
|
|
332039
|
+
"plugin": {
|
|
332040
|
+
"$ref": "#/components/schemas/Plugin"
|
|
332041
|
+
}
|
|
332042
|
+
},
|
|
332043
|
+
"required": [
|
|
332044
|
+
"plugin"
|
|
332045
|
+
],
|
|
332046
|
+
"title": "getDereferencedPluginResponse",
|
|
332047
|
+
"additionalProperties": false
|
|
332048
|
+
}
|
|
332049
|
+
}
|
|
332050
|
+
},
|
|
331113
332051
|
"getPluginByName": {
|
|
331114
332052
|
"name": "getPluginByName",
|
|
331115
332053
|
"description": "Get Plugin by name and version",
|
|
@@ -335170,7 +336108,7 @@ var state5 = {
|
|
|
335170
336108
|
"title": "Botpress API",
|
|
335171
336109
|
"description": "API for Botpress Cloud",
|
|
335172
336110
|
"server": "https://api.botpress.cloud",
|
|
335173
|
-
"version": "1.
|
|
336111
|
+
"version": "1.26.0",
|
|
335174
336112
|
"prefix": "v1"
|
|
335175
336113
|
},
|
|
335176
336114
|
"errors": [
|
|
@@ -335430,6 +336368,7 @@ var state5 = {
|
|
|
335430
336368
|
"getPublicIntegrationResponse": true,
|
|
335431
336369
|
"listPublicPluginsResponse": true,
|
|
335432
336370
|
"getPublicPluginByIdResponse": true,
|
|
336371
|
+
"getDereferencedPublicPluginByIdResponse": true,
|
|
335433
336372
|
"getPublicPluginResponse": true,
|
|
335434
336373
|
"getPublicPluginCodeResponse": true,
|
|
335435
336374
|
"listPublicInterfacesResponse": true,
|
|
@@ -335505,6 +336444,7 @@ var state5 = {
|
|
|
335505
336444
|
"listInterfacesResponse": true,
|
|
335506
336445
|
"createPluginResponse": true,
|
|
335507
336446
|
"getPluginResponse": true,
|
|
336447
|
+
"getDereferencedPluginResponse": true,
|
|
335508
336448
|
"getPluginByNameResponse": true,
|
|
335509
336449
|
"updatePluginResponse": true,
|
|
335510
336450
|
"deletePluginResponse": true,
|
|
@@ -339129,6 +340069,7 @@ var state5 = {
|
|
|
339129
340069
|
"getPublicIntegration",
|
|
339130
340070
|
"listPublicPlugins",
|
|
339131
340071
|
"getPublicPluginById",
|
|
340072
|
+
"getDereferencedPublicPluginById",
|
|
339132
340073
|
"getPublicPlugin",
|
|
339133
340074
|
"getPublicPluginCode",
|
|
339134
340075
|
"listPublicInterfaces",
|
|
@@ -339256,6 +340197,7 @@ var state5 = {
|
|
|
339256
340197
|
"operations": [
|
|
339257
340198
|
"createPlugin",
|
|
339258
340199
|
"getPlugin",
|
|
340200
|
+
"getDereferencedPlugin",
|
|
339259
340201
|
"getPluginByName",
|
|
339260
340202
|
"updatePlugin",
|
|
339261
340203
|
"deletePlugin",
|