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/orgInvites.json
CHANGED
|
@@ -4,89 +4,94 @@
|
|
|
4
4
|
"items": {
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
|
-
"
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
7
|
+
"title": "Organization Invitation",
|
|
8
|
+
"description": "Schema for a pending invitation to an Organization",
|
|
9
|
+
"type": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"id": {
|
|
12
|
+
"type": "string",
|
|
13
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
14
|
+
},
|
|
15
|
+
"email": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"format": "email",
|
|
18
|
+
"maxLength": 1024
|
|
19
|
+
},
|
|
20
|
+
"role": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"enum": [
|
|
23
|
+
"admin",
|
|
24
|
+
"edit",
|
|
25
|
+
"collaborate",
|
|
26
|
+
"view",
|
|
27
|
+
"none"
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
"applicationRoles": {
|
|
31
|
+
"type": "array",
|
|
32
|
+
"items": {
|
|
33
|
+
"type": "object",
|
|
34
|
+
"properties": {
|
|
35
|
+
"resourceId": {
|
|
36
|
+
"type": "string",
|
|
37
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
38
|
+
},
|
|
39
|
+
"role": {
|
|
40
|
+
"type": "string",
|
|
41
|
+
"enum": [
|
|
42
|
+
"collaborate",
|
|
43
|
+
"view",
|
|
44
|
+
"none"
|
|
45
|
+
]
|
|
46
|
+
}
|
|
34
47
|
},
|
|
35
|
-
"
|
|
36
|
-
"
|
|
37
|
-
"
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
"none"
|
|
41
|
-
]
|
|
42
|
-
}
|
|
48
|
+
"required": [
|
|
49
|
+
"resourceId",
|
|
50
|
+
"role"
|
|
51
|
+
],
|
|
52
|
+
"additionalProperties": false
|
|
43
53
|
},
|
|
44
|
-
"
|
|
45
|
-
"resourceId",
|
|
46
|
-
"role"
|
|
47
|
-
],
|
|
48
|
-
"additionalProperties": false
|
|
54
|
+
"maxItems": 1000
|
|
49
55
|
},
|
|
50
|
-
"
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
"
|
|
56
|
+
"dashboardRoles": {
|
|
57
|
+
"type": "array",
|
|
58
|
+
"items": {
|
|
59
|
+
"type": "object",
|
|
60
|
+
"properties": {
|
|
61
|
+
"resourceId": {
|
|
62
|
+
"type": "string",
|
|
63
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
64
|
+
},
|
|
65
|
+
"role": {
|
|
66
|
+
"type": "string",
|
|
67
|
+
"enum": [
|
|
68
|
+
"collaborate",
|
|
69
|
+
"view",
|
|
70
|
+
"none"
|
|
71
|
+
]
|
|
72
|
+
}
|
|
60
73
|
},
|
|
61
|
-
"
|
|
62
|
-
"
|
|
63
|
-
"
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
"none"
|
|
67
|
-
]
|
|
68
|
-
}
|
|
74
|
+
"required": [
|
|
75
|
+
"resourceId",
|
|
76
|
+
"role"
|
|
77
|
+
],
|
|
78
|
+
"additionalProperties": false
|
|
69
79
|
},
|
|
70
|
-
"
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
"
|
|
80
|
+
"maxItems": 1000
|
|
81
|
+
},
|
|
82
|
+
"inviteDate": {
|
|
83
|
+
"type": "string",
|
|
84
|
+
"format": "date-time"
|
|
85
|
+
},
|
|
86
|
+
"ttl": {
|
|
87
|
+
"type": "number"
|
|
88
|
+
},
|
|
89
|
+
"hasExpired": {
|
|
90
|
+
"type": "boolean"
|
|
75
91
|
},
|
|
76
|
-
"
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
"type": "string",
|
|
80
|
-
"format": "date-time"
|
|
81
|
-
},
|
|
82
|
-
"ttl": {
|
|
83
|
-
"type": "number"
|
|
84
|
-
},
|
|
85
|
-
"hasExpired": {
|
|
86
|
-
"type": "boolean"
|
|
87
|
-
},
|
|
88
|
-
"disallowTransfer": {
|
|
89
|
-
"type": "boolean"
|
|
92
|
+
"disallowTransfer": {
|
|
93
|
+
"type": "boolean"
|
|
94
|
+
}
|
|
90
95
|
}
|
|
91
96
|
}
|
|
92
97
|
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"properties": {
|
|
5
|
+
"role": {
|
|
6
|
+
"type": "string",
|
|
7
|
+
"enum": [
|
|
8
|
+
"admin",
|
|
9
|
+
"edit",
|
|
10
|
+
"collaborate",
|
|
11
|
+
"view",
|
|
12
|
+
"none"
|
|
13
|
+
]
|
|
14
|
+
},
|
|
15
|
+
"applicationRoles": {
|
|
16
|
+
"type": "array",
|
|
17
|
+
"items": {
|
|
18
|
+
"type": "object",
|
|
19
|
+
"properties": {
|
|
20
|
+
"resourceId": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
23
|
+
},
|
|
24
|
+
"role": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"enum": [
|
|
27
|
+
"collaborate",
|
|
28
|
+
"view",
|
|
29
|
+
"none"
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"required": [
|
|
34
|
+
"resourceId",
|
|
35
|
+
"role"
|
|
36
|
+
],
|
|
37
|
+
"additionalProperties": false
|
|
38
|
+
},
|
|
39
|
+
"maxItems": 1000
|
|
40
|
+
},
|
|
41
|
+
"dashboardRoles": {
|
|
42
|
+
"type": "array",
|
|
43
|
+
"items": {
|
|
44
|
+
"type": "object",
|
|
45
|
+
"properties": {
|
|
46
|
+
"resourceId": {
|
|
47
|
+
"type": "string",
|
|
48
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
49
|
+
},
|
|
50
|
+
"role": {
|
|
51
|
+
"type": "string",
|
|
52
|
+
"enum": [
|
|
53
|
+
"collaborate",
|
|
54
|
+
"view",
|
|
55
|
+
"none"
|
|
56
|
+
]
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"required": [
|
|
60
|
+
"resourceId",
|
|
61
|
+
"role"
|
|
62
|
+
],
|
|
63
|
+
"additionalProperties": false
|
|
64
|
+
},
|
|
65
|
+
"maxItems": 1000
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"additionalProperties": false
|
|
69
|
+
}
|
data/schemas/orgs.json
CHANGED
|
@@ -262,11 +262,11 @@
|
|
|
262
262
|
"type": "number"
|
|
263
263
|
},
|
|
264
264
|
"payloadCount": {
|
|
265
|
-
"title": "Payload
|
|
266
|
-
"description": "Schema for the result of a payload
|
|
265
|
+
"title": "Payload Stats",
|
|
266
|
+
"description": "Schema for the result of a payload stats request",
|
|
267
267
|
"type": "object",
|
|
268
268
|
"properties": {
|
|
269
|
-
"
|
|
269
|
+
"dataTable": {
|
|
270
270
|
"type": "object",
|
|
271
271
|
"patternProperties": {
|
|
272
272
|
".*": {
|
|
@@ -274,7 +274,7 @@
|
|
|
274
274
|
}
|
|
275
275
|
}
|
|
276
276
|
},
|
|
277
|
-
"
|
|
277
|
+
"deviceCommand": {
|
|
278
278
|
"type": "object",
|
|
279
279
|
"patternProperties": {
|
|
280
280
|
".*": {
|
|
@@ -282,7 +282,15 @@
|
|
|
282
282
|
}
|
|
283
283
|
}
|
|
284
284
|
},
|
|
285
|
-
"
|
|
285
|
+
"deviceConnect": {
|
|
286
|
+
"type": "object",
|
|
287
|
+
"patternProperties": {
|
|
288
|
+
".*": {
|
|
289
|
+
"type": "number"
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
},
|
|
293
|
+
"deviceDisconnect": {
|
|
286
294
|
"type": "object",
|
|
287
295
|
"patternProperties": {
|
|
288
296
|
".*": {
|
|
@@ -298,7 +306,7 @@
|
|
|
298
306
|
}
|
|
299
307
|
}
|
|
300
308
|
},
|
|
301
|
-
"
|
|
309
|
+
"endpoint": {
|
|
302
310
|
"type": "object",
|
|
303
311
|
"patternProperties": {
|
|
304
312
|
".*": {
|
|
@@ -306,7 +314,7 @@
|
|
|
306
314
|
}
|
|
307
315
|
}
|
|
308
316
|
},
|
|
309
|
-
"
|
|
317
|
+
"event": {
|
|
310
318
|
"type": "object",
|
|
311
319
|
"patternProperties": {
|
|
312
320
|
".*": {
|
|
@@ -314,7 +322,7 @@
|
|
|
314
322
|
}
|
|
315
323
|
}
|
|
316
324
|
},
|
|
317
|
-
"
|
|
325
|
+
"flowError": {
|
|
318
326
|
"type": "object",
|
|
319
327
|
"patternProperties": {
|
|
320
328
|
".*": {
|
|
@@ -322,7 +330,7 @@
|
|
|
322
330
|
}
|
|
323
331
|
}
|
|
324
332
|
},
|
|
325
|
-
"
|
|
333
|
+
"integration": {
|
|
326
334
|
"type": "object",
|
|
327
335
|
"patternProperties": {
|
|
328
336
|
".*": {
|
|
@@ -330,7 +338,7 @@
|
|
|
330
338
|
}
|
|
331
339
|
}
|
|
332
340
|
},
|
|
333
|
-
"
|
|
341
|
+
"mqttIn": {
|
|
334
342
|
"type": "object",
|
|
335
343
|
"patternProperties": {
|
|
336
344
|
".*": {
|
|
@@ -338,7 +346,7 @@
|
|
|
338
346
|
}
|
|
339
347
|
}
|
|
340
348
|
},
|
|
341
|
-
"
|
|
349
|
+
"mqttOut": {
|
|
342
350
|
"type": "object",
|
|
343
351
|
"patternProperties": {
|
|
344
352
|
".*": {
|
|
@@ -346,7 +354,7 @@
|
|
|
346
354
|
}
|
|
347
355
|
}
|
|
348
356
|
},
|
|
349
|
-
"
|
|
357
|
+
"notebook": {
|
|
350
358
|
"type": "object",
|
|
351
359
|
"patternProperties": {
|
|
352
360
|
".*": {
|
|
@@ -354,7 +362,7 @@
|
|
|
354
362
|
}
|
|
355
363
|
}
|
|
356
364
|
},
|
|
357
|
-
"
|
|
365
|
+
"timer": {
|
|
358
366
|
"type": "object",
|
|
359
367
|
"patternProperties": {
|
|
360
368
|
".*": {
|
|
@@ -362,7 +370,15 @@
|
|
|
362
370
|
}
|
|
363
371
|
}
|
|
364
372
|
},
|
|
365
|
-
"
|
|
373
|
+
"virtualButton": {
|
|
374
|
+
"type": "object",
|
|
375
|
+
"patternProperties": {
|
|
376
|
+
".*": {
|
|
377
|
+
"type": "number"
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"webhook": {
|
|
366
382
|
"type": "object",
|
|
367
383
|
"patternProperties": {
|
|
368
384
|
".*": {
|
data/schemas/payloadStats.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
3
3
|
"type": "object",
|
|
4
4
|
"properties": {
|
|
5
|
-
"
|
|
5
|
+
"dataTable": {
|
|
6
6
|
"type": "object",
|
|
7
7
|
"patternProperties": {
|
|
8
8
|
".*": {
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
}
|
|
11
11
|
}
|
|
12
12
|
},
|
|
13
|
-
"
|
|
13
|
+
"deviceCommand": {
|
|
14
14
|
"type": "object",
|
|
15
15
|
"patternProperties": {
|
|
16
16
|
".*": {
|
|
@@ -18,7 +18,15 @@
|
|
|
18
18
|
}
|
|
19
19
|
}
|
|
20
20
|
},
|
|
21
|
-
"
|
|
21
|
+
"deviceConnect": {
|
|
22
|
+
"type": "object",
|
|
23
|
+
"patternProperties": {
|
|
24
|
+
".*": {
|
|
25
|
+
"type": "number"
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
"deviceDisconnect": {
|
|
22
30
|
"type": "object",
|
|
23
31
|
"patternProperties": {
|
|
24
32
|
".*": {
|
|
@@ -34,7 +42,7 @@
|
|
|
34
42
|
}
|
|
35
43
|
}
|
|
36
44
|
},
|
|
37
|
-
"
|
|
45
|
+
"endpoint": {
|
|
38
46
|
"type": "object",
|
|
39
47
|
"patternProperties": {
|
|
40
48
|
".*": {
|
|
@@ -42,7 +50,7 @@
|
|
|
42
50
|
}
|
|
43
51
|
}
|
|
44
52
|
},
|
|
45
|
-
"
|
|
53
|
+
"event": {
|
|
46
54
|
"type": "object",
|
|
47
55
|
"patternProperties": {
|
|
48
56
|
".*": {
|
|
@@ -50,7 +58,7 @@
|
|
|
50
58
|
}
|
|
51
59
|
}
|
|
52
60
|
},
|
|
53
|
-
"
|
|
61
|
+
"flowError": {
|
|
54
62
|
"type": "object",
|
|
55
63
|
"patternProperties": {
|
|
56
64
|
".*": {
|
|
@@ -58,7 +66,7 @@
|
|
|
58
66
|
}
|
|
59
67
|
}
|
|
60
68
|
},
|
|
61
|
-
"
|
|
69
|
+
"integration": {
|
|
62
70
|
"type": "object",
|
|
63
71
|
"patternProperties": {
|
|
64
72
|
".*": {
|
|
@@ -66,7 +74,7 @@
|
|
|
66
74
|
}
|
|
67
75
|
}
|
|
68
76
|
},
|
|
69
|
-
"
|
|
77
|
+
"mqttIn": {
|
|
70
78
|
"type": "object",
|
|
71
79
|
"patternProperties": {
|
|
72
80
|
".*": {
|
|
@@ -74,7 +82,7 @@
|
|
|
74
82
|
}
|
|
75
83
|
}
|
|
76
84
|
},
|
|
77
|
-
"
|
|
85
|
+
"mqttOut": {
|
|
78
86
|
"type": "object",
|
|
79
87
|
"patternProperties": {
|
|
80
88
|
".*": {
|
|
@@ -82,7 +90,7 @@
|
|
|
82
90
|
}
|
|
83
91
|
}
|
|
84
92
|
},
|
|
85
|
-
"
|
|
93
|
+
"notebook": {
|
|
86
94
|
"type": "object",
|
|
87
95
|
"patternProperties": {
|
|
88
96
|
".*": {
|
|
@@ -90,7 +98,7 @@
|
|
|
90
98
|
}
|
|
91
99
|
}
|
|
92
100
|
},
|
|
93
|
-
"
|
|
101
|
+
"timer": {
|
|
94
102
|
"type": "object",
|
|
95
103
|
"patternProperties": {
|
|
96
104
|
".*": {
|
|
@@ -98,7 +106,15 @@
|
|
|
98
106
|
}
|
|
99
107
|
}
|
|
100
108
|
},
|
|
101
|
-
"
|
|
109
|
+
"virtualButton": {
|
|
110
|
+
"type": "object",
|
|
111
|
+
"patternProperties": {
|
|
112
|
+
".*": {
|
|
113
|
+
"type": "number"
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
},
|
|
117
|
+
"webhook": {
|
|
102
118
|
"type": "object",
|
|
103
119
|
"patternProperties": {
|
|
104
120
|
".*": {
|