losant_rest 1.16.6 → 1.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +2916 -598
  3. data/docs/applicationApiTokens.md +1 -1
  4. data/docs/events.md +1 -1
  5. data/docs/notebook.md +1 -1
  6. data/docs/resourceJob.md +263 -0
  7. data/docs/resourceJobs.md +93 -0
  8. data/lib/losant_rest/application_api_tokens.rb +1 -1
  9. data/lib/losant_rest/client.rb +10 -2
  10. data/lib/losant_rest/events.rb +1 -1
  11. data/lib/losant_rest/notebook.rb +1 -1
  12. data/lib/losant_rest/resource_job.rb +326 -0
  13. data/lib/losant_rest/resource_jobs.rb +138 -0
  14. data/lib/losant_rest/version.rb +1 -1
  15. data/lib/losant_rest.rb +2 -0
  16. data/schemas/apiTokenPost.json +10 -0
  17. data/schemas/applicationCreationByTemplateResult.json +1 -9
  18. data/schemas/applicationExportPost.json +4 -0
  19. data/schemas/applicationTemplate.json +3 -0
  20. data/schemas/applicationTemplates.json +3 -0
  21. data/schemas/auditLog.json +2 -1
  22. data/schemas/auditLogFilter.json +2 -1
  23. data/schemas/auditLogs.json +2 -1
  24. data/schemas/dataTableRowInsertResult.json +2 -1
  25. data/schemas/eventPlusNewCount.json +161 -0
  26. data/schemas/experienceLinkedResources.json +33 -6
  27. data/schemas/flow.json +8 -2
  28. data/schemas/flowPatch.json +8 -2
  29. data/schemas/flowPost.json +8 -2
  30. data/schemas/flowVersion.json +25 -4
  31. data/schemas/flowVersionPost.json +8 -2
  32. data/schemas/flowVersions.json +25 -4
  33. data/schemas/flows.json +8 -2
  34. data/schemas/flowsImportPost.json +16 -4
  35. data/schemas/flowsImportResult.json +33 -6
  36. data/schemas/githubLogin.json +10 -0
  37. data/schemas/historicalSummaries.json +524 -1
  38. data/schemas/historicalSummary.json +22 -0
  39. data/schemas/importIntoApplicationOptions.json +6 -1
  40. data/schemas/importNewApplicationOptions.json +6 -1
  41. data/schemas/instance.json +12 -0
  42. data/schemas/instanceCustomNodePatch.json +8 -2
  43. data/schemas/instanceCustomNodePost.json +8 -2
  44. data/schemas/instanceOrg.json +3 -0
  45. data/schemas/instanceOrgPatch.json +4 -0
  46. data/schemas/instanceOrgPost.json +4 -0
  47. data/schemas/instanceOrgs.json +3 -0
  48. data/schemas/instanceSandbox.json +11 -0
  49. data/schemas/instanceSandboxes.json +433 -1
  50. data/schemas/instances.json +217 -1
  51. data/schemas/me.json +11 -0
  52. data/schemas/notebookExecutionLogs.json +3 -1
  53. data/schemas/org.json +11 -0
  54. data/schemas/orgs.json +11 -0
  55. data/schemas/payloadStats.json +8 -0
  56. data/schemas/resourceJob.json +86 -0
  57. data/schemas/resourceJobExecutionLogs.json +127 -0
  58. data/schemas/resourceJobExecutionOptions.json +11 -0
  59. data/schemas/resourceJobPatch.json +55 -0
  60. data/schemas/resourceJobPost.json +66 -0
  61. data/schemas/resourceJobs.json +131 -0
  62. data/schemas/samlResponse.json +10 -0
  63. data/schemas/userCredentials.json +10 -0
  64. data/schemas/userPost.json +10 -0
  65. data/schemas/validateContextError.json +4 -0
  66. data/schemas/validationErrors.json +1 -9
  67. metadata +13 -2
