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/_schemas.md CHANGED
@@ -15217,6 +15217,60 @@ Schema for a single Application
15217
15217
  },
15218
15218
  "maxItems": 1000
15219
15219
  },
15220
+ "includeApplicationExport": {
15221
+ "type": "boolean",
15222
+ "default": false
15223
+ },
15224
+ "applicationExportOptions": {
15225
+ "type": "object",
15226
+ "properties": {
15227
+ "includeFiles": {
15228
+ "type": "boolean",
15229
+ "default": false
15230
+ },
15231
+ "includeDataTableRows": {
15232
+ "type": "boolean",
15233
+ "default": false
15234
+ },
15235
+ "includeDevices": {
15236
+ "type": "boolean",
15237
+ "default": false
15238
+ },
15239
+ "exportType": {
15240
+ "type": "string",
15241
+ "enum": [
15242
+ "repo"
15243
+ ],
15244
+ "default": "repo"
15245
+ },
15246
+ "credentialName": {
15247
+ "type": "string",
15248
+ "minLength": 1,
15249
+ "maxLength": 255
15250
+ },
15251
+ "repo": {
15252
+ "type": "object",
15253
+ "properties": {
15254
+ "branch": {
15255
+ "type": "string",
15256
+ "maxLength": 255
15257
+ },
15258
+ "directory": {
15259
+ "type": "string",
15260
+ "maxLength": 1024
15261
+ },
15262
+ "commitMessage": {
15263
+ "type": "string",
15264
+ "maxLength": 1024
15265
+ }
15266
+ }
15267
+ }
15268
+ },
15269
+ "required": [
15270
+ "credentialName"
15271
+ ],
15272
+ "additionalProperties": false
15273
+ },
15220
15274
  "delayDays": {
15221
15275
  "type": "integer",
15222
15276
  "minimum": 1
@@ -16929,6 +16983,60 @@ Schema for creating an application by template result
16929
16983
  },
16930
16984
  "maxItems": 1000
16931
16985
  },
