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/instanceOrgs.json CHANGED
@@ -31,81 +31,94 @@
31
31
  "maxLength": 64
32
32
  },
33
33
  "limits": {
34
- "apitoken": {
35
- "type": "number"
36
- },
37
- "application": {
38
- "type": "number"
39
- },
40
- "applicationkey": {
41
- "type": "number"
42
- },
43
- "dashboard": {
44
- "type": "number"
45
- },
46
- "datatable": {
47
- "type": "number"
48
- },
49
- "device": {
50
- "type": "number"
51
- },
52
- "devicerecipe": {
53
- "type": "number"
54
- },
55
- "experiencedomain": {
56
- "type": "number"
57
- },
58
- "experienceendpoint": {
59
- "type": "number"
60
- },
61
- "experiencegroup": {
62
- "type": "number"
63
- },
64
- "experienceslug": {
65
- "type": "number"
66
- },
67
- "experienceuser": {
68
- "type": "number"
69
- },
70
- "experienceversion": {
71
- "type": "number"
72
- },
73
- "experienceview": {
74
- "type": "number"
75
- },
76
- "file": {
77
- "type": "number"
78
- },
79
- "flow": {
80
- "type": "number"
81
- },
82
- "integration": {
83
- "type": "number"
84
- },
85
- "notebook": {
86
- "type": "number"
87
- },
88
- "webhook": {
89
- "type": "number"
90
- },
91
- "dataTTL": {
92
- "type": "number"
93
- },
94
- "member": {
95
- "type": "number"
96
- },
97
- "payload": {
98
- "type": "number"
99
- },
100
- "notebookMinutesPerRun": {
101
- "type": "number"
102
- },
103
- "notebookMinutesPerMonth": {
104
- "type": "number"
34
+ "type": "object",
35
+ "properties": {
36
+ "apitoken": {
37
+ "type": "integer"
38
+ },
39
+ "application": {
40
+ "type": "integer"
41
+ },
42
+ "applicationkey": {
43
+ "type": "integer"
44
+ },
45
+ "dashboard": {
46
+ "type": "integer"
47
+ },
48
+ "datatable": {
49
+ "type": "integer"
50
+ },
51
+ "device": {
52
+ "type": "integer"
53
+ },
54
+ "devicerecipe": {
55
+ "type": "integer"
56
+ },
57
+ "experiencedomain": {
58
+ "type": "integer"
59
+ },
60
+ "experienceendpoint": {
61
+ "type": "integer"
62
+ },
63
+ "experiencegroup": {
64
+ "type": "integer"
65
+ },
66
+ "experienceslug": {
67
+ "type": "integer"
68
+ },
69
+ "experienceuser": {
70
+ "type": "integer"
71
+ },
72
+ "experienceversion": {
73
+ "type": "integer"
74
+ },
75
+ "experienceview": {
76
+ "type": "integer"
77
+ },
78
+ "file": {
79
+ "type": "integer"
80
+ },
81
+ "flow": {
82
+ "type": "integer"
83
+ },
84
+ "integration": {
85
+ "type": "integer"
86
+ },
87
+ "notebook": {
88
+ "type": "integer"
89
+ },
90
+ "webhook": {
91
+ "type": "integer"
92
+ },
93
+ "dataTTL": {
94
+ "type": "integer"
95
+ },
96
+ "member": {
97
+ "type": "integer"
98
+ },
99
+ "payload": {
100
+ "type": "integer"
101
+ },
102
+ "storage": {
103
+ "type": "integer"
104
+ },
105
+ "notebookMinutesPerRun": {
106
+ "type": "integer"
107
+ },
108
+ "notebookMinutesPerMonth": {
109
+ "type": "integer"
110
+ },
111
+ "notebookInParallel": {
112
+ "type": "integer"
113
+ },
114
+ "experienceFlowSlots": {
115
+ "type": "integer"
116
+ },
117
+ "applicationFlowSlots": {
118
+ "type": "integer"
119
+ }
105
120
  },
106
- "notebookInParallel": {
107
- "type": "number"
108
- }
121
+ "additionalProperties": false
109
122
  },
110
123
  "whitelistedEmailDomains": {
111
124
  "type": "array",
@@ -139,6 +152,10 @@
139
152
  ]
140
153
  }
