losant_rest 1.22.1 → 1.22.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +7949 -6016
  3. data/docs/applicationJobLog.md +49 -0
  4. data/docs/applicationJobLogs.md +51 -0
  5. data/docs/data.md +1 -1
  6. data/docs/device.md +1 -0
  7. data/docs/events.md +3 -0
  8. data/docs/experienceEndpoints.md +1 -1
  9. data/lib/platform_rest/application_job_log.rb +81 -0
  10. data/lib/platform_rest/application_job_logs.rb +90 -0
  11. data/lib/platform_rest/client.rb +10 -2
  12. data/lib/platform_rest/data.rb +1 -1
  13. data/lib/platform_rest/device.rb +2 -0
  14. data/lib/platform_rest/events.rb +5 -0
  15. data/lib/platform_rest/version.rb +2 -2
  16. data/lib/platform_rest.rb +2 -0
  17. data/schemas/advancedApplicationJobLogQuery.json +855 -0
  18. data/schemas/apiTokenPost.json +4 -0
  19. data/schemas/application.json +58 -0
  20. data/schemas/applicationCreationByTemplateResult.json +58 -0
  21. data/schemas/applicationJobLog.json +250 -0
  22. data/schemas/applicationJobLogs.json +292 -0
  23. data/schemas/applicationPatch.json +195 -130
  24. data/schemas/applicationPost.json +58 -0
  25. data/schemas/applications.json +58 -0
  26. data/schemas/deviceDataExport.json +48 -0
  27. data/schemas/devicesDataExport.json +2116 -0
  28. data/schemas/experienceVersion.json +12 -0
  29. data/schemas/experienceVersionPatch.json +12 -0
  30. data/schemas/experienceVersionPost.json +12 -0
  31. data/schemas/experienceVersions.json +12 -0
  32. data/schemas/githubLogin.json +4 -0
  33. data/schemas/samlResponse.json +4 -0
  34. data/schemas/userCredentials.json +4 -0
  35. data/schemas/userPost.json +4 -0
  36. metadata +11 -2
data/schemas/applicationPatch.json CHANGED
@@ -85,155 +85,220 @@
85
85
  "maxItems": 100
86
86
  },
