@botpress/api 0.69.0 → 0.70.1
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 +1195 -54
- package/dist/src/gen/state.d.ts +1111 -50
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +1195 -54
package/src/gen/state.ts
CHANGED
|
@@ -5294,6 +5294,17 @@ export const state = {
|
|
|
5294
5294
|
"type": "boolean",
|
|
5295
5295
|
"required": false
|
|
5296
5296
|
},
|
|
5297
|
+
"tags": {
|
|
5298
|
+
"in": "query",
|
|
5299
|
+
"type": "object",
|
|
5300
|
+
"schema": {
|
|
5301
|
+
"type": "object",
|
|
5302
|
+
"additionalProperties": {
|
|
5303
|
+
"type": "string"
|
|
5304
|
+
}
|
|
5305
|
+
},
|
|
5306
|
+
"description": "Filter by tags"
|
|
5307
|
+
},
|
|
5297
5308
|
"nextToken": {
|
|
5298
5309
|
"in": "query",
|
|
5299
5310
|
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
@@ -5351,13 +5362,21 @@ export const state = {
|
|
|
5351
5362
|
"deployedAt": {
|
|
5352
5363
|
"type": "string",
|
|
5353
5364
|
"format": "date-time"
|
|
5365
|
+
},
|
|
5366
|
+
"tags": {
|
|
5367
|
+
"type": "object",
|
|
5368
|
+
"additionalProperties": {
|
|
5369
|
+
"type": "string"
|
|
5370
|
+
},
|
|
5371
|
+
"description": "Tags of [Bot](#schema_bot)"
|
|
5354
5372
|
}
|
|
5355
5373
|
},
|
|
5356
5374
|
"required": [
|
|
5357
5375
|
"id",
|
|
5358
5376
|
"createdAt",
|
|
5359
5377
|
"updatedAt",
|
|
5360
|
-
"name"
|
|
5378
|
+
"name",
|
|
5379
|
+
"tags"
|
|
5361
5380
|
]
|
|
5362
5381
|
}
|
|
5363
5382
|
},
|
|
@@ -8796,24 +8815,27 @@ export const state = {
|
|
|
8796
8815
|
},
|
|
8797
8816
|
"parameters": {}
|
|
8798
8817
|
},
|
|
8799
|
-
"
|
|
8800
|
-
"name": "
|
|
8801
|
-
"description": "
|
|
8802
|
-
"method": "
|
|
8803
|
-
"path": "/v1/admin/integrations/{id}",
|
|
8818
|
+
"validateIntegrationCreation": {
|
|
8819
|
+
"name": "validateIntegrationCreation",
|
|
8820
|
+
"description": "Perform a validation of an integration creation request",
|
|
8821
|
+
"method": "post",
|
|
8804
8822
|
"section": "integration",
|
|
8805
|
-
"
|
|
8806
|
-
"id": {
|
|
8807
|
-
"type": "string",
|
|
8808
|
-
"description": "Integration ID",
|
|
8809
|
-
"in": "path"
|
|
8810
|
-
}
|
|
8811
|
-
},
|
|
8823
|
+
"path": "/v1/admin/integrations/validate",
|
|
8812
8824
|
"requestBody": {
|
|
8813
8825
|
"description": "Integration",
|
|
8814
8826
|
"schema": {
|
|
8815
8827
|
"type": "object",
|
|
8816
8828
|
"properties": {
|
|
8829
|
+
"name": {
|
|
8830
|
+
"type": "string",
|
|
8831
|
+
"maxLength": 200,
|
|
8832
|
+
"description": "Name of the [Integration](#schema_integration)"
|
|
8833
|
+
},
|
|
8834
|
+
"version": {
|
|
8835
|
+
"type": "string",
|
|
8836
|
+
"maxLength": 200,
|
|
8837
|
+
"description": "Version of the [Integration](#schema_integration)"
|
|
8838
|
+
},
|
|
8817
8839
|
"configuration": {
|
|
8818
8840
|
"type": "object",
|
|
8819
8841
|
"properties": {
|
|
@@ -8835,13 +8857,12 @@ export const state = {
|
|
|
8835
8857
|
"identifier": {
|
|
8836
8858
|
"type": "object",
|
|
8837
8859
|
"properties": {
|
|
8838
|
-
"linkTemplateScript": {
|
|
8839
|
-
"type": "string",
|
|
8840
|
-
"maxLength": 2000,
|
|
8841
|
-
"nullable": true
|
|
8842
|
-
},
|
|
8843
8860
|
"required": {
|
|
8844
8861
|
"type": "boolean"
|
|
8862
|
+
},
|
|
8863
|
+
"linkTemplateScript": {
|
|
8864
|
+
"type": "string",
|
|
8865
|
+
"maxLength": 2000
|
|
8845
8866
|
}
|
|
8846
8867
|
},
|
|
8847
8868
|
"additionalProperties": false
|
|
@@ -8873,23 +8894,173 @@ export const state = {
|
|
|
8873
8894
|
"identifier": {
|
|
8874
8895
|
"type": "object",
|
|
8875
8896
|
"properties": {
|
|
8876
|
-
"linkTemplateScript": {
|
|
8877
|
-
"type": "string",
|
|
8878
|
-
"maxLength": 2000,
|
|
8879
|
-
"nullable": true
|
|
8880
|
-
},
|
|
8881
8897
|
"required": {
|
|
8882
8898
|
"type": "boolean"
|
|
8899
|
+
},
|
|
8900
|
+
"linkTemplateScript": {
|
|
8901
|
+
"type": "string",
|
|
8902
|
+
"maxLength": 2000
|
|
8883
8903
|
}
|
|
8884
8904
|
},
|
|
8885
8905
|
"additionalProperties": false
|
|
8886
8906
|
}
|
|
8887
8907
|
},
|
|
8888
|
-
"nullable": true,
|
|
8889
8908
|
"additionalProperties": false
|
|
8890
8909
|
},
|
|
8891
8910
|
"description": "Additional configuration definitions of the integration"
|
|
8892
8911
|
},
|
|
8912
|
+
"states": {
|
|
8913
|
+
"type": "object",
|
|
8914
|
+
"additionalProperties": {
|
|
8915
|
+
"type": "object",
|
|
8916
|
+
"properties": {
|
|
8917
|
+
"type": {
|
|
8918
|
+
"type": "string",
|
|
8919
|
+
"enum": [
|
|
8920
|
+
"conversation",
|
|
8921
|
+
"user",
|
|
8922
|
+
"integration"
|
|
8923
|
+
],
|
|
8924
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
8925
|
+
},
|
|
8926
|
+
"schema": {
|
|
8927
|
+
"type": "object",
|
|
8928
|
+
"additionalProperties": true,
|
|
8929
|
+
"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."
|
|
8930
|
+
}
|
|
8931
|
+
},
|
|
8932
|
+
"required": [
|
|
8933
|
+
"type",
|
|
8934
|
+
"schema"
|
|
8935
|
+
],
|
|
8936
|
+
"description": "State definition",
|
|
8937
|
+
"additionalProperties": false
|
|
8938
|
+
}
|
|
8939
|
+
},
|
|
8940
|
+
"events": {
|
|
8941
|
+
"type": "object",
|
|
8942
|
+
"additionalProperties": {
|
|
8943
|
+
"type": "object",
|
|
8944
|
+
"properties": {
|
|
8945
|
+
"title": {
|
|
8946
|
+
"type": "string",
|
|
8947
|
+
"maxLength": 64,
|
|
8948
|
+
"description": "Title of the event"
|
|
8949
|
+
},
|
|
8950
|
+
"description": {
|
|
8951
|
+
"type": "string",
|
|
8952
|
+
"maxLength": 256,
|
|
8953
|
+
"description": "Description of the event"
|
|
8954
|
+
},
|
|
8955
|
+
"schema": {
|
|
8956
|
+
"type": "object",
|
|
8957
|
+
"additionalProperties": true
|
|
8958
|
+
}
|
|
8959
|
+
},
|
|
8960
|
+
"required": [
|
|
8961
|
+
"schema"
|
|
8962
|
+
],
|
|
8963
|
+
"description": "Event Definition",
|
|
8964
|
+
"additionalProperties": false
|
|
8965
|
+
}
|
|
8966
|
+
},
|
|
8967
|
+
"actions": {
|
|
8968
|
+
"type": "object",
|
|
8969
|
+
"additionalProperties": {
|
|
8970
|
+
"type": "object",
|
|
8971
|
+
"properties": {
|
|
8972
|
+
"title": {
|
|
8973
|
+
"type": "string",
|
|
8974
|
+
"maxLength": 64,
|
|
8975
|
+
"description": "Title of the action"
|
|
8976
|
+
},
|
|
8977
|
+
"description": {
|
|
8978
|
+
"type": "string",
|
|
8979
|
+
"maxLength": 256,
|
|
8980
|
+
"description": "Description of the action"
|
|
8981
|
+
},
|
|
8982
|
+
"billable": {
|
|
8983
|
+
"type": "boolean"
|
|
8984
|
+
},
|
|
8985
|
+
"cacheable": {
|
|
8986
|
+
"type": "boolean"
|
|
8987
|
+
},
|
|
8988
|
+
"input": {
|
|
8989
|
+
"type": "object",
|
|
8990
|
+
"properties": {
|
|
8991
|
+
"schema": {
|
|
8992
|
+
"type": "object",
|
|
8993
|
+
"additionalProperties": true
|
|
8994
|
+
}
|
|
8995
|
+
},
|
|
8996
|
+
"required": [
|
|
8997
|
+
"schema"
|
|
8998
|
+
],
|
|
8999
|
+
"additionalProperties": false
|
|
9000
|
+
},
|
|
9001
|
+
"output": {
|
|
9002
|
+
"type": "object",
|
|
9003
|
+
"properties": {
|
|
9004
|
+
"schema": {
|
|
9005
|
+
"type": "object",
|
|
9006
|
+
"additionalProperties": true
|
|
9007
|
+
}
|
|
9008
|
+
},
|
|
9009
|
+
"required": [
|
|
9010
|
+
"schema"
|
|
9011
|
+
],
|
|
9012
|
+
"additionalProperties": false
|
|
9013
|
+
}
|
|
9014
|
+
},
|
|
9015
|
+
"required": [
|
|
9016
|
+
"input",
|
|
9017
|
+
"output"
|
|
9018
|
+
],
|
|
9019
|
+
"description": "Action definition",
|
|
9020
|
+
"additionalProperties": false
|
|
9021
|
+
}
|
|
9022
|
+
},
|
|
9023
|
+
"entities": {
|
|
9024
|
+
"type": "object",
|
|
9025
|
+
"additionalProperties": {
|
|
9026
|
+
"type": "object",
|
|
9027
|
+
"properties": {
|
|
9028
|
+
"title": {
|
|
9029
|
+
"type": "string",
|
|
9030
|
+
"maxLength": 64,
|
|
9031
|
+
"description": "Title of the entity"
|
|
9032
|
+
},
|
|
9033
|
+
"description": {
|
|
9034
|
+
"type": "string",
|
|
9035
|
+
"maxLength": 256,
|
|
9036
|
+
"description": "Description of the entity"
|
|
9037
|
+
},
|
|
9038
|
+
"schema": {
|
|
9039
|
+
"type": "object",
|
|
9040
|
+
"additionalProperties": true
|
|
9041
|
+
}
|
|
9042
|
+
},
|
|
9043
|
+
"required": [
|
|
9044
|
+
"schema"
|
|
9045
|
+
],
|
|
9046
|
+
"description": "Entity definition",
|
|
9047
|
+
"additionalProperties": false
|
|
9048
|
+
}
|
|
9049
|
+
},
|
|
9050
|
+
"identifier": {
|
|
9051
|
+
"type": "object",
|
|
9052
|
+
"properties": {
|
|
9053
|
+
"fallbackHandlerScript": {
|
|
9054
|
+
"type": "string",
|
|
9055
|
+
"maxLength": 2000
|
|
9056
|
+
},
|
|
9057
|
+
"extractScript": {
|
|
9058
|
+
"type": "string",
|
|
9059
|
+
"maxLength": 2000
|
|
9060
|
+
}
|
|
9061
|
+
},
|
|
9062
|
+
"additionalProperties": false
|
|
9063
|
+
},
|
|
8893
9064
|
"channels": {
|
|
8894
9065
|
"type": "object",
|
|
8895
9066
|
"additionalProperties": {
|
|
@@ -8919,7 +9090,6 @@ export const state = {
|
|
|
8919
9090
|
"schema"
|
|
8920
9091
|
],
|
|
8921
9092
|
"description": "Message definition",
|
|
8922
|
-
"nullable": true,
|
|
8923
9093
|
"additionalProperties": false
|
|
8924
9094
|
}
|
|
8925
9095
|
},
|
|
@@ -8965,7 +9135,6 @@ export const state = {
|
|
|
8965
9135
|
}
|
|
8966
9136
|
},
|
|
8967
9137
|
"description": "Definition of a tag that can be provided on the object",
|
|
8968
|
-
"nullable": true,
|
|
8969
9138
|
"additionalProperties": false
|
|
8970
9139
|
}
|
|
8971
9140
|
}
|
|
@@ -8992,7 +9161,6 @@ export const state = {
|
|
|
8992
9161
|
}
|
|
8993
9162
|
},
|
|
8994
9163
|
"description": "Definition of a tag that can be provided on the object",
|
|
8995
|
-
"nullable": true,
|
|
8996
9164
|
"additionalProperties": false
|
|
8997
9165
|
}
|
|
8998
9166
|
}
|
|
@@ -9000,27 +9168,1002 @@ export const state = {
|
|
|
9000
9168
|
"additionalProperties": false
|
|
9001
9169
|
}
|
|
9002
9170
|
},
|
|
9003
|
-
"
|
|
9171
|
+
"required": [
|
|
9172
|
+
"messages"
|
|
9173
|
+
],
|
|
9004
9174
|
"additionalProperties": false
|
|
9005
9175
|
}
|
|
9006
9176
|
},
|
|
9007
|
-
"
|
|
9177
|
+
"user": {
|
|
9008
9178
|
"type": "object",
|
|
9009
9179
|
"properties": {
|
|
9010
|
-
"
|
|
9011
|
-
"type": "
|
|
9012
|
-
"
|
|
9013
|
-
|
|
9180
|
+
"creation": {
|
|
9181
|
+
"type": "object",
|
|
9182
|
+
"properties": {
|
|
9183
|
+
"enabled": {
|
|
9184
|
+
"type": "boolean",
|
|
9185
|
+
"description": "Enable user creation"
|
|
9186
|
+
},
|
|
9187
|
+
"requiredTags": {
|
|
9188
|
+
"type": "array",
|
|
9189
|
+
"items": {
|
|
9190
|
+
"type": "string"
|
|
9191
|
+
},
|
|
9192
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
9193
|
+
}
|
|
9194
|
+
},
|
|
9195
|
+
"required": [
|
|
9196
|
+
"enabled",
|
|
9197
|
+
"requiredTags"
|
|
9198
|
+
],
|
|
9199
|
+
"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.",
|
|
9200
|
+
"additionalProperties": false
|
|
9014
9201
|
},
|
|
9015
|
-
"
|
|
9016
|
-
"type": "
|
|
9017
|
-
"
|
|
9018
|
-
|
|
9019
|
-
|
|
9020
|
-
|
|
9021
|
-
|
|
9022
|
-
|
|
9023
|
-
|
|
9202
|
+
"tags": {
|
|
9203
|
+
"type": "object",
|
|
9204
|
+
"additionalProperties": {
|
|
9205
|
+
"type": "object",
|
|
9206
|
+
"properties": {
|
|
9207
|
+
"title": {
|
|
9208
|
+
"type": "string",
|
|
9209
|
+
"maxLength": 64,
|
|
9210
|
+
"description": "Title of the tag"
|
|
9211
|
+
},
|
|
9212
|
+
"description": {
|
|
9213
|
+
"type": "string",
|
|
9214
|
+
"maxLength": 256,
|
|
9215
|
+
"description": "Description of the tag"
|
|
9216
|
+
}
|
|
9217
|
+
},
|
|
9218
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9219
|
+
"additionalProperties": false
|
|
9220
|
+
}
|
|
9221
|
+
}
|
|
9222
|
+
},
|
|
9223
|
+
"additionalProperties": false
|
|
9224
|
+
},
|
|
9225
|
+
"interfaces": {
|
|
9226
|
+
"type": "object",
|
|
9227
|
+
"additionalProperties": {
|
|
9228
|
+
"type": "object",
|
|
9229
|
+
"properties": {
|
|
9230
|
+
"id": {
|
|
9231
|
+
"type": "string",
|
|
9232
|
+
"minLength": 28,
|
|
9233
|
+
"maxLength": 36,
|
|
9234
|
+
"description": "ID of the interface"
|
|
9235
|
+
},
|
|
9236
|
+
"entities": {
|
|
9237
|
+
"type": "object",
|
|
9238
|
+
"additionalProperties": {
|
|
9239
|
+
"type": "object",
|
|
9240
|
+
"properties": {
|
|
9241
|
+
"name": {
|
|
9242
|
+
"type": "string",
|
|
9243
|
+
"maxLength": 200
|
|
9244
|
+
}
|
|
9245
|
+
},
|
|
9246
|
+
"required": [
|
|
9247
|
+
"name"
|
|
9248
|
+
],
|
|
9249
|
+
"additionalProperties": false
|
|
9250
|
+
}
|
|
9251
|
+
},
|
|
9252
|
+
"actions": {
|
|
9253
|
+
"type": "object",
|
|
9254
|
+
"additionalProperties": {
|
|
9255
|
+
"type": "object",
|
|
9256
|
+
"properties": {
|
|
9257
|
+
"name": {
|
|
9258
|
+
"type": "string",
|
|
9259
|
+
"maxLength": 200
|
|
9260
|
+
}
|
|
9261
|
+
},
|
|
9262
|
+
"required": [
|
|
9263
|
+
"name"
|
|
9264
|
+
],
|
|
9265
|
+
"additionalProperties": false
|
|
9266
|
+
}
|
|
9267
|
+
},
|
|
9268
|
+
"events": {
|
|
9269
|
+
"type": "object",
|
|
9270
|
+
"additionalProperties": {
|
|
9271
|
+
"type": "object",
|
|
9272
|
+
"properties": {
|
|
9273
|
+
"name": {
|
|
9274
|
+
"type": "string",
|
|
9275
|
+
"maxLength": 200
|
|
9276
|
+
}
|
|
9277
|
+
},
|
|
9278
|
+
"required": [
|
|
9279
|
+
"name"
|
|
9280
|
+
],
|
|
9281
|
+
"additionalProperties": false
|
|
9282
|
+
}
|
|
9283
|
+
},
|
|
9284
|
+
"channels": {
|
|
9285
|
+
"type": "object",
|
|
9286
|
+
"additionalProperties": {
|
|
9287
|
+
"type": "object",
|
|
9288
|
+
"properties": {
|
|
9289
|
+
"name": {
|
|
9290
|
+
"type": "string",
|
|
9291
|
+
"maxLength": 200
|
|
9292
|
+
}
|
|
9293
|
+
},
|
|
9294
|
+
"required": [
|
|
9295
|
+
"name"
|
|
9296
|
+
],
|
|
9297
|
+
"additionalProperties": false
|
|
9298
|
+
}
|
|
9299
|
+
}
|
|
9300
|
+
},
|
|
9301
|
+
"required": [
|
|
9302
|
+
"id"
|
|
9303
|
+
],
|
|
9304
|
+
"additionalProperties": false
|
|
9305
|
+
}
|
|
9306
|
+
},
|
|
9307
|
+
"secrets": {
|
|
9308
|
+
"type": "object",
|
|
9309
|
+
"additionalProperties": {
|
|
9310
|
+
"type": "string",
|
|
9311
|
+
"maxLength": 20000
|
|
9312
|
+
},
|
|
9313
|
+
"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."
|
|
9314
|
+
},
|
|
9315
|
+
"code": {
|
|
9316
|
+
"type": "string",
|
|
9317
|
+
"description": "JavaScript code of the integration"
|
|
9318
|
+
},
|
|
9319
|
+
"url": {
|
|
9320
|
+
"type": "string",
|
|
9321
|
+
"description": "URL of the integration"
|
|
9322
|
+
},
|
|
9323
|
+
"dev": {
|
|
9324
|
+
"type": "boolean",
|
|
9325
|
+
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
9326
|
+
},
|
|
9327
|
+
"icon": {
|
|
9328
|
+
"type": "string",
|
|
9329
|
+
"description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
|
|
9330
|
+
},
|
|
9331
|
+
"readme": {
|
|
9332
|
+
"type": "string",
|
|
9333
|
+
"description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
|
|
9334
|
+
},
|
|
9335
|
+
"title": {
|
|
9336
|
+
"type": "string",
|
|
9337
|
+
"minLength": 1,
|
|
9338
|
+
"maxLength": 64,
|
|
9339
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
9340
|
+
},
|
|
9341
|
+
"description": {
|
|
9342
|
+
"type": "string",
|
|
9343
|
+
"maxLength": 256,
|
|
9344
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
9345
|
+
},
|
|
9346
|
+
"public": {
|
|
9347
|
+
"type": "boolean",
|
|
9348
|
+
"description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
9349
|
+
},
|
|
9350
|
+
"layers": {
|
|
9351
|
+
"type": "array",
|
|
9352
|
+
"items": {
|
|
9353
|
+
"type": "string"
|
|
9354
|
+
}
|
|
9355
|
+
}
|
|
9356
|
+
},
|
|
9357
|
+
"required": [
|
|
9358
|
+
"name",
|
|
9359
|
+
"version"
|
|
9360
|
+
],
|
|
9361
|
+
"title": "validateIntegrationCreationBody",
|
|
9362
|
+
"additionalProperties": false
|
|
9363
|
+
}
|
|
9364
|
+
},
|
|
9365
|
+
"response": {
|
|
9366
|
+
"description": "Validation succeeded: the integration can be created using the same parameters",
|
|
9367
|
+
"schema": {
|
|
9368
|
+
"type": "object",
|
|
9369
|
+
"title": "validateIntegrationCreationResponse",
|
|
9370
|
+
"additionalProperties": false
|
|
9371
|
+
}
|
|
9372
|
+
},
|
|
9373
|
+
"parameters": {}
|
|
9374
|
+
},
|
|
9375
|
+
"updateIntegration": {
|
|
9376
|
+
"name": "updateIntegration",
|
|
9377
|
+
"description": "Update integration",
|
|
9378
|
+
"method": "put",
|
|
9379
|
+
"path": "/v1/admin/integrations/{id}",
|
|
9380
|
+
"section": "integration",
|
|
9381
|
+
"parameters": {
|
|
9382
|
+
"id": {
|
|
9383
|
+
"type": "string",
|
|
9384
|
+
"description": "Integration ID",
|
|
9385
|
+
"in": "path"
|
|
9386
|
+
}
|
|
9387
|
+
},
|
|
9388
|
+
"requestBody": {
|
|
9389
|
+
"description": "Integration",
|
|
9390
|
+
"schema": {
|
|
9391
|
+
"type": "object",
|
|
9392
|
+
"properties": {
|
|
9393
|
+
"configuration": {
|
|
9394
|
+
"type": "object",
|
|
9395
|
+
"properties": {
|
|
9396
|
+
"title": {
|
|
9397
|
+
"type": "string",
|
|
9398
|
+
"maxLength": 64,
|
|
9399
|
+
"description": "Title of the configuration"
|
|
9400
|
+
},
|
|
9401
|
+
"description": {
|
|
9402
|
+
"type": "string",
|
|
9403
|
+
"maxLength": 256,
|
|
9404
|
+
"description": "Description of the configuration"
|
|
9405
|
+
},
|
|
9406
|
+
"schema": {
|
|
9407
|
+
"type": "object",
|
|
9408
|
+
"additionalProperties": true,
|
|
9409
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
9410
|
+
},
|
|
9411
|
+
"identifier": {
|
|
9412
|
+
"type": "object",
|
|
9413
|
+
"properties": {
|
|
9414
|
+
"linkTemplateScript": {
|
|
9415
|
+
"type": "string",
|
|
9416
|
+
"maxLength": 2000,
|
|
9417
|
+
"nullable": true
|
|
9418
|
+
},
|
|
9419
|
+
"required": {
|
|
9420
|
+
"type": "boolean"
|
|
9421
|
+
}
|
|
9422
|
+
},
|
|
9423
|
+
"additionalProperties": false
|
|
9424
|
+
}
|
|
9425
|
+
},
|
|
9426
|
+
"description": "Default configuration definition of the integration",
|
|
9427
|
+
"additionalProperties": false
|
|
9428
|
+
},
|
|
9429
|
+
"configurations": {
|
|
9430
|
+
"type": "object",
|
|
9431
|
+
"additionalProperties": {
|
|
9432
|
+
"type": "object",
|
|
9433
|
+
"properties": {
|
|
9434
|
+
"title": {
|
|
9435
|
+
"type": "string",
|
|
9436
|
+
"maxLength": 64,
|
|
9437
|
+
"description": "Title of the configuration"
|
|
9438
|
+
},
|
|
9439
|
+
"description": {
|
|
9440
|
+
"type": "string",
|
|
9441
|
+
"maxLength": 256,
|
|
9442
|
+
"description": "Description of the configuration"
|
|
9443
|
+
},
|
|
9444
|
+
"schema": {
|
|
9445
|
+
"type": "object",
|
|
9446
|
+
"additionalProperties": true,
|
|
9447
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
9448
|
+
},
|
|
9449
|
+
"identifier": {
|
|
9450
|
+
"type": "object",
|
|
9451
|
+
"properties": {
|
|
9452
|
+
"linkTemplateScript": {
|
|
9453
|
+
"type": "string",
|
|
9454
|
+
"maxLength": 2000,
|
|
9455
|
+
"nullable": true
|
|
9456
|
+
},
|
|
9457
|
+
"required": {
|
|
9458
|
+
"type": "boolean"
|
|
9459
|
+
}
|
|
9460
|
+
},
|
|
9461
|
+
"additionalProperties": false
|
|
9462
|
+
}
|
|
9463
|
+
},
|
|
9464
|
+
"nullable": true,
|
|
9465
|
+
"additionalProperties": false
|
|
9466
|
+
},
|
|
9467
|
+
"description": "Additional configuration definitions of the integration"
|
|
9468
|
+
},
|
|
9469
|
+
"channels": {
|
|
9470
|
+
"type": "object",
|
|
9471
|
+
"additionalProperties": {
|
|
9472
|
+
"type": "object",
|
|
9473
|
+
"properties": {
|
|
9474
|
+
"title": {
|
|
9475
|
+
"type": "string",
|
|
9476
|
+
"maxLength": 64,
|
|
9477
|
+
"description": "Title of the channel"
|
|
9478
|
+
},
|
|
9479
|
+
"description": {
|
|
9480
|
+
"type": "string",
|
|
9481
|
+
"maxLength": 256,
|
|
9482
|
+
"description": "Description of the channel"
|
|
9483
|
+
},
|
|
9484
|
+
"messages": {
|
|
9485
|
+
"type": "object",
|
|
9486
|
+
"additionalProperties": {
|
|
9487
|
+
"type": "object",
|
|
9488
|
+
"properties": {
|
|
9489
|
+
"schema": {
|
|
9490
|
+
"type": "object",
|
|
9491
|
+
"additionalProperties": true
|
|
9492
|
+
}
|
|
9493
|
+
},
|
|
9494
|
+
"required": [
|
|
9495
|
+
"schema"
|
|
9496
|
+
],
|
|
9497
|
+
"description": "Message definition",
|
|
9498
|
+
"nullable": true,
|
|
9499
|
+
"additionalProperties": false
|
|
9500
|
+
}
|
|
9501
|
+
},
|
|
9502
|
+
"conversation": {
|
|
9503
|
+
"type": "object",
|
|
9504
|
+
"properties": {
|
|
9505
|
+
"creation": {
|
|
9506
|
+
"type": "object",
|
|
9507
|
+
"properties": {
|
|
9508
|
+
"enabled": {
|
|
9509
|
+
"type": "boolean",
|
|
9510
|
+
"description": "Enable conversation creation"
|
|
9511
|
+
},
|
|
9512
|
+
"requiredTags": {
|
|
9513
|
+
"type": "array",
|
|
9514
|
+
"items": {
|
|
9515
|
+
"type": "string"
|
|
9516
|
+
},
|
|
9517
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
9518
|
+
}
|
|
9519
|
+
},
|
|
9520
|
+
"required": [
|
|
9521
|
+
"enabled",
|
|
9522
|
+
"requiredTags"
|
|
9523
|
+
],
|
|
9524
|
+
"description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
|
|
9525
|
+
"additionalProperties": false
|
|
9526
|
+
},
|
|
9527
|
+
"tags": {
|
|
9528
|
+
"type": "object",
|
|
9529
|
+
"additionalProperties": {
|
|
9530
|
+
"type": "object",
|
|
9531
|
+
"properties": {
|
|
9532
|
+
"title": {
|
|
9533
|
+
"type": "string",
|
|
9534
|
+
"maxLength": 64,
|
|
9535
|
+
"description": "Title of the tag"
|
|
9536
|
+
},
|
|
9537
|
+
"description": {
|
|
9538
|
+
"type": "string",
|
|
9539
|
+
"maxLength": 256,
|
|
9540
|
+
"description": "Description of the tag"
|
|
9541
|
+
}
|
|
9542
|
+
},
|
|
9543
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9544
|
+
"nullable": true,
|
|
9545
|
+
"additionalProperties": false
|
|
9546
|
+
}
|
|
9547
|
+
}
|
|
9548
|
+
},
|
|
9549
|
+
"additionalProperties": false
|
|
9550
|
+
},
|
|
9551
|
+
"message": {
|
|
9552
|
+
"type": "object",
|
|
9553
|
+
"properties": {
|
|
9554
|
+
"tags": {
|
|
9555
|
+
"type": "object",
|
|
9556
|
+
"additionalProperties": {
|
|
9557
|
+
"type": "object",
|
|
9558
|
+
"properties": {
|
|
9559
|
+
"title": {
|
|
9560
|
+
"type": "string",
|
|
9561
|
+
"maxLength": 64,
|
|
9562
|
+
"description": "Title of the tag"
|
|
9563
|
+
},
|
|
9564
|
+
"description": {
|
|
9565
|
+
"type": "string",
|
|
9566
|
+
"maxLength": 256,
|
|
9567
|
+
"description": "Description of the tag"
|
|
9568
|
+
}
|
|
9569
|
+
},
|
|
9570
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9571
|
+
"nullable": true,
|
|
9572
|
+
"additionalProperties": false
|
|
9573
|
+
}
|
|
9574
|
+
}
|
|
9575
|
+
},
|
|
9576
|
+
"additionalProperties": false
|
|
9577
|
+
}
|
|
9578
|
+
},
|
|
9579
|
+
"nullable": true,
|
|
9580
|
+
"additionalProperties": false
|
|
9581
|
+
}
|
|
9582
|
+
},
|
|
9583
|
+
"identifier": {
|
|
9584
|
+
"type": "object",
|
|
9585
|
+
"properties": {
|
|
9586
|
+
"extractScript": {
|
|
9587
|
+
"type": "string",
|
|
9588
|
+
"maxLength": 2000,
|
|
9589
|
+
"nullable": true
|
|
9590
|
+
},
|
|
9591
|
+
"fallbackHandlerScript": {
|
|
9592
|
+
"type": "string",
|
|
9593
|
+
"maxLength": 2000,
|
|
9594
|
+
"nullable": true
|
|
9595
|
+
}
|
|
9596
|
+
},
|
|
9597
|
+
"additionalProperties": false
|
|
9598
|
+
},
|
|
9599
|
+
"actions": {
|
|
9600
|
+
"type": "object",
|
|
9601
|
+
"additionalProperties": {
|
|
9602
|
+
"type": "object",
|
|
9603
|
+
"properties": {
|
|
9604
|
+
"title": {
|
|
9605
|
+
"type": "string",
|
|
9606
|
+
"maxLength": 64,
|
|
9607
|
+
"description": "Title of the action"
|
|
9608
|
+
},
|
|
9609
|
+
"description": {
|
|
9610
|
+
"type": "string",
|
|
9611
|
+
"maxLength": 256,
|
|
9612
|
+
"description": "Description of the action"
|
|
9613
|
+
},
|
|
9614
|
+
"billable": {
|
|
9615
|
+
"type": "boolean"
|
|
9616
|
+
},
|
|
9617
|
+
"cacheable": {
|
|
9618
|
+
"type": "boolean"
|
|
9619
|
+
},
|
|
9620
|
+
"input": {
|
|
9621
|
+
"type": "object",
|
|
9622
|
+
"properties": {
|
|
9623
|
+
"schema": {
|
|
9624
|
+
"type": "object",
|
|
9625
|
+
"additionalProperties": true
|
|
9626
|
+
}
|
|
9627
|
+
},
|
|
9628
|
+
"required": [
|
|
9629
|
+
"schema"
|
|
9630
|
+
],
|
|
9631
|
+
"additionalProperties": false
|
|
9632
|
+
},
|
|
9633
|
+
"output": {
|
|
9634
|
+
"type": "object",
|
|
9635
|
+
"properties": {
|
|
9636
|
+
"schema": {
|
|
9637
|
+
"type": "object",
|
|
9638
|
+
"additionalProperties": true
|
|
9639
|
+
}
|
|
9640
|
+
},
|
|
9641
|
+
"required": [
|
|
9642
|
+
"schema"
|
|
9643
|
+
],
|
|
9644
|
+
"additionalProperties": false
|
|
9645
|
+
}
|
|
9646
|
+
},
|
|
9647
|
+
"required": [
|
|
9648
|
+
"input",
|
|
9649
|
+
"output"
|
|
9650
|
+
],
|
|
9651
|
+
"description": "Action definition",
|
|
9652
|
+
"nullable": true,
|
|
9653
|
+
"additionalProperties": false
|
|
9654
|
+
}
|
|
9655
|
+
},
|
|
9656
|
+
"events": {
|
|
9657
|
+
"type": "object",
|
|
9658
|
+
"additionalProperties": {
|
|
9659
|
+
"type": "object",
|
|
9660
|
+
"properties": {
|
|
9661
|
+
"title": {
|
|
9662
|
+
"type": "string",
|
|
9663
|
+
"maxLength": 64,
|
|
9664
|
+
"description": "Title of the event"
|
|
9665
|
+
},
|
|
9666
|
+
"description": {
|
|
9667
|
+
"type": "string",
|
|
9668
|
+
"maxLength": 256,
|
|
9669
|
+
"description": "Description of the event"
|
|
9670
|
+
},
|
|
9671
|
+
"schema": {
|
|
9672
|
+
"type": "object",
|
|
9673
|
+
"additionalProperties": true
|
|
9674
|
+
}
|
|
9675
|
+
},
|
|
9676
|
+
"required": [
|
|
9677
|
+
"schema"
|
|
9678
|
+
],
|
|
9679
|
+
"description": "Event Definition",
|
|
9680
|
+
"nullable": true,
|
|
9681
|
+
"additionalProperties": false
|
|
9682
|
+
}
|
|
9683
|
+
},
|
|
9684
|
+
"states": {
|
|
9685
|
+
"type": "object",
|
|
9686
|
+
"additionalProperties": {
|
|
9687
|
+
"type": "object",
|
|
9688
|
+
"properties": {
|
|
9689
|
+
"type": {
|
|
9690
|
+
"type": "string",
|
|
9691
|
+
"enum": [
|
|
9692
|
+
"conversation",
|
|
9693
|
+
"user",
|
|
9694
|
+
"integration"
|
|
9695
|
+
],
|
|
9696
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
9697
|
+
},
|
|
9698
|
+
"schema": {
|
|
9699
|
+
"type": "object",
|
|
9700
|
+
"additionalProperties": true,
|
|
9701
|
+
"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."
|
|
9702
|
+
}
|
|
9703
|
+
},
|
|
9704
|
+
"required": [
|
|
9705
|
+
"type",
|
|
9706
|
+
"schema"
|
|
9707
|
+
],
|
|
9708
|
+
"description": "State definition",
|
|
9709
|
+
"nullable": true,
|
|
9710
|
+
"additionalProperties": false
|
|
9711
|
+
}
|
|
9712
|
+
},
|
|
9713
|
+
"user": {
|
|
9714
|
+
"type": "object",
|
|
9715
|
+
"properties": {
|
|
9716
|
+
"creation": {
|
|
9717
|
+
"type": "object",
|
|
9718
|
+
"properties": {
|
|
9719
|
+
"enabled": {
|
|
9720
|
+
"type": "boolean",
|
|
9721
|
+
"description": "Enable user creation"
|
|
9722
|
+
},
|
|
9723
|
+
"requiredTags": {
|
|
9724
|
+
"type": "array",
|
|
9725
|
+
"items": {
|
|
9726
|
+
"type": "string"
|
|
9727
|
+
},
|
|
9728
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
9729
|
+
}
|
|
9730
|
+
},
|
|
9731
|
+
"required": [
|
|
9732
|
+
"enabled",
|
|
9733
|
+
"requiredTags"
|
|
9734
|
+
],
|
|
9735
|
+
"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.",
|
|
9736
|
+
"additionalProperties": false
|
|
9737
|
+
},
|
|
9738
|
+
"tags": {
|
|
9739
|
+
"type": "object",
|
|
9740
|
+
"additionalProperties": {
|
|
9741
|
+
"type": "object",
|
|
9742
|
+
"properties": {
|
|
9743
|
+
"title": {
|
|
9744
|
+
"type": "string",
|
|
9745
|
+
"maxLength": 64,
|
|
9746
|
+
"description": "Title of the tag"
|
|
9747
|
+
},
|
|
9748
|
+
"description": {
|
|
9749
|
+
"type": "string",
|
|
9750
|
+
"maxLength": 256,
|
|
9751
|
+
"description": "Description of the tag"
|
|
9752
|
+
}
|
|
9753
|
+
},
|
|
9754
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9755
|
+
"nullable": true,
|
|
9756
|
+
"additionalProperties": false
|
|
9757
|
+
}
|
|
9758
|
+
}
|
|
9759
|
+
},
|
|
9760
|
+
"additionalProperties": false
|
|
9761
|
+
},
|
|
9762
|
+
"entities": {
|
|
9763
|
+
"type": "object",
|
|
9764
|
+
"additionalProperties": {
|
|
9765
|
+
"type": "object",
|
|
9766
|
+
"properties": {
|
|
9767
|
+
"title": {
|
|
9768
|
+
"type": "string",
|
|
9769
|
+
"maxLength": 64,
|
|
9770
|
+
"description": "Title of the entity"
|
|
9771
|
+
},
|
|
9772
|
+
"description": {
|
|
9773
|
+
"type": "string",
|
|
9774
|
+
"maxLength": 256,
|
|
9775
|
+
"description": "Description of the entity"
|
|
9776
|
+
},
|
|
9777
|
+
"schema": {
|
|
9778
|
+
"type": "object",
|
|
9779
|
+
"additionalProperties": true
|
|
9780
|
+
}
|
|
9781
|
+
},
|
|
9782
|
+
"required": [
|
|
9783
|
+
"schema"
|
|
9784
|
+
],
|
|
9785
|
+
"description": "Entity definition",
|
|
9786
|
+
"nullable": true,
|
|
9787
|
+
"additionalProperties": false
|
|
9788
|
+
}
|
|
9789
|
+
},
|
|
9790
|
+
"interfaces": {
|
|
9791
|
+
"type": "object",
|
|
9792
|
+
"additionalProperties": {
|
|
9793
|
+
"type": "object",
|
|
9794
|
+
"properties": {
|
|
9795
|
+
"id": {
|
|
9796
|
+
"type": "string",
|
|
9797
|
+
"minLength": 28,
|
|
9798
|
+
"maxLength": 36,
|
|
9799
|
+
"description": "ID of the interface"
|
|
9800
|
+
},
|
|
9801
|
+
"entities": {
|
|
9802
|
+
"type": "object",
|
|
9803
|
+
"additionalProperties": {
|
|
9804
|
+
"type": "object",
|
|
9805
|
+
"properties": {
|
|
9806
|
+
"name": {
|
|
9807
|
+
"type": "string",
|
|
9808
|
+
"maxLength": 200
|
|
9809
|
+
}
|
|
9810
|
+
},
|
|
9811
|
+
"required": [
|
|
9812
|
+
"name"
|
|
9813
|
+
],
|
|
9814
|
+
"additionalProperties": false
|
|
9815
|
+
}
|
|
9816
|
+
},
|
|
9817
|
+
"actions": {
|
|
9818
|
+
"type": "object",
|
|
9819
|
+
"additionalProperties": {
|
|
9820
|
+
"type": "object",
|
|
9821
|
+
"properties": {
|
|
9822
|
+
"name": {
|
|
9823
|
+
"type": "string",
|
|
9824
|
+
"maxLength": 200
|
|
9825
|
+
}
|
|
9826
|
+
},
|
|
9827
|
+
"required": [
|
|
9828
|
+
"name"
|
|
9829
|
+
],
|
|
9830
|
+
"additionalProperties": false
|
|
9831
|
+
}
|
|
9832
|
+
},
|
|
9833
|
+
"events": {
|
|
9834
|
+
"type": "object",
|
|
9835
|
+
"additionalProperties": {
|
|
9836
|
+
"type": "object",
|
|
9837
|
+
"properties": {
|
|
9838
|
+
"name": {
|
|
9839
|
+
"type": "string",
|
|
9840
|
+
"maxLength": 200
|
|
9841
|
+
}
|
|
9842
|
+
},
|
|
9843
|
+
"required": [
|
|
9844
|
+
"name"
|
|
9845
|
+
],
|
|
9846
|
+
"additionalProperties": false
|
|
9847
|
+
}
|
|
9848
|
+
},
|
|
9849
|
+
"channels": {
|
|
9850
|
+
"type": "object",
|
|
9851
|
+
"additionalProperties": {
|
|
9852
|
+
"type": "object",
|
|
9853
|
+
"properties": {
|
|
9854
|
+
"name": {
|
|
9855
|
+
"type": "string",
|
|
9856
|
+
"maxLength": 200
|
|
9857
|
+
}
|
|
9858
|
+
},
|
|
9859
|
+
"required": [
|
|
9860
|
+
"name"
|
|
9861
|
+
],
|
|
9862
|
+
"additionalProperties": false
|
|
9863
|
+
}
|
|
9864
|
+
}
|
|
9865
|
+
},
|
|
9866
|
+
"required": [
|
|
9867
|
+
"id"
|
|
9868
|
+
],
|
|
9869
|
+
"nullable": true,
|
|
9870
|
+
"additionalProperties": false
|
|
9871
|
+
}
|
|
9872
|
+
},
|
|
9873
|
+
"secrets": {
|
|
9874
|
+
"type": "object",
|
|
9875
|
+
"additionalProperties": {
|
|
9876
|
+
"type": "string",
|
|
9877
|
+
"maxLength": 20000,
|
|
9878
|
+
"nullable": true
|
|
9879
|
+
},
|
|
9880
|
+
"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."
|
|
9881
|
+
},
|
|
9882
|
+
"code": {
|
|
9883
|
+
"type": "string",
|
|
9884
|
+
"description": "JavaScript code of the integration"
|
|
9885
|
+
},
|
|
9886
|
+
"icon": {
|
|
9887
|
+
"type": "string",
|
|
9888
|
+
"description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
|
|
9889
|
+
},
|
|
9890
|
+
"readme": {
|
|
9891
|
+
"type": "string",
|
|
9892
|
+
"description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
|
|
9893
|
+
},
|
|
9894
|
+
"title": {
|
|
9895
|
+
"type": "string",
|
|
9896
|
+
"minLength": 1,
|
|
9897
|
+
"maxLength": 64,
|
|
9898
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
9899
|
+
},
|
|
9900
|
+
"description": {
|
|
9901
|
+
"type": "string",
|
|
9902
|
+
"maxLength": 256,
|
|
9903
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
9904
|
+
},
|
|
9905
|
+
"url": {
|
|
9906
|
+
"type": "string",
|
|
9907
|
+
"description": "URL of the integration",
|
|
9908
|
+
"nullable": true
|
|
9909
|
+
},
|
|
9910
|
+
"public": {
|
|
9911
|
+
"type": "boolean",
|
|
9912
|
+
"description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
9913
|
+
},
|
|
9914
|
+
"layers": {
|
|
9915
|
+
"type": "array",
|
|
9916
|
+
"items": {
|
|
9917
|
+
"type": "string"
|
|
9918
|
+
}
|
|
9919
|
+
}
|
|
9920
|
+
},
|
|
9921
|
+
"title": "updateIntegrationBody",
|
|
9922
|
+
"additionalProperties": false
|
|
9923
|
+
}
|
|
9924
|
+
},
|
|
9925
|
+
"response": {
|
|
9926
|
+
"description": "Success",
|
|
9927
|
+
"schema": {
|
|
9928
|
+
"type": "object",
|
|
9929
|
+
"properties": {
|
|
9930
|
+
"integration": {
|
|
9931
|
+
"$ref": "#/components/schemas/Integration"
|
|
9932
|
+
}
|
|
9933
|
+
},
|
|
9934
|
+
"required": [
|
|
9935
|
+
"integration"
|
|
9936
|
+
],
|
|
9937
|
+
"title": "updateIntegrationResponse",
|
|
9938
|
+
"additionalProperties": false
|
|
9939
|
+
}
|
|
9940
|
+
}
|
|
9941
|
+
},
|
|
9942
|
+
"validateIntegrationUpdate": {
|
|
9943
|
+
"name": "validateIntegrationUpdate",
|
|
9944
|
+
"description": "Perform a validation of an integration update request",
|
|
9945
|
+
"method": "put",
|
|
9946
|
+
"path": "/v1/admin/integrations/{id}/validate",
|
|
9947
|
+
"section": "integration",
|
|
9948
|
+
"parameters": {
|
|
9949
|
+
"id": {
|
|
9950
|
+
"type": "string",
|
|
9951
|
+
"description": "Integration ID",
|
|
9952
|
+
"in": "path"
|
|
9953
|
+
}
|
|
9954
|
+
},
|
|
9955
|
+
"requestBody": {
|
|
9956
|
+
"description": "Integration",
|
|
9957
|
+
"schema": {
|
|
9958
|
+
"type": "object",
|
|
9959
|
+
"properties": {
|
|
9960
|
+
"configuration": {
|
|
9961
|
+
"type": "object",
|
|
9962
|
+
"properties": {
|
|
9963
|
+
"title": {
|
|
9964
|
+
"type": "string",
|
|
9965
|
+
"maxLength": 64,
|
|
9966
|
+
"description": "Title of the configuration"
|
|
9967
|
+
},
|
|
9968
|
+
"description": {
|
|
9969
|
+
"type": "string",
|
|
9970
|
+
"maxLength": 256,
|
|
9971
|
+
"description": "Description of the configuration"
|
|
9972
|
+
},
|
|
9973
|
+
"schema": {
|
|
9974
|
+
"type": "object",
|
|
9975
|
+
"additionalProperties": true,
|
|
9976
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
9977
|
+
},
|
|
9978
|
+
"identifier": {
|
|
9979
|
+
"type": "object",
|
|
9980
|
+
"properties": {
|
|
9981
|
+
"linkTemplateScript": {
|
|
9982
|
+
"type": "string",
|
|
9983
|
+
"maxLength": 2000,
|
|
9984
|
+
"nullable": true
|
|
9985
|
+
},
|
|
9986
|
+
"required": {
|
|
9987
|
+
"type": "boolean"
|
|
9988
|
+
}
|
|
9989
|
+
},
|
|
9990
|
+
"additionalProperties": false
|
|
9991
|
+
}
|
|
9992
|
+
},
|
|
9993
|
+
"description": "Default configuration definition of the integration",
|
|
9994
|
+
"additionalProperties": false
|
|
9995
|
+
},
|
|
9996
|
+
"configurations": {
|
|
9997
|
+
"type": "object",
|
|
9998
|
+
"additionalProperties": {
|
|
9999
|
+
"type": "object",
|
|
10000
|
+
"properties": {
|
|
10001
|
+
"title": {
|
|
10002
|
+
"type": "string",
|
|
10003
|
+
"maxLength": 64,
|
|
10004
|
+
"description": "Title of the configuration"
|
|
10005
|
+
},
|
|
10006
|
+
"description": {
|
|
10007
|
+
"type": "string",
|
|
10008
|
+
"maxLength": 256,
|
|
10009
|
+
"description": "Description of the configuration"
|
|
10010
|
+
},
|
|
10011
|
+
"schema": {
|
|
10012
|
+
"type": "object",
|
|
10013
|
+
"additionalProperties": true,
|
|
10014
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
10015
|
+
},
|
|
10016
|
+
"identifier": {
|
|
10017
|
+
"type": "object",
|
|
10018
|
+
"properties": {
|
|
10019
|
+
"linkTemplateScript": {
|
|
10020
|
+
"type": "string",
|
|
10021
|
+
"maxLength": 2000,
|
|
10022
|
+
"nullable": true
|
|
10023
|
+
},
|
|
10024
|
+
"required": {
|
|
10025
|
+
"type": "boolean"
|
|
10026
|
+
}
|
|
10027
|
+
},
|
|
10028
|
+
"additionalProperties": false
|
|
10029
|
+
}
|
|
10030
|
+
},
|
|
10031
|
+
"nullable": true,
|
|
10032
|
+
"additionalProperties": false
|
|
10033
|
+
},
|
|
10034
|
+
"description": "Additional configuration definitions of the integration"
|
|
10035
|
+
},
|
|
10036
|
+
"channels": {
|
|
10037
|
+
"type": "object",
|
|
10038
|
+
"additionalProperties": {
|
|
10039
|
+
"type": "object",
|
|
10040
|
+
"properties": {
|
|
10041
|
+
"title": {
|
|
10042
|
+
"type": "string",
|
|
10043
|
+
"maxLength": 64,
|
|
10044
|
+
"description": "Title of the channel"
|
|
10045
|
+
},
|
|
10046
|
+
"description": {
|
|
10047
|
+
"type": "string",
|
|
10048
|
+
"maxLength": 256,
|
|
10049
|
+
"description": "Description of the channel"
|
|
10050
|
+
},
|
|
10051
|
+
"messages": {
|
|
10052
|
+
"type": "object",
|
|
10053
|
+
"additionalProperties": {
|
|
10054
|
+
"type": "object",
|
|
10055
|
+
"properties": {
|
|
10056
|
+
"schema": {
|
|
10057
|
+
"type": "object",
|
|
10058
|
+
"additionalProperties": true
|
|
10059
|
+
}
|
|
10060
|
+
},
|
|
10061
|
+
"required": [
|
|
10062
|
+
"schema"
|
|
10063
|
+
],
|
|
10064
|
+
"description": "Message definition",
|
|
10065
|
+
"nullable": true,
|
|
10066
|
+
"additionalProperties": false
|
|
10067
|
+
}
|
|
10068
|
+
},
|
|
10069
|
+
"conversation": {
|
|
10070
|
+
"type": "object",
|
|
10071
|
+
"properties": {
|
|
10072
|
+
"creation": {
|
|
10073
|
+
"type": "object",
|
|
10074
|
+
"properties": {
|
|
10075
|
+
"enabled": {
|
|
10076
|
+
"type": "boolean",
|
|
10077
|
+
"description": "Enable conversation creation"
|
|
10078
|
+
},
|
|
10079
|
+
"requiredTags": {
|
|
10080
|
+
"type": "array",
|
|
10081
|
+
"items": {
|
|
10082
|
+
"type": "string"
|
|
10083
|
+
},
|
|
10084
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
10085
|
+
}
|
|
10086
|
+
},
|
|
10087
|
+
"required": [
|
|
10088
|
+
"enabled",
|
|
10089
|
+
"requiredTags"
|
|
10090
|
+
],
|
|
10091
|
+
"description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
|
|
10092
|
+
"additionalProperties": false
|
|
10093
|
+
},
|
|
10094
|
+
"tags": {
|
|
10095
|
+
"type": "object",
|
|
10096
|
+
"additionalProperties": {
|
|
10097
|
+
"type": "object",
|
|
10098
|
+
"properties": {
|
|
10099
|
+
"title": {
|
|
10100
|
+
"type": "string",
|
|
10101
|
+
"maxLength": 64,
|
|
10102
|
+
"description": "Title of the tag"
|
|
10103
|
+
},
|
|
10104
|
+
"description": {
|
|
10105
|
+
"type": "string",
|
|
10106
|
+
"maxLength": 256,
|
|
10107
|
+
"description": "Description of the tag"
|
|
10108
|
+
}
|
|
10109
|
+
},
|
|
10110
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
10111
|
+
"nullable": true,
|
|
10112
|
+
"additionalProperties": false
|
|
10113
|
+
}
|
|
10114
|
+
}
|
|
10115
|
+
},
|
|
10116
|
+
"additionalProperties": false
|
|
10117
|
+
},
|
|
10118
|
+
"message": {
|
|
10119
|
+
"type": "object",
|
|
10120
|
+
"properties": {
|
|
10121
|
+
"tags": {
|
|
10122
|
+
"type": "object",
|
|
10123
|
+
"additionalProperties": {
|
|
10124
|
+
"type": "object",
|
|
10125
|
+
"properties": {
|
|
10126
|
+
"title": {
|
|
10127
|
+
"type": "string",
|
|
10128
|
+
"maxLength": 64,
|
|
10129
|
+
"description": "Title of the tag"
|
|
10130
|
+
},
|
|
10131
|
+
"description": {
|
|
10132
|
+
"type": "string",
|
|
10133
|
+
"maxLength": 256,
|
|
10134
|
+
"description": "Description of the tag"
|
|
10135
|
+
}
|
|
10136
|
+
},
|
|
10137
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
10138
|
+
"nullable": true,
|
|
10139
|
+
"additionalProperties": false
|
|
10140
|
+
}
|
|
10141
|
+
}
|
|
10142
|
+
},
|
|
10143
|
+
"additionalProperties": false
|
|
10144
|
+
}
|
|
10145
|
+
},
|
|
10146
|
+
"nullable": true,
|
|
10147
|
+
"additionalProperties": false
|
|
10148
|
+
}
|
|
10149
|
+
},
|
|
10150
|
+
"identifier": {
|
|
10151
|
+
"type": "object",
|
|
10152
|
+
"properties": {
|
|
10153
|
+
"extractScript": {
|
|
10154
|
+
"type": "string",
|
|
10155
|
+
"maxLength": 2000,
|
|
10156
|
+
"nullable": true
|
|
10157
|
+
},
|
|
10158
|
+
"fallbackHandlerScript": {
|
|
10159
|
+
"type": "string",
|
|
10160
|
+
"maxLength": 2000,
|
|
10161
|
+
"nullable": true
|
|
10162
|
+
}
|
|
10163
|
+
},
|
|
10164
|
+
"additionalProperties": false
|
|
10165
|
+
},
|
|
10166
|
+
"actions": {
|
|
9024
10167
|
"type": "object",
|
|
9025
10168
|
"additionalProperties": {
|
|
9026
10169
|
"type": "object",
|
|
@@ -9342,23 +10485,15 @@ export const state = {
|
|
|
9342
10485
|
}
|
|
9343
10486
|
}
|
|
9344
10487
|
},
|
|
9345
|
-
"title": "
|
|
10488
|
+
"title": "validateIntegrationUpdateBody",
|
|
9346
10489
|
"additionalProperties": false
|
|
9347
10490
|
}
|
|
9348
10491
|
},
|
|
9349
10492
|
"response": {
|
|
9350
|
-
"description": "
|
|
10493
|
+
"description": "Validation succeeded: the integration can be updated using the same parameters",
|
|
9351
10494
|
"schema": {
|
|
9352
10495
|
"type": "object",
|
|
9353
|
-
"
|
|
9354
|
-
"integration": {
|
|
9355
|
-
"$ref": "#/components/schemas/Integration"
|
|
9356
|
-
}
|
|
9357
|
-
},
|
|
9358
|
-
"required": [
|
|
9359
|
-
"integration"
|
|
9360
|
-
],
|
|
9361
|
-
"title": "updateIntegrationResponse",
|
|
10496
|
+
"title": "validateIntegrationUpdateResponse",
|
|
9362
10497
|
"additionalProperties": false
|
|
9363
10498
|
}
|
|
9364
10499
|
}
|
|
@@ -14141,7 +15276,7 @@ export const state = {
|
|
|
14141
15276
|
"title": "Botpress API",
|
|
14142
15277
|
"description": "API for Botpress Cloud",
|
|
14143
15278
|
"server": "https://api.botpress.cloud",
|
|
14144
|
-
"version": "0.
|
|
15279
|
+
"version": "0.70.1",
|
|
14145
15280
|
"prefix": "v1"
|
|
14146
15281
|
},
|
|
14147
15282
|
"errors": [
|
|
@@ -14309,7 +15444,9 @@ export const state = {
|
|
|
14309
15444
|
"updateWorkspaceMemberBody": true,
|
|
14310
15445
|
"createIntegrationApiKeyBody": true,
|
|
14311
15446
|
"createIntegrationBody": true,
|
|
15447
|
+
"validateIntegrationCreationBody": true,
|
|
14312
15448
|
"updateIntegrationBody": true,
|
|
15449
|
+
"validateIntegrationUpdateBody": true,
|
|
14313
15450
|
"requestIntegrationVerificationBody": true,
|
|
14314
15451
|
"createInterfaceBody": true,
|
|
14315
15452
|
"updateInterfaceBody": true,
|
|
@@ -14432,7 +15569,9 @@ export const state = {
|
|
|
14432
15569
|
"createIntegrationApiKeyResponse": true,
|
|
14433
15570
|
"deleteIntegrationApiKeyResponse": true,
|
|
14434
15571
|
"createIntegrationResponse": true,
|
|
15572
|
+
"validateIntegrationCreationResponse": true,
|
|
14435
15573
|
"updateIntegrationResponse": true,
|
|
15574
|
+
"validateIntegrationUpdateResponse": true,
|
|
14436
15575
|
"listIntegrationsResponse": true,
|
|
14437
15576
|
"getIntegrationResponse": true,
|
|
14438
15577
|
"getIntegrationLogsResponse": true,
|
|
@@ -17845,7 +18984,9 @@ export const state = {
|
|
|
17845
18984
|
"createIntegrationApiKey",
|
|
17846
18985
|
"deleteIntegrationApiKey",
|
|
17847
18986
|
"createIntegration",
|
|
18987
|
+
"validateIntegrationCreation",
|
|
17848
18988
|
"updateIntegration",
|
|
18989
|
+
"validateIntegrationUpdate",
|
|
17849
18990
|
"listIntegrations",
|
|
17850
18991
|
"getIntegration",
|
|
17851
18992
|
"getIntegrationLogs",
|