losant_rest 1.9.1 → 1.9.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (112) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +8502 -580
  5. data/docs/application.md +45 -3
  6. data/docs/applications.md +46 -0
  7. data/docs/experienceEndpoint.md +43 -0
  8. data/docs/experienceEndpoints.md +1 -1
  9. data/docs/experienceView.md +43 -0
  10. data/lib/losant_rest.rb +1 -1
  11. data/lib/losant_rest/application.rb +52 -4
  12. data/lib/losant_rest/application_api_token.rb +1 -1
  13. data/lib/losant_rest/application_api_tokens.rb +1 -1
  14. data/lib/losant_rest/application_certificate.rb +1 -1
  15. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  16. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  17. data/lib/losant_rest/application_certificates.rb +1 -1
  18. data/lib/losant_rest/application_key.rb +1 -1
  19. data/lib/losant_rest/application_keys.rb +1 -1
  20. data/lib/losant_rest/applications.rb +1 -1
  21. data/lib/losant_rest/audit_log.rb +1 -1
  22. data/lib/losant_rest/audit_logs.rb +1 -1
  23. data/lib/losant_rest/auth.rb +1 -1
  24. data/lib/losant_rest/client.rb +3 -3
  25. data/lib/losant_rest/dashboard.rb +1 -1
  26. data/lib/losant_rest/dashboards.rb +1 -1
  27. data/lib/losant_rest/data.rb +1 -1
  28. data/lib/losant_rest/data_table.rb +1 -1
  29. data/lib/losant_rest/data_table_row.rb +1 -1
  30. data/lib/losant_rest/data_table_rows.rb +1 -1
  31. data/lib/losant_rest/data_tables.rb +1 -1
  32. data/lib/losant_rest/device.rb +1 -1
  33. data/lib/losant_rest/device_recipe.rb +1 -1
  34. data/lib/losant_rest/device_recipes.rb +1 -1
  35. data/lib/losant_rest/devices.rb +1 -1
  36. data/lib/losant_rest/edge_deployments.rb +1 -1
  37. data/lib/losant_rest/error.rb +1 -1
  38. data/lib/losant_rest/event.rb +1 -1
  39. data/lib/losant_rest/events.rb +1 -1
  40. data/lib/losant_rest/experience.rb +1 -1
  41. data/lib/losant_rest/experience_domain.rb +1 -1
  42. data/lib/losant_rest/experience_domains.rb +1 -1
  43. data/lib/losant_rest/experience_endpoint.rb +51 -1
  44. data/lib/losant_rest/experience_endpoints.rb +1 -1
  45. data/lib/losant_rest/experience_group.rb +1 -1
  46. data/lib/losant_rest/experience_groups.rb +1 -1
  47. data/lib/losant_rest/experience_slug.rb +1 -1
  48. data/lib/losant_rest/experience_slugs.rb +1 -1
  49. data/lib/losant_rest/experience_user.rb +1 -1
  50. data/lib/losant_rest/experience_users.rb +1 -1
  51. data/lib/losant_rest/experience_version.rb +1 -1
  52. data/lib/losant_rest/experience_versions.rb +1 -1
  53. data/lib/losant_rest/experience_view.rb +51 -1
  54. data/lib/losant_rest/experience_views.rb +1 -1
  55. data/lib/losant_rest/file.rb +1 -1
  56. data/lib/losant_rest/files.rb +1 -1
  57. data/lib/losant_rest/flow.rb +1 -1
  58. data/lib/losant_rest/flow_version.rb +1 -1
  59. data/lib/losant_rest/flow_versions.rb +1 -1
  60. data/lib/losant_rest/flows.rb +1 -1
  61. data/lib/losant_rest/integration.rb +1 -1
  62. data/lib/losant_rest/integrations.rb +1 -1
  63. data/lib/losant_rest/me.rb +1 -1
  64. data/lib/losant_rest/notebook.rb +1 -1
  65. data/lib/losant_rest/notebooks.rb +1 -1
  66. data/lib/losant_rest/org.rb +1 -1
  67. data/lib/losant_rest/org_invites.rb +1 -1
  68. data/lib/losant_rest/orgs.rb +1 -1
  69. data/lib/losant_rest/utils.rb +1 -1
  70. data/lib/losant_rest/version.rb +1 -1
  71. data/lib/losant_rest/webhook.rb +1 -1
  72. data/lib/losant_rest/webhooks.rb +1 -1
  73. data/schemas/application.json +3 -3
  74. data/schemas/applicationApiTokenPost.json +3 -0
  75. data/schemas/applicationCertificate.json +34 -0
  76. data/schemas/applicationCertificatePatch.json +34 -0
  77. data/schemas/applicationCertificatePost.json +34 -0
  78. data/schemas/applicationCertificates.json +34 -0
  79. data/schemas/{applicationCloneResult.json → applicationCreationByTemplateResult.json} +14 -6
  80. data/schemas/applicationExportPost.json +24 -0
  81. data/schemas/applicationExportResult.json +10 -0
  82. data/schemas/applicationKey.json +34 -0
  83. data/schemas/applicationKeyPatch.json +34 -0
  84. data/schemas/applicationKeyPost.json +34 -0
  85. data/schemas/applicationKeyPostResponse.json +34 -0
  86. data/schemas/applicationKeys.json +34 -0
  87. data/schemas/applicationPatch.json +3 -3
  88. data/schemas/applicationPost.json +3 -3
  89. data/schemas/applications.json +3 -3
  90. data/schemas/authedDevice.json +34 -0
  91. data/schemas/dashboard.json +76 -0
  92. data/schemas/dashboardPatch.json +76 -0
  93. data/schemas/dashboardPost.json +76 -0
  94. data/schemas/dashboards.json +76 -0
  95. data/schemas/experienceLinkedResources.json +6353 -0
  96. data/schemas/githubLogin.json +4 -0
  97. data/schemas/integration.json +4 -4
  98. data/schemas/integrationPatch.json +4 -4
  99. data/schemas/integrationPost.json +4 -4
  100. data/schemas/integrations.json +4 -4
  101. data/schemas/{applicationCloneEnqueued.json → jobEnqueuedResult.json} +0 -0
  102. data/schemas/notebook.json +198 -34
  103. data/schemas/notebookDataExportOptions.json +4 -0
  104. data/schemas/notebookExecutionLogs.json +4 -0
  105. data/schemas/notebookExecutionOptions.json +4 -0
  106. data/schemas/notebookPatch.json +198 -34
  107. data/schemas/notebookPost.json +198 -34
  108. data/schemas/notebooks.json +198 -34
  109. data/schemas/userCredentials.json +4 -0
  110. data/schemas/userPost.json +4 -0
  111. data/schemas/{validationCloneErrors.json → validationErrors.json} +9 -2
  112. metadata +9 -6
