losant_rest 1.22.2 → 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 (15) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +461 -136
  3. data/docs/experienceEndpoints.md +1 -1
  4. data/lib/platform_rest/client.rb +2 -2
  5. data/lib/platform_rest/version.rb +2 -2
  6. data/schemas/application.json +54 -0
  7. data/schemas/applicationCreationByTemplateResult.json +54 -0
  8. data/schemas/applicationPatch.json +195 -134
  9. data/schemas/applicationPost.json +54 -0
  10. data/schemas/applications.json +54 -0
  11. data/schemas/experienceVersion.json +12 -0
  12. data/schemas/experienceVersionPatch.json +12 -0
  13. data/schemas/experienceVersionPost.json +12 -0
  14. data/schemas/experienceVersions.json +12 -0
  15. metadata +2 -2
data/docs/experienceEndpoints.md CHANGED
@@ -121,7 +121,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
121
121
  | end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
122
122
  | resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
123
123
  | versionFilter | string | N | Filters the stats to a particular experience version | | myVersion |
124
- | domainFilter | string | N | Filters the stats to a particular experience domain or slug | | mycustomdomain.com |
124
+ | domainFilter | string | N | Filters the stats to a particular experience domain or slug | | example.com |
125
125
  | statusCodeFilter | string | N | Filters the stats to a particular status code | | 200 |
126
126
  | endpointIdFilter | string | N | Filters the stats to a particular endpoint | | 575ec8687ae143cd83dc4a98 |
127
127
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
data/lib/platform_rest/client.rb CHANGED
@@ -27,7 +27,7 @@ module PlatformRest
27
27
  #
28
28
  # User API for accessing platform data
29
29
  #
30
- # Built For Version 1.28.1
30
+ # Built For Version 1.28.3
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -422,7 +422,7 @@ module PlatformRest
422
422
 
423
423
  headers["Accept"] = "application/json"
424
424
  headers["Content-Type"] = "application/json"
425
- headers["Accept-Version"] = "^1.28.1"
425
+ headers["Accept-Version"] = "^1.28.3"
426
426
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
427
427
  path = self.url + options.fetch(:path, "")
428
428
 
data/lib/platform_rest/version.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  # The MIT License (MIT)
2
2
  #
3
- # Copyright (c) 2024 Losant IoT, Inc.
3
+ # Copyright (c) 2025 Losant IoT, Inc.
4
4
  #
5
5
  # Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  # of this software and associated documentation files (the "Software"), to deal
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module PlatformRest
24
- VERSION = "1.22.2"
24
+ VERSION = "1.22.3"
25
25
  end
