@botpress/api 0.69.0 → 0.70.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 +1135 -13
- package/dist/src/gen/state.d.ts +1049 -6
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +1135 -13
package/src/gen/state.ts
CHANGED
|
@@ -8796,11 +8796,1135 @@ export const state = {
|
|
|
8796
8796
|
},
|
|
8797
8797
|
"parameters": {}
|
|
8798
8798
|
},
|
|
8799
|
+
"validateIntegrationCreation": {
|
|
8800
|
+
"name": "validateIntegrationCreation",
|
|
8801
|
+
"description": "Perform a validation of an integration creation request",
|
|
8802
|
+
"method": "post",
|
|
8803
|
+
"section": "integration",
|
|
8804
|
+
"path": "/v1/admin/integrations/validate",
|
|
8805
|
+
"requestBody": {
|
|
8806
|
+
"description": "Integration",
|
|
8807
|
+
"schema": {
|
|
8808
|
+
"type": "object",
|
|
8809
|
+
"properties": {
|
|
8810
|
+
"name": {
|
|
8811
|
+
"type": "string",
|
|
8812
|
+
"maxLength": 200,
|
|
8813
|
+
"description": "Name of the [Integration](#schema_integration)"
|
|
8814
|
+
},
|
|
8815
|
+
"version": {
|
|
8816
|
+
"type": "string",
|
|
8817
|
+
"maxLength": 200,
|
|
8818
|
+
"description": "Version of the [Integration](#schema_integration)"
|
|
8819
|
+
},
|
|
8820
|
+
"configuration": {
|
|
8821
|
+
"type": "object",
|
|
8822
|
+
"properties": {
|
|
8823
|
+
"title": {
|
|
8824
|
+
"type": "string",
|
|
8825
|
+
"maxLength": 64,
|
|
8826
|
+
"description": "Title of the configuration"
|
|
8827
|
+
},
|
|
8828
|
+
"description": {
|
|
8829
|
+
"type": "string",
|
|
8830
|
+
"maxLength": 256,
|
|
8831
|
+
"description": "Description of the configuration"
|
|
8832
|
+
},
|
|
8833
|
+
"schema": {
|
|
8834
|
+
"type": "object",
|
|
8835
|
+
"additionalProperties": true,
|
|
8836
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
8837
|
+
},
|
|
8838
|
+
"identifier": {
|
|
8839
|
+
"type": "object",
|
|
8840
|
+
"properties": {
|
|
8841
|
+
"required": {
|
|
8842
|
+
"type": "boolean"
|
|
8843
|
+
},
|
|
8844
|
+
"linkTemplateScript": {
|
|
8845
|
+
"type": "string",
|
|
8846
|
+
"maxLength": 2000
|
|
8847
|
+
}
|
|
8848
|
+
},
|
|
8849
|
+
"additionalProperties": false
|
|
8850
|
+
}
|
|
8851
|
+
},
|
|
8852
|
+
"description": "Default configuration definition of the integration",
|
|
8853
|
+
"additionalProperties": false
|
|
8854
|
+
},
|
|
8855
|
+
"configurations": {
|
|
8856
|
+
"type": "object",
|
|
8857
|
+
"additionalProperties": {
|
|
8858
|
+
"type": "object",
|
|
8859
|
+
"properties": {
|
|
8860
|
+
"title": {
|
|
8861
|
+
"type": "string",
|
|
8862
|
+
"maxLength": 64,
|
|
8863
|
+
"description": "Title of the configuration"
|
|
8864
|
+
},
|
|
8865
|
+
"description": {
|
|
8866
|
+
"type": "string",
|
|
8867
|
+
"maxLength": 256,
|
|
8868
|
+
"description": "Description of the configuration"
|
|
8869
|
+
},
|
|
8870
|
+
"schema": {
|
|
8871
|
+
"type": "object",
|
|
8872
|
+
"additionalProperties": true,
|
|
8873
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
8874
|
+
},
|
|
8875
|
+
"identifier": {
|
|
8876
|
+
"type": "object",
|
|
8877
|
+
"properties": {
|
|
8878
|
+
"required": {
|
|
8879
|
+
"type": "boolean"
|
|
8880
|
+
},
|
|
8881
|
+
"linkTemplateScript": {
|
|
8882
|
+
"type": "string",
|
|
8883
|
+
"maxLength": 2000
|
|
8884
|
+
}
|
|
8885
|
+
},
|
|
8886
|
+
"additionalProperties": false
|
|
8887
|
+
}
|
|
8888
|
+
},
|
|
8889
|
+
"additionalProperties": false
|
|
8890
|
+
},
|
|
8891
|
+
"description": "Additional configuration definitions of the integration"
|
|
8892
|
+
},
|
|
8893
|
+
"states": {
|
|
8894
|
+
"type": "object",
|
|
8895
|
+
"additionalProperties": {
|
|
8896
|
+
"type": "object",
|
|
8897
|
+
"properties": {
|
|
8898
|
+
"type": {
|
|
8899
|
+
"type": "string",
|
|
8900
|
+
"enum": [
|
|
8901
|
+
"conversation",
|
|
8902
|
+
"user",
|
|
8903
|
+
"integration"
|
|
8904
|
+
],
|
|
8905
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
8906
|
+
},
|
|
8907
|
+
"schema": {
|
|
8908
|
+
"type": "object",
|
|
8909
|
+
"additionalProperties": true,
|
|
8910
|
+
"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."
|
|
8911
|
+
}
|
|
8912
|
+
},
|
|
8913
|
+
"required": [
|
|
8914
|
+
"type",
|
|
8915
|
+
"schema"
|
|
8916
|
+
],
|
|
8917
|
+
"description": "State definition",
|
|
8918
|
+
"additionalProperties": false
|
|
8919
|
+
}
|
|
8920
|
+
},
|
|
8921
|
+
"events": {
|
|
8922
|
+
"type": "object",
|
|
8923
|
+
"additionalProperties": {
|
|
8924
|
+
"type": "object",
|
|
8925
|
+
"properties": {
|
|
8926
|
+
"title": {
|
|
8927
|
+
"type": "string",
|
|
8928
|
+
"maxLength": 64,
|
|
8929
|
+
"description": "Title of the event"
|
|
8930
|
+
},
|
|
8931
|
+
"description": {
|
|
8932
|
+
"type": "string",
|
|
8933
|
+
"maxLength": 256,
|
|
8934
|
+
"description": "Description of the event"
|
|
8935
|
+
},
|
|
8936
|
+
"schema": {
|
|
8937
|
+
"type": "object",
|
|
8938
|
+
"additionalProperties": true
|
|
8939
|
+
}
|
|
8940
|
+
},
|
|
8941
|
+
"required": [
|
|
8942
|
+
"schema"
|
|
8943
|
+
],
|
|
8944
|
+
"description": "Event Definition",
|
|
8945
|
+
"additionalProperties": false
|
|
8946
|
+
}
|
|
8947
|
+
},
|
|
8948
|
+
"actions": {
|
|
8949
|
+
"type": "object",
|
|
8950
|
+
"additionalProperties": {
|
|
8951
|
+
"type": "object",
|
|
8952
|
+
"properties": {
|
|
8953
|
+
"title": {
|
|
8954
|
+
"type": "string",
|
|
8955
|
+
"maxLength": 64,
|
|
8956
|
+
"description": "Title of the action"
|
|
8957
|
+
},
|
|
8958
|
+
"description": {
|
|
8959
|
+
"type": "string",
|
|
8960
|
+
"maxLength": 256,
|
|
8961
|
+
"description": "Description of the action"
|
|
8962
|
+
},
|
|
8963
|
+
"billable": {
|
|
8964
|
+
"type": "boolean"
|
|
8965
|
+
},
|
|
8966
|
+
"cacheable": {
|
|
8967
|
+
"type": "boolean"
|
|
8968
|
+
},
|
|
8969
|
+
"input": {
|
|
8970
|
+
"type": "object",
|
|
8971
|
+
"properties": {
|
|
8972
|
+
"schema": {
|
|
8973
|
+
"type": "object",
|
|
8974
|
+
"additionalProperties": true
|
|
8975
|
+
}
|
|
8976
|
+
},
|
|
8977
|
+
"required": [
|
|
8978
|
+
"schema"
|
|
8979
|
+
],
|
|
8980
|
+
"additionalProperties": false
|
|
8981
|
+
},
|
|
8982
|
+
"output": {
|
|
8983
|
+
"type": "object",
|
|
8984
|
+
"properties": {
|
|
8985
|
+
"schema": {
|
|
8986
|
+
"type": "object",
|
|
8987
|
+
"additionalProperties": true
|
|
8988
|
+
}
|
|
8989
|
+
},
|
|
8990
|
+
"required": [
|
|
8991
|
+
"schema"
|
|
8992
|
+
],
|
|
8993
|
+
"additionalProperties": false
|
|
8994
|
+
}
|
|
8995
|
+
},
|
|
8996
|
+
"required": [
|
|
8997
|
+
"input",
|
|
8998
|
+
"output"
|
|
8999
|
+
],
|
|
9000
|
+
"description": "Action definition",
|
|
9001
|
+
"additionalProperties": false
|
|
9002
|
+
}
|
|
9003
|
+
},
|
|
9004
|
+
"entities": {
|
|
9005
|
+
"type": "object",
|
|
9006
|
+
"additionalProperties": {
|
|
9007
|
+
"type": "object",
|
|
9008
|
+
"properties": {
|
|
9009
|
+
"title": {
|
|
9010
|
+
"type": "string",
|
|
9011
|
+
"maxLength": 64,
|
|
9012
|
+
"description": "Title of the entity"
|
|
9013
|
+
},
|
|
9014
|
+
"description": {
|
|
9015
|
+
"type": "string",
|
|
9016
|
+
"maxLength": 256,
|
|
9017
|
+
"description": "Description of the entity"
|
|
9018
|
+
},
|
|
9019
|
+
"schema": {
|
|
9020
|
+
"type": "object",
|
|
9021
|
+
"additionalProperties": true
|
|
9022
|
+
}
|
|
9023
|
+
},
|
|
9024
|
+
"required": [
|
|
9025
|
+
"schema"
|
|
9026
|
+
],
|
|
9027
|
+
"description": "Entity definition",
|
|
9028
|
+
"additionalProperties": false
|
|
9029
|
+
}
|
|
9030
|
+
},
|
|
9031
|
+
"identifier": {
|
|
9032
|
+
"type": "object",
|
|
9033
|
+
"properties": {
|
|
9034
|
+
"fallbackHandlerScript": {
|
|
9035
|
+
"type": "string",
|
|
9036
|
+
"maxLength": 2000
|
|
9037
|
+
},
|
|
9038
|
+
"extractScript": {
|
|
9039
|
+
"type": "string",
|
|
9040
|
+
"maxLength": 2000
|
|
9041
|
+
}
|
|
9042
|
+
},
|
|
9043
|
+
"additionalProperties": false
|
|
9044
|
+
},
|
|
9045
|
+
"channels": {
|
|
9046
|
+
"type": "object",
|
|
9047
|
+
"additionalProperties": {
|
|
9048
|
+
"type": "object",
|
|
9049
|
+
"properties": {
|
|
9050
|
+
"title": {
|
|
9051
|
+
"type": "string",
|
|
9052
|
+
"maxLength": 64,
|
|
9053
|
+
"description": "Title of the channel"
|
|
9054
|
+
},
|
|
9055
|
+
"description": {
|
|
9056
|
+
"type": "string",
|
|
9057
|
+
"maxLength": 256,
|
|
9058
|
+
"description": "Description of the channel"
|
|
9059
|
+
},
|
|
9060
|
+
"messages": {
|
|
9061
|
+
"type": "object",
|
|
9062
|
+
"additionalProperties": {
|
|
9063
|
+
"type": "object",
|
|
9064
|
+
"properties": {
|
|
9065
|
+
"schema": {
|
|
9066
|
+
"type": "object",
|
|
9067
|
+
"additionalProperties": true
|
|
9068
|
+
}
|
|
9069
|
+
},
|
|
9070
|
+
"required": [
|
|
9071
|
+
"schema"
|
|
9072
|
+
],
|
|
9073
|
+
"description": "Message definition",
|
|
9074
|
+
"additionalProperties": false
|
|
9075
|
+
}
|
|
9076
|
+
},
|
|
9077
|
+
"conversation": {
|
|
9078
|
+
"type": "object",
|
|
9079
|
+
"properties": {
|
|
9080
|
+
"creation": {
|
|
9081
|
+
"type": "object",
|
|
9082
|
+
"properties": {
|
|
9083
|
+
"enabled": {
|
|
9084
|
+
"type": "boolean",
|
|
9085
|
+
"description": "Enable conversation creation"
|
|
9086
|
+
},
|
|
9087
|
+
"requiredTags": {
|
|
9088
|
+
"type": "array",
|
|
9089
|
+
"items": {
|
|
9090
|
+
"type": "string"
|
|
9091
|
+
},
|
|
9092
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
9093
|
+
}
|
|
9094
|
+
},
|
|
9095
|
+
"required": [
|
|
9096
|
+
"enabled",
|
|
9097
|
+
"requiredTags"
|
|
9098
|
+
],
|
|
9099
|
+
"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.",
|
|
9100
|
+
"additionalProperties": false
|
|
9101
|
+
},
|
|
9102
|
+
"tags": {
|
|
9103
|
+
"type": "object",
|
|
9104
|
+
"additionalProperties": {
|
|
9105
|
+
"type": "object",
|
|
9106
|
+
"properties": {
|
|
9107
|
+
"title": {
|
|
9108
|
+
"type": "string",
|
|
9109
|
+
"maxLength": 64,
|
|
9110
|
+
"description": "Title of the tag"
|
|
9111
|
+
},
|
|
9112
|
+
"description": {
|
|
9113
|
+
"type": "string",
|
|
9114
|
+
"maxLength": 256,
|
|
9115
|
+
"description": "Description of the tag"
|
|
9116
|
+
}
|
|
9117
|
+
},
|
|
9118
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9119
|
+
"additionalProperties": false
|
|
9120
|
+
}
|
|
9121
|
+
}
|
|
9122
|
+
},
|
|
9123
|
+
"additionalProperties": false
|
|
9124
|
+
},
|
|
9125
|
+
"message": {
|
|
9126
|
+
"type": "object",
|
|
9127
|
+
"properties": {
|
|
9128
|
+
"tags": {
|
|
9129
|
+
"type": "object",
|
|
9130
|
+
"additionalProperties": {
|
|
9131
|
+
"type": "object",
|
|
9132
|
+
"properties": {
|
|
9133
|
+
"title": {
|
|
9134
|
+
"type": "string",
|
|
9135
|
+
"maxLength": 64,
|
|
9136
|
+
"description": "Title of the tag"
|
|
9137
|
+
},
|
|
9138
|
+
"description": {
|
|
9139
|
+
"type": "string",
|
|
9140
|
+
"maxLength": 256,
|
|
9141
|
+
"description": "Description of the tag"
|
|
9142
|
+
}
|
|
9143
|
+
},
|
|
9144
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9145
|
+
"additionalProperties": false
|
|
9146
|
+
}
|
|
9147
|
+
}
|
|
9148
|
+
},
|
|
9149
|
+
"additionalProperties": false
|
|
9150
|
+
}
|
|
9151
|
+
},
|
|
9152
|
+
"required": [
|
|
9153
|
+
"messages"
|
|
9154
|
+
],
|
|
9155
|
+
"additionalProperties": false
|
|
9156
|
+
}
|
|
9157
|
+
},
|
|
9158
|
+
"user": {
|
|
9159
|
+
"type": "object",
|
|
9160
|
+
"properties": {
|
|
9161
|
+
"creation": {
|
|
9162
|
+
"type": "object",
|
|
9163
|
+
"properties": {
|
|
9164
|
+
"enabled": {
|
|
9165
|
+
"type": "boolean",
|
|
9166
|
+
"description": "Enable user creation"
|
|
9167
|
+
},
|
|
9168
|
+
"requiredTags": {
|
|
9169
|
+
"type": "array",
|
|
9170
|
+
"items": {
|
|
9171
|
+
"type": "string"
|
|
9172
|
+
},
|
|
9173
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
9174
|
+
}
|
|
9175
|
+
},
|
|
9176
|
+
"required": [
|
|
9177
|
+
"enabled",
|
|
9178
|
+
"requiredTags"
|
|
9179
|
+
],
|
|
9180
|
+
"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.",
|
|
9181
|
+
"additionalProperties": false
|
|
9182
|
+
},
|
|
9183
|
+
"tags": {
|
|
9184
|
+
"type": "object",
|
|
9185
|
+
"additionalProperties": {
|
|
9186
|
+
"type": "object",
|
|
9187
|
+
"properties": {
|
|
9188
|
+
"title": {
|
|
9189
|
+
"type": "string",
|
|
9190
|
+
"maxLength": 64,
|
|
9191
|
+
"description": "Title of the tag"
|
|
9192
|
+
},
|
|
9193
|
+
"description": {
|
|
9194
|
+
"type": "string",
|
|
9195
|
+
"maxLength": 256,
|
|
9196
|
+
"description": "Description of the tag"
|
|
9197
|
+
}
|
|
9198
|
+
},
|
|
9199
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9200
|
+
"additionalProperties": false
|
|
9201
|
+
}
|
|
9202
|
+
}
|
|
9203
|
+
},
|
|
9204
|
+
"additionalProperties": false
|
|
9205
|
+
},
|
|
9206
|
+
"interfaces": {
|
|
9207
|
+
"type": "object",
|
|
9208
|
+
"additionalProperties": {
|
|
9209
|
+
"type": "object",
|
|
9210
|
+
"properties": {
|
|
9211
|
+
"id": {
|
|
9212
|
+
"type": "string",
|
|
9213
|
+
"minLength": 28,
|
|
9214
|
+
"maxLength": 36,
|
|
9215
|
+
"description": "ID of the interface"
|
|
9216
|
+
},
|
|
9217
|
+
"entities": {
|
|
9218
|
+
"type": "object",
|
|
9219
|
+
"additionalProperties": {
|
|
9220
|
+
"type": "object",
|
|
9221
|
+
"properties": {
|
|
9222
|
+
"name": {
|
|
9223
|
+
"type": "string",
|
|
9224
|
+
"maxLength": 200
|
|
9225
|
+
}
|
|
9226
|
+
},
|
|
9227
|
+
"required": [
|
|
9228
|
+
"name"
|
|
9229
|
+
],
|
|
9230
|
+
"additionalProperties": false
|
|
9231
|
+
}
|
|
9232
|
+
},
|
|
9233
|
+
"actions": {
|
|
9234
|
+
"type": "object",
|
|
9235
|
+
"additionalProperties": {
|
|
9236
|
+
"type": "object",
|
|
9237
|
+
"properties": {
|
|
9238
|
+
"name": {
|
|
9239
|
+
"type": "string",
|
|
9240
|
+
"maxLength": 200
|
|
9241
|
+
}
|
|
9242
|
+
},
|
|
9243
|
+
"required": [
|
|
9244
|
+
"name"
|
|
9245
|
+
],
|
|
9246
|
+
"additionalProperties": false
|
|
9247
|
+
}
|
|
9248
|
+
},
|
|
9249
|
+
"events": {
|
|
9250
|
+
"type": "object",
|
|
9251
|
+
"additionalProperties": {
|
|
9252
|
+
"type": "object",
|
|
9253
|
+
"properties": {
|
|
9254
|
+
"name": {
|
|
9255
|
+
"type": "string",
|
|
9256
|
+
"maxLength": 200
|
|
9257
|
+
}
|
|
9258
|
+
},
|
|
9259
|
+
"required": [
|
|
9260
|
+
"name"
|
|
9261
|
+
],
|
|
9262
|
+
"additionalProperties": false
|
|
9263
|
+
}
|
|
9264
|
+
},
|
|
9265
|
+
"channels": {
|
|
9266
|
+
"type": "object",
|
|
9267
|
+
"additionalProperties": {
|
|
9268
|
+
"type": "object",
|
|
9269
|
+
"properties": {
|
|
9270
|
+
"name": {
|
|
9271
|
+
"type": "string",
|
|
9272
|
+
"maxLength": 200
|
|
9273
|
+
}
|
|
9274
|
+
},
|
|
9275
|
+
"required": [
|
|
9276
|
+
"name"
|
|
9277
|
+
],
|
|
9278
|
+
"additionalProperties": false
|
|
9279
|
+
}
|
|
9280
|
+
}
|
|
9281
|
+
},
|
|
9282
|
+
"required": [
|
|
9283
|
+
"id"
|
|
9284
|
+
],
|
|
9285
|
+
"additionalProperties": false
|
|
9286
|
+
}
|
|
9287
|
+
},
|
|
9288
|
+
"secrets": {
|
|
9289
|
+
"type": "object",
|
|
9290
|
+
"additionalProperties": {
|
|
9291
|
+
"type": "string",
|
|
9292
|
+
"maxLength": 20000
|
|
9293
|
+
},
|
|
9294
|
+
"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."
|
|
9295
|
+
},
|
|
9296
|
+
"code": {
|
|
9297
|
+
"type": "string",
|
|
9298
|
+
"description": "JavaScript code of the integration"
|
|
9299
|
+
},
|
|
9300
|
+
"url": {
|
|
9301
|
+
"type": "string",
|
|
9302
|
+
"description": "URL of the integration"
|
|
9303
|
+
},
|
|
9304
|
+
"dev": {
|
|
9305
|
+
"type": "boolean",
|
|
9306
|
+
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
9307
|
+
},
|
|
9308
|
+
"icon": {
|
|
9309
|
+
"type": "string",
|
|
9310
|
+
"description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
|
|
9311
|
+
},
|
|
9312
|
+
"readme": {
|
|
9313
|
+
"type": "string",
|
|
9314
|
+
"description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
|
|
9315
|
+
},
|
|
9316
|
+
"title": {
|
|
9317
|
+
"type": "string",
|
|
9318
|
+
"minLength": 1,
|
|
9319
|
+
"maxLength": 64,
|
|
9320
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
9321
|
+
},
|
|
9322
|
+
"description": {
|
|
9323
|
+
"type": "string",
|
|
9324
|
+
"maxLength": 256,
|
|
9325
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
9326
|
+
},
|
|
9327
|
+
"public": {
|
|
9328
|
+
"type": "boolean",
|
|
9329
|
+
"description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
9330
|
+
},
|
|
9331
|
+
"layers": {
|
|
9332
|
+
"type": "array",
|
|
9333
|
+
"items": {
|
|
9334
|
+
"type": "string"
|
|
9335
|
+
}
|
|
9336
|
+
}
|
|
9337
|
+
},
|
|
9338
|
+
"required": [
|
|
9339
|
+
"name",
|
|
9340
|
+
"version"
|
|
9341
|
+
],
|
|
9342
|
+
"title": "validateIntegrationCreationBody",
|
|
9343
|
+
"additionalProperties": false
|
|
9344
|
+
}
|
|
9345
|
+
},
|
|
9346
|
+
"response": {
|
|
9347
|
+
"description": "Validation succeeded: the integration can be created using the same parameters",
|
|
9348
|
+
"schema": {
|
|
9349
|
+
"type": "object",
|
|
9350
|
+
"title": "validateIntegrationCreationResponse",
|
|
9351
|
+
"additionalProperties": false
|
|
9352
|
+
}
|
|
9353
|
+
},
|
|
9354
|
+
"parameters": {}
|
|
9355
|
+
},
|
|
8799
9356
|
"updateIntegration": {
|
|
8800
9357
|
"name": "updateIntegration",
|
|
8801
9358
|
"description": "Update integration",
|
|
8802
9359
|
"method": "put",
|
|
8803
|
-
"path": "/v1/admin/integrations/{id}",
|
|
9360
|
+
"path": "/v1/admin/integrations/{id}",
|
|
9361
|
+
"section": "integration",
|
|
9362
|
+
"parameters": {
|
|
9363
|
+
"id": {
|
|
9364
|
+
"type": "string",
|
|
9365
|
+
"description": "Integration ID",
|
|
9366
|
+
"in": "path"
|
|
9367
|
+
}
|
|
9368
|
+
},
|
|
9369
|
+
"requestBody": {
|
|
9370
|
+
"description": "Integration",
|
|
9371
|
+
"schema": {
|
|
9372
|
+
"type": "object",
|
|
9373
|
+
"properties": {
|
|
9374
|
+
"configuration": {
|
|
9375
|
+
"type": "object",
|
|
9376
|
+
"properties": {
|
|
9377
|
+
"title": {
|
|
9378
|
+
"type": "string",
|
|
9379
|
+
"maxLength": 64,
|
|
9380
|
+
"description": "Title of the configuration"
|
|
9381
|
+
},
|
|
9382
|
+
"description": {
|
|
9383
|
+
"type": "string",
|
|
9384
|
+
"maxLength": 256,
|
|
9385
|
+
"description": "Description of the configuration"
|
|
9386
|
+
},
|
|
9387
|
+
"schema": {
|
|
9388
|
+
"type": "object",
|
|
9389
|
+
"additionalProperties": true,
|
|
9390
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
9391
|
+
},
|
|
9392
|
+
"identifier": {
|
|
9393
|
+
"type": "object",
|
|
9394
|
+
"properties": {
|
|
9395
|
+
"linkTemplateScript": {
|
|
9396
|
+
"type": "string",
|
|
9397
|
+
"maxLength": 2000,
|
|
9398
|
+
"nullable": true
|
|
9399
|
+
},
|
|
9400
|
+
"required": {
|
|
9401
|
+
"type": "boolean"
|
|
9402
|
+
}
|
|
9403
|
+
},
|
|
9404
|
+
"additionalProperties": false
|
|
9405
|
+
}
|
|
9406
|
+
},
|
|
9407
|
+
"description": "Default configuration definition of the integration",
|
|
9408
|
+
"additionalProperties": false
|
|
9409
|
+
},
|
|
9410
|
+
"configurations": {
|
|
9411
|
+
"type": "object",
|
|
9412
|
+
"additionalProperties": {
|
|
9413
|
+
"type": "object",
|
|
9414
|
+
"properties": {
|
|
9415
|
+
"title": {
|
|
9416
|
+
"type": "string",
|
|
9417
|
+
"maxLength": 64,
|
|
9418
|
+
"description": "Title of the configuration"
|
|
9419
|
+
},
|
|
9420
|
+
"description": {
|
|
9421
|
+
"type": "string",
|
|
9422
|
+
"maxLength": 256,
|
|
9423
|
+
"description": "Description of the configuration"
|
|
9424
|
+
},
|
|
9425
|
+
"schema": {
|
|
9426
|
+
"type": "object",
|
|
9427
|
+
"additionalProperties": true,
|
|
9428
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
9429
|
+
},
|
|
9430
|
+
"identifier": {
|
|
9431
|
+
"type": "object",
|
|
9432
|
+
"properties": {
|
|
9433
|
+
"linkTemplateScript": {
|
|
9434
|
+
"type": "string",
|
|
9435
|
+
"maxLength": 2000,
|
|
9436
|
+
"nullable": true
|
|
9437
|
+
},
|
|
9438
|
+
"required": {
|
|
9439
|
+
"type": "boolean"
|
|
9440
|
+
}
|
|
9441
|
+
},
|
|
9442
|
+
"additionalProperties": false
|
|
9443
|
+
}
|
|
9444
|
+
},
|
|
9445
|
+
"nullable": true,
|
|
9446
|
+
"additionalProperties": false
|
|
9447
|
+
},
|
|
9448
|
+
"description": "Additional configuration definitions of the integration"
|
|
9449
|
+
},
|
|
9450
|
+
"channels": {
|
|
9451
|
+
"type": "object",
|
|
9452
|
+
"additionalProperties": {
|
|
9453
|
+
"type": "object",
|
|
9454
|
+
"properties": {
|
|
9455
|
+
"title": {
|
|
9456
|
+
"type": "string",
|
|
9457
|
+
"maxLength": 64,
|
|
9458
|
+
"description": "Title of the channel"
|
|
9459
|
+
},
|
|
9460
|
+
"description": {
|
|
9461
|
+
"type": "string",
|
|
9462
|
+
"maxLength": 256,
|
|
9463
|
+
"description": "Description of the channel"
|
|
9464
|
+
},
|
|
9465
|
+
"messages": {
|
|
9466
|
+
"type": "object",
|
|
9467
|
+
"additionalProperties": {
|
|
9468
|
+
"type": "object",
|
|
9469
|
+
"properties": {
|
|
9470
|
+
"schema": {
|
|
9471
|
+
"type": "object",
|
|
9472
|
+
"additionalProperties": true
|
|
9473
|
+
}
|
|
9474
|
+
},
|
|
9475
|
+
"required": [
|
|
9476
|
+
"schema"
|
|
9477
|
+
],
|
|
9478
|
+
"description": "Message definition",
|
|
9479
|
+
"nullable": true,
|
|
9480
|
+
"additionalProperties": false
|
|
9481
|
+
}
|
|
9482
|
+
},
|
|
9483
|
+
"conversation": {
|
|
9484
|
+
"type": "object",
|
|
9485
|
+
"properties": {
|
|
9486
|
+
"creation": {
|
|
9487
|
+
"type": "object",
|
|
9488
|
+
"properties": {
|
|
9489
|
+
"enabled": {
|
|
9490
|
+
"type": "boolean",
|
|
9491
|
+
"description": "Enable conversation creation"
|
|
9492
|
+
},
|
|
9493
|
+
"requiredTags": {
|
|
9494
|
+
"type": "array",
|
|
9495
|
+
"items": {
|
|
9496
|
+
"type": "string"
|
|
9497
|
+
},
|
|
9498
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
9499
|
+
}
|
|
9500
|
+
},
|
|
9501
|
+
"required": [
|
|
9502
|
+
"enabled",
|
|
9503
|
+
"requiredTags"
|
|
9504
|
+
],
|
|
9505
|
+
"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.",
|
|
9506
|
+
"additionalProperties": false
|
|
9507
|
+
},
|
|
9508
|
+
"tags": {
|
|
9509
|
+
"type": "object",
|
|
9510
|
+
"additionalProperties": {
|
|
9511
|
+
"type": "object",
|
|
9512
|
+
"properties": {
|
|
9513
|
+
"title": {
|
|
9514
|
+
"type": "string",
|
|
9515
|
+
"maxLength": 64,
|
|
9516
|
+
"description": "Title of the tag"
|
|
9517
|
+
},
|
|
9518
|
+
"description": {
|
|
9519
|
+
"type": "string",
|
|
9520
|
+
"maxLength": 256,
|
|
9521
|
+
"description": "Description of the tag"
|
|
9522
|
+
}
|
|
9523
|
+
},
|
|
9524
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9525
|
+
"nullable": true,
|
|
9526
|
+
"additionalProperties": false
|
|
9527
|
+
}
|
|
9528
|
+
}
|
|
9529
|
+
},
|
|
9530
|
+
"additionalProperties": false
|
|
9531
|
+
},
|
|
9532
|
+
"message": {
|
|
9533
|
+
"type": "object",
|
|
9534
|
+
"properties": {
|
|
9535
|
+
"tags": {
|
|
9536
|
+
"type": "object",
|
|
9537
|
+
"additionalProperties": {
|
|
9538
|
+
"type": "object",
|
|
9539
|
+
"properties": {
|
|
9540
|
+
"title": {
|
|
9541
|
+
"type": "string",
|
|
9542
|
+
"maxLength": 64,
|
|
9543
|
+
"description": "Title of the tag"
|
|
9544
|
+
},
|
|
9545
|
+
"description": {
|
|
9546
|
+
"type": "string",
|
|
9547
|
+
"maxLength": 256,
|
|
9548
|
+
"description": "Description of the tag"
|
|
9549
|
+
}
|
|
9550
|
+
},
|
|
9551
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9552
|
+
"nullable": true,
|
|
9553
|
+
"additionalProperties": false
|
|
9554
|
+
}
|
|
9555
|
+
}
|
|
9556
|
+
},
|
|
9557
|
+
"additionalProperties": false
|
|
9558
|
+
}
|
|
9559
|
+
},
|
|
9560
|
+
"nullable": true,
|
|
9561
|
+
"additionalProperties": false
|
|
9562
|
+
}
|
|
9563
|
+
},
|
|
9564
|
+
"identifier": {
|
|
9565
|
+
"type": "object",
|
|
9566
|
+
"properties": {
|
|
9567
|
+
"extractScript": {
|
|
9568
|
+
"type": "string",
|
|
9569
|
+
"maxLength": 2000,
|
|
9570
|
+
"nullable": true
|
|
9571
|
+
},
|
|
9572
|
+
"fallbackHandlerScript": {
|
|
9573
|
+
"type": "string",
|
|
9574
|
+
"maxLength": 2000,
|
|
9575
|
+
"nullable": true
|
|
9576
|
+
}
|
|
9577
|
+
},
|
|
9578
|
+
"additionalProperties": false
|
|
9579
|
+
},
|
|
9580
|
+
"actions": {
|
|
9581
|
+
"type": "object",
|
|
9582
|
+
"additionalProperties": {
|
|
9583
|
+
"type": "object",
|
|
9584
|
+
"properties": {
|
|
9585
|
+
"title": {
|
|
9586
|
+
"type": "string",
|
|
9587
|
+
"maxLength": 64,
|
|
9588
|
+
"description": "Title of the action"
|
|
9589
|
+
},
|
|
9590
|
+
"description": {
|
|
9591
|
+
"type": "string",
|
|
9592
|
+
"maxLength": 256,
|
|
9593
|
+
"description": "Description of the action"
|
|
9594
|
+
},
|
|
9595
|
+
"billable": {
|
|
9596
|
+
"type": "boolean"
|
|
9597
|
+
},
|
|
9598
|
+
"cacheable": {
|
|
9599
|
+
"type": "boolean"
|
|
9600
|
+
},
|
|
9601
|
+
"input": {
|
|
9602
|
+
"type": "object",
|
|
9603
|
+
"properties": {
|
|
9604
|
+
"schema": {
|
|
9605
|
+
"type": "object",
|
|
9606
|
+
"additionalProperties": true
|
|
9607
|
+
}
|
|
9608
|
+
},
|
|
9609
|
+
"required": [
|
|
9610
|
+
"schema"
|
|
9611
|
+
],
|
|
9612
|
+
"additionalProperties": false
|
|
9613
|
+
},
|
|
9614
|
+
"output": {
|
|
9615
|
+
"type": "object",
|
|
9616
|
+
"properties": {
|
|
9617
|
+
"schema": {
|
|
9618
|
+
"type": "object",
|
|
9619
|
+
"additionalProperties": true
|
|
9620
|
+
}
|
|
9621
|
+
},
|
|
9622
|
+
"required": [
|
|
9623
|
+
"schema"
|
|
9624
|
+
],
|
|
9625
|
+
"additionalProperties": false
|
|
9626
|
+
}
|
|
9627
|
+
},
|
|
9628
|
+
"required": [
|
|
9629
|
+
"input",
|
|
9630
|
+
"output"
|
|
9631
|
+
],
|
|
9632
|
+
"description": "Action definition",
|
|
9633
|
+
"nullable": true,
|
|
9634
|
+
"additionalProperties": false
|
|
9635
|
+
}
|
|
9636
|
+
},
|
|
9637
|
+
"events": {
|
|
9638
|
+
"type": "object",
|
|
9639
|
+
"additionalProperties": {
|
|
9640
|
+
"type": "object",
|
|
9641
|
+
"properties": {
|
|
9642
|
+
"title": {
|
|
9643
|
+
"type": "string",
|
|
9644
|
+
"maxLength": 64,
|
|
9645
|
+
"description": "Title of the event"
|
|
9646
|
+
},
|
|
9647
|
+
"description": {
|
|
9648
|
+
"type": "string",
|
|
9649
|
+
"maxLength": 256,
|
|
9650
|
+
"description": "Description of the event"
|
|
9651
|
+
},
|
|
9652
|
+
"schema": {
|
|
9653
|
+
"type": "object",
|
|
9654
|
+
"additionalProperties": true
|
|
9655
|
+
}
|
|
9656
|
+
},
|
|
9657
|
+
"required": [
|
|
9658
|
+
"schema"
|
|
9659
|
+
],
|
|
9660
|
+
"description": "Event Definition",
|
|
9661
|
+
"nullable": true,
|
|
9662
|
+
"additionalProperties": false
|
|
9663
|
+
}
|
|
9664
|
+
},
|
|
9665
|
+
"states": {
|
|
9666
|
+
"type": "object",
|
|
9667
|
+
"additionalProperties": {
|
|
9668
|
+
"type": "object",
|
|
9669
|
+
"properties": {
|
|
9670
|
+
"type": {
|
|
9671
|
+
"type": "string",
|
|
9672
|
+
"enum": [
|
|
9673
|
+
"conversation",
|
|
9674
|
+
"user",
|
|
9675
|
+
"integration"
|
|
9676
|
+
],
|
|
9677
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
9678
|
+
},
|
|
9679
|
+
"schema": {
|
|
9680
|
+
"type": "object",
|
|
9681
|
+
"additionalProperties": true,
|
|
9682
|
+
"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."
|
|
9683
|
+
}
|
|
9684
|
+
},
|
|
9685
|
+
"required": [
|
|
9686
|
+
"type",
|
|
9687
|
+
"schema"
|
|
9688
|
+
],
|
|
9689
|
+
"description": "State definition",
|
|
9690
|
+
"nullable": true,
|
|
9691
|
+
"additionalProperties": false
|
|
9692
|
+
}
|
|
9693
|
+
},
|
|
9694
|
+
"user": {
|
|
9695
|
+
"type": "object",
|
|
9696
|
+
"properties": {
|
|
9697
|
+
"creation": {
|
|
9698
|
+
"type": "object",
|
|
9699
|
+
"properties": {
|
|
9700
|
+
"enabled": {
|
|
9701
|
+
"type": "boolean",
|
|
9702
|
+
"description": "Enable user creation"
|
|
9703
|
+
},
|
|
9704
|
+
"requiredTags": {
|
|
9705
|
+
"type": "array",
|
|
9706
|
+
"items": {
|
|
9707
|
+
"type": "string"
|
|
9708
|
+
},
|
|
9709
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
9710
|
+
}
|
|
9711
|
+
},
|
|
9712
|
+
"required": [
|
|
9713
|
+
"enabled",
|
|
9714
|
+
"requiredTags"
|
|
9715
|
+
],
|
|
9716
|
+
"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.",
|
|
9717
|
+
"additionalProperties": false
|
|
9718
|
+
},
|
|
9719
|
+
"tags": {
|
|
9720
|
+
"type": "object",
|
|
9721
|
+
"additionalProperties": {
|
|
9722
|
+
"type": "object",
|
|
9723
|
+
"properties": {
|
|
9724
|
+
"title": {
|
|
9725
|
+
"type": "string",
|
|
9726
|
+
"maxLength": 64,
|
|
9727
|
+
"description": "Title of the tag"
|
|
9728
|
+
},
|
|
9729
|
+
"description": {
|
|
9730
|
+
"type": "string",
|
|
9731
|
+
"maxLength": 256,
|
|
9732
|
+
"description": "Description of the tag"
|
|
9733
|
+
}
|
|
9734
|
+
},
|
|
9735
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
9736
|
+
"nullable": true,
|
|
9737
|
+
"additionalProperties": false
|
|
9738
|
+
}
|
|
9739
|
+
}
|
|
9740
|
+
},
|
|
9741
|
+
"additionalProperties": false
|
|
9742
|
+
},
|
|
9743
|
+
"entities": {
|
|
9744
|
+
"type": "object",
|
|
9745
|
+
"additionalProperties": {
|
|
9746
|
+
"type": "object",
|
|
9747
|
+
"properties": {
|
|
9748
|
+
"title": {
|
|
9749
|
+
"type": "string",
|
|
9750
|
+
"maxLength": 64,
|
|
9751
|
+
"description": "Title of the entity"
|
|
9752
|
+
},
|
|
9753
|
+
"description": {
|
|
9754
|
+
"type": "string",
|
|
9755
|
+
"maxLength": 256,
|
|
9756
|
+
"description": "Description of the entity"
|
|
9757
|
+
},
|
|
9758
|
+
"schema": {
|
|
9759
|
+
"type": "object",
|
|
9760
|
+
"additionalProperties": true
|
|
9761
|
+
}
|
|
9762
|
+
},
|
|
9763
|
+
"required": [
|
|
9764
|
+
"schema"
|
|
9765
|
+
],
|
|
9766
|
+
"description": "Entity definition",
|
|
9767
|
+
"nullable": true,
|
|
9768
|
+
"additionalProperties": false
|
|
9769
|
+
}
|
|
9770
|
+
},
|
|
9771
|
+
"interfaces": {
|
|
9772
|
+
"type": "object",
|
|
9773
|
+
"additionalProperties": {
|
|
9774
|
+
"type": "object",
|
|
9775
|
+
"properties": {
|
|
9776
|
+
"id": {
|
|
9777
|
+
"type": "string",
|
|
9778
|
+
"minLength": 28,
|
|
9779
|
+
"maxLength": 36,
|
|
9780
|
+
"description": "ID of the interface"
|
|
9781
|
+
},
|
|
9782
|
+
"entities": {
|
|
9783
|
+
"type": "object",
|
|
9784
|
+
"additionalProperties": {
|
|
9785
|
+
"type": "object",
|
|
9786
|
+
"properties": {
|
|
9787
|
+
"name": {
|
|
9788
|
+
"type": "string",
|
|
9789
|
+
"maxLength": 200
|
|
9790
|
+
}
|
|
9791
|
+
},
|
|
9792
|
+
"required": [
|
|
9793
|
+
"name"
|
|
9794
|
+
],
|
|
9795
|
+
"additionalProperties": false
|
|
9796
|
+
}
|
|
9797
|
+
},
|
|
9798
|
+
"actions": {
|
|
9799
|
+
"type": "object",
|
|
9800
|
+
"additionalProperties": {
|
|
9801
|
+
"type": "object",
|
|
9802
|
+
"properties": {
|
|
9803
|
+
"name": {
|
|
9804
|
+
"type": "string",
|
|
9805
|
+
"maxLength": 200
|
|
9806
|
+
}
|
|
9807
|
+
},
|
|
9808
|
+
"required": [
|
|
9809
|
+
"name"
|
|
9810
|
+
],
|
|
9811
|
+
"additionalProperties": false
|
|
9812
|
+
}
|
|
9813
|
+
},
|
|
9814
|
+
"events": {
|
|
9815
|
+
"type": "object",
|
|
9816
|
+
"additionalProperties": {
|
|
9817
|
+
"type": "object",
|
|
9818
|
+
"properties": {
|
|
9819
|
+
"name": {
|
|
9820
|
+
"type": "string",
|
|
9821
|
+
"maxLength": 200
|
|
9822
|
+
}
|
|
9823
|
+
},
|
|
9824
|
+
"required": [
|
|
9825
|
+
"name"
|
|
9826
|
+
],
|
|
9827
|
+
"additionalProperties": false
|
|
9828
|
+
}
|
|
9829
|
+
},
|
|
9830
|
+
"channels": {
|
|
9831
|
+
"type": "object",
|
|
9832
|
+
"additionalProperties": {
|
|
9833
|
+
"type": "object",
|
|
9834
|
+
"properties": {
|
|
9835
|
+
"name": {
|
|
9836
|
+
"type": "string",
|
|
9837
|
+
"maxLength": 200
|
|
9838
|
+
}
|
|
9839
|
+
},
|
|
9840
|
+
"required": [
|
|
9841
|
+
"name"
|
|
9842
|
+
],
|
|
9843
|
+
"additionalProperties": false
|
|
9844
|
+
}
|
|
9845
|
+
}
|
|
9846
|
+
},
|
|
9847
|
+
"required": [
|
|
9848
|
+
"id"
|
|
9849
|
+
],
|
|
9850
|
+
"nullable": true,
|
|
9851
|
+
"additionalProperties": false
|
|
9852
|
+
}
|
|
9853
|
+
},
|
|
9854
|
+
"secrets": {
|
|
9855
|
+
"type": "object",
|
|
9856
|
+
"additionalProperties": {
|
|
9857
|
+
"type": "string",
|
|
9858
|
+
"maxLength": 20000,
|
|
9859
|
+
"nullable": true
|
|
9860
|
+
},
|
|
9861
|
+
"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."
|
|
9862
|
+
},
|
|
9863
|
+
"code": {
|
|
9864
|
+
"type": "string",
|
|
9865
|
+
"description": "JavaScript code of the integration"
|
|
9866
|
+
},
|
|
9867
|
+
"icon": {
|
|
9868
|
+
"type": "string",
|
|
9869
|
+
"description": "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
|
|
9870
|
+
},
|
|
9871
|
+
"readme": {
|
|
9872
|
+
"type": "string",
|
|
9873
|
+
"description": "Base64 encoded markdown of the integration readme. The readme is specific to each integration versions."
|
|
9874
|
+
},
|
|
9875
|
+
"title": {
|
|
9876
|
+
"type": "string",
|
|
9877
|
+
"minLength": 1,
|
|
9878
|
+
"maxLength": 64,
|
|
9879
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
9880
|
+
},
|
|
9881
|
+
"description": {
|
|
9882
|
+
"type": "string",
|
|
9883
|
+
"maxLength": 256,
|
|
9884
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
9885
|
+
},
|
|
9886
|
+
"url": {
|
|
9887
|
+
"type": "string",
|
|
9888
|
+
"description": "URL of the integration",
|
|
9889
|
+
"nullable": true
|
|
9890
|
+
},
|
|
9891
|
+
"public": {
|
|
9892
|
+
"type": "boolean",
|
|
9893
|
+
"description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
|
|
9894
|
+
},
|
|
9895
|
+
"layers": {
|
|
9896
|
+
"type": "array",
|
|
9897
|
+
"items": {
|
|
9898
|
+
"type": "string"
|
|
9899
|
+
}
|
|
9900
|
+
}
|
|
9901
|
+
},
|
|
9902
|
+
"title": "updateIntegrationBody",
|
|
9903
|
+
"additionalProperties": false
|
|
9904
|
+
}
|
|
9905
|
+
},
|
|
9906
|
+
"response": {
|
|
9907
|
+
"description": "Success",
|
|
9908
|
+
"schema": {
|
|
9909
|
+
"type": "object",
|
|
9910
|
+
"properties": {
|
|
9911
|
+
"integration": {
|
|
9912
|
+
"$ref": "#/components/schemas/Integration"
|
|
9913
|
+
}
|
|
9914
|
+
},
|
|
9915
|
+
"required": [
|
|
9916
|
+
"integration"
|
|
9917
|
+
],
|
|
9918
|
+
"title": "updateIntegrationResponse",
|
|
9919
|
+
"additionalProperties": false
|
|
9920
|
+
}
|
|
9921
|
+
}
|
|
9922
|
+
},
|
|
9923
|
+
"validateIntegrationUpdate": {
|
|
9924
|
+
"name": "validateIntegrationUpdate",
|
|
9925
|
+
"description": "Perform a validation of an integration update request",
|
|
9926
|
+
"method": "put",
|
|
9927
|
+
"path": "/v1/admin/integrations/{id}/validate",
|
|
8804
9928
|
"section": "integration",
|
|
8805
9929
|
"parameters": {
|
|
8806
9930
|
"id": {
|
|
@@ -9342,23 +10466,15 @@ export const state = {
|
|
|
9342
10466
|
}
|
|
9343
10467
|
}
|
|
9344
10468
|
},
|
|
9345
|
-
"title": "
|
|
10469
|
+
"title": "validateIntegrationUpdateBody",
|
|
9346
10470
|
"additionalProperties": false
|
|
9347
10471
|
}
|
|
9348
10472
|
},
|
|
9349
10473
|
"response": {
|
|
9350
|
-
"description": "
|
|
10474
|
+
"description": "Validation succeeded: the integration can be updated using the same parameters",
|
|
9351
10475
|
"schema": {
|
|
9352
10476
|
"type": "object",
|
|
9353
|
-
"
|
|
9354
|
-
"integration": {
|
|
9355
|
-
"$ref": "#/components/schemas/Integration"
|
|
9356
|
-
}
|
|
9357
|
-
},
|
|
9358
|
-
"required": [
|
|
9359
|
-
"integration"
|
|
9360
|
-
],
|
|
9361
|
-
"title": "updateIntegrationResponse",
|
|
10477
|
+
"title": "validateIntegrationUpdateResponse",
|
|
9362
10478
|
"additionalProperties": false
|
|
9363
10479
|
}
|
|
9364
10480
|
}
|
|
@@ -14141,7 +15257,7 @@ export const state = {
|
|
|
14141
15257
|
"title": "Botpress API",
|
|
14142
15258
|
"description": "API for Botpress Cloud",
|
|
14143
15259
|
"server": "https://api.botpress.cloud",
|
|
14144
|
-
"version": "0.
|
|
15260
|
+
"version": "0.70.0",
|
|
14145
15261
|
"prefix": "v1"
|
|
14146
15262
|
},
|
|
14147
15263
|
"errors": [
|
|
@@ -14309,7 +15425,9 @@ export const state = {
|
|
|
14309
15425
|
"updateWorkspaceMemberBody": true,
|
|
14310
15426
|
"createIntegrationApiKeyBody": true,
|
|
14311
15427
|
"createIntegrationBody": true,
|
|
15428
|
+
"validateIntegrationCreationBody": true,
|
|
14312
15429
|
"updateIntegrationBody": true,
|
|
15430
|
+
"validateIntegrationUpdateBody": true,
|
|
14313
15431
|
"requestIntegrationVerificationBody": true,
|
|
14314
15432
|
"createInterfaceBody": true,
|
|
14315
15433
|
"updateInterfaceBody": true,
|
|
@@ -14432,7 +15550,9 @@ export const state = {
|
|
|
14432
15550
|
"createIntegrationApiKeyResponse": true,
|
|
14433
15551
|
"deleteIntegrationApiKeyResponse": true,
|
|
14434
15552
|
"createIntegrationResponse": true,
|
|
15553
|
+
"validateIntegrationCreationResponse": true,
|
|
14435
15554
|
"updateIntegrationResponse": true,
|
|
15555
|
+
"validateIntegrationUpdateResponse": true,
|
|
14436
15556
|
"listIntegrationsResponse": true,
|
|
14437
15557
|
"getIntegrationResponse": true,
|
|
14438
15558
|
"getIntegrationLogsResponse": true,
|
|
@@ -17845,7 +18965,9 @@ export const state = {
|
|
|
17845
18965
|
"createIntegrationApiKey",
|
|
17846
18966
|
"deleteIntegrationApiKey",
|
|
17847
18967
|
"createIntegration",
|
|
18968
|
+
"validateIntegrationCreation",
|
|
17848
18969
|
"updateIntegration",
|
|
18970
|
+
"validateIntegrationUpdate",
|
|
17849
18971
|
"listIntegrations",
|
|
17850
18972
|
"getIntegration",
|
|
17851
18973
|
"getIntegrationLogs",
|