losant_rest 1.13.1 → 1.15.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +10817 -3660
  3. data/docs/application.md +1 -1
  4. data/docs/device.md +43 -0
  5. data/docs/devices.md +39 -0
  6. data/docs/edgeDeployment.md +49 -0
  7. data/docs/embeddedDeployment.md +49 -0
  8. data/docs/embeddedDeployments.md +215 -0
  9. data/docs/flow.md +3 -3
  10. data/docs/flows.md +2 -2
  11. data/docs/instance.md +4 -2
  12. data/docs/instanceOrg.md +2 -0
  13. data/docs/instanceOrgInvite.md +139 -0
  14. data/docs/instanceOrgInvites.md +96 -0
  15. data/docs/instanceOrgMembers.md +2 -2
  16. data/docs/instanceOrgs.md +1 -1
  17. data/docs/me.md +1 -1
  18. data/docs/org.md +1 -1
  19. data/lib/losant_rest/client.rb +22 -2
  20. data/lib/losant_rest/device.rb +50 -0
  21. data/lib/losant_rest/devices.rb +46 -0
  22. data/lib/losant_rest/edge_deployment.rb +81 -0
  23. data/lib/losant_rest/embedded_deployment.rb +81 -0
  24. data/lib/losant_rest/embedded_deployments.rb +280 -0
  25. data/lib/losant_rest/flow.rb +3 -3
  26. data/lib/losant_rest/flows.rb +2 -2
  27. data/lib/losant_rest/instance.rb +1 -0
  28. data/lib/losant_rest/instance_org.rb +4 -0
  29. data/lib/losant_rest/instance_org_invite.rb +182 -0
  30. data/lib/losant_rest/instance_org_invites.rb +138 -0
  31. data/lib/losant_rest/instance_org_members.rb +2 -2
  32. data/lib/losant_rest/instance_orgs.rb +2 -2
  33. data/lib/losant_rest/version.rb +1 -1
  34. data/lib/losant_rest.rb +5 -0
  35. data/schemas/apiTokenPost.json +19 -0
  36. data/schemas/application.json +32 -32
  37. data/schemas/applicationCreationByTemplateResult.json +32 -32
  38. data/schemas/applicationDashboardPost.json +8 -5
  39. data/schemas/applicationPatch.json +13 -13
  40. data/schemas/applicationPost.json +13 -13
  41. data/schemas/applicationTemplate.json +16 -16
  42. data/schemas/applicationTemplates.json +16 -16
  43. data/schemas/applications.json +32 -32
  44. data/schemas/authedDevice.json +2 -1
  45. data/schemas/dashboard.json +8 -5
  46. data/schemas/dashboardPatch.json +8 -5
  47. data/schemas/dashboardPost.json +8 -5
  48. data/schemas/dashboardSendReport.json +6 -6
  49. data/schemas/dashboards.json +8 -5
  50. data/schemas/dataTableRowsDelete.json +1 -1
  51. data/schemas/device.json +2 -1
  52. data/schemas/deviceClassFilter.json +4 -2
  53. data/schemas/devicePatch.json +2 -1
  54. data/schemas/devicePayloadCounts.json +24 -0
  55. data/schemas/devicePost.json +2 -1
  56. data/schemas/deviceRecipe.json +2 -1
  57. data/schemas/deviceRecipePatch.json +2 -1
  58. data/schemas/deviceRecipePost.json +2 -1
  59. data/schemas/deviceRecipes.json +2 -1
  60. data/schemas/devices.json +4 -2
  61. data/schemas/devicesExportPayloadCountPost.json +1350 -0
  62. data/schemas/devicesPatch.json +4 -2
  63. data/schemas/edgeDeployment.json +20 -0
  64. data/schemas/edgeDeployments.json +20 -0
  65. data/schemas/embeddedDeployment.json +179 -0
  66. data/schemas/embeddedDeploymentExport.json +44 -0
  67. data/schemas/embeddedDeploymentRelease.json +58 -0
  68. data/schemas/embeddedDeploymentRemove.json +25 -0
  69. data/schemas/embeddedDeploymentReplace.json +29 -0
  70. data/schemas/embeddedDeployments.json +212 -0
  71. data/schemas/eventsDeleted.json +1 -1
  72. data/schemas/eventsExport.json +4 -0
  73. data/schemas/experienceEndpoint.json +6 -8
  74. data/schemas/experienceEndpointPatch.json +6 -8
  75. data/schemas/experienceEndpointPost.json +6 -8
  76. data/schemas/experienceEndpoints.json +6 -8
  77. data/schemas/experienceLinkedResources.json +790 -85
  78. data/schemas/flow.json +252 -16
  79. data/schemas/flowPatch.json +251 -16
  80. data/schemas/flowPost.json +252 -16
  81. data/schemas/flowVersion.json +503 -33
  82. data/schemas/flowVersionPost.json +251 -16
  83. data/schemas/flowVersions.json +503 -33
  84. data/schemas/flows.json +253 -16
  85. data/schemas/flowsImportPost.json +503 -32
  86. data/schemas/flowsImportResult.json +785 -79
  87. data/schemas/githubLogin.json +19 -0
  88. data/schemas/historicalSummary.json +147 -102
  89. data/schemas/instance.json +92 -79
  90. data/schemas/instanceMember.json +10 -0
  91. data/schemas/instanceMemberPost.json +18 -3
  92. data/schemas/instanceMembers.json +14 -0
  93. data/schemas/instanceOrg.json +87 -74
  94. data/schemas/instanceOrgMember.json +14 -0
  95. data/schemas/instanceOrgMembers.json +8 -0
  96. data/schemas/instanceOrgPatch.json +64 -26
  97. data/schemas/instanceOrgPost.json +65 -27
  98. data/schemas/instanceOrgs.json +91 -74
  99. data/schemas/instancePatch.json +2 -2
  100. data/schemas/me.json +134 -105
  101. data/schemas/notebook.json +32 -1
  102. data/schemas/notebookExecutionLogs.json +2 -1
  103. data/schemas/notebookPatch.json +32 -1
  104. data/schemas/notebookPost.json +32 -1
  105. data/schemas/notebooks.json +32 -1
  106. data/schemas/org.json +145 -110
  107. data/schemas/orgInvite.json +90 -0
  108. data/schemas/orgInviteCollection.json +130 -0
  109. data/schemas/orgInvites.json +82 -77
  110. data/schemas/orgRoleInfo.json +69 -0
  111. data/schemas/orgs.json +145 -110
  112. data/schemas/payloadStats.json +28 -12
  113. data/schemas/userCredentials.json +19 -0
  114. data/schemas/userPost.json +19 -0
  115. data/schemas/virtualButtonPress.json +4 -0
  116. metadata +27 -6
