losant_rest 1.15.1 → 1.16.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (152) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/docs/_schemas.md +12170 -4718
  4. data/docs/application.md +3 -4
  5. data/docs/applicationDashboard.md +43 -0
  6. data/docs/applications.md +3 -2
  7. data/docs/devices.md +40 -0
  8. data/docs/flows.md +38 -0
  9. data/docs/instanceCustomNode.md +222 -0
  10. data/docs/instanceCustomNodes.md +91 -0
  11. data/lib/losant_rest/application.rb +1 -1
  12. data/lib/losant_rest/application_api_token.rb +1 -1
  13. data/lib/losant_rest/application_api_tokens.rb +1 -1
  14. data/lib/losant_rest/application_certificate.rb +1 -1
  15. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  16. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  17. data/lib/losant_rest/application_certificates.rb +1 -1
  18. data/lib/losant_rest/application_dashboard.rb +50 -1
  19. data/lib/losant_rest/application_dashboards.rb +1 -1
  20. data/lib/losant_rest/application_key.rb +1 -1
  21. data/lib/losant_rest/application_keys.rb +1 -1
  22. data/lib/losant_rest/application_template.rb +1 -1
  23. data/lib/losant_rest/application_templates.rb +1 -1
  24. data/lib/losant_rest/applications.rb +1 -1
  25. data/lib/losant_rest/audit_log.rb +1 -1
  26. data/lib/losant_rest/audit_logs.rb +1 -1
  27. data/lib/losant_rest/auth.rb +1 -1
  28. data/lib/losant_rest/client.rb +11 -3
  29. data/lib/losant_rest/dashboard.rb +1 -1
  30. data/lib/losant_rest/dashboards.rb +1 -1
  31. data/lib/losant_rest/data.rb +1 -1
  32. data/lib/losant_rest/data_table.rb +1 -1
  33. data/lib/losant_rest/data_table_row.rb +1 -1
  34. data/lib/losant_rest/data_table_rows.rb +1 -1
  35. data/lib/losant_rest/data_tables.rb +1 -1
  36. data/lib/losant_rest/device.rb +1 -1
  37. data/lib/losant_rest/device_recipe.rb +1 -1
  38. data/lib/losant_rest/device_recipes.rb +1 -1
  39. data/lib/losant_rest/devices.rb +50 -1
  40. data/lib/losant_rest/edge_deployment.rb +1 -1
  41. data/lib/losant_rest/edge_deployments.rb +1 -1
  42. data/lib/losant_rest/embedded_deployment.rb +1 -1
  43. data/lib/losant_rest/embedded_deployments.rb +1 -1
  44. data/lib/losant_rest/error.rb +1 -1
  45. data/lib/losant_rest/event.rb +1 -1
  46. data/lib/losant_rest/events.rb +1 -1
  47. data/lib/losant_rest/experience.rb +1 -1
  48. data/lib/losant_rest/experience_domain.rb +1 -1
  49. data/lib/losant_rest/experience_domains.rb +1 -1
  50. data/lib/losant_rest/experience_endpoint.rb +1 -1
  51. data/lib/losant_rest/experience_endpoints.rb +1 -1
  52. data/lib/losant_rest/experience_group.rb +1 -1
  53. data/lib/losant_rest/experience_groups.rb +1 -1
  54. data/lib/losant_rest/experience_slug.rb +1 -1
  55. data/lib/losant_rest/experience_slugs.rb +1 -1
  56. data/lib/losant_rest/experience_user.rb +1 -1
  57. data/lib/losant_rest/experience_users.rb +1 -1
  58. data/lib/losant_rest/experience_version.rb +1 -1
  59. data/lib/losant_rest/experience_versions.rb +1 -1
  60. data/lib/losant_rest/experience_view.rb +1 -1
  61. data/lib/losant_rest/experience_views.rb +1 -1
  62. data/lib/losant_rest/file.rb +1 -1
  63. data/lib/losant_rest/files.rb +1 -1
  64. data/lib/losant_rest/flow.rb +1 -1
  65. data/lib/losant_rest/flow_version.rb +1 -1
  66. data/lib/losant_rest/flow_versions.rb +1 -1
  67. data/lib/losant_rest/flows.rb +45 -1
  68. data/lib/losant_rest/instance.rb +1 -1
  69. data/lib/losant_rest/instance_api_token.rb +1 -1
  70. data/lib/losant_rest/instance_api_tokens.rb +1 -1
  71. data/lib/losant_rest/instance_custom_node.rb +282 -0
  72. data/lib/losant_rest/instance_custom_nodes.rb +136 -0
  73. data/lib/losant_rest/instance_member.rb +1 -1
  74. data/lib/losant_rest/instance_members.rb +1 -1
  75. data/lib/losant_rest/instance_org.rb +1 -1
  76. data/lib/losant_rest/instance_org_invite.rb +1 -1
  77. data/lib/losant_rest/instance_org_invites.rb +1 -1
  78. data/lib/losant_rest/instance_org_member.rb +1 -1
  79. data/lib/losant_rest/instance_org_members.rb +1 -1
  80. data/lib/losant_rest/instance_orgs.rb +1 -1
  81. data/lib/losant_rest/instances.rb +1 -1
  82. data/lib/losant_rest/integration.rb +1 -1
  83. data/lib/losant_rest/integrations.rb +1 -1
  84. data/lib/losant_rest/me.rb +1 -1
  85. data/lib/losant_rest/notebook.rb +1 -1
  86. data/lib/losant_rest/notebooks.rb +1 -1
  87. data/lib/losant_rest/org.rb +1 -1
  88. data/lib/losant_rest/org_invites.rb +1 -1
  89. data/lib/losant_rest/orgs.rb +1 -1
  90. data/lib/losant_rest/user_api_token.rb +1 -1
  91. data/lib/losant_rest/user_api_tokens.rb +1 -1
  92. data/lib/losant_rest/utils.rb +1 -1
  93. data/lib/losant_rest/version.rb +2 -2
  94. data/lib/losant_rest/webhook.rb +1 -1
  95. data/lib/losant_rest/webhooks.rb +1 -1
  96. data/lib/losant_rest.rb +3 -1
  97. data/schemas/apiTokenPost.json +13 -1
  98. data/schemas/application.json +1 -1
  99. data/schemas/applicationApplyTemplatePatch.json +5 -0
  100. data/schemas/applicationClonePost.json +5 -0
  101. data/schemas/applicationCreationByTemplateResult.json +1 -1
  102. data/schemas/applicationDashboardPost.json +162 -3
  103. data/schemas/applicationExportPost.json +4 -0
  104. data/schemas/applicationImportOptions.json +43 -0
  105. data/schemas/applicationPatch.json +1 -1
  106. data/schemas/applicationPost.json +1 -1
  107. data/schemas/applications.json +1 -1
  108. data/schemas/dashboard.json +162 -3
  109. data/schemas/dashboardPatch.json +162 -3
  110. data/schemas/dashboardPost.json +162 -3
  111. data/schemas/dashboardSendReport.json +20 -3
  112. data/schemas/dashboards.json +162 -3
  113. data/schemas/deviceNamesResponse.json +36 -0
  114. data/schemas/experienceBootstrapOptions.json +1 -1
  115. data/schemas/experienceLinkedResources.json +485 -5
  116. data/schemas/experienceSlug.json +1 -1
  117. data/schemas/experienceSlugPatch.json +1 -1
  118. data/schemas/experienceSlugPost.json +1 -1
  119. data/schemas/experienceSlugs.json +1 -1
  120. data/schemas/experienceUser.json +2 -1
  121. data/schemas/experienceUsers.json +2 -1
  122. data/schemas/flow.json +173 -0
  123. data/schemas/flowPatch.json +174 -0
  124. data/schemas/flowPost.json +174 -0
  125. data/schemas/flowVersion.json +312 -5
  126. data/schemas/flowVersionPost.json +156 -0
  127. data/schemas/flowVersions.json +312 -5
  128. data/schemas/flows.json +173 -0
  129. data/schemas/flowsImportPost.json +339 -2
  130. data/schemas/flowsImportResult.json +485 -5
  131. data/schemas/githubLogin.json +13 -1
  132. data/schemas/instanceCustomNode.json +589 -0
  133. data/schemas/instanceCustomNodePatch.json +674 -0
  134. data/schemas/instanceCustomNodePost.json +679 -0
  135. data/schemas/instanceCustomNodes.json +634 -0
  136. data/schemas/instanceMember.json +2 -2
  137. data/schemas/instanceMembers.json +2 -2
  138. data/schemas/instanceOrg.json +8 -0
  139. data/schemas/instanceOrgMember.json +2 -2
  140. data/schemas/instanceOrgs.json +8 -0
  141. data/schemas/integration.json +30 -2
  142. data/schemas/integrationPatch.json +30 -2
  143. data/schemas/integrationPost.json +30 -2
  144. data/schemas/integrations.json +30 -2
  145. data/schemas/me.json +2 -2
  146. data/schemas/mePatch.json +0 -1
  147. data/schemas/org.json +2 -2
  148. data/schemas/orgs.json +2 -2
  149. data/schemas/paletteResponse.json +785 -0
  150. data/schemas/userCredentials.json +13 -1
  151. data/schemas/userPost.json +13 -2
  152. metadata +13 -2
