@seamapi/types 1.984.0 → 1.986.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 (34) hide show
  1. package/lib/seam/connect/models/acs/acs-credential.d.ts +33 -7
  2. package/lib/seam/connect/models/acs/acs-credential.js +5 -1
  3. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  4. package/lib/seam/connect/models/acs/acs-entrance.js +7 -4
  5. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  6. package/lib/seam/connect/models/acs/metadata/akiles.d.ts +8 -0
  7. package/lib/seam/connect/models/acs/metadata/akiles.js +9 -0
  8. package/lib/seam/connect/models/acs/metadata/akiles.js.map +1 -1
  9. package/lib/seam/connect/models/acs/metadata/index.d.ts +1 -0
  10. package/lib/seam/connect/models/acs/metadata/index.js +1 -0
  11. package/lib/seam/connect/models/acs/metadata/index.js.map +1 -1
  12. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +136 -29
  13. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +48 -10
  14. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +64 -14
  15. package/lib/seam/connect/models/action-attempts/scan-to-assign-credential.d.ts +24 -5
  16. package/lib/seam/connect/models/devices/device-metadata.js +1 -1
  17. package/lib/seam/connect/models/events/connected-accounts.js +5 -4
  18. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  19. package/lib/seam/connect/models/events/devices.js +12 -0
  20. package/lib/seam/connect/models/events/devices.js.map +1 -1
  21. package/lib/seam/connect/models/phones/phone-session.d.ts +56 -12
  22. package/lib/seam/connect/openapi.js +120 -16
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +1149 -441
  25. package/package.json +2 -2
  26. package/src/lib/seam/connect/models/acs/acs-credential.ts +7 -0
  27. package/src/lib/seam/connect/models/acs/acs-entrance.ts +10 -9
  28. package/src/lib/seam/connect/models/acs/metadata/akiles.ts +14 -0
  29. package/src/lib/seam/connect/models/acs/metadata/index.ts +1 -0
  30. package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -1
  31. package/src/lib/seam/connect/models/events/connected-accounts.ts +5 -4
  32. package/src/lib/seam/connect/models/events/devices.ts +12 -0
  33. package/src/lib/seam/connect/openapi.ts +129 -16
  34. package/src/lib/seam/connect/route-types.ts +1513 -261
package/lib/seam/connect/openapi.js CHANGED
@@ -2920,6 +2920,16 @@ const openapi = {
2920
2920
  format: 'uuid',
2921
2921
  type: 'string',
2922
2922
  },
