losant_rest 1.16.1 → 1.16.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +5525 -738
  3. data/docs/applications.md +1 -1
  4. data/docs/dashboard.md +2 -0
  5. data/docs/device.md +4 -0
  6. data/docs/devices.md +4 -0
  7. data/docs/instanceSandbox.md +135 -0
  8. data/docs/instanceSandboxes.md +55 -0
  9. data/docs/me.md +36 -0
  10. data/lib/losant_rest/client.rb +10 -2
  11. data/lib/losant_rest/dashboard.rb +4 -0
  12. data/lib/losant_rest/device.rb +8 -0
  13. data/lib/losant_rest/devices.rb +8 -0
  14. data/lib/losant_rest/instance_sandbox.rb +181 -0
  15. data/lib/losant_rest/instance_sandboxes.rb +98 -0
  16. data/lib/losant_rest/me.rb +41 -0
  17. data/lib/losant_rest/version.rb +1 -1
  18. data/lib/losant_rest.rb +2 -0
  19. data/schemas/advancedApplicationKeyQuery.json +88 -0
  20. data/schemas/advancedDeviceQuery.json +264 -0
  21. data/schemas/advancedEventQuery.json +88 -0
  22. data/schemas/advancedFlowByVersionQuery.json +88 -0
  23. data/schemas/advancedFlowQuery.json +88 -0
  24. data/schemas/advancedFlowVersionQuery.json +44 -0
  25. data/schemas/apiTokenPost.json +8 -1
  26. data/schemas/applicationDashboardPost.json +155 -24
  27. data/schemas/applicationExportPost.json +1 -0
  28. data/schemas/applicationSearchResult.json +2 -1
  29. data/schemas/applicationTemplateCategories.json +11 -0
  30. data/schemas/applicationTemplateCategory.json +11 -0
  31. data/schemas/dashboard.json +155 -24
  32. data/schemas/dashboardPatch.json +155 -24
  33. data/schemas/dashboardPost.json +155 -24
  34. data/schemas/dashboardSendReport.json +3 -0
  35. data/schemas/dashboards.json +155 -24
  36. data/schemas/dataExport.json +1 -0
  37. data/schemas/dataTableRowsExport.json +5 -0
  38. data/schemas/deviceRecipeBulkCreatePost.json +5 -0
  39. data/schemas/devicesDeletePost.json +269 -0
  40. data/schemas/devicesExportPayloadCountPost.json +265 -0
  41. data/schemas/devicesExportPost.json +265 -0
  42. data/schemas/devicesPatch.json +269 -0
  43. data/schemas/devicesRemoveDataPost.json +264 -0
  44. data/schemas/embeddedDeploymentExport.json +5 -0
  45. data/schemas/enableTwoFactorAuth.json +5 -1
  46. data/schemas/eventsExport.json +89 -0
  47. data/schemas/experienceLinkedResources.json +3 -0
  48. data/schemas/experienceUser.json +11 -0
  49. data/schemas/experienceUsers.json +11 -0
  50. data/schemas/experienceVersion.json +27 -0
  51. data/schemas/experienceVersionPatch.json +27 -0
  52. data/schemas/experienceVersionPost.json +39 -0
  53. data/schemas/experienceVersions.json +27 -0
  54. data/schemas/flow.json +1 -0
  55. data/schemas/flowPatch.json +1 -0
  56. data/schemas/flowPost.json +1 -0
  57. data/schemas/flowVersion.json +2 -0
  58. data/schemas/flowVersionPost.json +1 -0
  59. data/schemas/flowVersions.json +2 -0
  60. data/schemas/flowVersionsDeletePost.json +49 -0
  61. data/schemas/flows.json +1 -0
  62. data/schemas/flowsImportPost.json +2 -0
  63. data/schemas/flowsImportResult.json +3 -0
  64. data/schemas/githubLogin.json +8 -1
  65. data/schemas/importIntoApplicationOptions.json +58 -0
  66. data/schemas/importNewApplicationOptions.json +45 -0
  67. data/schemas/instance.json +1 -0
  68. data/schemas/instanceCustomNodePatch.json +1 -0
  69. data/schemas/instanceCustomNodePost.json +1 -0
  70. data/schemas/instanceOrg.json +30 -0
  71. data/schemas/instanceOrgPatch.json +29 -0
  72. data/schemas/instanceOrgPost.json +29 -0
  73. data/schemas/instanceOrgs.json +30 -0
  74. data/schemas/instancePatch.json +1 -0
  75. data/schemas/instanceReportOptionsPost.json +1 -0
  76. data/schemas/instanceSandbox.json +423 -0
  77. data/schemas/instanceSandboxes.json +48 -0
  78. data/schemas/integration.json +34 -1
  79. data/schemas/integrationPatch.json +34 -1
  80. data/schemas/integrationPost.json +34 -1
  81. data/schemas/integrations.json +34 -1
  82. data/schemas/multiDeviceCommand.json +264 -0
  83. data/schemas/notebookDataExportOptions.json +5 -0
  84. data/schemas/org.json +17 -0
  85. data/schemas/orgs.json +17 -0
  86. data/schemas/samlResponse.json +432 -0
  87. data/schemas/twoFactorAuthInfo.json +15 -0
  88. data/schemas/userCredentials.json +8 -1
  89. data/schemas/userPost.json +8 -1
  90. data/schemas/validateContextError.json +3 -0
  91. data/schemas/validateContextSuccess.json +27 -0
  92. metadata +12 -3
