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/apiTokenPost.json CHANGED
@@ -39,6 +39,8 @@
39
39
  "applicationCertificateAuthorities.*",
40
40
  "applicationDashboards.*",
41
41
  "applicationDashboard.*",
42
+ "applicationJobLogs.*",
43
+ "applicationJobLog.*",
42
44
  "applicationKey.*",
43
45
  "applicationKeys.*",
44
46
  "credential.*",
@@ -130,6 +132,8 @@
130
132
  "applicationDashboard.delete",
131
133
  "applicationDashboards.get",
132
134
  "applicationDashboards.post",
135
+ "applicationJobLogs.get",
136
+ "applicationJobLog.get",
133
137
  "applicationKey.delete",
134
138
  "applicationKey.get",
135
139
  "applicationKey.patch",
data/schemas/application.json CHANGED
@@ -461,6 +461,64 @@
461
461
  },
462
462
  "maxItems": 1000
463
463
  },
464
+ "includeApplicationExport": {
465
+ "type": "boolean",
466
+ "default": false
467
+ },
468
+ "applicationExportOptions": {
469
+ "type": "object",
470
+ "properties": {
471
+ "includeFiles": {
472
+ "type": "boolean",
473
+ "default": false
474
+ },
475
+ "includeDataTableRows": {
476
+ "type": "boolean",
477
+ "default": false
478
+ },
479
+ "includeDevices": {
480
+ "type": "boolean",
481
+ "default": false
482
+ },
483
+ "exportType": {
484
+ "type": "string",
485
+ "enum": [
486
+ "repo"
487
+ ],
488
+ "default": "repo"
489
+ },
490
+ "credentialName": {
491
+ "type": "string",
492
+ "minLength": 1,
493
+ "maxLength": 255
494
+ },
495
+ "repo": {
496
+ "type": "object",
497
+ "properties": {
498
+ "branch": {
499
+ "type": "string",
500
+ "maxLength": 255
501
+ },
502
+ "directory": {
503
+ "type": "string",
504
+ "maxLength": 1024
505
+ },
506
+ "commitMessage": {
507
+ "type": "string",
508
+ "maxLength": 1024
509
+ }
510
+ }
511
+ }
512
+ },
513
+ "required": [
514
+ "credentialName"
515
+ ],
516
+ "additionalProperties": false
517
+ },
518
+ "delayDays": {
519
+ "type": "integer",
520
+ "minimum": 1
521
+ },
464
522
  "s3": {
465
523
  "type": "object",
466
524
  "properties": {
data/schemas/applicationCreationByTemplateResult.json CHANGED
@@ -466,6 +466,64 @@
466
466
  },
467
467
  "maxItems": 1000
468
468
  },
