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/githubLogin.json CHANGED
@@ -42,7 +42,10 @@
42
42
  "deviceRecipe.*",
43
43
  "deviceRecipes.*",
44
44
  "devices.*",
45
+ "edgeDeployment.*",
45
46
  "edgeDeployments.*",
47
+ "embeddedDeployment.*",
48
+ "embeddedDeployments.*",
46
49
  "event.*",
47
50
  "events.*",
48
51
  "experience.*",
@@ -142,6 +145,7 @@
142
145
  "device.getLogEntries",
143
146
  "device.getState",
144
147
  "device.patch",
148
+ "device.payloadCounts",
145
149
  "device.removeData",
146
150
  "device.sendCommand",
147
151
  "device.sendState",
@@ -160,14 +164,22 @@
160
164
  "devices.detailedSummary",
161
165
  "devices.export",
162
166
  "devices.get",
167
+ "devices.payloadCounts",
163
168
  "devices.post",
164
169
  "devices.sendCommand",
165
170
  "devices.tagKeys",
166
171
  "devices.tagValues",
172
+ "edgeDeployment.get",
167
173
  "edgeDeployments.get",
168
174
  "edgeDeployments.release",
169
175
  "edgeDeployments.remove",
170
176
  "edgeDeployments.replace",
177
+ "embeddedDeployment.get",
178
+ "embeddedDeployments.get",
179
+ "embeddedDeployments.release",
180
+ "embeddedDeployments.remove",
181
+ "embeddedDeployments.replace",
182
+ "embeddedDeployments.export",
171
183
  "event.delete",
172
184
  "event.get",
173
185
  "event.patch",
@@ -345,6 +357,13 @@
345
357
  "instanceOrgMembers.*",
346
358
  "instanceOrgMembers.get",
347
359
  "instanceOrgMembers.post",
360
+ "instanceOrgInvite.*",
361
+ "instanceOrgInvite.get",
362
+ "instanceOrgInvite.delete",
363
+ "instanceOrgInvite.resendInvite",
364
+ "instanceOrgInvites.*",
365
+ "instanceOrgInvites.get",
366
+ "instanceOrgInvites.post",
348
367
  "instanceApiTokens.*",
349
368
  "instanceApiTokens.get",
350
369
  "instanceApiTokens.post",
data/schemas/historicalSummary.json CHANGED
@@ -39,81 +39,94 @@
39
39
  "maxLength": 255
40
40
  },
