losant_rest 1.11.1 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +17165 -8770
  3. data/docs/application.md +41 -0
  4. data/docs/applicationDashboard.md +133 -0
  5. data/docs/applicationDashboards.md +93 -0
  6. data/docs/applicationKeys.md +3 -2
  7. data/docs/experienceEndpoint.md +1 -0
  8. data/docs/flows.md +1 -0
  9. data/docs/integration.md +1 -0
  10. data/docs/webhook.md +1 -0
  11. data/lib/losant_rest.rb +2 -0
  12. data/lib/losant_rest/application.rb +47 -0
  13. data/lib/losant_rest/application_dashboard.rb +176 -0
  14. data/lib/losant_rest/application_dashboards.rb +138 -0
  15. data/lib/losant_rest/application_keys.rb +3 -0
  16. data/lib/losant_rest/client.rb +10 -2
  17. data/lib/losant_rest/experience_endpoint.rb +2 -0
  18. data/lib/losant_rest/flows.rb +2 -0
  19. data/lib/losant_rest/integration.rb +2 -0
  20. data/lib/losant_rest/version.rb +1 -1
  21. data/lib/losant_rest/webhook.rb +2 -0
  22. data/schemas/advancedApplicationKeyQuery.json +1082 -0
  23. data/schemas/advancedFlowQuery.json +218 -0
  24. data/schemas/advancedFlowVersionQuery.json +218 -0
  25. data/schemas/applicationApiTokenPost.json +7 -0
  26. data/schemas/applicationDashboardPost.json +5665 -0
  27. data/schemas/applicationGlobalPatch.json +33 -0
  28. data/schemas/dashboard.json +28 -1
  29. data/schemas/dashboardPatch.json +28 -1
  30. data/schemas/dashboardPost.json +28 -1
  31. data/schemas/dashboards.json +28 -1
  32. data/schemas/files.json +3 -0
  33. data/schemas/githubLogin.json +18 -0
  34. data/schemas/instance.json +132 -0
  35. data/schemas/instanceOrg.json +119 -0
  36. data/schemas/instanceOrgPatch.json +103 -0
  37. data/schemas/instanceOrgPost.json +114 -0
  38. data/schemas/instanceOrgs.json +160 -0
  39. data/schemas/instances.json +43 -0
  40. data/schemas/userCredentials.json +18 -0
  41. data/schemas/userPost.json +18 -0
  42. metadata +16 -3
data/schemas/applicationGlobalPatch.json ADDED
@@ -0,0 +1,33 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "array",
4
+ "maxItems": 100,
5
+ "items": {
6
+ "type": "object",
7
+ "properties": {
8
+ "key": {
9
+ "type": "string",
10
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
11
+ },
12
+ "json": {
13
+ "type": [
14
+ "string",
15
+ "null"
16
+ ],
17
+ "minLength": 1,
18
+ "maxLength": 32767
19
+ },
20
+ "cloudOnly": {
21
+ "type": "boolean"
22
+ },
23
+ "description": {
24
+ "type": "string",
25
+ "maxLength": 1024
26
+ }
27
+ },
28
+ "additionalProperties": false,
29
+ "required": [
30
+ "key"
31
+ ]
32
+ }
33
+ }
data/schemas/dashboard.json CHANGED
@@ -1034,6 +1034,24 @@
1034
1034
  "$and",
1035
1035
  "advanced"
1036
1036
  ]
1037
+ },
1038
+ "columns": {
1039
+ "type": "array",
1040
+ "maxItems": 100,
1041
+ "items": {
1042
+ "type": "object",
1043
+ "properties": {
1044
+ "id": {
1045
+ "type": "string",
1046
+ "maxLength": 48
1047
+ },
1048
+ "type": {
1049
+ "type": "string",
1050
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
1051
+ }
1052
+ },
1053
+ "additionalProperties": false
1054
+ }
1037
1055
  }
1038
1056
  },
1039
1057
  "additionalProperties": false
