@seamapi/types 1.424.0 → 1.425.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 (29) hide show
  1. package/dist/connect.cjs +197 -10
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +582 -6
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-credential.d.ts +6 -0
  8. package/lib/seam/connect/models/acs/acs-credential.js +4 -0
  9. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-entrance.d.ts +25 -2
  11. package/lib/seam/connect/models/acs/acs-entrance.js +18 -2
  12. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  13. package/lib/seam/connect/models/acs/acs-system.js +4 -1
  14. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  15. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +24 -0
  16. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +10 -0
  17. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +14 -0
  18. package/lib/seam/connect/models/phones/phone-session.d.ts +66 -4
  19. package/lib/seam/connect/openapi.d.ts +254 -4
  20. package/lib/seam/connect/openapi.js +178 -8
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +286 -0
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  25. package/src/lib/seam/connect/models/acs/acs-credential.ts +6 -0
  26. package/src/lib/seam/connect/models/acs/acs-entrance.ts +93 -70
  27. package/src/lib/seam/connect/models/acs/acs-system.ts +4 -1
  28. package/src/lib/seam/connect/openapi.ts +203 -8
  29. package/src/lib/seam/connect/route-types.ts +286 -0
package/lib/seam/connect/openapi.js CHANGED
@@ -1898,6 +1898,11 @@ export default {
1898
1898
  nullable: true,
1899
1899
  type: 'string',
1900
1900
  },
