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