87
87
  "archiveConfig": {
88
- "type": "object",
89
- "properties": {
90
- "directory": {
91
- "type": "string",
92
- "maxLength": 255
93
- },
94
- "mode": {
95
- "type": "string",
96
- "enum": [
97
- "all",
98
- "whitelist",
99
- "blacklist"
100
- ]
101
- },
102
- "deviceIds": {
103
- "type": "array",
104
- "items": {
105
- "type": "string",
106
- "pattern": "^[A-Fa-f\\d]{24}$"
107
- },
108
- "maxItems": 1000
109
- },
110
- "deviceTags": {
111
- "type": "array",
112
- "items": {
113
- "type": "object",
114
- "properties": {
115
- "key": {
116
- "type": "string",
117
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
118
- },
119
- "value": {
120
- "type": "string",
121
- "minLength": 1,
122
- "maxLength": 255
123
- }
124
- },
125
- "additionalProperties": false
126
- },
127
- "maxItems": 100
128
- },
129
- "includeDevices": {
130
- "type": "boolean",
131
- "default": true
132
- },
133
- "includeEvents": {
134
- "type": "boolean",
135
- "default": false
136
- },
137
- "includeDataTables": {
138
- "type": "boolean",
139
- "default": false
140
- },
141
- "dataTablesMode": {
142
- "type": "string",
143
- "enum": [
144
- "all",
145
- "whitelist",
146
- "blacklist"
147
- ]
148
- },
149
- "dataTableIds": {
150
- "type": "array",
151
- "items": {
152
- "type": "string",
153
- "pattern": "^[A-Fa-f\\d]{24}$"
154
- },
155
- "maxItems": 1000
156
- },
157
- "s3": {
88
+ "oneOf": [
89
+ {
158
90
  "type": "object",
159
91
  "properties": {
160
- "bucket": {
92
+ "directory": {
161
93
  "type": "string",
162
94
  "maxLength": 255
163
95
  },
164
- "accessKeyId": {
96
+ "mode": {
165
97
  "type": "string",
166
- "minLength": 4,
167
- "maxLength": 128
98
+ "enum": [
99
+ "all",
100
+ "whitelist",
101
+ "blacklist"
102
+ ]
168
103
  },
169
- "secretAccessKey": {
170
- "type": "string",
171
- "minLength": 4,
172
- "maxLength": 128
104
+ "deviceIds": {
105
+ "type": "array",
106
+ "items": {
107
+ "type": "string",
108
+ "pattern": "^[A-Fa-f\\d]{24}$"
109
+ },
110
+ "maxItems": 1000
173
111
  },
174
- "region": {
175
- "type": "string",
176
- "maxLength": 128
177
- }
178
- },
179
- "required": [
180
- "bucket"
181
- ],
182
- "additionalProperties": false
183
- },
184
- "credentialName": {
185
- "type": "string",
186
- "minLength": 1,
187
- "maxLength": 255
188
- },
189
- "gcs": {
190
- "type": "object",
191
- "properties": {
192
- "projectId": {
193
- "type": "string",
194
- "minLength": 1,
195
- "maxLength": 1024
112
+ "deviceTags": {
113
+ "type": "array",
114
+ "items": {
115
+ "type": "object",
116
+ "properties": {
117
+ "key": {
118
+ "type": "string",
119
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
120
+ },
121
+ "value": {
122
+ "type": "string",
123
+ "minLength": 1,
124
+ "maxLength": 255
125
+ }
126
+ },
127
+ "additionalProperties": false
128
+ },
129
+ "maxItems": 100
196
130
  },
197
- "keyJson": {
198
- "type": "string",
199
- "maxLength": 32767,
200
- "minLength": 4
131
+ "includeDevices": {
132
+ "type": "boolean",
133
+ "default": true
201
134
  },
202
- "bucket": {
203
- "type": "string",
204
- "maxLength": 255
205
- }
206
- },
207
- "required": [
208
- "bucket"
209
- ],
210
- "additionalProperties": false
211
- },
212
- "azure": {
213
- "type": "object",
214
- "properties": {
215
- "account": {
135
+ "includeEvents": {
136
+ "type": "boolean",
137
+ "default": false
138
+ },
139
+ "includeDataTables": {
140
+ "type": "boolean",
141
+ "default": false
142
+ },
143
+ "dataTablesMode": {
216
144
  "type": "string",
217
- "minLength": 3,
218
- "maxLength": 24
145
+ "enum": [
146
+ "all",
147
+ "whitelist",
148
+ "blacklist"
149
+ ]
219
150
  },
220
- "accountKey": {
151
+ "dataTableIds": {
152
+ "type": "array",
153
+ "items": {
154
+ "type": "string",
155
+ "pattern": "^[A-Fa-f\\d]{24}$"
156
+ },
157
+ "maxItems": 1000
158
+ },
159
+ "includeApplicationExport": {
160
+ "type": "boolean",
161
+ "default": false
162
+ },
163
+ "applicationExportOptions": {
164
+ "type": "object",
165
+ "properties": {
166
+ "includeFiles": {
167
+ "type": "boolean",
168
+ "default": false
169
+ },
170
+ "includeDataTableRows": {
171
+ "type": "boolean",
172
+ "default": false
173
+ },
174
+ "includeDevices": {
175
+ "type": "boolean",
176
+ "default": false
177
+ },
178
+ "exportType": {
179
+ "type": "string",
180
+ "enum": [
181
+ "repo"
182
+ ],
183
+ "default": "repo"
184
+ },
185
+ "credentialName": {
186
+ "type": "string",
187
+ "minLength": 1,
188
+ "maxLength": 255
189
+ },
190
+ "repo": {
191
+ "type": "object",
192
+ "properties": {
193
+ "branch": {
194
+ "type": "string",
195
+ "maxLength": 255
196
+ },
197
+ "directory": {
198
+ "type": "string",
199
+ "maxLength": 1024
200
+ },
201
+ "commitMessage": {
202
+ "type": "string",
203
+ "maxLength": 1024
204
+ }
205
+ }
206
+ }
207
+ },
208
+ "required": [
209
+ "credentialName"
210
+ ],
211
+ "additionalProperties": false
212
+ },
213
+ "delayDays": {
214
+ "type": "integer",
215
+ "minimum": 1
216
+ },
217
+ "s3": {
218
+ "type": "object",
219
+ "properties": {
220
+ "bucket": {
221
+ "type": "string",
222
+ "maxLength": 255
223
+ },
224
+ "accessKeyId": {
225
+ "type": "string",
226
+ "minLength": 4,
227
+ "maxLength": 128
228
+ },
229
+ "secretAccessKey": {
230
+ "type": "string",
231
+ "minLength": 4,
232
+ "maxLength": 128
233
+ },
234
+ "region": {
235
+ "type": "string",
236
+ "maxLength": 128
237
+ }
238
+ },
239
+ "required": [
240
+ "bucket"
241
+ ],
242
+ "additionalProperties": false
243
+ },
244
+ "credentialName": {
221
245
  "type": "string",
246
+ "minLength": 1,
222
247
  "maxLength": 255
223
248
  },
224
- "bucket": {
225
- "type": "string",
226
- "minLength": 3,
227
- "maxLength": 63
249
+ "gcs": {
250
+ "type": "object",
251
+ "properties": {
252
+ "projectId": {
253
+ "type": "string",
254
+ "minLength": 1,
255
+ "maxLength": 1024
256
+ },
257
+ "keyJson": {
258
+ "type": "string",
259
+ "maxLength": 32767,
260
+ "minLength": 4
261
+ },
262
+ "bucket": {
263
+ "type": "string",
264
+ "maxLength": 255
265
+ }
266
+ },
267
+ "required": [
268
+ "bucket"
269
+ ],
270
+ "additionalProperties": false
271
+ },
272
+ "azure": {
273
+ "type": "object",
274
+ "properties": {
275
+ "account": {
276
+ "type": "string",
277
+ "minLength": 3,
278
+ "maxLength": 24
279
+ },
280
+ "accountKey": {
281
+ "type": "string",
282
+ "maxLength": 255
283
+ },
284
+ "bucket": {
285
+ "type": "string",
286
+ "minLength": 3,
287
+ "maxLength": 63
288
+ }
289
+ },
290
+ "required": [
291
+ "bucket"
292
+ ],
293
+ "additionalProperties": false
228
294
  }
229
295
  },
230
- "required": [
231
- "bucket"
232
- ],
233
296
  "additionalProperties": false
297
+ },
298
+ {
299
+ "type": "null"
234
300
  }
235
- },
236
- "additionalProperties": false
301
+ ]
237
302
  },
238
303
  "blobUrlTTL": {
239
304
  "type": "number",
data/schemas/applicationPost.json CHANGED
@@ -141,6 +141,64 @@
141
141
  },
142
142
  "maxItems": 1000
143
143
  },
144
+ "includeApplicationExport": {
145
+ "type": "boolean",
146
+ "default": false
147
+ },
148
+ "applicationExportOptions": {
149
+ "type": "object",
150
+ "properties": {
151
+ "includeFiles": {
152
+ "type": "boolean",
153
+ "default": false
154
+ },
155
+ "includeDataTableRows": {
156
+ "type": "boolean",
157
+ "default": false
158
+ },
159
+ "includeDevices": {
160
+ "type": "boolean",
161
+ "default": false
162
+ },
163
+ "exportType": {
164
+ "type": "string",
165
+ "enum": [
166
+ "repo"
167
+ ],
168
+ "default": "repo"
169
+ },
170
+ "credentialName": {
171
+ "type": "string",
172
+ "minLength": 1,
173
+ "maxLength": 255
174
+ },
175
+ "repo": {
176
+ "type": "object",
177
+ "properties": {
178
+ "branch": {
179
+ "type": "string",
180
+ "maxLength": 255
181
+ },
182
+ "directory": {
183
+ "type": "string",
184
+ "maxLength": 1024
185
+ },
186
+ "commitMessage": {
187
+ "type": "string",
188
+ "maxLength": 1024
189
+ }
190
+ }
191
+ }
192
+ },
193
+ "required": [
194
+ "credentialName"
195
+ ],
196
+ "additionalProperties": false
197
+ },
198
+ "delayDays": {
199
+ "type": "integer",
200
+ "minimum": 1
201
+ },
144
202
  "s3": {
145
203
  "type": "object",
146
204
  "properties": {
data/schemas/applications.json CHANGED
@@ -468,6 +468,64 @@
468
468
  },
469
469
  "maxItems": 1000
470
470
  },
471
+ "includeApplicationExport": {
472
+ "type": "boolean",
473
+ "default": false
474
+ },
475
+ "applicationExportOptions": {
476
+ "type": "object",
477
+ "properties": {
478
+ "includeFiles": {
479
+ "type": "boolean",
480
+ "default": false
481
+ },
482
+ "includeDataTableRows": {
483
+ "type": "boolean",
484
+ "default": false
485
+ },
486
+ "includeDevices": {
487
+ "type": "boolean",
488
+ "default": false
489
+ },
490
+ "exportType": {
491
+ "type": "string",
492
+ "enum": [
493
+ "repo"
494
+ ],
495
+ "default": "repo"
496
+ },
497
+ "credentialName": {
498
+ "type": "string",
499
+ "minLength": 1,
500
+ "maxLength": 255
501
+ },
502
+ "repo": {
503
+ "type": "object",
504
+ "properties": {
505
+ "branch": {
506
+ "type": "string",
507
+ "maxLength": 255
508
+ },
509
+ "directory": {
510
+ "type": "string",
511
+ "maxLength": 1024
512
+ },
513
+ "commitMessage": {
514
+ "type": "string",
515
+ "maxLength": 1024
516
+ }
517
+ }
518
+ }
519
+ },
520
+ "required": [
521
+ "credentialName"
522
+ ],
523
+ "additionalProperties": false
524
+ },
525
+ "delayDays": {
526
+ "type": "integer",
527
+ "minimum": 1
528
+ },
471
529
  "s3": {
472
530
  "type": "object",
473
531
  "properties": {
data/schemas/deviceDataExport.json ADDED
@@ -0,0 +1,48 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "email": {
6
+ "type": "string",
7
+ "format": "email",
8
+ "maxLength": 1024
9
+ },
10
+ "callbackUrl": {
11
+ "type": "string",
12
+ "format": "uri",
13
+ "maxLength": 1024
14
+ },
15
+ "attributes": {
16
+ "type": "array",
17
+ "maxItems": 256,
18
+ "items": {
19
+ "type": "string",
20
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
21
+ }
22
+ },
23
+ "start": {
24
+ "type": "number"
25
+ },
26
+ "end": {
27
+ "type": "number"
28
+ },
29
+ "options": {
30
+ "type": "object",
31
+ "properties": {
32
+ "includeDate": {
33
+ "type": "boolean",
34
+ "default": true
35
+ },
36
+ "includeID": {
37
+ "type": "boolean",
38
+ "default": true
39
+ },
40
+ "includeBlobData": {
41
+ "type": "boolean",
42
+ "default": false
43
+ }
44
+ }
45
+ }
46
+ },
47
+ "additionalProperties": false
48
+ }