@botpress/api 0.2.2 → 0.3.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 CHANGED
@@ -227888,34 +227888,6 @@ var state = {
227888
227888
  },
227889
227889
  description: "A mapping of states to their definition"
227890
227890
  },
227891
- tags: {
227892
- type: "object",
227893
- properties: {
227894
- messages: {
227895
- default: [],
227896
- type: "array",
227897
- items: {
227898
- type: "string"
227899
- }
227900
- },
227901
- conversations: {
227902
- default: [],
227903
- type: "array",
227904
- items: {
227905
- type: "string"
227906
- }
227907
- },
227908
- users: {
227909
- default: [],
227910
- type: "array",
227911
- items: {
227912
- type: "string"
227913
- }
227914
- }
227915
- },
227916
- description: "Tags of the bot",
227917
- additionalProperties: false
227918
- },
227919
227891
  events: {
227920
227892
  type: "object",
227921
227893
  additionalProperties: {
@@ -227927,7 +227899,7 @@ var state = {
227927
227899
  }
227928
227900
  },
227929
227901
  required: ["schema"],
227930
- description: "Event schema",
227902
+ description: "Event Definition",
227931
227903
  additionalProperties: false
227932
227904
  },
227933
227905
  description: "Events definition"
@@ -227976,6 +227948,78 @@ var state = {
227976
227948
  },
227977
227949
  additionalProperties: false
227978
227950
  },