@@ -1578,8 +1596,17 @@
1578
1596
  "state",
1579
1597
  "tag",
1580
1598
  "deviceName",
1581
- "sourceId"
1599
+ "sourceId",
1600
+ "custom"
1582
1601
  ]
1602
+ },
1603
+ "headerTemplate": {
1604
+ "type": "string",
1605
+ "maxLength": 1024
1606
+ },
1607
+ "rowTemplate": {
1608
+ "type": "string",
1609
+ "maxLength": 32767
1583
1610
  }
1584
1611
  },
1585
1612
  "additionalProperties": false
data/schemas/dashboardPatch.json CHANGED
@@ -916,6 +916,24 @@
916
916
  "$and",
917
917
  "advanced"
918
918
  ]
919
+ },
920
+ "columns": {
921
+ "type": "array",
922
+ "maxItems": 100,
923
+ "items": {
924
+ "type": "object",
925
+ "properties": {
926
+ "id": {
927
+ "type": "string",
928
+ "maxLength": 48
929
+ },
930
+ "type": {
931
+ "type": "string",
932
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
933
+ }
934
+ },
935
+ "additionalProperties": false
936
+ }
919
937
  }
920
938
  },
921
939
  "additionalProperties": false
@@ -1460,8 +1478,17 @@
1460
1478
  "state",
1461
1479
  "tag",
1462
1480
  "deviceName",
1463
- "sourceId"
1481
+ "sourceId",
1482
+ "custom"
1464
1483
  ]
1484
+ },
1485
+ "headerTemplate": {
1486
+ "type": "string",
1487
+ "maxLength": 1024
1488
+ },
1489
+ "rowTemplate": {
1490
+ "type": "string",
1491
+ "maxLength": 32767
1465
1492
  }
1466
1493
  },
1467
1494
  "additionalProperties": false
data/schemas/dashboardPost.json CHANGED
@@ -924,6 +924,24 @@
924
924
  "$and",
925
925
  "advanced"
926
926
  ]
927
+ },
928
+ "columns": {
929
+ "type": "array",
930
+ "maxItems": 100,
931
+ "items": {
932
+ "type": "object",
933
+ "properties": {
934
+ "id": {
935
+ "type": "string",
936
+ "maxLength": 48
937
+ },
938
+ "type": {
939
+ "type": "string",
940
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
941
+ }
942
+ },
943
+ "additionalProperties": false
944
+ }
927
945
  }
928
946
  },
929
947
  "additionalProperties": false
@@ -1468,8 +1486,17 @@
1468
1486
  "state",
1469
1487
  "tag",
1470
1488
  "deviceName",
1471
- "sourceId"
1489
+ "sourceId",
1490
+ "custom"
1472
1491
  ]
1492
+ },
1493
+ "headerTemplate": {
1494
+ "type": "string",
1495
+ "maxLength": 1024
1496
+ },
1497
+ "rowTemplate": {
1498
+ "type": "string",
1499
+ "maxLength": 32767
1473
1500
  }
1474
1501
  },
1475
1502
  "additionalProperties": false
data/schemas/dashboards.json CHANGED
@@ -1041,6 +1041,24 @@
1041
1041
  "$and",
1042
1042
  "advanced"
1043
1043
  ]
1044
+ },
1045
+ "columns": {
1046
+ "type": "array",
1047
+ "maxItems": 100,
1048
+ "items": {
1049
+ "type": "object",
1050
+ "properties": {
1051
+ "id": {
1052
+ "type": "string",
1053
+ "maxLength": 48
1054
+ },
1055
+ "type": {
1056
+ "type": "string",
1057
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
1058
+ }
1059
+ },
1060
+ "additionalProperties": false
1061
+ }
1044
1062
  }
1045
1063
  },
1046
1064
  "additionalProperties": false
@@ -1585,8 +1603,17 @@
1585
1603
  "state",
1586
1604
  "tag",
1587
1605
  "deviceName",
