losant_rest 1.13.1 → 1.15.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +10817 -3660
  3. data/docs/application.md +1 -1
  4. data/docs/device.md +43 -0
  5. data/docs/devices.md +39 -0
  6. data/docs/edgeDeployment.md +49 -0
  7. data/docs/embeddedDeployment.md +49 -0
  8. data/docs/embeddedDeployments.md +215 -0
  9. data/docs/flow.md +3 -3
  10. data/docs/flows.md +2 -2
  11. data/docs/instance.md +4 -2
  12. data/docs/instanceOrg.md +2 -0
  13. data/docs/instanceOrgInvite.md +139 -0
  14. data/docs/instanceOrgInvites.md +96 -0
  15. data/docs/instanceOrgMembers.md +2 -2
  16. data/docs/instanceOrgs.md +1 -1
  17. data/docs/me.md +1 -1
  18. data/docs/org.md +1 -1
  19. data/lib/losant_rest/client.rb +22 -2
  20. data/lib/losant_rest/device.rb +50 -0
  21. data/lib/losant_rest/devices.rb +46 -0
  22. data/lib/losant_rest/edge_deployment.rb +81 -0
  23. data/lib/losant_rest/embedded_deployment.rb +81 -0
  24. data/lib/losant_rest/embedded_deployments.rb +280 -0
  25. data/lib/losant_rest/flow.rb +3 -3
  26. data/lib/losant_rest/flows.rb +2 -2
  27. data/lib/losant_rest/instance.rb +1 -0
  28. data/lib/losant_rest/instance_org.rb +4 -0
  29. data/lib/losant_rest/instance_org_invite.rb +182 -0
  30. data/lib/losant_rest/instance_org_invites.rb +138 -0
  31. data/lib/losant_rest/instance_org_members.rb +2 -2
  32. data/lib/losant_rest/instance_orgs.rb +2 -2
  33. data/lib/losant_rest/version.rb +1 -1
  34. data/lib/losant_rest.rb +5 -0
  35. data/schemas/apiTokenPost.json +19 -0
  36. data/schemas/application.json +32 -32
  37. data/schemas/applicationCreationByTemplateResult.json +32 -32
  38. data/schemas/applicationDashboardPost.json +8 -5
  39. data/schemas/applicationPatch.json +13 -13
  40. data/schemas/applicationPost.json +13 -13
  41. data/schemas/applicationTemplate.json +16 -16
  42. data/schemas/applicationTemplates.json +16 -16
  43. data/schemas/applications.json +32 -32
  44. data/schemas/authedDevice.json +2 -1
  45. data/schemas/dashboard.json +8 -5
  46. data/schemas/dashboardPatch.json +8 -5
  47. data/schemas/dashboardPost.json +8 -5
  48. data/schemas/dashboardSendReport.json +6 -6
  49. data/schemas/dashboards.json +8 -5
  50. data/schemas/dataTableRowsDelete.json +1 -1
  51. data/schemas/device.json +2 -1
  52. data/schemas/deviceClassFilter.json +4 -2
  53. data/schemas/devicePatch.json +2 -1
  54. data/schemas/devicePayloadCounts.json +24 -0
  55. data/schemas/devicePost.json +2 -1
  56. data/schemas/deviceRecipe.json +2 -1
  57. data/schemas/deviceRecipePatch.json +2 -1
  58. data/schemas/deviceRecipePost.json +2 -1
  59. data/schemas/deviceRecipes.json +2 -1
  60. data/schemas/devices.json +4 -2
  61. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  62. data/schemas/devicesPatch.json +4 -2
  63. data/schemas/edgeDeployment.json +20 -0
  64. data/schemas/edgeDeployments.json +20 -0
  65. data/schemas/embeddedDeployment.json +179 -0
  66. data/schemas/embeddedDeploymentExport.json +44 -0
  67. data/schemas/embeddedDeploymentRelease.json +58 -0
  68. data/schemas/embeddedDeploymentRemove.json +25 -0
  69. data/schemas/embeddedDeploymentReplace.json +29 -0
  70. data/schemas/embeddedDeployments.json +212 -0
  71. data/schemas/eventsDeleted.json +1 -1
  72. data/schemas/eventsExport.json +4 -0
  73. data/schemas/experienceEndpoint.json +6 -8
  74. data/schemas/experienceEndpointPatch.json +6 -8
  75. data/schemas/experienceEndpointPost.json +6 -8
  76. data/schemas/experienceEndpoints.json +6 -8
  77. data/schemas/experienceLinkedResources.json +790 -85
  78. data/schemas/flow.json +252 -16
  79. data/schemas/flowPatch.json +251 -16
  80. data/schemas/flowPost.json +252 -16
  81. data/schemas/flowVersion.json +503 -33
  82. data/schemas/flowVersionPost.json +251 -16
  83. data/schemas/flowVersions.json +503 -33
  84. data/schemas/flows.json +253 -16
  85. data/schemas/flowsImportPost.json +503 -32
  86. data/schemas/flowsImportResult.json +785 -79
  87. data/schemas/githubLogin.json +19 -0
  88. data/schemas/historicalSummary.json +147 -102
  89. data/schemas/instance.json +92 -79
  90. data/schemas/instanceMember.json +10 -0
  91. data/schemas/instanceMemberPost.json +18 -3
  92. data/schemas/instanceMembers.json +14 -0
  93. data/schemas/instanceOrg.json +87 -74
  94. data/schemas/instanceOrgMember.json +14 -0
  95. data/schemas/instanceOrgMembers.json +8 -0
  96. data/schemas/instanceOrgPatch.json +64 -26
  97. data/schemas/instanceOrgPost.json +65 -27
  98. data/schemas/instanceOrgs.json +91 -74
  99. data/schemas/instancePatch.json +2 -2
  100. data/schemas/me.json +134 -105
  101. data/schemas/notebook.json +32 -1
  102. data/schemas/notebookExecutionLogs.json +2 -1
  103. data/schemas/notebookPatch.json +32 -1
  104. data/schemas/notebookPost.json +32 -1
  105. data/schemas/notebooks.json +32 -1
  106. data/schemas/org.json +145 -110
  107. data/schemas/orgInvite.json +90 -0
  108. data/schemas/orgInviteCollection.json +130 -0
  109. data/schemas/orgInvites.json +82 -77
  110. data/schemas/orgRoleInfo.json +69 -0
  111. data/schemas/orgs.json +145 -110
  112. data/schemas/payloadStats.json +28 -12
  113. data/schemas/userCredentials.json +19 -0
  114. data/schemas/userPost.json +19 -0
  115. data/schemas/virtualButtonPress.json +4 -0
  116. metadata +27 -6