@@ -5,7 +5,530 @@
5
5
  "items": {
6
6
  "type": "array",
7
7
  "items": {
8
- "type": "#/definitions/historicalSummary"
8
+ "title": "Historical Summary",
9
+ "description": "Schema for a historical summary report",
10
+ "type": "object",
11
+ "properties": {
12
+ "resourceType": {
13
+ "type": "string",
14
+ "enum": [
15
+ "application",
16
+ "organization",
17
+ "whitelabel"
18
+ ]
19
+ },
20
+ "resourceId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "resourceName": {
25
+ "type": "string",
26
+ "minLength": 1,
27
+ "maxLength": 255
28
+ },
29
+ "resourceProration": {
30
+ "type": "number"
31
+ },
32
+ "ownerType": {
33
+ "type": "string",
34
+ "enum": [
35
+ "organization",
36
+ "user"
37
+ ]
38
+ },
39
+ "ownerId": {
40
+ "type": "string",
41
+ "pattern": "^[A-Fa-f\\d]{24}$"
42
+ },
43
+ "ownerName": {
44
+ "type": "string",
45
+ "minLength": 1,
46
+ "maxLength": 255
47
+ },
48
+ "limits": {
49
+ "type": "object",
50
+ "properties": {
51
+ "apitoken": {
52
+ "type": "integer"
53
+ },
54
+ "application": {
55
+ "type": "integer"
56
+ },
57
+ "applicationkey": {
58
+ "type": "integer"
59
+ },
60
+ "dashboard": {
61
+ "type": "integer"
62
+ },
63
+ "datatable": {
64
+ "type": "integer"
65
+ },
66
+ "device": {
67
+ "type": "integer"
68
+ },
69
+ "devicerecipe": {
70
+ "type": "integer"
71
+ },
72
+ "experiencedomain": {
73
+ "type": "integer"
74
+ },
75
+ "experienceendpoint": {
76
+ "type": "integer"
77
+ },
78
+ "experiencegroup": {
79
+ "type": "integer"
80
+ },
81
+ "experienceslug": {
82
+ "type": "integer"
83
+ },
84
+ "experienceuser": {
85
+ "type": "integer"
86
+ },
87
+ "experienceversion": {
88
+ "type": "integer"
89
+ },
90
+ "experienceview": {
91
+ "type": "integer"
92
+ },
93
+ "file": {
94
+ "type": "integer"
95
+ },
96
+ "flow": {
97
+ "type": "integer"
98
+ },
99
+ "integration": {
100
+ "type": "integer"
101
+ },
102
+ "notebook": {
103
+ "type": "integer"
104
+ },
105
+ "resourcejob": {
106
+ "type": "integer"
107
+ },
108
+ "webhook": {
109
+ "type": "integer"
110
+ },
111
+ "dataTTL": {
112
+ "type": "integer"
113
+ },
114
+ "member": {
115
+ "type": "integer"
116
+ },
117
+ "payload": {
118
+ "type": "integer"
119
+ },
120
+ "storage": {
121
+ "type": "integer"
122
+ },
123
+ "notebookMinutesPerRun": {
124
+ "type": "integer"
125
+ },
126
+ "notebookMinutesPerMonth": {
127
+ "type": "integer"
128
+ },
129
+ "notebookInParallel": {
130
+ "type": "integer"
131
+ },
132
+ "experienceFlowSlots": {
133
+ "type": "integer"
134
+ },
135
+ "applicationFlowSlots": {
136
+ "type": "integer"
137
+ }
138
+ },
139
+ "additionalProperties": false
140
+ },
141
+ "currentPeriodStart": {
142
+ "type": "string",
143
+ "format": "date-time"
144
+ },
145
+ "currentPeriodEnd": {
146
+ "type": "string",
147
+ "format": "date-time"
148
+ },
149
+ "applicationCount": {
150
+ "type": "number"
151
+ },
152
+ "applicationCountProrated": {
153
+ "type": "number"
154
+ },
155
+ "userCount": {
156
+ "type": "number"
157
+ },
158
+ "userCountProrated": {
159
+ "type": "number"
160
+ },
161
+ "apiTokenCount": {
162
+ "type": "number"
163
+ },
164
+ "applicationKeyCount": {
165
+ "type": "number"
166
+ },
167
+ "certificateAuthorityCount": {
168
+ "type": "number"
169
+ },
170
+ "certificateCount": {
171
+ "type": "number"
172
+ },
173
+ "dashboardCount": {
174
+ "type": "number"
175
+ },
176
+ "dashboardCountProrated": {
177
+ "type": "number"
178
+ },
179
+ "dataTableCount": {
180
+ "type": "number"
181
+ },
182
+ "dataTableRowCount": {
183
+ "type": "number"
184
+ },
185
+ "dataTableTotalSizeMb": {
186
+ "type": "number"
187
+ },
188
+ "deviceCount": {
189
+ "type": "number"
190
+ },
191
+ "deviceCountProrated": {
192
+ "type": "number"
193
+ },
194
+ "deviceRecipeCount": {
195
+ "type": "number"
196
+ },
197
+ "eventCount": {
198
+ "type": "number"
199
+ },
200
+ "experienceDomainCount": {
201
+ "type": "number"
202
+ },
203
+ "experienceEndpointCount": {
204
+ "type": "number"
205
+ },
206
+ "experienceGroupCount": {
207
+ "type": "number"
208
+ },
209
+ "experienceSlugCount": {
210
+ "type": "number"
211
+ },
212
+ "experienceUserCount": {
213
+ "type": "number"
214
+ },
215
+ "experienceVersionCount": {
216
+ "type": "number"
217
+ },
218
+ "experienceViewCount": {
219
+ "type": "number"
220
+ },
221
+ "fileCount": {
222
+ "type": "number"
223
+ },
224
+ "fileTotalSizeMb": {
225
+ "type": "number"
226
+ },
227
+ "integrationCount": {
228
+ "type": "number"
229
+ },
230
+ "notebookCount": {
231
+ "type": "number"
232
+ },
233
+ "resourceJobCount": {
234
+ "type": "integer"
235
+ },
236
+ "notebookRunCount": {
237
+ "type": "number"
238
+ },
239
+ "notebookMinutesCount": {
240
+ "type": "number"
241
+ },
242
+ "webhookCount": {
243
+ "type": "number"
244
+ },
245
+ "workflowCount": {
246
+ "type": "number"
247
+ },
248
+ "payloadBillableCount": {
249
+ "type": "number"
250
+ },
251
+ "payloadNonbillableCount": {
252
+ "type": "number"
253
+ },
254
+ "payloadBillableSizeMb": {
255
+ "type": "number"
256
+ },
257
+ "payloadNonbillableSizeMb": {
258
+ "type": "number"
259
+ },
260
+ "payloadCountDetails": {
261
+ "title": "Payload Stats",
262
+ "description": "Schema for the result of a payload stats request",
263
+ "type": "object",
264
+ "properties": {
265
+ "dataTable": {
266
+ "type": "object",
267
+ "patternProperties": {
268
+ ".*": {
269
+ "type": "number"
270
+ }
271
+ }
272
+ },
273
+ "deviceCommand": {
274
+ "type": "object",
275
+ "patternProperties": {
276
+ ".*": {
277
+ "type": "number"
278
+ }
279
+ }
280
+ },
281
+ "deviceConnect": {
282
+ "type": "object",
283
+ "patternProperties": {
284
+ ".*": {
285
+ "type": "number"
286
+ }
287
+ }
288
+ },
289
+ "deviceDisconnect": {
290
+ "type": "object",
291
+ "patternProperties": {
292
+ ".*": {
293
+ "type": "number"
294
+ }
295
+ }
296
+ },
297
+ "deviceState": {
298
+ "type": "object",
299
+ "patternProperties": {
300
+ ".*": {
301
+ "type": "number"
302
+ }
303
+ }
304
+ },
305
+ "endpoint": {
306
+ "type": "object",
307
+ "patternProperties": {
308
+ ".*": {
309
+ "type": "number"
310
+ }
311
+ }
312
+ },
313
+ "event": {
314
+ "type": "object",
315
+ "patternProperties": {
316
+ ".*": {
317
+ "type": "number"
318
+ }
319
+ }
320
+ },
321
+ "flowError": {
322
+ "type": "object",
323
+ "patternProperties": {
324
+ ".*": {
325
+ "type": "number"
326
+ }
327
+ }
328
+ },
329
+ "integration": {
330
+ "type": "object",
331
+ "patternProperties": {
332
+ ".*": {
333
+ "type": "number"
334
+ }
335
+ }
336
+ },
337
+ "mqttIn": {
338
+ "type": "object",
339
+ "patternProperties": {
340
+ ".*": {
341
+ "type": "number"
342
+ }
343
+ }
344
+ },
345
+ "mqttOut": {
346
+ "type": "object",
347
+ "patternProperties": {
348
+ ".*": {
349
+ "type": "number"
350
+ }
351
+ }
352
+ },
353
+ "notebook": {
354
+ "type": "object",
355
+ "patternProperties": {
356
+ ".*": {
357
+ "type": "number"
358
+ }
359
+ }
360
+ },
361
+ "timer": {
362
+ "type": "object",
363
+ "patternProperties": {
364
+ ".*": {
365
+ "type": "number"
366
+ }
367
+ }
368
+ },
369
+ "virtualButton": {
370
+ "type": "object",
371
+ "patternProperties": {
372
+ ".*": {
373
+ "type": "number"
374
+ }
375
+ }
376
+ },
377
+ "webhook": {
378
+ "type": "object",
379
+ "patternProperties": {
380
+ ".*": {
381
+ "type": "number"
382
+ }
383
+ }
384
+ },
385
+ "resourceJob": {
386
+ "type": "object",
387
+ "patternProperties": {
388
+ ".*": {
389
+ "type": "number"
390
+ }
391
+ }
392
+ }
393
+ }
394
+ },
395
+ "payloadSizeDetails": {
396
+ "title": "Payload Stats",
397
+ "description": "Schema for the result of a payload stats request",
398
+ "type": "object",
399
+ "properties": {
400
+ "dataTable": {
401
+ "type": "object",
402
+ "patternProperties": {
403
+ ".*": {
404
+ "type": "number"
405
+ }
406
+ }
407
+ },
408
+ "deviceCommand": {
409
+ "type": "object",
410
+ "patternProperties": {
411
+ ".*": {
412
+ "type": "number"
413
+ }
414
+ }
415
+ },
416
+ "deviceConnect": {
417
+ "type": "object",
418
+ "patternProperties": {
419
+ ".*": {
420
+ "type": "number"
421
+ }
422
+ }
423
+ },
424
+ "deviceDisconnect": {
425
+ "type": "object",
426
+ "patternProperties": {
427
+ ".*": {
428
+ "type": "number"
429
+ }
430
+ }
431
+ },
432
+ "deviceState": {
433
+ "type": "object",
434
+ "patternProperties": {
435
+ ".*": {
436
+ "type": "number"
437
+ }
438
+ }
439
+ },
440
+ "endpoint": {
441
+ "type": "object",
442
+ "patternProperties": {
443
+ ".*": {
444
+ "type": "number"
445
+ }
446
+ }
447
+ },
448
+ "event": {
449
+ "type": "object",
450
+ "patternProperties": {
451
+ ".*": {
452
+ "type": "number"
453
+ }
454
+ }
455
+ },
456
+ "flowError": {
457
+ "type": "object",
458
+ "patternProperties": {
459
+ ".*": {
460
+ "type": "number"
461
+ }
462
+ }
463
+ },
464
+ "integration": {
465
+ "type": "object",
466
+ "patternProperties": {
467
+ ".*": {
468
+ "type": "number"
469
+ }
470
+ }
471
+ },
472
+ "mqttIn": {
473
+ "type": "object",
474
+ "patternProperties": {
475
+ ".*": {
476
+ "type": "number"
477
+ }
478
+ }
479
+ },
480
+ "mqttOut": {
481
+ "type": "object",
482
+ "patternProperties": {
483
+ ".*": {
484
+ "type": "number"
485
+ }
486
+ }
487
+ },
488
+ "notebook": {
489
+ "type": "object",
490
+ "patternProperties": {
491
+ ".*": {
492
+ "type": "number"
493
+ }
494
+ }
495
+ },
496
+ "timer": {
497
+ "type": "object",
498
+ "patternProperties": {
499
+ ".*": {
500
+ "type": "number"
501
+ }
502
+ }
503
+ },
504
+ "virtualButton": {
505
+ "type": "object",
506
+ "patternProperties": {
507
+ ".*": {
508
+ "type": "number"
509
+ }
510
+ }
511
+ },
512
+ "webhook": {
513
+ "type": "object",
514
+ "patternProperties": {
515
+ ".*": {
516
+ "type": "number"
517
+ }
518
+ }
519
+ },
520
+ "resourceJob": {
521
+ "type": "object",
522
+ "patternProperties": {
523
+ ".*": {
524
+ "type": "number"
525
+ }
526
+ }
527
+ }
528
+ }
529
+ }
530
+ },
531
+ "additionalProperties": false
9
532
  }
