@seamapi/types 1.1002.0 → 1.1004.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.
@@ -1387,6 +1387,8 @@ export type Routes = {
1387
1387
  issued_at: string | null
1388
1388
  /** Indicates whether the access method has been issued. */
1389
1389
  is_issued: boolean
1390
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
1391
+ display_status: string
1390
1392
  /** URL of the Instant Key for mobile key access methods. */
1391
1393
  instant_key_url?: string | undefined
1392
1394
  /** Token of the client session associated with the access method. */
@@ -4527,6 +4529,8 @@ export type Routes = {
4527
4529
  issued_at: string | null
4528
4530
  /** Indicates whether the access method has been issued. */
4529
4531
  is_issued: boolean
4532
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
4533
+ display_status: string
4530
4534
  /** URL of the Instant Key for mobile key access methods. */
4531
4535
  instant_key_url?: string | undefined
4532
4536
  /** Token of the client session associated with the access method. */
@@ -7924,8 +7928,7 @@ export type Routes = {
7924
7928
  route: '/access_codes/unmanaged/convert_to_managed'
7925
7929
  method: 'POST' | 'PATCH'
7926
7930
  queryParams: {}
7927
- jsonBody: {}
7928
- commonParams: {
7931
+ jsonBody: {
7929
7932
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
7930
7933
  access_code_id: string
7931
7934
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. */
@@ -7937,6 +7940,7 @@ export type Routes = {
7937
7940
  /** */
7938
7941
  sync?: boolean
7939
7942
  }
7943
+ commonParams: {}
7940
7944
  formData: {}
7941
7945
  jsonResponse: {}
7942
7946
  maxDuration: undefined
@@ -9293,6 +9297,8 @@ export type Routes = {
9293
9297
  issued_at: string | null
9294
9298
  /** Indicates whether the access method has been issued. */
9295
9299
  is_issued: boolean
9300
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
9301
+ display_status: string
9296
9302
  /** URL of the Instant Key for mobile key access methods. */
9297
9303
  instant_key_url?: string | undefined
9298
9304
  /** Token of the client session associated with the access method. */
@@ -10891,8 +10897,7 @@ export type Routes = {
10891
10897
  route: '/access_codes/unmanaged/update'
10892
10898
  method: 'PATCH' | 'POST'
10893
10899
  queryParams: {}
10894
- jsonBody: {}
10895
- commonParams: {
10900
+ jsonBody: {
10896
10901
  /** ID of the unmanaged access code that you want to update. */
10897
10902
  access_code_id: string
10898
10903
  is_managed: boolean
@@ -10903,6 +10908,7 @@ export type Routes = {
10903
10908
  /** Indicates whether to force the unmanaged access code update. */
10904
10909
  force?: boolean | undefined
10905
10910
  }
10911
+ commonParams: {}
10906
10912
  formData: {}
10907
10913
  jsonResponse: {}
10908
10914
  maxDuration: undefined
@@ -12284,6 +12290,8 @@ export type Routes = {
12284
12290
  issued_at: string | null
12285
12291
  /** Indicates whether the access method has been issued. */
12286
12292
  is_issued: boolean
12293
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
12294
+ display_status: string
12287
12295
  /** URL of the Instant Key for mobile key access methods. */
12288
12296
  instant_key_url?: string | undefined
12289
12297
  /** Token of the client session associated with the access method. */
@@ -13061,8 +13069,7 @@ export type Routes = {
13061
13069
  route: '/access_grants/create'
13062
13070
  method: 'POST'
13063
13071
  queryParams: {}
13064
- jsonBody: {}
13065
- commonParams: (
13072
+ jsonBody: (
13066
13073
  | {
13067
13074
  /** ID of user identity for whom access is being granted. */
13068
13075
  user_identity_id: string
@@ -13127,6 +13134,7 @@ export type Routes = {
13127
13134
  /** ID of the customization profile to apply to the Access Grant and its access methods. */
13128
13135
  customization_profile_id?: string | undefined
13129
13136
  }
13137
+ commonParams: {}
13130
13138
  formData: {}
13131
13139
  jsonResponse: {
13132
13140
  /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
@@ -16527,6 +16535,8 @@ export type Routes = {
16527
16535
  issued_at: string | null
16528
16536
  /** Indicates whether the access method has been issued. */
16529
16537
  is_issued: boolean
16538
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
16539
+ display_status: string
16530
16540
  /** URL of the Instant Key for mobile key access methods. */
16531
16541
  instant_key_url?: string | undefined
16532
16542
  /** Token of the client session associated with the access method. */
@@ -16903,8 +16913,7 @@ export type Routes = {
16903
16913
  route: '/access_grants/request_access_methods'
16904
16914
  method: 'POST'
16905
16915
  queryParams: {}
16906
- jsonBody: {}
16907
- commonParams: {
16916
+ jsonBody: {
16908
16917
  /** ID of the Access Grant to add access methods to. */
16909
16918
  access_grant_id: string
16910
16919
  /** Array of requested access methods to add to the access grant. */
@@ -16917,6 +16926,7 @@ export type Routes = {
16917
16926
  instant_key_max_use_count?: number | undefined
16918
16927
  }[]
16919
16928
  }
16929
+ commonParams: {}
16920
16930
  formData: {}
16921
16931
  jsonResponse: {
16922
16932
  /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
@@ -17561,8 +17571,7 @@ export type Routes = {
17561
17571
  route: '/access_grants/update'
17562
17572
  method: 'POST' | 'PATCH'
17563
17573
  queryParams: {}
17564
- jsonBody: {}
17565
- commonParams: {
17574
+ jsonBody: {
17566
17575
  /** Display name for the access grant. */
17567
17576
  name?: (string | null) | undefined
17568
17577
  /** ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`. */
@@ -17574,6 +17583,7 @@ export type Routes = {
17574
17583
  /** Date and time at which the validity of the 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`. */
17575
17584
  ends_at?: (string | null) | undefined
17576
17585
  }
17586
+ commonParams: {}
17577
17587
  formData: {}
17578
17588
  jsonResponse: {}
17579
17589
  maxDuration: undefined
@@ -17582,13 +17592,13 @@ export type Routes = {
17582
17592
  route: '/access_methods/assign_card'
17583
17593
  method: 'POST'
17584
17594
  queryParams: {}
17585
- jsonBody: {}
17586
- commonParams: {
17595
+ jsonBody: {
17587
17596
  /** ID of the `access_method` to assign the credential to. */
17588
17597
  access_method_id: string
17589
17598
  /** Card number of the credential to assign. */
17590
17599
  card_number: string
17591
17600
  }
17601
+ commonParams: {}
17592
17602
  formData: {}
17593
17603
  jsonResponse: {
17594
17604
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -18930,6 +18940,8 @@ export type Routes = {
18930
18940
  issued_at: string | null
18931
18941
  /** Indicates whether the access method has been issued. */
18932
18942
  is_issued: boolean
18943
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
18944
+ display_status: string
18933
18945
  /** URL of the Instant Key for mobile key access methods. */
18934
18946
  instant_key_url?: string | undefined
18935
18947
  /** Token of the client session associated with the access method. */
@@ -19704,13 +19716,13 @@ export type Routes = {
19704
19716
  route: '/access_methods/encode'
19705
19717
  method: 'POST'
19706
19718
  queryParams: {}
19707
- jsonBody: {}
19708
- commonParams: {
19719
+ jsonBody: {
19709
19720
  /** ID of the `acs_encoder` to use to encode the `access_method`. */
19710
19721
  acs_encoder_id: string
19711
19722
  /** ID of the `access_method` to encode onto a card. */
19712
19723
  access_method_id: string
19713
19724
  }
19725
+ commonParams: {}
19714
19726
  formData: {}
19715
19727
  jsonResponse: {
19716
19728
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -21052,6 +21064,8 @@ export type Routes = {
21052
21064
  issued_at: string | null
21053
21065
  /** Indicates whether the access method has been issued. */
21054
21066
  is_issued: boolean
21067
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
21068
+ display_status: string
21055
21069
  /** URL of the Instant Key for mobile key access methods. */
21056
21070
  instant_key_url?: string | undefined
21057
21071
  /** Token of the client session associated with the access method. */
@@ -21827,6 +21841,8 @@ export type Routes = {
21827
21841
  issued_at: string | null
21828
21842
  /** Indicates whether the access method has been issued. */
21829
21843
  is_issued: boolean
21844
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
21845
+ display_status: string
21830
21846
  /** URL of the Instant Key for mobile key access methods. */
21831
21847
  instant_key_url?: string | undefined
21832
21848
  /** Token of the client session associated with the access method. */
@@ -24435,6 +24451,8 @@ export type Routes = {
24435
24451
  issued_at: string | null
24436
24452
  /** Indicates whether the access method has been issued. */
24437
24453
  is_issued: boolean
24454
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
24455
+ display_status: string
24438
24456
  /** URL of the Instant Key for mobile key access methods. */
24439
24457
  instant_key_url?: string | undefined
24440
24458
  /** Token of the client session associated with the access method. */
@@ -24853,6 +24871,8 @@ export type Routes = {
24853
24871
  issued_at: string | null
24854
24872
  /** Indicates whether the access method has been issued. */
24855
24873
  is_issued: boolean
24874
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
24875
+ display_status: string
24856
24876
  /** URL of the Instant Key for mobile key access methods. */
24857
24877
  instant_key_url?: string | undefined
24858
24878
  /** Token of the client session associated with the access method. */
@@ -24993,13 +25013,13 @@ export type Routes = {
24993
25013
  route: '/access_methods/unlock_door'
24994
25014
  method: 'POST'
24995
25015
  queryParams: {}
24996
- jsonBody: {}
24997
- commonParams: {
25016
+ jsonBody: {
24998
25017
  /** ID of the cloud_key `access_method` to use for the unlock operation. */
24999
25018
  access_method_id: string
25000
25019
  /** ID of the entrance to unlock. */
25001
25020
  acs_entrance_id: string
25002
25021
  }
25022
+ commonParams: {}
25003
25023
  formData: {}
25004
25024
  jsonResponse: {
25005
25025
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -26341,6 +26361,8 @@ export type Routes = {
26341
26361
  issued_at: string | null
26342
26362
  /** Indicates whether the access method has been issued. */
26343
26363
  is_issued: boolean
26364
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
26365
+ display_status: string
26344
26366
  /** URL of the Instant Key for mobile key access methods. */
26345
26367
  instant_key_url?: string | undefined
26346
26368
  /** Token of the client session associated with the access method. */
@@ -27116,6 +27138,8 @@ export type Routes = {
27116
27138
  issued_at: string | null
27117
27139
  /** Indicates whether the access method has been issued. */
27118
27140
  is_issued: boolean
27141
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
27142
+ display_status: string
27119
27143
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
27120
27144
  is_encoding_required?: boolean | undefined
27121
27145
  /** Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued. */
@@ -27269,6 +27293,8 @@ export type Routes = {
27269
27293
  issued_at: string | null
27270
27294
  /** Indicates whether the access method has been issued. */
27271
27295
  is_issued: boolean
27296
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
27297
+ display_status: string
27272
27298
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
27273
27299
  is_encoding_required?: boolean | undefined
27274
27300
  /** Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued. */
@@ -27394,8 +27420,7 @@ export type Routes = {
27394
27420
  route: '/acs/access_groups/add_user'
27395
27421
  method: 'PUT' | 'POST'
27396
27422
  queryParams: {}
27397
- jsonBody: {}
27398
- commonParams: {
27423
+ jsonBody: {
27399
27424
  /** ID of the access group to which you want to add an access system user. */
27400
27425
  acs_access_group_id: string
27401
27426
  /** ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. */
@@ -27403,6 +27428,7 @@ export type Routes = {
27403
27428
  /** ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
27404
27429
  user_identity_id?: string | undefined
27405
27430
  }
27431
+ commonParams: {}
27406
27432
  formData: {}
27407
27433
  jsonResponse: {}
27408
27434
  maxDuration: undefined
@@ -28932,8 +28958,7 @@ export type Routes = {
28932
28958
  route: '/acs/credential_provisioning_automations/launch'
28933
28959
  method: 'POST'
28934
28960
  queryParams: {}
28935
- jsonBody: {}
28936
- commonParams: {
28961
+ jsonBody: {
28937
28962
  /** ID of the user identity for which you want to launch a credential provisioning automation. */
28938
28963
  user_identity_id: string
28939
28964
  /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
@@ -28945,6 +28970,7 @@ export type Routes = {
28945
28970
  /** ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
28946
28971
  credential_manager_acs_user_id?: string | undefined
28947
28972
  }
28973
+ commonParams: {}
28948
28974
  formData: {}
28949
28975
  jsonResponse: {
28950
28976
  /**
@@ -29173,8 +29199,7 @@ export type Routes = {
29173
29199
  route: '/acs/credentials/create'
29174
29200
  method: 'POST'
29175
29201
  queryParams: {}
29176
- jsonBody: {}
29177
- commonParams: {
29202
+ jsonBody: {
29178
29203
  /** ACS system ID of the credential manager for the new credential. */
29179
29204
  credential_manager_acs_system_id?: string | undefined
29180
29205
  /** ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
@@ -29238,6 +29263,7 @@ export type Routes = {
29238
29263
  /** Date and time at which the validity of the new credential 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`. */
29239
29264
  ends_at?: string | undefined
29240
29265
  }
29266
+ commonParams: {}
29241
29267
  formData: {}
29242
29268
  jsonResponse: {
29243
29269
  /** Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
@@ -29439,8 +29465,7 @@ export type Routes = {
29439
29465
  route: '/acs/credentials/create_offline_code'
29440
29466
  method: 'POST'
29441
29467
  queryParams: {}
29442
- jsonBody: {}
29443
- commonParams: {
29468
+ jsonBody: {
29444
29469
  /** ID of the access system user to whom the new credential belongs. */
29445
29470
  acs_user_id: string
29446
29471
  /** IDs of the [`acs_entrance`s](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access. */
@@ -29452,6 +29477,7 @@ export type Routes = {
29452
29477
  /** Date and time at which the validity of the new credential 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`. */
29453
29478
  ends_at?: string | undefined
29454
29479
  }
29480
+ commonParams: {}
29455
29481
  formData: {}
29456
29482
  jsonResponse: {
29457
29483
  /** Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
@@ -31193,8 +31219,7 @@ export type Routes = {
31193
31219
  route: '/acs/encoders/encode_credential'
31194
31220
  method: 'POST'
31195
31221
  queryParams: {}
31196
- jsonBody: {}
31197
- commonParams: {
31222
+ jsonBody: {
31198
31223
  /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
31199
31224
  acs_encoder_id: string
31200
31225
  /** ID of the `acs_credential` to encode onto a card. */
@@ -31202,6 +31227,7 @@ export type Routes = {
31202
31227
  /** ID of the `access_method` to encode onto a card. */
31203
31228
  access_method_id?: string | undefined
31204
31229
  }
31230
+ commonParams: {}
31205
31231
  formData: {}
31206
31232
  jsonResponse: {
31207
31233
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -32543,6 +32569,8 @@ export type Routes = {
32543
32569
  issued_at: string | null
32544
32570
  /** Indicates whether the access method has been issued. */
32545
32571
  is_issued: boolean
32572
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
32573
+ display_status: string
32546
32574
  /** URL of the Instant Key for mobile key access methods. */
32547
32575
  instant_key_url?: string | undefined
32548
32576
  /** Token of the client session associated with the access method. */
@@ -33400,8 +33428,7 @@ export type Routes = {
33400
33428
  route: '/acs/encoders/scan_credential'
33401
33429
  method: 'POST'
33402
33430
  queryParams: {}
33403
- jsonBody: {}
33404
- commonParams: {
33431
+ jsonBody: {
33405
33432
  /** ID of the encoder to use for the scan. */
33406
33433
  acs_encoder_id: string
33407
33434
  /** Salto KS-specific metadata for the scan action. */
@@ -33412,6 +33439,7 @@ export type Routes = {
33412
33439
  }
33413
33440
  | undefined
33414
33441
  }
33442
+ commonParams: {}
33415
33443
  formData: {}
33416
33444
  jsonResponse: {
33417
33445
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -34753,6 +34781,8 @@ export type Routes = {
34753
34781
  issued_at: string | null
34754
34782
  /** Indicates whether the access method has been issued. */
34755
34783
  is_issued: boolean
34784
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
34785
+ display_status: string
34756
34786
  /** URL of the Instant Key for mobile key access methods. */
34757
34787
  instant_key_url?: string | undefined
34758
34788
  /** Token of the client session associated with the access method. */
@@ -35505,8 +35535,7 @@ export type Routes = {
35505
35535
  route: '/acs/encoders/scan_to_assign_credential'
35506
35536
  method: 'POST'
35507
35537
  queryParams: {}
35508
- jsonBody: {}
35509
- commonParams: {
35538
+ jsonBody: {
35510
35539
  /** ID of the `acs_encoder` to use to scan the credential. */
35511
35540
  acs_encoder_id: string
35512
35541
  /** ID of the `acs_user` to assign the scanned credential to. */
@@ -35521,6 +35550,7 @@ export type Routes = {
35521
35550
  }
35522
35551
  | undefined
35523
35552
  }
35553
+ commonParams: {}
35524
35554
  formData: {}
35525
35555
  jsonResponse: {
35526
35556
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -36862,6 +36892,8 @@ export type Routes = {
36862
36892
  issued_at: string | null
36863
36893
  /** Indicates whether the access method has been issued. */
36864
36894
  is_issued: boolean
36895
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
36896
+ display_status: string
36865
36897
  /** URL of the Instant Key for mobile key access methods. */
36866
36898
  instant_key_url?: string | undefined
36867
36899
  /** Token of the client session associated with the access method. */
@@ -38508,13 +38540,13 @@ export type Routes = {
38508
38540
  route: '/acs/entrances/unlock'
38509
38541
  method: 'POST'
38510
38542
  queryParams: {}
38511
- jsonBody: {}
38512
- commonParams: {
38543
+ jsonBody: {
38513
38544
  /** ID of the entrance to unlock. */
38514
38545
  acs_entrance_id: string
38515
38546
  /** ID of the cloud_key credential to use for the unlock operation. */
38516
38547
  acs_credential_id: string
38517
38548
  }
38549
+ commonParams: {}
38518
38550
  formData: {}
38519
38551
  jsonResponse: {
38520
38552
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -39856,6 +39888,8 @@ export type Routes = {
39856
39888
  issued_at: string | null
39857
39889
  /** Indicates whether the access method has been issued. */
39858
39890
  is_issued: boolean
39891
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
39892
+ display_status: string
39859
39893
  /** URL of the Instant Key for mobile key access methods. */
39860
39894
  instant_key_url?: string | undefined
39861
39895
  /** Token of the client session associated with the access method. */
@@ -41283,8 +41317,7 @@ export type Routes = {
41283
41317
  route: '/acs/systems/report_devices'
41284
41318
  method: 'POST'
41285
41319
  queryParams: {}
41286
- jsonBody: {}
41287
- commonParams: {
41320
+ jsonBody: {
41288
41321
  /** ID of the ACS system to report resources for */
41289
41322
  acs_system_id: string
41290
41323
  /** Array of ACS encoders to report */
@@ -41315,6 +41348,7 @@ export type Routes = {
41315
41348
  }[]
41316
41349
  | undefined
41317
41350
  }
41351
+ commonParams: {}
41318
41352
  formData: {}
41319
41353
  jsonResponse: {}
41320
41354
  maxDuration: undefined
@@ -41323,13 +41357,13 @@ export type Routes = {
41323
41357
  route: '/acs/users/add_to_access_group'
41324
41358
  method: 'PUT' | 'POST'
41325
41359
  queryParams: {}
41326
- jsonBody: {}
41327
- commonParams: {
41360
+ jsonBody: {
41328
41361
  /** ID of the access system user that you want to add to an access group. */
41329
41362
  acs_user_id: string
41330
41363
  /** ID of the access group to which you want to add an access system user. */
41331
41364
  acs_access_group_id: string
41332
41365
  }
41366
+ commonParams: {}
41333
41367
  formData: {}
41334
41368
  jsonResponse: {}
41335
41369
  maxDuration: undefined
@@ -42694,8 +42728,7 @@ export type Routes = {
42694
42728
  route: '/acs/users/suspend'
42695
42729
  method: 'POST'
42696
42730
  queryParams: {}
42697
- jsonBody: {}
42698
- commonParams: {
42731
+ jsonBody: {
42699
42732
  /** ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
42700
42733
  acs_user_id?: string | undefined
42701
42734
  /** ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
@@ -42703,6 +42736,7 @@ export type Routes = {
42703
42736
  /** ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
42704
42737
  acs_system_id?: string | undefined
42705
42738
  }
42739
+ commonParams: {}
42706
42740
  formData: {}
42707
42741
  jsonResponse: {}
42708
42742
  maxDuration: undefined
@@ -43364,8 +43398,7 @@ export type Routes = {
43364
43398
  route: '/acs/users/unsuspend'
43365
43399
  method: 'POST'
43366
43400
  queryParams: {}
43367
- jsonBody: {}
43368
- commonParams: {
43401
+ jsonBody: {
43369
43402
  /** ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
43370
43403
  acs_user_id?: string | undefined
43371
43404
  /** ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
@@ -43373,6 +43406,7 @@ export type Routes = {
43373
43406
  /** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
43374
43407
  acs_system_id?: string | undefined
43375
43408
  }
43409
+ commonParams: {}
43376
43410
  formData: {}
43377
43411
  jsonResponse: {}
43378
43412
  maxDuration: undefined
@@ -44764,6 +44798,8 @@ export type Routes = {
44764
44798
  issued_at: string | null
44765
44799
  /** Indicates whether the access method has been issued. */
44766
44800
  is_issued: boolean
44801
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
44802
+ display_status: string
44767
44803
  /** URL of the Instant Key for mobile key access methods. */
44768
44804
  instant_key_url?: string | undefined
44769
44805
  /** Token of the client session associated with the access method. */
@@ -46863,6 +46899,8 @@ export type Routes = {
46863
46899
  issued_at: string | null
46864
46900
  /** Indicates whether the access method has been issued. */
46865
46901
  is_issued: boolean
46902
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
46903
+ display_status: string
46866
46904
  /** URL of the Instant Key for mobile key access methods. */
46867
46905
  instant_key_url?: string | undefined
46868
46906
  /** Token of the client session associated with the access method. */
@@ -47858,8 +47896,7 @@ export type Routes = {
47858
47896
  route: '/client_sessions/grant_access'
47859
47897
  method: 'PATCH' | 'POST'
47860
47898
  queryParams: {}
47861
- jsonBody: {}
47862
- commonParams: {
47899
+ jsonBody: {
47863
47900
  /** ID of the client session to which you want to grant access to resources. */
47864
47901
  client_session_id?: string | undefined
47865
47902
  /** Your user ID for the user that you want to associate with the client session. */
@@ -47874,6 +47911,7 @@ export type Routes = {
47874
47911
  /** ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
47875
47912
  user_identity_id?: string | undefined
47876
47913
  }
47914
+ commonParams: {}
47877
47915
  formData: {}
47878
47916
  jsonResponse: {
47879
47917
  /** Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
@@ -47968,11 +48006,11 @@ export type Routes = {
47968
48006
  route: '/client_sessions/revoke'
47969
48007
  method: 'POST'
47970
48008
  queryParams: {}
47971
- jsonBody: {}
47972
- commonParams: {
48009
+ jsonBody: {
47973
48010
  /** ID of the client session that you want to revoke. */
47974
48011
  client_session_id: string
47975
48012
  }
48013
+ commonParams: {}
47976
48014
  formData: {}
47977
48015
  jsonResponse: {}
47978
48016
  maxDuration: undefined
@@ -49111,8 +49149,7 @@ export type Routes = {
49111
49149
  route: '/customers/create_portal'
49112
49150
  method: 'POST'
49113
49151
  queryParams: {}
49114
- jsonBody: {}
49115
- commonParams: {
49152
+ jsonBody: {
49116
49153
  features?: {
49117
49154
  /** Configuration for the connect accounts feature. */
49118
49155
  connect?: {
@@ -49653,6 +49690,7 @@ export type Routes = {
49653
49690
  }
49654
49691
  | undefined
49655
49692
  }
49693
+ commonParams: {}
49656
49694
  formData: {}
49657
49695
  jsonResponse: {
49658
49696
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -49745,8 +49783,7 @@ export type Routes = {
49745
49783
  route: '/customers/push_data'
49746
49784
  method: 'POST'
49747
49785
  queryParams: {}
49748
- jsonBody: {}
49749
- commonParams: {
49786
+ jsonBody: {
49750
49787
  /** Your unique identifier for the customer. */
49751
49788
  customer_key: string
49752
49789
  /** List of general spaces or areas. */
@@ -50105,6 +50142,7 @@ export type Routes = {
50105
50142
  }[]
50106
50143
  | undefined
50107
50144
  }
50145
+ commonParams: {}
50108
50146
  formData: {}
50109
50147
  jsonResponse: {}
50110
50148
  maxDuration: undefined
@@ -50113,13 +50151,13 @@ export type Routes = {
50113
50151
  route: '/customers/reservations/create_deep_link'
50114
50152
  method: 'POST'
50115
50153
  queryParams: {}
50116
- jsonBody: {}
50117
- commonParams: {
50154
+ jsonBody: {
50118
50155
  /** The customer_key identifying the customer who owns the reservation. */
50119
50156
  customer_key: string
50120
50157
  /** The key of the reservation to create a deep link for. */
50121
50158
  reservation_key: string
50122
50159
  }
50160
+ commonParams: {}
50123
50161
  formData: {}
50124
50162
  jsonResponse: {
50125
50163
  deep_link: {
@@ -54297,8 +54335,7 @@ export type Routes = {
54297
54335
  route: '/devices/report_provider_metadata'
54298
54336
  method: 'POST'
54299
54337
  queryParams: {}
54300
- jsonBody: {}
54301
- commonParams: {
54338
+ jsonBody: {
54302
54339
  /** Array of devices with provider metadata to update */
54303
54340
  devices: {
54304
54341
  /** ID of the device to update */
@@ -55613,6 +55650,7 @@ export type Routes = {
55613
55650
  | undefined
55614
55651
  }[]
55615
55652
  }
55653
+ commonParams: {}
55616
55654
  formData: {}
55617
55655
  jsonResponse: {}
55618
55656
  maxDuration: undefined
@@ -57130,8 +57168,7 @@ export type Routes = {
57130
57168
  route: '/devices/unmanaged/update'
57131
57169
  method: 'POST' | 'PATCH'
57132
57170
  queryParams: {}
57133
- jsonBody: {}
57134
- commonParams: {
57171
+ jsonBody: {
57135
57172
  /** ID of the unmanaged device that you want to update. */
57136
57173
  device_id: string
57137
57174
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
@@ -57143,6 +57180,7 @@ export type Routes = {
57143
57180
  }
57144
57181
  | undefined
57145
57182
  }
57183
+ commonParams: {}
57146
57184
  formData: {}
57147
57185
  jsonResponse: {}
57148
57186
  maxDuration: undefined
@@ -57151,8 +57189,7 @@ export type Routes = {
57151
57189
  route: '/devices/update'
57152
57190
  method: 'POST' | 'PATCH'
57153
57191
  queryParams: {}
57154
- jsonBody: {}
57155
- commonParams: {
57192
+ jsonBody: {
57156
57193
  /** ID of the device that you want to update. */
57157
57194
  device_id: string
57158
57195
  properties?:
@@ -57174,6 +57211,7 @@ export type Routes = {
57174
57211
  /** Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use. */
57175
57212
  backup_access_code_pool_enabled?: boolean | undefined
57176
57213
  }
57214
+ commonParams: {}
57177
57215
  formData: {}
57178
57216
  jsonResponse: {}
57179
57217
  maxDuration: undefined
@@ -66163,6 +66201,8 @@ export type Routes = {
66163
66201
  issued_at: string | null
66164
66202
  /** Indicates whether the access method has been issued. */
66165
66203
  is_issued: boolean
66204
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
66205
+ display_status: string
66166
66206
  /** URL of the Instant Key for mobile key access methods. */
66167
66207
  instant_key_url?: string | undefined
66168
66208
  /** Token of the client session associated with the access method. */
@@ -75853,6 +75893,8 @@ export type Routes = {
75853
75893
  issued_at: string | null
75854
75894
  /** Indicates whether the access method has been issued. */
75855
75895
  is_issued: boolean
75896
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
75897
+ display_status: string
75856
75898
  /** URL of the Instant Key for mobile key access methods. */
75857
75899
  instant_key_url?: string | undefined
75858
75900
  /** Token of the client session associated with the access method. */
@@ -77953,6 +77995,8 @@ export type Routes = {
77953
77995
  issued_at: string | null
77954
77996
  /** Indicates whether the access method has been issued. */
77955
77997
  is_issued: boolean
77998
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
77999
+ display_status: string
77956
78000
  /** URL of the Instant Key for mobile key access methods. */
77957
78001
  instant_key_url?: string | undefined
77958
78002
  /** Token of the client session associated with the access method. */
@@ -80051,6 +80095,8 @@ export type Routes = {
80051
80095
  issued_at: string | null
80052
80096
  /** Indicates whether the access method has been issued. */
80053
80097
  is_issued: boolean
80098
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
80099
+ display_status: string
80054
80100
  /** URL of the Instant Key for mobile key access methods. */
80055
80101
  instant_key_url?: string | undefined
80056
80102
  /** Token of the client session associated with the access method. */
@@ -82151,6 +82197,8 @@ export type Routes = {
82151
82197
  issued_at: string | null
82152
82198
  /** Indicates whether the access method has been issued. */
82153
82199
  is_issued: boolean
82200
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
82201
+ display_status: string
82154
82202
  /** URL of the Instant Key for mobile key access methods. */
82155
82203
  instant_key_url?: string | undefined
82156
82204
  /** Token of the client session associated with the access method. */
@@ -88007,6 +88055,8 @@ export type Routes = {
88007
88055
  issued_at: string | null
88008
88056
  /** Indicates whether the access method has been issued. */
88009
88057
  is_issued: boolean
88058
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
88059
+ display_status: string
88010
88060
  /** URL of the Instant Key for mobile key access methods. */
88011
88061
  instant_key_url?: string | undefined
88012
88062
  /** Token of the client session associated with the access method. */
@@ -90126,6 +90176,8 @@ export type Routes = {
90126
90176
  issued_at: string | null
90127
90177
  /** Indicates whether the access method has been issued. */
90128
90178
  is_issued: boolean
90179
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
90180
+ display_status: string
90129
90181
  /** URL of the Instant Key for mobile key access methods. */
90130
90182
  instant_key_url?: string | undefined
90131
90183
  /** Token of the client session associated with the access method. */
@@ -92301,6 +92353,8 @@ export type Routes = {
92301
92353
  issued_at: string | null
92302
92354
  /** Indicates whether the access method has been issued. */
92303
92355
  is_issued: boolean
92356
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
92357
+ display_status: string
92304
92358
  /** URL of the Instant Key for mobile key access methods. */
92305
92359
  instant_key_url?: string | undefined
92306
92360
  /** Token of the client session associated with the access method. */
@@ -93916,11 +93970,11 @@ export type Routes = {
93916
93970
  route: '/seam/console/v1/lynx_migration/migrate_property'
93917
93971
  method: 'POST'
93918
93972
  queryParams: {}
93919
- jsonBody: {}
93920
- commonParams: {
93973
+ jsonBody: {
93921
93974
  /** ID of the space (property) to migrate. */
93922
93975
  space_id: string
93923
93976
  }
93977
+ commonParams: {}
93924
93978
  formData: {}
93925
93979
  jsonResponse: {
93926
93980
  lynx_migration_property_run: {
@@ -94779,8 +94833,7 @@ export type Routes = {
94779
94833
  route: '/seam/console/v1/workspace/feature_flags/update'
94780
94834
  method: 'POST'
94781
94835
  queryParams: {}
94782
- jsonBody: {}
94783
- commonParams: {
94836
+ jsonBody: {
94784
94837
  /** Name of the workspace feature flag to update. */
94785
94838
  feature_flag_name:
94786
94839
  | 'RESERVATION_LEGACY'
@@ -94800,6 +94853,7 @@ export type Routes = {
94800
94853
  /** Whether the feature flag should be enabled for the workspace. */
94801
94854
  enabled: boolean
94802
94855
  }
94856
+ commonParams: {}
94803
94857
  formData: {}
94804
94858
  jsonResponse: {
94805
94859
  feature_flag: {
@@ -95033,13 +95087,13 @@ export type Routes = {
95033
95087
  route: '/seam/customer/v1/access_grants/update'
95034
95088
  method: 'POST' | 'PATCH'
95035
95089
  queryParams: {}
95036
- jsonBody: {}
95037
- commonParams: {
95090
+ jsonBody: {
95038
95091
  /** ID of the Access Grant to update. */
95039
95092
  access_grant_id: string
95040
95093
  /** Array of location IDs to associate with the access grant. */
95041
95094
  space_ids: string[]
95042
95095
  }
95096
+ commonParams: {}
95043
95097
  formData: {}
95044
95098
  jsonResponse: {}
95045
95099
  maxDuration: undefined
@@ -95048,13 +95102,13 @@ export type Routes = {
95048
95102
  route: '/seam/customer/v1/access_methods/encode'
95049
95103
  method: 'POST'
95050
95104
  queryParams: {}
95051
- jsonBody: {}
95052
- commonParams: {
95105
+ jsonBody: {
95053
95106
  /** ID of the encoder to use for encoding the access method. */
95054
95107
  acs_encoder_id: string
95055
95108
  /** ID of the access method to encode onto a card. */
95056
95109
  access_method_id: string
95057
95110
  }
95111
+ commonParams: {}
95058
95112
  formData: {}
95059
95113
  jsonResponse: {
95060
95114
  /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
@@ -96396,6 +96450,8 @@ export type Routes = {
96396
96450
  issued_at: string | null
96397
96451
  /** Indicates whether the access method has been issued. */
96398
96452
  is_issued: boolean
96453
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
96454
+ display_status: string
96399
96455
  /** URL of the Instant Key for mobile key access methods. */
96400
96456
  instant_key_url?: string | undefined
96401
96457
  /** Token of the client session associated with the access method. */
@@ -97747,8 +97803,7 @@ export type Routes = {
97747
97803
  route: '/seam/customer/v1/connectors/sync'
97748
97804
  method: 'POST'
97749
97805
  queryParams: {}
97750
- jsonBody: {}
97751
- commonParams: {
97806
+ jsonBody: {
97752
97807
  /** ID of the connector to sync */
97753
97808
  connector_id: string
97754
97809
  /** Type of the connector to sync */
@@ -97760,6 +97815,7 @@ export type Routes = {
97760
97815
  /** Unique provider resource key of the connector to sync */
97761
97816
  unique_provider_resource_key?: (string | null) | undefined
97762
97817
  }
97818
+ commonParams: {}
97763
97819
  formData: {}
97764
97820
  jsonResponse: {
97765
97821
  connector_sync: {
@@ -98097,11 +98153,11 @@ export type Routes = {
98097
98153
  route: '/seam/customer/v1/customers/open_portal'
98098
98154
  method: 'POST'
98099
98155
  queryParams: {}
98100
- jsonBody: {}
98101
- commonParams: {
98156
+ jsonBody: {
98102
98157
  /** The customer key to open a portal for. */
98103
98158
  customer_key: string
98104
98159
  }
98160
+ commonParams: {}
98105
98161
  formData: {}
98106
98162
  jsonResponse: {
98107
98163
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -103105,8 +103161,7 @@ export type Routes = {
103105
103161
  route: '/seam/customer/v1/spaces/push_common_areas'
103106
103162
  method: 'POST'
103107
103163
  queryParams: {}
103108
- jsonBody: {}
103109
- commonParams: {
103164
+ jsonBody: {
103110
103165
  common_areas?:
103111
103166
  | {
103112
103167
  name: string
@@ -103121,6 +103176,7 @@ export type Routes = {
103121
103176
  }[]
103122
103177
  | undefined
103123
103178
  }
103179
+ commonParams: {}
103124
103180
  formData: {}
103125
103181
  jsonResponse: {}
103126
103182
  maxDuration: undefined
@@ -107265,6 +107321,8 @@ export type Routes = {
107265
107321
  issued_at: string | null
107266
107322
  /** Indicates whether the access method has been issued. */
107267
107323
  is_issued: boolean
107324
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
107325
+ display_status: string
107268
107326
  /** URL of the Instant Key for mobile key access methods. */
107269
107327
  instant_key_url?: string | undefined
107270
107328
  /** Token of the client session associated with the access method. */
@@ -108960,6 +109018,8 @@ export type Routes = {
108960
109018
  issued_at: string | null
108961
109019
  /** Indicates whether the access method has been issued. */
108962
109020
  is_issued: boolean
109021
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
109022
+ display_status: string
108963
109023
  /** URL of the Instant Key for mobile key access methods. */
108964
109024
  instant_key_url?: string | undefined
108965
109025
  /** Token of the client session associated with the access method. */
@@ -111064,6 +111124,8 @@ export type Routes = {
111064
111124
  issued_at: string | null
111065
111125
  /** Indicates whether the access method has been issued. */
111066
111126
  is_issued: boolean
111127
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
111128
+ display_status: string
111067
111129
  /** URL of the Instant Key for mobile key access methods. */
111068
111130
  instant_key_url?: string | undefined
111069
111131
  /** Token of the client session associated with the access method. */
@@ -113279,6 +113341,8 @@ export type Routes = {
113279
113341
  issued_at: string | null
113280
113342
  /** Indicates whether the access method has been issued. */
113281
113343
  is_issued: boolean
113344
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
113345
+ display_status: string
113282
113346
  /** URL of the Instant Key for mobile key access methods. */
113283
113347
  instant_key_url?: string | undefined
113284
113348
  /** Token of the client session associated with the access method. */
@@ -117276,6 +117340,8 @@ export type Routes = {
117276
117340
  issued_at: string | null
117277
117341
  /** Indicates whether the access method has been issued. */
117278
117342
  is_issued: boolean
117343
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
117344
+ display_status: string
117279
117345
  /** URL of the Instant Key for mobile key access methods. */
117280
117346
  instant_key_url?: string | undefined
117281
117347
  /** Token of the client session associated with the access method. */
@@ -119384,6 +119450,8 @@ export type Routes = {
119384
119450
  issued_at: string | null
119385
119451
  /** Indicates whether the access method has been issued. */
119386
119452
  is_issued: boolean
119453
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
119454
+ display_status: string
119387
119455
  /** URL of the Instant Key for mobile key access methods. */
119388
119456
  instant_key_url?: string | undefined
119389
119457
  /** Token of the client session associated with the access method. */
@@ -125257,6 +125325,8 @@ export type Routes = {
125257
125325
  issued_at: string | null
125258
125326
  /** Indicates whether the access method has been issued. */
125259
125327
  is_issued: boolean
125328
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
125329
+ display_status: string
125260
125330
  /** URL of the Instant Key for mobile key access methods. */
125261
125331
  instant_key_url?: string | undefined
125262
125332
  /** Token of the client session associated with the access method. */
@@ -127566,6 +127636,8 @@ export type Routes = {
127566
127636
  issued_at: string | null
127567
127637
  /** Indicates whether the access method has been issued. */
127568
127638
  is_issued: boolean
127639
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
127640
+ display_status: string
127569
127641
  /** URL of the Instant Key for mobile key access methods. */
127570
127642
  instant_key_url?: string | undefined
127571
127643
  /** Token of the client session associated with the access method. */
@@ -129702,6 +129774,8 @@ export type Routes = {
129702
129774
  issued_at: string | null
129703
129775
  /** Indicates whether the access method has been issued. */
129704
129776
  is_issued: boolean
129777
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
129778
+ display_status: string
129705
129779
  /** URL of the Instant Key for mobile key access methods. */
129706
129780
  instant_key_url?: string | undefined
129707
129781
  /** Token of the client session associated with the access method. */
@@ -131954,6 +132028,8 @@ export type Routes = {
131954
132028
  issued_at: string | null
131955
132029
  /** Indicates whether the access method has been issued. */
131956
132030
  is_issued: boolean
132031
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
132032
+ display_status: string
131957
132033
  /** URL of the Instant Key for mobile key access methods. */
131958
132034
  instant_key_url?: string | undefined
131959
132035
  /** Token of the client session associated with the access method. */
@@ -132706,11 +132782,11 @@ export type Routes = {
132706
132782
  route: '/unstable_partner/building_blocks/connect_accounts'
132707
132783
  method: 'POST'
132708
132784
  queryParams: {}
132709
- jsonBody: {}
132710
- commonParams: {
132785
+ jsonBody: {
132711
132786
  /** Customer key for which you want to connect accounts. */
132712
132787
  customer_key: string
132713
132788
  }
132789
+ commonParams: {}
132714
132790
  formData: {}
132715
132791
  jsonResponse: {
132716
132792
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -132806,11 +132882,11 @@ export type Routes = {
132806
132882
  route: '/unstable_partner/building_blocks/manage_devices'
132807
132883
  method: 'POST'
132808
132884
  queryParams: {}
132809
- jsonBody: {}
132810
- commonParams: {
132885
+ jsonBody: {
132811
132886
  /** Customer key for which you want to manage devices. */
132812
132887
  customer_key: string
132813
132888
  }
132889
+ commonParams: {}
132814
132890
  formData: {}
132815
132891
  jsonResponse: {
132816
132892
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -132837,8 +132913,7 @@ export type Routes = {
132837
132913
  route: '/unstable_partner/building_blocks/organize_spaces'
132838
132914
  method: 'POST'
132839
132915
  queryParams: {}
132840
- jsonBody: {}
132841
- commonParams: {
132916
+ jsonBody: {
132842
132917
  /** Customer key for which you want to organize spaces. */
132843
132918
  customer_key: string
132844
132919
  /** Optional list of spaces that you want to include in the new building block magic link. */
@@ -132877,6 +132952,7 @@ export type Routes = {
132877
132952
  }[]
132878
132953
  | undefined
132879
132954
  }
132955
+ commonParams: {}
132880
132956
  formData: {}
132881
132957
  jsonResponse: {
132882
132958
  /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
@@ -132903,8 +132979,7 @@ export type Routes = {
132903
132979
  route: '/user_identities/add_acs_user'
132904
132980
  method: 'POST' | 'PUT'
132905
132981
  queryParams: {}
132906
- jsonBody: {}
132907
- commonParams: {
132982
+ jsonBody: {
132908
132983
  /** ID of the user identity to which you want to add an access system user. */
132909
132984
  user_identity_id?: string | undefined
132910
132985
  /** Key of the user identity to which you want to add an access system user. */
@@ -132912,6 +132987,7 @@ export type Routes = {
132912
132987
  /** ID of the access system user that you want to add to the user identity. */
132913
132988
  acs_user_id: string
132914
132989
  }
132990
+ commonParams: {}
132915
132991
  formData: {}
132916
132992
  jsonResponse: {}
132917
132993
  maxDuration: undefined
@@ -132920,8 +132996,7 @@ export type Routes = {
132920
132996
  route: '/user_identities/create'
132921
132997
  method: 'POST'
132922
132998
  queryParams: {}
132923
- jsonBody: {}
132924
- commonParams: {
132999
+ jsonBody: {
132925
133000
  /** Unique key for the new user identity. */
132926
133001
  user_identity_key?: (string | null) | undefined
132927
133002
  /** Unique email address for the new user identity. */
@@ -132933,6 +133008,7 @@ export type Routes = {
132933
133008
  /** List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. */
132934
133009
  acs_system_ids?: string[] | undefined
132935
133010
  }
133011
+ commonParams: {}
132936
133012
  formData: {}
132937
133013
  jsonResponse: {
132938
133014
  /** Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
@@ -133048,8 +133124,7 @@ export type Routes = {
133048
133124
  route: '/user_identities/enrollment_automations/launch'
133049
133125
  method: 'POST'
133050
133126
  queryParams: {}
133051
- jsonBody: {}
133052
- commonParams: {
133127
+ jsonBody: {
133053
133128
  /** ID of the user identity for which you want to launch an enrollment automation. */
133054
133129
  user_identity_id: string
133055
133130
  /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
@@ -133061,6 +133136,7 @@ export type Routes = {
133061
133136
  /** ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
133062
133137
  credential_manager_acs_user_id?: string | undefined
133063
133138
  }
133139
+ commonParams: {}
133064
133140
  formData: {}
133065
133141
  jsonResponse: {
133066
133142
  /** Represents an [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/capability-guides/mobile-access/). */
@@ -133109,14 +133185,14 @@ export type Routes = {
133109
133185
  route: '/user_identities/generate_instant_key'
133110
133186
  method: 'POST'
133111
133187
  queryParams: {}
133112
- jsonBody: {}
133113
- commonParams: {
133188
+ jsonBody: {
133114
133189
  customization_profile_id?: string | undefined
133115
133190
  /** ID of the user identity for which you want to generate an instant key. */
133116
133191
  user_identity_id: string
133117
133192
  /** Maximum number of times the instant key can be used. Default: 1. */
133118
133193
  max_use_count?: number
133119
133194
  }
133195
+ commonParams: {}
133120
133196
  formData: {}
133121
133197
  jsonResponse: {
133122
133198
  /** Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.
@@ -133229,13 +133305,13 @@ export type Routes = {
133229
133305
  route: '/user_identities/grant_access_to_device'
133230
133306
  method: 'PUT' | 'POST'
133231
133307
  queryParams: {}
133232
- jsonBody: {}
133233
- commonParams: {
133308
+ jsonBody: {
133234
133309
  /** ID of the user identity that you want to grant access to a device. */
133235
133310
  user_identity_id: string
133236
133311
  /** ID of the managed device to which you want to grant access to the user identity. */
133237
133312
  device_id: string
133238
133313
  }
133314
+ commonParams: {}
133239
133315
  formData: {}
133240
133316
  jsonResponse: {}
133241
133317
  maxDuration: undefined
@@ -142856,6 +142932,8 @@ export type Routes = {
142856
142932
  issued_at: string | null
142857
142933
  /** Indicates whether the access method has been issued. */
142858
142934
  is_issued: boolean
142935
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
142936
+ display_status: string
142859
142937
  /** URL of the Instant Key for mobile key access methods. */
142860
142938
  instant_key_url?: string | undefined
142861
142939
  /** Token of the client session associated with the access method. */
@@ -144852,6 +144930,8 @@ export type Routes = {
144852
144930
  issued_at: string | null
144853
144931
  /** Indicates whether the access method has been issued. */
144854
144932
  is_issued: boolean
144933
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
144934
+ display_status: string
144855
144935
  /** URL of the Instant Key for mobile key access methods. */
144856
144936
  instant_key_url?: string | undefined
144857
144937
  /** Token of the client session associated with the access method. */
@@ -151847,6 +151927,8 @@ export type Routes = {
151847
151927
  issued_at: string | null
151848
151928
  /** Indicates whether the access method has been issued. */
151849
151929
  is_issued: boolean
151930
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
151931
+ display_status: string
151850
151932
  /** URL of the Instant Key for mobile key access methods. */
151851
151933
  instant_key_url?: string | undefined
151852
151934
  /** Token of the client session associated with the access method. */