data/schemas/notebookPatch.json CHANGED
@@ -573,6 +573,36 @@
573
573
  "outputType"
574
574
  ],
575
575
  "additionalProperties": false
576
+ },
577
+ {
578
+ "type": "object",
579
+ "properties": {
580
+ "outputType": {
581
+ "type": "string",
582
+ "enum": [
583
+ "temporaryUrl"
584
+ ]
585
+ },
586
+ "fileName": {
587
+ "oneOf": [
588
+ {
589
+ "type": "string",
590
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
591
+ },
592
+ {
593
+ "type": "string",
594
+ "minLength": 4,
595
+ "maxLength": 255,
596
+ "pattern": ".*{{.+}}.*"
597
+ }
598
+ ]
599
+ }
600
+ },
601
+ "required": [
602
+ "fileName",
603
+ "outputType"
604
+ ],
605
+ "additionalProperties": false
576
606
  }
577
607
  ]
578
608
  }
@@ -581,7 +611,8 @@
581
611
  "type": "string",
582
612
  "enum": [
583
613
  "v1",
584
- "v2"
614
+ "v2",
615
+ "v3"
585
616
  ]
586
617
  }
587
618
  },
data/schemas/notebookPost.json CHANGED
@@ -15,7 +15,8 @@
15
15
  "type": "string",
16
16
  "enum": [
17
17
  "v1",
18
- "v2"
18
+ "v2",
19
+ "v3"
19
20
  ]
20
21
  },
21
22
  "inputs": {
@@ -580,6 +581,36 @@
580
581
  "outputType"
581
582
  ],
582
583
  "additionalProperties": false
584
+ },
585
+ {
586
+ "type": "object",
587
+ "properties": {
588
+ "outputType": {
589
+ "type": "string",
590
+ "enum": [
591
+ "temporaryUrl"
592
+ ]
593
+ },
594
+ "fileName": {
595
+ "oneOf": [
596
+ {
597
+ "type": "string",
598
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
599
+ },
600
+ {
601
+ "type": "string",
602
+ "minLength": 4,
603
+ "maxLength": 255,
604
+ "pattern": ".*{{.+}}.*"
605
+ }
606
+ ]
607
+ }
608
+ },
609
+ "required": [
610
+ "fileName",
611
+ "outputType"
612
+ ],
613
+ "additionalProperties": false
583
614
  }
584
615
  ]
585
616
  }
data/schemas/notebooks.json CHANGED
@@ -50,7 +50,8 @@
50
50
  "type": "string",
