losant_rest 1.7.2 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +7347 -4603
  3. data/docs/application.md +47 -0
  4. data/docs/applicationApiToken.md +3 -0
  5. data/docs/applicationApiTokens.md +2 -0
  6. data/docs/applicationKey.md +3 -0
  7. data/docs/applicationKeys.md +2 -0
  8. data/docs/applications.md +2 -0
  9. data/docs/auditLog.md +1 -0
  10. data/docs/auditLogs.md +1 -0
  11. data/docs/auth.md +4 -0
  12. data/docs/dashboard.md +4 -0
  13. data/docs/dashboards.md +2 -0
  14. data/docs/data.md +2 -0
  15. data/docs/dataTable.md +5 -0
  16. data/docs/dataTableRow.md +3 -0
  17. data/docs/dataTableRows.md +9 -3
  18. data/docs/dataTables.md +2 -0
  19. data/docs/device.md +12 -0
  20. data/docs/deviceRecipe.md +4 -0
  21. data/docs/deviceRecipes.md +2 -0
  22. data/docs/devices.md +4 -0
  23. data/docs/edgeDeployments.md +4 -0
  24. data/docs/event.md +3 -0
  25. data/docs/events.md +4 -0
  26. data/docs/experience.md +52 -8
  27. data/docs/experienceDomain.md +3 -0
  28. data/docs/experienceDomains.md +2 -0
  29. data/docs/experienceEndpoint.md +4 -0
  30. data/docs/experienceEndpoints.md +9 -1
  31. data/docs/experienceGroup.md +3 -0
  32. data/docs/experienceGroups.md +2 -0
  33. data/docs/experienceSlug.md +133 -0
  34. data/docs/experienceSlugs.md +87 -0
  35. data/docs/experienceUser.md +3 -0
  36. data/docs/experienceUsers.md +2 -0
  37. data/docs/experienceVersion.md +133 -0
  38. data/docs/experienceVersions.md +93 -0
  39. data/docs/experienceView.md +4 -0
  40. data/docs/experienceViews.md +3 -0
  41. data/docs/file.md +4 -0
  42. data/docs/files.md +2 -0
  43. data/docs/flow.md +8 -0
  44. data/docs/flowVersion.md +4 -0
  45. data/docs/flowVersions.md +2 -0
  46. data/docs/flows.md +54 -1
  47. data/docs/integration.md +3 -0
  48. data/docs/integrations.md +2 -0
  49. data/docs/me.md +19 -3
  50. data/docs/org.md +10 -0
  51. data/docs/orgInvites.md +2 -0
  52. data/docs/orgs.md +2 -0
  53. data/docs/solution.md +3 -0
  54. data/docs/solutionUser.md +3 -0
  55. data/docs/solutionUsers.md +2 -0
  56. data/docs/solutions.md +2 -0
  57. data/docs/webhook.md +3 -0
  58. data/docs/webhooks.md +2 -0
  59. data/lib/losant_rest/application.rb +47 -0
  60. data/lib/losant_rest/client.rb +18 -2
  61. data/lib/losant_rest/data_table_rows.rb +3 -3
  62. data/lib/losant_rest/experience.rb +62 -11
  63. data/lib/losant_rest/experience_endpoint.rb +2 -0
  64. data/lib/losant_rest/experience_endpoints.rb +11 -1
  65. data/lib/losant_rest/experience_slug.rb +174 -0
  66. data/lib/losant_rest/experience_slugs.rb +124 -0
  67. data/lib/losant_rest/experience_version.rb +174 -0
  68. data/lib/losant_rest/experience_versions.rb +136 -0
  69. data/lib/losant_rest/experience_view.rb +2 -0
  70. data/lib/losant_rest/experience_views.rb +2 -0
  71. data/lib/losant_rest/flows.rb +66 -1
  72. data/lib/losant_rest/version.rb +1 -1
  73. data/lib/losant_rest.rb +4 -0
  74. data/schemas/apiTokens.json +128 -0
  75. data/schemas/application.json +6 -0
  76. data/schemas/applicationApiTokenPost.json +18 -0
  77. data/schemas/applications.json +6 -0
  78. data/schemas/dataTableRowInMultiple.json +20 -0
  79. data/schemas/dataTableRowInsert.json +42 -0
  80. data/schemas/dataTableRowInsertResult.json +54 -0
  81. data/schemas/edgeDeployment.json +119 -0
  82. data/schemas/emailVerificationVerify.json +20 -0
  83. data/schemas/experienceBootstrapOptions.json +25 -0
  84. data/schemas/experienceBootstrapResult.json +16 -0
  85. data/schemas/experienceDomain.json +5 -0
  86. data/schemas/experienceDomainPatch.json +12 -0
  87. data/schemas/experienceDomainPost.json +12 -0
  88. data/schemas/experienceDomains.json +5 -0
  89. data/schemas/experienceSlug.json +37 -0
  90. data/schemas/experienceSlugPatch.json +25 -0
  91. data/schemas/experienceSlugPost.json +28 -0
  92. data/schemas/experienceSlugs.json +57 -0
  93. data/schemas/experienceVersion.json +82 -0
  94. data/schemas/experienceVersionPatch.json +19 -0
  95. data/schemas/experienceVersionPost.json +35 -0
  96. data/schemas/experienceVersions.json +102 -0
  97. data/schemas/file.json +3 -0
  98. data/schemas/files.json +3 -0
  99. data/schemas/flow.json +5 -0
  100. data/schemas/flowPatch.json +1 -0
  101. data/schemas/flowPost.json +2 -0
  102. data/schemas/flowVersion.json +622 -433
  103. data/schemas/flowVersionPost.json +1 -0
  104. data/schemas/flowVersions.json +622 -433
  105. data/schemas/flows.json +6 -0
  106. data/schemas/flowsImportPost.json +3 -0
  107. data/schemas/flowsImportResult.json +628 -434
  108. data/schemas/githubLogin.json +18 -0
  109. data/schemas/me.json +12 -0
  110. data/schemas/mqttPublishBody.json +20 -0
  111. data/schemas/org.json +12 -0
  112. data/schemas/orgs.json +12 -0
  113. data/schemas/passwordResetFinish.json +31 -0
  114. data/schemas/passwordResetInput.json +19 -0
  115. data/schemas/passwordResetResponse.json +18 -0
  116. data/schemas/solutionMe.json +150 -0
  117. data/schemas/userCredentials.json +18 -0
  118. data/schemas/userPost.json +388 -0
  119. metadata +32 -2