1588
- "sourceId"
1606
+ "sourceId",
1607
+ "custom"
1589
1608
  ]
1609
+ },
1610
+ "headerTemplate": {
1611
+ "type": "string",
1612
+ "maxLength": 1024
1613
+ },
1614
+ "rowTemplate": {
1615
+ "type": "string",
1616
+ "maxLength": 32767
1590
1617
  }
1591
1618
  },
1592
1619
  "additionalProperties": false
data/schemas/files.json CHANGED
@@ -125,6 +125,9 @@
125
125
  "DESC",
126
126
  ""
127
127
  ]
128
+ },
129
+ "parentExists": {
130
+ "type": "boolean"
128
131
  }
129
132
  }
130
133
  }
data/schemas/githubLogin.json CHANGED
@@ -28,6 +28,8 @@
28
28
  "applicationCertificates.*",
29
29
  "applicationCertificateAuthority.*",
30
30
  "applicationCertificateAuthorities.*",
31
+ "applicationDashboards.*",
32
+ "applicationDashboard.*",
31
33
  "applicationKey.*",
32
34
  "applicationKeys.*",
33
35
  "data.*",
@@ -100,6 +102,11 @@
100
102
  "applicationCertificateAuthority.patch",
101
103
  "applicationCertificateAuthorities.get",
102
104
  "applicationCertificateAuthorities.post",
105
+ "applicationDashboard.get",
106
+ "applicationDashboard.patch",
107
+ "applicationDashboard.delete",
108
+ "applicationDashboards.get",
109
+ "applicationDashboards.post",
103
110
  "applicationKey.delete",
104
111
  "applicationKey.get",
105
112
  "applicationKey.patch",
@@ -317,6 +324,17 @@
317
324
  "applicationTemplates.getUniqueKeywords",
318
325
  "me.*",
319
326
  "orgs.*",
327
+ "instance.*",
328
+ "instance.get",
329
+ "instances.*",
330
+ "instances.get",
331
+ "instanceOrg.*",
332
+ "instanceOrg.get",
333
+ "instanceOrg.patch",
334
+ "instanceOrg.delete",
335
+ "instanceOrgs.*",
336
+ "instanceOrgs.get",
337
+ "instanceOrgs.post",
320
338
  "me.get",
321
339
  "me.patch",
322
340
  "me.delete",