@@ -71,6 +71,7 @@
71
71
  "application.archiveData",
72
72
  "application.backfillArchiveData",
73
73
  "application.clone",
74
+ "application.export",
74
75
  "application.fullEventsArchive",
75
76
  "application.fullDataTablesArchive",
76
77
  "application.debug",
@@ -169,6 +170,7 @@
169
170
  "experienceDomains.post",
170
171
  "experienceEndpoint.delete",
171
172
  "experienceEndpoint.get",
173
+ "experienceEndpoint.linkedResources",
172
174
  "experienceEndpoint.patch",
173
175
  "experienceEndpoints.get",
174
176
  "experienceEndpoints.post",
@@ -198,6 +200,7 @@
198
200
  "experienceView.debug",
199
201
  "experienceView.delete",
200
202
  "experienceView.get",
203
+ "experienceView.linkedResources",
201
204
  "experienceView.patch",
202
205
  "experienceViews.debug",
203
206
  "experienceViews.detailedSummary",
@@ -263,6 +266,7 @@
263
266
  "org.*",
264
267
  "applications.get",
265
268
  "applications.post",
269
+ "applications.import",
266
270
  "applications.detailedSummary",
267
271
  "auditLog.get",
268
272
  "auditLogs.get",
@@ -58,7 +58,7 @@
58
58
  "keyJson": {
59
59
  "type": "string",
60
60
  "maxLength": 32767,
61
- "minLength": 50
61
+ "minLength": 4
62
62
  }