227951
+ user: {
227952
+ type: "object",
227953
+ properties: {
227954
+ tags: {
227955
+ type: "object",
227956
+ additionalProperties: {
227957
+ type: "object",
227958
+ properties: {
227959
+ title: {
227960
+ type: "string",
227961
+ description: "Title of the tag"
227962
+ },
227963
+ description: {
227964
+ type: "string",
227965
+ description: "Description of the tag"
227966
+ }
227967
+ },
227968
+ description: "Definition of a tag that can be provided on the object",
227969
+ additionalProperties: false
227970
+ }
227971
+ }
227972
+ },
227973
+ additionalProperties: false
227974
+ },
227975
+ conversation: {
227976
+ type: "object",
227977
+ properties: {
227978
+ tags: {
227979
+ type: "object",
227980
+ additionalProperties: {
227981
+ type: "object",
227982
+ properties: {
227983
+ title: {
227984
+ type: "string",
227985
+ description: "Title of the tag"
227986
+ },
227987
+ description: {
227988
+ type: "string",
227989
+ description: "Description of the tag"
227990
+ }
227991
+ },
227992
+ description: "Definition of a tag that can be provided on the object",
227993
+ additionalProperties: false
227994
+ }
227995
+ }
227996
+ },
227997
+ additionalProperties: false
227998
+ },
227999
+ message: {
228000
+ type: "object",
228001
+ properties: {
228002
+ tags: {
228003
+ type: "object",
228004
+ additionalProperties: {
228005
+ type: "object",
228006
+ properties: {
228007
+ title: {
228008
+ type: "string",
228009
+ description: "Title of the tag"
228010
+ },
228011
+ description: {
228012
+ type: "string",
228013
+ description: "Description of the tag"
228014
+ }
228015
+ },
228016
+ description: "Definition of a tag that can be provided on the object",
228017
+ additionalProperties: false
228018
+ }
228019
+ }
228020
+ },
228021
+ additionalProperties: false
228022
+ },
227979
228023
  code: {
227980
228024
  type: "string",
227981
228025
  description: "JavaScript code of the bot"
@@ -228057,58 +228101,98 @@ var state = {
228057
228101
  enum: ["iam"],
228058
228102
  description: "Type of the [Bot](#schema_bot) authentication (`iam`)"
228059
228103
  },
228060
- states: {
228104
+ configuration: {
228061
228105
  type: "object",
228062
- additionalProperties: {
228063
- type: "object",
228064
- properties: {
228065
- type: {
228066
- type: "string",
228067
- enum: ["conversation", "user", "bot"],
228068
- description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
228069
- },
228070
- schema: {
228071
- type: "object",
228072
- additionalProperties: true,
228073
- 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."
228074
- },
228075
- expiry: {
228076
- type: "number",
228077
- minimum: 1,
228078
- description: "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
228079
- }
228106
+ properties: {
228107
+ data: {
228108
+ type: "object",
228109
+ additionalProperties: true,
228110
+ description: "Configuration data"
228080
228111
  },
228081
- required: ["type", "schema"],
228082
- additionalProperties: false
228112
+ schema: {
228113
+ type: "object",
228114
+ additionalProperties: true,
228115
+ description: "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
228116
+ }
228083
228117
  },
228084
- description: "A mapping of states to their definition"
228118
+ additionalProperties: false
228085
228119
  },
228086
- tags: {
228120
+ blocked: {
228121
+ type: "boolean"
228122
+ },
228123
+ user: {
228087
228124
  type: "object",
228088
228125
  properties: {
228089
- messages: {
228090
- default: [],
228091
- type: "array",
228092
- items: {
228093
- type: "string"
228126
+ tags: {
228127
+ type: "object",
228128
+ additionalProperties: {
228129
+ type: "object",
228130
+ properties: {
228131
+ title: {
228132
+ type: "string",
228133
+ description: "Title of the tag"
228134
+ },
228135
+ description: {
228136
+ type: "string",
228137
+ description: "Description of the tag"
228138
+ }
228139
+ },
228140
+ description: "Definition of a tag that can be provided on the object",
228141
+ nullable: true,
228142
+ additionalProperties: false
228094
228143
  }
228095
- },
228096
- conversations: {
228097
- default: [],
228098
- type: "array",
228099
- items: {
228100
- type: "string"
228144
+ }
228145
+ },
228146
+ additionalProperties: false
228147
+ },
228148
+ message: {
228149
+ type: "object",
228150
+ properties: {
228151
+ tags: {
228152
+ type: "object",
228153
+ additionalProperties: {
228154
+ type: "object",
228155
+ properties: {
228156
+ title: {
228157
+ type: "string",
228158
+ description: "Title of the tag"
228159
+ },
228160
+ description: {
228161
+ type: "string",
228162
+ description: "Description of the tag"
228163
+ }
228164
+ },
228165
+ description: "Definition of a tag that can be provided on the object",
228166
+ nullable: true,
228167
+ additionalProperties: false
228101
228168
  }
228102
- },
228103
- users: {
228104
- default: [],
228105
- type: "array",
228106
- items: {
228107
- type: "string"
228169
+ }
228170
+ },
228171
+ additionalProperties: false
228172
+ },
228173
+ conversation: {
228174
+ type: "object",
228175
+ properties: {
228176
+ tags: {
228177
+ type: "object",
228178
+ additionalProperties: {
228179
+ type: "object",
228180
+ properties: {
228181
+ title: {
228182
+ type: "string",
228183
+ description: "Title of the tag"
228184
+ },
228185
+ description: {
228186
+ type: "string",
228187
+ description: "Description of the tag"
228188
+ }
228189
+ },
228190
+ description: "Definition of a tag that can be provided on the object",
228191
+ nullable: true,
228192
+ additionalProperties: false
228108
228193
  }
228109
228194
  }
228110
228195
  },
228111
- description: "Tags of the bot",
228112
228196
  additionalProperties: false
228113
228197
  },
228114
228198
  events: {
@@ -228122,10 +228206,36 @@ var state = {
228122
228206
  }
228123
228207
  },
228124
228208
  required: ["schema"],
228125
- description: "Event schema",
228209
+ description: "Event Definition",
228210
+ nullable: true,
228126
228211
  additionalProperties: false
228127
- },
228128
- description: "Events definition"
228212
+ }
228213
+ },
228214
+ states: {
228215
+ type: "object",
228216
+ additionalProperties: {
228217
+ type: "object",
228218
+ properties: {
228219
+ type: {
228220
+ type: "string",
228221
+ enum: ["conversation", "user", "bot"],
228222
+ description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
228223
+ },
228224
+ schema: {
228225
+ type: "object",
228226
+ additionalProperties: true,
228227
+ 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."
228228
+ },
228229
+ expiry: {
228230
+ type: "number",
228231
+ minimum: 1,
228232
+ description: "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
228233
+ }
228234
+ },
228235
+ required: ["type", "schema"],
228236
+ nullable: true,
228237
+ additionalProperties: false
228238
+ }
228129
228239
  },
228130
228240
  recurringEvents: {
228131
228241
  type: "object",
@@ -228151,28 +228261,9 @@ var state = {
228151
228261
  }
228152
228262
  },
228153
228263
  required: ["schedule", "type", "payload"],
228264
+ nullable: true,
228154
228265
  additionalProperties: false
228155
- },
228156
- description: "Recurring events"
228157
- },
228158
- configuration: {
228159
- type: "object",
228160
- properties: {
228161
- data: {
228162
- type: "object",
228163
- additionalProperties: true,
228164
- description: "Configuration data"
228165
- },
228166
- schema: {
228167
- type: "object",
228168
- additionalProperties: true,
228169
- description: "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
228170
- }
228171
- },
228172
- additionalProperties: false
228173
- },
228174
- blocked: {
228175
- type: "boolean"
228266
+ }
228176
228267
  },
228177
228268
  integrations: {
228178
228269
  type: "object",
@@ -228682,91 +228773,19 @@ var state = {
228682
228773
  type: "string",
228683
228774
  description: "Version of the [Integration](#schema_integration)"
228684
228775
  },
228685
- tags: {
228776
+ configuration: {
228686
228777
  type: "object",
228687
228778
  properties: {
228688
- users: {
228689
- default: [],
228690
- type: "array",
228691
- items: {
228692
- type: "string"
228693
- }
228779
+ schema: {
228780
+ type: "object",
228781
+ additionalProperties: true,
228782
+ description: "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
228694
228783
  }
228695
228784
  },
228696
- description: "Tags of the [Integration](#schema_integration)",
228785
+ required: ["schema"],
228786
+ description: "Configuration definition",
228697
228787
  additionalProperties: false
228698
228788
  },
228699
- channels: {
228700
- type: "object",
228701
- additionalProperties: {
228702
- type: "object",
228703
- properties: {
228704
- tags: {
228705
- type: "object",
228706
- properties: {
228707
- messages: {
228708
- default: [],
228709
- type: "array",
228710
- items: {
228711
- type: "string"
228712
- }
228713
- },
228714
- conversations: {
228715
- default: [],
228716
- type: "array",
228717
- items: {
228718
- type: "string"
228719
- }
228720
- }
228721
- },
228722
- additionalProperties: false
228723
- },
228724
- messages: {
228725
- type: "object",
228726
- additionalProperties: {
228727
- type: "object",
228728
- properties: {
228729
- schema: {
228730
- type: "object",
228731
- additionalProperties: true
228732
- }
228733
- },
228734
- required: ["schema"],
228735
- additionalProperties: false
228736
- }
228737
- },
228738
- conversation: {
228739
- type: "object",
228740
- properties: {
228741
- creation: {
228742
- type: "object",
228743
- properties: {
228744
- enabled: {
228745
- type: "boolean",
228746
- description: "Enable conversation creation"
228747
- },
228748
- requiredTags: {
228749
- type: "array",
228750
- items: {
228751
- type: "string"
228752
- },
228753
- description: "The list of tags that are required to be specified when calling the API directly to create a conversation."
228754
- }
228755
- },
228756
- required: ["enabled", "requiredTags"],
228757
- 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.",
228758
- additionalProperties: false
228759
- }
228760
- },
228761
- required: ["creation"],
228762
- additionalProperties: false
228763
- }
228764
- },
228765
- required: ["messages"],
228766
- additionalProperties: false
228767
- },
228768
- description: "Channels definition"
228769
- },
228770
228789
  states: {
228771
228790
  type: "object",
228772
228791
  additionalProperties: {
@@ -228784,22 +228803,9 @@ var state = {
228784
228803
  }
228785
228804
  },
228786
228805
  required: ["type", "schema"],
228806
+ description: "State definition",
228787
228807
  additionalProperties: false
228788
- },
228789
- description: "States definition"
228790
- },
228791
- configuration: {
228792
- type: "object",
228793
- properties: {
228794
- schema: {
228795
- type: "object",
228796
- additionalProperties: true,
228797
- description: "Schema for the configuration"
228798
- }
228799
- },
228800
- required: ["schema"],
228801
- description: "Configuration definition",
228802
- additionalProperties: false
228808
+ }
228803
228809
  },
228804
228810
  events: {
228805
228811
  type: "object",
@@ -228812,10 +228818,9 @@ var state = {
228812
228818
  }
228813
228819
  },
228814
228820
  required: ["schema"],
228815
- description: "Event schema",
228821
+ description: "Event Definition",
228816
228822
  additionalProperties: false
228817
- },
228818
- description: "Events definition"
228823
+ }
228819
228824
  },
228820
228825
  actions: {
228821
228826
  type: "object",
@@ -228846,9 +228851,101 @@ var state = {
228846
228851
  }
228847
228852
  },
228848
228853
  required: ["input", "output"],
228854
+ description: "Action definition",
228849
228855
  additionalProperties: false
228850
- },
228851
- description: "Action definition"
228856
+ }
228857
+ },
228858
+ channels: {
228859
+ type: "object",
228860
+ additionalProperties: {
228861
+ type: "object",
228862
+ properties: {
228863
+ messages: {
228864
+ type: "object",
228865
+ additionalProperties: {
228866
+ type: "object",
228867
+ properties: {
228868
+ schema: {
228869
+ type: "object",
228870
+ additionalProperties: true
228871
+ }
228872
+ },
228873
+ required: ["schema"],
228874
+ description: "Message definition",
228875
+ additionalProperties: false
228876
+ }
228877
+ },
228878
+ conversation: {
228879
+ type: "object",
228880
+ properties: {
228881
+ creation: {
228882
+ type: "object",
228883
+ properties: {
228884
+ enabled: {
228885
+ type: "boolean",
228886
+ description: "Enable conversation creation"
228887
+ },
228888
+ requiredTags: {
228889
+ type: "array",
228890
+ items: {
228891
+ type: "string"
228892
+ },
228893
+ description: "The list of tags that are required to be specified when calling the API directly to create a conversation."
228894
+ }
228895
+ },
228896
+ required: ["enabled", "requiredTags"],
228897
+ 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.",
228898
+ additionalProperties: false
228899
+ },
228900
+ tags: {
228901
+ type: "object",
228902
+ additionalProperties: {
228903
+ type: "object",
228904
+ properties: {
228905
+ title: {
228906
+ type: "string",
228907
+ description: "Title of the tag"
228908
+ },
228909
+ description: {
228910
+ type: "string",
228911
+ description: "Description of the tag"
228912
+ }
228913
+ },
228914
+ description: "Definition of a tag that can be provided on the object",
228915
+ additionalProperties: false
228916
+ }
228917
+ }
228918
+ },
228919
+ additionalProperties: false
228920
+ },
228921
+ message: {
228922
+ type: "object",
228923
+ properties: {
228924
+ tags: {
228925
+ type: "object",
228926
+ additionalProperties: {
228927
+ type: "object",
228928
+ properties: {
228929
+ title: {
228930
+ type: "string",
228931
+ description: "Title of the tag"
228932
+ },
228933
+ description: {
228934
+ type: "string",
228935
+ description: "Description of the tag"
228936
+ }
228937
+ },
228938
+ description: "Definition of a tag that can be provided on the object",
228939
+ additionalProperties: false
228940
+ }
228941
+ }
228942
+ },
228943
+ additionalProperties: false
228944
+ }
228945
+ },
228946
+ required: ["messages"],
228947
+ additionalProperties: false
228948
+ }
228852
228949
  },