469
+ "includeApplicationExport": {
470
+ "type": "boolean",
471
+ "default": false
472
+ },
473
+ "applicationExportOptions": {
474
+ "type": "object",
475
+ "properties": {
476
+ "includeFiles": {
477
+ "type": "boolean",
478
+ "default": false
479
+ },
480
+ "includeDataTableRows": {
481
+ "type": "boolean",
482
+ "default": false
483
+ },
484
+ "includeDevices": {
485
+ "type": "boolean",
486
+ "default": false
487
+ },
488
+ "exportType": {
489
+ "type": "string",
490
+ "enum": [
491
+ "repo"
492
+ ],
493
+ "default": "repo"
494
+ },
495
+ "credentialName": {
496
+ "type": "string",
497
+ "minLength": 1,
498
+ "maxLength": 255
499
+ },
500
+ "repo": {
501
+ "type": "object",
502
+ "properties": {
503
+ "branch": {
504
+ "type": "string",
505
+ "maxLength": 255
506
+ },
507
+ "directory": {
508
+ "type": "string",
509
+ "maxLength": 1024
510
+ },
511
+ "commitMessage": {
512
+ "type": "string",
513
+ "maxLength": 1024
514
+ }
515
+ }
516
+ }
517
+ },
518
+ "required": [
519
+ "credentialName"
520
+ ],
521
+ "additionalProperties": false
522
+ },
523
+ "delayDays": {
524
+ "type": "integer",
525
+ "minimum": 1
526
+ },
469
527
  "s3": {
470
528
  "type": "object",
471
529
  "properties": {
data/schemas/applicationJobLog.json ADDED
@@ -0,0 +1,250 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "jobId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "jobExecutionId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "name": {
18
+ "type": "string"
19
+ },
20
+ "applicationId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "runQueuedAt": {
25
+ "type": "string",
26
+ "format": "date-time"
27
+ },
28
+ "runStartedAt": {
29
+ "type": "string",
30
+ "format": "date-time"
31
+ },
32
+ "runCompletedAt": {
33
+ "type": "string",
34
+ "format": "date-time"
35
+ },
36
+ "status": {
37
+ "type": "string",
38
+ "enum": [
39
+ "queued",
40
+ "inProgress",
41
+ "completed",
42
+ "errored",
43
+ "failed"
44
+ ]
45
+ },
46
+ "requestedById": {
47
+ "type": "string",
48
+ "pattern": "^[A-Fa-f\\d]{24}$"
49
+ },
50
+ "requestedByType": {
51
+ "type": "string",
52
+ "enum": [
53
+ "user",
54
+ "apiToken",
55
+ "flow",
56
+ "device",
57
+ "system"
58
+ ]
59
+ },
60
+ "ownerType": {
61
+ "type": "string",
62
+ "enum": [
63
+ "application",
64
+ "user",
65
+ "organization"
66
+ ]
67
+ },
68
+ "ownerId": {
69
+ "type": "string",
70
+ "pattern": "^[A-Fa-f\\d]{24}$"
71
+ },
72
+ "resourceType": {
73
+ "type": "string",
74
+ "enum": [
75
+ "application",
76
+ "dashboard",
77
+ "datatable",
78
+ "event",
79
+ "device",
80
+ "notebook",
81
+ "deviceRecipe"
82
+ ]
83
+ },
84
+ "resourceId": {
85
+ "type": "string",
86
+ "pattern": "^[A-Fa-f\\d]{24}$"
87
+ },
88
+ "progress": {
89
+ "type": "object",
90
+ "properties": {
91
+ "completed": {
92
+ "type": "number"
93
+ },
94
+ "total": {
95
+ "type": "number"
96
+ },
97
+ "status": {
98
+ "type": "string"
99
+ }
100
+ }
101
+ },
102
+ "error": {
103
+ "type": "object",
104
+ "properties": {
105
+ "name": {
106
+ "type": "string"
107
+ },
108
+ "message": {
109
+ "type": "string"
110
+ }
111
+ }
112
+ },
113
+ "input": {
114
+ "callbackUrl": {
115
+ "type": "string",
116
+ "format": "uri",
117
+ "maxLength": 1024
118
+ },
119
+ "emails": {
120
+ "type": "array",
121
+ "items": {
122
+ "type": "string",
123
+ "format": "email",
124
+ "maxLength": 1024
125
+ }
126
+ },
127
+ "start": {
128
+ "type": "number"
129
+ },
130
+ "end": {
131
+ "type": "number"
132
+ },
133
+ "gatewayId": {
134
+ "type": "string",
135
+ "pattern": "^[A-Fa-f\\d]{24}$"
136
+ },
137
+ "parentId": {
138
+ "type": "string",
139
+ "pattern": "^[A-Fa-f\\d]{24}$"
140
+ },
141
+ "query": {
142
+ "type": "string"
143
+ },
144
+ "ownerId": {
145
+ "type": "string",
146
+ "pattern": "^[A-Fa-f\\d]{24}$"
147
+ },
148
+ "ownerType": {
149
+ "type": "string",
150
+ "enum": [
151
+ "user",
152
+ "organization"
153
+ ]
154
+ },
155
+ "fileUrl": {
156
+ "type": "string",
157
+ "format": "uri",
158
+ "maxLength": 1024
159
+ },
160
+ "templateContext": {
161
+ "type": "string"
162
+ }
163
+ },
164
+ "output": {
165
+ "downloadUrls": {
166
+ "type": "array",
167
+ "items": {
168
+ "type": "string",
169
+ "format": "uri",
170
+ "maxLength": 1024
171
+ }
172
+ },
173
+ "devicesDirectory": {
174
+ "type": "string"
175
+ },
176
+ "eventsDirectory": {
177
+ "type": "string"
178
+ },
179
+ "dataTablesDirectory": {
180
+ "type": "string"
181
+ },
182
+ "created": {
183
+ "type": "number"
184
+ },
185
+ "failed": {
186
+ "type": "number"
187
+ },
188
+ "removed": {
189
+ "type": "number"
190
+ },
191
+ "restored": {
192
+ "type": "number"
193
+ },
194
+ "repoUrl": {
195
+ "type": "string"
196
+ },
197
+ "commit": {
198
+ "type": "string"
199
+ },
200
+ "noChanges": {
201
+ "type": "boolean"
202
+ },
203
+ "applicationId": {
204
+ "type": "string",
205
+ "pattern": "^[A-Fa-f\\d]{24}$"
206
+ },
207
+ "validationErrors": {
208
+ "type": "array",
209
+ "items": {
210
+ "type": "object",
211
+ "properties": {
212
+ "type": {
213
+ "type": "string"
214
+ },
215
+ "name": {
216
+ "type": "string"
217
+ },
218
+ "id": {
219
+ "type": "string"
220
+ },
221
+ "message": {
222
+ "type": "string"
223
+ }
224
+ }
225
+ }
226
+ },
227
+ "skippedDeviceNotFound": {
228
+ "type": "number"
229
+ },
230
+ "skippedDateTooOld": {
231
+ "type": "number"
232
+ },
233
+ "skippedDateInFuture": {
234
+ "type": "number"
235
+ },
236
+ "skippedInvalidDate": {
237
+ "type": "number"
238
+ },
239
+ "skippedNoValidAttributes": {
240
+ "type": "number"
241
+ },
242
+ "written": {
243
+ "type": "number"
244
+ },
245
+ "eeaBundleVersion": {
246
+ "type": "string"
247
+ }
248
+ }
249
+ }
250
+ }
data/schemas/applicationJobLogs.json ADDED
@@ -0,0 +1,292 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Application Job Log",
9
+ "description": "Schema for a single Application Job Log",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "jobId": {
17
+ "type": "string",
18
+ "pattern": "^[A-Fa-f\\d]{24}$"
19
+ },
20
+ "jobExecutionId": {
21
+ "type": "string",
22
+ "pattern": "^[A-Fa-f\\d]{24}$"
23
+ },
24
+ "name": {
25
+ "type": "string"
26
+ },
27
+ "applicationId": {
28
+ "type": "string",
29
+ "pattern": "^[A-Fa-f\\d]{24}$"
30
+ },
31
+ "runQueuedAt": {
32
+ "type": "string",
33
+ "format": "date-time"
34
+ },
35
+ "runStartedAt": {
36
+ "type": "string",
37
+ "format": "date-time"
38
+ },
39
+ "runCompletedAt": {
40
+ "type": "string",
41
+ "format": "date-time"
42
+ },
43
+ "status": {
44
+ "type": "string",
45
+ "enum": [
46
+ "queued",
47
+ "inProgress",
48
+ "completed",
49
+ "errored",
50
+ "failed"
51
+ ]
52
+ },
53
+ "requestedById": {
54
+ "type": "string",
55
+ "pattern": "^[A-Fa-f\\d]{24}$"
56
+ },
57
+ "requestedByType": {
58
+ "type": "string",
59
+ "enum": [
60
+ "user",
61
+ "apiToken",
62
+ "flow",
63
+ "device",
64
+ "system"
65
+ ]
66
+ },
67
+ "ownerType": {
68
+ "type": "string",
69
+ "enum": [
70
+ "application",
71
+ "user",
72
+ "organization"
73
+ ]
74
+ },
75
+ "ownerId": {
76
+ "type": "string",
77
+ "pattern": "^[A-Fa-f\\d]{24}$"
78
+ },
79
+ "resourceType": {
80
+ "type": "string",
81
+ "enum": [
82
+ "application",
83
+ "dashboard",
84
+ "datatable",
85
+ "event",
86
+ "device",
87
+ "notebook",
88
+ "deviceRecipe"
89
+ ]
90
+ },
91
+ "resourceId": {
92
+ "type": "string",
93
+ "pattern": "^[A-Fa-f\\d]{24}$"
94
+ },
95
+ "progress": {
96
+ "type": "object",
97
+ "properties": {
98
+ "completed": {
99
+ "type": "number"
100
+ },
101
+ "total": {
102
+ "type": "number"
103
+ },
104
+ "status": {
105
+ "type": "string"
106
+ }
107
+ }
108
+ },
109
+ "error": {
110
+ "type": "object",
111
+ "properties": {
112
+ "name": {
113
+ "type": "string"
114
+ },
115
+ "message": {
116
+ "type": "string"
117
+ }
118
+ }
119
+ },
120
+ "input": {
121
+ "callbackUrl": {
122
+ "type": "string",
123
+ "format": "uri",
124
+ "maxLength": 1024
125
+ },
126
+ "emails": {
127
+ "type": "array",
128
+ "items": {
129
+ "type": "string",
130
+ "format": "email",
131
+ "maxLength": 1024
132
+ }
133
+ },
134
+ "start": {
135
+ "type": "number"
136
+ },
137
+ "end": {
138
+ "type": "number"
139
+ },
140
+ "gatewayId": {
141
+ "type": "string",
142
+ "pattern": "^[A-Fa-f\\d]{24}$"
143
+ },
144
+ "parentId": {
145
+ "type": "string",
146
+ "pattern": "^[A-Fa-f\\d]{24}$"
147
+ },
148
+ "query": {
149
+ "type": "string"
150
+ },
151
+ "ownerId": {
152
+ "type": "string",
153
+ "pattern": "^[A-Fa-f\\d]{24}$"
154
+ },
155
+ "ownerType": {
156
+ "type": "string",
157
+ "enum": [
158
+ "user",
159
+ "organization"
160
+ ]
161
+ },
162
+ "fileUrl": {
163
+ "type": "string",
164
+ "format": "uri",
165
+ "maxLength": 1024
166
+ },
167
+ "templateContext": {
168
+ "type": "string"
169
+ }
170
+ },
171
+ "output": {
172
+ "downloadUrls": {
173
+ "type": "array",
174
+ "items": {
175
+ "type": "string",
176
+ "format": "uri",
177
+ "maxLength": 1024
178
+ }
179
+ },
180
+ "devicesDirectory": {
181
+ "type": "string"
182
+ },
183
+ "eventsDirectory": {
184
+ "type": "string"
185
+ },
186
+ "dataTablesDirectory": {
187
+ "type": "string"
188
+ },
189
+ "created": {
190
+ "type": "number"
191
+ },
192
+ "failed": {
193
+ "type": "number"
194
+ },
195
+ "removed": {
196
+ "type": "number"
197
+ },
198
+ "restored": {
199
+ "type": "number"
200
+ },
201
+ "repoUrl": {
202
+ "type": "string"
203
+ },
204
+ "commit": {
205
+ "type": "string"
206
+ },
207
+ "noChanges": {
208
+ "type": "boolean"
209
+ },
210
+ "applicationId": {
211
+ "type": "string",
212
+ "pattern": "^[A-Fa-f\\d]{24}$"
213
+ },
214
+ "validationErrors": {
215
+ "type": "array",
216
+ "items": {
217
+ "type": "object",
218
+ "properties": {
219
+ "type": {
220
+ "type": "string"
221
+ },
222
+ "name": {
223
+ "type": "string"
224
+ },
225
+ "id": {
226
+ "type": "string"
227
+ },
228
+ "message": {
229
+ "type": "string"
230
+ }
231
+ }
232
+ }
233
+ },
234
+ "skippedDeviceNotFound": {
235
+ "type": "number"
236
+ },
237
+ "skippedDateTooOld": {
238
+ "type": "number"
239
+ },
240
+ "skippedDateInFuture": {
241
+ "type": "number"
242
+ },
243
+ "skippedInvalidDate": {
244
+ "type": "number"
245
+ },
246
+ "skippedNoValidAttributes": {
247
+ "type": "number"
248
+ },
249
+ "written": {
250
+ "type": "number"
251
+ },
252
+ "eeaBundleVersion": {
253
+ "type": "string"
254
+ }
255
+ }
256
+ }
257
+ }
258
+ },
259
+ "count": {
260
+ "type": "integer"
261
+ },
262
+ "totalCount": {
263
+ "type": "integer"
264
+ },
265
+ "query": {
266
+ "type": "object"
267
+ },
268
+ "perPage": {
269
+ "type": "integer"
270
+ },
271
+ "page": {
272
+ "type": "integer"
273
+ },
274
+ "sortField": {
275
+ "type": "string"
276
+ },
277
+ "sortDirection": {
278
+ "type": "string",
279
+ "enum": [
280
+ "asc",
281
+ "desc",
282
+ "ASC",
283
+ "DESC",
284
+ ""
285
+ ]
286
+ },
287
+ "applicationId": {
288
+ "type": "string",
289
+ "pattern": "^[A-Fa-f\\d]{24}$"
290
+ }
291
+ }
292
+ }