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