10
533
  },
11
534
  "count": {
@@ -95,6 +95,9 @@
95
95
  "notebook": {
96
96
  "type": "integer"
97
97
  },
98
+ "resourcejob": {
99
+ "type": "integer"
100
+ },
98
101
  "webhook": {
99
102
  "type": "integer"
100
103
  },
@@ -220,6 +223,9 @@
220
223
  "notebookCount": {
221
224
  "type": "number"
222
225
  },
226
+ "resourceJobCount": {
227
+ "type": "integer"
228
+ },
223
229
  "notebookRunCount": {
224
230
  "type": "number"
225
231
  },
@@ -368,6 +374,14 @@
368
374
  "type": "number"
369
375
  }
370
376
  }
377
+ },
378
+ "resourceJob": {
379
+ "type": "object",
380
+ "patternProperties": {
381
+ ".*": {
382
+ "type": "number"
383
+ }
384
+ }
371
385
  }
372
386
  }
373
387
  },
@@ -495,6 +509,14 @@
495
509
  "type": "number"
496
510
  }
497
511
  }
512
+ },
513
+ "resourceJob": {
514
+ "type": "object",
515
+ "patternProperties": {
516
+ ".*": {
517
+ "type": "number"
518
+ }
519
+ }
498
520
  }
499
521
  }