data/schemas/instanceMember.json CHANGED
@@ -2,6 +2,10 @@
2
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
3
  "type": "object",
4
4
  "properties": {
5
+ "instanceId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
5
9
  "userId": {
6
10
  "type": "string",
7
11
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -31,6 +35,12 @@
31
35
  "avatarUrl": {
32
36
  "type": "string",
33
37
  "format": "url"
38
+ },
39
+ "twoFactorAuthEnabled": {
40
+ "type": "boolean"
41
+ },
42
+ "ssoLinked": {
43
+ "type": "boolean"
34
44
  }
35
45
  },
36
46
  "additionalProperties": false
data/schemas/instanceMemberPost.json CHANGED
@@ -6,6 +6,11 @@
6
6
  "type": "string",
7
7
  "pattern": "^[A-Fa-f\\d]{24}$"
8
8
  },
9
+ "email": {
10
+ "type": "string",
11
+ "format": "email",
12
+ "maxLength": 1024
13
+ },
9
14
  "role": {
10
15
  "type": "string",
11
16
  "enum": [
@@ -15,8 +20,18 @@
15
20
  }
16
21
  },
17
22
  "additionalProperties": false,
18
- "required": [
19
- "userId",
20
- "role"
23
+ "anyOf": [
24
+ {
25
+ "required": [
26
+ "email",
27
+ "role"
28
+ ]
29
+ },
30
+ {
31
+ "required": [
32
+ "userId",
33
+ "role"
34
+ ]
35
+ }
21
36
  ]
22
37
  }
data/schemas/instanceMembers.json CHANGED
@@ -9,6 +9,10 @@
9
9
  "description": "Schema for an Instance member",
10
10
  "type": "object",
