losant_rest 1.9.1 → 1.10.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +41608 -19945
  5. data/docs/application.md +168 -4
  6. data/docs/applicationTemplates.md +50 -0
  7. data/docs/applications.md +46 -0
  8. data/docs/auth.md +72 -0
  9. data/docs/device.md +1 -0
  10. data/docs/devices.md +89 -2
  11. data/docs/experienceEndpoint.md +43 -0
  12. data/docs/experienceEndpoints.md +1 -1
  13. data/docs/experienceView.md +43 -0
  14. data/lib/losant_rest.rb +2 -1
  15. data/lib/losant_rest/application.rb +144 -5
  16. data/lib/losant_rest/application_api_token.rb +1 -1
  17. data/lib/losant_rest/application_api_tokens.rb +1 -1
  18. data/lib/losant_rest/application_certificate.rb +1 -1
  19. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  20. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  21. data/lib/losant_rest/application_certificates.rb +1 -1
  22. data/lib/losant_rest/application_key.rb +1 -1
  23. data/lib/losant_rest/application_keys.rb +1 -1
  24. data/lib/losant_rest/application_templates.rb +88 -0
  25. data/lib/losant_rest/applications.rb +1 -1
  26. data/lib/losant_rest/audit_log.rb +1 -1
  27. data/lib/losant_rest/audit_logs.rb +1 -1
  28. data/lib/losant_rest/auth.rb +85 -1
  29. data/lib/losant_rest/client.rb +7 -3
  30. data/lib/losant_rest/dashboard.rb +1 -1
  31. data/lib/losant_rest/dashboards.rb +1 -1
  32. data/lib/losant_rest/data.rb +1 -1
  33. data/lib/losant_rest/data_table.rb +1 -1
  34. data/lib/losant_rest/data_table_row.rb +1 -1
  35. data/lib/losant_rest/data_table_rows.rb +1 -1
  36. data/lib/losant_rest/data_tables.rb +1 -1
  37. data/lib/losant_rest/device.rb +3 -1
  38. data/lib/losant_rest/device_recipe.rb +1 -1
  39. data/lib/losant_rest/device_recipes.rb +1 -1
  40. data/lib/losant_rest/devices.rb +105 -3
  41. data/lib/losant_rest/edge_deployments.rb +1 -1
  42. data/lib/losant_rest/error.rb +1 -1
  43. data/lib/losant_rest/event.rb +1 -1
  44. data/lib/losant_rest/events.rb +1 -1
  45. data/lib/losant_rest/experience.rb +1 -1
  46. data/lib/losant_rest/experience_domain.rb +1 -1
  47. data/lib/losant_rest/experience_domains.rb +1 -1
  48. data/lib/losant_rest/experience_endpoint.rb +51 -1
  49. data/lib/losant_rest/experience_endpoints.rb +1 -1
  50. data/lib/losant_rest/experience_group.rb +1 -1
  51. data/lib/losant_rest/experience_groups.rb +1 -1
  52. data/lib/losant_rest/experience_slug.rb +1 -1
  53. data/lib/losant_rest/experience_slugs.rb +1 -1
  54. data/lib/losant_rest/experience_user.rb +1 -1
  55. data/lib/losant_rest/experience_users.rb +1 -1
  56. data/lib/losant_rest/experience_version.rb +1 -1
  57. data/lib/losant_rest/experience_versions.rb +1 -1
  58. data/lib/losant_rest/experience_view.rb +51 -1
  59. data/lib/losant_rest/experience_views.rb +1 -1
  60. data/lib/losant_rest/file.rb +1 -1
  61. data/lib/losant_rest/files.rb +1 -1
  62. data/lib/losant_rest/flow.rb +1 -1
  63. data/lib/losant_rest/flow_version.rb +1 -1
  64. data/lib/losant_rest/flow_versions.rb +1 -1
  65. data/lib/losant_rest/flows.rb +1 -1
  66. data/lib/losant_rest/integration.rb +1 -1
  67. data/lib/losant_rest/integrations.rb +1 -1
  68. data/lib/losant_rest/me.rb +1 -1
  69. data/lib/losant_rest/notebook.rb +1 -1
  70. data/lib/losant_rest/notebooks.rb +1 -1
  71. data/lib/losant_rest/org.rb +1 -1
  72. data/lib/losant_rest/org_invites.rb +1 -1
  73. data/lib/losant_rest/orgs.rb +1 -1
  74. data/lib/losant_rest/utils.rb +1 -1
  75. data/lib/losant_rest/version.rb +2 -2
  76. data/lib/losant_rest/webhook.rb +1 -1
  77. data/lib/losant_rest/webhooks.rb +1 -1
  78. data/schemas/advancedDeviceQuery.json +1018 -0
  79. data/schemas/advancedEventQuery.json +382 -13
  80. data/schemas/advancedQuery.json +37 -3
  81. data/schemas/application.json +10 -5
  82. data/schemas/applicationApiTokenPost.json +6 -0
  83. data/schemas/applicationCertificate.json +34 -0
  84. data/schemas/applicationCertificatePatch.json +34 -0
  85. data/schemas/applicationCertificatePost.json +34 -0
  86. data/schemas/applicationCertificates.json +34 -0
  87. data/schemas/{applicationCloneResult.json → applicationCreationByTemplateResult.json} +21 -8
  88. data/schemas/applicationExportPost.json +24 -0
  89. data/schemas/applicationExportResult.json +10 -0
  90. data/schemas/applicationKey.json +34 -0
  91. data/schemas/applicationKeyPatch.json +34 -0
  92. data/schemas/applicationKeyPost.json +34 -0
  93. data/schemas/applicationKeyPostResponse.json +34 -0
  94. data/schemas/applicationKeys.json +34 -0
  95. data/schemas/applicationPatch.json +10 -5
  96. data/schemas/applicationPost.json +14 -5
  97. data/schemas/applicationReadme.json +29 -0
  98. data/schemas/applicationReadmePatch.json +11 -0
  99. data/schemas/applicationTemplate.json +99 -0
  100. data/schemas/applicationTemplates.json +140 -0
  101. data/schemas/applications.json +10 -5
  102. data/schemas/authedDevice.json +34 -0
  103. data/schemas/dashboard.json +1228 -144
  104. data/schemas/dashboardPatch.json +1228 -144
  105. data/schemas/dashboardPost.json +1228 -144
  106. data/schemas/dashboards.json +1228 -144
  107. data/schemas/dataExport.json +11 -0
  108. data/schemas/dataTableRows.json +3 -0
  109. data/schemas/dataTableRowsExport.json +37 -3
  110. data/schemas/device.json +16 -3
  111. data/schemas/devicePatch.json +16 -3
  112. data/schemas/devicePost.json +16 -3
  113. data/schemas/deviceRecipe.json +16 -3
  114. data/schemas/deviceRecipePatch.json +16 -3
  115. data/schemas/deviceRecipePost.json +16 -3
  116. data/schemas/deviceRecipes.json +16 -3
  117. data/schemas/devices.json +19 -3
  118. data/schemas/devicesDataRemoved.json +12 -0
  119. data/schemas/devicesDeletePost.json +1034 -0
  120. data/schemas/devicesDeleted.json +12 -0
  121. data/schemas/devicesExportPost.json +1035 -0
  122. data/schemas/devicesPatch.json +1773 -7
  123. data/schemas/devicesRemoveDataPost.json +1056 -0
  124. data/schemas/devicesUpdated.json +18 -0
  125. data/schemas/events.json +1 -816
  126. data/schemas/eventsExport.json +382 -13
  127. data/schemas/experienceGroup.json +7 -0
  128. data/schemas/experienceGroupPatch.json +7 -0
  129. data/schemas/experienceGroupPost.json +7 -0
  130. data/schemas/experienceGroups.json +7 -0
  131. data/schemas/experienceLinkedResources.json +6659 -0
  132. data/schemas/flow.json +103 -1
  133. data/schemas/flowPatch.json +103 -1
  134. data/schemas/flowPost.json +103 -1
  135. data/schemas/flowVersion.json +206 -2
  136. data/schemas/flowVersionPost.json +103 -1
  137. data/schemas/flowVersions.json +206 -2
  138. data/schemas/flows.json +103 -1
  139. data/schemas/flowsImportPost.json +206 -2
  140. data/schemas/flowsImportResult.json +309 -3
  141. data/schemas/githubLogin.json +9 -0
  142. data/schemas/integration.json +4 -4
  143. data/schemas/integrationPatch.json +4 -4
  144. data/schemas/integrationPost.json +4 -4
  145. data/schemas/integrations.json +4 -4
  146. data/schemas/{applicationCloneEnqueued.json → jobEnqueuedResult.json} +0 -0
  147. data/schemas/me.json +3 -0
  148. data/schemas/multiDeviceCommand.json +1019 -0
  149. data/schemas/notebook.json +207 -35
  150. data/schemas/notebookDataExportOptions.json +4 -0
  151. data/schemas/notebookExecutionLogs.json +4 -0
  152. data/schemas/notebookExecutionOptions.json +4 -0
  153. data/schemas/notebookPatch.json +207 -35
  154. data/schemas/notebookPost.json +207 -35
  155. data/schemas/notebooks.json +207 -35
  156. data/schemas/org.json +8 -0
  157. data/schemas/orgPatch.json +9 -0
  158. data/schemas/orgs.json +8 -0
  159. data/schemas/samlResponse.json +21 -0
  160. data/schemas/ssoRequest.json +20 -0
  161. data/schemas/timeSeriesData.json +91 -12
  162. data/schemas/timeSeriesQuery.json +21 -12
  163. data/schemas/userCredentials.json +9 -0
  164. data/schemas/userPost.json +9 -0
  165. data/schemas/{validationCloneErrors.json → validationErrors.json} +9 -2
  166. metadata +24 -7