data/schemas/instance.json ADDED
@@ -0,0 +1,132 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "id": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "instanceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "creationDate": {
19
+ "type": "string",
20
+ "format": "date-time"
21
+ },
22
+ "lastUpdated": {
23
+ "type": "string",
24
+ "format": "date-time"
25
+ },
26
+ "allowAuditLogging": {
27
+ "type": "boolean"
28
+ },
29
+ "limits": {
30
+ "organization": {
31
+ "type": "number"
32
+ },
33
+ "apitoken": {
34
+ "type": "number"
35
+ },
36
+ "application": {
37
+ "type": "number"
38
+ },
39
+ "applicationkey": {
40
+ "type": "number"
41
+ },
42
+ "dashboard": {
43
+ "type": "number"
44
+ },
45
+ "datatable": {
46
+ "type": "number"
47
+ },
48
+ "device": {
49
+ "type": "number"
50
+ },
51
+ "devicerecipe": {
52
+ "type": "number"
53
+ },
54
+ "experiencedomain": {
55
+ "type": "number"
56
+ },
57
+ "experienceendpoint": {
58
+ "type": "number"
59
+ },
60
+ "experiencegroup": {
61
+ "type": "number"
62
+ },
63
+ "experienceslug": {
64
+ "type": "number"
65
+ },
66
+ "experienceuser": {
67
+ "type": "number"
68
+ },
69
+ "experienceversion": {
70
+ "type": "number"
71
+ },
72
+ "experienceview": {
73
+ "type": "number"
74
+ },
75
+ "file": {
76
+ "type": "number"
77
+ },
78
+ "flow": {
79
+ "type": "number"
80
+ },
81
+ "integration": {
82
+ "type": "number"
83
+ },
84
+ "notebook": {
85
+ "type": "number"
86
+ },
87
+ "webhook": {
88
+ "type": "number"
89
+ },
90
+ "dataTTL": {
91
+ "type": "number"
92
+ },
93
+ "member": {
94
+ "type": "number"
95
+ },
96
+ "payload": {
97
+ "type": "number"
98
+ },
99
+ "notebookMinutesPerRun": {
100
+ "type": "number"
101
+ },
102
+ "notebookMinutesPerMonth": {
103
+ "type": "number"
104
+ },
105
+ "notebookInParallel": {
106
+ "type": "number"
107
+ }
108
+ },
109
+ "members": {
110
+ "type": "array",
111
+ "items": {
112
+ "type": "object",
113
+ "properties": {
114
+ "userId": {
115
+ "type": "string",
116
+ "pattern": "^[A-Fa-f\\d]{24}$"
117
+ },
118
+ "role": {
119
+ "type": "string",
120
+ "enum": [
121
+ "admin",
122
+ "edit",
123
+ "collaborate",
124
+ "view",
125
+ "none"
126
+ ]
127
+ }
128
+ }
129
+ }
130
+ }
131
+ }
132
+ }
data/schemas/instanceOrg.json ADDED
@@ -0,0 +1,119 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 255
9
+ },
10
+ "id": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "instanceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "description": {
19
+ "type": "string",
20
+ "maxLength": 32767
21
+ },
22
+ "iconColor": {
23
+ "type": "string",
24
+ "maxLength": 64
25
+ },
26
+ "limits": {
27
+ "apitoken": {
28
+ "type": "number"
29
+ },
30
+ "application": {
31
+ "type": "number"
32
+ },
33
+ "applicationkey": {
34
+ "type": "number"
35
+ },
36
+ "dashboard": {
37
+ "type": "number"
38
+ },
39
+ "datatable": {
40
+ "type": "number"
41
+ },
42
+ "device": {
43
+ "type": "number"
44
+ },
45
+ "devicerecipe": {
46
+ "type": "number"
47
+ },
48
+ "experiencedomain": {
49
+ "type": "number"
50
+ },
51
+ "experienceendpoint": {
52
+ "type": "number"
53
+ },
54
+ "experiencegroup": {
55
+ "type": "number"
56
+ },
57
+ "experienceslug": {
58
+ "type": "number"
59
+ },
60
+ "experienceuser": {
61
+ "type": "number"
62
+ },
63
+ "experienceversion": {
64
+ "type": "number"
65
+ },
66
+ "experienceview": {
67
+ "type": "number"
68
+ },
69
+ "file": {
70
+ "type": "number"
71
+ },
72
+ "flow": {
73
+ "type": "number"
74
+ },
75
+ "integration": {
76
+ "type": "number"
77
+ },
78
+ "notebook": {
79
+ "type": "number"
80
+ },
81
+ "webhook": {
82
+ "type": "number"
83
+ },
84
+ "dataTTL": {
85
+ "type": "number"
86
+ },
87
+ "member": {
88
+ "type": "number"
89
+ },
90
+ "payload": {
91
+ "type": "number"
92
+ },
93
+ "notebookMinutesPerRun": {
94
+ "type": "number"
95
+ },
96
+ "notebookMinutesPerMonth": {
97
+ "type": "number"
98
+ },
99
+ "notebookInParallel": {
100
+ "type": "number"
101
+ }
102
+ },
103
+ "whitelistedEmailDomains": {
104
+ "type": "array",
105
+ "items": {
106
+ "type": "string",
107
+ "maxLength": 45,
108
+ "minLength": 3
109
+ }
110
+ },
111
+ "auditLogEnabled": {
112
+ "type": "boolean"
113
+ }
114
+ },
115
+ "additionalProperties": false,
116
+ "required": [
117
+ "name"
118
+ ]
119
+ }