41
41
  "limits": {
42
- "apitoken": {
43
- "type": "number"
44
- },
45
- "application": {
46
- "type": "number"
47
- },
48
- "applicationkey": {
49
- "type": "number"
50
- },
51
- "dashboard": {
52
- "type": "number"
53
- },
54
- "datatable": {
55
- "type": "number"
56
- },
57
- "device": {
58
- "type": "number"
59
- },
60
- "devicerecipe": {
61
- "type": "number"
62
- },
63
- "experiencedomain": {
64
- "type": "number"
65
- },
66
- "experienceendpoint": {
67
- "type": "number"
68
- },
69
- "experiencegroup": {
70
- "type": "number"
71
- },
72
- "experienceslug": {
73
- "type": "number"
74
- },
75
- "experienceuser": {
76
- "type": "number"
77
- },
78
- "experienceversion": {
79
- "type": "number"
80
- },
81
- "experienceview": {
82
- "type": "number"
83
- },
84
- "file": {
85
- "type": "number"
86
- },
87
- "flow": {
88
- "type": "number"
89
- },
90
- "integration": {
91
- "type": "number"
92
- },
93
- "notebook": {
94
- "type": "number"
95
- },
96
- "webhook": {
97
- "type": "number"
98
- },
99
- "dataTTL": {
100
- "type": "number"
101
- },
102
- "member": {
103
- "type": "number"
104
- },
105
- "payload": {
106
- "type": "number"
107
- },
108
- "notebookMinutesPerRun": {
109
- "type": "number"
110
- },
111
- "notebookMinutesPerMonth": {
112
- "type": "number"
42
+ "type": "object",
43
+ "properties": {
44
+ "apitoken": {
45
+ "type": "integer"
46
+ },
47
+ "application": {
48
+ "type": "integer"
49
+ },
50
+ "applicationkey": {
51
+ "type": "integer"
52
+ },
53
+ "dashboard": {
54
+ "type": "integer"
55
+ },
56
+ "datatable": {
57
+ "type": "integer"
58
+ },
59
+ "device": {
60
+ "type": "integer"
61
+ },
62
+ "devicerecipe": {
63
+ "type": "integer"
64
+ },
65
+ "experiencedomain": {
66
+ "type": "integer"
67
+ },
68
+ "experienceendpoint": {
69
+ "type": "integer"
70
+ },
71
+ "experiencegroup": {
72
+ "type": "integer"
73
+ },
74
+ "experienceslug": {
75
+ "type": "integer"
76
+ },
77
+ "experienceuser": {
78
+ "type": "integer"
79
+ },
80
+ "experienceversion": {
81
+ "type": "integer"
82
+ },
83
+ "experienceview": {
84
+ "type": "integer"
85
+ },
86
+ "file": {
87
+ "type": "integer"
88
+ },
89
+ "flow": {
90
+ "type": "integer"
91
+ },
92
+ "integration": {
93
+ "type": "integer"
94
+ },
95
+ "notebook": {
96
+ "type": "integer"
97
+ },
98
+ "webhook": {
99
+ "type": "integer"
100
+ },
101
+ "dataTTL": {
102
+ "type": "integer"
103
+ },
104
+ "member": {
105
+ "type": "integer"
106
+ },
107
+ "payload": {
108
+ "type": "integer"
109
+ },
110
+ "storage": {
111
+ "type": "integer"
112
+ },
113
+ "notebookMinutesPerRun": {
114
+ "type": "integer"
115
+ },
116
+ "notebookMinutesPerMonth": {
117
+ "type": "integer"
118
+ },
119
+ "notebookInParallel": {
120
+ "type": "integer"
121
+ },
122
+ "experienceFlowSlots": {
123
+ "type": "integer"
124
+ },
125
+ "applicationFlowSlots": {
126
+ "type": "integer"
127
+ }
113
128
  },
114
- "notebookInParallel": {
115
- "type": "number"
116
- }
129
+ "additionalProperties": false
117
130
  },
118
131
  "currentPeriodStart": {
119
132
  "type": "string",
@@ -232,11 +245,11 @@
232
245
  "type": "number"
233
246
  },
234
247
  "payloadCountDetails": {
235
- "title": "Payload Counts",
236
- "description": "Schema for the result of a payload count request",
248
+ "title": "Payload Stats",
249
+ "description": "Schema for the result of a payload stats request",
237
250
  "type": "object",
238
251
  "properties": {
239
- "mqttOut": {
252
+ "dataTable": {
240
253
  "type": "object",
241
254
  "patternProperties": {
242
255
  ".*": {
@@ -244,7 +257,7 @@
244
257
  }
245
258
  }
246
259
  },
247
- "mqttIn": {
260
+ "deviceCommand": {
248
261
  "type": "object",
249
262
  "patternProperties": {
250
263
  ".*": {
@@ -252,7 +265,15 @@
252
265
  }
253
266
  }
254
267
  },
255
- "dataTable": {
268
+ "deviceConnect": {
269
+ "type": "object",
270
+ "patternProperties": {
271
+ ".*": {
272
+ "type": "number"
273
+ }
274
+ }
275
+ },
276
+ "deviceDisconnect": {
256
277
  "type": "object",
257
278
  "patternProperties": {
258
279
  ".*": {
@@ -268,7 +289,7 @@
268
289
  }
269
290
  }
270
291
  },
271
- "deviceCommand": {
292
+ "endpoint": {
272
293
  "type": "object",
273
294
  "patternProperties": {
274
295
  ".*": {
@@ -276,7 +297,7 @@
276
297
  }
277
298
  }
278
299
  },
279
- "webhook": {
300
+ "event": {
280
301
  "type": "object",
281
302
  "patternProperties": {
282
303
  ".*": {
@@ -284,7 +305,7 @@
284
305
  }
285
306
  }
286
307
  },
287
- "timer": {
308
+ "flowError": {
288
309
  "type": "object",
289
310
  "patternProperties": {
290
311
  ".*": {
@@ -292,7 +313,7 @@
292
313
  }
293
314
  }
294
315
  },
295
- "event": {
316
+ "integration": {
296
317
  "type": "object",
297
318
  "patternProperties": {
298
319
  ".*": {
@@ -300,7 +321,7 @@
300
321
  }
301
322
  }
302
323
  },
303
- "virtualButton": {
324
+ "mqttIn": {
304
325
  "type": "object",
305
326
  "patternProperties": {
306
327
  ".*": {
@@ -308,7 +329,7 @@
308
329
  }
309
330
  }
310
331
  },
311
- "deviceConnect": {
332
+ "mqttOut": {
312
333
  "type": "object",
313
334
  "patternProperties": {
314
335
  ".*": {
@@ -316,7 +337,7 @@
316
337
  }
317
338
  }
318
339
  },
319
- "deviceDisconnect": {
340
+ "notebook": {
320
341
  "type": "object",
321
342
  "patternProperties": {
322
343
  ".*": {
@@ -324,7 +345,7 @@
324
345
  }
325
346
  }
326
347
  },
327
- "endpoint": {
348
+ "timer": {
328
349
  "type": "object",
329
350
  "patternProperties": {
330
351
  ".*": {
@@ -332,7 +353,15 @@
332
353
  }
333
354
  }
334
355
  },
335
- "integration": {
356
+ "virtualButton": {
357
+ "type": "object",
358
+ "patternProperties": {
359
+ ".*": {
360
+ "type": "number"
361
+ }
362
+ }
363
+ },
364
+ "webhook": {
336
365
  "type": "object",
337
366
  "patternProperties": {
338
367
  ".*": {
@@ -343,11 +372,11 @@
343
372
  }
344
373
  },
345
374
  "payloadSizeDetails": {
346
- "title": "Payload Counts",
347
- "description": "Schema for the result of a payload count request",
375
+ "title": "Payload Stats",
376
+ "description": "Schema for the result of a payload stats request",
348
377
  "type": "object",
349
378
  "properties": {
350
- "mqttOut": {
379
+ "dataTable": {
351
380
  "type": "object",
352
381
  "patternProperties": {
353
382
  ".*": {
@@ -355,7 +384,7 @@
355
384
  }
356
385
  }
357
386
  },
358
- "mqttIn": {
387
+ "deviceCommand": {
359
388
  "type": "object",
360
389
  "patternProperties": {
361
390
  ".*": {
@@ -363,7 +392,15 @@
363
392
  }
364
393
  }
365
394
  },
366
- "dataTable": {
395
+ "deviceConnect": {
396
+ "type": "object",
397
+ "patternProperties": {
398
+ ".*": {
399
+ "type": "number"
400
+ }
401
+ }
402
+ },
403
+ "deviceDisconnect": {
367
404
  "type": "object",
368
405
  "patternProperties": {
369
406
  ".*": {
@@ -379,7 +416,7 @@
379
416
  }
380
417
  }
381
418
  },
382
- "deviceCommand": {
419
+ "endpoint": {
383
420
  "type": "object",
384
421
  "patternProperties": {
385
422
  ".*": {
@@ -387,7 +424,7 @@
387
424
  }
388
425
  }
389
426
  },
390
- "webhook": {
427
+ "event": {
391
428
  "type": "object",
392
429
  "patternProperties": {
393
430
  ".*": {
@@ -395,7 +432,7 @@
395
432
  }
396
433
  }
397
434
  },
398
- "timer": {
435
+ "flowError": {
399
436
  "type": "object",
400
437
  "patternProperties": {
401
438
  ".*": {
@@ -403,7 +440,7 @@
403
440
  }
404
441
  }
405
442
  },
406
- "event": {
443
+ "integration": {
407
444
  "type": "object",
408
445
  "patternProperties": {
409
446
  ".*": {
@@ -411,7 +448,7 @@
411
448
  }
412
449
  }
413
450
  },
414
- "virtualButton": {
451
+ "mqttIn": {
415
452
  "type": "object",
416
453
  "patternProperties": {
417
454
  ".*": {
@@ -419,7 +456,7 @@
419
456
  }
420
457
  }
421
458
  },
422
- "deviceConnect": {
459
+ "mqttOut": {
423
460
  "type": "object",
424
461
  "patternProperties": {
425
462
  ".*": {
@@ -427,7 +464,7 @@
427
464
  }
428
465
  }
429
466
  },
430
- "deviceDisconnect": {
467
+ "notebook": {
431
468
  "type": "object",
432
469
  "patternProperties": {
433
470
  ".*": {
@@ -435,7 +472,7 @@
435
472
  }
436
473
  }
437
474
  },
438
- "endpoint": {
475
+ "timer": {
439
476
  "type": "object",
440
477
  "patternProperties": {
441
478
  ".*": {
@@ -443,7 +480,15 @@
443
480
  }
444
481
  }
445
482
  },
446
- "integration": {
483
+ "virtualButton": {
484
+ "type": "object",
485
+ "patternProperties": {
486
+ ".*": {
487
+ "type": "number"
488
+ }
489
+ }
490
+ },
491
+ "webhook": {
447
492
  "type": "object",
448
493
  "patternProperties": {
449
494
  ".*": {
data/schemas/instance.json CHANGED
@@ -28,9 +28,9 @@
28
28
  },
29
29
  "reportConfigs": {
30
30
  "type": "array",
31
+ "maxItems": 10,
31
32
  "items": {
32
33
  "type": "object",
33
- "max": 10,
34
34
  "properties": {
35
35
  "id": {
36
36
  "type": "string",
@@ -46,7 +46,7 @@
46
46
  },
47
47
  "emails": {
48
48
  "type": "array",
49
- "max": 10,
49
+ "maxItems": 10,
50
50
  "items": {
51
51
  "type": "string",
52
52
  "format": "email",
@@ -87,84 +87,97 @@
87
87
  }
88
88
  },
89
89
  "limits": {
90
- "organization": {
91
- "type": "number"
92
- },
93
- "apitoken": {
94
- "type": "number"
95
- },
96
- "application": {
97
- "type": "number"
98
- },
99
- "applicationkey": {
100
- "type": "number"
101
- },
102
- "dashboard": {
103
- "type": "number"
104
- },
105
- "datatable": {
106
- "type": "number"
107
- },
108
- "device": {
109
- "type": "number"
110
- },
111
- "devicerecipe": {
112
- "type": "number"
113
- },
114
- "experiencedomain": {
115
- "type": "number"
116
- },
117
- "experienceendpoint": {
118
- "type": "number"
119
- },
120
- "experiencegroup": {
121
- "type": "number"
122
- },
123
- "experienceslug": {
124
- "type": "number"
125
- },
126
- "experienceuser": {
127
- "type": "number"
128
- },
129
- "experienceversion": {
130
- "type": "number"
131
- },
132
- "experienceview": {
133
- "type": "number"
134
- },
135
- "file": {
136
- "type": "number"
137
- },
138
- "flow": {
139
- "type": "number"
140
- },
141
- "integration": {
142
- "type": "number"
143
- },
144
- "notebook": {
145
- "type": "number"
146
- },
147
- "webhook": {
148
- "type": "number"
149
- },
150
- "dataTTL": {
151
- "type": "number"
152
- },
153
- "member": {
154
- "type": "number"
155
- },
156
- "payload": {
157
- "type": "number"
158
- },
159
- "notebookMinutesPerRun": {
160
- "type": "number"
161
- },
162
- "notebookMinutesPerMonth": {
163
- "type": "number"
90
+ "type": "object",
91
+ "properties": {
92
+ "organization": {
93
+ "type": "integer"
94
+ },
95
+ "apitoken": {
96
+ "type": "integer"
97
+ },
98
+ "application": {
99
+ "type": "integer"
100
+ },
101
+ "applicationkey": {
102
+ "type": "integer"
103
+ },
104
+ "dashboard": {
105
+ "type": "integer"
106
+ },
107
+ "datatable": {
108
+ "type": "integer"
109
+ },
110
+ "device": {
111
+ "type": "integer"
112
+ },
113
+ "devicerecipe": {
114
+ "type": "integer"
115
+ },
116
+ "experiencedomain": {
117
+ "type": "integer"
118
+ },
119
+ "experienceendpoint": {
120
+ "type": "integer"
121
+ },
122
+ "experiencegroup": {
123
+ "type": "integer"
124
+ },
125
+ "experienceslug": {
126
+ "type": "integer"
127
+ },
128
+ "experienceuser": {
129
+ "type": "integer"
130
+ },
131
+ "experienceversion": {
132
+ "type": "integer"
133
+ },
134
+ "experienceview": {
135
+ "type": "integer"
136
+ },
137
+ "file": {
138
+ "type": "integer"
139
+ },
140
+ "flow": {
141
+ "type": "integer"
142
+ },
143
+ "integration": {
144
+ "type": "integer"
145
+ },
146
+ "notebook": {
147
+ "type": "integer"
148
+ },
149
+ "webhook": {
150
+ "type": "integer"
151
+ },
152
+ "dataTTL": {
153
+ "type": "integer"
154
+ },
155
+ "member": {
156
+ "type": "integer"
157
+ },
158
+ "payload": {
159
+ "type": "integer"
160
+ },
161
+ "storage": {
162
+ "type": "integer"
163
+ },
164
+ "notebookMinutesPerRun": {
165
+ "type": "integer"
166
+ },
167
+ "notebookMinutesPerMonth": {
168
+ "type": "integer"
169
+ },
170
+ "notebookInParallel": {
171
+ "type": "integer"
172
+ },
173
+ "experienceFlowSlots": {
174
+ "type": "integer"
175
+ },
176
+ "applicationFlowSlots": {
177
+ "type": "integer"
178
+ }
164
179
  },
165
- "notebookInParallel": {
166
- "type": "number"
167
- }
180
+ "additionalProperties": false
168
181
  },
169
182
  "members": {
170
183
  "type": "array",