data/schemas/instanceSandbox.json ADDED
@@ -0,0 +1,423 @@
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
+ "instanceSandboxId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "instanceId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "creationDate": {
18
+ "type": "string",
19
+ "format": "date-time"
20
+ },
21
+ "permanentDeletion": {
22
+ "type": "string",
23
+ "format": "date-time"
24
+ },
25
+ "dataDeletion": {
26
+ "type": "string",
27
+ "format": "date-time"
28
+ },
29
+ "lastUpdated": {
30
+ "type": "string",
31
+ "format": "date-time"
32
+ },
33
+ "lastSuccessfulLogin": {
34
+ "type": "string",
35
+ "format": "date-time"
36
+ },
37
+ "lastFailedLogin": {
38
+ "type": "string",
39
+ "format": "date-time"
40
+ },
41
+ "failedLoginCount": {
42
+ "type": "number"
43
+ },
44
+ "passwordLastUpdated": {
45
+ "type": "string",
46
+ "format": "date-time"
47
+ },
48
+ "email": {
49
+ "type": "string",
50
+ "format": "email",
51
+ "maxLength": 1024
52
+ },
53
+ "firstName": {
54
+ "type": "string",
55
+ "minLength": 1,
56
+ "maxLength": 1024
57
+ },
58
+ "lastName": {
59
+ "type": "string",
60
+ "maxLength": 1024
61
+ },
62
+ "companyName": {
63
+ "type": "string",
64
+ "maxLength": 1024
65
+ },
66
+ "title": {
67
+ "type": "string",
68
+ "maxLength": 1024
69
+ },
70
+ "phoneNumber": {
71
+ "type": "string",
72
+ "maxLength": 1024
73
+ },
74
+ "location": {
75
+ "type": "string",
76
+ "maxLength": 1024
77
+ },
78
+ "url": {
79
+ "type": "string",
80
+ "maxLength": 1024
81
+ },
82
+ "tokenCutoff": {
83
+ "type": "string",
84
+ "format": "date-time"
85
+ },
86
+ "emailVerified": {
87
+ "type": "boolean"
88
+ },
89
+ "needsToVerifyEmail": {
90
+ "type": "boolean"
91
+ },
92
+ "twoFactorAuthEnabled": {
93
+ "type": "boolean"
94
+ },
95
+ "fullName": {
96
+ "type": "string"
97
+ },
98
+ "githubName": {
99
+ "type": "string"
100
+ },
101
+ "avatarUrl": {
102
+ "type": "string",
103
+ "format": "uri",
104
+ "maxLength": 1024
105
+ },
106
+ "limits": {
107
+ "type": "object",
108
+ "properties": {
109
+ "apitoken": {
110
+ "type": "integer"
111
+ },
112
+ "application": {
113
+ "type": "integer"
114
+ },
115
+ "applicationkey": {
116
+ "type": "integer"
117
+ },
118
+ "dashboard": {
119
+ "type": "integer"
120
+ },
121
+ "datatable": {
122
+ "type": "integer"
123
+ },
124
+ "device": {
125
+ "type": "integer"
126
+ },
127
+ "devicerecipe": {
128
+ "type": "integer"
129
+ },
130
+ "experiencedomain": {
131
+ "type": "integer"
132
+ },
133
+ "experienceendpoint": {
134
+ "type": "integer"
135
+ },
136
+ "experiencegroup": {
137
+ "type": "integer"
138
+ },
139
+ "experienceslug": {
140
+ "type": "integer"
141
+ },
142
+ "experienceuser": {
143
+ "type": "integer"
144
+ },
145
+ "experienceversion": {
146
+ "type": "integer"
147
+ },
148
+ "experienceview": {
149
+ "type": "integer"
150
+ },
151
+ "file": {
152
+ "type": "integer"
153
+ },
154
+ "flow": {
155
+ "type": "integer"
156
+ },
157
+ "integration": {
158
+ "type": "integer"
159
+ },
160
+ "notebook": {
161
+ "type": "integer"
162
+ },
163
+ "webhook": {
164
+ "type": "integer"
165
+ },
166
+ "dataTTL": {
167
+ "type": "integer"
168
+ },
169
+ "payload": {
170
+ "type": "integer"
171
+ },
172
+ "storage": {
173
+ "type": "integer"
174
+ },
175
+ "notebookMinutesPerRun": {
176
+ "type": "integer"
177
+ },
178
+ "notebookMinutesPerMonth": {
179
+ "type": "integer"
180
+ },
181
+ "notebookInParallel": {
182
+ "type": "integer"
183
+ },
184
+ "experienceFlowSlots": {
185
+ "type": "integer"
186
+ },
187
+ "applicationFlowSlots": {
188
+ "type": "integer"
189
+ }
190
+ },
191
+ "additionalProperties": false
192
+ },
193
+ "summary": {
194
+ "type": "object",
195
+ "properties": {
196
+ "apiTokenCount": {
197
+ "type": "integer"
198
+ },
199
+ "appCount": {
200
+ "type": "integer"
201
+ },
202
+ "dashCount": {
203
+ "type": "integer"
204
+ },
205
+ "dataTableCount": {
206
+ "type": "integer"
207
+ },
208
+ "deviceCount": {
209
+ "type": "integer"
210
+ },
211
+ "deviceRecipeCount": {
212
+ "type": "integer"
213
+ },
214
+ "experienceEndpointCount": {
215
+ "type": "integer"
216
+ },
217
+ "experienceGroupCount": {
218
+ "type": "integer"
219
+ },
220
+ "experienceSlugCount": {
221
+ "type": "integer"
222
+ },
223
+ "experienceUserCount": {
224
+ "type": "integer"
225
+ },
226
+ "experienceVersionCount": {
227
+ "type": "integer"
228
+ },
229
+ "experienceViewCount": {
230
+ "type": "integer"
231
+ },
232
+ "fileCount": {
233
+ "type": "integer"
234
+ },
235
+ "flowCount": {
236
+ "type": "integer"
237
+ },
238
+ "integrationCount": {
239
+ "type": "integer"
240
+ },
241
+ "keyCount": {
242
+ "type": "integer"
243
+ },
244
+ "orgCount": {
245
+ "type": "integer"
246
+ },
247
+ "payloadCount": {
248
+ "title": "Payload Stats",
249
+ "description": "Schema for the result of a payload stats request",
250
+ "type": "object",
251
+ "properties": {
252
+ "dataTable": {
253
+ "type": "object",
254
+ "patternProperties": {
255
+ ".*": {
256
+ "type": "number"
257
+ }
258
+ }
259
+ },
260
+ "deviceCommand": {
261
+ "type": "object",
262
+ "patternProperties": {
263
+ ".*": {
264
+ "type": "number"
265
+ }
266
+ }
267
+ },
268
+ "deviceConnect": {
269
+ "type": "object",
270
+ "patternProperties": {
271
+ ".*": {
272
+ "type": "number"
273
+ }
274
+ }
275
+ },
276
+ "deviceDisconnect": {
277
+ "type": "object",
278
+ "patternProperties": {
279
+ ".*": {
280
+ "type": "number"
281
+ }
282
+ }
283
+ },
284
+ "deviceState": {
285
+ "type": "object",
286
+ "patternProperties": {
287
+ ".*": {
288
+ "type": "number"
289
+ }
290
+ }
291
+ },
292
+ "endpoint": {
293
+ "type": "object",
294
+ "patternProperties": {
295
+ ".*": {
296
+ "type": "number"
297
+ }
298
+ }
299
+ },
300
+ "event": {
301
+ "type": "object",
302
+ "patternProperties": {
303
+ ".*": {
304
+ "type": "number"
305
+ }
306
+ }
307
+ },
308
+ "flowError": {
309
+ "type": "object",
310
+ "patternProperties": {
311
+ ".*": {
312
+ "type": "number"
313
+ }
314
+ }
315
+ },
316
+ "integration": {
317
+ "type": "object",
318
+ "patternProperties": {
319
+ ".*": {
320
+ "type": "number"
321
+ }
322
+ }
323
+ },
324
+ "mqttIn": {
325
+ "type": "object",
326
+ "patternProperties": {
327
+ ".*": {
328
+ "type": "number"
329
+ }
330
+ }
331
+ },
332
+ "mqttOut": {
333
+ "type": "object",
334
+ "patternProperties": {
335
+ ".*": {
336
+ "type": "number"
337
+ }
338
+ }
339
+ },
340
+ "notebook": {
341
+ "type": "object",
342
+ "patternProperties": {
343
+ ".*": {
344
+ "type": "number"
345
+ }
346
+ }
347
+ },
348
+ "timer": {
349
+ "type": "object",
350
+ "patternProperties": {
351
+ ".*": {
352
+ "type": "number"
353
+ }
354
+ }
355
+ },
356
+ "virtualButton": {
357
+ "type": "object",
358
+ "patternProperties": {
359
+ ".*": {
360
+ "type": "number"
361
+ }
362
+ }
363
+ },
364
+ "webhook": {
365
+ "type": "object",
366
+ "patternProperties": {
367
+ ".*": {
368
+ "type": "number"
369
+ }
370
+ }
371
+ }
372
+ }
373
+ },
374
+ "storageStats": {
375
+ "type": "object",
376
+ "properties": {
377
+ "count": {
378
+ "type": "integer"
379
+ },
380
+ "size": {
381
+ "type": "integer"
382
+ }
383
+ }
384
+ },
385
+ "webhookCount": {
386
+ "type": "integer"
387
+ }
388
+ }
389
+ },
390
+ "currentPeriodStart": {
391
+ "type": "string",
392
+ "format": "date-time"
393
+ },
394
+ "currentPeriodEnd": {
395
+ "type": "string",
396
+ "format": "date-time"
397
+ },
398
+ "ssoLinked": {
399
+ "type": "boolean"
400
+ },
401
+ "orgs": {
402
+ "type": "array",
403
+ "items": {
404
+ "type": "object",
405
+ "properties": {
406
+ "id": {
407
+ "type": "string",
408
+ "pattern": "^[A-Fa-f\\d]{24}$"
409
+ },
410
+ "iconColor": {
411
+ "type": "string",
412
+ "maxLength": 64
413
+ },
414
+ "name": {
415
+ "type": "string",
416
+ "minLength": 1,
417
+ "maxLength": 255
418
+ }
419
+ }
420
+ }
421
+ }
422
+ }
423
+ }
data/schemas/instanceSandboxes.json ADDED
@@ -0,0 +1,48 @@
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/instanceSandbox"
9
+ }
10
+ },
11
+ "count": {
12
+ "type": "integer"
13
+ },
14
+ "limit": {
15
+ "type": "integer"
16
+ },
17
+ "startingAfterId": {
18
+ "type": "string",
19
+ "pattern": "^[A-Fa-f\\d]{24}$"
20
+ },
21
+ "endingBeforeId": {
22
+ "type": "string",
23
+ "pattern": "^[A-Fa-f\\d]{24}$"
24
+ },
25
+ "filter": {
26
+ "type": "string"
27
+ },
28
+ "filterField": {
29
+ "type": "string"
30
+ },
31
+ "sortField": {
32
+ "type": "string"
33
+ },
34
+ "sortDirection": {
35
+ "type": "string",
36
+ "enum": [
37
+ "asc",
38
+ "desc",
39
+ "ASC",
40
+ "DESC",
41
+ ""
42
+ ]
43
+ },
44
+ "hasMore": {
45
+ "type": "boolean"
46
+ }
47
+ }
48
+ }
data/schemas/integration.json CHANGED
@@ -34,7 +34,8 @@
34
34
  "googlePubSub",
