@alwaysai/device-agent-schemas 2.1.12 → 2.2.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.
Files changed (248) hide show
  1. package/.eslintrc +1 -21
  2. package/docs/README.md +47 -21
  3. package/docs/app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload-properties-appsignedurl.md +15 -0
  4. package/docs/app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload.md +39 -0
  5. package/docs/app-install-response-schema-properties-appinstallresponse-properties-appreleasehash.md +25 -0
  6. package/docs/app-install-response-schema-properties-appinstallresponse-properties-models_install_payload.md +15 -0
  7. package/docs/app-install-response-schema-properties-appinstallresponse-properties-projectid.md +25 -0
  8. package/docs/app-install-response-schema-properties-appinstallresponse.md +116 -0
  9. package/docs/app-install-response-schema.md +39 -0
  10. package/docs/app-install-schema-properties-projectid.md +2 -2
  11. package/docs/app-install-schema.md +2 -2
  12. package/docs/app-logs-schema-properties-logchunk.md +15 -0
  13. package/docs/app-logs-schema-properties-projectid.md +25 -0
  14. package/docs/app-logs-schema.md +23 -21
  15. package/docs/app-state-control-schema-properties-basecommand.md +25 -0
  16. package/docs/app-state-control-schema-properties-projectid.md +25 -0
  17. package/docs/app-state-control-schema.md +34 -22
  18. package/docs/app-state-schema-properties-appstate-items-properties-appdetails-properties-projectid.md +2 -2
  19. package/docs/app-state-schema-properties-appstate-items-properties-appdetails.md +2 -2
  20. package/docs/app-state-schema.md +3 -30
  21. package/docs/app-uninstall-schema-properties-projectid.md +2 -2
  22. package/docs/app-uninstall-schema.md +2 -2
  23. package/docs/app-version-control-schema.md +5 -56
  24. package/docs/common-schema-defs-appreleasehash.md +5 -5
  25. package/docs/common-schema-defs-projectid.md +7 -7
  26. package/docs/common-schema-defs-txid.md +29 -0
  27. package/docs/common-schema.md +11 -0
  28. package/docs/device-action-schema-properties-action.md +23 -0
  29. package/docs/device-action-schema.md +47 -0
  30. package/docs/device-stats-schema-properties-cpudetails-properties-temperature.md +15 -0
  31. package/docs/device-stats-schema-properties-cpudetails-properties-usedperc.md +15 -0
  32. package/docs/device-stats-schema-properties-cpudetails.md +58 -0
  33. package/docs/device-stats-schema-properties-cpuusage.md +15 -0
  34. package/docs/device-stats-schema-properties-diskdetails-properties-freegb.md +15 -0
  35. package/docs/device-stats-schema-properties-diskdetails-properties-usedgb.md +15 -0
  36. package/docs/device-stats-schema-properties-diskdetails.md +58 -0
  37. package/docs/device-stats-schema-properties-diskutil.md +15 -0
  38. package/docs/device-stats-schema-properties-memdetails-properties-freemb.md +15 -0
  39. package/docs/device-stats-schema-properties-memdetails-properties-usedmb.md +15 -0
  40. package/docs/device-stats-schema-properties-memdetails.md +58 -0
  41. package/docs/device-stats-schema-properties-usedmemorypercentage.md +15 -0
  42. package/docs/device-stats-schema.md +134 -0
  43. package/docs/live-updates-toggle-schema-properties-applogs-properties-toggle.md +15 -0
  44. package/docs/live-updates-toggle-schema-properties-applogs.md +68 -0
  45. package/docs/live-updates-toggle-schema-properties-appstate.md +15 -0
  46. package/docs/live-updates-toggle-schema-properties-devicestats.md +15 -0
  47. package/docs/live-updates-toggle-schema.md +34 -23
  48. package/docs/models-install-response-schema-properties-modelsinstallresponse.md +68 -0
  49. package/docs/models-install-response-schema.md +39 -0
  50. package/docs/shadow-project-update-schema-properties-appconfig.md +15 -0
  51. package/docs/shadow-project-update-schema-properties-envvars-patternproperties--patternproperties-.md +15 -0
  52. package/docs/shadow-project-update-schema-properties-envvars-patternproperties--patternproperties.md +15 -0
  53. package/docs/shadow-project-update-schema-properties-envvars-patternproperties-.md +39 -0
  54. package/docs/shadow-project-update-schema-properties-envvars-patternproperties.md +15 -0
  55. package/docs/shadow-project-update-schema-properties-envvars.md +44 -0
  56. package/docs/shadow-project-update-schema.md +63 -0
  57. package/docs/shadow-projects-update-all-schema-patternproperties.md +15 -0
  58. package/docs/shadow-projects-update-all-schema-propertynames.md +25 -0
  59. package/docs/shadow-projects-update-all-schema.md +44 -0
  60. package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest.md +7 -7
  61. package/docs/signed-urls-request-schema-properties-signedurlsrequest.md +8 -8
  62. package/docs/signed-urls-request-schema.md +4 -31
  63. package/docs/status-response-schema-properties-message.md +15 -0
  64. package/docs/status-response-schema-properties-status.md +27 -0
  65. package/docs/status-response-schema.md +70 -0
  66. package/docs/system-information-schema-properties-cpu-properties-brand.md +15 -0
  67. package/docs/system-information-schema-properties-cpu-properties-cores.md +15 -0
  68. package/docs/system-information-schema-properties-cpu-properties-efficiencycores.md +15 -0
  69. package/docs/system-information-schema-properties-cpu-properties-manufacturer.md +15 -0
  70. package/docs/system-information-schema-properties-cpu-properties-model.md +15 -0
  71. package/docs/system-information-schema-properties-cpu-properties-physicalcores.md +15 -0
  72. package/docs/system-information-schema-properties-cpu-properties-processors.md +15 -0
  73. package/docs/system-information-schema-properties-cpu-properties-vendor.md +15 -0
  74. package/docs/system-information-schema-properties-cpu.md +172 -0
  75. package/docs/system-information-schema-properties-device-properties-manufacturer.md +15 -0
  76. package/docs/system-information-schema-properties-device-properties-model.md +15 -0
  77. package/docs/system-information-schema-properties-device-properties-serial.md +15 -0
  78. package/docs/system-information-schema-properties-device-properties-version.md +15 -0
  79. package/docs/system-information-schema-properties-device-properties-virtual.md +15 -0
  80. package/docs/system-information-schema-properties-device.md +115 -0
  81. package/docs/system-information-schema-properties-disk-properties-drives-items-properties-device.md +15 -0
  82. package/docs/system-information-schema-properties-disk-properties-drives-items-properties-name.md +15 -0
  83. package/docs/system-information-schema-properties-disk-properties-drives-items-properties-size.md +15 -0
  84. package/docs/system-information-schema-properties-disk-properties-drives-items-properties-type.md +15 -0
  85. package/docs/system-information-schema-properties-disk-properties-drives-items-properties-vendor.md +15 -0
  86. package/docs/system-information-schema-properties-disk-properties-drives-items.md +115 -0
  87. package/docs/system-information-schema-properties-disk-properties-drives.md +15 -0
  88. package/docs/system-information-schema-properties-disk.md +39 -0
  89. package/docs/system-information-schema-properties-network-properties-ipv4address.md +15 -0
  90. package/docs/system-information-schema-properties-network-properties-ipv6address.md +15 -0
  91. package/docs/system-information-schema-properties-network-properties-macaddress.md +15 -0
  92. package/docs/system-information-schema-properties-network.md +77 -0
  93. package/docs/system-information-schema-properties-os-properties-architecture.md +15 -0
  94. package/docs/system-information-schema-properties-os-properties-distro.md +15 -0
  95. package/docs/system-information-schema-properties-os-properties-hostname.md +15 -0
  96. package/docs/system-information-schema-properties-os-properties-kernel.md +15 -0
  97. package/docs/system-information-schema-properties-os-properties-platform.md +15 -0
  98. package/docs/system-information-schema-properties-os-properties-release.md +15 -0
  99. package/docs/system-information-schema-properties-os.md +134 -0
  100. package/docs/system-information-schema-properties-versions-properties-agent.md +15 -0
  101. package/docs/system-information-schema-properties-versions-properties-deviceagentschemas.md +15 -0
  102. package/docs/system-information-schema-properties-versions.md +58 -0
  103. package/docs/system-information-schema.md +134 -0
  104. package/docs/to-client-message-schema-allof-0-if-properties-messagetype.md +23 -0
  105. package/docs/to-client-message-schema-allof-0-if-properties.md +15 -0
  106. package/docs/to-client-message-schema-allof-0-if.md +47 -0
  107. package/docs/to-client-message-schema-allof-0-then-properties.md +15 -0
  108. package/docs/to-client-message-schema-allof-0-then.md +39 -0
  109. package/docs/to-client-message-schema-allof-0.md +15 -0
  110. package/docs/to-client-message-schema-allof-1-if-properties-messagetype.md +23 -0
  111. package/docs/to-client-message-schema-allof-1-if-properties.md +15 -0
  112. package/docs/to-client-message-schema-allof-1-if.md +47 -0
  113. package/docs/to-client-message-schema-allof-1-then-properties.md +15 -0
  114. package/docs/to-client-message-schema-allof-1-then.md +39 -0
  115. package/docs/to-client-message-schema-allof-1.md +15 -0
  116. package/docs/to-client-message-schema-allof-2-if-properties-messagetype.md +23 -0
  117. package/docs/to-client-message-schema-allof-2-if-properties.md +15 -0
  118. package/docs/to-client-message-schema-allof-2-if.md +47 -0
  119. package/docs/to-client-message-schema-allof-2-then-properties.md +15 -0
  120. package/docs/to-client-message-schema-allof-2-then.md +39 -0
  121. package/docs/to-client-message-schema-allof-2.md +15 -0
  122. package/docs/to-client-message-schema-allof-3-if-properties-messagetype.md +23 -0
  123. package/docs/to-client-message-schema-allof-3-if-properties.md +15 -0
  124. package/docs/to-client-message-schema-allof-3-if.md +47 -0
  125. package/docs/to-client-message-schema-allof-3-then-properties.md +15 -0
  126. package/docs/to-client-message-schema-allof-3-then.md +39 -0
  127. package/docs/to-client-message-schema-allof-3.md +15 -0
  128. package/docs/to-client-message-schema-defs-toclient.md +25 -0
  129. package/docs/to-client-message-schema-defs.md +15 -0
  130. package/docs/to-client-message-schema-properties-deviceid.md +15 -0
  131. package/docs/to-client-message-schema-properties-messagetype.md +26 -0
  132. package/docs/to-client-message-schema-properties-payload.md +25 -0
  133. package/docs/to-client-message-schema-properties-timestamp.md +15 -0
  134. package/docs/to-client-message-schema-properties-topic-oneof-0.md +25 -0
  135. package/docs/to-client-message-schema-properties-topic.md +19 -0
  136. package/docs/to-client-message-schema.md +196 -0
  137. package/docs/to-cloud-message-schema-allof-0-if-properties-messagetype.md +23 -0
  138. package/docs/to-cloud-message-schema-allof-0-if-properties.md +15 -0
  139. package/docs/to-cloud-message-schema-allof-0-if.md +47 -0
  140. package/docs/to-cloud-message-schema-allof-0-then-properties.md +15 -0
  141. package/docs/to-cloud-message-schema-allof-0-then.md +39 -0
  142. package/docs/to-cloud-message-schema-allof-0.md +15 -0
  143. package/docs/to-cloud-message-schema-defs-tocloud.md +25 -0
  144. package/docs/to-cloud-message-schema-defs.md +15 -0
  145. package/docs/to-cloud-message-schema-properties-deviceid.md +15 -0
  146. package/docs/to-cloud-message-schema-properties-messagetype.md +23 -0
  147. package/docs/to-cloud-message-schema-properties-payload.md +19 -0
  148. package/docs/to-cloud-message-schema-properties-timestamp.md +15 -0
  149. package/docs/to-cloud-message-schema-properties-topic-oneof-0.md +25 -0
  150. package/docs/to-cloud-message-schema-properties-topic.md +19 -0
  151. package/docs/to-cloud-message-schema.md +181 -0
  152. package/docs/to-device-agent-message-schema-allof-0-if-properties-messagetype.md +23 -0
  153. package/docs/to-device-agent-message-schema-allof-0-if-properties.md +15 -0
  154. package/docs/to-device-agent-message-schema-allof-0-if.md +47 -0
  155. package/docs/to-device-agent-message-schema-allof-0-then-properties.md +15 -0
  156. package/docs/to-device-agent-message-schema-allof-0-then.md +39 -0
  157. package/docs/to-device-agent-message-schema-allof-0.md +15 -0
  158. package/docs/to-device-agent-message-schema-allof-1-if-properties-messagetype.md +23 -0
  159. package/docs/to-device-agent-message-schema-allof-1-if-properties.md +15 -0
  160. package/docs/to-device-agent-message-schema-allof-1-if.md +47 -0
  161. package/docs/to-device-agent-message-schema-allof-1-then-properties.md +15 -0
  162. package/docs/to-device-agent-message-schema-allof-1-then.md +45 -0
  163. package/docs/to-device-agent-message-schema-allof-1.md +15 -0
  164. package/docs/to-device-agent-message-schema-allof-2-if-properties-messagetype.md +23 -0
  165. package/docs/to-device-agent-message-schema-allof-2-if-properties.md +15 -0
  166. package/docs/to-device-agent-message-schema-allof-2-if.md +47 -0
  167. package/docs/to-device-agent-message-schema-allof-2-then-properties.md +15 -0
  168. package/docs/to-device-agent-message-schema-allof-2-then.md +39 -0
  169. package/docs/to-device-agent-message-schema-allof-2.md +15 -0
  170. package/docs/to-device-agent-message-schema-allof-3-if-properties-messagetype.md +23 -0
  171. package/docs/to-device-agent-message-schema-allof-3-if-properties.md +15 -0
  172. package/docs/to-device-agent-message-schema-allof-3-if.md +47 -0
  173. package/docs/to-device-agent-message-schema-allof-3-then-properties.md +15 -0
  174. package/docs/to-device-agent-message-schema-allof-3-then.md +39 -0
  175. package/docs/to-device-agent-message-schema-allof-3.md +15 -0
  176. package/docs/to-device-agent-message-schema-allof-4-if-properties-messagetype.md +23 -0
  177. package/docs/to-device-agent-message-schema-allof-4-if-properties.md +15 -0
  178. package/docs/to-device-agent-message-schema-allof-4-if.md +47 -0
  179. package/docs/to-device-agent-message-schema-allof-4-then-properties.md +15 -0
  180. package/docs/to-device-agent-message-schema-allof-4-then.md +39 -0
  181. package/docs/to-device-agent-message-schema-allof-4.md +15 -0
  182. package/docs/to-device-agent-message-schema-allof-5-if-properties-messagetype.md +23 -0
  183. package/docs/to-device-agent-message-schema-allof-5-if-properties.md +15 -0
  184. package/docs/to-device-agent-message-schema-allof-5-if.md +47 -0
  185. package/docs/to-device-agent-message-schema-allof-5-then-properties.md +15 -0
  186. package/docs/to-device-agent-message-schema-allof-5-then.md +39 -0
  187. package/docs/to-device-agent-message-schema-allof-5.md +15 -0
  188. package/docs/to-device-agent-message-schema-allof-6-if-properties-messagetype.md +23 -0
  189. package/docs/to-device-agent-message-schema-allof-6-if-properties.md +15 -0
  190. package/docs/to-device-agent-message-schema-allof-6-if.md +47 -0
  191. package/docs/to-device-agent-message-schema-allof-6-then-properties.md +15 -0
  192. package/docs/to-device-agent-message-schema-allof-6-then.md +39 -0
  193. package/docs/to-device-agent-message-schema-allof-6.md +15 -0
  194. package/docs/to-device-agent-message-schema-defs-todevice.md +25 -0
  195. package/docs/to-device-agent-message-schema-defs.md +15 -0
  196. package/docs/to-device-agent-message-schema-properties-messagetype.md +29 -0
  197. package/docs/to-device-agent-message-schema-properties-payload.md +35 -0
  198. package/docs/to-device-agent-message-schema-properties-timestamp.md +15 -0
  199. package/docs/to-device-agent-message-schema-properties-topic.md +25 -0
  200. package/docs/to-device-agent-message-schema.md +202 -0
  201. package/lib/constants.d.ts.map +1 -1
  202. package/lib/constants.js +10 -10
  203. package/lib/constants.js.map +1 -1
  204. package/lib/constants.test.js.map +1 -1
  205. package/lib/device-agent-action-schema.d.ts.map +1 -1
  206. package/lib/index.d.ts +2 -2
  207. package/lib/index.d.ts.map +1 -1
  208. package/lib/index.js +11 -1
  209. package/lib/index.js.map +1 -1
  210. package/lib/message-builders.d.ts +11 -11
  211. package/lib/message-builders.d.ts.map +1 -1
  212. package/lib/message-builders.js +3 -4
  213. package/lib/message-builders.js.map +1 -1
  214. package/lib/schemas/shadow-project-update-schema.json +30 -0
  215. package/lib/schemas/shadow-projects-update-all-schema.json +17 -0
  216. package/lib/shadow-schema.d.ts +104 -0
  217. package/lib/shadow-schema.d.ts.map +1 -0
  218. package/lib/shadow-schema.js +75 -0
  219. package/lib/shadow-schema.js.map +1 -0
  220. package/lib/shadow-schema.test.d.ts +2 -0
  221. package/lib/shadow-schema.test.d.ts.map +1 -0
  222. package/lib/shadow-schema.test.js +148 -0
  223. package/lib/shadow-schema.test.js.map +1 -0
  224. package/lib/status-response-schema.d.ts.map +1 -1
  225. package/lib/types.d.ts.map +1 -1
  226. package/lib/types.js +1 -3
  227. package/lib/types.js.map +1 -1
  228. package/lib/types.test.js +92 -92
  229. package/lib/types.test.js.map +1 -1
  230. package/package.json +2 -4
  231. package/src/app-action-schema.ts +1 -1
  232. package/src/constants.test.ts +7 -5
  233. package/src/constants.ts +30 -19
  234. package/src/device-agent-action-schema.ts +2 -1
  235. package/src/index.ts +38 -13
  236. package/src/message-builders.ts +48 -37
  237. package/src/schemas/shadow-project-update-schema.json +30 -0
  238. package/src/schemas/shadow-projects-update-all-schema.json +17 -0
  239. package/src/shadow-schema.test.ts +172 -0
  240. package/src/shadow-schema.ts +172 -0
  241. package/src/status-response-schema.ts +2 -1
  242. package/src/types.test.ts +97 -94
  243. package/src/types.ts +30 -19
  244. package/lib/system-information-schema.d.ts +0 -45
  245. package/lib/system-information-schema.d.ts.map +0 -1
  246. package/lib/system-information-schema.js +0 -3
  247. package/lib/system-information-schema.js.map +0 -1
  248. package/src/system-information-schema.ts +0 -44
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/0/if/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,47 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/0/if
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## if Type
14
+
15
+ unknown
16
+
17
+ # if Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :-------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [messageType](#messagetype) | Not specified | Optional | cannot be null | [to\_client\_message](to-client-message-schema-allof-0-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/0/if/properties/messageType") |
22
+
23
+ ## messageType
24
+
25
+
26
+
27
+ `messageType`
28
+
29
+ * is optional
30
+
31
+ * Type: unknown
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-allof-0-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/0/if/properties/messageType")
36
+
37
+ ### messageType Type
38
+
39
+ unknown
40
+
41
+ ### messageType Constraints
42
+
43
+ **constant**: the value of this property must be equal to:
44
+
45
+ ```json
46
+ "device_stats"
47
+ ```
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/0/then/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,39 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/0/then
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## then Type
14
+
15
+ unknown
16
+
17
+ # then Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :------------------ | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [payload](#payload) | `object` | Optional | cannot be null | [to\_client\_message](to-client-message-schema-properties-payload-oneof-device_stats.md "https://alwaysai.co/device-stats-schema.json#/allOf/0/then/properties/payload") |
22
+
23
+ ## payload
24
+
25
+
26
+
27
+ `payload`
28
+
29
+ * is optional
30
+
31
+ * Type: `object` ([device\_stats](to-client-message-schema-properties-payload-oneof-device_stats.md))
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-properties-payload-oneof-device_stats.md "https://alwaysai.co/device-stats-schema.json#/allOf/0/then/properties/payload")
36
+
37
+ ### payload Type
38
+
39
+ `object` ([device\_stats](to-client-message-schema-properties-payload-oneof-device_stats.md))
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/0
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## 0 Type
14
+
15
+ unknown
@@ -0,0 +1,23 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/1/if/properties/messageType
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## messageType Type
14
+
15
+ unknown
16
+
17
+ ## messageType Constraints
18
+
19
+ **constant**: the value of this property must be equal to:
20
+
21
+ ```json
22
+ "app_state"
23
+ ```
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/1/if/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,47 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/1/if
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## if Type
14
+
15
+ unknown
16
+
17
+ # if Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :-------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [messageType](#messagetype) | Not specified | Optional | cannot be null | [to\_client\_message](to-client-message-schema-allof-1-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/1/if/properties/messageType") |
22
+
23
+ ## messageType
24
+
25
+
26
+
27
+ `messageType`
28
+
29
+ * is optional
30
+
31
+ * Type: unknown
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-allof-1-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/1/if/properties/messageType")
36
+
37
+ ### messageType Type
38
+
39
+ unknown
40
+
41
+ ### messageType Constraints
42
+
43
+ **constant**: the value of this property must be equal to:
44
+
45
+ ```json
46
+ "app_state"
47
+ ```
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/1/then/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,39 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/1/then
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## then Type
14
+
15
+ unknown
16
+
17
+ # then Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :------------------ | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [payload](#payload) | `object` | Optional | cannot be null | [to\_client\_message](to-client-message-schema-properties-payload-oneof-app_state.md "https://alwaysai.co/app-state-schema.json#/allOf/1/then/properties/payload") |
22
+
23
+ ## payload
24
+
25
+
26
+
27
+ `payload`
28
+
29
+ * is optional
30
+
31
+ * Type: `object` ([app\_state](to-client-message-schema-properties-payload-oneof-app_state.md))
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-properties-payload-oneof-app_state.md "https://alwaysai.co/app-state-schema.json#/allOf/1/then/properties/payload")
36
+
37
+ ### payload Type
38
+
39
+ `object` ([app\_state](to-client-message-schema-properties-payload-oneof-app_state.md))
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/1
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## 1 Type
14
+
15
+ unknown
@@ -0,0 +1,23 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/2/if/properties/messageType
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## messageType Type
14
+
15
+ unknown
16
+
17
+ ## messageType Constraints
18
+
19
+ **constant**: the value of this property must be equal to:
20
+
21
+ ```json
22
+ "status_response"
23
+ ```
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/2/if/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,47 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/2/if
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## if Type
14
+
15
+ unknown
16
+
17
+ # if Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :-------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [messageType](#messagetype) | Not specified | Optional | cannot be null | [to\_client\_message](to-client-message-schema-allof-2-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/2/if/properties/messageType") |
22
+
23
+ ## messageType
24
+
25
+
26
+
27
+ `messageType`
28
+
29
+ * is optional
30
+
31
+ * Type: unknown
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-allof-2-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/2/if/properties/messageType")
36
+
37
+ ### messageType Type
38
+
39
+ unknown
40
+
41
+ ### messageType Constraints
42
+
43
+ **constant**: the value of this property must be equal to:
44
+
45
+ ```json
46
+ "status_response"
47
+ ```
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/2/then/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,39 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/2/then
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## then Type
14
+
15
+ unknown
16
+
17
+ # then Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :------------------ | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [payload](#payload) | `object` | Optional | cannot be null | [to\_client\_message](to-client-message-schema-properties-payload-oneof-status_response.md "https://alwaysai.co/status-response-schema.json#/allOf/2/then/properties/payload") |
22
+
23
+ ## payload
24
+
25
+
26
+
27
+ `payload`
28
+
29
+ * is optional
30
+
31
+ * Type: `object` ([status\_response](to-client-message-schema-properties-payload-oneof-status_response.md))
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-properties-payload-oneof-status_response.md "https://alwaysai.co/status-response-schema.json#/allOf/2/then/properties/payload")
36
+
37
+ ### payload Type
38
+
39
+ `object` ([status\_response](to-client-message-schema-properties-payload-oneof-status_response.md))
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/2
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## 2 Type
14
+
15
+ unknown
@@ -0,0 +1,23 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/3/if/properties/messageType
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## messageType Type
14
+
15
+ unknown
16
+
17
+ ## messageType Constraints
18
+
19
+ **constant**: the value of this property must be equal to:
20
+
21
+ ```json
22
+ "app_logs"
23
+ ```
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/3/if/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,47 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/3/if
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## if Type
14
+
15
+ unknown
16
+
17
+ # if Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :-------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [messageType](#messagetype) | Not specified | Optional | cannot be null | [to\_client\_message](to-client-message-schema-allof-3-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/3/if/properties/messageType") |
22
+
23
+ ## messageType
24
+
25
+
26
+
27
+ `messageType`
28
+
29
+ * is optional
30
+
31
+ * Type: unknown
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-allof-3-if-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/allOf/3/if/properties/messageType")
36
+
37
+ ### messageType Type
38
+
39
+ unknown
40
+
41
+ ### messageType Constraints
42
+
43
+ **constant**: the value of this property must be equal to:
44
+
45
+ ```json
46
+ "app_logs"
47
+ ```
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/3/then/properties
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## properties Type
14
+
15
+ unknown
@@ -0,0 +1,39 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/3/then
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## then Type
14
+
15
+ unknown
16
+
17
+ # then Properties
18
+
19
+ | Property | Type | Required | Nullable | Defined by |
20
+ | :------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
+ | [payload](#payload) | `object` | Optional | cannot be null | [to\_client\_message](to-client-message-schema-properties-payload-oneof-app_logs.md "https://alwaysai.co/app-logs-schema.json#/allOf/3/then/properties/payload") |
22
+
23
+ ## payload
24
+
25
+
26
+
27
+ `payload`
28
+
29
+ * is optional
30
+
31
+ * Type: `object` ([app\_logs](to-client-message-schema-properties-payload-oneof-app_logs.md))
32
+
33
+ * cannot be null
34
+
35
+ * defined in: [to\_client\_message](to-client-message-schema-properties-payload-oneof-app_logs.md "https://alwaysai.co/app-logs-schema.json#/allOf/3/then/properties/payload")
36
+
37
+ ### payload Type
38
+
39
+ `object` ([app\_logs](to-client-message-schema-properties-payload-oneof-app_logs.md))
@@ -0,0 +1,15 @@
1
+ # Untitled undefined type in to\_client\_message Schema
2
+
3
+ ```txt
4
+ https://alwaysai.co/to-client-message-schema.json#/allOf/3
5
+ ```
6
+
7
+
8
+
9
+ | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
10
+ | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
11
+ | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-client-message-schema.json\*](../out/to-client-message-schema.json "open original schema") |
12
+
13
+ ## 3 Type
14
+
15
+ unknown