losant_rest 1.3.3 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. checksums.yaml +4 -4
  2. data/.markdownlint.json +11 -0
  3. data/README.md +139 -231
  4. data/docs/_schemas.md +1036 -393
  5. data/docs/dataTableRows.md +41 -0
  6. data/docs/deviceRecipe.md +1 -0
  7. data/docs/{experienceTemplate.md → experienceDomain.md} +25 -25
  8. data/docs/experienceDomains.md +85 -0
  9. data/docs/experienceView.md +130 -0
  10. data/docs/{experienceTemplates.md → experienceViews.md} +15 -15
  11. data/docs/me.md +36 -0
  12. data/lib/losant_rest.rb +4 -2
  13. data/lib/losant_rest/client.rb +18 -10
  14. data/lib/losant_rest/data_table_rows.rb +48 -0
  15. data/lib/losant_rest/device_recipe.rb +1 -0
  16. data/lib/losant_rest/{experience_template.rb → experience_domain.rb} +26 -26
  17. data/lib/losant_rest/experience_domains.rb +124 -0
  18. data/lib/losant_rest/experience_view.rb +174 -0
  19. data/lib/losant_rest/{experience_templates.rb → experience_views.rb} +16 -16
  20. data/lib/losant_rest/me.rb +44 -0
  21. data/lib/losant_rest/version.rb +1 -1
  22. data/schemas/application.json +34 -2
  23. data/schemas/applicationApiTokenPost.json +14 -7
  24. data/schemas/applicationPatch.json +29 -0
  25. data/schemas/applications.json +34 -2
  26. data/schemas/auditLog.json +2 -1
  27. data/schemas/auditLogFilter.json +2 -1
  28. data/schemas/auditLogs.json +2 -1
  29. data/schemas/changePassword.json +28 -0
  30. data/schemas/dataTableRowsExport.json +36 -0
  31. data/schemas/deviceRecipeBulkCreateEnqueued.json +9 -0
  32. data/schemas/deviceRecipeBulkCreatePost.json +5 -0
  33. data/schemas/experienceDomain.json +41 -0
  34. data/schemas/experienceDomainPatch.json +27 -0
  35. data/schemas/experienceDomainPost.json +30 -0
  36. data/schemas/experienceDomains.json +61 -0
  37. data/schemas/experienceEndpoint.json +11 -0
  38. data/schemas/experienceEndpointPatch.json +11 -0
  39. data/schemas/experienceEndpointPost.json +11 -0
  40. data/schemas/experienceEndpoints.json +11 -0
  41. data/schemas/experienceGroup.json +11 -0
  42. data/schemas/experienceGroupPatch.json +11 -0
  43. data/schemas/experienceGroupPost.json +11 -0
  44. data/schemas/experienceGroups.json +11 -0
  45. data/schemas/{experienceTemplate.json → experienceView.json} +8 -3
  46. data/schemas/{experienceTemplatePatch.json → experienceViewPatch.json} +1 -1
  47. data/schemas/{experienceTemplatePost.json → experienceViewPost.json} +3 -3
  48. data/schemas/{experienceTemplates.json → experienceViews.json} +11 -6
  49. data/schemas/me.json +10 -4
  50. data/schemas/org.json +10 -4
  51. data/schemas/orgs.json +10 -4
  52. data/schemas/solutionUser.json +4 -0
  53. data/schemas/solutionUserPatch.json +4 -0
  54. data/schemas/solutionUserPost.json +4 -0
  55. data/schemas/solutionUsers.json +4 -0
  56. metadata +22 -10
data/schemas/experienceEndpoints.json CHANGED
@@ -60,6 +60,17 @@
60
60
  "group"
61
61
  ]
62
62
  },
63
+ "endpointTags": {
64
+ "type": "object",
65
+ "patternProperties": {
66
+ "^[0-9a-zA-Z_-]{1,255}$": {
67
+ "type": "string",
68
+ "minLength": 1,
69
+ "maxLength": 255
70
+ }
71
+ },
72
+ "additionalProperties": false
73
+ },
63
74
  "experienceGroups": {
64
75
  "type": "array",
65
76
  "items": {
data/schemas/experienceGroup.json CHANGED
@@ -46,6 +46,17 @@
46
46
  "pattern": "^[A-Fa-f\\d]{24}$"
47
47
  },
48
48
  "maxItems": 1000
49
+ },
50
+ "groupTags": {
51
+ "type": "object",
52
+ "patternProperties": {
53
+ "^[0-9a-zA-Z_-]{1,255}$": {
54
+ "type": "string",
55
+ "minLength": 1,
56
+ "maxLength": 255
57
+ }
58
+ },
59
+ "additionalProperties": false
49
60
  }