16986
+ "includeApplicationExport": {
16987
+ "type": "boolean",
16988
+ "default": false
16989
+ },
16990
+ "applicationExportOptions": {
16991
+ "type": "object",
16992
+ "properties": {
16993
+ "includeFiles": {
16994
+ "type": "boolean",
16995
+ "default": false
16996
+ },
16997
+ "includeDataTableRows": {
16998
+ "type": "boolean",
16999
+ "default": false
17000
+ },
17001
+ "includeDevices": {
17002
+ "type": "boolean",
17003
+ "default": false
17004
+ },
17005
+ "exportType": {
17006
+ "type": "string",
17007
+ "enum": [
17008
+ "repo"
17009
+ ],
17010
+ "default": "repo"
17011
+ },
17012
+ "credentialName": {
17013
+ "type": "string",
17014
+ "minLength": 1,
17015
+ "maxLength": 255
17016
+ },
17017
+ "repo": {
17018
+ "type": "object",
17019
+ "properties": {
17020
+ "branch": {
17021
+ "type": "string",
17022
+ "maxLength": 255
17023
+ },
17024
+ "directory": {
17025
+ "type": "string",
17026
+ "maxLength": 1024
17027
+ },
17028
+ "commitMessage": {
17029
+ "type": "string",
17030
+ "maxLength": 1024
17031
+ }
17032
+ }
17033
+ }
17034
+ },
17035
+ "required": [
17036
+ "credentialName"
17037
+ ],
17038
+ "additionalProperties": false
17039
+ },
16932
17040
  "delayDays": {
16933
17041
  "type": "integer",
16934
17042
  "minimum": 1
@@ -23913,7 +24021,7 @@ Schema for a list Application import executions
23913
24021
  "status": "completed",
23914
24022
  "conflictBehavior": "create",
23915
24023
  "dryRun": false,
23916
- "email": "test@losant.com",
24024
+ "email": "email@example.com",
23917
24025
  "include": [
23918
24026
  "ExperienceUser",
23919
24027
  "ExperienceEndpoint",
@@ -25248,159 +25356,220 @@ Schema for the body of an Application modification request
25248
25356
  "maxItems": 100
25249
25357
  },
25250
25358
  "archiveConfig": {
25251
- "type": "object",
25252
- "properties": {
25253
- "directory": {
25254
- "type": "string",
25255
- "maxLength": 255
25256
- },
25257
- "mode": {
25258
- "type": "string",
25259
- "enum": [
25260
- "all",
25261
- "whitelist",
25262
- "blacklist"
25263
- ]
25264
- },
25265
- "deviceIds": {
25266
- "type": "array",
25267
- "items": {
25268
- "type": "string",
25269
- "pattern": "^[A-Fa-f\\d]{24}$"
25270
- },
25271
- "maxItems": 1000
25272
- },
25273
- "deviceTags": {
25274
- "type": "array",
25275
- "items": {
25276
- "type": "object",
25277
- "properties": {
25278
- "key": {
25279
- "type": "string",
25280
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
25281
- },
25282
- "value": {
25283
- "type": "string",
25284
- "minLength": 1,
25285
- "maxLength": 255
25286
- }
25287
- },
25288
- "additionalProperties": false
25289
- },
25290
- "maxItems": 100
25291
- },
25292
- "includeDevices": {
25293
- "type": "boolean",
25294
- "default": true
25295
- },
25296
- "includeEvents": {
25297
- "type": "boolean",
25298
- "default": false
25299
- },
25300
- "includeDataTables": {
25301
- "type": "boolean",
25302
- "default": false
25303
- },
25304
- "dataTablesMode": {
25305
- "type": "string",
25306
- "enum": [
25307
- "all",
25308
- "whitelist",
25309
- "blacklist"
25310
- ]
25311
- },
25312
- "dataTableIds": {
25313
- "type": "array",
25314
- "items": {
25315
- "type": "string",
25316
- "pattern": "^[A-Fa-f\\d]{24}$"
25317
- },
25318
- "maxItems": 1000
25319
- },
25320
- "delayDays": {
25321
- "type": "integer",
25322
- "minimum": 1
25323
- },
25324
- "s3": {
25359
+ "oneOf": [
25360
+ {
25325
25361
  "type": "object",
25326
25362
  "properties": {
25327
- "bucket": {
25363
+ "directory": {
25328
25364
  "type": "string",
25329
25365
  "maxLength": 255
25330
25366
  },
25331
- "accessKeyId": {
25367
+ "mode": {
25332
25368
  "type": "string",
25333
- "minLength": 4,
25334
- "maxLength": 128
25369
+ "enum": [
25370
+ "all",
25371
+ "whitelist",
25372
+ "blacklist"
25373
+ ]
25335
25374
  },
25336
- "secretAccessKey": {
25337
- "type": "string",
25338
- "minLength": 4,
25339
- "maxLength": 128
25375
+ "deviceIds": {
25376
+ "type": "array",
25377
+ "items": {
25378
+ "type": "string",
25379
+ "pattern": "^[A-Fa-f\\d]{24}$"
25380
+ },
25381
+ "maxItems": 1000
25340
25382
  },
25341
- "region": {
25342
- "type": "string",
25343
- "maxLength": 128
25344
- }
25345
- },
25346
- "required": [
25347
- "bucket"
25348
- ],
25349
- "additionalProperties": false
25350
- },
25351
- "credentialName": {
25352
- "type": "string",
25353
- "minLength": 1,
25354
- "maxLength": 255
25355
- },
25356
- "gcs": {
25357
- "type": "object",
25358
- "properties": {
25359
- "projectId": {
25360
- "type": "string",
25361
- "minLength": 1,
25362
- "maxLength": 1024
25383
+ "deviceTags": {
25384
+ "type": "array",
25385
+ "items": {
25386
+ "type": "object",
25387
+ "properties": {
25388
+ "key": {
25389
+ "type": "string",
25390
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
25391
+ },
25392
+ "value": {
25393
+ "type": "string",
25394
+ "minLength": 1,
25395
+ "maxLength": 255
25396
+ }
25397
+ },
25398
+ "additionalProperties": false
25399
+ },
25400
+ "maxItems": 100
25363
25401
  },
25364
- "keyJson": {
25365
- "type": "string",
25366
- "maxLength": 32767,
25367
- "minLength": 4
25402
+ "includeDevices": {
25403
+ "type": "boolean",
25404
+ "default": true
25368
25405
  },
25369
- "bucket": {
25370
- "type": "string",
25371
- "maxLength": 255
25372
- }
25373
- },
25374
- "required": [
25375
- "bucket"
25376
- ],
25377
- "additionalProperties": false
25378
- },
25379
- "azure": {
25380
- "type": "object",
25381
- "properties": {
25382
- "account": {
25406
+ "includeEvents": {
25407
+ "type": "boolean",
25408
+ "default": false
25409
+ },
25410
+ "includeDataTables": {
25411
+ "type": "boolean",
25412
+ "default": false
25413
+ },
25414
+ "dataTablesMode": {
25383
25415
  "type": "string",
25384
- "minLength": 3,
25385
- "maxLength": 24
25416
+ "enum": [
25417
+ "all",
25418
+ "whitelist",
25419
+ "blacklist"
25420
+ ]
25386
25421
  },
25387
- "accountKey": {
25422
+ "dataTableIds": {
25423
+ "type": "array",
25424
+ "items": {
25425
+ "type": "string",
25426
+ "pattern": "^[A-Fa-f\\d]{24}$"
25427
+ },
25428
+ "maxItems": 1000
25429
+ },
25430
+ "includeApplicationExport": {
25431
+ "type": "boolean",
25432
+ "default": false
25433
+ },
25434
+ "applicationExportOptions": {
25435
+ "type": "object",
25436
+ "properties": {
25437
+ "includeFiles": {
25438
+ "type": "boolean",
25439
+ "default": false
25440
+ },
25441
+ "includeDataTableRows": {
25442
+ "type": "boolean",
25443
+ "default": false
25444
+ },
25445
+ "includeDevices": {
25446
+ "type": "boolean",
25447
+ "default": false
25448
+ },
25449
+ "exportType": {
25450
+ "type": "string",
25451
+ "enum": [
25452
+ "repo"
25453
+ ],
25454
+ "default": "repo"
25455
+ },
25456
+ "credentialName": {
25457
+ "type": "string",
25458
+ "minLength": 1,
25459
+ "maxLength": 255
25460
+ },
25461
+ "repo": {
25462
+ "type": "object",
25463
+ "properties": {
25464
+ "branch": {
25465
+ "type": "string",
25466
+ "maxLength": 255
25467
+ },
25468
+ "directory": {
25469
+ "type": "string",
25470
+ "maxLength": 1024
25471
+ },
25472
+ "commitMessage": {
25473
+ "type": "string",
25474
+ "maxLength": 1024
25475
+ }
25476
+ }
25477
+ }
25478
+ },
25479
+ "required": [
25480
+ "credentialName"
25481
+ ],
25482
+ "additionalProperties": false
25483
+ },
25484
+ "delayDays": {
25485
+ "type": "integer",
25486
+ "minimum": 1
25487
+ },
25488
+ "s3": {
25489
+ "type": "object",
25490
+ "properties": {
25491
+ "bucket": {
25492
+ "type": "string",
25493
+ "maxLength": 255
25494
+ },
25495
+ "accessKeyId": {
25496
+ "type": "string",
25497
+ "minLength": 4,
25498
+ "maxLength": 128
25499
+ },
25500
+ "secretAccessKey": {
25501
+ "type": "string",
25502
+ "minLength": 4,
25503
+ "maxLength": 128
25504
+ },
25505
+ "region": {
25506
+ "type": "string",
25507
+ "maxLength": 128
25508
+ }
25509
+ },
25510
+ "required": [
25511
+ "bucket"
25512
+ ],
25513
+ "additionalProperties": false
25514
+ },
25515
+ "credentialName": {
25388
25516
  "type": "string",
25517
+ "minLength": 1,
25389
25518
  "maxLength": 255
25390
25519
  },
25391
- "bucket": {
25392
- "type": "string",
25393
- "minLength": 3,
25394
- "maxLength": 63
25520
+ "gcs": {
25521
+ "type": "object",
25522
+ "properties": {
25523
+ "projectId": {
25524
+ "type": "string",
25525
+ "minLength": 1,
25526
+ "maxLength": 1024
25527
+ },
25528
+ "keyJson": {
25529
+ "type": "string",
25530
+ "maxLength": 32767,
25531
+ "minLength": 4
25532
+ },
25533
+ "bucket": {
25534
+ "type": "string",
25535
+ "maxLength": 255
25536
+ }
25537
+ },
25538
+ "required": [
25539
+ "bucket"
25540
+ ],
25541
+ "additionalProperties": false
25542
+ },
25543
+ "azure": {
25544
+ "type": "object",
25545
+ "properties": {
25546
+ "account": {
25547
+ "type": "string",
25548
+ "minLength": 3,
25549
+ "maxLength": 24
25550
+ },
25551
+ "accountKey": {
25552
+ "type": "string",
25553
+ "maxLength": 255
25554
+ },
25555
+ "bucket": {
25556
+ "type": "string",
25557
+ "minLength": 3,
25558
+ "maxLength": 63
25559
+ }
25560
+ },
25561
+ "required": [
25562
+ "bucket"
25563
+ ],
25564
+ "additionalProperties": false
25395
25565
  }
25396
25566
  },
25397
- "required": [
25398
- "bucket"
25399
- ],
25400
25567
  "additionalProperties": false
25568
+ },
25569
+ {
25570
+ "type": "null"
25401
25571
  }
25402
- },
25403
- "additionalProperties": false
25572
+ ]
25404
25573
  },
25405
25574
  "blobUrlTTL": {
25406
25575
  "type": "number",
@@ -25572,6 +25741,60 @@ Schema for the body of an Application creation request
25572
25741
  },
25573
25742
  "maxItems": 1000
25574
25743
  },
25744
+ "includeApplicationExport": {
25745
+ "type": "boolean",
25746
+ "default": false
25747
+ },
25748
+ "applicationExportOptions": {
25749
+ "type": "object",
25750
+ "properties": {
25751
+ "includeFiles": {
25752
+ "type": "boolean",
25753
+ "default": false
25754
+ },
25755
+ "includeDataTableRows": {
25756
+ "type": "boolean",
25757
+ "default": false
25758
+ },
25759
+ "includeDevices": {
25760
+ "type": "boolean",
25761
+ "default": false
25762
+ },
25763
+ "exportType": {
25764
+ "type": "string",
25765
+ "enum": [
25766
+ "repo"
25767
+ ],
25768
+ "default": "repo"
25769
+ },
25770
+ "credentialName": {
25771
+ "type": "string",
25772
+ "minLength": 1,
25773
+ "maxLength": 255
25774
+ },
25775
+ "repo": {
25776
+ "type": "object",
25777
+ "properties": {
25778
+ "branch": {
25779
+ "type": "string",
25780
+ "maxLength": 255
25781
+ },
25782
+ "directory": {
25783
+ "type": "string",
25784
+ "maxLength": 1024
25785
+ },
25786
+ "commitMessage": {
25787
+ "type": "string",
25788
+ "maxLength": 1024
25789
+ }
25790
+ }
25791
+ }
25792
+ },
25793
+ "required": [
25794
+ "credentialName"
25795
+ ],
25796
+ "additionalProperties": false
25797
+ },
25575
25798
  "delayDays": {
25576
25799
  "type": "integer",
25577
25800
  "minimum": 1
@@ -26901,6 +27124,60 @@ Schema for a collection of Applications
26901
27124
  },
26902
27125
  "maxItems": 1000
26903
27126
  },
27127
+ "includeApplicationExport": {
27128
+ "type": "boolean",
27129
+ "default": false
27130
+ },
27131
+ "applicationExportOptions": {
27132
+ "type": "object",
27133
+ "properties": {
27134
+ "includeFiles": {
27135
+ "type": "boolean",
27136
+ "default": false
27137
+ },
27138
+ "includeDataTableRows": {
27139
+ "type": "boolean",
27140
+ "default": false
27141
+ },
27142
+ "includeDevices": {
27143
+ "type": "boolean",
27144
+ "default": false
27145
+ },
27146
+ "exportType": {
27147
+ "type": "string",
27148
+ "enum": [
27149
+ "repo"
27150
+ ],
27151
+ "default": "repo"
27152
+ },
27153
+ "credentialName": {
27154
+ "type": "string",
27155
+ "minLength": 1,
27156
+ "maxLength": 255
27157
+ },
27158
+ "repo": {
27159
+ "type": "object",
27160
+ "properties": {
27161
+ "branch": {
27162
+ "type": "string",
27163
+ "maxLength": 255
27164
+ },
27165
+ "directory": {
27166
+ "type": "string",
27167
+ "maxLength": 1024
27168
+ },
27169
+ "commitMessage": {
27170
+ "type": "string",
27171
+ "maxLength": 1024
27172
+ }
27173
+ }
27174
+ }
27175
+ },
27176
+ "required": [
27177
+ "credentialName"
27178
+ ],
27179
+ "additionalProperties": false
27180
+ },
26904
27181
  "delayDays": {
26905
27182
  "type": "integer",
26906
27183
  "minimum": 1
@@ -100656,6 +100933,18 @@ Schema for a single Experience Version
100656
100933
  }
100657
100934
  ]
100658
100935
  },
100936
+ "responseHeaders": {
100937
+ "type": "object",
100938
+ "patternProperties": {
100939
+ "^.{1,255}$": {
100940
+ "type": "string",
100941
+ "minLength": 1,
100942
+ "maxLength": 1024
100943
+ }
100944
+ },
100945
+ "maxProperties": 10,
100946
+ "additionalProperties": false
100947
+ },
100659
100948
  "attachedDomains": {
100660
100949
  "type": "array",
100661
100950
  "items": {
@@ -100841,6 +101130,18 @@ Schema for the body of an Experience Version modification request
100841
101130
  "type": "string",
100842
101131
  "minLength": 1,
100843
101132
  "maxLength": 255
101133
+ },
101134
+ "responseHeaders": {
101135
+ "type": "object",
101136
+ "patternProperties": {
101137
+ "^.{1,255}$": {
101138
+ "type": "string",
101139
+ "minLength": 1,
101140
+ "maxLength": 1024
101141
+ }
101142
+ },
101143
+ "maxProperties": 10,
101144
+ "additionalProperties": false
100844
101145
  }
100845
101146
  },
100846
101147
  "additionalProperties": false
@@ -100994,6 +101295,18 @@ Schema for the body of an Experience Version creation request
100994
101295
  "maxLength": 270
100995
101296
  },
100996
101297
  "maxItems": 100
101298
+ },
101299
+ "responseHeaders": {
101300
+ "type": "object",
101301
+ "patternProperties": {
101302
+ "^.{1,255}$": {
101303
+ "type": "string",
101304
+ "minLength": 1,
101305
+ "maxLength": 1024
101306
+ }
101307
+ },
101308
+ "maxProperties": 10,
101309
+ "additionalProperties": false
100997
101310
  }
100998
101311
  },
100999
101312
  "additionalProperties": false,
@@ -101193,6 +101506,18 @@ Schema for a collection of Experience Versions
101193
101506
  }
101194
101507
  ]
101195
101508
  },
101509
+ "responseHeaders": {
101510
+ "type": "object",
101511
+ "patternProperties": {
101512
+ "^.{1,255}$": {
101513
+ "type": "string",
101514
+ "minLength": 1,
101515
+ "maxLength": 1024
101516
+ }
101517
+ },
101518
+ "maxProperties": 10,
101519
+ "additionalProperties": false
101520
+ },
101196
101521
  "attachedDomains": {
101197
101522
  "type": "array",
101198
101523
  "items": {
@@ -166942,7 +167267,7 @@ Schema for a set of Notification Rule delivery logs
166942
167267
  "subject": "Limit Exceeded",
166943
167268
  "body": "Org has exceeded its payload limit",
166944
167269
  "addresses": [
166945
- "alice@exmaple.com"
167270
+ "alice@example.com"
166946
167271
  ]
166947
167272
  },
166948
167273
  "evaluation": {