@@ -6,17 +6,26 @@
6
6
  "type": "array",
7
7
  "items": {
8
8
  "$ref": "#/definitions/advancedQuery"
9
- }
9
+ },
10
+ "maxItems": 100
10
11
  },
11
12
  "$or": {
12
13
  "type": "array",
13
14
  "items": {
14
15
  "$ref": "#/definitions/advancedQuery"
15
- }
16
+ },
17
+ "maxItems": 100
18
+ },
19
+ "$nor": {
20
+ "type": "array",
21
+ "items": {
22
+ "$ref": "#/definitions/advancedQuery"
23
+ },
24
+ "maxItems": 100
16
25
  }
17
26
  },
18
27
  "patternProperties": {
19
- "^[0-9a-zA-Z_-]{1,255}": {
28
+ "^[0-9a-zA-Z_-]{1,255}$": {
20
29
  "oneOf": [
21
30
  {
22
31
  "type": [
@@ -88,6 +97,31 @@
88
97
  "$contains": {
89
98
  "type": "string",
90
99
  "minLength": 1
100
+ },
101
+ "$ci": {
102
+ "type": "boolean"
103
+ },
104
+ "$in": {
105
+ "type": "array",
106
+ "maxItems": 100,
107
+ "items": {
108
+ "type": [
109
+ "string",
110
+ "number",
111
+ "boolean"
112
+ ]
113
+ }
114
+ },
115
+ "$nin": {
116
+ "type": "array",
117
+ "maxItems": 100,
118
+ "items": {
119
+ "type": [
120
+ "string",
121
+ "number",
122
+ "boolean"
123
+ ]
124
+ }
91
125
  }
92
126
  },
93
127
  "additionalProperties": false
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "description": {
47
47
  "type": "string",
48
- "maxLength": 32767
48
+ "maxLength": 1024
49
49
  },
50
50
  "endpointSlug": {
51
51
  "type": "string",
@@ -81,7 +81,7 @@
81
81
  },
82
82
  "description": {
83
83
  "type": "string",
84
- "maxLength": 32767
84
+ "maxLength": 1024
85
85
  }
86
86
  },
87
87
  "additionalProperties": false,
@@ -91,6 +91,11 @@
91
91
  ]
92
92
  }
93
93
  },
94
+ "blobUrlTTL": {
95
+ "type": "number",
96
+ "minimum": 3600,
97
+ "maximum": 604800
98
+ },
94
99
  "summary": {
95
100
  "type": "object",
96
101
  "properties": {
@@ -266,12 +271,12 @@
266
271
  },
267
272
  "accessKeyId": {
268
273
  "type": "string",
269
- "min": 16,
274
+ "min": 4,
270
275
  "max": 128
271
276
  },
272
277
  "secretAccessKey": {
273
278
  "type": "string",
274
- "min": 16,
279
+ "min": 4,
275
280
  "max": 128
276
281
  },
277
282
  "region": {
@@ -298,7 +303,7 @@
298
303
  "keyJson": {
299
304
  "type": "string",
300
305
  "maxLength": 32767,
301
- "minLength": 50
306
+ "minLength": 4
302
307
  },
303
308
  "bucket": {
304
309
  "type": "string",
@@ -76,6 +76,8 @@
76
76
  "application.archiveData",
77
77
  "application.backfillArchiveData",
78
78
  "application.clone",
79
+ "application.export",
80
+ "application.import",
79
81
  "application.fullEventsArchive",
80
82
  "application.fullDataTablesArchive",
81
83
  "application.debug",
@@ -147,6 +149,8 @@
147
149
  "deviceRecipes.get",
148
150
  "deviceRecipes.post",
149
151
  "devices.patch",
152
+ "devices.delete",
153
+ "devices.removeData",
150
154
  "devices.detailedSummary",
151
155
  "devices.export",
152
156
  "devices.get",
@@ -174,6 +178,7 @@
174
178
  "experienceDomains.post",
175
179
  "experienceEndpoint.delete",
176
180
  "experienceEndpoint.get",
181
+ "experienceEndpoint.linkedResources",
177
182
  "experienceEndpoint.patch",
178
183
  "experienceEndpoints.get",
179
184
  "experienceEndpoints.post",
@@ -203,6 +208,7 @@
203
208
  "experienceView.debug",
204
209
  "experienceView.delete",
205
210
  "experienceView.get",
211
+ "experienceView.linkedResources",
206
212
  "experienceView.patch",
207
213
  "experienceViews.debug",
208
214
  "experienceViews.detailedSummary",
@@ -90,6 +90,40 @@
90
90
  "format": "date-time"
91
91
  }
92
92
  }
93
+ },
94
+ "filterType": {
95
+ "oneOf": [
96
+ {
97
+ "type": "string",
98
+ "enum": [
99
+ "all",
100
+ "whitelist",
101
+ "blacklist"
102
+ ]
103
+ },
104
+ {
105
+ "type": "string",
106
+ "enum": [
107
+ "none"
108
+ ]
109
+ }
110
+ ]
111
+ },
112
+ "pubTopics": {
113
+ "type": "array",
114
+ "items": {
115
+ "type": "string",
116
+ "minLength": 1,
117
+ "maxLength": 1024
118
+ }
119
+ },
120
+ "subTopics": {
121
+ "type": "array",
122
+ "items": {
123
+ "type": "string",
124
+ "minLength": 1,
125
+ "maxLength": 1024
126
+ }
93
127
  }
94
128
  }