data/schemas/githubLogin.json CHANGED
@@ -44,8 +44,12 @@
44
44
  "experienceEndpoints.*",
45
45
  "experienceGroup.*",
46
46
  "experienceGroups.*",
47
+ "experienceSlug.*",
48
+ "experienceSlugs.*",
47
49
  "experienceUser.*",
48
50
  "experienceUsers.*",
51
+ "experienceVersion.*",
52
+ "experienceVersions.*",
49
53
  "experienceView.*",
50
54
  "experienceViews.*",
51
55
  "integration.*",
@@ -63,6 +67,8 @@
63
67
  "application.debug",
64
68
  "application.delete",
65
69
  "application.get",
70
+ "application.mqttPublishMessage",
71
+ "application.mqttSubscriptionStream",
66
72
  "application.patch",
67
73
  "application.payloadCounts",
68
74
  "applicationApiToken.delete",
@@ -131,6 +137,7 @@
131
137
  "events.patch",
132
138
  "events.post",
133
139
  "experience.delete",
140
+ "experience.bootstrap",
134
141
  "experienceDomain.delete",
135
142
  "experienceDomain.get",
136
143
  "experienceDomain.patch",
@@ -148,12 +155,22 @@
148
155
  "experienceGroups.detailedSummary",
149
156
  "experienceGroups.get",
150
157
  "experienceGroups.post",