500
522
  }
@@ -26,6 +26,10 @@
26
26
  "type": "boolean",
27
27
  "default": false
28
28
  },
29
+ "forceJob": {
30
+ "type": "boolean",
31
+ "default": false
32
+ },
29
33
  "include": {
30
34
  "type": "array",
31
35
  "items": {
@@ -49,7 +53,8 @@
49
53
  "Global",
50
54
  "Integration",
51
55
  "Notebook",
52
- "Webhook"
56
+ "Webhook",
57
+ "ResourceJob"
53
58
  ]
54
59
  },
55
60
  "uniqueItems": true
@@ -35,10 +35,15 @@
35
35
  "Global",
36
36
  "Integration",
37
37
  "Notebook",
38
- "Webhook"
38
+ "Webhook",
39
+ "ResourceJob"
39
40
  ]
40
41
  },
41
42
  "uniqueItems": true
43
+ },
44
+ "forceJob": {
45
+ "type": "boolean",
46
+ "default": false
42
47
  }
43
48
  },
44
49
  "additionalProperties": false
@@ -99,6 +99,12 @@
99
99
  "application": {
100
100
  "type": "integer"
101
101
  },
102
+ "applicationcertificate": {
103
+ "type": "integer"
104
+ },
105
+ "applicationcertificateauthority": {
106
+ "type": "integer"
107
+ },
102
108
  "applicationkey": {
103
109
  "type": "integer"
104
110
  },