2923
+ akiles_metadata: {
2924
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
2925
+ properties: {
2926
+ member_pin_id: {
2927
+ description: 'ID of the Akiles member PIN.',
2928
+ type: 'string',
2929
+ },
2930
+ },
2931
+ type: 'object',
2932
+ },
2923
2933
  assa_abloy_vostio_metadata: {
2924
2934
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
2925
2935
  properties: {
@@ -3014,6 +3024,7 @@ const openapi = {
3014
3024
  'salto_ks_tag',
3015
3025
  'avigilon_alta_credential',
3016
3026
  'kisi_credential',
3027
+ 'akiles_credential',
3017
3028
  ],
3018
3029
  type: 'string',
3019
3030
  },
@@ -3823,7 +3834,8 @@ const openapi = {
3823
3834
  type: 'object',
3824
3835
  },
3825
3836
  {
3826
- description: 'deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
3837
+ deprecated: true,
3838
+ description: 'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
3827
3839
  properties: {
3828
3840
  created_at: {
3829
3841
  description: 'Date and time at which Seam created the warning.',
@@ -3842,6 +3854,7 @@ const openapi = {
3842
3854
  },
3843
3855
  required: ['created_at', 'message', 'warning_code'],
3844
3856
  type: 'object',
3857
+ 'x-deprecated': 'Use `privacy_mode` instead.',
3845
3858
  },
3846
3859
  {
3847
3860
  description: 'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
@@ -5531,6 +5544,16 @@ const openapi = {
5531
5544
  format: 'uuid',
5532
5545
  type: 'string',
5533
5546
  },
5547
+ akiles_metadata: {
5548
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
5549
+ properties: {
5550
+ member_pin_id: {
5551
+ description: 'ID of the Akiles member PIN.',
5552
+ type: 'string',
5553
+ },
5554
+ },
5555
+ type: 'object',
5556
+ },
5534
5557
  assa_abloy_vostio_metadata: {
5535
5558
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
5536
5559
  properties: {
@@ -5625,6 +5648,7 @@ const openapi = {
5625
5648
  'salto_ks_tag',
5626
5649
  'avigilon_alta_credential',
5627
5650
  'kisi_credential',
5651
+ 'akiles_credential',
5628
5652
  ],
5629
5653
  type: 'string',
5630
5654
  },
@@ -5933,6 +5957,16 @@ const openapi = {
5933
5957
  format: 'uuid',
5934
5958
  type: 'string',
5935
5959
  },
5960
+ akiles_metadata: {
5961
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
5962
+ properties: {
5963
+ member_pin_id: {
5964
+ description: 'ID of the Akiles member PIN.',
5965
+ type: 'string',
5966
+ },
5967
+ },
5968
+ type: 'object',
5969
+ },
5936
5970
  assa_abloy_vostio_metadata: {
5937
5971
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
5938
5972
  properties: {
@@ -6027,6 +6061,7 @@ const openapi = {
6027
6061
  'salto_ks_tag',
6028
6062
  'avigilon_alta_credential',
6029
6063
  'kisi_credential',
6064
+ 'akiles_credential',
6030
6065
  ],
6031
6066
  type: 'string',
6032
6067
  },
@@ -6557,6 +6592,16 @@ const openapi = {
6557
6592
  format: 'uuid',
6558
6593
  type: 'string',
6559
6594
  },
6595
+ akiles_metadata: {
6596
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
6597
+ properties: {
6598
+ member_pin_id: {
6599
+ description: 'ID of the Akiles member PIN.',
6600
+ type: 'string',
6601
+ },
6602
+ },
6603
+ type: 'object',
6604
+ },
6560
6605
  assa_abloy_vostio_metadata: {
6561
6606
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
6562
6607
  properties: {
@@ -6651,6 +6696,7 @@ const openapi = {
6651
6696
  'salto_ks_tag',
6652
6697
  'avigilon_alta_credential',
6653
6698
  'kisi_credential',
6699
+ 'akiles_credential',
6654
6700
  ],
6655
6701
  type: 'string',
6656
6702
  },
@@ -6957,6 +7003,16 @@ const openapi = {
6957
7003
  format: 'uuid',
6958
7004
  type: 'string',
6959
7005
  },
7006
+ akiles_metadata: {
7007
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
7008
+ properties: {
7009
+ member_pin_id: {
7010
+ description: 'ID of the Akiles member PIN.',
7011
+ type: 'string',
7012
+ },
7013
+ },
7014
+ type: 'object',
7015
+ },
6960
7016
  assa_abloy_vostio_metadata: {
6961
7017
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
6962
7018
  properties: {
@@ -7051,6 +7107,7 @@ const openapi = {
7051
7107
  'salto_ks_tag',
7052
7108
  'avigilon_alta_credential',
7053
7109
  'kisi_credential',
7110
+ 'akiles_credential',
7054
7111
  ],
7055
7112
  type: 'string',
7056
7113
  },
@@ -7608,6 +7665,16 @@ const openapi = {
7608
7665
  format: 'uuid',
7609
7666
  type: 'string',
7610
7667
  },
7668
+ akiles_metadata: {
7669
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
7670
+ properties: {
7671
+ member_pin_id: {
7672
+ description: 'ID of the Akiles member PIN.',
7673
+ type: 'string',
7674
+ },
7675
+ },
7676
+ type: 'object',
7677
+ },
7611
7678
  assa_abloy_vostio_metadata: {
7612
7679
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
7613
7680
  properties: {
@@ -7702,6 +7769,7 @@ const openapi = {
7702
7769
  'salto_ks_tag',
7703
7770
  'avigilon_alta_credential',
7704
7771
  'kisi_credential',
7772
+ 'akiles_credential',
7705
7773
  ],
7706
7774
  type: 'string',
7707
7775
  },
@@ -13210,7 +13278,7 @@ const openapi = {
13210
13278
  },
13211
13279
  },
13212
13280
  type: 'object',
13213
- 'x-deprecated': 'Use `salto_ks_metadata ` instead.',
13281
+ 'x-deprecated': 'Use `salto_ks_metadata` instead.',
13214
13282
  },
13215
13283
  schlage_metadata: {
13216
13284
  description: 'Metadata for a Schlage device.',
@@ -20080,8 +20148,8 @@ const openapi = {
20080
20148
  type: 'string',
20081
20149
  },
20082
20150
  connected_account_type: {
20083
- description: 'undocumented: Unreleased.',
20084
20151
  type: 'string',
20152
+ 'x-undocumented': 'Unreleased.',
20085
20153
  },
20086
20154
  created_at: {
20087
20155
  description: 'Date and time at which the event was created.',
@@ -23148,19 +23216,22 @@ const openapi = {
23148
23216
  type: 'boolean',
23149
23217
  },
23150
23218
  acs_entrance_id: {
23151
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the lock event.\n ',
23219
+ description: 'ID of the ACS entrance associated with the lock event.',
23152
23220
  format: 'uuid',
23153
23221
  type: 'string',
23222
+ 'x-undocumented': 'Unreleased.',
23154
23223
  },
23155
23224
  acs_system_id: {
23156
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the lock event.\n ',
23225
+ description: 'ID of the ACS system associated with the lock event.',
23157
23226
  format: 'uuid',
23158
23227
  type: 'string',
23228
+ 'x-undocumented': 'Unreleased.',
23159
23229
  },
23160
23230
  acs_user_id: {
23161
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the lock event.\n ',
23231
+ description: 'ID of the ACS user associated with the lock event.',
23162
23232
  format: 'uuid',
23163
23233
  type: 'string',
23234
+ 'x-undocumented': 'Unreleased.',
23164
23235
  },
23165
23236
  action_attempt_id: {
23166
23237
  description: 'ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt).',
@@ -23240,9 +23311,10 @@ const openapi = {
23240
23311
  type: 'string',
23241
23312
  },
23242
23313
  user_identity_id: {
23243
- description: '\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the lock event.\n ',
23314
+ description: 'ID of the user identity associated with the lock event.',
23244
23315
  format: 'uuid',
23245
23316
  type: 'string',
23317
+ 'x-undocumented': 'Unreleased.',
23246
23318
  },
23247
23319
  workspace_id: {
23248
23320
  description: 'ID of the workspace associated with the event.',
@@ -23276,19 +23348,22 @@ const openapi = {
23276
23348
  type: 'boolean',
23277
23349
  },
23278
23350
  acs_entrance_id: {
23279
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the unlock event.\n ',
23351
+ description: 'ID of the ACS entrance associated with the unlock event.',
23280
23352
  format: 'uuid',
23281
23353
  type: 'string',
23354
+ 'x-undocumented': 'Unreleased.',
23282
23355
  },
23283
23356
  acs_system_id: {
23284
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the unlock event.\n ',
23357
+ description: 'ID of the ACS system associated with the unlock event.',
23285
23358
  format: 'uuid',
23286
23359
  type: 'string',
23360
+ 'x-undocumented': 'Unreleased.',
23287
23361
  },
23288
23362
  acs_user_id: {
23289
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the unlock event.\n ',
23363
+ description: 'ID of the ACS user associated with the unlock event.',
23290
23364
  format: 'uuid',
23291
23365
  type: 'string',
23366
+ 'x-undocumented': 'Unreleased.',
23292
23367
  },
23293
23368
  action_attempt_id: {
23294
23369
  description: 'ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt).',
@@ -23368,9 +23443,10 @@ const openapi = {
23368
23443
  type: 'string',
23369
23444
  },
23370
23445
  user_identity_id: {
23371
- description: '\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the unlock event.\n ',
23446
+ description: 'ID of the user identity associated with the unlock event.',
23372
23447
  format: 'uuid',
23373
23448
  type: 'string',
23449
+ 'x-undocumented': 'Unreleased.',
23374
23450
  },
23375
23451
  workspace_id: {
23376
23452
  description: 'ID of the workspace associated with the event.',
@@ -23399,19 +23475,22 @@ const openapi = {
23399
23475
  type: 'string',
23400
23476
  },
23401
23477
  acs_entrance_id: {
23402
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS entrance associated with the access-denied event.\n ',
23478
+ description: 'ID of the ACS entrance associated with the access-denied event.',
23403
23479
  format: 'uuid',
23404
23480
  type: 'string',
23481
+ 'x-undocumented': 'Unreleased.',
23405
23482
  },
23406
23483
  acs_system_id: {
23407
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS system associated with the access-denied event.\n ',
23484
+ description: 'ID of the ACS system associated with the access-denied event.',
23408
23485
  format: 'uuid',
23409
23486
  type: 'string',
23487
+ 'x-undocumented': 'Unreleased.',
23410
23488
  },
23411
23489
  acs_user_id: {
23412
- description: '\n undocumented: Unreleased.\n ---\n ID of the ACS user associated with the access-denied event.\n ',
23490
+ description: 'ID of the ACS user associated with the access-denied event.',
23413
23491
  format: 'uuid',
23414
23492
  type: 'string',
23493
+ 'x-undocumented': 'Unreleased.',
23415
23494
  },
23416
23495
  connected_account_custom_metadata: {
23417
23496
  additionalProperties: {
@@ -23485,9 +23564,10 @@ const openapi = {
23485
23564
  type: 'object',
23486
23565
  },
23487
23566
  user_identity_id: {
23488
- description: '\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the access-denied event.\n ',
23567
+ description: 'ID of the user identity associated with the access-denied event.',
23489
23568
  format: 'uuid',
23490
23569
  type: 'string',
23570
+ 'x-undocumented': 'Unreleased.',
23491
23571
  },
23492
23572
  workspace_id: {
23493
23573
  description: 'ID of the workspace associated with the event.',
@@ -25490,7 +25570,8 @@ const openapi = {
25490
25570
  type: 'object',
25491
25571
  },
25492
25572
  {
25493
- description: 'deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
25573
+ deprecated: true,
25574
+ description: 'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
25494
25575
  properties: {
25495
25576
  created_at: {
25496
25577
  description: 'Date and time at which Seam created the warning.',
@@ -25513,6 +25594,7 @@ const openapi = {
25513
25594
  'warning_code',
25514
25595
  ],
25515
25596
  type: 'object',
25597
+ 'x-deprecated': 'Use `privacy_mode` instead.',
25516
25598
  },
25517
25599
  {
25518
25600
  description: 'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
@@ -25569,6 +25651,16 @@ const openapi = {
25569
25651
  format: 'uuid',
25570
25652
  type: 'string',
25571
25653
  },
25654
+ akiles_metadata: {
25655
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
25656
+ properties: {
25657
+ member_pin_id: {
25658
+ description: 'ID of the Akiles member PIN.',
25659
+ type: 'string',
25660
+ },
25661
+ },
25662
+ type: 'object',
25663
+ },
25572
25664
  assa_abloy_vostio_metadata: {
25573
25665
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
25574
25666
  properties: {
@@ -25663,6 +25755,7 @@ const openapi = {
25663
25755
  'salto_ks_tag',
25664
25756
  'avigilon_alta_credential',
25665
25757
  'kisi_credential',
25758
+ 'akiles_credential',
25666
25759
  ],
25667
25760
  type: 'string',
25668
25761
  },
@@ -29099,6 +29192,16 @@ const openapi = {
29099
29192
  format: 'uuid',
29100
29193
  type: 'string',
29101
29194
  },
29195
+ akiles_metadata: {
29196
+ description: 'Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
29197
+ properties: {
29198
+ member_pin_id: {
29199
+ description: 'ID of the Akiles member PIN.',
29200
+ type: 'string',
29201
+ },
29202
+ },
29203
+ type: 'object',
29204
+ },
29102
29205
  assa_abloy_vostio_metadata: {
29103
29206
  description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).',
29104
29207
  properties: {
@@ -29193,6 +29296,7 @@ const openapi = {
29193
29296
  'salto_ks_tag',
29194
29297
  'avigilon_alta_credential',
29195
29298
  'kisi_credential',
29299
+ 'akiles_credential',
29196
29300
  ],
29197
29301
  type: 'string',
29198
29302
  },