51
51
  "enum": [
52
52
  "v1",
53
- "v2"
53
+ "v2",
54
+ "v3"
54
55
  ]
55
56
  },
56
57
  "inputs": {
@@ -615,6 +616,36 @@
615
616
  "outputType"
616
617
  ],
617
618
  "additionalProperties": false
619
+ },
620
+ {
621
+ "type": "object",
622
+ "properties": {
623
+ "outputType": {
624
+ "type": "string",
625
+ "enum": [
626
+ "temporaryUrl"
627
+ ]
628
+ },
629
+ "fileName": {
630
+ "oneOf": [
631
+ {
632
+ "type": "string",
633
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
634
+ },
635
+ {
636
+ "type": "string",
637
+ "minLength": 4,
638
+ "maxLength": 255,
639
+ "pattern": ".*{{.+}}.*"
640
+ }
641
+ ]
642
+ }
643
+ },
644
+ "required": [
645
+ "fileName",
646
+ "outputType"
647
+ ],
648
+ "additionalProperties": false
618
649
  }
619
650
  ]
620
651
  }
data/schemas/org.json CHANGED
@@ -116,150 +116,169 @@
116
116
  "additionalProperties": false
117
117
  },
118
118
  "maxItems": 1000
119
+ },
120
+ "twoFactorAuthEnabled": {
121
+ "type": "boolean"
122
+ },
123
+ "ssoLinked": {
124
+ "type": "boolean"
119
125
  }
120
126
  }
121
127
  }
122
128
  },