11
11
  "properties": {
12
+ "instanceId": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
12
16
  "userId": {
13
17
  "type": "string",
14
18
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -38,11 +42,21 @@
38
42
  "avatarUrl": {
39
43
  "type": "string",
40
44
  "format": "url"
45
+ },
46
+ "twoFactorAuthEnabled": {
47
+ "type": "boolean"
48
+ },
49
+ "ssoLinked": {
50
+ "type": "boolean"
41
51
  }
42
52
  },
43
53
  "additionalProperties": false
44
54
  }
45
55
  },
56
+ "instanceId": {
57
+ "type": "string",
58
+ "pattern": "^[A-Fa-f\\d]{24}$"
59
+ },
46
60
  "count": {
47
61
  "type": "integer"
48
62
  },
data/schemas/instanceOrg.json CHANGED
@@ -24,81 +24,94 @@
24
24
  "maxLength": 64
25
25
  },
26
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"
27
+ "type": "object",
28
+ "properties": {
29
+ "apitoken": {
30
+ "type": "integer"
31
+ },
32
+ "application": {
33
+ "type": "integer"
34
+ },
35
+ "applicationkey": {
36
+ "type": "integer"
37
+ },
38
+ "dashboard": {
39
+ "type": "integer"
40
+ },
41
+ "datatable": {
42
+ "type": "integer"
43
+ },
44
+ "device": {
45
+ "type": "integer"
46
+ },
47
+ "devicerecipe": {
48
+ "type": "integer"
49
+ },
50
+ "experiencedomain": {
51
+ "type": "integer"
52
+ },
53
+ "experienceendpoint": {
54
+ "type": "integer"
55
+ },
56
+ "experiencegroup": {
57
+ "type": "integer"
58
+ },
59
+ "experienceslug": {
60
+ "type": "integer"
61
+ },
62
+ "experienceuser": {
63
+ "type": "integer"
64
+ },
65
+ "experienceversion": {
66
+ "type": "integer"
67
+ },
68
+ "experienceview": {
69
+ "type": "integer"
70
+ },
71
+ "file": {
72
+ "type": "integer"
73
+ },
74
+ "flow": {
75
+ "type": "integer"
76
+ },
77
+ "integration": {
78
+ "type": "integer"
79
+ },
80
+ "notebook": {
81
+ "type": "integer"
82
+ },
83
+ "webhook": {
84
+ "type": "integer"
85
+ },
86
+ "dataTTL": {
87
+ "type": "integer"
88
+ },
89
+ "member": {
90
+ "type": "integer"
91
+ },
92
+ "payload": {
93
+ "type": "integer"
94
+ },
95
+ "storage": {
96
+ "type": "integer"
97
+ },
98
+ "notebookMinutesPerRun": {
99
+ "type": "integer"
100
+ },
101
+ "notebookMinutesPerMonth": {
102
+ "type": "integer"
103
+ },
104
+ "notebookInParallel": {
105
+ "type": "integer"
106
+ },
107
+ "experienceFlowSlots": {
108
+ "type": "integer"
109
+ },
110
+ "applicationFlowSlots": {
111
+ "type": "integer"
112
+ }
98
113
  },
99
- "notebookInParallel": {
100
- "type": "number"
101
- }
114
+ "additionalProperties": false
102
115
  },
103
116
  "whitelistedEmailDomains": {
104
117
  "type": "array",
data/schemas/instanceOrgMember.json CHANGED
@@ -2,6 +2,14 @@
2
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
3
  "type": "object",
4
4
  "properties": {
5
+ "instanceId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "orgId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
5
13
  "userId": {
6
14
  "type": "string",
7
15
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -31,6 +39,12 @@
31
39
  "avatarUrl": {
32
40
  "type": "string",
33
41
  "format": "url"
42
+ },
43
+ "twoFactorAuthEnabled": {
44
+ "type": "boolean"
45
+ },
46
+ "ssoLinked": {
47
+ "type": "boolean"
34
48
  }
35
49
  },
36
50
  "additionalProperties": false
data/schemas/instanceOrgMembers.json CHANGED
@@ -8,6 +8,14 @@
8
8
  "$ref": "#/definitions/instanceOrgMembers"
9
9
  }
10
10
  },
