@seamapi/types 1.358.0 → 1.359.0

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 (35) hide show
  1. package/dist/connect.cjs +467 -10
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2286 -812
  4. package/lib/seam/connect/model-types.d.ts +1 -1
  5. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +100 -0
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +100 -0
  7. package/lib/seam/connect/models/acs/acs-access-group.d.ts +14 -14
  8. package/lib/seam/connect/models/acs/acs-credential.d.ts +74 -74
  9. package/lib/seam/connect/models/acs/acs-encoder.d.ts +8 -8
  10. package/lib/seam/connect/models/acs/acs-system.d.ts +72 -72
  11. package/lib/seam/connect/models/acs/acs-user.d.ts +104 -104
  12. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +168 -168
  13. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +72 -72
  14. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +96 -96
  15. package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +2 -2
  16. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +634 -21
  17. package/lib/seam/connect/models/connected-accounts/connected-account.js +56 -0
  18. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  19. package/lib/seam/connect/models/devices/device-metadata.d.ts +24 -24
  20. package/lib/seam/connect/models/devices/device.d.ts +146 -46
  21. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +127 -27
  22. package/lib/seam/connect/models/events/access-codes.d.ts +68 -68
  23. package/lib/seam/connect/models/events/connect-webviews.d.ts +4 -4
  24. package/lib/seam/connect/models/events/connected-accounts.d.ts +28 -28
  25. package/lib/seam/connect/models/events/devices.d.ts +128 -128
  26. package/lib/seam/connect/models/events/seam-event.d.ts +114 -114
  27. package/lib/seam/connect/openapi.d.ts +366 -4
  28. package/lib/seam/connect/openapi.js +415 -2
  29. package/lib/seam/connect/openapi.js.map +1 -1
  30. package/lib/seam/connect/route-types.d.ts +567 -0
  31. package/package.json +1 -1
  32. package/src/lib/seam/connect/model-types.ts +0 -2
  33. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +77 -2
  34. package/src/lib/seam/connect/openapi.ts +445 -2
  35. package/src/lib/seam/connect/route-types.ts +597 -0
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -523,6 +523,12 @@ export default {
523
523
  {
524
524
  description: 'Account is disconnected.',
525
525
  properties: {
526
+ created_at: {
527
+ description:
528
+ 'Date and time at which Seam created the error.',
529
+ format: 'date-time',
530
+ type: 'string',
531
+ },
526
532
  error_code: {
527
533
  description:
528
534
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -536,6 +542,7 @@ export default {
536
542
  message: { type: 'string' },
537
543
  },
538
544
  required: [
545
+ 'created_at',
539
546
  'message',
540
547
  'is_connected_account_error',
541
548
  'error_code',
@@ -545,6 +552,12 @@ export default {
545
552
  {
546
553
  description: 'Credentials provided were invalid.',
547
554
  properties: {
555
+ created_at: {
556
+ description:
557
+ 'Date and time at which Seam created the error.',
558
+ format: 'date-time',
559
+ type: 'string',
560
+ },
548
561
  error_code: {
549
562
  description:
550
563
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -558,9 +571,71 @@ export default {
558
571
  message: { type: 'string' },
559
572
  },
560
573
  required: [
574
+ 'created_at',
575
+ 'message',
576
+ 'is_connected_account_error',
577
+ 'error_code',
578
+ ],
579
+ type: 'object',
580
+ },
581
+ {
582
+ description:
583
+ 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
584
+ properties: {
585
+ created_at: {
586
+ description:
587
+ 'Date and time at which Seam created the error.',
588
+ format: 'date-time',
589
+ type: 'string',
590
+ },
591
+ error_code: {
592
+ description:
593
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
594
+ enum: ['salto_ks_subscription_limit_exceeded'],
595
+ type: 'string',
596
+ },
597
+ is_connected_account_error: {
598
+ enum: [true],
599
+ type: 'boolean',
600
+ },
601
+ message: { type: 'string' },
602
+ salto_ks_metadata: {
603
+ properties: {
604
+ sites: {
605
+ items: {
606
+ properties: {
607
+ site_id: { type: 'string' },
608
+ site_name: { type: 'string' },
609
+ site_user_subscription_limit: {
610
+ minimum: 0,
611
+ type: 'integer',
612
+ },
613
+ subscribed_site_user_count: {
614
+ minimum: 0,
615
+ type: 'integer',
616
+ },
617
+ },
618
+ required: [
619
+ 'site_id',
620
+ 'site_name',
621
+ 'subscribed_site_user_count',
622
+ 'site_user_subscription_limit',
623
+ ],
624
+ type: 'object',
625
+ },
626
+ type: 'array',
627
+ },
628
+ },
629
+ required: ['sites'],
630
+ type: 'object',
631
+ },
632
+ },
633
+ required: [
634
+ 'created_at',
561
635
  'message',
562
636
  'is_connected_account_error',
563
637
  'error_code',
638
+ 'salto_ks_metadata',
564
639
  ],
565
640
  type: 'object',
566
641
  },
@@ -5260,6 +5335,12 @@ export default {
5260
5335
  {
5261
5336
  description: 'Account is disconnected.',
5262
5337
  properties: {
5338
+ created_at: {
5339
+ description:
5340
+ 'Date and time at which Seam created the error.',
5341
+ format: 'date-time',
5342
+ type: 'string',
5343
+ },
5263
5344
  error_code: {
5264
5345
  description:
5265
5346
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5273,6 +5354,7 @@ export default {
5273
5354
  message: { type: 'string' },
5274
5355
  },
5275
5356
  required: [
5357
+ 'created_at',
5276
5358
  'message',
5277
5359
  'is_connected_account_error',
5278
5360
  'error_code',
@@ -5282,6 +5364,12 @@ export default {
5282
5364
  {
5283
5365
  description: 'Credentials provided were invalid.',
5284
5366
  properties: {
5367
+ created_at: {
5368
+ description:
5369
+ 'Date and time at which Seam created the error.',
5370
+ format: 'date-time',
5371
+ type: 'string',
5372
+ },
5285
5373
  error_code: {
5286
5374
  description:
5287
5375
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5295,12 +5383,74 @@ export default {
5295
5383
  message: { type: 'string' },
5296
5384
  },
5297
5385
  required: [
5386
+ 'created_at',
5298
5387
  'message',
5299
5388
  'is_connected_account_error',
5300
5389
  'error_code',
5301
5390
  ],
5302
5391
  type: 'object',
5303
5392
  },
5393
+ {
5394
+ description:
5395
+ 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
5396
+ properties: {
5397
+ created_at: {
5398
+ description:
5399
+ 'Date and time at which Seam created the error.',
5400
+ format: 'date-time',
5401
+ type: 'string',
5402
+ },
5403
+ error_code: {
5404
+ description:
5405
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5406
+ enum: ['salto_ks_subscription_limit_exceeded'],
5407
+ type: 'string',
5408
+ },
5409
+ is_connected_account_error: {
5410
+ enum: [true],
5411
+ type: 'boolean',
5412
+ },
5413
+ message: { type: 'string' },
5414
+ salto_ks_metadata: {
5415
+ properties: {
5416
+ sites: {
5417
+ items: {
5418
+ properties: {
5419
+ site_id: { type: 'string' },
5420
+ site_name: { type: 'string' },
5421
+ site_user_subscription_limit: {
5422
+ minimum: 0,
5423
+ type: 'integer',
5424
+ },
5425
+ subscribed_site_user_count: {
5426
+ minimum: 0,
5427
+ type: 'integer',
5428
+ },
5429
+ },
5430
+ required: [
5431
+ 'site_id',
5432
+ 'site_name',
5433
+ 'subscribed_site_user_count',
5434
+ 'site_user_subscription_limit',
5435
+ ],
5436
+ type: 'object',
5437
+ },
5438
+ type: 'array',
5439
+ },
5440
+ },
5441
+ required: ['sites'],
5442
+ type: 'object',
5443
+ },
5444
+ },
5445
+ required: [
5446
+ 'created_at',
5447
+ 'message',
5448
+ 'is_connected_account_error',
5449
+ 'error_code',
5450
+ 'salto_ks_metadata',
5451
+ ],
5452
+ type: 'object',
5453
+ },
5304
5454
  ],
5305
5455
  },
5306
5456
  type: 'array',
@@ -5323,6 +5473,12 @@ export default {
5323
5473
  {
5324
5474
  description: 'Scheduled downtime for account planned.',
5325
5475
  properties: {
5476
+ created_at: {
5477
+ description:
5478
+ 'Date and time at which Seam created the warning.',
5479
+ format: 'date-time',
5480
+ type: 'string',
5481
+ },
5326
5482
  message: { type: 'string' },
5327
5483
  warning_code: {
5328
5484
  description:
@@ -5331,13 +5487,19 @@ export default {
5331
5487
  type: 'string',
5332
5488
  },
5333
5489
  },
5334
- required: ['message', 'warning_code'],
5490
+ required: ['created_at', 'message', 'warning_code'],
5335
5491
  type: 'object',
5336
5492
  },
5337
5493
  {
5338
5494
  description:
5339
5495
  'An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account.',
5340
5496
  properties: {
5497
+ created_at: {
5498
+ description:
5499
+ 'Date and time at which Seam created the warning.',
5500
+ format: 'date-time',
5501
+ type: 'string',
5502
+ },
5341
5503
  message: { type: 'string' },
5342
5504
  warning_code: {
5343
5505
  description:
@@ -5346,7 +5508,63 @@ export default {
5346
5508
  type: 'string',
5347
5509
  },
5348
5510
  },
5349
- required: ['message', 'warning_code'],
5511
+ required: ['created_at', 'message', 'warning_code'],
5512
+ type: 'object',
5513
+ },
5514
+ {
5515
+ description:
5516
+ 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
5517
+ properties: {
5518
+ created_at: {
5519
+ description:
5520
+ 'Date and time at which Seam created the warning.',
5521
+ format: 'date-time',
5522
+ type: 'string',
5523
+ },
5524
+ message: { type: 'string' },
5525
+ salto_ks_metadata: {
5526
+ properties: {
5527
+ sites: {
5528
+ items: {
5529
+ properties: {
5530
+ site_id: { type: 'string' },
5531
+ site_name: { type: 'string' },
5532
+ site_user_subscription_limit: {
5533
+ minimum: 0,
5534
+ type: 'integer',
5535
+ },
5536
+ subscribed_site_user_count: {
5537
+ minimum: 0,
5538
+ type: 'integer',
5539
+ },
5540
+ },
5541
+ required: [
5542
+ 'site_id',
5543
+ 'site_name',
5544
+ 'site_user_subscription_limit',
5545
+ 'subscribed_site_user_count',
5546
+ ],
5547
+ type: 'object',
5548
+ },
5549
+ type: 'array',
5550
+ },
5551
+ },
5552
+ required: ['sites'],
5553
+ type: 'object',
5554
+ },
5555
+ warning_code: {
5556
+ description:
5557
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5558
+ enum: ['salto_ks_subscription_limit_almost_reached'],
5559
+ type: 'string',
5560
+ },
5561
+ },
5562
+ required: [
5563
+ 'created_at',
5564
+ 'message',
5565
+ 'warning_code',
5566
+ 'salto_ks_metadata',
5567
+ ],
5350
5568
  type: 'object',
5351
5569
  },
5352
5570
  ],
@@ -5665,6 +5883,12 @@ export default {
5665
5883
  {
5666
5884
  description: 'Account is disconnected.',
5667
5885
  properties: {
5886
+ created_at: {
5887
+ description:
5888
+ 'Date and time at which Seam created the error.',
5889
+ format: 'date-time',
5890
+ type: 'string',
5891
+ },
5668
5892
  error_code: {
5669
5893
  description:
5670
5894
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5678,6 +5902,7 @@ export default {
5678
5902
  message: { type: 'string' },
5679
5903
  },
5680
5904
  required: [
5905
+ 'created_at',
5681
5906
  'message',
5682
5907
  'is_connected_account_error',
5683
5908
  'error_code',
@@ -5687,6 +5912,12 @@ export default {
5687
5912
  {
5688
5913
  description: 'Credentials provided were invalid.',
5689
5914
  properties: {
5915
+ created_at: {
5916
+ description:
5917
+ 'Date and time at which Seam created the error.',
5918
+ format: 'date-time',
5919
+ type: 'string',
5920
+ },
5690
5921
  error_code: {
5691
5922
  description:
5692
5923
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -5700,12 +5931,74 @@ export default {
5700
5931
  message: { type: 'string' },
5701
5932
  },
5702
5933
  required: [
5934
+ 'created_at',
5703
5935
  'message',
5704
5936
  'is_connected_account_error',
5705
5937
  'error_code',
5706
5938
  ],
5707
5939
  type: 'object',
5708
5940
  },
5941
+ {
5942
+ description:
5943
+ 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
5944
+ properties: {
5945
+ created_at: {
5946
+ description:
5947
+ 'Date and time at which Seam created the error.',
5948
+ format: 'date-time',
5949
+ type: 'string',
5950
+ },
5951
+ error_code: {
5952
+ description:
5953
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5954
+ enum: ['salto_ks_subscription_limit_exceeded'],
5955
+ type: 'string',
5956
+ },
5957
+ is_connected_account_error: {
5958
+ enum: [true],
5959
+ type: 'boolean',
5960
+ },
5961
+ message: { type: 'string' },
5962
+ salto_ks_metadata: {
5963
+ properties: {
5964
+ sites: {
5965
+ items: {
5966
+ properties: {
5967
+ site_id: { type: 'string' },
5968
+ site_name: { type: 'string' },
5969
+ site_user_subscription_limit: {
5970
+ minimum: 0,
5971
+ type: 'integer',
5972
+ },
5973
+ subscribed_site_user_count: {
5974
+ minimum: 0,
5975
+ type: 'integer',
5976
+ },
5977
+ },
5978
+ required: [
5979
+ 'site_id',
5980
+ 'site_name',
5981
+ 'subscribed_site_user_count',
5982
+ 'site_user_subscription_limit',
5983
+ ],
5984
+ type: 'object',
5985
+ },
5986
+ type: 'array',
5987
+ },
5988
+ },
5989
+ required: ['sites'],
5990
+ type: 'object',
5991
+ },
5992
+ },
5993
+ required: [
5994
+ 'created_at',
5995
+ 'message',
5996
+ 'is_connected_account_error',
5997
+ 'error_code',
5998
+ 'salto_ks_metadata',
5999
+ ],
6000
+ type: 'object',
6001
+ },
5709
6002
  ],
5710
6003
  },
5711
6004
  type: 'array',
@@ -12567,6 +12860,12 @@ export default {
12567
12860
  {
12568
12861
  description: 'Account is disconnected.',
12569
12862
  properties: {
12863
+ created_at: {
12864
+ description:
12865
+ 'Date and time at which Seam created the error.',
12866
+ format: 'date-time',
12867
+ type: 'string',
12868
+ },
12570
12869
  error_code: {
12571
12870
  description:
12572
12871
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -12580,6 +12879,7 @@ export default {
12580
12879
  message: { type: 'string' },
12581
12880
  },
12582
12881
  required: [
12882
+ 'created_at',
12583
12883
  'message',
12584
12884
  'is_connected_account_error',
12585
12885
  'error_code',
@@ -12589,6 +12889,12 @@ export default {
12589
12889
  {
12590
12890
  description: 'Credentials provided were invalid.',
12591
12891
  properties: {
12892
+ created_at: {
12893
+ description:
12894
+ 'Date and time at which Seam created the error.',
12895
+ format: 'date-time',
12896
+ type: 'string',
12897
+ },
12592
12898
  error_code: {
12593
12899
  description:
12594
12900
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -12602,9 +12908,71 @@ export default {
12602
12908
  message: { type: 'string' },
12603
12909
  },
12604
12910
  required: [
12911
+ 'created_at',
12912
+ 'message',
12913
+ 'is_connected_account_error',
12914
+ 'error_code',
12915
+ ],
12916
+ type: 'object',
12917
+ },
12918
+ {
12919
+ description:
12920
+ 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
12921
+ properties: {
12922
+ created_at: {
12923
+ description:
12924
+ 'Date and time at which Seam created the error.',
12925
+ format: 'date-time',
12926
+ type: 'string',
12927
+ },
12928
+ error_code: {
12929
+ description:
12930
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12931
+ enum: ['salto_ks_subscription_limit_exceeded'],
12932
+ type: 'string',
12933
+ },
12934
+ is_connected_account_error: {
12935
+ enum: [true],
12936
+ type: 'boolean',
12937
+ },
12938
+ message: { type: 'string' },
12939
+ salto_ks_metadata: {
12940
+ properties: {
12941
+ sites: {
12942
+ items: {
12943
+ properties: {
12944
+ site_id: { type: 'string' },
12945
+ site_name: { type: 'string' },
12946
+ site_user_subscription_limit: {
12947
+ minimum: 0,
12948
+ type: 'integer',
12949
+ },
12950
+ subscribed_site_user_count: {
12951
+ minimum: 0,
12952
+ type: 'integer',
12953
+ },
12954
+ },
12955
+ required: [
12956
+ 'site_id',
12957
+ 'site_name',
12958
+ 'subscribed_site_user_count',
12959
+ 'site_user_subscription_limit',
12960
+ ],
12961
+ type: 'object',
12962
+ },
12963
+ type: 'array',
12964
+ },
12965
+ },
12966
+ required: ['sites'],
12967
+ type: 'object',
12968
+ },
12969
+ },
12970
+ required: [
12971
+ 'created_at',
12605
12972
  'message',
12606
12973
  'is_connected_account_error',
12607
12974
  'error_code',
12975
+ 'salto_ks_metadata',
12608
12976
  ],
12609
12977
  type: 'object',
12610
12978
  },
@@ -13886,6 +14254,12 @@ export default {
13886
14254
  {
13887
14255
  description: 'Account is disconnected.',
13888
14256
  properties: {
14257
+ created_at: {
14258
+ description:
14259
+ 'Date and time at which Seam created the error.',
14260
+ format: 'date-time',
14261
+ type: 'string',
14262
+ },
13889
14263
  error_code: {
13890
14264
  description:
13891
14265
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -13899,6 +14273,7 @@ export default {
13899
14273
  message: { type: 'string' },
13900
14274
  },
13901
14275
  required: [
14276
+ 'created_at',
13902
14277
  'message',
13903
14278
  'is_connected_account_error',
13904
14279
  'error_code',
@@ -13908,6 +14283,12 @@ export default {
13908
14283
  {
13909
14284
  description: 'Credentials provided were invalid.',
13910
14285
  properties: {
14286
+ created_at: {
14287
+ description:
14288
+ 'Date and time at which Seam created the error.',
14289
+ format: 'date-time',
14290
+ type: 'string',
14291
+ },
13911
14292
  error_code: {
13912
14293
  description:
13913
14294
  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
@@ -13921,9 +14302,71 @@ export default {
13921
14302
  message: { type: 'string' },
13922
14303
  },
13923
14304
  required: [
14305
+ 'created_at',
14306
+ 'message',
14307
+ 'is_connected_account_error',
14308
+ 'error_code',
14309
+ ],
14310
+ type: 'object',
14311
+ },
14312
+ {
14313
+ description:
14314
+ 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
14315
+ properties: {
14316
+ created_at: {
14317
+ description:
14318
+ 'Date and time at which Seam created the error.',
14319
+ format: 'date-time',
14320
+ type: 'string',
14321
+ },
14322
+ error_code: {
14323
+ description:
14324
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14325
+ enum: ['salto_ks_subscription_limit_exceeded'],
14326
+ type: 'string',
14327
+ },
14328
+ is_connected_account_error: {
14329
+ enum: [true],
14330
+ type: 'boolean',
14331
+ },
14332
+ message: { type: 'string' },
14333
+ salto_ks_metadata: {
14334
+ properties: {
14335
+ sites: {
14336
+ items: {
14337
+ properties: {
14338
+ site_id: { type: 'string' },
14339
+ site_name: { type: 'string' },
14340
+ site_user_subscription_limit: {
14341
+ minimum: 0,
14342
+ type: 'integer',
14343
+ },
14344
+ subscribed_site_user_count: {
14345
+ minimum: 0,
14346
+ type: 'integer',
14347
+ },
14348
+ },
14349
+ required: [
14350
+ 'site_id',
14351
+ 'site_name',
14352
+ 'subscribed_site_user_count',
14353
+ 'site_user_subscription_limit',
14354
+ ],
14355
+ type: 'object',
14356
+ },
14357
+ type: 'array',
14358
+ },
14359
+ },
14360
+ required: ['sites'],
14361
+ type: 'object',
14362
+ },
14363
+ },
14364
+ required: [
14365
+ 'created_at',
13924
14366
  'message',
13925
14367
  'is_connected_account_error',
13926
14368
  'error_code',
14369
+ 'salto_ks_metadata',
13927
14370
  ],
13928
14371
  type: 'object',
13929
14372
  },