123
129
  "limits": {
124
- "apitoken": {
125
- "type": "number"
126
- },
127
- "application": {
128
- "type": "number"
129
- },
130
- "applicationkey": {
131
- "type": "number"
132
- },
133
- "dashboard": {
134
- "type": "number"
135
- },
136
- "datatable": {
137
- "type": "number"
138
- },
139
- "device": {
140
- "type": "number"
141
- },
142
- "devicerecipe": {
143
- "type": "number"
144
- },
145
- "experiencedomain": {
146
- "type": "number"
147
- },
148
- "experienceendpoint": {
149
- "type": "number"
150
- },
151
- "experiencegroup": {
152
- "type": "number"
153
- },
154
- "experienceslug": {
155
- "type": "number"
156
- },
157
- "experienceuser": {
158
- "type": "number"
159
- },
160
- "experienceversion": {
161
- "type": "number"
162
- },
163
- "experienceview": {
164
- "type": "number"
165
- },
166
- "file": {
167
- "type": "number"
168
- },
169
- "flow": {
170
- "type": "number"
171
- },
172
- "integration": {
173
- "type": "number"
174
- },
175
- "notebook": {
176
- "type": "number"
177
- },
178
- "webhook": {
179
- "type": "number"
180
- },
181
- "dataTTL": {
182
- "type": "number"
183
- },
184
- "member": {
185
- "type": "number"
186
- },
187
- "payload": {
188
- "type": "number"
189
- },
190
- "notebookMinutesPerRun": {
191
- "type": "number"
192
- },
193
- "notebookMinutesPerMonth": {
194
- "type": "number"
130
+ "type": "object",
131
+ "properties": {
132
+ "apitoken": {
133
+ "type": "integer"
134
+ },
135
+ "application": {
136
+ "type": "integer"
137
+ },
138
+ "applicationkey": {
139
+ "type": "integer"
140
+ },
141
+ "dashboard": {
142
+ "type": "integer"
143
+ },
144
+ "datatable": {
145
+ "type": "integer"
146
+ },
147
+ "device": {
148
+ "type": "integer"
149
+ },
150
+ "devicerecipe": {
151
+ "type": "integer"
152
+ },
153
+ "experiencedomain": {
154
+ "type": "integer"
155
+ },
156
+ "experienceendpoint": {
157
+ "type": "integer"
158
+ },
159
+ "experiencegroup": {
160
+ "type": "integer"
161
+ },
162
+ "experienceslug": {
163
+ "type": "integer"
164
+ },
165
+ "experienceuser": {
166
+ "type": "integer"
167
+ },
168
+ "experienceversion": {
169
+ "type": "integer"
170
+ },
171
+ "experienceview": {
172
+ "type": "integer"
173
+ },
174
+ "file": {
175
+ "type": "integer"
176
+ },
177
+ "flow": {
178
+ "type": "integer"
179
+ },
180
+ "integration": {
181
+ "type": "integer"
182
+ },
183
+ "notebook": {
184
+ "type": "integer"
185
+ },
186
+ "webhook": {
187
+ "type": "integer"
188
+ },
189
+ "dataTTL": {
190
+ "type": "integer"
191
+ },
192
+ "member": {
193
+ "type": "integer"
194
+ },
195
+ "payload": {
196
+ "type": "integer"
197
+ },
198
+ "storage": {
199
+ "type": "integer"
200
+ },
201
+ "notebookMinutesPerRun": {
202
+ "type": "integer"
203
+ },
204
+ "notebookMinutesPerMonth": {
205
+ "type": "integer"
206
+ },
207
+ "notebookInParallel": {
208
+ "type": "integer"
209
+ },
210
+ "experienceFlowSlots": {
211
+ "type": "integer"
212
+ },
213
+ "applicationFlowSlots": {
214
+ "type": "integer"
215
+ }
195
216
  },
196
- "notebookInParallel": {
197
- "type": "number"
198
- }
217
+ "additionalProperties": false
199
218
  },
200
219
  "summary": {
201
220
  "type": "object",
202
221
  "properties": {
203
222
  "apiTokenCount": {
204
- "type": "number"
223
+ "type": "integer"
205
224
  },
206
225
  "appCount": {
207
- "type": "number"
226
+ "type": "integer"
208
227
  },
209
228
  "dashCount": {
210
- "type": "number"
229
+ "type": "integer"
211
230
  },
212
231
  "dataTableCount": {
213
- "type": "number"
232
+ "type": "integer"
214
233
  },
215
234
  "deviceCount": {
216
- "type": "number"
235
+ "type": "integer"
217
236
  },
218
237
  "deviceRecipeCount": {
219
- "type": "number"
238
+ "type": "integer"
220
239
  },
221
240
  "experienceDomainCount": {
222
- "type": "number"
241
+ "type": "integer"
223
242
  },
224
243
  "experienceEndpointCount": {
225
- "type": "number"
244
+ "type": "integer"
226
245
  },
227
246
  "experienceGroupCount": {
228
- "type": "number"
247
+ "type": "integer"
229
248
  },
230
249
  "experienceSlugCount": {
231
- "type": "number"
250
+ "type": "integer"
232
251
  },
233
252
  "experienceUserCount": {
234
- "type": "number"
253
+ "type": "integer"
235
254
  },
236
255
  "experienceVersionCount": {
237
- "type": "number"
256
+ "type": "integer"
238
257
  },
239
258
  "experienceViewCount": {
240
- "type": "number"
259
+ "type": "integer"
241
260
  },
242
261
  "fileCount": {
243
- "type": "number"
262
+ "type": "integer"
244
263
  },
245
264
  "flowCount": {
246
- "type": "number"
265
+ "type": "integer"
247
266
  },
248
267
  "integrationCount": {
249
- "type": "number"
268
+ "type": "integer"
250
269
  },
251
270
  "keyCount": {
252
- "type": "number"
271
+ "type": "integer"
253
272
  },
254
273
  "memberCount": {
255
- "type": "number"
274
+ "type": "integer"
256
275
  },
257
276
  "payloadCount": {
258
- "title": "Payload Counts",
259
- "description": "Schema for the result of a payload count request",
277
+ "title": "Payload Stats",
278
+ "description": "Schema for the result of a payload stats request",
260
279
  "type": "object",
261
280
  "properties": {
262
- "mqttOut": {
281
+ "dataTable": {
263
282
  "type": "object",
264
283
  "patternProperties": {
265
284
  ".*": {
@@ -267,7 +286,7 @@
267
286
  }
268
287
  }
269
288
  },
270
- "mqttIn": {
289
+ "deviceCommand": {
271
290
  "type": "object",
272
291
  "patternProperties": {
273
292
  ".*": {
@@ -275,7 +294,15 @@
275
294
  }
276
295
  }
277
296
  },
278
- "dataTable": {
297
+ "deviceConnect": {
298
+ "type": "object",
299
+ "patternProperties": {
300
+ ".*": {
301
+ "type": "number"
302
+ }
303
+ }
304
+ },
305
+ "deviceDisconnect": {
279
306
  "type": "object",
280
307
  "patternProperties": {
281
308
  ".*": {
@@ -291,7 +318,7 @@
291
318
  }
292
319
  }
293
320
  },
294
- "deviceCommand": {
321
+ "endpoint": {
295
322
  "type": "object",
296
323
  "patternProperties": {
297
324
  ".*": {
@@ -299,7 +326,7 @@
299
326
  }
300
327
  }
301
328
  },
302
- "webhook": {
329
+ "event": {
303
330
  "type": "object",
304
331
  "patternProperties": {
305
332
  ".*": {
@@ -307,7 +334,7 @@
307
334
  }
308
335
  }
309
336
  },
310
- "timer": {
337
+ "flowError": {
311
338
  "type": "object",
312
339
  "patternProperties": {
313
340
  ".*": {
@@ -315,7 +342,7 @@
315
342
  }
316
343
  }
317
344
  },
318
- "event": {
345
+ "integration": {
319
346
  "type": "object",
320
347
  "patternProperties": {
321
348
  ".*": {
@@ -323,7 +350,7 @@
323
350
  }
324
351
  }
325
352
  },
326
- "virtualButton": {
353
+ "mqttIn": {
327
354
  "type": "object",
328
355
  "patternProperties": {
329
356
  ".*": {
@@ -331,7 +358,7 @@
331
358
  }
332
359
  }
333
360
  },
334
- "deviceConnect": {
361
+ "mqttOut": {
335
362
  "type": "object",
336
363
  "patternProperties": {
337
364
  ".*": {
@@ -339,7 +366,7 @@
339
366
  }
340
367
  }
341
368
  },
342
- "deviceDisconnect": {
369
+ "notebook": {
343
370
  "type": "object",
344
371
  "patternProperties": {
345
372
  ".*": {
@@ -347,7 +374,7 @@
347
374
  }
348
375
  }
349
376
  },
350
- "endpoint": {
377
+ "timer": {
351
378
  "type": "object",
352
379
  "patternProperties": {
353
380
  ".*": {
@@ -355,7 +382,15 @@
355
382
  }
356
383
  }
357
384
  },
358
- "integration": {
385
+ "virtualButton": {
386
+ "type": "object",
387
+ "patternProperties": {
388
+ ".*": {
389
+ "type": "number"
390
+ }
391
+ }
392
+ },
393
+ "webhook": {
359
394
  "type": "object",
360
395
  "patternProperties": {
361
396
  ".*": {
@@ -366,21 +401,21 @@
366
401
  }
367
402
  },
368
403
  "pendingInviteCount": {
369
- "type": "number"
404
+ "type": "integer"
370
405
  },
371
406
  "storageStats": {
372
407
  "type": "object",
373
408
  "properties": {
374
409
  "count": {
375
- "type": "number"
410
+ "type": "integer"
376
411
  },
377
412
  "size": {
378
- "type": "number"
413
+ "type": "integer"
379
414
  }
380
415
  }
381
416
  },
382
417
  "webhookCount": {
383
- "type": "number"
418
+ "type": "integer"
384
419
  }
385
420
  }
386
421
  },
data/schemas/orgInvite.json ADDED
@@ -0,0 +1,90 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "email": {
10
+ "type": "string",
11
+ "format": "email",
12
+ "maxLength": 1024
13
+ },
14
+ "role": {
15
+ "type": "string",
16
+ "enum": [
17
+ "admin",
18
+ "edit",
19
+ "collaborate",
20
+ "view",
21
+ "none"
22
+ ]
23
+ },
24
+ "applicationRoles": {
25
+ "type": "array",
26
+ "items": {
27
+ "type": "object",
28
+ "properties": {
29
+ "resourceId": {
30
+ "type": "string",
31
+ "pattern": "^[A-Fa-f\\d]{24}$"
32
+ },
33
+ "role": {
34
+ "type": "string",
35
+ "enum": [
36
+ "collaborate",
37
+ "view",
38
+ "none"
39
+ ]
40
+ }
41
+ },
42
+ "required": [
43
+ "resourceId",
44
+ "role"
45
+ ],
46
+ "additionalProperties": false
47
+ },
48
+ "maxItems": 1000
49
+ },
50
+ "dashboardRoles": {
51
+ "type": "array",
52
+ "items": {
53
+ "type": "object",
54
+ "properties": {
55
+ "resourceId": {
56
+ "type": "string",
57
+ "pattern": "^[A-Fa-f\\d]{24}$"
58
+ },
59
+ "role": {
60
+ "type": "string",
61
+ "enum": [
62
+ "collaborate",
63
+ "view",
64
+ "none"
65
+ ]
66
+ }
67
+ },
68
+ "required": [
69
+ "resourceId",
70
+ "role"
71
+ ],
72
+ "additionalProperties": false
73
+ },
74
+ "maxItems": 1000
75
+ },
76
+ "inviteDate": {
77
+ "type": "string",
78
+ "format": "date-time"
79
+ },
80
+ "ttl": {
81
+ "type": "number"
82
+ },
83
+ "hasExpired": {
84
+ "type": "boolean"
85
+ },
86
+ "disallowTransfer": {
87
+ "type": "boolean"
88
+ }
89
+ }
90
+ }