1901
+ connected_account_id: {
1902
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
1903
+ format: 'uuid',
1904
+ type: 'string',
1905
+ },
1901
1906
  created_at: {
1902
1907
  description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
1903
1908
  format: 'date-time',
@@ -2168,6 +2173,7 @@ export default {
2168
2173
  },
2169
2174
  required: [
2170
2175
  'acs_credential_id',
2176
+ 'connected_account_id',
2171
2177
  'acs_system_id',
2172
2178
  'display_name',
2173
2179
  'access_method',
@@ -2341,6 +2347,18 @@ export default {
2341
2347
  required: ['door_type', 'door_name'],
2342
2348
  type: 'object',
2343
2349
  },
2350
+ can_unlock_with_card: {
2351
+ description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
2352
+ type: 'boolean',
2353
+ },
2354
+ can_unlock_with_code: {
2355
+ description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
2356
+ type: 'boolean',
2357
+ },
2358
+ can_unlock_with_mobile_key: {
2359
+ description: 'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
2360
+ type: 'boolean',
2361
+ },
2344
2362
  connected_account_id: {
2345
2363
  description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
2346
2364
  format: 'uuid',
@@ -3970,6 +3988,11 @@ export default {
3970
3988
  nullable: true,
3971
3989
  type: 'string',
3972
3990
  },
3991
+ connected_account_id: {
3992
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
3993
+ format: 'uuid',
3994
+ type: 'string',
3995
+ },
3973
3996
  created_at: {
3974
3997
  description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
3975
3998
  format: 'date-time',
@@ -4266,6 +4289,7 @@ export default {
4266
4289
  },
4267
4290
  required: [
4268
4291
  'acs_credential_id',
4292
+ 'connected_account_id',
4269
4293
  'acs_system_id',
4270
4294
  'display_name',
4271
4295
  'access_method',
@@ -4347,6 +4371,11 @@ export default {
4347
4371
  nullable: true,
4348
4372
  type: 'string',
4349
4373
  },
4374
+ connected_account_id: {
4375
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
4376
+ format: 'uuid',
4377
+ type: 'string',
4378
+ },
4350
4379
  created_at: {
4351
4380
  description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
4352
4381
  format: 'date-time',
@@ -4643,6 +4672,7 @@ export default {
4643
4672
  },
4644
4673
  required: [
4645
4674
  'acs_credential_id',
4675
+ 'connected_account_id',
4646
4676
  'acs_system_id',
4647
4677
  'display_name',
4648
4678
  'access_method',
@@ -5124,6 +5154,11 @@ export default {
5124
5154
  nullable: true,
5125
5155
  type: 'string',
5126
5156
  },
5157
+ connected_account_id: {
5158
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
5159
+ format: 'uuid',
5160
+ type: 'string',
5161
+ },
5127
5162
  created_at: {
5128
5163
  description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
5129
5164
  format: 'date-time',
@@ -5418,6 +5453,7 @@ export default {
5418
5453
  },
5419
5454
  required: [
5420
5455
  'acs_credential_id',
5456
+ 'connected_account_id',
5421
5457
  'acs_system_id',
5422
5458
  'display_name',
5423
5459
  'access_method',
@@ -5499,6 +5535,11 @@ export default {
5499
5535
  nullable: true,
5500
5536
  type: 'string',
5501
5537
  },
5538
+ connected_account_id: {
5539
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
5540
+ format: 'uuid',
5541
+ type: 'string',
5542
+ },
5502
5543
  created_at: {
5503
5544
  description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
5504
5545
  format: 'date-time',
@@ -5793,6 +5834,7 @@ export default {
5793
5834
  },
5794
5835
  required: [
5795
5836
  'acs_credential_id',
5837
+ 'connected_account_id',
5796
5838
  'acs_system_id',
5797
5839
  'display_name',
5798
5840
  'access_method',
@@ -16650,6 +16692,18 @@ export default {
16650
16692
  required: ['door_type', 'door_name'],
16651
16693
  type: 'object',
16652
16694
  },
16695
+ can_unlock_with_card: {
16696
+ description: 'Indicates whether the ACS entrance can be unlocked with card credentials.',
16697
+ type: 'boolean',
16698
+ },
16699
+ can_unlock_with_code: {
16700
+ description: 'Indicates whether the ACS entrance can be unlocked with pin codes.',
16701
+ type: 'boolean',
16702
+ },
16703
+ can_unlock_with_mobile_key: {
16704
+ description: 'Indicates whether the ACS entrance can be unlocked with mobile key credentials.',
16705
+ type: 'boolean',
16706
+ },
16653
16707
  connected_account_id: {
16654
16708
  description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
16655
16709
  format: 'uuid',
@@ -16894,6 +16948,11 @@ export default {
16894
16948
  nullable: true,
16895
16949
  type: 'string',
16896
16950
  },
16951
+ connected_account_id: {
16952
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
16953
+ format: 'uuid',
16954
+ type: 'string',
16955
+ },
16897
16956
  created_at: {
16898
16957
  description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
16899
16958
  format: 'date-time',
@@ -17187,6 +17246,7 @@ export default {
17187
17246
  },
17188
17247
  },
17189
17248
  required: [
17249
+ 'connected_account_id',
17190
17250
  'acs_system_id',
17191
17251
  'display_name',
17192
17252
  'access_method',
@@ -19123,6 +19183,11 @@ export default {
19123
19183
  nullable: true,
19124
19184
  type: 'string',
19125
19185
  },
19186
+ connected_account_id: {
19187
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
19188
+ format: 'uuid',
19189
+ type: 'string',
19190
+ },
19126
19191
  created_at: {
19127
19192
  description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.',
19128
19193
  format: 'date-time',
@@ -19393,6 +19458,7 @@ export default {
19393
19458
  },
19394
19459
  required: [
19395
19460
  'acs_credential_id',
19461
+ 'connected_account_id',
19396
19462
  'acs_system_id',
19397
19463
  'display_name',
19398
19464
  'access_method',
@@ -21610,7 +21676,11 @@ export default {
21610
21676
  description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
21611
21677
  type: 'boolean',
21612
21678
  },
21613
- use_offline_access_code: { type: 'boolean' },
21679
+ use_offline_access_code: {
21680
+ deprecated: true,
21681
+ type: 'boolean',
21682
+ 'x-deprecated': 'Use `is_offline_access_code` instead.',
21683
+ },
21614
21684
  },
21615
21685
  required: ['device_id'],
21616
21686
  type: 'object',
@@ -21735,7 +21805,11 @@ export default {
21735
21805
  description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
21736
21806
  type: 'boolean',
21737
21807
  },
21738
- use_offline_access_code: { type: 'boolean' },
21808
+ use_offline_access_code: {
21809
+ deprecated: true,
21810
+ type: 'boolean',
21811
+ 'x-deprecated': 'Use `is_offline_access_code` instead.',
21812
+ },
21739
21813
  },
21740
21814
  required: ['device_ids'],
21741
21815
  type: 'object',
@@ -21856,7 +21930,11 @@ export default {
21856
21930
  description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
21857
21931
  type: 'boolean',
21858
21932
  },
21859
- use_offline_access_code: { type: 'boolean' },
21933
+ use_offline_access_code: {
21934
+ deprecated: true,
21935
+ type: 'boolean',
21936
+ 'x-deprecated': 'Use `is_offline_access_code` instead.',
21937
+ },
21860
21938
  },
21861
21939
  required: ['device_ids'],
21862
21940
  type: 'object',
@@ -23382,7 +23460,11 @@ export default {
23382
23460
  description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
23383
23461
  type: 'boolean',
23384
23462
  },
23385
- use_offline_access_code: { type: 'boolean' },
23463
+ use_offline_access_code: {
23464
+ deprecated: true,
23465
+ type: 'boolean',
23466
+ 'x-deprecated': 'Use `is_offline_access_code` instead.',
23467
+ },
23386
23468
  },
23387
23469
  required: ['access_code_id'],
23388
23470
  type: 'object',
@@ -23516,7 +23598,11 @@ export default {
23516
23598
  description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
23517
23599
  type: 'boolean',
23518
23600
  },
23519
- use_offline_access_code: { type: 'boolean' },
23601
+ use_offline_access_code: {
23602
+ deprecated: true,
23603
+ type: 'boolean',
23604
+ 'x-deprecated': 'Use `is_offline_access_code` instead.',
23605
+ },
23520
23606
  },
23521
23607
  required: ['access_code_id'],
23522
23608
  type: 'object',
@@ -23650,7 +23736,11 @@ export default {
23650
23736
  description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
23651
23737
  type: 'boolean',
23652
23738
  },
23653
- use_offline_access_code: { type: 'boolean' },
23739
+ use_offline_access_code: {
23740
+ deprecated: true,
23741
+ type: 'boolean',
23742
+ 'x-deprecated': 'Use `is_offline_access_code` instead.',
23743
+ },
23654
23744
  },
23655
23745
  required: ['access_code_id'],
23656
23746
  type: 'object',
@@ -23885,7 +23975,6 @@ export default {
23885
23975
  },
23886
23976
  ends_at: {
23887
23977
  description: 'Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
23888
- format: 'date-time',
23889
23978
  type: 'string',
23890
23979
  },
23891
23980
  location: {
@@ -23939,7 +24028,6 @@ export default {
23939
24028
  },
23940
24029
  starts_at: {
23941
24030
  description: 'Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
23942
- format: 'date-time',
23943
24031
  type: 'string',
23944
24032
  },
23945
24033
  },
@@ -34560,6 +34648,15 @@ export default {
34560
34648
  type: 'string',
34561
34649
  },
34562
34650
  },
34651
+ {
34652
+ in: 'query',
34653
+ name: 'search',
34654
+ schema: {
34655
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
34656
+ minLength: 1,
34657
+ type: 'string',
34658
+ },
34659
+ },
34563
34660
  ],
34564
34661
  responses: {
34565
34662
  200: {
@@ -34862,6 +34959,11 @@ export default {
34862
34959
  nullable: true,
34863
34960
  type: 'string',
34864
34961
  },
34962
+ search: {
34963
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
34964
+ minLength: 1,
34965
+ type: 'string',
34966
+ },
34865
34967
  space_id: {
34866
34968
  description: 'ID of the space for which you want to list devices.',
34867
34969
  format: 'uuid',
@@ -35652,6 +35754,15 @@ export default {
35652
35754
  type: 'string',
35653
35755
  },
35654
35756
  },
35757
+ {
35758
+ in: 'query',
35759
+ name: 'search',
35760
+ schema: {
35761
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
35762
+ minLength: 1,
35763
+ type: 'string',
35764
+ },
35765
+ },
35655
35766
  ],
35656
35767
  responses: {
35657
35768
  200: {
@@ -35951,6 +36062,11 @@ export default {
35951
36062
  nullable: true,
35952
36063
  type: 'string',
35953
36064
  },
36065
+ search: {
36066
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
36067
+ minLength: 1,
36068
+ type: 'string',
36069
+ },
35954
36070
  space_id: {
35955
36071
  description: 'ID of the space for which you want to list devices.',
35956
36072
  format: 'uuid',
@@ -37512,6 +37628,15 @@ export default {
37512
37628
  type: 'string',
37513
37629
  },
37514
37630
  },
37631
+ {
37632
+ in: 'query',
37633
+ name: 'search',
37634
+ schema: {
37635
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
37636
+ minLength: 1,
37637
+ type: 'string',
37638
+ },
37639
+ },
37515
37640
  ],
37516
37641
  responses: {
37517
37642
  200: {
@@ -37752,6 +37877,11 @@ export default {
37752
37877
  nullable: true,
37753
37878
  type: 'string',
37754
37879
  },
37880
+ search: {
37881
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
37882
+ minLength: 1,
37883
+ type: 'string',
37884
+ },
37755
37885
  space_id: {
37756
37886
  description: 'ID of the space for which you want to list devices.',
37757
37887
  format: 'uuid',
@@ -38491,6 +38621,15 @@ export default {
38491
38621
  type: 'string',
38492
38622
  },
38493
38623
  },
38624
+ {
38625
+ in: 'query',
38626
+ name: 'search',
38627
+ schema: {
38628
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
38629
+ minLength: 1,
38630
+ type: 'string',
38631
+ },
38632
+ },
38494
38633
  ],
38495
38634
  responses: {
38496
38635
  200: {
@@ -38646,6 +38785,11 @@ export default {
38646
38785
  nullable: true,
38647
38786
  type: 'string',
38648
38787
  },
38788
+ search: {
38789
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
38790
+ minLength: 1,
38791
+ type: 'string',
38792
+ },
38649
38793
  space_id: {
38650
38794
  description: 'ID of the space for which you want to list devices.',
38651
38795
  format: 'uuid',
@@ -43004,6 +43148,15 @@ export default {
43004
43148
  type: 'string',
43005
43149
  },
43006
43150
  },
43151
+ {
43152
+ in: 'query',
43153
+ name: 'search',
43154
+ schema: {
43155
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
43156
+ minLength: 1,
43157
+ type: 'string',
43158
+ },
43159
+ },
43007
43160
  ],
43008
43161
  responses: {
43009
43162
  200: {
@@ -43180,6 +43333,11 @@ export default {
43180
43333
  nullable: true,
43181
43334
  type: 'string',
43182
43335
  },
43336
+ search: {
43337
+ description: 'String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id`, `display_name`, `custom_metadata` or `location.location_name`.',
43338
+ minLength: 1,
43339
+ type: 'string',
43340
+ },
43183
43341
  space_id: {
43184
43342
  description: 'ID of the space for which you want to list devices.',
43185
43343
  format: 'uuid',
@@ -47895,6 +48053,14 @@ export default {
47895
48053
  description: 'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
47896
48054
  operationId: 'userIdentitiesListGet',
47897
48055
  parameters: [
48056
+ {
48057
+ in: 'query',
48058
+ name: 'search',
48059
+ schema: {
48060
+ description: 'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
48061
+ type: 'string',
48062
+ },
48063
+ },
47898
48064
  {
47899
48065
  in: 'query',
47900
48066
  name: 'credential_manager_acs_system_id',
@@ -47954,6 +48120,10 @@ export default {
47954
48120
  format: 'uuid',
47955
48121
  type: 'string',
47956
48122
  },
48123
+ search: {
48124
+ description: 'String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.',
48125
+ type: 'string',
48126
+ },
47957
48127
  },
47958
48128
  type: 'object',
47959
48129
  },