228853
228950
  user: {
228854
228951
  type: "object",
@@ -228871,19 +228968,32 @@ var state = {
228871
228968
  required: ["enabled", "requiredTags"],
228872
228969
  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.",
228873
228970
  additionalProperties: false
228971
+ },
228972
+ tags: {
228973
+ type: "object",
228974
+ additionalProperties: {
228975
+ type: "object",
228976
+ properties: {
228977
+ title: {
228978
+ type: "string",
228979
+ description: "Title of the tag"
228980
+ },
228981
+ description: {
228982
+ type: "string",
228983
+ description: "Description of the tag"
228984
+ }
228985
+ },
228986
+ description: "Definition of a tag that can be provided on the object",
228987
+ additionalProperties: false
228988
+ }
228874
228989
  }
228875
228990
  },
228876
- required: ["creation"],
228877
228991
  additionalProperties: false
228878
228992
  },
228879
228993
  code: {
228880
228994
  type: "string",
228881
228995
  description: "JavaScript code of the integration"
228882
228996
  },
228883
- public: {
228884
- type: "boolean",
228885
- description: "Whether the integration is public"
228886
- },
228887
228997
  url: {
228888
228998
  type: "string",
228889
228999
  description: "URL of the integration; Only available for dev integrations"
@@ -228951,18 +229061,17 @@ var state = {
228951
229061
  schema: {
228952
229062
  type: "object",
228953
229063
  properties: {
228954
- tags: {
229064
+ configuration: {
228955
229065
  type: "object",
228956
229066
  properties: {
228957
- users: {
228958
- default: [],
228959
- type: "array",
228960
- items: {
228961
- type: "string"
228962
- }
229067
+ schema: {
229068
+ type: "object",
229069
+ additionalProperties: true,
229070
+ description: "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
228963
229071
  }
228964
229072
  },
228965
- description: "Tags of the [Integration](#schema_integration)",
229073
+ required: ["schema"],
229074
+ description: "Configuration definition",
228966
229075
  additionalProperties: false
228967
229076
  },
228968
229077
  channels: {
@@ -228970,26 +229079,6 @@ var state = {
228970
229079
  additionalProperties: {
228971
229080
  type: "object",
228972
229081
  properties: {
228973
- tags: {
228974
- type: "object",
228975
- properties: {
228976
- messages: {
228977
- default: [],
228978
- type: "array",
228979
- items: {
228980
- type: "string"
228981
- }
228982
- },
228983
- conversations: {
228984
- default: [],
228985
- type: "array",
228986
- items: {
228987
- type: "string"
228988
- }
228989
- }
228990
- },
228991
- additionalProperties: false
228992
- },
228993
229082
  messages: {
228994
229083
  type: "object",
228995
229084
  additionalProperties: {
@@ -229001,6 +229090,8 @@ var state = {
229001
229090
  }
229002
229091
  },
229003
229092
  required: ["schema"],
229093
+ description: "Message definition",
229094
+ nullable: true,
229004
229095
  additionalProperties: false
229005
229096
  }
229006
229097
  },
@@ -229025,50 +229116,91 @@ var state = {
229025
229116
  required: ["enabled", "requiredTags"],
229026
229117
  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.",
229027
229118
  additionalProperties: false
229119
+ },
229120
+ tags: {
229121
+ type: "object",
229122
+ additionalProperties: {
229123
+ type: "object",
229124
+ properties: {
229125
+ title: {
229126
+ type: "string",
229127
+ description: "Title of the tag"
229128
+ },
229129
+ description: {
229130
+ type: "string",
229131
+ description: "Description of the tag"
229132
+ }
229133
+ },
229134
+ description: "Definition of a tag that can be provided on the object",
229135
+ nullable: true,
229136
+ additionalProperties: false
229137
+ }
229138
+ }
229139
+ },
229140
+ additionalProperties: false
229141
+ },
229142
+ message: {
229143
+ type: "object",
229144
+ properties: {
229145
+ tags: {
229146
+ type: "object",
229147
+ additionalProperties: {
229148
+ type: "object",
229149
+ properties: {
229150
+ title: {
229151
+ type: "string",
229152
+ description: "Title of the tag"
229153
+ },
229154
+ description: {
229155
+ type: "string",
229156
+ description: "Description of the tag"
229157
+ }
229158
+ },
229159
+ description: "Definition of a tag that can be provided on the object",
229160
+ nullable: true,
229161
+ additionalProperties: false
229162
+ }
229028
229163
  }
229029
229164
  },
229030
- required: ["creation"],
229031
229165
  additionalProperties: false
229032
229166
  }
229033
229167
  },
229034
- required: ["messages"],
229035
229168
  additionalProperties: false
229036
- },
229037
- description: "Channels definition"
229169
+ }
229038
229170
  },
229039
- states: {
229171
+ actions: {
229040
229172
  type: "object",
229041
229173
  additionalProperties: {
229042
229174
  type: "object",
229043
229175
  properties: {
229044
- type: {
229045
- type: "string",
229046
- enum: ["conversation", "user", "integration"],
229047
- description: "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
229176
+ input: {
229177
+ type: "object",
229178
+ properties: {
229179
+ schema: {
229180
+ type: "object",
229181
+ additionalProperties: true
229182
+ }
229183
+ },
229184
+ required: ["schema"],
229185
+ additionalProperties: false
229048
229186
  },
229049
- schema: {
229187
+ output: {
229050
229188
  type: "object",
229051
- additionalProperties: true,
229052
- 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."
229189
+ properties: {
229190
+ schema: {
229191
+ type: "object",
229192
+ additionalProperties: true
229193
+ }
229194
+ },
229195
+ required: ["schema"],
229196
+ additionalProperties: false
229053
229197
  }
229054
229198
  },
229055
- required: ["type", "schema"],
229199
+ required: ["input", "output"],
229200
+ description: "Action definition",
229201
+ nullable: true,
229056
229202
  additionalProperties: false
229057
- },
229058
- description: "States definition"
229059
- },
229060
- configuration: {
229061
- type: "object",
229062
- properties: {
229063
- schema: {
229064
- type: "object",
229065
- additionalProperties: true,
229066
- description: "Schema for the configuration"
229067
- }
229068
- },
229069
- required: ["schema"],
229070
- description: "Configuration definition",
229071
- additionalProperties: false
229203
+ }
229072
229204
  },
229073
229205
  events: {
229074
229206
  type: "object",
@@ -229081,43 +229213,32 @@ var state = {
229081
229213
  }
229082
229214
  },
229083
229215
  required: ["schema"],
229084
- description: "Event schema",
229216
+ description: "Event Definition",
229217
+ nullable: true,
229085
229218
  additionalProperties: false
229086
- },
229087
- description: "Events definition"
229219
+ }
229088
229220
  },
229089
- actions: {
229221
+ states: {
229090
229222
  type: "object",
229091
229223
  additionalProperties: {
229092
229224
  type: "object",
229093
229225
  properties: {
229094
- input: {
229095
- type: "object",
229096
- properties: {
229097
- schema: {
229098
- type: "object",
229099
- additionalProperties: true
229100
- }
229101
- },
229102
- required: ["schema"],
229103
- additionalProperties: false
229226
+ type: {
229227
+ type: "string",
229228
+ enum: ["conversation", "user", "integration"],
229229
+ description: "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
229104
229230
  },
229105
- output: {
229231
+ schema: {
229106
229232
  type: "object",
229107
- properties: {
229108
- schema: {
229109
- type: "object",
229110
- additionalProperties: true
229111
- }
229112
- },
229113
- required: ["schema"],
229114
- additionalProperties: false
229233
+ additionalProperties: true,
229234
+ 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."
229115
229235
  }
229116
229236
  },
229117
- required: ["input", "output"],
229237
+ required: ["type", "schema"],
229238
+ description: "State definition",
229239
+ nullable: true,
229118
229240
  additionalProperties: false
229119
- },
229120
- description: "Action definition"
229241
+ }
229121
229242
  },
229122
229243
  user: {
229123
229244
  type: "object",
@@ -229140,23 +229261,33 @@ var state = {
229140
229261
  required: ["enabled", "requiredTags"],
229141
229262
  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.",
229142
229263
  additionalProperties: false
229264
+ },
229265
+ tags: {
229266
+ type: "object",
229267
+ additionalProperties: {
229268
+ type: "object",
229269
+ properties: {
229270
+ title: {
229271
+ type: "string",
229272
+ description: "Title of the tag"
229273
+ },
229274
+ description: {
229275
+ type: "string",
229276
+ description: "Description of the tag"
229277
+ }
229278
+ },
229279
+ description: "Definition of a tag that can be provided on the object",
229280
+ nullable: true,
229281
+ additionalProperties: false
229282
+ }
229143
229283
  }
229144
229284
  },
229145
- required: ["creation"],
229146
229285
  additionalProperties: false
229147
229286
  },
229148
229287
  code: {
229149
229288
  type: "string",
229150
229289
  description: "JavaScript code of the integration"
229151
229290
  },
229152
- public: {
229153
- type: "boolean",
229154
- description: "Whether the integration is public"
229155
- },
229156
- url: {
229157
- type: "string",
229158
- description: "URL of the integration; Only available for dev integrations"
229159
- },
229160
229291
  icon: {
229161
229292
  type: "string",
229162
229293
  description: "Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes."
@@ -229175,6 +229306,10 @@ var state = {
229175
229306
  type: "string",
229176
229307
  maxLength: 256,
229177
229308
  description: "Description of the integration. This is the description that will be displayed in the UI"
229309
+ },
229310
+ url: {
229311
+ type: "string",
229312
+ description: "URL of the integration; Only available for dev integrations"
229178
229313
  }
229179
229314
  },
229180
229315
  title: "updateIntegrationBody",
@@ -229640,7 +229775,7 @@ var state = {
229640
229775
  title: "Botpress API",
229641
229776
  description: "API for Botpress Cloud",
229642
229777
  server: "https://api.botpress.cloud",
229643
- version: "0.2.0",
229778
+ version: "0.2.2",
229644
229779
  prefix: "v1"
229645
229780
  },
229646
229781
  errors: [
@@ -229887,6 +230022,84 @@ var state = {
229887
230022
  },
229888
230023
  description: "A mapping of integrations to their configuration"
229889
230024
  },
230025
+ user: {
230026
+ type: "object",
230027
+ properties: {
230028
+ tags: {
230029
+ type: "object",
230030
+ additionalProperties: {
230031
+ type: "object",
230032
+ properties: {
230033
+ title: {
230034
+ type: "string",
230035
+ description: "Title of the tag"
230036
+ },
230037
+ description: {
230038
+ type: "string",
230039
+ description: "Description of the tag"
230040
+ }
230041
+ },
230042
+ description: "Definition of a tag that can be provided on the object",
230043
+ additionalProperties: false
230044
+ }
230045
+ }
230046
+ },
230047
+ required: ["tags"],
230048
+ description: "User object configuration",
230049
+ additionalProperties: false
230050
+ },
230051
+ conversation: {
230052
+ type: "object",
230053
+ properties: {
230054
+ tags: {
230055
+ type: "object",
230056
+ additionalProperties: {
230057
+ type: "object",
230058
+ properties: {
230059
+ title: {
230060
+ type: "string",
230061
+ description: "Title of the tag"
230062
+ },
230063
+ description: {
230064
+ type: "string",
230065
+ description: "Description of the tag"
230066
+ }
230067
+ },
230068
+ description: "Definition of a tag that can be provided on the object",
230069
+ additionalProperties: false
230070
+ }
230071
+ }
230072
+ },
230073
+ required: ["tags"],
230074
+ description: "Conversation object configuration",
230075
+ additionalProperties: false
230076
+ },
230077
+ message: {
230078
+ type: "object",
230079
+ properties: {
230080
+ tags: {
230081
+ type: "object",
230082
+ additionalProperties: {
230083
+ type: "object",
230084
+ properties: {
230085
+ title: {
230086
+ type: "string",
230087
+ description: "Title of the tag"
230088
+ },
230089
+ description: {
230090
+ type: "string",
230091
+ description: "Description of the tag"
230092
+ }
230093
+ },
230094
+ description: "Definition of a tag that can be provided on the object",
230095
+ additionalProperties: false
230096
+ }
230097
+ }
230098
+ },
230099
+ required: ["tags"],
230100
+ description: "Message object configuration",
230101
+ additionalProperties: false
230102
+ },
229890
230103
  states: {
229891
230104
  type: "object",
229892
230105
  additionalProperties: {
@@ -229913,34 +230126,6 @@ var state = {
229913
230126
  },
229914
230127
  description: "A mapping of states to their definition"
229915
230128
  },
229916
- tags: {
229917
- type: "object",
229918
- properties: {
229919
- messages: {
229920
- default: [],
229921
- type: "array",
229922
- items: {
229923
- type: "string"
229924
- }
229925
- },
229926
- conversations: {
229927
- default: [],
229928
- type: "array",
229929
- items: {
229930
- type: "string"
229931
- }
229932
- },
229933
- users: {
229934
- default: [],
229935
- type: "array",
229936
- items: {
229937
- type: "string"
229938
- }
229939
- }
229940
- },
229941
- description: "Tags of the bot",
229942
- additionalProperties: false
229943
- },
229944
230129
  configuration: {
229945
230130
  type: "object",
229946
230131
  properties: {
@@ -229970,7 +230155,7 @@ var state = {
229970
230155
  }
229971
230156
  },
229972
230157
  required: ["schema"],
229973
- description: "Event schema",
230158
+ description: "Event Definition",
229974
230159
  additionalProperties: false
229975
230160
  },
229976
230161
  description: "Events definition"
@@ -230045,8 +230230,10 @@ var state = {
230045
230230
  "updatedAt",
230046
230231
  "signingSecret",
230047
230232
  "integrations",
230233
+ "user",
230234
+ "conversation",
230235
+ "message",
230048
230236
  "states",
230049
- "tags",
230050
230237
  "configuration",
230051
230238
  "events",
230052
230239
  "recurringEvents",
@@ -230084,31 +230271,24 @@ var state = {
230084
230271
  type: "string",
230085
230272
  description: "Version of the [Integration](#schema_integration)"
230086
230273
  },
230274
+ configuration: {
230275
+ type: "object",
230276
+ properties: {
230277
+ schema: {
230278
+ type: "object",
230279
+ additionalProperties: true,
230280
+ description: "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
230281
+ }
230282
+ },
230283
+ required: ["schema"],
230284
+ description: "Configuration definition",
230285
+ additionalProperties: false
230286
+ },
230087
230287
  channels: {
230088
230288
  type: "object",
230089
230289
  additionalProperties: {
230090
230290
  type: "object",
230091
230291
  properties: {
230092
- tags: {
230093
- type: "object",
230094
- properties: {
230095
- messages: {
230096
- default: [],
230097
- type: "array",
230098
- items: {
230099
- type: "string"
230100
- }
230101
- },
230102
- conversations: {
230103
- default: [],
230104
- type: "array",
230105
- items: {
230106
- type: "string"
230107
- }
230108
- }
230109
- },
230110
- additionalProperties: false
230111
- },
230112
230292
  messages: {
230113
230293
  type: "object",
230114
230294
  additionalProperties: {
@@ -230120,12 +230300,31 @@ var state = {
230120
230300
  }
230121
230301
  },
230122
230302
  required: ["schema"],
230303
+ description: "Message definition",
230123
230304
  additionalProperties: false
230124
230305
  }
230125
230306
  },
230126
230307
  conversation: {
230127
230308
  type: "object",
230128
230309
  properties: {
230310
+ tags: {
230311
+ type: "object",
230312
+ additionalProperties: {
230313
+ type: "object",
230314
+ properties: {
230315
+ title: {
230316
+ type: "string",
230317
+ description: "Title of the tag"
230318
+ },
230319
+ description: {
230320
+ type: "string",
230321
+ description: "Description of the tag"
230322
+ }
230323
+ },
230324
+ description: "Definition of a tag that can be provided on the object",
230325
+ additionalProperties: false
230326
+ }
230327
+ },
230129
230328
  creation: {
230130
230329
  type: "object",
230131
230330
  properties: {
@@ -230146,17 +230345,43 @@ var state = {
230146
230345
  additionalProperties: false
230147
230346
  }
230148
230347
  },
230149
- required: ["creation"],
230348
+ required: ["tags", "creation"],
230349
+ description: "Conversation object configuration",
230350
+ additionalProperties: false
230351
+ },
230352
+ message: {
230353
+ type: "object",
230354
+ properties: {
230355
+ tags: {
230356
+ type: "object",
230357
+ additionalProperties: {
230358
+ type: "object",
230359
+ properties: {
230360
+ title: {
230361
+ type: "string",
230362
+ description: "Title of the tag"
230363
+ },
230364
+ description: {
230365
+ type: "string",
230366
+ description: "Description of the tag"
230367
+ }
230368
+ },
230369
+ description: "Definition of a tag that can be provided on the object",
230370
+ additionalProperties: false
230371
+ }
230372
+ }
230373
+ },
230374
+ required: ["tags"],
230375
+ description: "Message object configuration",
230150
230376
  additionalProperties: false
230151
230377
  }
230152
230378
  },
230153
- required: ["tags", "messages", "conversation"],
230379
+ required: ["messages", "conversation", "message"],
230380
+ description: "Channel definition",
230154
230381
  additionalProperties: false
230155
- },
230156
- description: "Channels definition"
230382
+ }
230157
230383
  },
230158
230384
  states: {
230159
- default: {},
230160
230385
  type: "object",
230161
230386
  additionalProperties: {
230162
230387
  type: "object",
@@ -230173,22 +230398,9 @@ var state = {
230173
230398
  }
230174
230399
  },
230175
230400
  required: ["type", "schema"],
230401
+ description: "State definition",
230176
230402
  additionalProperties: false
230177
- },
230178
- description: "States definition"
230179
- },
230180
- configuration: {
230181
- type: "object",
230182
- properties: {
230183
- schema: {
230184
- type: "object",
230185
- additionalProperties: true,
230186
- description: "Schema for the configuration"
230187
- }
230188
- },
230189
- required: ["schema"],
230190
- description: "Configuration definition",
230191
- additionalProperties: false
230403
+ }
230192
230404
  },
230193
230405
  events: {
230194
230406
  type: "object",
@@ -230201,10 +230413,9 @@ var state = {
230201
230413
  }
230202
230414
  },
230203
230415
  required: ["schema"],
230204
- description: "Event schema",
230416
+ description: "Event Definition",
230205
230417
  additionalProperties: false
230206
- },
230207
- description: "Events definition"
230418
+ }
230208
230419
  },
