losant_rest 2.1.0 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +139101 -66992
  3. data/docs/application.md +6 -6
  4. data/docs/applicationCertificates.md +3 -2
  5. data/docs/applicationDashboard.md +1 -1
  6. data/docs/applications.md +1 -1
  7. data/docs/auth.md +1 -1
  8. data/docs/dashboard.md +1 -1
  9. data/docs/dashboards.md +1 -0
  10. data/docs/dataTableRow.md +1 -1
  11. data/docs/dataTableRows.md +3 -3
  12. data/docs/device.md +1 -1
  13. data/docs/edgeDeployments.md +3 -3
  14. data/docs/embeddedDeployments.md +3 -3
  15. data/docs/experience.md +1 -1
  16. data/docs/file.md +4 -4
  17. data/docs/files.md +1 -1
  18. data/docs/flowVersions.md +1 -1
  19. data/docs/instanceApiTokens.md +1 -1
  20. data/docs/instanceMember.md +1 -1
  21. data/docs/instanceOrg.md +1 -1
  22. data/docs/instanceOrgInvite.md +2 -2
  23. data/docs/instanceOrgInvites.md +1 -1
  24. data/docs/instanceOrgMembers.md +2 -1
  25. data/docs/instanceOrgs.md +1 -1
  26. data/docs/me.md +1 -1
  27. data/docs/notebook.md +1 -1
  28. data/docs/org.md +1 -1
  29. data/docs/privateFile.md +4 -4
  30. data/docs/privateFiles.md +1 -1
  31. data/docs/resourceJob.md +2 -2
  32. data/docs/userApiTokens.md +2 -2
  33. data/lib/platform_rest/application.rb +1 -1
  34. data/lib/platform_rest/application_certificates.rb +5 -2
  35. data/lib/platform_rest/application_dashboard.rb +1 -1
  36. data/lib/platform_rest/client.rb +2 -2
  37. data/lib/platform_rest/dashboard.rb +1 -1
  38. data/lib/platform_rest/dashboards.rb +1 -0
  39. data/lib/platform_rest/data_table_row.rb +1 -1
  40. data/lib/platform_rest/data_table_rows.rb +3 -3
  41. data/lib/platform_rest/device.rb +1 -1
  42. data/lib/platform_rest/edge_deployments.rb +3 -3
  43. data/lib/platform_rest/embedded_deployments.rb +3 -3
  44. data/lib/platform_rest/experience.rb +1 -1
  45. data/lib/platform_rest/file.rb +2 -2
  46. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  47. data/lib/platform_rest/instance_member.rb +1 -1
  48. data/lib/platform_rest/instance_org.rb +1 -1
  49. data/lib/platform_rest/instance_org_invite.rb +2 -2
  50. data/lib/platform_rest/instance_org_invites.rb +2 -2
  51. data/lib/platform_rest/instance_org_members.rb +2 -1
  52. data/lib/platform_rest/instance_orgs.rb +1 -1
  53. data/lib/platform_rest/me.rb +1 -1
  54. data/lib/platform_rest/notebook.rb +1 -1
  55. data/lib/platform_rest/org.rb +1 -1
  56. data/lib/platform_rest/private_file.rb +2 -2
  57. data/lib/platform_rest/resource_job.rb +2 -2
  58. data/lib/platform_rest/user_api_tokens.rb +2 -2
  59. data/lib/platform_rest/version.rb +1 -1
  60. data/schemas/advancedApplicationCertQuery.json +1885 -0
  61. data/schemas/advancedApplicationKeyQuery.json +763 -763
  62. data/schemas/apiToken.json +10 -1
  63. data/schemas/apiTokens.json +20 -2
  64. data/schemas/application.json +15 -2
  65. data/schemas/applicationCertificate.json +90 -58
  66. data/schemas/applicationCertificateAuthorities.json +24 -0
  67. data/schemas/applicationCertificateAuthority.json +24 -0
  68. data/schemas/applicationCertificatePatch.json +32 -4
  69. data/schemas/applicationCertificatePost.json +28 -30
  70. data/schemas/applicationCertificates.json +90 -58
  71. data/schemas/applicationCreationByTemplateResult.json +15 -2
  72. data/schemas/applicationDashboardPost.json +179 -128
  73. data/schemas/applicationImportExecutions.json +3 -5
  74. data/schemas/applicationImportResult.json +674 -0
  75. data/schemas/applicationJobLog.json +129 -123
  76. data/schemas/applicationJobLogs.json +129 -123
  77. data/schemas/applicationKey.json +41 -41
  78. data/schemas/applicationKeyPatch.json +4 -4
  79. data/schemas/applicationKeyPost.json +36 -29
  80. data/schemas/applicationKeys.json +41 -41
  81. data/schemas/applicationSearchResult.json +10 -10
  82. data/schemas/applicationTemplates.json +9 -2
  83. data/schemas/applications.json +15 -2
  84. data/schemas/auditLog.json +2 -6
  85. data/schemas/auditLogs.json +2 -6
  86. data/schemas/authedDevice.json +3 -0
  87. data/schemas/credential.json +7 -0
  88. data/schemas/credentialLinkedResources.json +19724 -344
  89. data/schemas/credentialPatch.json +3 -0
  90. data/schemas/credentialPost.json +3 -0
  91. data/schemas/credentials.json +7 -0
  92. data/schemas/dashboard.json +199 -128
  93. data/schemas/dashboardBlockSuggestCodePost.json +19 -0
  94. data/schemas/dashboardPatch.json +179 -128
  95. data/schemas/dashboardPost.json +179 -128
  96. data/schemas/dashboardUpdateEventsResult.json +266 -0
  97. data/schemas/dashboards.json +199 -128
  98. data/schemas/dataTable.json +11 -0
  99. data/schemas/dataTableRowPatch.json +16 -0
  100. data/schemas/dataTableRowPost.json +39 -0
  101. data/schemas/dataTableRowPostResult.json +54 -0
  102. data/schemas/dataTables.json +11 -0
  103. data/schemas/device.json +259 -107
  104. data/schemas/deviceConnectionStatus.json +4 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/deviceRecipe.json +259 -108
  107. data/schemas/deviceRecipes.json +259 -108
  108. data/schemas/devices.json +287 -116
  109. data/schemas/edgeDeploymentRelease.json +4252 -39
  110. data/schemas/edgeDeployments.json +28 -0
  111. data/schemas/embeddedDeploymentRelease.json +2073 -0
  112. data/schemas/embeddedDeployments.json +25 -0
  113. data/schemas/error.json +14 -0
  114. data/schemas/event.json +4 -1
  115. data/schemas/eventPlusNewCount.json +4 -1
  116. data/schemas/events.json +4 -1
  117. data/schemas/experienceDomains.json +19 -0
  118. data/schemas/experienceEndpoint.json +19 -0
  119. data/schemas/experienceEndpoints.json +24 -0
  120. data/schemas/experienceLinkedResources.json +19728 -313
  121. data/schemas/experienceSlugs.json +19 -0
  122. data/schemas/experienceUsers.json +16 -2
  123. data/schemas/experienceVersions.json +25 -0
  124. data/schemas/experienceView.json +5 -0
  125. data/schemas/experienceViews.json +10 -0
  126. data/schemas/fileUploadPostResponse.json +92 -103
  127. data/schemas/files.json +5 -1
  128. data/schemas/flow.json +211 -46
  129. data/schemas/flowPatch.json +199 -46
  130. data/schemas/flowPost.json +199 -46
  131. data/schemas/flowStorageMetadata.json +2 -2
  132. data/schemas/flowVersion.json +450 -101
  133. data/schemas/flowVersionPost.json +199 -46
  134. data/schemas/flowVersions.json +9903 -113
  135. data/schemas/flows.json +9637 -46
  136. data/schemas/flowsImportPost.json +398 -92
  137. data/schemas/flowsImportResult.json +661 -147
  138. data/schemas/historicalSummaries.json +3 -2
  139. data/schemas/historicalSummary.json +3 -2
  140. data/schemas/instanceAuditLog.json +2 -6
  141. data/schemas/instanceAuditLogs.json +90 -1
  142. data/schemas/instanceCustomNode.json +41 -2
  143. data/schemas/instanceCustomNodePatch.json +59 -6
  144. data/schemas/instanceCustomNodePost.json +59 -6
  145. data/schemas/instanceCustomNodes.json +41 -2
  146. data/schemas/instanceOrg.json +4 -1
  147. data/schemas/instanceOrgInvite.json +102 -0
  148. data/schemas/instanceOrgInviteSent.json +12 -0
  149. data/schemas/instanceOrgInvites.json +145 -0
  150. data/schemas/instanceOrgMember.json +52 -0
  151. data/schemas/instanceOrgMembers.json +105 -1
  152. data/schemas/instanceOrgPost.json +1 -1
  153. data/schemas/instanceOrgs.json +5 -2
  154. data/schemas/instanceSandbox.json +5 -1
  155. data/schemas/instanceSandboxes.json +9 -1
  156. data/schemas/integration.json +38 -39
  157. data/schemas/integrationPatch.json +8 -8
  158. data/schemas/integrationPost.json +8 -8
  159. data/schemas/integrations.json +38 -39
  160. data/schemas/jobEnqueuedResult.json +1 -1
  161. data/schemas/me.json +685 -88
  162. data/schemas/notebook.json +33 -21
  163. data/schemas/notebookExecutionLogs.json +20 -0
  164. data/schemas/notebookMinuteCounts.json +1 -1
  165. data/schemas/notebookPatch.json +29 -21
  166. data/schemas/notebookPost.json +29 -21
  167. data/schemas/notebooks.json +33 -21
  168. data/schemas/notificationRule.json +4 -0
  169. data/schemas/notificationRules.json +8 -0
  170. data/schemas/org.json +14 -1
  171. data/schemas/orgInvites.json +77 -82
  172. data/schemas/orgInvitesUser.json +44 -47
  173. data/schemas/orgs.json +14 -1
  174. data/schemas/paletteResponse.json +372 -364
  175. data/schemas/periodSummaries.json +1 -1
  176. data/schemas/recentItemList.json +226 -27
  177. data/schemas/resourceJob.json +33 -9
  178. data/schemas/resourceJobExecutionLogs.json +34 -20
  179. data/schemas/resourceJobExecutionOptions.json +1 -1
  180. data/schemas/resourceJobPatch.json +9 -9
  181. data/schemas/resourceJobPost.json +9 -9
  182. data/schemas/resourceJobs.json +33 -9
  183. data/schemas/tagValuesResponse.json +1 -2
  184. data/schemas/templateKeywords.json +1 -0
  185. data/schemas/timeSeriesData.json +36 -4
  186. data/schemas/userOauthToken.json +4 -1
  187. data/schemas/userOauthTokenPost.json +1 -1
  188. data/schemas/userOauthTokens.json +4 -1
  189. data/schemas/validateContextError.json +71 -24
  190. data/schemas/validateContextSuccess.json +71 -24
  191. metadata +10 -1