@@ -0,0 +1,589 @@
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
+ "instanceCustomNodeId": {
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
+ "createdById": {
22
+ "type": "string",
23
+ "pattern": "^[A-Fa-f\\d]{24}$"
24
+ },
25
+ "createdByType": {
26
+ "type": "string",
27
+ "enum": [
28
+ "apiToken",
29
+ "user"
30
+ ]
31
+ },
32
+ "lastUpdated": {
33
+ "type": "string",
34
+ "format": "date-time"
35
+ },
36
+ "lastUpdatedById": {
37
+ "type": "string",
38
+ "pattern": "^[A-Fa-f\\d]{24}$"
39
+ },
40
+ "lastUpdatedByType": {
41
+ "type": "string",
42
+ "enum": [
43
+ "apiToken",
44
+ "user"
45
+ ]
46
+ },
47
+ "name": {
48
+ "type": "string",
49
+ "minLength": 1,
50
+ "maxLength": 255
51
+ },
52
+ "description": {
53
+ "type": "string",
54
+ "maxLength": 32767
55
+ },
56
+ "shortDescription": {
57
+ "type": "string",
58
+ "maxLength": 1024
59
+ },
60
+ "iconData": {
61
+ "type": "string",
62
+ "maxLength": 32767,
63
+ "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
64
+ },
65
+ "docsUrl": {
66
+ "type": "string",
67
+ "maxLength": 1024
68
+ },
69
+ "category": {
70
+ "type": "string",
71
+ "enum": [
72
+ "data",
73
+ "experience",
74
+ "logic",
75
+ "output"
76
+ ]
77
+ },
78
+ "minimumAgentVersion": {
79
+ "type": "string",
80
+ "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
81
+ },
82
+ "triggers": {
83
+ "type": "array",
84
+ "items": {
85
+ "type": "object",
86
+ "properties": {
87
+ "key": {
88
+ "type": "string",
89
+ "maxLength": 1024
90
+ },
91
+ "type": {
92
+ "type": "string",
93
+ "enum": [
94
+ "customNodeStart"
95
+ ]
96
+ },
97
+ "config": {
98
+ "type": "object",
99
+ "additionalProperties": false
100
+ },
101
+ "meta": {
102
+ "type": "object",
103
+ "properties": {
104
+ "category": {
105
+ "type": "string",
106
+ "enum": [
107
+ "trigger"
108
+ ]
109
+ },
110
+ "name": {
111
+ "type": "string",
112
+ "enum": [
113
+ "customNodeStart"
114
+ ]
115
+ },
116
+ "label": {
117
+ "type": "string",
118
+ "minLength": 1,
119
+ "maxLength": 255
120
+ },
121
+ "x": {
122
+ "type": "number"
123
+ },
124
+ "y": {
125
+ "type": "number"
126
+ },
127
+ "uiId": {
128
+ "type": "string",
129
+ "maxLength": 48
130
+ },
131
+ "description": {
132
+ "type": "string",
133
+ "maxLength": 32767
134
+ }
135
+ },
136
+ "additionalProperties": false
137
+ },
138
+ "outputIds": {
139
+ "type": "array",
140
+ "items": {
141
+ "type": "array",
142
+ "items": {
143
+ "type": "string",
144
+ "maxLength": 48,
145
+ "minLength": 1
146
+ },
147
+ "maxItems": 100
148
+ },
149
+ "maxItems": 100
150
+ }
151
+ },
152
+ "required": [
153
+ "type"
154
+ ],
155
+ "additionalProperties": false
156
+ },
157
+ "maxItems": 1
158
+ },
159
+ "nodes": {
160
+ "type": "array",
161
+ "items": {
162
+ "type": "object",
163
+ "properties": {
164
+ "id": {
165
+ "type": "string",
166
+ "maxLength": 1024
167
+ },
168
+ "type": {
169
+ "type": "string",
170
+ "minLength": 1,
171
+ "maxLength": 1024
172
+ },
173
+ "config": {
174
+ "type": "object"
175
+ },
176
+ "meta": {
177
+ "type": "object"
178
+ },
179
+ "outputIds": {
180
+ "type": "array",
181
+ "items": {
182
+ "type": "array",
183
+ "items": {
184
+ "type": "string",
185
+ "maxLength": 48,
186
+ "minLength": 1
187
+ },
188
+ "maxItems": 100
189
+ },
190
+ "maxItems": 100
191
+ }
192
+ },
193
+ "additionalProperties": false,
194
+ "required": [
195
+ "type"
196
+ ]
197
+ }
198
+ },
199
+ "customNodeConfig": {
200
+ "type": "object",
201
+ "properties": {
202
+ "outputCount": {
203
+ "type": "number",
204
+ "enum": [
205
+ 1,
206
+ 2
207
+ ]
208
+ },
209
+ "resultMode": {
210
+ "type": "string",
211
+ "enum": [
212
+ "optional",
213
+ "required",
214
+ "none"
215
+ ]
216
+ },
217
+ "resultDescription": {
218
+ "type": "string",
219
+ "maxLength": 32767
220
+ },
221
+ "fields": {
222
+ "type": "array",
223
+ "maxItems": 100,
224
+ "items": {
225
+ "oneOf": [
226
+ {
227
+ "type": "object",
228
+ "properties": {
229
+ "type": {
230
+ "type": "string",
231
+ "enum": [
232
+ "checkbox"
233
+ ]
234
+ },
235
+ "label": {
236
+ "type": "string",
237
+ "minLength": 1,
238
+ "maxLength": 1024
239
+ },
240
+ "id": {
241
+ "type": "string",
242
+ "minLength": 1,
243
+ "maxLength": 1024
244
+ },
245
+ "description": {
246
+ "type": "string",
247
+ "maxLength": 32767
248
+ },
249
+ "defaultValue": {
250
+ "type": "boolean"
251
+ }
252
+ },
253
+ "additionalProperties": false,
254
+ "required": [
255
+ "type",
256
+ "label"
257
+ ]
258
+ },
259
+ {
260
+ "type": "object",
261
+ "properties": {
262
+ "type": {
263
+ "type": "string",
264
+ "enum": [
265
+ "select"
266
+ ]
267
+ },
268
+ "label": {
269
+ "type": "string",
270
+ "minLength": 1,
271
+ "maxLength": 1024
272
+ },
273
+ "id": {
274
+ "type": "string",
275
+ "minLength": 1,
276
+ "maxLength": 1024
277
+ },
278
+ "description": {
279
+ "type": "string",
280
+ "maxLength": 32767
281
+ },
282
+ "defaultValue": {
283
+ "type": "string",
284
+ "minLength": 1,
285
+ "maxLength": 1024
286
+ },
287
+ "options": {
288
+ "type": "array",
289
+ "minItems": 1,
290
+ "maxItems": 100,
291
+ "items": {
292
+ "type": "object",
293
+ "properties": {
294
+ "label": {
295
+ "type": "string",
296
+ "maxLength": 1024
297
+ },
298
+ "value": {
299
+ "type": "string",
300
+ "minLength": 1,
301
+ "maxLength": 1024
302
+ }
303
+ },
304
+ "additionalProperties": false,
305
+ "required": [
306
+ "value"
307
+ ]
308
+ }
309
+ }
310
+ },
311
+ "additionalProperties": false,
312
+ "required": [
313
+ "type",
314
+ "label",
315
+ "defaultValue",
316
+ "options"
317
+ ]
318
+ },
319
+ {
320
+ "type": "object",
321
+ "properties": {
322
+ "type": {
323
+ "type": "string",
324
+ "enum": [
325
+ "stringTemplate"
326
+ ]
327
+ },
328
+ "label": {
329
+ "type": "string",
330
+ "minLength": 1,
331
+ "maxLength": 1024
332
+ },
333
+ "id": {
334
+ "type": "string",
335
+ "minLength": 1,
336
+ "maxLength": 1024
337
+ },
338
+ "description": {
339
+ "type": "string",
340
+ "maxLength": 32767
341
+ },
342
+ "defaultValue": {
343
+ "type": "string",
344
+ "maxLength": 1024
345
+ },
346
+ "required": {
347
+ "type": "boolean"
348
+ },
349
+ "validRegExp": {
350
+ "type": "string",
351
+ "maxLength": 1024
352
+ }
353
+ },
354
+ "additionalProperties": false,
355
+ "required": [
356
+ "type",
357
+ "label"
358
+ ]
359
+ },
360
+ {
361
+ "type": "object",
362
+ "properties": {
363
+ "type": {
364
+ "type": "string",
365
+ "enum": [
366
+ "numberTemplate"
367
+ ]
368
+ },
369
+ "label": {
370
+ "type": "string",
371
+ "minLength": 1,
372
+ "maxLength": 1024
373
+ },
374
+ "id": {
375
+ "type": "string",
376
+ "minLength": 1,
377
+ "maxLength": 1024
378
+ },
379
+ "description": {
380
+ "type": "string",
381
+ "maxLength": 32767
382
+ },
383
+ "defaultValue": {
384
+ "type": "number"
385
+ },
386
+ "required": {
387
+ "type": "boolean"
388
+ },
389
+ "validMin": {
390
+ "type": "number"
391
+ },
392
+ "validMax": {
393
+ "type": "number"
394
+ }
395
+ },
396
+ "additionalProperties": false,
397
+ "required": [
398
+ "type",
399
+ "label"
400
+ ]
401
+ },
402
+ {
403
+ "type": "object",
404
+ "properties": {
405
+ "type": {
406
+ "type": "string",
407
+ "enum": [
408
+ "jsonTemplate"
409
+ ]
410
+ },
411
+ "label": {
412
+ "type": "string",
413
+ "minLength": 1,
414
+ "maxLength": 1024
415
+ },
416
+ "id": {
417
+ "type": "string",
418
+ "minLength": 1,
419
+ "maxLength": 1024
420
+ },
421
+ "description": {
422
+ "type": "string",
423
+ "maxLength": 32767
424
+ },
425
+ "defaultValue": {
426
+ "type": "string",
427
+ "maxLength": 32767
428
+ },
429
+ "required": {
430
+ "type": "boolean"
431
+ }
432
+ },
433
+ "additionalProperties": false,
434
+ "required": [
435
+ "type",
436
+ "label"
437
+ ]
438
+ },
439
+ {
440
+ "type": "object",
441
+ "properties": {
442
+ "type": {
443
+ "type": "string",
444
+ "enum": [
445
+ "payloadPath"
446
+ ]
447
+ },
448
+ "label": {
449
+ "type": "string",
450
+ "minLength": 1,
451
+ "maxLength": 1024
452
+ },
453
+ "id": {
454
+ "type": "string",
455
+ "minLength": 1,
456
+ "maxLength": 1024
457
+ },
458
+ "description": {
459
+ "type": "string",
460
+ "maxLength": 32767
461
+ },
462
+ "required": {
463
+ "type": "boolean"
464
+ }
465
+ },
466
+ "additionalProperties": false,
467
+ "required": [
468
+ "type",
469
+ "label"
470
+ ]
471
+ },
472
+ {
473
+ "type": "object",
474
+ "properties": {
475
+ "type": {
476
+ "type": "string",
477
+ "enum": [
478
+ "section"
479
+ ]
480
+ },
481
+ "label": {
482
+ "type": "string",
483
+ "minLength": 1,
484
+ "maxLength": 1024
485
+ },
486
+ "id": {
487
+ "type": "string",
488
+ "minLength": 1,
489
+ "maxLength": 1024
490
+ },
491
+ "description": {
492
+ "type": "string",
493
+ "maxLength": 32767
494
+ }
495
+ },
496
+ "additionalProperties": false,
497
+ "required": [
498
+ "type",
499
+ "label"
500
+ ]
501
+ }
502
+ ]
503
+ }
504
+ }
505
+ },
506
+ "additionalProperties": false,
507
+ "required": [
508
+ "outputCount",
509
+ "resultMode",
510
+ "fields"
511
+ ]
512
+ },
513
+ "customNodeSupports": {
514
+ "type": "array",
515
+ "items": {
516
+ "type": "string",
517
+ "enum": [
518
+ "cloud"
519
+ ]
520
+ }
521
+ },
522
+ "sourceApplicationId": {
523
+ "type": "string",
524
+ "pattern": "^[A-Fa-f\\d]{24}$"
525
+ },
526
+ "sourceFlowId": {
527
+ "type": "string",
528
+ "pattern": "^[A-Fa-f\\d]{24}$"
529
+ },
530
+ "sourceFlowVersion": {
531
+ "type": "string",
532
+ "minLength": 1,
533
+ "maxLength": 255
534
+ },
535
+ "stats": {
536
+ "type": "object",
537
+ "properties": {
538
+ "errorCount": {
539
+ "type": "integer"
540
+ },
541
+ "runCount": {
542
+ "type": "integer"
543
+ }
544
+ },
545
+ "additionalProperties": false
546
+ },
547
+ "usage": {
548
+ "type": "object",
549
+ "properties": {
550
+ "sandbox": {
551
+ "type": "object",
552
+ "properties": {
553
+ "appCount": {
554
+ "type": "integer"
555
+ },
556
+ "flowCount": {
557
+ "type": "integer"
558
+ }
559
+ },
560
+ "additionalProperties": false
561
+ }
562
+ },
563
+ "patternProperties": {
564
+ "^[A-Fa-f\\d]{24}$": {
565
+ "type": "object",
566
+ "properties": {
567
+ "appCount": {
568
+ "type": "integer"
569
+ },
570
+ "flowCount": {
571
+ "type": "integer"
572
+ },
573
+ "orgName": {
574
+ "type": "string",
575
+ "minLength": 1,
576
+ "maxLength": 255
577
+ },
578
+ "orgIconColor": {
579
+ "type": "string",
580
+ "maxLength": 64
581
+ }
582
+ },
583
+ "additionalProperties": false
584
+ }
585
+ },
586
+ "additionalProperties": false
587
+ }
588
+ }
589
+ }