losant_rest 1.13.1 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +2919 -507
- data/docs/application.md +1 -1
- data/docs/device.md +43 -0
- data/docs/devices.md +39 -0
- data/docs/edgeDeployment.md +49 -0
- data/docs/flow.md +1 -1
- data/docs/instanceOrg.md +2 -0
- data/docs/instanceOrgInvite.md +139 -0
- data/docs/instanceOrgInvites.md +96 -0
- data/docs/instanceOrgMembers.md +2 -2
- data/docs/instanceOrgs.md +1 -1
- data/docs/me.md +1 -1
- data/docs/org.md +1 -1
- data/lib/losant_rest.rb +3 -0
- data/lib/losant_rest/client.rb +14 -2
- data/lib/losant_rest/device.rb +50 -0
- data/lib/losant_rest/devices.rb +46 -0
- data/lib/losant_rest/edge_deployment.rb +81 -0
- data/lib/losant_rest/flow.rb +1 -1
- data/lib/losant_rest/instance_org.rb +4 -0
- data/lib/losant_rest/instance_org_invite.rb +182 -0
- data/lib/losant_rest/instance_org_invites.rb +138 -0
- data/lib/losant_rest/instance_org_members.rb +2 -2
- data/lib/losant_rest/instance_orgs.rb +2 -2
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/apiTokenPost.json +11 -0
- data/schemas/devicePayloadCounts.json +24 -0
- data/schemas/devicesExportPayloadCountPost.json +1350 -0
- data/schemas/edgeDeployment.json +16 -0
- data/schemas/edgeDeployments.json +16 -0
- data/schemas/experienceLinkedResources.json +45 -0
- data/schemas/flow.json +15 -0
- data/schemas/flowPatch.json +15 -0
- data/schemas/flowPost.json +15 -0
- data/schemas/flowVersion.json +30 -0
- data/schemas/flowVersionPost.json +15 -0
- data/schemas/flowVersions.json +30 -0
- data/schemas/flows.json +15 -0
- data/schemas/flowsImportPost.json +30 -0
- data/schemas/flowsImportResult.json +45 -0
- data/schemas/githubLogin.json +11 -0
- data/schemas/historicalSummary.json +60 -28
- data/schemas/instanceMember.json +4 -0
- data/schemas/instanceMemberPost.json +18 -3
- data/schemas/instanceMembers.json +8 -0
- data/schemas/instanceOrgMember.json +8 -0
- data/schemas/instanceOrgMembers.json +8 -0
- data/schemas/instanceOrgs.json +4 -0
- data/schemas/me.json +30 -14
- data/schemas/notebook.json +30 -0
- data/schemas/notebookPatch.json +30 -0
- data/schemas/notebookPost.json +30 -0
- data/schemas/notebooks.json +30 -0
- data/schemas/org.json +30 -14
- data/schemas/orgInvite.json +90 -0
- data/schemas/orgInviteCollection.json +130 -0
- data/schemas/orgInvites.json +82 -77
- data/schemas/orgRoleInfo.json +69 -0
- data/schemas/orgs.json +30 -14
- data/schemas/payloadStats.json +28 -12
- data/schemas/userCredentials.json +11 -0
- data/schemas/userPost.json +11 -0
- data/schemas/virtualButtonPress.json +4 -0
- metadata +13 -2
data/schemas/notebook.json
CHANGED
|
@@ -608,6 +608,36 @@
|
|
|
608
608
|
"outputType"
|
|
609
609
|
],
|
|
610
610
|
"additionalProperties": false
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"type": "object",
|
|
614
|
+
"properties": {
|
|
615
|
+
"outputType": {
|
|
616
|
+
"type": "string",
|
|
617
|
+
"enum": [
|
|
618
|
+
"temporaryUrl"
|
|
619
|
+
]
|
|
620
|
+
},
|
|
621
|
+
"fileName": {
|
|
622
|
+
"oneOf": [
|
|
623
|
+
{
|
|
624
|
+
"type": "string",
|
|
625
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"type": "string",
|
|
629
|
+
"minLength": 4,
|
|
630
|
+
"maxLength": 255,
|
|
631
|
+
"pattern": ".*{{.+}}.*"
|
|
632
|
+
}
|
|
633
|
+
]
|
|
634
|
+
}
|
|
635
|
+
},
|
|
636
|
+
"required": [
|
|
637
|
+
"fileName",
|
|
638
|
+
"outputType"
|
|
639
|
+
],
|
|
640
|
+
"additionalProperties": false
|
|
611
641
|
}
|
|
612
642
|
]
|
|
613
643
|
}
|
data/schemas/notebookPatch.json
CHANGED
|
@@ -573,6 +573,36 @@
|
|
|
573
573
|
"outputType"
|
|
574
574
|
],
|
|
575
575
|
"additionalProperties": false
|
|
576
|
+
},
|
|
577
|
+
{
|
|
578
|
+
"type": "object",
|
|
579
|
+
"properties": {
|
|
580
|
+
"outputType": {
|
|
581
|
+
"type": "string",
|
|
582
|
+
"enum": [
|
|
583
|
+
"temporaryUrl"
|
|
584
|
+
]
|
|
585
|
+
},
|
|
586
|
+
"fileName": {
|
|
587
|
+
"oneOf": [
|
|
588
|
+
{
|
|
589
|
+
"type": "string",
|
|
590
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"type": "string",
|
|
594
|
+
"minLength": 4,
|
|
595
|
+
"maxLength": 255,
|
|
596
|
+
"pattern": ".*{{.+}}.*"
|
|
597
|
+
}
|
|
598
|
+
]
|
|
599
|
+
}
|
|
600
|
+
},
|
|
601
|
+
"required": [
|
|
602
|
+
"fileName",
|
|
603
|
+
"outputType"
|
|
604
|
+
],
|
|
605
|
+
"additionalProperties": false
|
|
576
606
|
}
|
|
577
607
|
]
|
|
578
608
|
}
|
data/schemas/notebookPost.json
CHANGED
|
@@ -580,6 +580,36 @@
|
|
|
580
580
|
"outputType"
|
|
581
581
|
],
|
|
582
582
|
"additionalProperties": false
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"type": "object",
|
|
586
|
+
"properties": {
|
|
587
|
+
"outputType": {
|
|
588
|
+
"type": "string",
|
|
589
|
+
"enum": [
|
|
590
|
+
"temporaryUrl"
|
|
591
|
+
]
|
|
592
|
+
},
|
|
593
|
+
"fileName": {
|
|
594
|
+
"oneOf": [
|
|
595
|
+
{
|
|
596
|
+
"type": "string",
|
|
597
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"type": "string",
|
|
601
|
+
"minLength": 4,
|
|
602
|
+
"maxLength": 255,
|
|
603
|
+
"pattern": ".*{{.+}}.*"
|
|
604
|
+
}
|
|
605
|
+
]
|
|
606
|
+
}
|
|
607
|
+
},
|
|
608
|
+
"required": [
|
|
609
|
+
"fileName",
|
|
610
|
+
"outputType"
|
|
611
|
+
],
|
|
612
|
+
"additionalProperties": false
|
|
583
613
|
}
|
|
584
614
|
]
|
|
585
615
|
}
|
data/schemas/notebooks.json
CHANGED
|
@@ -615,6 +615,36 @@
|
|
|
615
615
|
"outputType"
|
|
616
616
|
],
|
|
617
617
|
"additionalProperties": false
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
"type": "object",
|
|
621
|
+
"properties": {
|
|
622
|
+
"outputType": {
|
|
623
|
+
"type": "string",
|
|
624
|
+
"enum": [
|
|
625
|
+
"temporaryUrl"
|
|
626
|
+
]
|
|
627
|
+
},
|
|
628
|
+
"fileName": {
|
|
629
|
+
"oneOf": [
|
|
630
|
+
{
|
|
631
|
+
"type": "string",
|
|
632
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
"type": "string",
|
|
636
|
+
"minLength": 4,
|
|
637
|
+
"maxLength": 255,
|
|
638
|
+
"pattern": ".*{{.+}}.*"
|
|
639
|
+
}
|
|
640
|
+
]
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
"required": [
|
|
644
|
+
"fileName",
|
|
645
|
+
"outputType"
|
|
646
|
+
],
|
|
647
|
+
"additionalProperties": false
|
|
618
648
|
}
|
|
619
649
|
]
|
|
620
650
|
}
|
data/schemas/org.json
CHANGED
|
@@ -255,11 +255,11 @@
|
|
|
255
255
|
"type": "number"
|
|
256
256
|
},
|
|
257
257
|
"payloadCount": {
|
|
258
|
-
"title": "Payload
|
|
259
|
-
"description": "Schema for the result of a payload
|
|
258
|
+
"title": "Payload Stats",
|
|
259
|
+
"description": "Schema for the result of a payload stats request",
|
|
260
260
|
"type": "object",
|
|
261
261
|
"properties": {
|
|
262
|
-
"
|
|
262
|
+
"dataTable": {
|
|
263
263
|
"type": "object",
|
|
264
264
|
"patternProperties": {
|
|
265
265
|
".*": {
|
|
@@ -267,7 +267,7 @@
|
|
|
267
267
|
}
|
|
268
268
|
}
|
|
269
269
|
},
|
|
270
|
-
"
|
|
270
|
+
"deviceCommand": {
|
|
271
271
|
"type": "object",
|
|
272
272
|
"patternProperties": {
|
|
273
273
|
".*": {
|
|
@@ -275,7 +275,15 @@
|
|
|
275
275
|
}
|
|
276
276
|
}
|
|
277
277
|
},
|
|
278
|
-
"
|
|
278
|
+
"deviceConnect": {
|
|
279
|
+
"type": "object",
|
|
280
|
+
"patternProperties": {
|
|
281
|
+
".*": {
|
|
282
|
+
"type": "number"
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"deviceDisconnect": {
|
|
279
287
|
"type": "object",
|
|
280
288
|
"patternProperties": {
|
|
281
289
|
".*": {
|
|
@@ -291,7 +299,7 @@
|
|
|
291
299
|
}
|
|
292
300
|
}
|
|
293
301
|
},
|
|
294
|
-
"
|
|
302
|
+
"endpoint": {
|
|
295
303
|
"type": "object",
|
|
296
304
|
"patternProperties": {
|
|
297
305
|
".*": {
|
|
@@ -299,7 +307,7 @@
|
|
|
299
307
|
}
|
|
300
308
|
}
|
|
301
309
|
},
|
|
302
|
-
"
|
|
310
|
+
"event": {
|
|
303
311
|
"type": "object",
|
|
304
312
|
"patternProperties": {
|
|
305
313
|
".*": {
|
|
@@ -307,7 +315,7 @@
|
|
|
307
315
|
}
|
|
308
316
|
}
|
|
309
317
|
},
|
|
310
|
-
"
|
|
318
|
+
"flowError": {
|
|
311
319
|
"type": "object",
|
|
312
320
|
"patternProperties": {
|
|
313
321
|
".*": {
|
|
@@ -315,7 +323,7 @@
|
|
|
315
323
|
}
|
|
316
324
|
}
|
|
317
325
|
},
|
|
318
|
-
"
|
|
326
|
+
"integration": {
|
|
319
327
|
"type": "object",
|
|
320
328
|
"patternProperties": {
|
|
321
329
|
".*": {
|
|
@@ -323,7 +331,7 @@
|
|
|
323
331
|
}
|
|
324
332
|
}
|
|
325
333
|
},
|
|
326
|
-
"
|
|
334
|
+
"mqttIn": {
|
|
327
335
|
"type": "object",
|
|
328
336
|
"patternProperties": {
|
|
329
337
|
".*": {
|
|
@@ -331,7 +339,7 @@
|
|
|
331
339
|
}
|
|
332
340
|
}
|
|
333
341
|
},
|
|
334
|
-
"
|
|
342
|
+
"mqttOut": {
|
|
335
343
|
"type": "object",
|
|
336
344
|
"patternProperties": {
|
|
337
345
|
".*": {
|
|
@@ -339,7 +347,7 @@
|
|
|
339
347
|
}
|
|
340
348
|
}
|
|
341
349
|
},
|
|
342
|
-
"
|
|
350
|
+
"notebook": {
|
|
343
351
|
"type": "object",
|
|
344
352
|
"patternProperties": {
|
|
345
353
|
".*": {
|
|
@@ -347,7 +355,7 @@
|
|
|
347
355
|
}
|
|
348
356
|
}
|
|
349
357
|
},
|
|
350
|
-
"
|
|
358
|
+
"timer": {
|
|
351
359
|
"type": "object",
|
|
352
360
|
"patternProperties": {
|
|
353
361
|
".*": {
|
|
@@ -355,7 +363,15 @@
|
|
|
355
363
|
}
|
|
356
364
|
}
|
|
357
365
|
},
|
|
358
|
-
"
|
|
366
|
+
"virtualButton": {
|
|
367
|
+
"type": "object",
|
|
368
|
+
"patternProperties": {
|
|
369
|
+
".*": {
|
|
370
|
+
"type": "number"
|
|
371
|
+
}
|
|
372
|
+
}
|
|
373
|
+
},
|
|
374
|
+
"webhook": {
|
|
359
375
|
"type": "object",
|
|
360
376
|
"patternProperties": {
|
|
361
377
|
".*": {
|
|
@@ -0,0 +1,90 @@
|
|
|
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
|
+
"email": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"format": "email",
|
|
12
|
+
"maxLength": 1024
|
|
13
|
+
},
|
|
14
|
+
"role": {
|
|
15
|
+
"type": "string",
|
|
16
|
+
"enum": [
|
|
17
|
+
"admin",
|
|
18
|
+
"edit",
|
|
19
|
+
"collaborate",
|
|
20
|
+
"view",
|
|
21
|
+
"none"
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
"applicationRoles": {
|
|
25
|
+
"type": "array",
|
|
26
|
+
"items": {
|
|
27
|
+
"type": "object",
|
|
28
|
+
"properties": {
|
|
29
|
+
"resourceId": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
32
|
+
},
|
|
33
|
+
"role": {
|
|
34
|
+
"type": "string",
|
|
35
|
+
"enum": [
|
|
36
|
+
"collaborate",
|
|
37
|
+
"view",
|
|
38
|
+
"none"
|
|
39
|
+
]
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
"required": [
|
|
43
|
+
"resourceId",
|
|
44
|
+
"role"
|
|
45
|
+
],
|
|
46
|
+
"additionalProperties": false
|
|
47
|
+
},
|
|
48
|
+
"maxItems": 1000
|
|
49
|
+
},
|
|
50
|
+
"dashboardRoles": {
|
|
51
|
+
"type": "array",
|
|
52
|
+
"items": {
|
|
53
|
+
"type": "object",
|
|
54
|
+
"properties": {
|
|
55
|
+
"resourceId": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
58
|
+
},
|
|
59
|
+
"role": {
|
|
60
|
+
"type": "string",
|
|
61
|
+
"enum": [
|
|
62
|
+
"collaborate",
|
|
63
|
+
"view",
|
|
64
|
+
"none"
|
|
65
|
+
]
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"required": [
|
|
69
|
+
"resourceId",
|
|
70
|
+
"role"
|
|
71
|
+
],
|
|
72
|
+
"additionalProperties": false
|
|
73
|
+
},
|
|
74
|
+
"maxItems": 1000
|
|
75
|
+
},
|
|
76
|
+
"inviteDate": {
|
|
77
|
+
"type": "string",
|
|
78
|
+
"format": "date-time"
|
|
79
|
+
},
|
|
80
|
+
"ttl": {
|
|
81
|
+
"type": "number"
|
|
82
|
+
},
|
|
83
|
+
"hasExpired": {
|
|
84
|
+
"type": "boolean"
|
|
85
|
+
},
|
|
86
|
+
"disallowTransfer": {
|
|
87
|
+
"type": "boolean"
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"items": {
|
|
6
|
+
"type": "array",
|
|
7
|
+
"items": {
|
|
8
|
+
"title": "Organization Invitation",
|
|
9
|
+
"description": "Schema for a pending invitation to an Organization",
|
|
10
|
+
"type": "object",
|
|
11
|
+
"properties": {
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
15
|
+
},
|
|
16
|
+
"email": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"format": "email",
|
|
19
|
+
"maxLength": 1024
|
|
20
|
+
},
|
|
21
|
+
"role": {
|
|
22
|
+
"type": "string",
|
|
23
|
+
"enum": [
|
|
24
|
+
"admin",
|
|
25
|
+
"edit",
|
|
26
|
+
"collaborate",
|
|
27
|
+
"view",
|
|
28
|
+
"none"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
"applicationRoles": {
|
|
32
|
+
"type": "array",
|
|
33
|
+
"items": {
|
|
34
|
+
"type": "object",
|
|
35
|
+
"properties": {
|
|
36
|
+
"resourceId": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
39
|
+
},
|
|
40
|
+
"role": {
|
|
41
|
+
"type": "string",
|
|
42
|
+
"enum": [
|
|
43
|
+
"collaborate",
|
|
44
|
+
"view",
|
|
45
|
+
"none"
|
|
46
|
+
]
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"required": [
|
|
50
|
+
"resourceId",
|
|
51
|
+
"role"
|
|
52
|
+
],
|
|
53
|
+
"additionalProperties": false
|
|
54
|
+
},
|
|
55
|
+
"maxItems": 1000
|
|
56
|
+
},
|
|
57
|
+
"dashboardRoles": {
|
|
58
|
+
"type": "array",
|
|
59
|
+
"items": {
|
|
60
|
+
"type": "object",
|
|
61
|
+
"properties": {
|
|
62
|
+
"resourceId": {
|
|
63
|
+
"type": "string",
|
|
64
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
65
|
+
},
|
|
66
|
+
"role": {
|
|
67
|
+
"type": "string",
|
|
68
|
+
"enum": [
|
|
69
|
+
"collaborate",
|
|
70
|
+
"view",
|
|
71
|
+
"none"
|
|
72
|
+
]
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
"required": [
|
|
76
|
+
"resourceId",
|
|
77
|
+
"role"
|
|
78
|
+
],
|
|
79
|
+
"additionalProperties": false
|
|
80
|
+
},
|
|
81
|
+
"maxItems": 1000
|
|
82
|
+
},
|
|
83
|
+
"inviteDate": {
|
|
84
|
+
"type": "string",
|
|
85
|
+
"format": "date-time"
|
|
86
|
+
},
|
|
87
|
+
"ttl": {
|
|
88
|
+
"type": "number"
|
|
89
|
+
},
|
|
90
|
+
"hasExpired": {
|
|
91
|
+
"type": "boolean"
|
|
92
|
+
},
|
|
93
|
+
"disallowTransfer": {
|
|
94
|
+
"type": "boolean"
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
"instanceId": {
|
|
100
|
+
"type": "string",
|
|
101
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
102
|
+
},
|
|
103
|
+
"orgId": {
|
|
104
|
+
"type": "string",
|
|
105
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
106
|
+
},
|
|
107
|
+
"count": {
|
|
108
|
+
"type": "integer"
|
|
109
|
+
},
|
|
110
|
+
"filter": {
|
|
111
|
+
"type": "string"
|
|
112
|
+
},
|
|
113
|
+
"filterField": {
|
|
114
|
+
"type": "string"
|
|
115
|
+
},
|
|
116
|
+
"sortField": {
|
|
117
|
+
"type": "string"
|
|
118
|
+
},
|
|
119
|
+
"sortDirection": {
|
|
120
|
+
"type": "string",
|
|
121
|
+
"enum": [
|
|
122
|
+
"asc",
|
|
123
|
+
"desc",
|
|
124
|
+
"ASC",
|
|
125
|
+
"DESC",
|
|
126
|
+
""
|
|
127
|
+
]
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|