losant_rest 1.10.1 → 1.11.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/_schemas.md +26941 -15658
  4. data/docs/application.md +42 -0
  5. data/docs/applicationApiTokens.md +2 -2
  6. data/docs/applicationCertificateAuthorities.md +1 -1
  7. data/docs/applicationCertificates.md +1 -1
  8. data/docs/applicationKeys.md +1 -1
  9. data/docs/applicationTemplate.md +46 -0
  10. data/docs/applicationTemplates.md +77 -2
  11. data/docs/applications.md +1 -1
  12. data/docs/auditLogs.md +1 -1
  13. data/docs/dashboards.md +1 -1
  14. data/docs/dataTables.md +1 -1
  15. data/docs/device.md +6 -3
  16. data/docs/deviceRecipes.md +1 -1
  17. data/docs/devices.md +217 -5
  18. data/docs/edgeDeployments.md +1 -1
  19. data/docs/events.md +1 -1
  20. data/docs/experienceEndpoints.md +1 -0
  21. data/docs/experienceGroups.md +1 -1
  22. data/docs/experienceUsers.md +1 -1
  23. data/docs/experienceVersions.md +1 -1
  24. data/docs/experienceViews.md +1 -1
  25. data/docs/file.md +4 -4
  26. data/docs/files.md +1 -1
  27. data/docs/flow.md +94 -1
  28. data/docs/flowVersion.md +96 -1
  29. data/docs/flowVersions.md +2 -1
  30. data/docs/flows.md +4 -2
  31. data/docs/integrations.md +1 -1
  32. data/docs/me.md +0 -36
  33. data/docs/notebooks.md +1 -1
  34. data/docs/orgs.md +1 -1
  35. data/docs/webhooks.md +1 -1
  36. data/lib/losant_rest.rb +1 -0
  37. data/lib/losant_rest/application.rb +48 -0
  38. data/lib/losant_rest/application_api_tokens.rb +1 -1
  39. data/lib/losant_rest/application_template.rb +79 -0
  40. data/lib/losant_rest/application_templates.rb +89 -1
  41. data/lib/losant_rest/client.rb +6 -2
  42. data/lib/losant_rest/device.rb +9 -3
  43. data/lib/losant_rest/devices.rb +255 -3
  44. data/lib/losant_rest/experience_endpoints.rb +2 -0
  45. data/lib/losant_rest/file.rb +3 -3
  46. data/lib/losant_rest/flow.rb +115 -1
  47. data/lib/losant_rest/flow_version.rb +115 -1
  48. data/lib/losant_rest/flow_versions.rb +3 -0
  49. data/lib/losant_rest/flows.rb +6 -0
  50. data/lib/losant_rest/me.rb +0 -41
  51. data/lib/losant_rest/version.rb +1 -1
  52. data/schemas/advancedDeviceQuery.json +110 -0
  53. data/schemas/advancedEventQuery.json +198 -0
  54. data/schemas/advancedFlowByVersionQuery.json +665 -0
  55. data/schemas/advancedFlowQuery.json +665 -0
  56. data/schemas/advancedFlowVersionQuery.json +707 -0
  57. data/schemas/advancedQuery.json +22 -0
  58. data/schemas/application.json +8 -0
  59. data/schemas/applicationApiTokenPost.json +11 -1
  60. data/schemas/applicationApplyTemplatePatch.json +19 -0
  61. data/schemas/applicationCreationByTemplateResult.json +8 -0
  62. data/schemas/applicationPost.json +8 -0
  63. data/schemas/applicationTemplate.json +20 -0
  64. data/schemas/applicationTemplateCategories.json +43 -0
  65. data/schemas/applicationTemplateCategory.json +23 -0
  66. data/schemas/applicationTemplates.json +32 -0
  67. data/schemas/applications.json +8 -0
  68. data/schemas/attributeNamesResponse.json +14 -0
  69. data/schemas/authedUser.json +3 -0
  70. data/schemas/changePassword.json +2 -2
  71. data/schemas/dashboard.json +175 -25
  72. data/schemas/dashboardPatch.json +175 -25
  73. data/schemas/dashboardPost.json +175 -25
  74. data/schemas/dashboards.json +175 -25
  75. data/schemas/dataExport.json +142 -0
  76. data/schemas/dataTableRowsExport.json +22 -0
  77. data/schemas/deviceAttributeDataTypeFilter.json +29 -0
  78. data/schemas/deviceClassFilter.json +1 -2
  79. data/schemas/devicesDataRemoved.json +12 -0
  80. data/schemas/devicesDeletePost.json +1034 -0
  81. data/schemas/devicesDeleted.json +12 -0
  82. data/schemas/devicesExportPost.json +1035 -0
  83. data/schemas/devicesPatch.json +1757 -4
  84. data/schemas/devicesRemoveDataPost.json +1056 -0
  85. data/schemas/devicesUpdated.json +18 -0
  86. data/schemas/eventPost.json +22 -0
  87. data/schemas/eventsExport.json +198 -0
  88. data/schemas/experienceDomain.json +1 -1
  89. data/schemas/experienceDomainPatch.json +1 -1
  90. data/schemas/experienceDomainPost.json +1 -1
  91. data/schemas/experienceDomains.json +1 -1
  92. data/schemas/experienceLinkedResources.json +96 -0
  93. data/schemas/experienceVersion.json +10 -1
  94. data/schemas/experienceVersionPatch.json +9 -0
  95. data/schemas/experienceVersions.json +10 -1
  96. data/schemas/flow.json +32 -0
  97. data/schemas/flowErrors.json +87 -0
  98. data/schemas/flowPatch.json +32 -0
  99. data/schemas/flowPost.json +32 -0
  100. data/schemas/flowStats.json +54 -0
  101. data/schemas/flowVersion.json +64 -0
  102. data/schemas/flowVersionPost.json +32 -0
  103. data/schemas/flowVersions.json +64 -0
  104. data/schemas/flows.json +32 -0
  105. data/schemas/flowsImportPost.json +64 -0
  106. data/schemas/flowsImportResult.json +96 -0
  107. data/schemas/githubLogin.json +17 -4
  108. data/schemas/integration.json +3 -0
  109. data/schemas/integrationPatch.json +3 -0
  110. data/schemas/integrationPost.json +3 -0
  111. data/schemas/integrations.json +3 -0
  112. data/schemas/me.json +3 -3
  113. data/schemas/mePatch.json +2 -2
  114. data/schemas/multiDeviceCommand.json +1019 -0
  115. data/schemas/notebook.json +96 -0
  116. data/schemas/notebookExecutionLogs.json +7 -0
  117. data/schemas/notebookPatch.json +96 -0
  118. data/schemas/notebookPost.json +96 -0
  119. data/schemas/notebooks.json +96 -0
  120. data/schemas/org.json +1 -1
  121. data/schemas/orgInviteInfo.json +3 -0
  122. data/schemas/orgInvitePost.json +3 -0
  123. data/schemas/orgInvites.json +3 -0
  124. data/schemas/orgPatch.json +1 -1
  125. data/schemas/orgs.json +1 -1
  126. data/schemas/passwordResetFinish.json +2 -2
  127. data/schemas/samlResponse.json +1 -1
  128. data/schemas/tagKeysResponse.json +14 -0
  129. data/schemas/tagValuesResponse.json +19 -0
  130. data/schemas/templateKeywords.json +14 -0
  131. data/schemas/timeSeriesData.json +12 -2
  132. data/schemas/timeSeriesQuery.json +94 -14
  133. data/schemas/userCredentials.json +15 -3
  134. data/schemas/userPost.json +23 -7
  135. metadata +27 -6