63
63
  },
64
64
  "additionalProperties": false,
@@ -110,17 +110,17 @@
110
110
  "privateKey": {
111
111
  "type": "string",
112
112
  "maxLength": 32767,
113
- "minLength": 50
113
+ "minLength": 4
114
114
  },
115
115
  "certificate": {
116
116
  "type": "string",
117
117
  "maxLength": 32767,
118
- "minLength": 50
118
+ "minLength": 4
119
119
  },
120
120
  "caCertificate": {
121
121
  "type": "string",
122
122
  "maxLength": 32767,
123
- "minLength": 50
123
+ "minLength": 4
124
124
  }
125
125
  },
126
126
  "additionalProperties": false,
@@ -38,7 +38,7 @@
38
38
  "keyJson": {
39
39
  "type": "string",
40
40
  "maxLength": 32767,
41
- "minLength": 50
41
+ "minLength": 4
42
42
  }
43
43
  },
44
44
  "additionalProperties": false,
@@ -90,17 +90,17 @@
90
90
  "privateKey": {
91
91
  "type": "string",
92
92
  "maxLength": 32767,
93
- "minLength": 50
93
+ "minLength": 4
94
94
  },
95
95
  "certificate": {
96
96
  "type": "string",
97
97
  "maxLength": 32767,
98
- "minLength": 50
98
+ "minLength": 4
99
99
  },
100
100
  "caCertificate": {
101
101
  "type": "string",
102
102
  "maxLength": 32767,
103
- "minLength": 50
103
+ "minLength": 4
104
104
  }
105
105
  },
106
106
  "additionalProperties": false,
@@ -38,7 +38,7 @@
38
38
  "keyJson": {
39
39
  "type": "string",
40
40
  "maxLength": 32767,
41
- "minLength": 50
41
+ "minLength": 4
42
42
  }
43
43
  },
44
44
  "additionalProperties": false,
@@ -90,17 +90,17 @@
90
90
  "privateKey": {
91
91
  "type": "string",
92
92
  "maxLength": 32767,
93
- "minLength": 50
93
+ "minLength": 4
94
94
  },
95
95
  "certificate": {
96
96
  "type": "string",
97
97
  "maxLength": 32767,
98
- "minLength": 50
98
+ "minLength": 4
99
99
  },
100
100
  "caCertificate": {
101
101
  "type": "string",
102
102
  "maxLength": 32767,
103
- "minLength": 50
103
+ "minLength": 4
104
104
  }
105
105
  },
106
106
  "additionalProperties": false,
@@ -65,7 +65,7 @@
65
65
  "keyJson": {
66
66
  "type": "string",
67
67
  "maxLength": 32767,
68
- "minLength": 50
68
+ "minLength": 4
69
69
  }
70
70
  },
71
71
  "additionalProperties": false,
@@ -117,17 +117,17 @@
117
117
  "privateKey": {
118
118
  "type": "string",
119
119
  "maxLength": 32767,
120
- "minLength": 50
120
+ "minLength": 4
121
121
  },
122
122
  "certificate": {
123
123
  "type": "string",
124
124
  "maxLength": 32767,
125
- "minLength": 50
125
+ "minLength": 4
126
126
  },
127
127
  "caCertificate": {
128
128
  "type": "string",
129
129
  "maxLength": 32767,
130
- "minLength": 50
130
+ "minLength": 4
131
131
  }
132
132
  },
133
133
  "additionalProperties": false,
@@ -54,17 +54,38 @@
54
54
  ]
55
55
  },
56
56
  "fileName": {
57
- "type": "string",
58
- "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
57
+ "oneOf": [
58
+ {
59
+ "type": "string",
60
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
61
+ },
62
+ {
63
+ "type": "string",
64
+ "minLength": 4,
65
+ "maxLength": 255,
66
+ "pattern": ".*{{.+}}.*"
67
+ }
68
+ ]
59
69
  },