data/schemas/device.json CHANGED
@@ -36,155 +36,307 @@
36
36
  "maxLength": 32767
37
37
  },
38
38
  "tags": {
39
- "type": "array",
40
- "items": {
41
- "type": "object",
42
- "properties": {
43
- "key": {
44
- "type": "string",
45
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
46
- },
47
- "value": {
48
- "type": "string",
49
- "minLength": 1,
50
- "maxLength": 255
51
- }
52
- },
53
- "required": [
54
- "key",
55
- "value"
56
- ],
57
- "additionalProperties": false
58
- },
59
- "maxItems": 100
60
- },
61
- "attributes": {
62
- "type": "array",
63
- "items": {
64
- "type": "object",
65
- "properties": {
66
- "name": {
67
- "type": "string",
68
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
69
- },
70
- "dataType": {
71
- "type": "string",
72
- "enum": [
73
- "string",
74
- "number",
75
- "gps",
76
- "boolean",
77
- "blob"
78
- ]
79
- },
80
- "contentType": {
81
- "type": "string",
82
- "maxLength": 64
83
- },
84
- "description": {
85
- "type": "string",
86
- "maxLength": 32767
87
- },
88
- "attributeTags": {
39
+ "oneOf": [
40
+ {
41
+ "type": "array",
42
+ "items": {
89
43
  "type": "object",
90
- "patternProperties": {
91
- "^[0-9a-zA-Z_-]{1,255}$": {
44
+ "properties": {
45
+ "key": {
46
+ "type": "string",
47
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
48
+ },
49
+ "value": {
92
50
  "type": "string",
93
51
  "minLength": 1,
94
52
  "maxLength": 255
95
53
  }
96
54
  },
55
+ "required": [
56
+ "key",
57
+ "value"
58
+ ],
97
59
  "additionalProperties": false
98
60
  },
99
- "system": {
61
+ "maxItems": 100
62
+ },
63
+ {
64
+ "type": "object",
65
+ "patternProperties": {
66
+ "^[0-9a-zA-Z_-]{1,255}$": {
67
+ "type": "array",
68
+ "items": {
69
+ "type": "string",
70
+ "minLength": 1,
71
+ "maxLength": 255
72
+ }
73
+ }
74
+ },
75
+ "additionalProperties": false
76
+ }
77
+ ]
78
+ },
79
+ "attributes": {
80
+ "oneOf": [
81
+ {
82
+ "type": "array",
83
+ "items": {
100
84
  "type": "object",
101
85
  "properties": {
102
- "aggregation": {
86
+ "name": {
87
+ "type": "string",
88
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
89
+ },
90
+ "dataType": {
103
91
  "type": "string",
104
92
  "enum": [
105
- "FIRST",
106
- "LAST",
107
- "COUNT",
108
- "MAX",
109
- "MIN",
110
- "MEDIAN",
111
- "MEAN",
112
- "SUM",
113
- "STD_DEV"
93
+ "string",
94
+ "number",
95
+ "gps",
96
+ "boolean",
97
+ "blob"
114
98
  ]
115
99
  },
116
- "aggregationOptions": {
117
- "type": "array",
118
- "items": {
100
+ "contentType": {
101
+ "type": "string",
102
+ "maxLength": 64
103
+ },
104
+ "description": {
105
+ "type": "string",
106
+ "maxLength": 32767
107
+ },
108
+ "attributeTags": {
109
+ "type": "object",
110
+ "patternProperties": {
111
+ "^[0-9a-zA-Z_-]{1,255}$": {
112
+ "type": "string",
113
+ "minLength": 1,
114
+ "maxLength": 255
115
+ }
116
+ },
117
+ "additionalProperties": false
118
+ },
119
+ "system": {
120
+ "type": "object",
121
+ "properties": {
122
+ "aggregation": {
123
+ "type": "string",
124
+ "enum": [
125
+ "FIRST",
126
+ "LAST",
127
+ "COUNT",
128
+ "MAX",
129
+ "MIN",
130
+ "MEDIAN",
131
+ "MEAN",
132
+ "SUM",
133
+ "STD_DEV"
134
+ ]
135
+ },
136
+ "aggregationOptions": {
137
+ "type": "array",
138
+ "items": {
139
+ "type": "object",
140
+ "additionalProperties": false
141
+ },
142
+ "maxItems": 0
143
+ },
144
+ "childAttributes": {
145
+ "type": "array",
146
+ "items": {
147
+ "type": "object",
148
+ "properties": {
149
+ "name": {
150
+ "type": "string",
151
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
152
+ },
153
+ "mode": {
154
+ "type": "string",
155
+ "enum": [
156
+ "all",
157
+ "whitelist",
158
+ "blacklist"
159
+ ]
160
+ },
161
+ "deviceIds": {
162
+ "type": "array",
163
+ "items": {
164
+ "type": "string",
165
+ "pattern": "^[A-Fa-f\\d]{24}$"
166
+ },
167
+ "maxItems": 1000
168
+ },
169
+ "deviceTags": {
170
+ "type": "array",
171
+ "items": {
172
+ "type": "object",
173
+ "properties": {
174
+ "key": {
175
+ "type": "string",
176
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
177
+ },
178
+ "value": {
179
+ "type": "string",
180
+ "minLength": 1,
181
+ "maxLength": 255
182
+ }
183
+ },
184
+ "additionalProperties": false
185
+ },
186
+ "maxItems": 100
187
+ }
188
+ },
189
+ "required": [
190
+ "name",
191
+ "mode"
192
+ ],
193
+ "additionalProperties": false
194
+ },
195
+ "maxItems": 256
196
+ }
197
+ },
198
+ "additionalProperties": false
199
+ }
200
+ },
201
+ "required": [
202
+ "name",
203
+ "dataType"
204
+ ],
205
+ "additionalProperties": false
206
+ },
207
+ "maxItems": 256
208
+ },
209
+ {
210
+ "type": "object",
211
+ "patternProperties": {
212
+ "^[0-9a-zA-Z_-]{1,255}$": {
213
+ "type": "object",
214
+ "properties": {
215
+ "name": {
216
+ "type": "string",
217
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
218
+ },
219
+ "dataType": {
220
+ "type": "string",
221
+ "enum": [
222
+ "string",
223
+ "number",
224
+ "gps",
225
+ "boolean",
226
+ "blob"
227
+ ]
228
+ },
229
+ "contentType": {
230
+ "type": "string",
231
+ "maxLength": 64
232
+ },
233
+ "description": {
234
+ "type": "string",
235
+ "maxLength": 32767
236
+ },
237
+ "attributeTags": {
119
238
  "type": "object",
239
+ "patternProperties": {
240
+ "^[0-9a-zA-Z_-]{1,255}$": {
241
+ "type": "string",
242
+ "minLength": 1,
243
+ "maxLength": 255
244
+ }
245
+ },
120
246
  "additionalProperties": false
121
247
  },
122
- "maxItems": 0
123
- },
124
- "childAttributes": {
125
- "type": "array",
126
- "items": {
248
+ "system": {
127
249
  "type": "object",
128
250
  "properties": {
129
- "name": {
130
- "type": "string",
131
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
132
- },
133
- "mode": {
251
+ "aggregation": {
134
252
  "type": "string",
135
253
  "enum": [
136
- "all",
137
- "whitelist",
138
- "blacklist"
254
+ "FIRST",
255
+ "LAST",
256
+ "COUNT",
257
+ "MAX",
258
+ "MIN",
259
+ "MEDIAN",
260
+ "MEAN",
261
+ "SUM",
262
+ "STD_DEV"
139
263
  ]
140
264
  },
141
- "deviceIds": {
265
+ "aggregationOptions": {
142
266
  "type": "array",
143
267
  "items": {
144
- "type": "string",
145
- "pattern": "^[A-Fa-f\\d]{24}$"
268
+ "type": "object",
269
+ "additionalProperties": false
146
270
  },
147
- "maxItems": 1000
271
+ "maxItems": 0
148
272
  },
149
- "deviceTags": {
273
+ "childAttributes": {
150
274
  "type": "array",
151
275
  "items": {
152
276
  "type": "object",
153
277
  "properties": {
154
- "key": {
278
+ "name": {
155
279
  "type": "string",
156
280
  "pattern": "^[0-9a-zA-Z_-]{1,255}$"
157
281
  },
158
- "value": {
282
+ "mode": {
159
283
  "type": "string",
160
- "minLength": 1,
161
- "maxLength": 255
284
+ "enum": [
285
+ "all",
286
+ "whitelist",
287
+ "blacklist"
288
+ ]
289
+ },
290
+ "deviceIds": {
291
+ "type": "array",
292
+ "items": {
293
+ "type": "string",
294
+ "pattern": "^[A-Fa-f\\d]{24}$"
295
+ },
296
+ "maxItems": 1000
297
+ },
298
+ "deviceTags": {
299
+ "type": "array",
300
+ "items": {
301
+ "type": "object",
302
+ "properties": {
303
+ "key": {
304
+ "type": "string",
305
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
306
+ },
307
+ "value": {
308
+ "type": "string",
309
+ "minLength": 1,
310
+ "maxLength": 255
311
+ }
312
+ },
313
+ "additionalProperties": false
314
+ },
315
+ "maxItems": 100
162
316
  }
163
317
  },
318
+ "required": [
319
+ "name",
320
+ "mode"
321
+ ],
164
322
  "additionalProperties": false
165
323
  },
166
- "maxItems": 100
324
+ "maxItems": 256
167
325
  }
168
326
  },
169
- "required": [
170
- "name",
171
- "mode"
172
- ],
173
327
  "additionalProperties": false
174
- },
175
- "maxItems": 256
176
- }
177
- },
178
- "additionalProperties": false
179
- }
180
- },
181
- "required": [
182
- "name",
183
- "dataType"
184
- ],
185
- "additionalProperties": false
186
- },
187
- "maxItems": 256
328
+ }
329
+ },
330
+ "required": [
331
+ "name",
332
+ "dataType"
333
+ ],
334
+ "additionalProperties": false
335
+ }
336
+ },
337
+ "additionalProperties": false
338
+ }
339
+ ]
188
340
  },
189
341
  "deviceClass": {
190
342
  "type": "string",
@@ -1,5 +1,9 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "discriminator": {
5
+ "propertyName": "status"
6
+ },
3
7
  "oneOf": [
4
8
  {
5
9
  "title": "Device Connected",
@@ -14,6 +14,9 @@
14
14
  "type": "string",
15
15
  "format": "date-time"
16
16
  },
17
+ "method": {
18
+ "type": "string"
19
+ },
17
20
  "disconnectReason": {
18
21
  "type": "string"
19
22
  },