data/schemas/notebook.json CHANGED
@@ -39,6 +39,13 @@
39
39
  "jupyterFileUrl": {
40
40
  "type": "string"
41
41
  },
42
+ "imageVersion": {
43
+ "type": "string",
44
+ "enum": [
45
+ "v1",
46
+ "v2"
47
+ ]
48
+ },
42
49
  "inputs": {
43
50
  "type": "array",
44
51
  "items": {
@@ -141,6 +148,95 @@
141
148
  ],
142
149
  "additionalProperties": false
143
150
  },
151
+ {
152
+ "type": "object",
153
+ "properties": {
154
+ "inputType": {
155
+ "type": "string",
156
+ "enum": [
157
+ "deviceConnectionHistory"
158
+ ]
159
+ },
160
+ "fileName": {
161
+ "oneOf": [
162
+ {
163
+ "type": "string",
164
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
165
+ },
166
+ {
167
+ "type": "string",
168
+ "minLength": 4,
169
+ "maxLength": 255,
170
+ "pattern": ".*{{.+}}.*"
171
+ }
172
+ ]
173
+ },
174
+ "deviceTags": {
175
+ "type": "array",
176
+ "maxItems": 100,
177
+ "items": {
178
+ "type": "object",
179
+ "properties": {
180
+ "key": {
181
+ "oneOf": [
182
+ {
183
+ "type": "string",
184
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
185
+ },
186
+ {
187
+ "type": "string",
188
+ "minLength": 4,
189
+ "maxLength": 255,
190
+ "pattern": ".*{{.+}}.*"
191
+ }
192
+ ]
193
+ },
194
+ "value": {
195
+ "type": "string",
196
+ "minLength": 1,
197
+ "maxLength": 255
198
+ }
199
+ },
200
+ "additionalProperties": false
201
+ }
202
+ },
203
+ "deviceIds": {
204
+ "type": "array",
205
+ "maxItems": 100,
206
+ "items": {
207
+ "oneOf": [
208
+ {
209
+ "type": "string",
210
+ "pattern": "^[A-Fa-f\\d]{24}$"
211
+ },
212
+ {
213
+ "type": "string",
214
+ "minLength": 4,
215
+ "maxLength": 255,
216
+ "pattern": ".*{{.+}}.*"
217
+ }
218
+ ]
219
+ }
220
+ },
221
+ "queryJson": {
222
+ "type": "string",
223
+ "maxLength": 8192
224
+ },
225
+ "start": {
226
+ "type": "number"
227
+ },
228
+ "end": {
229
+ "type": "number"
230
+ }
231
+ },
232
+ "required": [
233
+ "inputType",
234
+ "fileName",
235
+ "start",
236
+ "end"
237
+ ],
238
+ "additionalProperties": false
239
+ },
144
240
  {
145
241
  "type": "object",
146
242
  "properties": {
data/schemas/notebookExecutionLogs.json CHANGED
@@ -16,6 +16,13 @@
16
16
  "type": "string",
17
17
  "pattern": "^[A-Fa-f\\d]{24}$"
18
18
  },
19
+ "imageVersion": {
20
+ "type": "string",
21
+ "enum": [
22
+ "v1",
23
+ "v2"
24
+ ]
25
+ },
19
26
  "applicationId": {
20
27
  "type": "string",
21
28
  "pattern": "^[A-Fa-f\\d]{24}$"
data/schemas/notebookPatch.json CHANGED
@@ -113,6 +113,95 @@
113
113
  ],
114
114
  "additionalProperties": false
115
115
  },