11
+ "instanceId": {
12
+ "type": "string",
13
+ "pattern": "^[A-Fa-f\\d]{24}$"
14
+ },
15
+ "orgId": {
16
+ "type": "string",
17
+ "pattern": "^[A-Fa-f\\d]{24}$"
18
+ },
11
19
  "count": {
12
20
  "type": "integer"
13
21
  },
data/schemas/instanceOrgPatch.json CHANGED
@@ -19,81 +19,119 @@
19
19
  "type": "object",
20
20
  "properties": {
21
21
  "apitoken": {
22
- "type": "number"
22
+ "type": "integer",
23
+ "minimum": 0
23
24
  },
24
25
  "application": {
25
- "type": "number"
26
+ "type": "integer",
27
+ "minimum": 0
26
28
  },
27
29
  "applicationkey": {
28
- "type": "number"
30
+ "type": "integer",
31
+ "minimum": 0
29
32
  },
30
33
  "dashboard": {
31
- "type": "number"
34
+ "type": "integer",
35
+ "minimum": 0
32
36
  },
33
37
  "datatable": {
34
- "type": "number"
38
+ "type": "integer",
39
+ "minimum": 0
35
40
  },
36
41
  "device": {
37
- "type": "number"
42
+ "type": "integer",
43
+ "minimum": 0
38
44
  },
39
45
  "devicerecipe": {
40
- "type": "number"
46
+ "type": "integer",
47
+ "minimum": 0
41
48
  },
42
49
  "experiencedomain": {
43
- "type": "number"
50
+ "type": "integer",
51
+ "minimum": 0
44
52
  },
45
53
  "experienceendpoint": {
46
- "type": "number"
54
+ "type": "integer",
55
+ "minimum": 0
47
56
  },
48
57
  "experiencegroup": {
49
- "type": "number"
58
+ "type": "integer",
59
+ "minimum": 0
50
60
  },
51
61
  "experienceslug": {
52
- "type": "number"
62
+ "type": "integer",
63
+ "minimum": 0
53
64
  },
54
65
  "experienceuser": {
55
- "type": "number"
66
+ "type": "integer",
67
+ "minimum": 0
56
68
  },
57
69
  "experienceversion": {
58
- "type": "number"
70
+ "type": "integer",
71
+ "minimum": 0
59
72
  },
60
73
  "experienceview": {
61
- "type": "number"
74
+ "type": "integer",
75
+ "minimum": 0
62
76
  },
63
77
  "file": {
64
- "type": "number"
78
+ "type": "integer",
79
+ "minimum": 0
65
80
  },
66
81
  "flow": {
67
- "type": "number"
82
+ "type": "integer",
83
+ "minimum": 0
68
84
  },
69
85
  "integration": {
70
- "type": "number"
86
+ "type": "integer",
87
+ "minimum": 0
71
88
  },
72
89
  "notebook": {
73
- "type": "number"
90
+ "type": "integer",
91
+ "minimum": 0
74
92
  },
75
93
  "webhook": {
76
- "type": "number"
94
+ "type": "integer",
95
+ "minimum": 0
77
96
  },
78
97
  "dataTTL": {
79
- "type": "number"
98
+ "type": "integer",
99
+ "minimum": 86400
80
100
  },
81
101
  "member": {
82
- "type": "number"
102
+ "type": "integer",
103
+ "minimum": 0
83
104
  },
84
105
  "payload": {
85
- "type": "number"
106
+ "type": "integer",
107
+ "minimum": 0
108
+ },
109
+ "storage": {
110
+ "type": "integer",
111
+ "minimum": 0
86
112
  },
87
113
  "notebookMinutesPerRun": {
88
- "type": "number"
114
+ "type": "integer",
115
+ "minimum": 0
89
116
  },
90
117
  "notebookMinutesPerMonth": {
91
- "type": "number"
118
+ "type": "integer",
119
+ "minimum": 0
92
120
  },
93
121
  "notebookInParallel": {
94
- "type": "number"
122
+ "type": "integer",
123
+ "minimum": 0
124
+ },
125
+ "experienceFlowSlots": {
126
+ "type": "integer",
127
+ "minimum": 0
128
+ },
129
+ "applicationFlowSlots": {
130
+ "type": "integer",
131
+ "minimum": 0
95
132
  }
96
- }
133
+ },
134
+ "additionalProperties": false
97
135
  },
