losant_rest 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (124) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +4164 -701
  5. data/docs/events.md +3 -3
  6. data/docs/flow.md +41 -0
  7. data/docs/instance.md +128 -0
  8. data/docs/instanceMember.md +133 -0
  9. data/docs/instanceMembers.md +91 -0
  10. data/docs/instanceOrg.md +133 -0
  11. data/docs/instanceOrgMember.md +139 -0
  12. data/docs/instanceOrgMembers.md +96 -0
  13. data/docs/instanceOrgs.md +91 -0
  14. data/docs/instances.md +50 -0
  15. data/lib/losant_rest.rb +9 -1
  16. data/lib/losant_rest/application.rb +2 -2
  17. data/lib/losant_rest/application_api_token.rb +1 -1
  18. data/lib/losant_rest/application_api_tokens.rb +1 -1
  19. data/lib/losant_rest/application_certificate.rb +1 -1
  20. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  21. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  22. data/lib/losant_rest/application_certificates.rb +1 -1
  23. data/lib/losant_rest/application_dashboard.rb +1 -1
  24. data/lib/losant_rest/application_dashboards.rb +1 -1
  25. data/lib/losant_rest/application_key.rb +1 -1
  26. data/lib/losant_rest/application_keys.rb +1 -1
  27. data/lib/losant_rest/application_template.rb +1 -1
  28. data/lib/losant_rest/application_templates.rb +1 -1
  29. data/lib/losant_rest/applications.rb +1 -1
  30. data/lib/losant_rest/audit_log.rb +1 -1
  31. data/lib/losant_rest/audit_logs.rb +1 -1
  32. data/lib/losant_rest/auth.rb +1 -1
  33. data/lib/losant_rest/client.rb +35 -3
  34. data/lib/losant_rest/dashboard.rb +1 -1
  35. data/lib/losant_rest/dashboards.rb +1 -1
  36. data/lib/losant_rest/data.rb +1 -1
  37. data/lib/losant_rest/data_table.rb +1 -1
  38. data/lib/losant_rest/data_table_row.rb +1 -1
  39. data/lib/losant_rest/data_table_rows.rb +1 -1
  40. data/lib/losant_rest/data_tables.rb +1 -1
  41. data/lib/losant_rest/device.rb +1 -1
  42. data/lib/losant_rest/device_recipe.rb +1 -1
  43. data/lib/losant_rest/device_recipes.rb +1 -1
  44. data/lib/losant_rest/devices.rb +1 -1
  45. data/lib/losant_rest/edge_deployments.rb +1 -1
  46. data/lib/losant_rest/error.rb +1 -1
  47. data/lib/losant_rest/event.rb +1 -1
  48. data/lib/losant_rest/events.rb +4 -4
  49. data/lib/losant_rest/experience.rb +1 -1
  50. data/lib/losant_rest/experience_domain.rb +1 -1
  51. data/lib/losant_rest/experience_domains.rb +1 -1
  52. data/lib/losant_rest/experience_endpoint.rb +1 -1
  53. data/lib/losant_rest/experience_endpoints.rb +1 -1
  54. data/lib/losant_rest/experience_group.rb +1 -1
  55. data/lib/losant_rest/experience_groups.rb +1 -1
  56. data/lib/losant_rest/experience_slug.rb +1 -1
  57. data/lib/losant_rest/experience_slugs.rb +1 -1
  58. data/lib/losant_rest/experience_user.rb +1 -1
  59. data/lib/losant_rest/experience_users.rb +1 -1
  60. data/lib/losant_rest/experience_version.rb +1 -1
  61. data/lib/losant_rest/experience_versions.rb +1 -1
  62. data/lib/losant_rest/experience_view.rb +1 -1
  63. data/lib/losant_rest/experience_views.rb +1 -1
  64. data/lib/losant_rest/file.rb +1 -1
  65. data/lib/losant_rest/files.rb +1 -1
  66. data/lib/losant_rest/flow.rb +47 -1
  67. data/lib/losant_rest/flow_version.rb +1 -1
  68. data/lib/losant_rest/flow_versions.rb +1 -1
  69. data/lib/losant_rest/flows.rb +1 -1
  70. data/lib/losant_rest/instance.rb +181 -0
  71. data/lib/losant_rest/instance_member.rb +176 -0
  72. data/lib/losant_rest/instance_members.rb +134 -0
  73. data/lib/losant_rest/instance_org.rb +176 -0
  74. data/lib/losant_rest/instance_org_member.rb +182 -0
  75. data/lib/losant_rest/instance_org_members.rb +138 -0
  76. data/lib/losant_rest/instance_orgs.rb +139 -0
  77. data/lib/losant_rest/instances.rb +88 -0
  78. data/lib/losant_rest/integration.rb +1 -1
  79. data/lib/losant_rest/integrations.rb +1 -1
  80. data/lib/losant_rest/me.rb +2 -2
  81. data/lib/losant_rest/notebook.rb +1 -1
  82. data/lib/losant_rest/notebooks.rb +1 -1
  83. data/lib/losant_rest/org.rb +2 -2
  84. data/lib/losant_rest/org_invites.rb +1 -1
  85. data/lib/losant_rest/orgs.rb +1 -1
  86. data/lib/losant_rest/utils.rb +1 -1
  87. data/lib/losant_rest/version.rb +2 -2
  88. data/lib/losant_rest/webhook.rb +1 -1
  89. data/lib/losant_rest/webhooks.rb +1 -1
  90. data/schemas/advancedDeviceQuery.json +309 -0
  91. data/schemas/applicationApiTokenPost.json +1 -0
  92. data/schemas/applicationDashboardPost.json +19 -1
  93. data/schemas/dashboard.json +19 -1
  94. data/schemas/dashboardPatch.json +19 -1
  95. data/schemas/dashboardPost.json +19 -1
  96. data/schemas/dashboards.json +19 -1
  97. data/schemas/devicesDeletePost.json +309 -0
  98. data/schemas/devicesExportPost.json +309 -0
  99. data/schemas/devicesPatch.json +309 -0
  100. data/schemas/devicesRemoveDataPost.json +309 -0
  101. data/schemas/filePost.json +8 -2
  102. data/schemas/flowStorageMetadata.json +13 -0
  103. data/schemas/githubLogin.json +35 -11
  104. data/schemas/historicalSummaries.json +43 -0
  105. data/schemas/historicalSummary.json +455 -0
  106. data/schemas/instanceMember.json +37 -0
  107. data/schemas/instanceMemberPatch.json +17 -0
  108. data/schemas/instanceMemberPost.json +22 -0
  109. data/schemas/instanceMembers.json +69 -0
  110. data/schemas/instanceOrg.json +14 -0
  111. data/schemas/instanceOrgMember.json +37 -0
  112. data/schemas/instanceOrgMemberPatch.json +69 -0
  113. data/schemas/instanceOrgMemberPost.json +161 -0
  114. data/schemas/instanceOrgMembers.json +34 -0
  115. data/schemas/instanceOrgPatch.json +19 -0
  116. data/schemas/instanceOrgPost.json +11 -0
  117. data/schemas/instanceOrgs.json +14 -0
  118. data/schemas/instanceReportOptionsPost.json +40 -0
  119. data/schemas/multiDeviceCommand.json +309 -0
  120. data/schemas/orgPatch.json +0 -9
  121. data/schemas/payloadStats.json +110 -0
  122. data/schemas/userCredentials.json +35 -11
  123. data/schemas/userPost.json +35 -11
  124. metadata +31 -2