158
+ "experienceSlug.delete",
159
+ "experienceSlug.get",
160
+ "experienceSlug.patch",
161
+ "experienceSlugs.get",
162
+ "experienceSlugs.post",
151
163
  "experienceUser.delete",
152
164
  "experienceUser.get",
153
165
  "experienceUser.patch",
154
166
  "experienceUsers.detailedSummary",
155
167
  "experienceUsers.get",
156
168
  "experienceUsers.post",
169
+ "experienceVersion.delete",
170
+ "experienceVersion.get",
171
+ "experienceVersion.patch",
172
+ "experienceVersions.get",
173
+ "experienceVersions.post",
157
174
  "experienceView.debug",
158
175
  "experienceView.delete",
159
176
  "experienceView.get",
@@ -178,6 +195,7 @@
178
195
  "flow.pressVirtualButton",
179
196
  "flow.setStorageEntry",
180
197
  "flows.get",
198
+ "flows.getByVersion",
181
199
  "flows.import",
182
200
  "flows.post",
183
201
  "flowVersion.delete",
data/schemas/me.json CHANGED
@@ -111,9 +111,15 @@
111
111
  "experiencegroup": {
112
112
  "type": "number"
113
113
  },
114
+ "experienceslug": {
115
+ "type": "number"
116
+ },
114
117
  "experienceuser": {
115
118
  "type": "number"
116
119
  },
120
+ "experienceversion": {
121
+ "type": "number"
122
+ },
117
123
  "experienceview": {
118
124
  "type": "number"
119
125
  },
@@ -283,9 +289,15 @@
283
289
  "experienceGroupCount": {
284
290
  "type": "number"
285
291
  },
292
+ "experienceSlugCount": {
293
+ "type": "number"
294
+ },
286
295
  "experienceUserCount": {
287
296
  "type": "number"
288
297
  },
298
+ "experienceVersionCount": {
299
+ "type": "number"
300
+ },
289
301
  "experienceViewCount": {
290
302
  "type": "number"
291
303
  },
data/schemas/mqttPublishBody.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "topic": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 230
9
+ },
10
+ "message": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ }
14
+ },
15
+ "required": [
16
+ "topic",
17
+ "message"
18
+ ],
19
+ "additionalProperties": false
20
+ }
data/schemas/org.json CHANGED
@@ -154,9 +154,15 @@
154
154
  "experiencegroup": {
155
155
  "type": "number"
156
156
  },
157
+ "experienceslug": {
158
+ "type": "number"
159
+ },
157
160
  "experienceuser": {
158
161
  "type": "number"
159
162
  },
163
+ "experienceversion": {
164
+ "type": "number"
165
+ },
160
166
  "experienceview": {
161
167
  "type": "number"
162
168
  },
@@ -218,9 +224,15 @@
218
224
  "experienceGroupCount": {
219
225
  "type": "number"
220
226
  },
227
+ "experienceSlugCount": {
228
+ "type": "number"
229
+ },
221
230
  "experienceUserCount": {
222
231
  "type": "number"
223
232
  },
233
+ "experienceVersionCount": {
234
+ "type": "number"
235
+ },
224
236
  "experienceViewCount": {
225
237
  "type": "number"
226
238
  },
data/schemas/orgs.json CHANGED
@@ -161,9 +161,15 @@
161
161
  "experiencegroup": {
162
162
  "type": "number"
163
163
  },
164
+ "experienceslug": {
165
+ "type": "number"
166
+ },
164
167
  "experienceuser": {
165
168
  "type": "number"
166
169
  },
170
+ "experienceversion": {
171
+ "type": "number"
172
+ },
167
173
  "experienceview": {
168
174
  "type": "number"
169
175
  },
@@ -225,9 +231,15 @@
225
231
  "experienceGroupCount": {
226
232
  "type": "number"
227
233
  },
234
+ "experienceSlugCount": {
235
+ "type": "number"
236
+ },
228
237
  "experienceUserCount": {
229
238
  "type": "number"
230
239
  },