data/schemas/application.json CHANGED
@@ -461,6 +461,60 @@
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
+ },
464
518
  "delayDays": {
465
519
  "type": "integer",
466
520
  "minimum": 1
data/schemas/applicationCreationByTemplateResult.json CHANGED
@@ -466,6 +466,60 @@
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
+ },
469
523
  "delayDays": {
470
524
  "type": "integer",
471
525
  "minimum": 1
data/schemas/applicationPatch.json CHANGED
@@ -85,159 +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
- "delayDays": {
158
- "type": "integer",
159
- "minimum": 1
160
- },
161
- "s3": {
88
+ "oneOf": [
89
+ {
162
90
  "type": "object",
163
91
  "properties": {
164
- "bucket": {
92
+ "directory": {
165
93
  "type": "string",
166
94
  "maxLength": 255
167
95
  },
168
- "accessKeyId": {
96
+ "mode": {
169
97
  "type": "string",
170
- "minLength": 4,
171
- "maxLength": 128
98
+ "enum": [
99
+ "all",
100
+ "whitelist",
101
+ "blacklist"
102
+ ]
172
103
  },
173
- "secretAccessKey": {
174
- "type": "string",
175
- "minLength": 4,
176
- "maxLength": 128
104
+ "deviceIds": {
105
+ "type": "array",
106
+ "items": {
107
+ "type": "string",
108
+ "pattern": "^[A-Fa-f\\d]{24}$"
109
+ },
110
+ "maxItems": 1000
177
111
  },
178
- "region": {
179
- "type": "string",
180
- "maxLength": 128
181
- }
182
- },
183
- "required": [
184
- "bucket"
185
- ],
186
- "additionalProperties": false
187
- },
188
- "credentialName": {
189
- "type": "string",
190
- "minLength": 1,
191
- "maxLength": 255
192
- },
193
- "gcs": {
194
- "type": "object",
195
- "properties": {
196
- "projectId": {
197
- "type": "string",
198
- "minLength": 1,
199
- "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
200
130
  },
201
- "keyJson": {
202
- "type": "string",
203
- "maxLength": 32767,
204
- "minLength": 4
131
+ "includeDevices": {
132
+ "type": "boolean",
133
+ "default": true
205
134
  },
206
- "bucket": {
207
- "type": "string",
208
- "maxLength": 255
209
- }
210
- },
211
- "required": [
212
- "bucket"
213
- ],
214
- "additionalProperties": false
215
- },
216
- "azure": {
217
- "type": "object",
218
- "properties": {
219
- "account": {
135
+ "includeEvents": {
136
+ "type": "boolean",
137
+ "default": false
138
+ },
139
+ "includeDataTables": {
140
+ "type": "boolean",
141
+ "default": false
142
+ },
143
+ "dataTablesMode": {
220
144
  "type": "string",
221
- "minLength": 3,
222
- "maxLength": 24
145
+ "enum": [
146
+ "all",
147
+ "whitelist",
148
+ "blacklist"
149
+ ]
150
+ },
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
223
243
  },
224
- "accountKey": {
244
+ "credentialName": {
225
245
  "type": "string",
246
+ "minLength": 1,
226
247
  "maxLength": 255
227
248
  },
228
- "bucket": {
229
- "type": "string",
230
- "minLength": 3,
231
- "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
232
294
  }
233
295
  },
234
- "required": [
235
- "bucket"
236
- ],
237
296
  "additionalProperties": false
297
+ },
298
+ {
299
+ "type": "null"
238
300
  }
239
- },
240
- "additionalProperties": false
301
+ ]
241
302
  },
242
303
  "blobUrlTTL": {
243
304
  "type": "number",
data/schemas/applicationPost.json CHANGED
@@ -141,6 +141,60 @@
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
+ },
144
198
  "delayDays": {
145
199
  "type": "integer",
146
200
  "minimum": 1
data/schemas/applications.json CHANGED
@@ -468,6 +468,60 @@
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
+ },
471
525
  "delayDays": {
472
526
  "type": "integer",
473
527
  "minimum": 1
data/schemas/experienceVersion.json CHANGED
@@ -158,6 +158,18 @@
158
158
  }
159
159
  ]
160
160
  },
161
+ "responseHeaders": {
162
+ "type": "object",
163
+ "patternProperties": {
164
+ "^.{1,255}$": {
165
+ "type": "string",
166
+ "minLength": 1,
167
+ "maxLength": 1024
168
+ }
169
+ },
170
+ "maxProperties": 10,
171
+ "additionalProperties": false
172
+ },
161
173
  "attachedDomains": {
162
174
  "type": "array",
163
175
  "items": {
data/schemas/experienceVersionPatch.json CHANGED
@@ -113,6 +113,18 @@
113
113
  "type": "string",
114
114
  "minLength": 1,
115
115
  "maxLength": 255
116
+ },
117
+ "responseHeaders": {
118
+ "type": "object",
119
+ "patternProperties": {
120
+ "^.{1,255}$": {
121
+ "type": "string",
122
+ "minLength": 1,
123
+ "maxLength": 1024
124
+ }
125
+ },
126
+ "maxProperties": 10,
127
+ "additionalProperties": false
116
128
  }
117
129
  },
118
130
  "additionalProperties": false