98
136
  "whitelistedEmailDomains": {
99
137
  "type": "array",
data/schemas/instanceOrgPost.json CHANGED
@@ -19,85 +19,123 @@
19
19
  "type": "object",
20
20
  "properties": {
21
21
  "apitoken": {
22
- "type": "number"
22
+ "type": "integer",
23
+ "minimum": 0
23
24
  },
24
25
  "application": {
25
- "type": "number"
26
+ "type": "integer",
27
+ "minimum": 0
26
28
  },
27
29
  "applicationkey": {
28
- "type": "number"
30
+ "type": "integer",
31
+ "minimum": 0
29
32
  },
30
33
  "dashboard": {
31
- "type": "number"
34
+ "type": "integer",
35
+ "minimum": 0
32
36
  },
33
37
  "datatable": {
34
- "type": "number"
38
+ "type": "integer",
39
+ "minimum": 0
35
40
  },
36
41
  "device": {
37
- "type": "number"
42
+ "type": "integer",
43
+ "minimum": 0
38
44
  },
39
45
  "devicerecipe": {
40
- "type": "number"
46
+ "type": "integer",
47
+ "minimum": 0
41
48
  },
42
49
  "experiencedomain": {
43
- "type": "number"
50
+ "type": "integer",
51
+ "minimum": 0
44
52
  },
45
53
  "experienceendpoint": {
46
- "type": "number"
54
+ "type": "integer",
55
+ "minimum": 0
47
56
  },
48
57
  "experiencegroup": {
49
- "type": "number"
58
+ "type": "integer",
59
+ "minimum": 0
50
60
  },
51
61
  "experienceslug": {
52
- "type": "number"
62
+ "type": "integer",
63
+ "minimum": 0
53
64
  },
54
65
  "experienceuser": {
55
- "type": "number"
66
+ "type": "integer",
67
+ "minimum": 0
56
68
  },
57
69
  "experienceversion": {
58
- "type": "number"
70
+ "type": "integer",
71
+ "minimum": 0
59
72
  },
60
73
  "experienceview": {
61
- "type": "number"
74
+ "type": "integer",
75
+ "minimum": 0
62
76
  },
63
77
  "file": {
64
- "type": "number"
78
+ "type": "integer",
79
+ "minimum": 0
65
80
  },
66
81
  "flow": {
67
- "type": "number"
82
+ "type": "integer",
83
+ "minimum": 0
68
84
  },
69
85
  "integration": {
70
- "type": "number"
86
+ "type": "integer",
87
+ "minimum": 0
71
88
  },
72
89
  "notebook": {
73
- "type": "number"
90
+ "type": "integer",
91
+ "minimum": 0
74
92
  },
75
93
  "webhook": {
76
- "type": "number"
94
+ "type": "integer",
95
+ "minimum": 0
77
96
  },
78
97
  "dataTTL": {
79
- "type": "number"
98
+ "type": "integer",
99
+ "minimum": 86400
80
100
  },
81
101
  "member": {
82
- "type": "number"
102
+ "type": "integer",
103
+ "minimum": 0
83
104
  },
84
105
  "payload": {
85
- "type": "number"
106
+ "type": "integer",
107
+ "minimum": 0
108
+ },
109
+ "storage": {
110
+ "type": "integer",
111
+ "minimum": 0
86
112
  },
87
113
  "notebookMinutesPerRun": {
88
- "type": "number"
114
+ "type": "integer",
115
+ "minimum": 0
89
116
  },
90
117
  "notebookMinutesPerMonth": {
91
- "type": "number"
118
+ "type": "integer",
119
+ "minimum": 0
92
120
  },
93
121
  "notebookInParallel": {
94
- "type": "number"
122
+ "type": "integer",
123
+ "minimum": 0
124
+ },
125
+ "experienceFlowSlots": {
126
+ "type": "integer",
127
+ "minimum": 0
128
+ },
129
+ "applicationFlowSlots": {
130
+ "type": "integer",
131
+ "minimum": 0
95
132
  }
96
- }
133
+ },
134
+ "additionalProperties": false
97
135
  },
98
136
  "members": {
99
137
  "type": "array",
100
- "max": "10",
138
+ "maxItems": "10",
101
139
  "items": {
102
140
  "title": "Instance Org Member Post",
103
141
  "description": "Schema for an Instance Organization member creation request",