230209
230420
  actions: {
230210
230421
  type: "object",
@@ -230235,13 +230446,31 @@ var state = {
230235
230446
  }
230236
230447
  },
230237
230448
  required: ["input", "output"],
230449
+ description: "Action definition",
230238
230450
  additionalProperties: false
230239
- },
230240
- description: "Action definition"
230451
+ }
230241
230452
  },
230242
230453
  user: {
230243
230454
  type: "object",
230244
230455
  properties: {
230456
+ tags: {
230457
+ type: "object",
230458
+ additionalProperties: {
230459
+ type: "object",
230460
+ properties: {
230461
+ title: {
230462
+ type: "string",
230463
+ description: "Title of the tag"
230464
+ },
230465
+ description: {
230466
+ type: "string",
230467
+ description: "Description of the tag"
230468
+ }
230469
+ },
230470
+ description: "Definition of a tag that can be provided on the object",
230471
+ additionalProperties: false
230472
+ }
230473
+ },
230245
230474
  creation: {
230246
230475
  type: "object",
230247
230476
  properties: {
@@ -230262,7 +230491,8 @@ var state = {
230262
230491
  additionalProperties: false
230263
230492
  }
230264
230493
  },
230265
- required: ["creation"],
230494
+ required: ["tags", "creation"],
230495
+ description: "User object configuration",
230266
230496
  additionalProperties: false
230267
230497
  },
230268
230498
  dev: {
@@ -230295,8 +230525,9 @@ var state = {
230295
230525
  "updatedAt",
230296
230526
  "name",
230297
230527
  "version",
230298
- "channels",
230299
230528
  "configuration",
230529
+ "channels",
230530
+ "states",
230300
230531
  "events",
230301
230532
  "actions",
230302
230533
  "user",