35
35
  "meridian",
36
36
  "mqtt",
37
- "particle"
37
+ "particle",
38
+ "sqs"
38
39
  ]
39
40
  },
40
41
  "enabled": {
@@ -190,6 +191,38 @@
190
191
  "accessToken"
191
192
  ]
192
193
  },
194
+ "sqsConfig": {
195
+ "type": "object",
196
+ "properties": {
197
+ "accessKeyId": {
198
+ "type": "string",
199
+ "minLength": 1,
200
+ "maxLength": 1024
201
+ },
202
+ "secretAccessKey": {
203
+ "type": "string",
204
+ "minLength": 1,
205
+ "maxLength": 1024
206
+ },
207
+ "region": {
208
+ "type": "string",
209
+ "minLength": 1,
210
+ "maxLength": 1024
211
+ },
212
+ "queueUrl": {
213
+ "type": "string",
214
+ "minLength": 1,
215
+ "maxLength": 1024
216
+ }
217
+ },
218
+ "additionalProperties": false,
219
+ "required": [
220
+ "accessKeyId",
221
+ "secretAccessKey",
222
+ "region",
223
+ "queueUrl"
224
+ ]
225
+ },
193
226
  "meridianConfig": {
194
227
  "type": "object",
195
228
  "properties": {
data/schemas/integrationPatch.json CHANGED
@@ -14,7 +14,8 @@
14
14
  "googlePubSub",
15
15
  "meridian",
16
16
  "mqtt",
17
- "particle"
17
+ "particle",
18
+ "sqs"
18
19
  ]
19
20
  },