60
70
  "deviceTags": {
61
71
  "type": "array",
72
+ "maxItems": 100,
62
73
  "items": {
63
74
  "type": "object",
64
75
  "properties": {
65
76
  "key": {
66
- "type": "string",
67
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
77
+ "oneOf": [
78
+ {
79
+ "type": "string",
80
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
81
+ },
82
+ {
83
+ "type": "string",
84
+ "minLength": 4,
85
+ "maxLength": 255,
86
+ "pattern": ".*{{.+}}.*"
87
+ }
88
+ ]
68
89
  },
69
90
  "value": {
70
91
  "type": "string",
@@ -73,16 +94,25 @@
73
94
  }
74
95
  },
75
96
  "additionalProperties": false
76
- },
77
- "maxItems": 100
97
+ }
78
98
  },
79
99
  "deviceIds": {
80
100
  "type": "array",
101
+ "maxItems": 100,
81
102
  "items": {
82
- "type": "string",
83
- "pattern": "^[A-Fa-f\\d]{24}$"
84
- },
85
- "maxItems": 1000
103
+ "oneOf": [
104
+ {
105
+ "type": "string",
106
+ "pattern": "^[A-Fa-f\\d]{24}$"
107
+ },
108
+ {
109
+ "type": "string",
110
+ "minLength": 4,
111
+ "maxLength": 255,
112
+ "pattern": ".*{{.+}}.*"
113
+ }
114
+ ]
115
+ }
86
116
  },
87
117
  "attributes": {
88
118
  "type": "array",
@@ -117,17 +147,38 @@
117
147
  ]
118
148
  },
119
149
  "fileName": {
120
- "type": "string",
121
- "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
150
+ "oneOf": [
151
+ {
152
+ "type": "string",
153
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
154
+ },
155
+ {
156
+ "type": "string",
157
+ "minLength": 4,
158
+ "maxLength": 255,
159
+ "pattern": ".*{{.+}}.*"
160
+ }
161
+ ]
122
162
  },
123
163
  "deviceTags": {
124
164
  "type": "array",
165
+ "maxItems": 100,
125
166
  "items": {
126
167
  "type": "object",
127
168
  "properties": {
128
169
  "key": {
129
- "type": "string",
130
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
170
+ "oneOf": [
171
+ {
172
+ "type": "string",
173
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
174
+ },
175
+ {
176
+ "type": "string",
177
+ "minLength": 4,
178
+ "maxLength": 255,
179
+ "pattern": ".*{{.+}}.*"
180
+ }
181
+ ]
131
182
  },
132
183
  "value": {
133
184
  "type": "string",
@@ -136,16 +187,25 @@
136
187
  }
137
188
  },
138
189
  "additionalProperties": false
139
- },
140
- "maxItems": 100
190
+ }
141
191
  },
142
192
  "deviceIds": {
143
193
  "type": "array",
194
+ "maxItems": 100,
144
195
  "items": {
145
- "type": "string",
146
- "pattern": "^[A-Fa-f\\d]{24}$"
147
- },
148
- "maxItems": 1000
196
+ "oneOf": [
197
+ {
198
+ "type": "string",
199
+ "pattern": "^[A-Fa-f\\d]{24}$"
200
+ },
201
+ {
202
+ "type": "string",
203
+ "minLength": 4,
204
+ "maxLength": 255,
205
+ "pattern": ".*{{.+}}.*"
206
+ }
207
+ ]
208
+ }
149
209
  }
150
210
  },
151
211
  "required": [
@@ -164,12 +224,32 @@
164
224
  ]
165
225
  },
166
226
  "fileName": {
167
- "type": "string",
168
- "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
227
+ "oneOf": [
228
+ {
229
+ "type": "string",
230
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
231
+ },
232
+ {
233
+ "type": "string",
234
+ "minLength": 4,
235
+ "maxLength": 255,
236
+ "pattern": ".*{{.+}}.*"
237
+ }
238
+ ]
169
239
  },