@@ -147,6 +153,9 @@
147
153
  "notebook": {
148
154
  "type": "integer"
149
155
  },
156
+ "resourcejob": {
157
+ "type": "integer"
158
+ },
150
159
  "webhook": {
151
160
  "type": "integer"
152
161
  },
@@ -176,6 +185,9 @@
176
185
  },
177
186
  "applicationFlowSlots": {
178
187
  "type": "integer"
188
+ },
189
+ "systemInterval": {
190
+ "type": "integer"
179
191
  }
180
192
  },
181
193
  "additionalProperties": false
@@ -71,7 +71,10 @@
71
71
  "onConnect",
72
72
  "onDisconnect",
73
73
  "udp",
74
- "webhook"
74
+ "webhook",
75
+ "resourceJobIteration",
76
+ "resourceJobIterationTimeout",
77
+ "resourceJobComplete"
75
78
  ]
76
79
  },
77
80
  "config": {
@@ -107,7 +110,10 @@
107
110
  "particle",
108
111
  "sqs",
109
112
  "udp",
110
- "webhook"
113
+ "webhook",
114
+ "resourceJobIteration",
115
+ "resourceJobIterationTimeout",
116
+ "resourceJobComplete"
111
117
  ]
112
118
  },
113
119
  "label": {
@@ -71,7 +71,10 @@
71
71
  "onConnect",
72
72
  "onDisconnect",
73
73
  "udp",
74
- "webhook"
74
+ "webhook",
75
+ "resourceJobIteration",
76
+ "resourceJobIterationTimeout",
77
+ "resourceJobComplete"
75
78
  ]
76
79
  },
77
80
  "config": {
@@ -107,7 +110,10 @@
107
110
  "particle",
108
111
  "sqs",
109
112
  "udp",
110
- "webhook"
113
+ "webhook",
114
+ "resourceJobIteration",
115
+ "resourceJobIterationTimeout",
116
+ "resourceJobComplete"
111
117
  ]
112
118
  },
113
119
  "label": {