20
21
  "enabled": {
@@ -170,6 +171,38 @@
170
171
  "accessToken"
171
172
  ]
172
173
  },
174
+ "sqsConfig": {
175
+ "type": "object",
176
+ "properties": {
177
+ "accessKeyId": {
178
+ "type": "string",
179
+ "minLength": 1,
180
+ "maxLength": 1024
181
+ },
182
+ "secretAccessKey": {
183
+ "type": "string",
184
+ "minLength": 1,
185
+ "maxLength": 1024
186
+ },
187
+ "region": {
188
+ "type": "string",
189
+ "minLength": 1,
190
+ "maxLength": 1024
191
+ },
192
+ "queueUrl": {
193
+ "type": "string",
194
+ "minLength": 1,
195
+ "maxLength": 1024
196
+ }
197
+ },
198
+ "additionalProperties": false,
199
+ "required": [
200
+ "accessKeyId",
201
+ "secretAccessKey",
202
+ "region",
203
+ "queueUrl"
204
+ ]
205
+ },
173
206
  "meridianConfig": {
174
207
  "type": "object",
175
208
  "properties": {
data/schemas/integrationPost.json CHANGED
@@ -14,7 +14,8 @@
14
14
  "googlePubSub",
15
15
  "meridian",
16
16
  "mqtt",
17
- "particle"
17
+ "particle",
18
+ "sqs"
18
19
  ]
19
20
  },