50
61
  }
51
62
  }
data/schemas/experienceGroupPatch.json CHANGED
@@ -26,6 +26,17 @@
26
26
  "pattern": "^[A-Fa-f\\d]{24}$"
27
27
  },
28
28
  "maxItems": 1000
29
+ },
30
+ "groupTags": {
31
+ "type": "object",
32
+ "patternProperties": {
33
+ "^[0-9a-zA-Z_-]{1,255}$": {
34
+ "type": "string",
35
+ "minLength": 1,
36
+ "maxLength": 255
37
+ }
38
+ },
39
+ "additionalProperties": false
29
40
  }
30
41
  },
31
42
  "additionalProperties": false
data/schemas/experienceGroupPost.json CHANGED
@@ -26,6 +26,17 @@
26
26
  "pattern": "^[A-Fa-f\\d]{24}$"
27
27
  },
28
28
  "maxItems": 1000
29
+ },
30
+ "groupTags": {
31
+ "type": "object",
32
+ "patternProperties": {
33
+ "^[0-9a-zA-Z_-]{1,255}$": {
34
+ "type": "string",
35
+ "minLength": 1,
36
+ "maxLength": 255
37
+ }
38
+ },
39
+ "additionalProperties": false
29
40
  }
30
41
  },
31
42
  "additionalProperties": false,
data/schemas/experienceGroups.json CHANGED
@@ -53,6 +53,17 @@
53
53
  "pattern": "^[A-Fa-f\\d]{24}$"
54
54
  },
55
55
  "maxItems": 1000
56
+ },
57
+ "groupTags": {
58
+ "type": "object",
59
+ "patternProperties": {
60
+ "^[0-9a-zA-Z_-]{1,255}$": {
61
+ "type": "string",
62
+ "minLength": 1,
63
+ "maxLength": 255
64
+ }
65
+ },
66
+ "additionalProperties": false
56
67
  }
57
68
  }
58
69
  }
data/schemas/{experienceTemplate.json → experienceView.json} RENAMED
@@ -6,7 +6,7 @@
6
6
  "type": "string",
7
7
  "pattern": "^[A-Fa-f\\d]{24}$"
8
8
  },
9
- "experienceTemplateId": {
9
+ "experienceViewId": {
10
10
  "type": "string",
11
11
  "pattern": "^[A-Fa-f\\d]{24}$"
12
12
  },
@@ -31,7 +31,7 @@
31
31
  "type": "string",
32
32
  "maxLength": 32767
33
33
  },
