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/devices.json CHANGED
@@ -43,155 +43,307 @@
43
43
  "maxLength": 32767
44
44
  },
45
45
  "tags": {
46
- "type": "array",
47
- "items": {
48
- "type": "object",
49
- "properties": {
50
- "key": {
51
- "type": "string",
52
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
53
- },
54
- "value": {
55
- "type": "string",
56
- "minLength": 1,
57
- "maxLength": 255
58
- }
59
- },
60
- "required": [
61
- "key",
62
- "value"
63
- ],
64
- "additionalProperties": false
65
- },
66
- "maxItems": 100
67
- },
68
- "attributes": {
69
- "type": "array",
70
- "items": {
71
- "type": "object",
72
- "properties": {
73
- "name": {
74
- "type": "string",
75
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
76
- },
77
- "dataType": {
78
- "type": "string",
79
- "enum": [
80
- "string",
81
- "number",
82
- "gps",
83
- "boolean",
84
- "blob"
85
- ]
86
- },
87
- "contentType": {
88
- "type": "string",
89
- "maxLength": 64
90
- },
91
- "description": {
92
- "type": "string",
93
- "maxLength": 32767
94
- },
95
- "attributeTags": {
46
+ "oneOf": [
47
+ {
48
+ "type": "array",
49
+ "items": {
96
50
  "type": "object",
97
- "patternProperties": {
98
- "^[0-9a-zA-Z_-]{1,255}$": {
51
+ "properties": {
52
+ "key": {
53
+ "type": "string",
54
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
55
+ },
56
+ "value": {
99
57
  "type": "string",
100
58
  "minLength": 1,
101
59
  "maxLength": 255
102
60
  }
103
61
  },
62
+ "required": [
63
+ "key",
64
+ "value"
65
+ ],
104
66
  "additionalProperties": false
105
67
  },
106
- "system": {
68
+ "maxItems": 100
69
+ },
70
+ {
71
+ "type": "object",
72
+ "patternProperties": {
73
+ "^[0-9a-zA-Z_-]{1,255}$": {
74
+ "type": "array",
75
+ "items": {
76
+ "type": "string",
77
+ "minLength": 1,
78
+ "maxLength": 255
79
+ }
80
+ }
81
+ },
82
+ "additionalProperties": false
83
+ }
84
+ ]
85
+ },
86
+ "attributes": {
87
+ "oneOf": [
88
+ {
89
+ "type": "array",
90
+ "items": {
107
91
  "type": "object",
108
92
  "properties": {
109
- "aggregation": {
93
+ "name": {
94
+ "type": "string",
95
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
96
+ },
97
+ "dataType": {
110
98
  "type": "string",
111
99
  "enum": [
112
- "FIRST",
113
- "LAST",
114
- "COUNT",
115
- "MAX",
116
- "MIN",
117
- "MEDIAN",
118
- "MEAN",
119
- "SUM",
120
- "STD_DEV"
100
+ "string",
101
+ "number",
102
+ "gps",
103
+ "boolean",
104
+ "blob"
121
105
  ]
122
106
  },
123
- "aggregationOptions": {
124
- "type": "array",
125
- "items": {
107
+ "contentType": {
108
+ "type": "string",
109
+ "maxLength": 64
110
+ },
111
+ "description": {
112
+ "type": "string",
113
+ "maxLength": 32767
114
+ },
115
+ "attributeTags": {
116
+ "type": "object",
117
+ "patternProperties": {
118
+ "^[0-9a-zA-Z_-]{1,255}$": {
119
+ "type": "string",
120
+ "minLength": 1,
121
+ "maxLength": 255
122
+ }
123
+ },
124
+ "additionalProperties": false
125
+ },
126
+ "system": {
127
+ "type": "object",
128
+ "properties": {
129
+ "aggregation": {
130
+ "type": "string",
131
+ "enum": [
132
+ "FIRST",
133
+ "LAST",
134
+ "COUNT",
135
+ "MAX",
136
+ "MIN",
137
+ "MEDIAN",
138
+ "MEAN",
139
+ "SUM",
140
+ "STD_DEV"
141
+ ]
142
+ },
143
+ "aggregationOptions": {
144
+ "type": "array",
145
+ "items": {
146
+ "type": "object",
147
+ "additionalProperties": false
148
+ },
149
+ "maxItems": 0
150
+ },
151
+ "childAttributes": {
152
+ "type": "array",
153
+ "items": {
154
+ "type": "object",
155
+ "properties": {
156
+ "name": {
157
+ "type": "string",
158
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
159
+ },
160
+ "mode": {
161
+ "type": "string",
162
+ "enum": [
163
+ "all",
164
+ "whitelist",
165
+ "blacklist"
166
+ ]
167
+ },
168
+ "deviceIds": {
169
+ "type": "array",
170
+ "items": {
171
+ "type": "string",
172
+ "pattern": "^[A-Fa-f\\d]{24}$"
173
+ },
174
+ "maxItems": 1000
175
+ },
176
+ "deviceTags": {
177
+ "type": "array",
178
+ "items": {
179
+ "type": "object",
180
+ "properties": {
181
+ "key": {
182
+ "type": "string",
183
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
184
+ },
185
+ "value": {
186
+ "type": "string",
187
+ "minLength": 1,
188
+ "maxLength": 255
189
+ }
190
+ },
191
+ "additionalProperties": false
192
+ },
193
+ "maxItems": 100
194
+ }
195
+ },
196
+ "required": [
197
+ "name",
198
+ "mode"
199
+ ],
200
+ "additionalProperties": false
201
+ },
202
+ "maxItems": 256
203
+ }
204
+ },
205
+ "additionalProperties": false
206
+ }
207
+ },
208
+ "required": [
209
+ "name",
210
+ "dataType"
211
+ ],
212
+ "additionalProperties": false
213
+ },
214
+ "maxItems": 256
215
+ },
216
+ {
217
+ "type": "object",
218
+ "patternProperties": {
219
+ "^[0-9a-zA-Z_-]{1,255}$": {
220
+ "type": "object",
221
+ "properties": {
222
+ "name": {
223
+ "type": "string",
224
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
225
+ },
226
+ "dataType": {
227
+ "type": "string",
228
+ "enum": [
229
+ "string",
230
+ "number",
231
+ "gps",
232
+ "boolean",
233
+ "blob"
234
+ ]
235
+ },
236
+ "contentType": {
237
+ "type": "string",
238
+ "maxLength": 64
239
+ },
240
+ "description": {
241
+ "type": "string",
242
+ "maxLength": 32767
243
+ },
244
+ "attributeTags": {
126
245
  "type": "object",
246
+ "patternProperties": {
247
+ "^[0-9a-zA-Z_-]{1,255}$": {
248
+ "type": "string",
249
+ "minLength": 1,
250
+ "maxLength": 255
251
+ }
252
+ },
127
253
  "additionalProperties": false
128
254
  },
129
- "maxItems": 0
130
- },
131
- "childAttributes": {
132
- "type": "array",
133
- "items": {
255
+ "system": {
134
256
  "type": "object",
135
257
  "properties": {
136
- "name": {
137
- "type": "string",
138
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
139
- },
140
- "mode": {
258
+ "aggregation": {
141
259
  "type": "string",
142
260
  "enum": [
143
- "all",
144
- "whitelist",
145
- "blacklist"
261
+ "FIRST",
262
+ "LAST",
263
+ "COUNT",
264
+ "MAX",
265
+ "MIN",
266
+ "MEDIAN",
267
+ "MEAN",
268
+ "SUM",
269
+ "STD_DEV"
146
270
  ]
147
271
  },
148
- "deviceIds": {
272
+ "aggregationOptions": {
149
273
  "type": "array",
150
274
  "items": {
151
- "type": "string",
152
- "pattern": "^[A-Fa-f\\d]{24}$"
275
+ "type": "object",
276
+ "additionalProperties": false
153
277
  },
154
- "maxItems": 1000
278
+ "maxItems": 0
155
279
  },
156
- "deviceTags": {
280
+ "childAttributes": {
157
281
  "type": "array",
158
282
  "items": {
159
283
  "type": "object",
160
284
  "properties": {
161
- "key": {
285
+ "name": {
162
286
  "type": "string",
163
287
  "pattern": "^[0-9a-zA-Z_-]{1,255}$"
164
288
  },
165
- "value": {
289
+ "mode": {
166
290
  "type": "string",
167
- "minLength": 1,
168
- "maxLength": 255
291
+ "enum": [
292
+ "all",
293
+ "whitelist",
294
+ "blacklist"
295
+ ]
296
+ },
297
+ "deviceIds": {
298
+ "type": "array",
299
+ "items": {
300
+ "type": "string",
301
+ "pattern": "^[A-Fa-f\\d]{24}$"
302
+ },
303
+ "maxItems": 1000
304
+ },
305
+ "deviceTags": {
306
+ "type": "array",
307
+ "items": {
308
+ "type": "object",
309
+ "properties": {
310
+ "key": {
311
+ "type": "string",
312
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
313
+ },
314
+ "value": {
315
+ "type": "string",
316
+ "minLength": 1,
317
+ "maxLength": 255
318
+ }
319
+ },
320
+ "additionalProperties": false
321
+ },
322
+ "maxItems": 100
169
323
  }
170
324
  },
325
+ "required": [
326
+ "name",
327
+ "mode"
328
+ ],
171
329
  "additionalProperties": false
172
330
  },
173
- "maxItems": 100
331
+ "maxItems": 256
174
332
  }
175
333
  },
176
- "required": [
177
- "name",
178
- "mode"
179
- ],
180
334
  "additionalProperties": false
181
- },
182
- "maxItems": 256
183
- }
184
- },
185
- "additionalProperties": false
186
- }
187
- },
188
- "required": [
189
- "name",
190
- "dataType"
191
- ],
192
- "additionalProperties": false
193
- },
194
- "maxItems": 256
335
+ }
336
+ },
337
+ "required": [
338
+ "name",
339
+ "dataType"
340
+ ],
341
+ "additionalProperties": false
342
+ }
343
+ },
344
+ "additionalProperties": false
345
+ }
346
+ ]
195
347
  },
196
348
  "deviceClass": {
197
349
  "type": "string",
@@ -295,15 +447,34 @@
295
447
  "pattern": "^[A-Fa-f\\d]{24}$"
296
448
  },
297
449
  "deviceClass": {
298
- "type": "string",
299
- "enum": [
300
- "standalone",
301
- "gateway",
302
- "peripheral",
303
- "floating",
304
- "edgeCompute",
305
- "system",
306
- "embedded"
450
+ "oneOf": [
451
+ {
452
+ "type": "string",
453
+ "enum": [
454
+ "standalone",
455
+ "gateway",
456
+ "peripheral",
457
+ "floating",
458
+ "edgeCompute",
459
+ "system",
460
+ "embedded"
461
+ ]
462
+ },
463
+ {
464
+ "type": "array",
465
+ "items": {
466
+ "type": "string",
467
+ "enum": [
468
+ "standalone",
469
+ "gateway",
470
+ "peripheral",
471
+ "floating",
472
+ "edgeCompute",
473
+ "system",
474
+ "embedded"
475
+ ]
476
+ }
477
+ }
307
478
  ]
308
479
  },
309
480
  "tagFilter": {