240
+ "experienceVersionCount": {
241
+ "type": "number"
242
+ },
231
243
  "experienceViewCount": {
232
244
  "type": "number"
233
245
  },
data/schemas/passwordResetFinish.json ADDED
@@ -0,0 +1,31 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "token": {
6
+ "type": "string",
7
+ "minLength": 1
8
+ },
9
+ "email": {
10
+ "type": "string",
11
+ "format": "email",
12
+ "maxLength": 1024
13
+ },
14
+ "password": {
15
+ "type": "string",
16
+ "minLength": 8,
17
+ "maxLength": 2048,
18
+ "pattern": "^(?=.*[A-Z])(?=.*[^A-z0-9])(?=.*[0-9])(?=.*[a-z]).{8,}$"
19
+ },
20
+ "solutionId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ }
24
+ },
25
+ "required": [
26
+ "token",
27
+ "email",
28
+ "password"
29
+ ],
30
+ "additionalProperties": false
31
+ }
data/schemas/passwordResetInput.json ADDED
@@ -0,0 +1,19 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "email": {
6
+ "type": "string",
7
+ "format": "email",
8
+ "maxLength": 1024
9
+ },
10
+ "solutionId": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ }
14
+ },
15
+ "required": [
16
+ "email"
17
+ ],
18
+ "additionalProperties": false
19
+ }
data/schemas/passwordResetResponse.json ADDED
@@ -0,0 +1,18 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "success": {
6
+ "type": "boolean",
7
+ "enum": [
8
+ true
9
+ ]
10
+ },
11
+ "accountIsLocked": {
12
+ "type": "boolean"
13
+ },
14
+ "twoFactorAuthEnabled": {
15
+ "type": "boolean"
16
+ }
17
+ }
18
+ }
data/schemas/solutionMe.json ADDED
@@ -0,0 +1,150 @@
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
+ "solutionUserId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "creationDate": {
14
+ "type": "string",
15
+ "format": "date-time"
16
+ },
17
+ "lastUpdated": {
18
+ "type": "string",
19
+ "format": "date-time"
20
+ },
21
+ "passwordLastUpdated": {
22
+ "type": "string",
23
+ "format": "date-time"
24
+ },
25
+ "lastLogin": {
26
+ "type": "string",
27
+ "format": "date-time"
28
+ },
29
+ "email": {
30
+ "type": "string",
31
+ "format": "email",
32
+ "maxLength": 1024
33
+ },
34
+ "firstName": {
35
+ "type": "string",
36
+ "minLength": 1,
37
+ "maxLength": 1024
38
+ },
39
+ "lastName": {
40
+ "type": "string",
41
+ "minLength": 1,
42
+ "maxLength": 1024
43
+ },
44
+ "companyName": {
45
+ "type": "string",
46
+ "maxLength": 1024
47
+ },
48
+ "title": {
49
+ "type": "string",
50
+ "maxLength": 1024
51
+ },
52
+ "phoneNumber": {
53
+ "type": "string",
54
+ "maxLength": 1024
55
+ },
56
+ "location": {
57
+ "type": "string",
58
+ "maxLength": 1024
59
+ },
60
+ "url": {
61
+ "type": "string",
62
+ "maxLength": 1024
63
+ },
64
+ "forcePasswordResetOnNextLogin": {
65
+ "type": "boolean"
66
+ },
67
+ "fullName": {
68
+ "type": "string"
69
+ },
70
+ "twoFactorAuthEnabled": {
71
+ "type": "boolean"
72
+ },
73
+ "avatarUrl": {
74
+ "type": "string",
75
+ "format": "url"
76
+ },
77
+ "accessRestrictions": {
78
+ "type": "object",
79
+ "properties": {
80
+ "dashboardIds": {
81
+ "type": "array",
82
+ "items": {
83
+ "type": "string",
84
+ "pattern": "^[A-Fa-f\\d]{24}$"
85
+ },
86
+ "maxItems": 1000
87
+ }
88
+ }
89
+ },
90
+ "recentDashboards": {
91
+ "title": "Recent Item List",
92
+ "description": "Schema for an array of recent items",
93
+ "type": "object",
94
+ "properties": {
95
+ "itemType": {
96
+ "type": "string",
97
+ "enum": [
98
+ "application",
99
+ "device",
100
+ "flow",
101
+ "dashboard",
102
+ "organization"
103
+ ]
104
+ },
105
+ "parentId": {
106
+ "type": "string",
107
+ "pattern": "^[A-Fa-f\\d]{24}$"
108
+ },
109
+ "items": {
110
+ "type": "array",
111
+ "items": {
112
+ "type": "object",
113
+ "properties": {
114
+ "id": {
115
+ "type": "string",
116
+ "pattern": "^[A-Fa-f\\d]{24}$"
117
+ },
118
+ "name": {
119
+ "type": "string",
120
+ "minLength": 1,
121
+ "maxLength": 255
122
+ }
123
+ }
124
+ }
125
+ }
126
+ }
127
+ },
128
+ "solution": {
129
+ "id": {
130
+ "type": "string",
131
+ "pattern": "^[A-Fa-f\\d]{24}$"
132
+ },
133
+ "slug": {
134
+ "type": "string",
135
+ "pattern": "^[0-9a-z_-]{1,255}$"
136
+ },
137
+ "name": {
138
+ "type": "string",
139
+ "minLength": 1,
140
+ "maxLength": 255
141
+ },
142
+ "allowSelfDeletion": {
143
+ "type": "boolean"
144
+ },
145
+ "allowSelfEmailChange": {
146
+ "type": "boolean"
147
+ }
148
+ }
149
+ }
150
+ }
data/schemas/userCredentials.json CHANGED
@@ -54,8 +54,12 @@
54
54
  "experienceEndpoints.*",