116
+ {
117
+ "type": "object",
118
+ "properties": {
119
+ "inputType": {
120
+ "type": "string",
121
+ "enum": [
122
+ "deviceConnectionHistory"
123
+ ]
124
+ },
125
+ "fileName": {
126
+ "oneOf": [
127
+ {
128
+ "type": "string",
129
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
130
+ },
131
+ {
132
+ "type": "string",
133
+ "minLength": 4,
134
+ "maxLength": 255,
135
+ "pattern": ".*{{.+}}.*"
136
+ }
137
+ ]
138
+ },
139
+ "deviceTags": {
140
+ "type": "array",
141
+ "maxItems": 100,
142
+ "items": {
143
+ "type": "object",
144
+ "properties": {
145
+ "key": {
146
+ "oneOf": [
147
+ {
148
+ "type": "string",
149
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
150
+ },
151
+ {
152
+ "type": "string",
153
+ "minLength": 4,
154
+ "maxLength": 255,
155
+ "pattern": ".*{{.+}}.*"
156
+ }
157
+ ]
158
+ },
159
+ "value": {
160
+ "type": "string",
161
+ "minLength": 1,
162
+ "maxLength": 255
163
+ }
164
+ },
165
+ "additionalProperties": false
166
+ }
167
+ },
168
+ "deviceIds": {
169
+ "type": "array",
170
+ "maxItems": 100,
171
+ "items": {
172
+ "oneOf": [
173
+ {
174
+ "type": "string",
175
+ "pattern": "^[A-Fa-f\\d]{24}$"
176
+ },
177
+ {
178
+ "type": "string",
179
+ "minLength": 4,
180
+ "maxLength": 255,
181
+ "pattern": ".*{{.+}}.*"
182
+ }
183
+ ]
184
+ }
185
+ },
186
+ "queryJson": {
187
+ "type": "string",
188
+ "maxLength": 8192
189
+ },
190
+ "start": {
191
+ "type": "number"
192
+ },
193
+ "end": {
194
+ "type": "number"
195
+ }
196
+ },
197
+ "required": [
198
+ "inputType",
199
+ "fileName",
200
+ "start",
201
+ "end"
202
+ ],
203
+ "additionalProperties": false
204
+ },
116
205
  {
117
206
  "type": "object",
118
207
  "properties": {
@@ -487,6 +576,13 @@
487
576
  }
488
577
  ]