95
129
  }
@@ -17,6 +17,40 @@
17
17
  "type": "string",
18
18
  "maxLength": 32767,
19
19
  "minLength": 50
20
+ },
21
+ "filterType": {
22
+ "oneOf": [
23
+ {
24
+ "type": "string",
25
+ "enum": [
26
+ "all",
27
+ "whitelist",
28
+ "blacklist"
29
+ ]
30
+ },
31
+ {
32
+ "type": "string",
33
+ "enum": [
34
+ "none"
35
+ ]
36
+ }
37
+ ]
38
+ },
39
+ "pubTopics": {
40
+ "type": "array",
41
+ "items": {
42
+ "type": "string",
43
+ "minLength": 1,
44
+ "maxLength": 1024
45
+ }
46
+ },
47
+ "subTopics": {
48
+ "type": "array",
49
+ "items": {
50
+ "type": "string",
51
+ "minLength": 1,
52
+ "maxLength": 1024
53
+ }
20
54
  }
21
55
  },
22
56
  "additionalProperties": false
@@ -44,6 +44,40 @@
44
44
  "type": "string",
45
45
  "maxLength": 32767,
46
46
  "minLength": 50
47
+ },
48
+ "filterType": {
49
+ "oneOf": [
50
+ {
51
+ "type": "string",
52
+ "enum": [
53
+ "all",
54
+ "whitelist",
55
+ "blacklist"
56
+ ]
57
+ },
58
+ {
59
+ "type": "string",
60
+ "enum": [
61
+ "none"
62
+ ]
63
+ }
64
+ ]
65
+ },
66
+ "pubTopics": {
67
+ "type": "array",
68
+ "items": {
69
+ "type": "string",
70
+ "minLength": 1,
71
+ "maxLength": 1024
72
+ }
73
+ },
74
+ "subTopics": {
75
+ "type": "array",
76
+ "items": {
77
+ "type": "string",
78
+ "minLength": 1,
79
+ "maxLength": 1024
80
+ }
47
81
  }