34
- "templateType": {
34
+ "viewType": {
35
35
  "type": "string",
36
36
  "enum": [
37
37
  "layout",
@@ -46,12 +46,17 @@
46
46
  ],
47
47
  "pattern": "^[A-Fa-f\\d]{24}$"
48
48
  },
49
+ "layoutName": {
50
+ "type": "string",
51
+ "minLength": 1,
52
+ "maxLength": 255
53
+ },
49
54
  "body": {
50
55
  "type": "string",
51
56
  "maxLength": 131072,
52
57
  "minLength": 1
53
58
  },
54
- "templateTags": {
59
+ "viewTags": {
55
60
  "type": "object",
56
61
  "patternProperties": {
57
62
  "^[0-9a-zA-Z_-]{1,255}$": {
data/schemas/{experienceTemplatePatch.json → experienceViewPatch.json} RENAMED
@@ -23,7 +23,7 @@
23
23
  "maxLength": 131072,
24
24
  "minLength": 1
25
25
  },
26
- "templateTags": {
26
+ "viewTags": {
27
27
  "type": "object",
28
28
  "patternProperties": {
29
29
  "^[0-9a-zA-Z_-]{1,255}$": {
data/schemas/{experienceTemplatePost.json → experienceViewPost.json} RENAMED
@@ -11,7 +11,7 @@
11
11
  "type": "string",
12
12
  "maxLength": 32767
13
13
  },
14
- "templateType": {
14
+ "viewType": {
15
15
  "type": "string",
16
16
  "enum": [
17
17
  "layout",
@@ -31,7 +31,7 @@
31
31
  "maxLength": 131072,
32
32
  "minLength": 1
33
33
  },
34
- "templateTags": {
34
+ "viewTags": {
35
35
  "type": "object",
36
36
  "patternProperties": {
37
37
  "^[0-9a-zA-Z_-]{1,255}$": {
@@ -46,7 +46,7 @@
46
46
  "additionalProperties": false,
47
47
  "required": [
48
48
  "name",
49
- "templateType",
49
+ "viewType",
50
50
  "body"
51
51
  ]
52
52
  }
data/schemas/{experienceTemplates.json → experienceViews.json} RENAMED
@@ -5,15 +5,15 @@
5
5
  "items": {
6
6
  "type": "array",
7
7
  "items": {
8
- "title": "Experience Template",
9
- "description": "Schema for a single Experience Template",
8
+ "title": "Experience View",
9
+ "description": "Schema for a single Experience View",
10
10
  "type": "object",
11
11
  "properties": {
12
12
  "id": {
13
13
  "type": "string",
14
14
  "pattern": "^[A-Fa-f\\d]{24}$"
15
15
  },
16
- "experienceTemplateId": {
16
+ "experienceViewId": {
17
17
  "type": "string",
18
18
  "pattern": "^[A-Fa-f\\d]{24}$"
19
19
  },
@@ -38,7 +38,7 @@
38
38
  "type": "string",
39
39
  "maxLength": 32767
40
40
  },
41
- "templateType": {
41
+ "viewType": {
42
42
  "type": "string",
43
43
  "enum": [
44
44
  "layout",
@@ -53,12 +53,17 @@
53
53
  ],
54
54
  "pattern": "^[A-Fa-f\\d]{24}$"
55
55
  },
56
+ "layoutName": {
57
+ "type": "string",
58
+ "minLength": 1,
59
+ "maxLength": 255
60
+ },
56
61
  "body": {
57
62
  "type": "string",
58
63
  "maxLength": 131072,
59
64
  "minLength": 1
60
65
  },
61
- "templateTags": {
66
+ "viewTags": {
62
67
  "type": "object",
63
68
  "patternProperties": {
64
69
  "^[0-9a-zA-Z_-]{1,255}$": {
@@ -104,7 +109,7 @@
104
109
  "type": "string",
105
110
  "pattern": "^[A-Fa-f\\d]{24}$"
106
111
  },
107
- "templateType": {
112
+ "viewType": {
108
113
  "type": "string",
109
114
  "enum": [
110
115
  "layout",
data/schemas/me.json CHANGED
@@ -98,16 +98,19 @@
98
98
  "devicerecipe": {
99
99
  "type": "number"
100
100
  },
101
+ "experiencedomain": {
102
+ "type": "number"
103
+ },
101
104
  "experienceendpoint": {
102
105
  "type": "number"
103
106
  },
104
107
  "experiencegroup": {
105
108
  "type": "number"
106
109
  },
107
- "experiencetemplate": {
110
+ "experienceuser": {
108
111
  "type": "number"
109
112
  },
110
- "experienceuser": {
113
+ "experienceview": {
111
114
  "type": "number"
112
115
  },
113
116
  "flow": {
@@ -264,16 +267,19 @@
264
267
  "deviceRecipeCount": {
265
268
  "type": "number"
266
269
  },
270
+ "experienceDomainCount": {
271
+ "type": "number"
272
+ },
267
273
  "experienceEndpointCount": {
268
274
  "type": "number"
269
275
  },
270
276
  "experienceGroupCount": {
271
277
  "type": "number"
272
278
  },
273
- "experienceTemplateCount": {
279
+ "experienceUserCount": {
274
280
  "type": "number"
275
281
  },
276
- "experienceUserCount": {
282
+ "experienceViewCount": {
277
283
  "type": "number"
278
284
  },
279
285
  "flowCount": {
data/schemas/org.json CHANGED
@@ -91,16 +91,19 @@
91
91
  "devicerecipe": {
92
92
  "type": "number"
93
93
  },
94
+ "experiencedomain": {
95
+ "type": "number"
96
+ },
94
97
  "experienceendpoint": {
95
98
  "type": "number"
96
99
  },
97
100
  "experiencegroup": {
98
101
  "type": "number"
99
102
  },
100
- "experiencetemplate": {
103
+ "experienceuser": {
101
104
  "type": "number"
102
105
  },
103
- "experienceuser": {
106
+ "experienceview": {
104
107
  "type": "number"
105
108
  },
106
109
  "flow": {
@@ -149,16 +152,19 @@
149
152
  "deviceRecipeCount": {
150
153
  "type": "number"
151
154
  },
155
+ "experienceDomainCount": {
156
+ "type": "number"
157
+ },
152
158
  "experienceEndpointCount": {
153
159
  "type": "number"
154
160
  },
155
161
  "experienceGroupCount": {
156
162
  "type": "number"
157
163
  },
158
- "experienceTemplateCount": {
164
+ "experienceUserCount": {
159
165
  "type": "number"
160
166
  },
161
- "experienceUserCount": {
167
+ "experienceViewCount": {
162
168
  "type": "number"
163
169
  },
164
170
  "flowCount": {
data/schemas/orgs.json CHANGED
@@ -98,16 +98,19 @@
98
98
  "devicerecipe": {
99
99
  "type": "number"
100
100
  },
101
+ "experiencedomain": {
102
+ "type": "number"
103
+ },
101
104
  "experienceendpoint": {
102
105
  "type": "number"
103
106
  },
104
107
  "experiencegroup": {
105
108
  "type": "number"
106
109
  },
107
- "experiencetemplate": {
110
+ "experienceuser": {
108
111
  "type": "number"
109
112
  },
110
- "experienceuser": {
113
+ "experienceview": {
111
114
  "type": "number"
112
115
  },
113
116
  "flow": {
@@ -156,16 +159,19 @@
156
159
  "deviceRecipeCount": {
157
160
  "type": "number"
158
161
  },
162
+ "experienceDomainCount": {
163
+ "type": "number"
164
+ },
159
165
  "experienceEndpointCount": {
160
166
  "type": "number"
161
167
  },
162
168
  "experienceGroupCount": {
163
169
  "type": "number"
164
170
  },
165
- "experienceTemplateCount": {
171
+ "experienceUserCount": {
166
172
  "type": "number"
167
173
  },
168
- "experienceUserCount": {
174
+ "experienceViewCount": {
169
175
  "type": "number"
170
176
  },
171
177
  "flowCount": {
data/schemas/solutionUser.json CHANGED
@@ -78,6 +78,10 @@
78
78
  "type": "string",
79
79
  "format": "url"
80
80
  },
81
+ "tokenCutoff": {
82
+ "type": "string",
83
+ "format": "date-time"
84
+ },
81
85
  "accessRestrictions": {
82
86
  "type": "object",
83
87
  "properties": {
data/schemas/solutionUserPatch.json CHANGED
@@ -46,6 +46,10 @@
46
46
  "minLength": 52,
47
47
  "maxLength": 52
48
48
  },
49
+ "tokenCutoff": {
50
+ "type": "string",
51
+ "format": "date-time"
52
+ },
49
53
  "accessRestrictions": {
50
54
  "type": "object",
51
55
  "properties": {
data/schemas/solutionUserPost.json CHANGED
@@ -46,6 +46,10 @@
46
46
  "minLength": 52,
47
47
  "maxLength": 52
48
48
  },
49
+ "tokenCutoff": {
50
+ "type": "string",
51
+ "format": "date-time"
52
+ },
49
53
  "accessRestrictions": {
50
54
  "type": "object",
51
55
  "properties": {
data/schemas/solutionUsers.json CHANGED
@@ -85,6 +85,10 @@
85
85
  "type": "string",
86
86
  "format": "url"
87
87
  },
88
+ "tokenCutoff": {
89
+ "type": "string",
90
+ "format": "date-time"
91
+ },
88
92
  "accessRestrictions": {
89
93
  "type": "object",
90
94
  "properties": {
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: losant_rest
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.3
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Michael Kuehl
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-10-18 00:00:00.000000000 Z
11
+ date: 2017-11-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: httparty
@@ -74,6 +74,7 @@ extensions: []
74
74
  extra_rdoc_files: []
75
75
  files:
76
76
  - ".gitignore"
77
+ - ".markdownlint.json"
77
78
  - ".ruby-version"
78
79
  - ".travis.yml"
79
80
  - Gemfile
@@ -103,14 +104,16 @@ files:
103
104
  - docs/devices.md
104
105
  - docs/event.md
105
106
  - docs/events.md
107
+ - docs/experienceDomain.md
108
+ - docs/experienceDomains.md
106
109
  - docs/experienceEndpoint.md
107
110
  - docs/experienceEndpoints.md
108
111
  - docs/experienceGroup.md
109
112
  - docs/experienceGroups.md
110
- - docs/experienceTemplate.md
111
- - docs/experienceTemplates.md
112
113
  - docs/experienceUser.md
113
114
  - docs/experienceUsers.md
115
+ - docs/experienceView.md
116
+ - docs/experienceViews.md
114
117
  - docs/flow.md
115
118
  - docs/flowVersion.md
116
119
  - docs/flowVersions.md
@@ -154,14 +157,16 @@ files:
154
157
  - lib/losant_rest/error.rb
155
158
  - lib/losant_rest/event.rb
156
159
  - lib/losant_rest/events.rb
160
+ - lib/losant_rest/experience_domain.rb
161
+ - lib/losant_rest/experience_domains.rb
157
162
  - lib/losant_rest/experience_endpoint.rb
158
163
  - lib/losant_rest/experience_endpoints.rb
159
164
  - lib/losant_rest/experience_group.rb
160
165
  - lib/losant_rest/experience_groups.rb
161
- - lib/losant_rest/experience_template.rb
162
- - lib/losant_rest/experience_templates.rb
163
166
  - lib/losant_rest/experience_user.rb
164
167
  - lib/losant_rest/experience_users.rb
168
+ - lib/losant_rest/experience_view.rb
169
+ - lib/losant_rest/experience_views.rb
165
170
  - lib/losant_rest/flow.rb
166
171
  - lib/losant_rest/flow_version.rb
167
172
  - lib/losant_rest/flow_versions.rb
@@ -199,6 +204,7 @@ files:
199
204
  - schemas/authedDevice.json
200
205
  - schemas/authedSolutionUser.json
201
206
  - schemas/authedUser.json
207
+ - schemas/changePassword.json
202
208
  - schemas/compositeDeviceState.json
203
209
  - schemas/dashboard.json
204
210
  - schemas/dashboardContextInstance.json
@@ -213,6 +219,7 @@ files:
213
219
  - schemas/dataTableRow.json
214
220
  - schemas/dataTableRowInsertUpdate.json
215
221
  - schemas/dataTableRows.json
222
+ - schemas/dataTableRowsExport.json
216
223
  - schemas/dataTables.json
217
224
  - schemas/device.json
218
225
  - schemas/deviceCommand.json
@@ -223,6 +230,7 @@ files:
223
230
  - schemas/devicePost.json
224
231
  - schemas/deviceRecipe.json
225
232
  - schemas/deviceRecipeBulkCreate.json
233
+ - schemas/deviceRecipeBulkCreateEnqueued.json
226
234
  - schemas/deviceRecipeBulkCreatePost.json
227
235
  - schemas/deviceRecipePatch.json
228
236
  - schemas/deviceRecipePost.json
@@ -238,6 +246,10 @@ files:
238
246
  - schemas/eventPatch.json
239
247
  - schemas/eventPost.json
240
248
  - schemas/events.json
249
+ - schemas/experienceDomain.json
250
+ - schemas/experienceDomainPatch.json
251
+ - schemas/experienceDomainPost.json
252
+ - schemas/experienceDomains.json
241
253
  - schemas/experienceEndpoint.json
242
254
  - schemas/experienceEndpointPatch.json
243
255
  - schemas/experienceEndpointPost.json
@@ -247,14 +259,14 @@ files:
247
259
  - schemas/experienceGroupPatch.json
248
260
  - schemas/experienceGroupPost.json
249
261
  - schemas/experienceGroups.json
250
- - schemas/experienceTemplate.json
251
- - schemas/experienceTemplatePatch.json
252
- - schemas/experienceTemplatePost.json
253
- - schemas/experienceTemplates.json
254
262
  - schemas/experienceUser.json
255
263
  - schemas/experienceUserPatch.json
256
264
  - schemas/experienceUserPost.json
257
265
  - schemas/experienceUsers.json
266
+ - schemas/experienceView.json
267
+ - schemas/experienceViewPatch.json
268
+ - schemas/experienceViewPost.json
269
+ - schemas/experienceViews.json
258
270
  - schemas/flow.json
259
271
  - schemas/flowLog.json
260
272
  - schemas/flowPatch.json