489
578
  }
579
+ },
580
+ "imageVersion": {
581
+ "type": "string",
582
+ "enum": [
583
+ "v1",
584
+ "v2"
585
+ ]
490
586
  }
491
587
  },
492
588
  "additionalProperties": false
data/schemas/notebookPost.json CHANGED
@@ -11,6 +11,13 @@
11
11
  "type": "string",
12
12
  "maxLength": 32767
13
13
  },
14
+ "imageVersion": {
15
+ "type": "string",
16
+ "enum": [
17
+ "v1",
18
+ "v2"
19
+ ]
20
+ },
14
21
  "inputs": {
15
22
  "type": "array",
16
23
  "items": {
@@ -113,6 +120,95 @@
113
120
  ],
114
121
  "additionalProperties": false
115
122
  },
123
+ {
124
+ "type": "object",
125
+ "properties": {
126
+ "inputType": {
127
+ "type": "string",
128
+ "enum": [
129
+ "deviceConnectionHistory"
130
+ ]
131
+ },
132
+ "fileName": {
133
+ "oneOf": [
134
+ {
135
+ "type": "string",
136
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
137
+ },
138
+ {
139
+ "type": "string",
140
+ "minLength": 4,
141
+ "maxLength": 255,
142
+ "pattern": ".*{{.+}}.*"
143
+ }
144
+ ]
145
+ },
146
+ "deviceTags": {
147
+ "type": "array",
148
+ "maxItems": 100,
149
+ "items": {
150
+ "type": "object",
151
+ "properties": {
152
+ "key": {
153
+ "oneOf": [
154
+ {
155
+ "type": "string",
156
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
157
+ },
158
+ {
159
+ "type": "string",
160
+ "minLength": 4,
161
+ "maxLength": 255,
162
+ "pattern": ".*{{.+}}.*"
163
+ }
164
+ ]
165
+ },
166
+ "value": {
167
+ "type": "string",
168
+ "minLength": 1,
169
+ "maxLength": 255
170
+ }
171
+ },
172
+ "additionalProperties": false
173
+ }
174
+ },
175
+ "deviceIds": {
176
+ "type": "array",
177
+ "maxItems": 100,
178
+ "items": {
179
+ "oneOf": [
180
+ {
181
+ "type": "string",
182
+ "pattern": "^[A-Fa-f\\d]{24}$"
183
+ },
184
+ {
185
+ "type": "string",
186
+ "minLength": 4,
187
+ "maxLength": 255,
188
+ "pattern": ".*{{.+}}.*"
189
+ }
190
+ ]
191
+ }
192
+ },
193
+ "queryJson": {
194
+ "type": "string",
195
+ "maxLength": 8192
196
+ },
197
+ "start": {
198
+ "type": "number"
199
+ },
200
+ "end": {
201
+ "type": "number"
202
+ }
203
+ },
204
+ "required": [
205
+ "inputType",
206
+ "fileName",
207
+ "start",
208
+ "end"
209
+ ],
210
+ "additionalProperties": false
211
+ },
116
212
  {
117
213
  "type": "object",
118
214
  "properties": {
data/schemas/notebooks.json CHANGED
@@ -46,6 +46,13 @@
46
46
  "jupyterFileUrl": {
47
47
  "type": "string"
48
48
  },
49
+ "imageVersion": {
50
+ "type": "string",
51
+ "enum": [
52
+ "v1",
53
+ "v2"
54
+ ]
55
+ },
49
56
  "inputs": {
50
57
  "type": "array",
51
58
  "items": {
@@ -148,6 +155,95 @@
148
155
  ],
149
156
  "additionalProperties": false
150
157
  },
158
+ {
159
+ "type": "object",
160
+ "properties": {
161
+ "inputType": {
162
+ "type": "string",
163
+ "enum": [
164
+ "deviceConnectionHistory"
165
+ ]
166
+ },
167
+ "fileName": {
168
+ "oneOf": [
169
+ {
170
+ "type": "string",
171
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
172
+ },
173
+ {
174
+ "type": "string",
175
+ "minLength": 4,
176
+ "maxLength": 255,
177
+ "pattern": ".*{{.+}}.*"
178
+ }
179
+ ]
180
+ },
181
+ "deviceTags": {
182
+ "type": "array",
183
+ "maxItems": 100,
184
+ "items": {
185
+ "type": "object",
186
+ "properties": {
187
+ "key": {
188
+ "oneOf": [
189
+ {
190
+ "type": "string",
191
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
192
+ },
193
+ {
194
+ "type": "string",
195
+ "minLength": 4,
196
+ "maxLength": 255,
197
+ "pattern": ".*{{.+}}.*"
198
+ }
199
+ ]
200
+ },
201
+ "value": {
202
+ "type": "string",
203
+ "minLength": 1,
204
+ "maxLength": 255
205
+ }
206
+ },
207
+ "additionalProperties": false
208
+ }
209
+ },
210
+ "deviceIds": {
211
+ "type": "array",
212
+ "maxItems": 100,
213
+ "items": {
214
+ "oneOf": [
215
+ {
216
+ "type": "string",
217
+ "pattern": "^[A-Fa-f\\d]{24}$"
218
+ },
219
+ {
220
+ "type": "string",
221
+ "minLength": 4,
222
+ "maxLength": 255,
223
+ "pattern": ".*{{.+}}.*"
224
+ }
225
+ ]
226
+ }
227
+ },
228
+ "queryJson": {
229
+ "type": "string",
230
+ "maxLength": 8192
231
+ },
232
+ "start": {
233
+ "type": "number"
234
+ },
235
+ "end": {
236
+ "type": "number"
237
+ }
238
+ },
239
+ "required": [
240
+ "inputType",
241
+ "fileName",
242
+ "start",
243
+ "end"
244
+ ],
245
+ "additionalProperties": false
246
+ },
151
247
  {
152
248
  "type": "object",
153
249
  "properties": {