20
21
  "enabled": {
@@ -170,6 +171,38 @@
170
171
  "accessToken"
171
172
  ]
172
173
  },
174
+ "sqsConfig": {
175
+ "type": "object",
176
+ "properties": {
177
+ "accessKeyId": {
178
+ "type": "string",
179
+ "minLength": 1,
180
+ "maxLength": 1024
181
+ },
182
+ "secretAccessKey": {
183
+ "type": "string",
184
+ "minLength": 1,
185
+ "maxLength": 1024
186
+ },
187
+ "region": {
188
+ "type": "string",
189
+ "minLength": 1,
190
+ "maxLength": 1024
191
+ },
192
+ "queueUrl": {
193
+ "type": "string",
194
+ "minLength": 1,
195
+ "maxLength": 1024
196
+ }
197
+ },
198
+ "additionalProperties": false,
199
+ "required": [
200
+ "accessKeyId",
201
+ "secretAccessKey",
202
+ "region",
203
+ "queueUrl"
204
+ ]
205
+ },
173
206
  "meridianConfig": {
174
207
  "type": "object",
175
208
  "properties": {
data/schemas/integrations.json CHANGED
@@ -41,7 +41,8 @@
41
41
  "googlePubSub",
42
42
  "meridian",
43
43
  "mqtt",
44
- "particle"
44
+ "particle",
45
+ "sqs"
45
46
  ]
46
47
  },
47
48
  "enabled": {
@@ -197,6 +198,38 @@
197
198
  "accessToken"
198
199
  ]
199
200
  },
201
+ "sqsConfig": {
202
+ "type": "object",
203
+ "properties": {
204
+ "accessKeyId": {
205
+ "type": "string",
206
+ "minLength": 1,
207
+ "maxLength": 1024
208
+ },
209
+ "secretAccessKey": {
210
+ "type": "string",
211
+ "minLength": 1,
212
+ "maxLength": 1024
213
+ },
214
+ "region": {
215
+ "type": "string",
216
+ "minLength": 1,
217
+ "maxLength": 1024
218
+ },
219
+ "queueUrl": {
220
+ "type": "string",
221
+ "minLength": 1,
222
+ "maxLength": 1024
223
+ }
224
+ },
225
+ "additionalProperties": false,
226
+ "required": [
227
+ "accessKeyId",
228
+ "secretAccessKey",
229
+ "region",
230
+ "queueUrl"
231
+ ]
232
+ },
200
233
  "meridianConfig": {
201
234
  "type": "object",
202
235
  "properties": {