@botpress/api 1.64.0 → 1.67.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 +618 -8
- package/dist/src/gen/runtime/state.d.ts +289 -0
- package/dist/src/gen/state.d.ts +251 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -276890,6 +276890,324 @@ var state = {
|
|
|
276890
276890
|
"documented"
|
|
276891
276891
|
]
|
|
276892
276892
|
},
|
|
276893
|
+
"initializeIncomingMessage": {
|
|
276894
|
+
"name": "initializeIncomingMessage",
|
|
276895
|
+
"description": "Initializes a user, conversation and sends a message to the conversation.",
|
|
276896
|
+
"method": "post",
|
|
276897
|
+
"path": "/v1/chat/initialize-incoming-message",
|
|
276898
|
+
"parameters": {
|
|
276899
|
+
"x-bot-id": {
|
|
276900
|
+
"in": "header",
|
|
276901
|
+
"description": "Bot id",
|
|
276902
|
+
"type": "string",
|
|
276903
|
+
"required": true
|
|
276904
|
+
},
|
|
276905
|
+
"x-integration-id": {
|
|
276906
|
+
"in": "header",
|
|
276907
|
+
"description": "Integration id",
|
|
276908
|
+
"type": "string",
|
|
276909
|
+
"required": false
|
|
276910
|
+
},
|
|
276911
|
+
"x-integration-alias": {
|
|
276912
|
+
"in": "header",
|
|
276913
|
+
"description": "Integration alias",
|
|
276914
|
+
"type": "string",
|
|
276915
|
+
"required": false
|
|
276916
|
+
}
|
|
276917
|
+
},
|
|
276918
|
+
"section": "message",
|
|
276919
|
+
"requestBody": {
|
|
276920
|
+
"description": "Message data with related conversation and user",
|
|
276921
|
+
"schema": {
|
|
276922
|
+
"type": "object",
|
|
276923
|
+
"properties": {
|
|
276924
|
+
"userId": {
|
|
276925
|
+
"type": "string"
|
|
276926
|
+
},
|
|
276927
|
+
"user": {
|
|
276928
|
+
"type": "object",
|
|
276929
|
+
"properties": {
|
|
276930
|
+
"tags": {
|
|
276931
|
+
"type": "object",
|
|
276932
|
+
"additionalProperties": {
|
|
276933
|
+
"type": "string",
|
|
276934
|
+
"maxLength": 500
|
|
276935
|
+
},
|
|
276936
|
+
"description": "Tags for the [User](#schema_user)"
|
|
276937
|
+
},
|
|
276938
|
+
"integrationName": {
|
|
276939
|
+
"type": "string",
|
|
276940
|
+
"maxLength": 200,
|
|
276941
|
+
"description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
|
|
276942
|
+
"deprecated": true
|
|
276943
|
+
},
|
|
276944
|
+
"name": {
|
|
276945
|
+
"type": "string",
|
|
276946
|
+
"maxLength": 200,
|
|
276947
|
+
"description": "Name of the user"
|
|
276948
|
+
},
|
|
276949
|
+
"pictureUrl": {
|
|
276950
|
+
"type": "string",
|
|
276951
|
+
"maxLength": 4e4,
|
|
276952
|
+
"description": "URI of the user picture"
|
|
276953
|
+
},
|
|
276954
|
+
"discriminateByTags": {
|
|
276955
|
+
"type": "array",
|
|
276956
|
+
"items": {
|
|
276957
|
+
"type": "string",
|
|
276958
|
+
"maxLength": 500
|
|
276959
|
+
},
|
|
276960
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
276961
|
+
}
|
|
276962
|
+
},
|
|
276963
|
+
"required": [
|
|
276964
|
+
"tags",
|
|
276965
|
+
"discriminateByTags"
|
|
276966
|
+
],
|
|
276967
|
+
"additionalProperties": false
|
|
276968
|
+
},
|
|
276969
|
+
"conversationId": {
|
|
276970
|
+
"type": "string"
|
|
276971
|
+
},
|
|
276972
|
+
"conversation": {
|
|
276973
|
+
"type": "object",
|
|
276974
|
+
"properties": {
|
|
276975
|
+
"channel": {
|
|
276976
|
+
"type": "string",
|
|
276977
|
+
"maxLength": 200,
|
|
276978
|
+
"description": "Channel name"
|
|
276979
|
+
},
|
|
276980
|
+
"tags": {
|
|
276981
|
+
"type": "object",
|
|
276982
|
+
"additionalProperties": {
|
|
276983
|
+
"type": "string",
|
|
276984
|
+
"maxLength": 500
|
|
276985
|
+
},
|
|
276986
|
+
"description": "Tags for the [Conversation](#schema_conversation)"
|
|
276987
|
+
},
|
|
276988
|
+
"integrationName": {
|
|
276989
|
+
"type": "string",
|
|
276990
|
+
"maxLength": 200,
|
|
276991
|
+
"description": "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.",
|
|
276992
|
+
"deprecated": true
|
|
276993
|
+
},
|
|
276994
|
+
"discriminateByTags": {
|
|
276995
|
+
"type": "array",
|
|
276996
|
+
"items": {
|
|
276997
|
+
"type": "string",
|
|
276998
|
+
"maxLength": 500
|
|
276999
|
+
},
|
|
277000
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
277001
|
+
}
|
|
277002
|
+
},
|
|
277003
|
+
"required": [
|
|
277004
|
+
"channel",
|
|
277005
|
+
"tags",
|
|
277006
|
+
"discriminateByTags"
|
|
277007
|
+
],
|
|
277008
|
+
"additionalProperties": false
|
|
277009
|
+
},
|
|
277010
|
+
"message": {
|
|
277011
|
+
"type": "object",
|
|
277012
|
+
"properties": {
|
|
277013
|
+
"payload": {
|
|
277014
|
+
"type": "object",
|
|
277015
|
+
"additionalProperties": true,
|
|
277016
|
+
"description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
|
|
277017
|
+
},
|
|
277018
|
+
"type": {
|
|
277019
|
+
"type": "string",
|
|
277020
|
+
"maxLength": 200,
|
|
277021
|
+
"description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
|
|
277022
|
+
},
|
|
277023
|
+
"tags": {
|
|
277024
|
+
"type": "object",
|
|
277025
|
+
"additionalProperties": {
|
|
277026
|
+
"type": "string",
|
|
277027
|
+
"maxLength": 500
|
|
277028
|
+
},
|
|
277029
|
+
"description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
|
|
277030
|
+
},
|
|
277031
|
+
"origin": {
|
|
277032
|
+
"type": "string",
|
|
277033
|
+
"enum": [
|
|
277034
|
+
"synthetic"
|
|
277035
|
+
]
|
|
277036
|
+
},
|
|
277037
|
+
"discriminateByTags": {
|
|
277038
|
+
"type": "array",
|
|
277039
|
+
"items": {
|
|
277040
|
+
"type": "string",
|
|
277041
|
+
"maxLength": 500
|
|
277042
|
+
},
|
|
277043
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
277044
|
+
}
|
|
277045
|
+
},
|
|
277046
|
+
"required": [
|
|
277047
|
+
"payload",
|
|
277048
|
+
"type",
|
|
277049
|
+
"tags",
|
|
277050
|
+
"discriminateByTags"
|
|
277051
|
+
],
|
|
277052
|
+
"additionalProperties": false
|
|
277053
|
+
}
|
|
277054
|
+
},
|
|
277055
|
+
"title": "initializeIncomingMessageBody",
|
|
277056
|
+
"additionalProperties": false
|
|
277057
|
+
}
|
|
277058
|
+
},
|
|
277059
|
+
"response": {
|
|
277060
|
+
"description": "Returns an object containing the user, conversation and message (if created)",
|
|
277061
|
+
"schema": {
|
|
277062
|
+
"type": "object",
|
|
277063
|
+
"properties": {
|
|
277064
|
+
"user": {
|
|
277065
|
+
"$ref": "#/components/schemas/User"
|
|
277066
|
+
},
|
|
277067
|
+
"conversation": {
|
|
277068
|
+
"$ref": "#/components/schemas/Conversation"
|
|
277069
|
+
},
|
|
277070
|
+
"message": {
|
|
277071
|
+
"$ref": "#/components/schemas/Message"
|
|
277072
|
+
}
|
|
277073
|
+
},
|
|
277074
|
+
"required": [
|
|
277075
|
+
"user",
|
|
277076
|
+
"conversation"
|
|
277077
|
+
],
|
|
277078
|
+
"title": "initializeIncomingMessageResponse",
|
|
277079
|
+
"additionalProperties": false
|
|
277080
|
+
}
|
|
277081
|
+
},
|
|
277082
|
+
"tags": [
|
|
277083
|
+
"experimental"
|
|
277084
|
+
]
|
|
277085
|
+
},
|
|
277086
|
+
"importMessages": {
|
|
277087
|
+
"name": "importMessages",
|
|
277088
|
+
"description": "Imports messages if no matching messages already exist. Returns the list of messages that were either created or retrieved.",
|
|
277089
|
+
"method": "post",
|
|
277090
|
+
"path": "/v1/chat/messages/import-messages",
|
|
277091
|
+
"requestBody": {
|
|
277092
|
+
"description": "Data for the list of messages to import",
|
|
277093
|
+
"schema": {
|
|
277094
|
+
"type": "object",
|
|
277095
|
+
"properties": {
|
|
277096
|
+
"messages": {
|
|
277097
|
+
"type": "array",
|
|
277098
|
+
"items": {
|
|
277099
|
+
"type": "object",
|
|
277100
|
+
"properties": {
|
|
277101
|
+
"payload": {
|
|
277102
|
+
"type": "object",
|
|
277103
|
+
"properties": {},
|
|
277104
|
+
"additionalProperties": true,
|
|
277105
|
+
"description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
|
|
277106
|
+
},
|
|
277107
|
+
"userId": {
|
|
277108
|
+
"type": "string",
|
|
277109
|
+
"minLength": 28,
|
|
277110
|
+
"maxLength": 36,
|
|
277111
|
+
"description": "ID of the [User](#schema_user)"
|
|
277112
|
+
},
|
|
277113
|
+
"conversationId": {
|
|
277114
|
+
"type": "string",
|
|
277115
|
+
"minLength": 28,
|
|
277116
|
+
"maxLength": 36,
|
|
277117
|
+
"description": "ID of the [Conversation](#schema_conversation)"
|
|
277118
|
+
},
|
|
277119
|
+
"type": {
|
|
277120
|
+
"type": "string",
|
|
277121
|
+
"maxLength": 200,
|
|
277122
|
+
"description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
|
|
277123
|
+
},
|
|
277124
|
+
"tags": {
|
|
277125
|
+
"type": "object",
|
|
277126
|
+
"additionalProperties": {
|
|
277127
|
+
"type": "string",
|
|
277128
|
+
"maxLength": 500
|
|
277129
|
+
},
|
|
277130
|
+
"description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
|
|
277131
|
+
},
|
|
277132
|
+
"createdAt": {
|
|
277133
|
+
"type": "string",
|
|
277134
|
+
"format": "date-time",
|
|
277135
|
+
"description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
|
|
277136
|
+
},
|
|
277137
|
+
"discriminateByTags": {
|
|
277138
|
+
"type": "array",
|
|
277139
|
+
"items": {
|
|
277140
|
+
"type": "string",
|
|
277141
|
+
"maxLength": 500
|
|
277142
|
+
},
|
|
277143
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
277144
|
+
}
|
|
277145
|
+
},
|
|
277146
|
+
"required": [
|
|
277147
|
+
"payload",
|
|
277148
|
+
"userId",
|
|
277149
|
+
"conversationId",
|
|
277150
|
+
"type",
|
|
277151
|
+
"tags",
|
|
277152
|
+
"createdAt",
|
|
277153
|
+
"discriminateByTags"
|
|
277154
|
+
],
|
|
277155
|
+
"description": "Setting empty tags or discriminateByTags will always result in the creation of a new message"
|
|
277156
|
+
},
|
|
277157
|
+
"maxItems": 100
|
|
277158
|
+
}
|
|
277159
|
+
},
|
|
277160
|
+
"required": [
|
|
277161
|
+
"messages"
|
|
277162
|
+
],
|
|
277163
|
+
"title": "importMessagesBody",
|
|
277164
|
+
"additionalProperties": false
|
|
277165
|
+
}
|
|
277166
|
+
},
|
|
277167
|
+
"section": "message",
|
|
277168
|
+
"response": {
|
|
277169
|
+
"description": "Returns the list of [Message](#schema_message) objects that were retrieved or created. Returns an [Error](#errors) otherwise",
|
|
277170
|
+
"schema": {
|
|
277171
|
+
"type": "object",
|
|
277172
|
+
"properties": {
|
|
277173
|
+
"messages": {
|
|
277174
|
+
"type": "array",
|
|
277175
|
+
"items": {
|
|
277176
|
+
"$ref": "#/components/schemas/Message"
|
|
277177
|
+
}
|
|
277178
|
+
}
|
|
277179
|
+
},
|
|
277180
|
+
"required": [
|
|
277181
|
+
"messages"
|
|
277182
|
+
],
|
|
277183
|
+
"title": "importMessagesResponse",
|
|
277184
|
+
"additionalProperties": false
|
|
277185
|
+
}
|
|
277186
|
+
},
|
|
277187
|
+
"tags": [
|
|
277188
|
+
"experimental"
|
|
277189
|
+
],
|
|
277190
|
+
"parameters": {
|
|
277191
|
+
"x-bot-id": {
|
|
277192
|
+
"in": "header",
|
|
277193
|
+
"description": "Bot id",
|
|
277194
|
+
"type": "string",
|
|
277195
|
+
"required": true
|
|
277196
|
+
},
|
|
277197
|
+
"x-integration-id": {
|
|
277198
|
+
"in": "header",
|
|
277199
|
+
"description": "Integration id",
|
|
277200
|
+
"type": "string",
|
|
277201
|
+
"required": false
|
|
277202
|
+
},
|
|
277203
|
+
"x-integration-alias": {
|
|
277204
|
+
"in": "header",
|
|
277205
|
+
"description": "Integration alias",
|
|
277206
|
+
"type": "string",
|
|
277207
|
+
"required": false
|
|
277208
|
+
}
|
|
277209
|
+
}
|
|
277210
|
+
},
|
|
276893
277211
|
"createUser": {
|
|
276894
277212
|
"name": "createUser",
|
|
276895
277213
|
"description": "Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.",
|
|
@@ -279045,7 +279363,7 @@ var state = {
|
|
|
279045
279363
|
"title": "Botpress Runtime API",
|
|
279046
279364
|
"description": "API for Botpress Runtime",
|
|
279047
279365
|
"server": "https://api.botpress.cloud",
|
|
279048
|
-
"version": "1.
|
|
279366
|
+
"version": "1.67.0",
|
|
279049
279367
|
"prefix": "v1"
|
|
279050
279368
|
},
|
|
279051
279369
|
"defaultParameters": {
|
|
@@ -279206,6 +279524,8 @@ var state = {
|
|
|
279206
279524
|
"createMessageBody": true,
|
|
279207
279525
|
"getOrCreateMessageBody": true,
|
|
279208
279526
|
"updateMessageBody": true,
|
|
279527
|
+
"initializeIncomingMessageBody": true,
|
|
279528
|
+
"importMessagesBody": true,
|
|
279209
279529
|
"createUserBody": true,
|
|
279210
279530
|
"getOrCreateUserBody": true,
|
|
279211
279531
|
"updateUserBody": true,
|
|
@@ -279243,6 +279563,8 @@ var state = {
|
|
|
279243
279563
|
"updateMessageResponse": true,
|
|
279244
279564
|
"listMessagesResponse": true,
|
|
279245
279565
|
"deleteMessageResponse": true,
|
|
279566
|
+
"initializeIncomingMessageResponse": true,
|
|
279567
|
+
"importMessagesResponse": true,
|
|
279246
279568
|
"createUserResponse": true,
|
|
279247
279569
|
"getUserResponse": true,
|
|
279248
279570
|
"listUsersResponse": true,
|
|
@@ -279889,7 +280211,9 @@ var state = {
|
|
|
279889
280211
|
"getMessage",
|
|
279890
280212
|
"updateMessage",
|
|
279891
280213
|
"listMessages",
|
|
279892
|
-
"deleteMessage"
|
|
280214
|
+
"deleteMessage",
|
|
280215
|
+
"initializeIncomingMessage",
|
|
280216
|
+
"importMessages"
|
|
279893
280217
|
],
|
|
279894
280218
|
"schema": "Message"
|
|
279895
280219
|
},
|
|
@@ -295450,7 +295774,7 @@ var state2 = {
|
|
|
295450
295774
|
"title": "Botpress Admin API",
|
|
295451
295775
|
"description": "API for Botpress Cloud Manager",
|
|
295452
295776
|
"server": "https://api.botpress.cloud",
|
|
295453
|
-
"version": "1.
|
|
295777
|
+
"version": "1.67.0",
|
|
295454
295778
|
"prefix": "v1"
|
|
295455
295779
|
},
|
|
295456
295780
|
"defaultParameters": {
|
|
@@ -300953,7 +301277,7 @@ var state3 = {
|
|
|
300953
301277
|
"title": "Botpress Files API",
|
|
300954
301278
|
"description": "API for Botpress Files",
|
|
300955
301279
|
"server": "https://api.botpress.cloud",
|
|
300956
|
-
"version": "1.
|
|
301280
|
+
"version": "1.67.0",
|
|
300957
301281
|
"prefix": "v1"
|
|
300958
301282
|
},
|
|
300959
301283
|
"defaultParameters": {
|
|
@@ -303244,7 +303568,7 @@ var state4 = {
|
|
|
303244
303568
|
"title": "Botpress Tables API",
|
|
303245
303569
|
"description": "API for Botpress Tables",
|
|
303246
303570
|
"server": "https://api.botpress.cloud",
|
|
303247
|
-
"version": "1.
|
|
303571
|
+
"version": "1.67.0",
|
|
303248
303572
|
"prefix": "v1"
|
|
303249
303573
|
},
|
|
303250
303574
|
"defaultParameters": {
|
|
@@ -305063,6 +305387,286 @@ var state5 = {
|
|
|
305063
305387
|
"documented"
|
|
305064
305388
|
]
|
|
305065
305389
|
},
|
|
305390
|
+
"initializeIncomingMessage": {
|
|
305391
|
+
"name": "initializeIncomingMessage",
|
|
305392
|
+
"description": "Initializes a user, conversation and sends a message to the conversation.",
|
|
305393
|
+
"method": "post",
|
|
305394
|
+
"path": "/v1/chat/initialize-incoming-message",
|
|
305395
|
+
"parameters": {},
|
|
305396
|
+
"section": "message",
|
|
305397
|
+
"requestBody": {
|
|
305398
|
+
"description": "Message data with related conversation and user",
|
|
305399
|
+
"schema": {
|
|
305400
|
+
"type": "object",
|
|
305401
|
+
"properties": {
|
|
305402
|
+
"userId": {
|
|
305403
|
+
"type": "string"
|
|
305404
|
+
},
|
|
305405
|
+
"user": {
|
|
305406
|
+
"type": "object",
|
|
305407
|
+
"properties": {
|
|
305408
|
+
"tags": {
|
|
305409
|
+
"type": "object",
|
|
305410
|
+
"additionalProperties": {
|
|
305411
|
+
"type": "string",
|
|
305412
|
+
"maxLength": 500
|
|
305413
|
+
},
|
|
305414
|
+
"description": "Tags for the [User](#schema_user)"
|
|
305415
|
+
},
|
|
305416
|
+
"integrationName": {
|
|
305417
|
+
"type": "string",
|
|
305418
|
+
"maxLength": 200,
|
|
305419
|
+
"description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
|
|
305420
|
+
"deprecated": true
|
|
305421
|
+
},
|
|
305422
|
+
"name": {
|
|
305423
|
+
"type": "string",
|
|
305424
|
+
"maxLength": 200,
|
|
305425
|
+
"description": "Name of the user"
|
|
305426
|
+
},
|
|
305427
|
+
"pictureUrl": {
|
|
305428
|
+
"type": "string",
|
|
305429
|
+
"maxLength": 4e4,
|
|
305430
|
+
"description": "URI of the user picture"
|
|
305431
|
+
},
|
|
305432
|
+
"discriminateByTags": {
|
|
305433
|
+
"type": "array",
|
|
305434
|
+
"items": {
|
|
305435
|
+
"type": "string",
|
|
305436
|
+
"maxLength": 500
|
|
305437
|
+
},
|
|
305438
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
305439
|
+
}
|
|
305440
|
+
},
|
|
305441
|
+
"required": [
|
|
305442
|
+
"tags",
|
|
305443
|
+
"discriminateByTags"
|
|
305444
|
+
],
|
|
305445
|
+
"additionalProperties": false
|
|
305446
|
+
},
|
|
305447
|
+
"conversationId": {
|
|
305448
|
+
"type": "string"
|
|
305449
|
+
},
|
|
305450
|
+
"conversation": {
|
|
305451
|
+
"type": "object",
|
|
305452
|
+
"properties": {
|
|
305453
|
+
"channel": {
|
|
305454
|
+
"type": "string",
|
|
305455
|
+
"maxLength": 200,
|
|
305456
|
+
"description": "Channel name"
|
|
305457
|
+
},
|
|
305458
|
+
"tags": {
|
|
305459
|
+
"type": "object",
|
|
305460
|
+
"additionalProperties": {
|
|
305461
|
+
"type": "string",
|
|
305462
|
+
"maxLength": 500
|
|
305463
|
+
},
|
|
305464
|
+
"description": "Tags for the [Conversation](#schema_conversation)"
|
|
305465
|
+
},
|
|
305466
|
+
"integrationName": {
|
|
305467
|
+
"type": "string",
|
|
305468
|
+
"maxLength": 200,
|
|
305469
|
+
"description": "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.",
|
|
305470
|
+
"deprecated": true
|
|
305471
|
+
},
|
|
305472
|
+
"discriminateByTags": {
|
|
305473
|
+
"type": "array",
|
|
305474
|
+
"items": {
|
|
305475
|
+
"type": "string",
|
|
305476
|
+
"maxLength": 500
|
|
305477
|
+
},
|
|
305478
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
305479
|
+
}
|
|
305480
|
+
},
|
|
305481
|
+
"required": [
|
|
305482
|
+
"channel",
|
|
305483
|
+
"tags",
|
|
305484
|
+
"discriminateByTags"
|
|
305485
|
+
],
|
|
305486
|
+
"additionalProperties": false
|
|
305487
|
+
},
|
|
305488
|
+
"message": {
|
|
305489
|
+
"type": "object",
|
|
305490
|
+
"properties": {
|
|
305491
|
+
"payload": {
|
|
305492
|
+
"type": "object",
|
|
305493
|
+
"additionalProperties": true,
|
|
305494
|
+
"description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
|
|
305495
|
+
},
|
|
305496
|
+
"type": {
|
|
305497
|
+
"type": "string",
|
|
305498
|
+
"maxLength": 200,
|
|
305499
|
+
"description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
|
|
305500
|
+
},
|
|
305501
|
+
"tags": {
|
|
305502
|
+
"type": "object",
|
|
305503
|
+
"additionalProperties": {
|
|
305504
|
+
"type": "string",
|
|
305505
|
+
"maxLength": 500
|
|
305506
|
+
},
|
|
305507
|
+
"description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
|
|
305508
|
+
},
|
|
305509
|
+
"origin": {
|
|
305510
|
+
"type": "string",
|
|
305511
|
+
"enum": [
|
|
305512
|
+
"synthetic"
|
|
305513
|
+
]
|
|
305514
|
+
},
|
|
305515
|
+
"discriminateByTags": {
|
|
305516
|
+
"type": "array",
|
|
305517
|
+
"items": {
|
|
305518
|
+
"type": "string",
|
|
305519
|
+
"maxLength": 500
|
|
305520
|
+
},
|
|
305521
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
305522
|
+
}
|
|
305523
|
+
},
|
|
305524
|
+
"required": [
|
|
305525
|
+
"payload",
|
|
305526
|
+
"type",
|
|
305527
|
+
"tags",
|
|
305528
|
+
"discriminateByTags"
|
|
305529
|
+
],
|
|
305530
|
+
"additionalProperties": false
|
|
305531
|
+
}
|
|
305532
|
+
},
|
|
305533
|
+
"title": "initializeIncomingMessageBody",
|
|
305534
|
+
"additionalProperties": false
|
|
305535
|
+
}
|
|
305536
|
+
},
|
|
305537
|
+
"response": {
|
|
305538
|
+
"description": "Returns an object containing the user, conversation and message (if created)",
|
|
305539
|
+
"schema": {
|
|
305540
|
+
"type": "object",
|
|
305541
|
+
"properties": {
|
|
305542
|
+
"user": {
|
|
305543
|
+
"$ref": "#/components/schemas/User"
|
|
305544
|
+
},
|
|
305545
|
+
"conversation": {
|
|
305546
|
+
"$ref": "#/components/schemas/Conversation"
|
|
305547
|
+
},
|
|
305548
|
+
"message": {
|
|
305549
|
+
"$ref": "#/components/schemas/Message"
|
|
305550
|
+
}
|
|
305551
|
+
},
|
|
305552
|
+
"required": [
|
|
305553
|
+
"user",
|
|
305554
|
+
"conversation"
|
|
305555
|
+
],
|
|
305556
|
+
"title": "initializeIncomingMessageResponse",
|
|
305557
|
+
"additionalProperties": false
|
|
305558
|
+
}
|
|
305559
|
+
},
|
|
305560
|
+
"tags": [
|
|
305561
|
+
"experimental"
|
|
305562
|
+
]
|
|
305563
|
+
},
|
|
305564
|
+
"importMessages": {
|
|
305565
|
+
"name": "importMessages",
|
|
305566
|
+
"description": "Imports messages if no matching messages already exist. Returns the list of messages that were either created or retrieved.",
|
|
305567
|
+
"method": "post",
|
|
305568
|
+
"path": "/v1/chat/messages/import-messages",
|
|
305569
|
+
"requestBody": {
|
|
305570
|
+
"description": "Data for the list of messages to import",
|
|
305571
|
+
"schema": {
|
|
305572
|
+
"type": "object",
|
|
305573
|
+
"properties": {
|
|
305574
|
+
"messages": {
|
|
305575
|
+
"type": "array",
|
|
305576
|
+
"items": {
|
|
305577
|
+
"type": "object",
|
|
305578
|
+
"properties": {
|
|
305579
|
+
"payload": {
|
|
305580
|
+
"type": "object",
|
|
305581
|
+
"properties": {},
|
|
305582
|
+
"additionalProperties": true,
|
|
305583
|
+
"description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
|
|
305584
|
+
},
|
|
305585
|
+
"userId": {
|
|
305586
|
+
"type": "string",
|
|
305587
|
+
"minLength": 28,
|
|
305588
|
+
"maxLength": 36,
|
|
305589
|
+
"description": "ID of the [User](#schema_user)"
|
|
305590
|
+
},
|
|
305591
|
+
"conversationId": {
|
|
305592
|
+
"type": "string",
|
|
305593
|
+
"minLength": 28,
|
|
305594
|
+
"maxLength": 36,
|
|
305595
|
+
"description": "ID of the [Conversation](#schema_conversation)"
|
|
305596
|
+
},
|
|
305597
|
+
"type": {
|
|
305598
|
+
"type": "string",
|
|
305599
|
+
"maxLength": 200,
|
|
305600
|
+
"description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
|
|
305601
|
+
},
|
|
305602
|
+
"tags": {
|
|
305603
|
+
"type": "object",
|
|
305604
|
+
"additionalProperties": {
|
|
305605
|
+
"type": "string",
|
|
305606
|
+
"maxLength": 500
|
|
305607
|
+
},
|
|
305608
|
+
"description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
|
|
305609
|
+
},
|
|
305610
|
+
"createdAt": {
|
|
305611
|
+
"type": "string",
|
|
305612
|
+
"format": "date-time",
|
|
305613
|
+
"description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
|
|
305614
|
+
},
|
|
305615
|
+
"discriminateByTags": {
|
|
305616
|
+
"type": "array",
|
|
305617
|
+
"items": {
|
|
305618
|
+
"type": "string",
|
|
305619
|
+
"maxLength": 500
|
|
305620
|
+
},
|
|
305621
|
+
"description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
|
|
305622
|
+
}
|
|
305623
|
+
},
|
|
305624
|
+
"required": [
|
|
305625
|
+
"payload",
|
|
305626
|
+
"userId",
|
|
305627
|
+
"conversationId",
|
|
305628
|
+
"type",
|
|
305629
|
+
"tags",
|
|
305630
|
+
"createdAt",
|
|
305631
|
+
"discriminateByTags"
|
|
305632
|
+
],
|
|
305633
|
+
"description": "Setting empty tags or discriminateByTags will always result in the creation of a new message"
|
|
305634
|
+
},
|
|
305635
|
+
"maxItems": 100
|
|
305636
|
+
}
|
|
305637
|
+
},
|
|
305638
|
+
"required": [
|
|
305639
|
+
"messages"
|
|
305640
|
+
],
|
|
305641
|
+
"title": "importMessagesBody",
|
|
305642
|
+
"additionalProperties": false
|
|
305643
|
+
}
|
|
305644
|
+
},
|
|
305645
|
+
"section": "message",
|
|
305646
|
+
"response": {
|
|
305647
|
+
"description": "Returns the list of [Message](#schema_message) objects that were retrieved or created. Returns an [Error](#errors) otherwise",
|
|
305648
|
+
"schema": {
|
|
305649
|
+
"type": "object",
|
|
305650
|
+
"properties": {
|
|
305651
|
+
"messages": {
|
|
305652
|
+
"type": "array",
|
|
305653
|
+
"items": {
|
|
305654
|
+
"$ref": "#/components/schemas/Message"
|
|
305655
|
+
}
|
|
305656
|
+
}
|
|
305657
|
+
},
|
|
305658
|
+
"required": [
|
|
305659
|
+
"messages"
|
|
305660
|
+
],
|
|
305661
|
+
"title": "importMessagesResponse",
|
|
305662
|
+
"additionalProperties": false
|
|
305663
|
+
}
|
|
305664
|
+
},
|
|
305665
|
+
"tags": [
|
|
305666
|
+
"experimental"
|
|
305667
|
+
],
|
|
305668
|
+
"parameters": {}
|
|
305669
|
+
},
|
|
305066
305670
|
"createUser": {
|
|
305067
305671
|
"name": "createUser",
|
|
305068
305672
|
"description": "Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.",
|
|
@@ -324356,7 +324960,7 @@ var state5 = {
|
|
|
324356
324960
|
"title": "Botpress API",
|
|
324357
324961
|
"description": "API for Botpress Cloud",
|
|
324358
324962
|
"server": "https://api.botpress.cloud",
|
|
324359
|
-
"version": "1.
|
|
324963
|
+
"version": "1.67.0",
|
|
324360
324964
|
"prefix": "v1"
|
|
324361
324965
|
},
|
|
324362
324966
|
"errors": [
|
|
@@ -324497,6 +325101,8 @@ var state5 = {
|
|
|
324497
325101
|
"createMessageBody": true,
|
|
324498
325102
|
"getOrCreateMessageBody": true,
|
|
324499
325103
|
"updateMessageBody": true,
|
|
325104
|
+
"initializeIncomingMessageBody": true,
|
|
325105
|
+
"importMessagesBody": true,
|
|
324500
325106
|
"createUserBody": true,
|
|
324501
325107
|
"getOrCreateUserBody": true,
|
|
324502
325108
|
"updateUserBody": true,
|
|
@@ -324584,6 +325190,8 @@ var state5 = {
|
|
|
324584
325190
|
"updateMessageResponse": true,
|
|
324585
325191
|
"listMessagesResponse": true,
|
|
324586
325192
|
"deleteMessageResponse": true,
|
|
325193
|
+
"initializeIncomingMessageResponse": true,
|
|
325194
|
+
"importMessagesResponse": true,
|
|
324587
325195
|
"createUserResponse": true,
|
|
324588
325196
|
"getUserResponse": true,
|
|
324589
325197
|
"listUsersResponse": true,
|
|
@@ -328468,7 +329076,9 @@ var state5 = {
|
|
|
328468
329076
|
"getMessage",
|
|
328469
329077
|
"updateMessage",
|
|
328470
329078
|
"listMessages",
|
|
328471
|
-
"deleteMessage"
|
|
329079
|
+
"deleteMessage",
|
|
329080
|
+
"initializeIncomingMessage",
|
|
329081
|
+
"importMessages"
|
|
328472
329082
|
],
|
|
328473
329083
|
"schema": "Message"
|
|
328474
329084
|
},
|
|
@@ -329598,7 +330208,7 @@ var state6 = {
|
|
|
329598
330208
|
"title": "Botpress Billing Public API",
|
|
329599
330209
|
"description": "API for Botpress Billing",
|
|
329600
330210
|
"server": "https://api.botpress.cloud",
|
|
329601
|
-
"version": "1.
|
|
330211
|
+
"version": "1.67.0",
|
|
329602
330212
|
"prefix": "v2"
|
|
329603
330213
|
},
|
|
329604
330214
|
"defaultParameters": {
|
|
@@ -1390,6 +1390,291 @@ export declare const state: {
|
|
|
1390
1390
|
};
|
|
1391
1391
|
tags: string[];
|
|
1392
1392
|
};
|
|
1393
|
+
initializeIncomingMessage: {
|
|
1394
|
+
name: string;
|
|
1395
|
+
description: string;
|
|
1396
|
+
method: "post";
|
|
1397
|
+
path: string;
|
|
1398
|
+
parameters: {
|
|
1399
|
+
"x-bot-id": {
|
|
1400
|
+
in: "header";
|
|
1401
|
+
description: string;
|
|
1402
|
+
type: "string";
|
|
1403
|
+
required: true;
|
|
1404
|
+
};
|
|
1405
|
+
"x-integration-id": {
|
|
1406
|
+
in: "header";
|
|
1407
|
+
description: string;
|
|
1408
|
+
type: "string";
|
|
1409
|
+
required: false;
|
|
1410
|
+
};
|
|
1411
|
+
"x-integration-alias": {
|
|
1412
|
+
in: "header";
|
|
1413
|
+
description: string;
|
|
1414
|
+
type: "string";
|
|
1415
|
+
required: false;
|
|
1416
|
+
};
|
|
1417
|
+
};
|
|
1418
|
+
section: "message";
|
|
1419
|
+
requestBody: {
|
|
1420
|
+
description: string;
|
|
1421
|
+
schema: {
|
|
1422
|
+
type: "object";
|
|
1423
|
+
properties: {
|
|
1424
|
+
userId: {
|
|
1425
|
+
type: "string";
|
|
1426
|
+
};
|
|
1427
|
+
user: {
|
|
1428
|
+
type: "object";
|
|
1429
|
+
properties: {
|
|
1430
|
+
tags: {
|
|
1431
|
+
type: "object";
|
|
1432
|
+
additionalProperties: {
|
|
1433
|
+
type: "string";
|
|
1434
|
+
maxLength: number;
|
|
1435
|
+
};
|
|
1436
|
+
description: string;
|
|
1437
|
+
};
|
|
1438
|
+
integrationName: {
|
|
1439
|
+
type: "string";
|
|
1440
|
+
maxLength: number;
|
|
1441
|
+
description: string;
|
|
1442
|
+
deprecated: true;
|
|
1443
|
+
};
|
|
1444
|
+
name: {
|
|
1445
|
+
type: "string";
|
|
1446
|
+
maxLength: number;
|
|
1447
|
+
description: string;
|
|
1448
|
+
};
|
|
1449
|
+
pictureUrl: {
|
|
1450
|
+
type: "string";
|
|
1451
|
+
maxLength: number;
|
|
1452
|
+
description: string;
|
|
1453
|
+
};
|
|
1454
|
+
discriminateByTags: {
|
|
1455
|
+
type: "array";
|
|
1456
|
+
items: {
|
|
1457
|
+
type: "string";
|
|
1458
|
+
maxLength: number;
|
|
1459
|
+
};
|
|
1460
|
+
description: string;
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
required: string[];
|
|
1464
|
+
additionalProperties: false;
|
|
1465
|
+
};
|
|
1466
|
+
conversationId: {
|
|
1467
|
+
type: "string";
|
|
1468
|
+
};
|
|
1469
|
+
conversation: {
|
|
1470
|
+
type: "object";
|
|
1471
|
+
properties: {
|
|
1472
|
+
channel: {
|
|
1473
|
+
type: "string";
|
|
1474
|
+
maxLength: number;
|
|
1475
|
+
description: string;
|
|
1476
|
+
};
|
|
1477
|
+
tags: {
|
|
1478
|
+
type: "object";
|
|
1479
|
+
additionalProperties: {
|
|
1480
|
+
type: "string";
|
|
1481
|
+
maxLength: number;
|
|
1482
|
+
};
|
|
1483
|
+
description: string;
|
|
1484
|
+
};
|
|
1485
|
+
integrationName: {
|
|
1486
|
+
type: "string";
|
|
1487
|
+
maxLength: number;
|
|
1488
|
+
description: string;
|
|
1489
|
+
deprecated: true;
|
|
1490
|
+
};
|
|
1491
|
+
discriminateByTags: {
|
|
1492
|
+
type: "array";
|
|
1493
|
+
items: {
|
|
1494
|
+
type: "string";
|
|
1495
|
+
maxLength: number;
|
|
1496
|
+
};
|
|
1497
|
+
description: string;
|
|
1498
|
+
};
|
|
1499
|
+
};
|
|
1500
|
+
required: string[];
|
|
1501
|
+
additionalProperties: false;
|
|
1502
|
+
};
|
|
1503
|
+
message: {
|
|
1504
|
+
type: "object";
|
|
1505
|
+
properties: {
|
|
1506
|
+
payload: {
|
|
1507
|
+
type: "object";
|
|
1508
|
+
additionalProperties: true;
|
|
1509
|
+
description: string;
|
|
1510
|
+
};
|
|
1511
|
+
type: {
|
|
1512
|
+
type: "string";
|
|
1513
|
+
maxLength: number;
|
|
1514
|
+
description: string;
|
|
1515
|
+
};
|
|
1516
|
+
tags: {
|
|
1517
|
+
type: "object";
|
|
1518
|
+
additionalProperties: {
|
|
1519
|
+
type: "string";
|
|
1520
|
+
maxLength: number;
|
|
1521
|
+
};
|
|
1522
|
+
description: string;
|
|
1523
|
+
};
|
|
1524
|
+
origin: {
|
|
1525
|
+
type: "string";
|
|
1526
|
+
enum: string[];
|
|
1527
|
+
};
|
|
1528
|
+
discriminateByTags: {
|
|
1529
|
+
type: "array";
|
|
1530
|
+
items: {
|
|
1531
|
+
type: "string";
|
|
1532
|
+
maxLength: number;
|
|
1533
|
+
};
|
|
1534
|
+
description: string;
|
|
1535
|
+
};
|
|
1536
|
+
};
|
|
1537
|
+
required: string[];
|
|
1538
|
+
additionalProperties: false;
|
|
1539
|
+
};
|
|
1540
|
+
};
|
|
1541
|
+
title: string;
|
|
1542
|
+
additionalProperties: false;
|
|
1543
|
+
};
|
|
1544
|
+
};
|
|
1545
|
+
response: {
|
|
1546
|
+
description: string;
|
|
1547
|
+
schema: {
|
|
1548
|
+
type: "object";
|
|
1549
|
+
properties: {
|
|
1550
|
+
user: {
|
|
1551
|
+
$ref: string;
|
|
1552
|
+
};
|
|
1553
|
+
conversation: {
|
|
1554
|
+
$ref: string;
|
|
1555
|
+
};
|
|
1556
|
+
message: {
|
|
1557
|
+
$ref: string;
|
|
1558
|
+
};
|
|
1559
|
+
};
|
|
1560
|
+
required: string[];
|
|
1561
|
+
title: string;
|
|
1562
|
+
additionalProperties: false;
|
|
1563
|
+
};
|
|
1564
|
+
};
|
|
1565
|
+
tags: string[];
|
|
1566
|
+
};
|
|
1567
|
+
importMessages: {
|
|
1568
|
+
name: string;
|
|
1569
|
+
description: string;
|
|
1570
|
+
method: "post";
|
|
1571
|
+
path: string;
|
|
1572
|
+
requestBody: {
|
|
1573
|
+
description: string;
|
|
1574
|
+
schema: {
|
|
1575
|
+
type: "object";
|
|
1576
|
+
properties: {
|
|
1577
|
+
messages: {
|
|
1578
|
+
type: "array";
|
|
1579
|
+
items: {
|
|
1580
|
+
type: "object";
|
|
1581
|
+
properties: {
|
|
1582
|
+
payload: {
|
|
1583
|
+
type: "object";
|
|
1584
|
+
properties: {};
|
|
1585
|
+
additionalProperties: true;
|
|
1586
|
+
description: string;
|
|
1587
|
+
};
|
|
1588
|
+
userId: {
|
|
1589
|
+
type: "string";
|
|
1590
|
+
minLength: number;
|
|
1591
|
+
maxLength: number;
|
|
1592
|
+
description: string;
|
|
1593
|
+
};
|
|
1594
|
+
conversationId: {
|
|
1595
|
+
type: "string";
|
|
1596
|
+
minLength: number;
|
|
1597
|
+
maxLength: number;
|
|
1598
|
+
description: string;
|
|
1599
|
+
};
|
|
1600
|
+
type: {
|
|
1601
|
+
type: "string";
|
|
1602
|
+
maxLength: number;
|
|
1603
|
+
description: string;
|
|
1604
|
+
};
|
|
1605
|
+
tags: {
|
|
1606
|
+
type: "object";
|
|
1607
|
+
additionalProperties: {
|
|
1608
|
+
type: "string";
|
|
1609
|
+
maxLength: number;
|
|
1610
|
+
};
|
|
1611
|
+
description: string;
|
|
1612
|
+
};
|
|
1613
|
+
createdAt: {
|
|
1614
|
+
type: "string";
|
|
1615
|
+
format: string;
|
|
1616
|
+
description: string;
|
|
1617
|
+
};
|
|
1618
|
+
discriminateByTags: {
|
|
1619
|
+
type: "array";
|
|
1620
|
+
items: {
|
|
1621
|
+
type: "string";
|
|
1622
|
+
maxLength: number;
|
|
1623
|
+
};
|
|
1624
|
+
description: string;
|
|
1625
|
+
};
|
|
1626
|
+
};
|
|
1627
|
+
required: string[];
|
|
1628
|
+
description: string;
|
|
1629
|
+
};
|
|
1630
|
+
maxItems: number;
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1633
|
+
required: string[];
|
|
1634
|
+
title: string;
|
|
1635
|
+
additionalProperties: false;
|
|
1636
|
+
};
|
|
1637
|
+
};
|
|
1638
|
+
section: "message";
|
|
1639
|
+
response: {
|
|
1640
|
+
description: string;
|
|
1641
|
+
schema: {
|
|
1642
|
+
type: "object";
|
|
1643
|
+
properties: {
|
|
1644
|
+
messages: {
|
|
1645
|
+
type: "array";
|
|
1646
|
+
items: {
|
|
1647
|
+
$ref: string;
|
|
1648
|
+
};
|
|
1649
|
+
};
|
|
1650
|
+
};
|
|
1651
|
+
required: string[];
|
|
1652
|
+
title: string;
|
|
1653
|
+
additionalProperties: false;
|
|
1654
|
+
};
|
|
1655
|
+
};
|
|
1656
|
+
tags: string[];
|
|
1657
|
+
parameters: {
|
|
1658
|
+
"x-bot-id": {
|
|
1659
|
+
in: "header";
|
|
1660
|
+
description: string;
|
|
1661
|
+
type: "string";
|
|
1662
|
+
required: true;
|
|
1663
|
+
};
|
|
1664
|
+
"x-integration-id": {
|
|
1665
|
+
in: "header";
|
|
1666
|
+
description: string;
|
|
1667
|
+
type: "string";
|
|
1668
|
+
required: false;
|
|
1669
|
+
};
|
|
1670
|
+
"x-integration-alias": {
|
|
1671
|
+
in: "header";
|
|
1672
|
+
description: string;
|
|
1673
|
+
type: "string";
|
|
1674
|
+
required: false;
|
|
1675
|
+
};
|
|
1676
|
+
};
|
|
1677
|
+
};
|
|
1393
1678
|
createUser: {
|
|
1394
1679
|
name: string;
|
|
1395
1680
|
description: string;
|
|
@@ -3414,6 +3699,8 @@ export declare const state: {
|
|
|
3414
3699
|
createMessageBody: true;
|
|
3415
3700
|
getOrCreateMessageBody: true;
|
|
3416
3701
|
updateMessageBody: true;
|
|
3702
|
+
initializeIncomingMessageBody: true;
|
|
3703
|
+
importMessagesBody: true;
|
|
3417
3704
|
createUserBody: true;
|
|
3418
3705
|
getOrCreateUserBody: true;
|
|
3419
3706
|
updateUserBody: true;
|
|
@@ -3451,6 +3738,8 @@ export declare const state: {
|
|
|
3451
3738
|
updateMessageResponse: true;
|
|
3452
3739
|
listMessagesResponse: true;
|
|
3453
3740
|
deleteMessageResponse: true;
|
|
3741
|
+
initializeIncomingMessageResponse: true;
|
|
3742
|
+
importMessagesResponse: true;
|
|
3454
3743
|
createUserResponse: true;
|
|
3455
3744
|
getUserResponse: true;
|
|
3456
3745
|
listUsersResponse: true;
|
package/dist/src/gen/state.d.ts
CHANGED
|
@@ -1025,6 +1025,253 @@ export declare const state: {
|
|
|
1025
1025
|
};
|
|
1026
1026
|
tags: string[];
|
|
1027
1027
|
};
|
|
1028
|
+
initializeIncomingMessage: {
|
|
1029
|
+
name: string;
|
|
1030
|
+
description: string;
|
|
1031
|
+
method: "post";
|
|
1032
|
+
path: string;
|
|
1033
|
+
parameters: {};
|
|
1034
|
+
section: "message";
|
|
1035
|
+
requestBody: {
|
|
1036
|
+
description: string;
|
|
1037
|
+
schema: {
|
|
1038
|
+
type: "object";
|
|
1039
|
+
properties: {
|
|
1040
|
+
userId: {
|
|
1041
|
+
type: "string";
|
|
1042
|
+
};
|
|
1043
|
+
user: {
|
|
1044
|
+
type: "object";
|
|
1045
|
+
properties: {
|
|
1046
|
+
tags: {
|
|
1047
|
+
type: "object";
|
|
1048
|
+
additionalProperties: {
|
|
1049
|
+
type: "string";
|
|
1050
|
+
maxLength: number;
|
|
1051
|
+
};
|
|
1052
|
+
description: string;
|
|
1053
|
+
};
|
|
1054
|
+
integrationName: {
|
|
1055
|
+
type: "string";
|
|
1056
|
+
maxLength: number;
|
|
1057
|
+
description: string;
|
|
1058
|
+
deprecated: true;
|
|
1059
|
+
};
|
|
1060
|
+
name: {
|
|
1061
|
+
type: "string";
|
|
1062
|
+
maxLength: number;
|
|
1063
|
+
description: string;
|
|
1064
|
+
};
|
|
1065
|
+
pictureUrl: {
|
|
1066
|
+
type: "string";
|
|
1067
|
+
maxLength: number;
|
|
1068
|
+
description: string;
|
|
1069
|
+
};
|
|
1070
|
+
discriminateByTags: {
|
|
1071
|
+
type: "array";
|
|
1072
|
+
items: {
|
|
1073
|
+
type: "string";
|
|
1074
|
+
maxLength: number;
|
|
1075
|
+
};
|
|
1076
|
+
description: string;
|
|
1077
|
+
};
|
|
1078
|
+
};
|
|
1079
|
+
required: string[];
|
|
1080
|
+
additionalProperties: false;
|
|
1081
|
+
};
|
|
1082
|
+
conversationId: {
|
|
1083
|
+
type: "string";
|
|
1084
|
+
};
|
|
1085
|
+
conversation: {
|
|
1086
|
+
type: "object";
|
|
1087
|
+
properties: {
|
|
1088
|
+
channel: {
|
|
1089
|
+
type: "string";
|
|
1090
|
+
maxLength: number;
|
|
1091
|
+
description: string;
|
|
1092
|
+
};
|
|
1093
|
+
tags: {
|
|
1094
|
+
type: "object";
|
|
1095
|
+
additionalProperties: {
|
|
1096
|
+
type: "string";
|
|
1097
|
+
maxLength: number;
|
|
1098
|
+
};
|
|
1099
|
+
description: string;
|
|
1100
|
+
};
|
|
1101
|
+
integrationName: {
|
|
1102
|
+
type: "string";
|
|
1103
|
+
maxLength: number;
|
|
1104
|
+
description: string;
|
|
1105
|
+
deprecated: true;
|
|
1106
|
+
};
|
|
1107
|
+
discriminateByTags: {
|
|
1108
|
+
type: "array";
|
|
1109
|
+
items: {
|
|
1110
|
+
type: "string";
|
|
1111
|
+
maxLength: number;
|
|
1112
|
+
};
|
|
1113
|
+
description: string;
|
|
1114
|
+
};
|
|
1115
|
+
};
|
|
1116
|
+
required: string[];
|
|
1117
|
+
additionalProperties: false;
|
|
1118
|
+
};
|
|
1119
|
+
message: {
|
|
1120
|
+
type: "object";
|
|
1121
|
+
properties: {
|
|
1122
|
+
payload: {
|
|
1123
|
+
type: "object";
|
|
1124
|
+
additionalProperties: true;
|
|
1125
|
+
description: string;
|
|
1126
|
+
};
|
|
1127
|
+
type: {
|
|
1128
|
+
type: "string";
|
|
1129
|
+
maxLength: number;
|
|
1130
|
+
description: string;
|
|
1131
|
+
};
|
|
1132
|
+
tags: {
|
|
1133
|
+
type: "object";
|
|
1134
|
+
additionalProperties: {
|
|
1135
|
+
type: "string";
|
|
1136
|
+
maxLength: number;
|
|
1137
|
+
};
|
|
1138
|
+
description: string;
|
|
1139
|
+
};
|
|
1140
|
+
origin: {
|
|
1141
|
+
type: "string";
|
|
1142
|
+
enum: string[];
|
|
1143
|
+
};
|
|
1144
|
+
discriminateByTags: {
|
|
1145
|
+
type: "array";
|
|
1146
|
+
items: {
|
|
1147
|
+
type: "string";
|
|
1148
|
+
maxLength: number;
|
|
1149
|
+
};
|
|
1150
|
+
description: string;
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
required: string[];
|
|
1154
|
+
additionalProperties: false;
|
|
1155
|
+
};
|
|
1156
|
+
};
|
|
1157
|
+
title: string;
|
|
1158
|
+
additionalProperties: false;
|
|
1159
|
+
};
|
|
1160
|
+
};
|
|
1161
|
+
response: {
|
|
1162
|
+
description: string;
|
|
1163
|
+
schema: {
|
|
1164
|
+
type: "object";
|
|
1165
|
+
properties: {
|
|
1166
|
+
user: {
|
|
1167
|
+
$ref: string;
|
|
1168
|
+
};
|
|
1169
|
+
conversation: {
|
|
1170
|
+
$ref: string;
|
|
1171
|
+
};
|
|
1172
|
+
message: {
|
|
1173
|
+
$ref: string;
|
|
1174
|
+
};
|
|
1175
|
+
};
|
|
1176
|
+
required: string[];
|
|
1177
|
+
title: string;
|
|
1178
|
+
additionalProperties: false;
|
|
1179
|
+
};
|
|
1180
|
+
};
|
|
1181
|
+
tags: string[];
|
|
1182
|
+
};
|
|
1183
|
+
importMessages: {
|
|
1184
|
+
name: string;
|
|
1185
|
+
description: string;
|
|
1186
|
+
method: "post";
|
|
1187
|
+
path: string;
|
|
1188
|
+
requestBody: {
|
|
1189
|
+
description: string;
|
|
1190
|
+
schema: {
|
|
1191
|
+
type: "object";
|
|
1192
|
+
properties: {
|
|
1193
|
+
messages: {
|
|
1194
|
+
type: "array";
|
|
1195
|
+
items: {
|
|
1196
|
+
type: "object";
|
|
1197
|
+
properties: {
|
|
1198
|
+
payload: {
|
|
1199
|
+
type: "object";
|
|
1200
|
+
properties: {};
|
|
1201
|
+
additionalProperties: true;
|
|
1202
|
+
description: string;
|
|
1203
|
+
};
|
|
1204
|
+
userId: {
|
|
1205
|
+
type: "string";
|
|
1206
|
+
minLength: number;
|
|
1207
|
+
maxLength: number;
|
|
1208
|
+
description: string;
|
|
1209
|
+
};
|
|
1210
|
+
conversationId: {
|
|
1211
|
+
type: "string";
|
|
1212
|
+
minLength: number;
|
|
1213
|
+
maxLength: number;
|
|
1214
|
+
description: string;
|
|
1215
|
+
};
|
|
1216
|
+
type: {
|
|
1217
|
+
type: "string";
|
|
1218
|
+
maxLength: number;
|
|
1219
|
+
description: string;
|
|
1220
|
+
};
|
|
1221
|
+
tags: {
|
|
1222
|
+
type: "object";
|
|
1223
|
+
additionalProperties: {
|
|
1224
|
+
type: "string";
|
|
1225
|
+
maxLength: number;
|
|
1226
|
+
};
|
|
1227
|
+
description: string;
|
|
1228
|
+
};
|
|
1229
|
+
createdAt: {
|
|
1230
|
+
type: "string";
|
|
1231
|
+
format: string;
|
|
1232
|
+
description: string;
|
|
1233
|
+
};
|
|
1234
|
+
discriminateByTags: {
|
|
1235
|
+
type: "array";
|
|
1236
|
+
items: {
|
|
1237
|
+
type: "string";
|
|
1238
|
+
maxLength: number;
|
|
1239
|
+
};
|
|
1240
|
+
description: string;
|
|
1241
|
+
};
|
|
1242
|
+
};
|
|
1243
|
+
required: string[];
|
|
1244
|
+
description: string;
|
|
1245
|
+
};
|
|
1246
|
+
maxItems: number;
|
|
1247
|
+
};
|
|
1248
|
+
};
|
|
1249
|
+
required: string[];
|
|
1250
|
+
title: string;
|
|
1251
|
+
additionalProperties: false;
|
|
1252
|
+
};
|
|
1253
|
+
};
|
|
1254
|
+
section: "message";
|
|
1255
|
+
response: {
|
|
1256
|
+
description: string;
|
|
1257
|
+
schema: {
|
|
1258
|
+
type: "object";
|
|
1259
|
+
properties: {
|
|
1260
|
+
messages: {
|
|
1261
|
+
type: "array";
|
|
1262
|
+
items: {
|
|
1263
|
+
$ref: string;
|
|
1264
|
+
};
|
|
1265
|
+
};
|
|
1266
|
+
};
|
|
1267
|
+
required: string[];
|
|
1268
|
+
title: string;
|
|
1269
|
+
additionalProperties: false;
|
|
1270
|
+
};
|
|
1271
|
+
};
|
|
1272
|
+
tags: string[];
|
|
1273
|
+
parameters: {};
|
|
1274
|
+
};
|
|
1028
1275
|
createUser: {
|
|
1029
1276
|
name: string;
|
|
1030
1277
|
description: string;
|
|
@@ -17835,6 +18082,8 @@ export declare const state: {
|
|
|
17835
18082
|
createMessageBody: true;
|
|
17836
18083
|
getOrCreateMessageBody: true;
|
|
17837
18084
|
updateMessageBody: true;
|
|
18085
|
+
initializeIncomingMessageBody: true;
|
|
18086
|
+
importMessagesBody: true;
|
|
17838
18087
|
createUserBody: true;
|
|
17839
18088
|
getOrCreateUserBody: true;
|
|
17840
18089
|
updateUserBody: true;
|
|
@@ -17922,6 +18171,8 @@ export declare const state: {
|
|
|
17922
18171
|
updateMessageResponse: true;
|
|
17923
18172
|
listMessagesResponse: true;
|
|
17924
18173
|
deleteMessageResponse: true;
|
|
18174
|
+
initializeIncomingMessageResponse: true;
|
|
18175
|
+
importMessagesResponse: true;
|
|
17925
18176
|
createUserResponse: true;
|
|
17926
18177
|
getUserResponse: true;
|
|
17927
18178
|
listUsersResponse: true;
|