data/schemas/filePost.json CHANGED
@@ -34,7 +34,13 @@
34
34
  "height": {
35
35
  "type": "number"
36
36
  }
37
- }
37
+ },
38
+ "additionalProperties": false
38
39
  }
39
- }
40
+ },
41
+ "additionalProperties": false,
42
+ "required": [
43
+ "name",
44
+ "type"
45
+ ]
40
46
  }
data/schemas/flowStorageMetadata.json ADDED
@@ -0,0 +1,13 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "memoryUsed": {
6
+ "type": "number"
7
+ },
8
+ "keysCount": {
9
+ "type": "number"
10
+ }
11
+ },
12
+ "additionalProperties": false
13
+ }
data/schemas/githubLogin.json CHANGED
@@ -238,6 +238,7 @@
238
238
  "flow.patch",
239
239
  "flow.pressVirtualButton",
240
240
  "flow.setStorageEntry",
241
+ "flow.getStorageEntriesMetadata",
241
242
  "flow.stats",
242
243
  "flows.get",
243
244
  "flows.getByVersion",
@@ -311,6 +312,38 @@
311
312
  }
312
313
  ]
313
314
  },
315
+ {
316
+ "type": "string",
317
+ "enum": [
318
+ "all.Instance",
319
+ "all.Instance.read",
320
+ "instance.*",
321
+ "instance.get",
322
+ "instance.historicalSummaries",
323
+ "instance.generateReport",
324
+ "instanceOrg.*",
325
+ "instanceOrg.get",
326
+ "instanceOrg.patch",
327
+ "instanceOrg.delete",
328
+ "instanceOrgs.*",
329
+ "instanceOrgs.get",
330
+ "instanceOrgs.post",
331
+ "instanceMember.*",
332
+ "instanceMember.get",
333
+ "instanceMember.patch",
334
+ "instanceMember.delete",
335
+ "instanceMembers.*",
336
+ "instanceMembers.get",
337
+ "instanceMembers.post",
338
+ "instanceOrgMember.*",
339
+ "instanceOrgMember.get",
340
+ "instanceOrgMember.patch",
341
+ "instanceOrgMember.delete",
342
+ "instanceOrgMembers.*",
343
+ "instanceOrgMembers.get",
344
+ "instanceOrgMembers.post"
345
+ ]
346
+ },
314
347
  {
315
348
  "type": "string",
316
349
  "enum": [
@@ -322,19 +355,9 @@
322
355
  "applicationTemplates.get",
323
356
  "applicationTemplates.getCategories",
324
357
  "applicationTemplates.getUniqueKeywords",
325
- "me.*",
326
- "orgs.*",
327
- "instance.*",
328
- "instance.get",
329
358
  "instances.*",
330
359
  "instances.get",
331
- "instanceOrg.*",
332
- "instanceOrg.get",
333
- "instanceOrg.patch",
334
- "instanceOrg.delete",
335
- "instanceOrgs.*",
336
- "instanceOrgs.get",
337
- "instanceOrgs.post",
360
+ "me.*",
338
361
  "me.get",
339
362
  "me.patch",
340
363
  "me.delete",
@@ -348,6 +371,7 @@
348
371
  "me.fetchRecentItems",
349
372
  "me.payloadCounts",
350
373
  "me.transferResources",
374
+ "orgs.*",
351
375
  "orgs.get",
352
376
  "orgs.post"
353
377
  ]
data/schemas/historicalSummaries.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "#/definitions/historicalSummary"
9
+ }
10
+ },
11
+ "count": {
12
+ "type": "integer"
13
+ },
14
+ "totalCount": {
15
+ "type": "integer"
16
+ },
17
+ "perPage": {
18
+ "type": "integer"
19
+ },
20
+ "page": {
21
+ "type": "integer"
22
+ },
23
+ "filter": {
24
+ "type": "string"
25
+ },
26
+ "filterField": {
27
+ "type": "string"
28
+ },
29
+ "sortField": {
30
+ "type": "string"
31
+ },
32
+ "sortDirection": {
33
+ "type": "string",
34
+ "enum": [
35
+ "asc",
36
+ "desc",
37
+ "ASC",
38
+ "DESC",
39
+ ""
40
+ ]
41
+ }
42
+ }
43
+ }
data/schemas/historicalSummary.json ADDED
@@ -0,0 +1,455 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "resourceType": {
6
+ "type": "string",
7
+ "enum": [
8
+ "application",
9
+ "organization",
10
+ "whitelabel"
11
+ ]
12
+ },
13
+ "resourceId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "resourceName": {
18
+ "type": "string",
19
+ "minLength": 1,
20
+ "maxLength": 255
21
+ },
22
+ "resourceProration": {
23
+ "type": "number"
24
+ },
25
+ "ownerType": {
26
+ "type": "string",
27
+ "enum": [
28
+ "organization",
29
+ "user"
30
+ ]
31
+ },
32
+ "ownerId": {
33
+ "type": "string",
34
+ "pattern": "^[A-Fa-f\\d]{24}$"
35
+ },
36
+ "ownerName": {
37
+ "type": "string",
38
+ "minLength": 1,
39
+ "maxLength": 255
40
+ },
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"
113
+ },
114
+ "notebookInParallel": {
115
+ "type": "number"
116
+ }
117
+ },
118
+ "currentPeriodStart": {
119
+ "type": "string",
120
+ "format": "date-time"
121
+ },
122
+ "currentPeriodEnd": {
123
+ "type": "string",
124
+ "format": "date-time"
125
+ },
126
+ "applicationCount": {
127
+ "type": "number"
128
+ },
129
+ "applicationCountProrated": {
130
+ "type": "number"
131
+ },
132
+ "userCount": {
133
+ "type": "number"
134
+ },
135
+ "userCountProrated": {
136
+ "type": "number"
137
+ },
138
+ "apiTokenCount": {
139
+ "type": "number"
140
+ },
141
+ "applicationKeyCount": {
142
+ "type": "number"
143
+ },
144
+ "certificateAuthorityCount": {
145
+ "type": "number"
146
+ },
147
+ "certificateCount": {
148
+ "type": "number"
149
+ },
150
+ "dashboardCount": {
151
+ "type": "number"
152
+ },
153
+ "dataTableCount": {
154
+ "type": "number"
155
+ },
156
+ "dataTableRowCount": {
157
+ "type": "number"
158
+ },
159
+ "dataTableTotalSizeMb": {
160
+ "type": "number"
161
+ },
162
+ "deviceCount": {
163
+ "type": "number"
164
+ },
165
+ "deviceCountProrated": {
166
+ "type": "number"
167
+ },
168
+ "deviceRecipeCount": {
169
+ "type": "number"
170
+ },
171
+ "eventCount": {
172
+ "type": "number"
173
+ },
174
+ "experienceDomainCount": {
175
+ "type": "number"
176
+ },
177
+ "experienceEndpointCount": {
178
+ "type": "number"
179
+ },
180
+ "experienceGroupCount": {
181
+ "type": "number"
182
+ },
183
+ "experienceSlugCount": {
184
+ "type": "number"
185
+ },
186
+ "experienceUserCount": {
187
+ "type": "number"
188
+ },
189
+ "experienceVersionCount": {
190
+ "type": "number"
191
+ },
192
+ "experienceViewCount": {
193
+ "type": "number"
194
+ },
195
+ "fileCount": {
196
+ "type": "number"
197
+ },
198
+ "fileTotalSizeMb": {
199
+ "type": "number"
200
+ },
201
+ "integrationCount": {
202
+ "type": "number"
203
+ },
204
+ "notebookCount": {
205
+ "type": "number"
206
+ },
207
+ "notebookRunCount": {
208
+ "type": "number"
209
+ },
210
+ "notebookMinutesCount": {
211
+ "type": "number"
212
+ },
213
+ "webhookCount": {
214
+ "type": "number"
215
+ },
216
+ "workflowCount": {
217
+ "type": "number"
218
+ },
219
+ "payloadBillableCount": {
220
+ "type": "number"
221
+ },
222
+ "payloadNonbillableCount": {
223
+ "type": "number"
224
+ },
225
+ "payloadBillableSizeMb": {
226
+ "type": "number"
227
+ },
228
+ "payloadNonbillableSizeMb": {
229
+ "type": "number"
230
+ },
231
+ "payloadCountDetails": {
232
+ "title": "Payload Counts",
233
+ "description": "Schema for the result of a payload count request",
234
+ "type": "object",
235
+ "properties": {
236
+ "mqttOut": {
237
+ "type": "object",
238
+ "patternProperties": {
239
+ ".*": {
240
+ "type": "number"
241
+ }
242
+ }
243
+ },
244
+ "mqttIn": {
245
+ "type": "object",
246
+ "patternProperties": {
247
+ ".*": {
248
+ "type": "number"
249
+ }
250
+ }
251
+ },
252
+ "dataTable": {
253
+ "type": "object",
254
+ "patternProperties": {
255
+ ".*": {
256
+ "type": "number"
257
+ }
258
+ }
259
+ },
260
+ "deviceState": {
261
+ "type": "object",
262
+ "patternProperties": {
263
+ ".*": {
264
+ "type": "number"
265
+ }
266
+ }
267
+ },
268
+ "deviceCommand": {
269
+ "type": "object",
270
+ "patternProperties": {
271
+ ".*": {
272
+ "type": "number"
273
+ }
274
+ }
275
+ },
276
+ "webhook": {
277
+ "type": "object",
278
+ "patternProperties": {
279
+ ".*": {
280
+ "type": "number"
281
+ }
282
+ }
283
+ },
284
+ "timer": {
285
+ "type": "object",
286
+ "patternProperties": {
287
+ ".*": {
288
+ "type": "number"
289
+ }
290
+ }
291
+ },
292
+ "event": {
293
+ "type": "object",
294
+ "patternProperties": {
295
+ ".*": {
296
+ "type": "number"
297
+ }
298
+ }
299
+ },
300
+ "virtualButton": {
301
+ "type": "object",
302
+ "patternProperties": {
303
+ ".*": {
304
+ "type": "number"
305
+ }
306
+ }
307
+ },
308
+ "deviceConnect": {
309
+ "type": "object",
310
+ "patternProperties": {
311
+ ".*": {
312
+ "type": "number"
313
+ }
314
+ }
315
+ },
316
+ "deviceDisconnect": {
317
+ "type": "object",
318
+ "patternProperties": {
319
+ ".*": {
320
+ "type": "number"
321
+ }
322
+ }
323
+ },
324
+ "endpoint": {
325
+ "type": "object",
326
+ "patternProperties": {
327
+ ".*": {
328
+ "type": "number"
329
+ }
330
+ }
331
+ },
332
+ "integration": {
333
+ "type": "object",
334
+ "patternProperties": {
335
+ ".*": {
336
+ "type": "number"
337
+ }
338
+ }
339
+ }
340
+ }
341
+ },
342
+ "payloadSizeDetails": {
343
+ "title": "Payload Counts",
344
+ "description": "Schema for the result of a payload count request",
345
+ "type": "object",
346
+ "properties": {
347
+ "mqttOut": {
348
+ "type": "object",
349
+ "patternProperties": {
350
+ ".*": {
351
+ "type": "number"
352
+ }
353
+ }
354
+ },
355
+ "mqttIn": {
356
+ "type": "object",
357
+ "patternProperties": {
358
+ ".*": {
359
+ "type": "number"
360
+ }
361
+ }
362
+ },
363
+ "dataTable": {
364
+ "type": "object",
365
+ "patternProperties": {
366
+ ".*": {
367
+ "type": "number"
368
+ }
369
+ }
370
+ },
371
+ "deviceState": {
372
+ "type": "object",
373
+ "patternProperties": {
374
+ ".*": {
375
+ "type": "number"
376
+ }
377
+ }
378
+ },
379
+ "deviceCommand": {
380
+ "type": "object",
381
+ "patternProperties": {
382
+ ".*": {
383
+ "type": "number"
384
+ }
385
+ }
386
+ },
387
+ "webhook": {
388
+ "type": "object",
389
+ "patternProperties": {
390
+ ".*": {
391
+ "type": "number"
392
+ }
393
+ }
394
+ },
395
+ "timer": {
396
+ "type": "object",
397
+ "patternProperties": {
398
+ ".*": {
399
+ "type": "number"
400
+ }
401
+ }
402
+ },
403
+ "event": {
404
+ "type": "object",
405
+ "patternProperties": {
406
+ ".*": {
407
+ "type": "number"
408
+ }
409
+ }
410
+ },
411
+ "virtualButton": {
412
+ "type": "object",
413
+ "patternProperties": {
414
+ ".*": {
415
+ "type": "number"
416
+ }
417
+ }
418
+ },
419
+ "deviceConnect": {
420
+ "type": "object",
421
+ "patternProperties": {
422
+ ".*": {
423
+ "type": "number"
424
+ }
425
+ }
426
+ },
427
+ "deviceDisconnect": {
428
+ "type": "object",
429
+ "patternProperties": {
430
+ ".*": {
431
+ "type": "number"
432
+ }
433
+ }
434
+ },
435
+ "endpoint": {
436
+ "type": "object",
437
+ "patternProperties": {
438
+ ".*": {
439
+ "type": "number"
440
+ }
441
+ }
442
+ },
443
+ "integration": {
444
+ "type": "object",
445
+ "patternProperties": {
446
+ ".*": {
447
+ "type": "number"
448
+ }
449
+ }
450
+ }
451
+ }
452
+ }
453
+ },
454
+ "additionalProperties": false
455
+ }