48
82
  },
49
83
  "required": [
@@ -97,6 +97,40 @@
97
97
  "format": "date-time"
98
98
  }
99
99
  }
100
+ },
101
+ "filterType": {
102
+ "oneOf": [
103
+ {
104
+ "type": "string",
105
+ "enum": [
106
+ "all",
107
+ "whitelist",
108
+ "blacklist"
109
+ ]
110
+ },
111
+ {
112
+ "type": "string",
113
+ "enum": [
114
+ "none"
115
+ ]
116
+ }
117
+ ]
118
+ },
119
+ "pubTopics": {
120
+ "type": "array",
121
+ "items": {
122
+ "type": "string",
123
+ "minLength": 1,
124
+ "maxLength": 1024
125
+ }
126
+ },
127
+ "subTopics": {
128
+ "type": "array",
129
+ "items": {
130
+ "type": "string",
131
+ "minLength": 1,
132
+ "maxLength": 1024
133
+ }
100
134
  }
101
135
  }
102
136
  }
@@ -50,7 +50,7 @@
50
50
  },
51
51
  "description": {
52
52
  "type": "string",
53
- "maxLength": 32767
53
+ "maxLength": 1024
54
54
  },
55
55
  "endpointSlug": {
56
56
  "type": "string",
@@ -86,7 +86,7 @@
86
86
  },