141
154
  },
155
+ "instanceId": {
156
+ "type": "string",
157
+ "pattern": "^[A-Fa-f\\d]{24}$"
158
+ },
142
159
  "count": {
143
160
  "type": "integer"
144
161
  },
data/schemas/instancePatch.json CHANGED
@@ -4,9 +4,9 @@
4
4
  "properties": {
5
5
  "reportConfigs": {
6
6
  "type": "array",
7
+ "maxItems": 10,
7
8
  "items": {
8
9
  "type": "object",
9
- "max": 10,
10
10
  "properties": {
11
11
  "id": {
12
12
  "type": "string",
@@ -22,7 +22,7 @@
22
22
  },
23
23
  "emails": {
24
24
  "type": "array",
25
- "max": 10,
25
+ "maxItems": 10,
26
26
  "items": {
27
27
  "type": "string",
28
28
  "format": "email",
data/schemas/me.json CHANGED
@@ -81,78 +81,91 @@
81
81
  "format": "url"
82
82
  },
83
83
  "limits": {
84
- "apitoken": {
85
- "type": "number"
86
- },
87
- "application": {
88
- "type": "number"
89
- },
90
- "applicationkey": {
91
- "type": "number"
92
- },
93
- "dashboard": {
94
- "type": "number"
95
- },
96
- "datatable": {
97
- "type": "number"
98
- },
99
- "device": {
100
- "type": "number"
101
- },
102
- "devicerecipe": {
103
- "type": "number"
104
- },
105
- "experiencedomain": {
106
- "type": "number"
107
- },
108
- "experienceendpoint": {
109
- "type": "number"
110
- },
111
- "experiencegroup": {
112
- "type": "number"
113
- },
114
- "experienceslug": {
115
- "type": "number"
116
- },
117
- "experienceuser": {
118
- "type": "number"
119
- },
120
- "experienceversion": {
121
- "type": "number"
122
- },
123
- "experienceview": {
124
- "type": "number"
125
- },
126
- "file": {
127
- "type": "number"
128
- },
129
- "flow": {
130
- "type": "number"
131
- },
132
- "integration": {
133
- "type": "number"
134
- },
135
- "notebook": {
136
- "type": "number"
137
- },
138
- "webhook": {
139
- "type": "number"
140
- },
141
- "dataTTL": {
142
- "type": "number"
143
- },
144
- "payload": {
145
- "type": "number"
146
- },
147
- "notebookMinutesPerRun": {
148
- "type": "number"
149
- },
150
- "notebookMinutesPerMonth": {
151
- "type": "number"
84
+ "type": "object",
85
+ "properties": {
86
+ "apitoken": {
87
+ "type": "integer"
88
+ },
89
+ "application": {
90
+ "type": "integer"
91
+ },
92
+ "applicationkey": {
93
+ "type": "integer"
94
+ },
95
+ "dashboard": {
96
+ "type": "integer"
97
+ },
98
+ "datatable": {
99
+ "type": "integer"
100
+ },
101
+ "device": {
102
+ "type": "integer"
103
+ },
104
+ "devicerecipe": {
105
+ "type": "integer"
106
+ },
107
+ "experiencedomain": {
108
+ "type": "integer"
109
+ },
110
+ "experienceendpoint": {
111
+ "type": "integer"
112
+ },
113
+ "experiencegroup": {
114
+ "type": "integer"
115
+ },
116
+ "experienceslug": {
117
+ "type": "integer"
118
+ },
119
+ "experienceuser": {
120
+ "type": "integer"
121
+ },
122
+ "experienceversion": {
123
+ "type": "integer"
124
+ },
125
+ "experienceview": {
126
+ "type": "integer"
127
+ },
128
+ "file": {
129
+ "type": "integer"
130
+ },
131
+ "flow": {
132
+ "type": "integer"
133
+ },
134
+ "integration": {
135
+ "type": "integer"
136
+ },
137
+ "notebook": {
138
+ "type": "integer"
139
+ },
140
+ "webhook": {
141
+ "type": "integer"
142
+ },
143
+ "dataTTL": {
144
+ "type": "integer"
145
+ },
146
+ "payload": {
147
+ "type": "integer"
148
+ },
149
+ "storage": {
150
+ "type": "integer"
151
+ },
152
+ "notebookMinutesPerRun": {
153
+ "type": "integer"
154
+ },
155
+ "notebookMinutesPerMonth": {
156
+ "type": "integer"
157
+ },
158
+ "notebookInParallel": {
159
+ "type": "integer"
160
+ },
161
+ "experienceFlowSlots": {
162
+ "type": "integer"
163
+ },
164
+ "applicationFlowSlots": {
165
+ "type": "integer"
166
+ }
152
167
  },
153
- "notebookInParallel": {
154
- "type": "number"
155
- }
168
+ "additionalProperties": false
156
169
  },
157
170
  "recentDashboards": {
158
171
  "title": "Recent Item List",
@@ -272,62 +285,62 @@
272
285
  "type": "object",
273
286
  "properties": {
274
287
  "apiTokenCount": {
275
- "type": "number"
288
+ "type": "integer"
276
289
  },
277
290
  "appCount": {
278
- "type": "number"
291
+ "type": "integer"
279
292
  },
280
293
  "dashCount": {
281
- "type": "number"
294
+ "type": "integer"
282
295
  },
283
296
  "dataTableCount": {
284
- "type": "number"
297
+ "type": "integer"
285
298
  },
286
299
  "deviceCount": {
287
- "type": "number"
300
+ "type": "integer"
288
301
  },
289
302
  "deviceRecipeCount": {
290
- "type": "number"
303
+ "type": "integer"
291
304
  },
292
305
  "experienceEndpointCount": {
293
- "type": "number"
306
+ "type": "integer"
294
307
  },
295
308
  "experienceGroupCount": {
296
- "type": "number"
309
+ "type": "integer"
297
310
  },
298
311
  "experienceSlugCount": {
299
- "type": "number"
312
+ "type": "integer"
300
313
  },
301
314
  "experienceUserCount": {
302
- "type": "number"
315
+ "type": "integer"
303
316
  },
304
317
  "experienceVersionCount": {
305
- "type": "number"
318
+ "type": "integer"
306
319
  },
307
320
  "experienceViewCount": {
308
- "type": "number"
321
+ "type": "integer"
309
322
  },
310
323
  "fileCount": {
311
- "type": "number"
324
+ "type": "integer"
312
325
  },
313
326
  "flowCount": {
314
- "type": "number"
327
+ "type": "integer"
315
328
  },
316
329
  "integrationCount": {
317
- "type": "number"
330
+ "type": "integer"
318
331
  },
319
332
  "keyCount": {
320
- "type": "number"
333
+ "type": "integer"
321
334
  },
322
335
  "orgCount": {
323
- "type": "number"
336
+ "type": "integer"
324
337
  },
325
338
  "payloadCount": {
326
- "title": "Payload Counts",
327
- "description": "Schema for the result of a payload count request",
339
+ "title": "Payload Stats",
340
+ "description": "Schema for the result of a payload stats request",
328
341
  "type": "object",
329
342
  "properties": {
330
- "mqttOut": {
343
+ "dataTable": {
331
344
  "type": "object",
332
345
  "patternProperties": {
333
346
  ".*": {
@@ -335,7 +348,7 @@
335
348
  }
336
349
  }
337
350
  },
338
- "mqttIn": {
351
+ "deviceCommand": {
339
352
  "type": "object",
340
353
  "patternProperties": {
341
354
  ".*": {
@@ -343,7 +356,15 @@
343
356
  }
344
357
  }
345
358
  },
346
- "dataTable": {
359
+ "deviceConnect": {
360
+ "type": "object",
361
+ "patternProperties": {
362
+ ".*": {
363
+ "type": "number"
364
+ }
365
+ }
366
+ },
367
+ "deviceDisconnect": {
347
368
  "type": "object",
348
369
  "patternProperties": {
349
370
  ".*": {
@@ -359,7 +380,7 @@
359
380
  }
360
381
  }
361
382
  },
362
- "deviceCommand": {
383
+ "endpoint": {
363
384
  "type": "object",
364
385
  "patternProperties": {
365
386
  ".*": {
@@ -367,7 +388,7 @@
367
388
  }
368
389
  }
369
390
  },
370
- "webhook": {
391
+ "event": {
371
392
  "type": "object",
372
393
  "patternProperties": {
373
394
  ".*": {
@@ -375,7 +396,7 @@
375
396
  }
376
397
  }
377
398
  },
378
- "timer": {
399
+ "flowError": {
379
400
  "type": "object",
380
401
  "patternProperties": {
381
402
  ".*": {
@@ -383,7 +404,7 @@
383
404
  }
384
405
  }
385
406
  },
386
- "event": {
407
+ "integration": {
387
408
  "type": "object",
388
409
  "patternProperties": {
389
410
  ".*": {
@@ -391,7 +412,7 @@
391
412
  }
392
413
  }
393
414
  },
394
- "virtualButton": {
415
+ "mqttIn": {
395
416
  "type": "object",
396
417
  "patternProperties": {
397
418
  ".*": {
@@ -399,7 +420,7 @@
399
420
  }
400
421
  }
401
422
  },
402
- "deviceConnect": {
423
+ "mqttOut": {
403
424
  "type": "object",
404
425
  "patternProperties": {
405
426
  ".*": {
@@ -407,7 +428,7 @@
407
428
  }
408
429
  }
409
430
  },
410
- "deviceDisconnect": {
431
+ "notebook": {
411
432
  "type": "object",
412
433
  "patternProperties": {
413
434
  ".*": {
@@ -415,7 +436,7 @@
415
436
  }
416
437
  }
417
438
  },
418
- "endpoint": {
439
+ "timer": {
419
440
  "type": "object",
420
441
  "patternProperties": {
421
442
  ".*": {
@@ -423,7 +444,15 @@
423
444
  }
424
445
  }
425
446
  },
426
- "integration": {
447
+ "virtualButton": {
448
+ "type": "object",
449
+ "patternProperties": {
450
+ ".*": {
451
+ "type": "number"
452
+ }
453
+ }
454
+ },
455
+ "webhook": {
427
456
  "type": "object",
428
457
  "patternProperties": {
429
458
  ".*": {
@@ -437,15 +466,15 @@
437
466
  "type": "object",
438
467
  "properties": {
439
468
  "count": {
440
- "type": "number"
469
+ "type": "integer"
441
470
  },
442
471
  "size": {
443
- "type": "number"
472
+ "type": "integer"
444
473
  }
445
474
  }
446
475
  },
447
476
  "webhookCount": {
448
- "type": "number"
477
+ "type": "integer"
449
478
  }
450
479
  }
451
480
  },
data/schemas/notebook.json CHANGED
@@ -43,7 +43,8 @@
43
43
  "type": "string",
44
44
  "enum": [
45
45
  "v1",
46
- "v2"
46
+ "v2",
47
+ "v3"
47
48
  ]
48
49
  },
49
50
  "inputs": {
@@ -608,6 +609,36 @@
608
609
  "outputType"
609
610
  ],
610
611
  "additionalProperties": false
612
+ },
613
+ {
614
+ "type": "object",
615
+ "properties": {
616
+ "outputType": {
617
+ "type": "string",
618
+ "enum": [
619
+ "temporaryUrl"
620
+ ]
621
+ },
622
+ "fileName": {
623
+ "oneOf": [
624
+ {
625
+ "type": "string",
626
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
627
+ },
628
+ {
629
+ "type": "string",
630
+ "minLength": 4,
631
+ "maxLength": 255,
632
+ "pattern": ".*{{.+}}.*"
633
+ }
634
+ ]
635
+ }
636
+ },
637
+ "required": [
638
+ "fileName",
639
+ "outputType"
640
+ ],
641
+ "additionalProperties": false
611
642
  }
612
643
  ]
613
644
  }
data/schemas/notebookExecutionLogs.json CHANGED
@@ -20,7 +20,8 @@
20
20
  "type": "string",
21
21
  "enum": [
22
22
  "v1",
23
- "v2"
23
+ "v2",
24
+ "v3"
24
25
  ]
25
26
  },
26
27
  "applicationId": {