170
240
  "dataTableId": {
171
- "type": "string",
172
- "pattern": "^[A-Fa-f\\d]{24}$"
241
+ "oneOf": [
242
+ {
243
+ "type": "string",
244
+ "pattern": "^[A-Fa-f\\d]{24}$"
245
+ },
246
+ {
247
+ "type": "string",
248
+ "minLength": 4,
249
+ "maxLength": 255,
250
+ "pattern": ".*{{.+}}.*"
251
+ }
252
+ ]
173
253
  },
174
254
  "queryJson": {
175
255
  "type": "string",
@@ -189,12 +269,56 @@
189
269
  "inputType": {
190
270
  "type": "string",
191
271
  "enum": [
192
- "externalUrl"
272
+ "eventData"
193
273
  ]
194
274
  },
195
275
  "fileName": {
276
+ "oneOf": [
277
+ {
278
+ "type": "string",
279
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
280
+ },
281
+ {
282
+ "type": "string",
283
+ "minLength": 4,
284
+ "maxLength": 255,
285
+ "pattern": ".*{{.+}}.*"
286
+ }
287
+ ]
288
+ },
289
+ "queryJson": {
290
+ "type": "string",
291
+ "maxLength": 32767
292
+ }
293
+ },
294
+ "required": [
295
+ "inputType",
296
+ "fileName"
297
+ ],
298
+ "additionalProperties": false
299
+ },
300
+ {
301
+ "type": "object",
302
+ "properties": {
303
+ "inputType": {
196
304
  "type": "string",
197
- "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
305
+ "enum": [
306
+ "externalUrl"
307
+ ]
308
+ },
309
+ "fileName": {
310
+ "oneOf": [
311
+ {
312
+ "type": "string",
313
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
314
+ },
315
+ {
316
+ "type": "string",
317
+ "minLength": 4,
318
+ "maxLength": 255,
319
+ "pattern": ".*{{.+}}.*"
320
+ }
321
+ ]
198
322
  },
199
323
  "sourceUrl": {
200
324
  "type": "string",
@@ -227,12 +351,32 @@
227
351
  ]
228
352
  },
229
353
  "fileName": {
230
- "type": "string",
231
- "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
354
+ "oneOf": [
355
+ {
356
+ "type": "string",
357
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
358
+ },
359
+ {
360
+ "type": "string",
361
+ "minLength": 4,
362
+ "maxLength": 255,
363
+ "pattern": ".*{{.+}}.*"
364
+ }
365
+ ]
232
366
  },
233
367
  "dataTableId": {
234
- "type": "string",
235
- "pattern": "^[A-Fa-f\\d]{24}$"
368
+ "oneOf": [
369
+ {
370
+ "type": "string",
371
+ "pattern": "^[A-Fa-f\\d]{24}$"
372
+ },
373
+ {
374
+ "type": "string",
375
+ "minLength": 4,
376
+ "maxLength": 255,
377
+ "pattern": ".*{{.+}}.*"
378
+ }
379
+ ]
236
380
  },
237
381
  "createMissingColumns": {
238
382
  "type": "boolean"
@@ -258,8 +402,18 @@
258
402
  ]
259
403
  },
260
404
  "fileName": {
261
- "type": "string",
262
- "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
405
+ "oneOf": [
406
+ {
407
+ "type": "string",
408
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
409
+ },
410
+ {
411
+ "type": "string",
412
+ "minLength": 4,
413
+ "maxLength": 255,
414
+ "pattern": ".*{{.+}}.*"
415
+ }
416
+ ]
263
417
  },
264
418
  "destinationDirectoryTemplate": {
265
419
  "type": "string",
@@ -289,8 +443,18 @@
289
443
  ]
290
444
  },
291
445
  "directoryName": {
292
- "type": "string",
293
- "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
446
+ "oneOf": [
447
+ {
448
+ "type": "string",
449
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
450
+ },
451
+ {
452
+ "type": "string",
453
+ "minLength": 4,
454
+ "maxLength": 255,
455
+ "pattern": ".*{{.+}}.*"
456
+ }
457
+ ]
294
458
  },
295
459
  "destinationDirectoryTemplate": {
296
460
  "type": "string",