87
87
  "description": {
88
88
  "type": "string",
89
- "maxLength": 32767
89
+ "maxLength": 1024
90
90
  }
91
91
  },
92
92
  "additionalProperties": false,
@@ -96,6 +96,11 @@
96
96
  ]
97
97
  }
98
98
  },
99
+ "blobUrlTTL": {
100
+ "type": "number",
101
+ "minimum": 3600,
102
+ "maximum": 604800
103
+ },
99
104
  "summary": {
100
105
  "type": "object",
101
106
  "properties": {
@@ -271,12 +276,12 @@
271
276
  },
272
277
  "accessKeyId": {
273
278
  "type": "string",
274
- "min": 16,
279
+ "min": 4,
275
280
  "max": 128
276
281
  },
277
282
  "secretAccessKey": {
278
283
  "type": "string",
279
- "min": 16,
284
+ "min": 4,
280
285
  "max": 128
281
286
  },
282
287
  "region": {
@@ -303,7 +308,7 @@
303
308
  "keyJson": {
304
309
  "type": "string",
305
310
  "maxLength": 32767,
306
- "minLength": 50
311
+ "minLength": 4
307
312
  },
308
313
  "bucket": {
309
314
  "type": "string",
@@ -359,8 +364,15 @@
359
364
  "type": "string"
360
365
  },
361
366
  "id": {
362
- "type": "string",
363
- "pattern": "^[A-Fa-f\\d]{24}$"
367
+ "oneOf": [
368
+ {
369
+ "type": "string",
370
+ "pattern": "^[A-Fa-f\\d]{24}$"
371
+ },
372
+ {
373
+ "type": "string"
374
+ }
375
+ ]
364
376
  },
365
377
  "message": {
366
378
  "type": "string"
@@ -368,5 +380,6 @@
368
380
  }
369
381
  }
370
382
  }
371
- }
383
+ },
384
+ "additionalProperties": false
372
385
  }
@@ -0,0 +1,24 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "includeFiles": {
6
+ "type": "boolean",
7
+ "default": false
8
+ },
9
+ "includeDataTableRows": {
10
+ "type": "boolean",
11
+ "default": false
12
+ },
13
+ "includeDevices": {
14
+ "type": "boolean",
15
+ "default": false
16
+ },
17
+ "email": {
18
+ "type": "string",
19
+ "format": "email",
20
+ "maxLength": 1024
21
+ }
22
+ },
23
+ "additionalProperties": false
24
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "url": {
6
+ "type": "string"
7
+ }
8
+ },
9
+ "additionalProperties": false
10
+ }
@@ -62,6 +62,40 @@
62
62
  "description": {
63
63
  "type": "string",
64
64
  "maxLength": 32767
65
+ },
66
+ "filterType": {
67
+ "oneOf": [
68
+ {
69
+ "type": "string",
70
+ "enum": [
71
+ "all",
72
+ "whitelist",
73
+ "blacklist"
74
+ ]
75
+ },
76
+ {
77
+ "type": "string",
78
+ "enum": [
79
+ "none"
80
+ ]
81
+ }
82
+ ]
83
+ },
84
+ "pubTopics": {
85
+ "type": "array",
86
+ "items": {
87
+ "type": "string",
88
+ "minLength": 1,
89
+ "maxLength": 1024
90
+ }
91
+ },
92
+ "subTopics": {
93
+ "type": "array",
94
+ "items": {
95
+ "type": "string",
96
+ "minLength": 1,
97
+ "maxLength": 1024
98
+ }
65
99
  }
66
100
  }
67
101
  }