55
55
  "experienceGroup.*",
56
56
  "experienceGroups.*",
57
+ "experienceSlug.*",
58
+ "experienceSlugs.*",
57
59
  "experienceUser.*",
58
60
  "experienceUsers.*",
61
+ "experienceVersion.*",
62
+ "experienceVersions.*",
59
63
  "experienceView.*",
60
64
  "experienceViews.*",
61
65
  "integration.*",
@@ -73,6 +77,8 @@
73
77
  "application.debug",
74
78
  "application.delete",
75
79
  "application.get",
80
+ "application.mqttPublishMessage",
81
+ "application.mqttSubscriptionStream",
76
82
  "application.patch",
77
83
  "application.payloadCounts",
78
84
  "applicationApiToken.delete",
@@ -141,6 +147,7 @@
141
147
  "events.patch",
142
148
  "events.post",
143
149
  "experience.delete",
150
+ "experience.bootstrap",
144
151
  "experienceDomain.delete",
145
152
  "experienceDomain.get",
146
153
  "experienceDomain.patch",
@@ -158,12 +165,22 @@
158
165
  "experienceGroups.detailedSummary",
159
166
  "experienceGroups.get",
160
167
  "experienceGroups.post",
168
+ "experienceSlug.delete",
169
+ "experienceSlug.get",
170
+ "experienceSlug.patch",
171
+ "experienceSlugs.get",
172
+ "experienceSlugs.post",
161
173
  "experienceUser.delete",
162
174
  "experienceUser.get",
163
175
  "experienceUser.patch",
164
176
  "experienceUsers.detailedSummary",
165
177
  "experienceUsers.get",
166
178
  "experienceUsers.post",
179
+ "experienceVersion.delete",
180
+ "experienceVersion.get",
181
+ "experienceVersion.patch",
182
+ "experienceVersions.get",
183
+ "experienceVersions.post",
167
184
  "experienceView.debug",
168
185
  "experienceView.delete",
169
186
  "experienceView.get",
@@ -188,6 +205,7 @@
188
205
  "flow.pressVirtualButton",
189
206
  "flow.setStorageEntry",
190
207
  "flows.get",
208
+ "flows.getByVersion",
191
209
  "flows.import",
192
210
  "flows.post",
193
211
  "flowVersion.delete",