@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.
@@ -1143,6 +1143,8 @@ export type Routes = {
1143
1143
  issued_at: string | null;
1144
1144
  /** Indicates whether the access method has been issued. */
1145
1145
  is_issued: boolean;
1146
+ /** 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`. */
1147
+ display_status: string;
1146
1148
  /** URL of the Instant Key for mobile key access methods. */
1147
1149
  instant_key_url?: string | undefined;
1148
1150
  /** Token of the client session associated with the access method. */
@@ -3885,6 +3887,8 @@ export type Routes = {
3885
3887
  issued_at: string | null;
3886
3888
  /** Indicates whether the access method has been issued. */
3887
3889
  is_issued: boolean;
3890
+ /** 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`. */
3891
+ display_status: string;
3888
3892
  /** URL of the Instant Key for mobile key access methods. */
3889
3893
  instant_key_url?: string | undefined;
3890
3894
  /** Token of the client session associated with the access method. */
@@ -6941,8 +6945,7 @@ export type Routes = {
6941
6945
  route: '/access_codes/unmanaged/convert_to_managed';
6942
6946
  method: 'POST' | 'PATCH';
6943
6947
  queryParams: {};
6944
- jsonBody: {};
6945
- commonParams: {
6948
+ jsonBody: {
6946
6949
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
6947
6950
  access_code_id: string;
6948
6951
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. */
@@ -6954,6 +6957,7 @@ export type Routes = {
6954
6957
  /** */
6955
6958
  sync?: boolean;
6956
6959
  };
6960
+ commonParams: {};
6957
6961
  formData: {};
6958
6962
  jsonResponse: {};
6959
6963
  maxDuration: undefined;
@@ -8066,6 +8070,8 @@ export type Routes = {
8066
8070
  issued_at: string | null;
8067
8071
  /** Indicates whether the access method has been issued. */
8068
8072
  is_issued: boolean;
8073
+ /** 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`. */
8074
+ display_status: string;
8069
8075
  /** URL of the Instant Key for mobile key access methods. */
8070
8076
  instant_key_url?: string | undefined;
8071
8077
  /** Token of the client session associated with the access method. */
@@ -9524,8 +9530,7 @@ export type Routes = {
9524
9530
  route: '/access_codes/unmanaged/update';
9525
9531
  method: 'PATCH' | 'POST';
9526
9532
  queryParams: {};
9527
- jsonBody: {};
9528
- commonParams: {
9533
+ jsonBody: {
9529
9534
  /** ID of the unmanaged access code that you want to update. */
9530
9535
  access_code_id: string;
9531
9536
  is_managed: boolean;
@@ -9536,6 +9541,7 @@ export type Routes = {
9536
9541
  /** Indicates whether to force the unmanaged access code update. */
9537
9542
  force?: boolean | undefined;
9538
9543
  };
9544
+ commonParams: {};
9539
9545
  formData: {};
9540
9546
  jsonResponse: {};
9541
9547
  maxDuration: undefined;
@@ -10673,6 +10679,8 @@ export type Routes = {
10673
10679
  issued_at: string | null;
10674
10680
  /** Indicates whether the access method has been issued. */
10675
10681
  is_issued: boolean;
10682
+ /** 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`. */
10683
+ display_status: string;
10676
10684
  /** URL of the Instant Key for mobile key access methods. */
10677
10685
  instant_key_url?: string | undefined;
10678
10686
  /** Token of the client session associated with the access method. */
@@ -11390,8 +11398,7 @@ export type Routes = {
11390
11398
  route: '/access_grants/create';
11391
11399
  method: 'POST';
11392
11400
  queryParams: {};
11393
- jsonBody: {};
11394
- commonParams: ({
11401
+ jsonBody: ({
11395
11402
  /** ID of user identity for whom access is being granted. */
11396
11403
  user_identity_id: string;
11397
11404
  } | {
@@ -11451,6 +11458,7 @@ export type Routes = {
11451
11458
  /** ID of the customization profile to apply to the Access Grant and its access methods. */
11452
11459
  customization_profile_id?: string | undefined;
11453
11460
  };
11461
+ commonParams: {};
11454
11462
  formData: {};
11455
11463
  jsonResponse: {
11456
11464
  /** 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. */
@@ -14161,6 +14169,8 @@ export type Routes = {
14161
14169
  issued_at: string | null;
14162
14170
  /** Indicates whether the access method has been issued. */
14163
14171
  is_issued: boolean;
14172
+ /** 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`. */
14173
+ display_status: string;
14164
14174
  /** URL of the Instant Key for mobile key access methods. */
14165
14175
  instant_key_url?: string | undefined;
14166
14176
  /** Token of the client session associated with the access method. */
@@ -14511,8 +14521,7 @@ export type Routes = {
14511
14521
  route: '/access_grants/request_access_methods';
14512
14522
  method: 'POST';
14513
14523
  queryParams: {};
14514
- jsonBody: {};
14515
- commonParams: {
14524
+ jsonBody: {
14516
14525
  /** ID of the Access Grant to add access methods to. */
14517
14526
  access_grant_id: string;
14518
14527
  /** Array of requested access methods to add to the access grant. */
@@ -14525,6 +14534,7 @@ export type Routes = {
14525
14534
  instant_key_max_use_count?: number | undefined;
14526
14535
  }[];
14527
14536
  };
14537
+ commonParams: {};
14528
14538
  formData: {};
14529
14539
  jsonResponse: {
14530
14540
  /** 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. */
@@ -15121,8 +15131,7 @@ export type Routes = {
15121
15131
  route: '/access_grants/update';
15122
15132
  method: 'POST' | 'PATCH';
15123
15133
  queryParams: {};
15124
- jsonBody: {};
15125
- commonParams: {
15134
+ jsonBody: {
15126
15135
  /** Display name for the access grant. */
15127
15136
  name?: (string | null) | undefined;
15128
15137
  /** ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`. */
@@ -15134,6 +15143,7 @@ export type Routes = {
15134
15143
  /** 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`. */
15135
15144
  ends_at?: (string | null) | undefined;
15136
15145
  };
15146
+ commonParams: {};
15137
15147
  formData: {};
15138
15148
  jsonResponse: {};
15139
15149
  maxDuration: undefined;
@@ -15142,13 +15152,13 @@ export type Routes = {
15142
15152
  route: '/access_methods/assign_card';
15143
15153
  method: 'POST';
15144
15154
  queryParams: {};
15145
- jsonBody: {};
15146
- commonParams: {
15155
+ jsonBody: {
15147
15156
  /** ID of the `access_method` to assign the credential to. */
15148
15157
  access_method_id: string;
15149
15158
  /** Card number of the credential to assign. */
15150
15159
  card_number: string;
15151
15160
  };
15161
+ commonParams: {};
15152
15162
  formData: {};
15153
15163
  jsonResponse: {
15154
15164
  /** 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.
@@ -16246,6 +16256,8 @@ export type Routes = {
16246
16256
  issued_at: string | null;
16247
16257
  /** Indicates whether the access method has been issued. */
16248
16258
  is_issued: boolean;
16259
+ /** 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`. */
16260
+ display_status: string;
16249
16261
  /** URL of the Instant Key for mobile key access methods. */
16250
16262
  instant_key_url?: string | undefined;
16251
16263
  /** Token of the client session associated with the access method. */
@@ -16957,13 +16969,13 @@ export type Routes = {
16957
16969
  route: '/access_methods/encode';
16958
16970
  method: 'POST';
16959
16971
  queryParams: {};
16960
- jsonBody: {};
16961
- commonParams: {
16972
+ jsonBody: {
16962
16973
  /** ID of the `acs_encoder` to use to encode the `access_method`. */
16963
16974
  acs_encoder_id: string;
16964
16975
  /** ID of the `access_method` to encode onto a card. */
16965
16976
  access_method_id: string;
16966
16977
  };
16978
+ commonParams: {};
16967
16979
  formData: {};
16968
16980
  jsonResponse: {
16969
16981
  /** 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.
@@ -18061,6 +18073,8 @@ export type Routes = {
18061
18073
  issued_at: string | null;
18062
18074
  /** Indicates whether the access method has been issued. */
18063
18075
  is_issued: boolean;
18076
+ /** 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`. */
18077
+ display_status: string;
18064
18078
  /** URL of the Instant Key for mobile key access methods. */
18065
18079
  instant_key_url?: string | undefined;
18066
18080
  /** Token of the client session associated with the access method. */
@@ -18776,6 +18790,8 @@ export type Routes = {
18776
18790
  issued_at: string | null;
18777
18791
  /** Indicates whether the access method has been issued. */
18778
18792
  is_issued: boolean;
18793
+ /** 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`. */
18794
+ display_status: string;
18779
18795
  /** URL of the Instant Key for mobile key access methods. */
18780
18796
  instant_key_url?: string | undefined;
18781
18797
  /** Token of the client session associated with the access method. */
@@ -20840,6 +20856,8 @@ export type Routes = {
20840
20856
  issued_at: string | null;
20841
20857
  /** Indicates whether the access method has been issued. */
20842
20858
  is_issued: boolean;
20859
+ /** 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`. */
20860
+ display_status: string;
20843
20861
  /** URL of the Instant Key for mobile key access methods. */
20844
20862
  instant_key_url?: string | undefined;
20845
20863
  /** Token of the client session associated with the access method. */
@@ -21204,6 +21222,8 @@ export type Routes = {
21204
21222
  issued_at: string | null;
21205
21223
  /** Indicates whether the access method has been issued. */
21206
21224
  is_issued: boolean;
21225
+ /** 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`. */
21226
+ display_status: string;
21207
21227
  /** URL of the Instant Key for mobile key access methods. */
21208
21228
  instant_key_url?: string | undefined;
21209
21229
  /** Token of the client session associated with the access method. */
@@ -21335,13 +21355,13 @@ export type Routes = {
21335
21355
  route: '/access_methods/unlock_door';
21336
21356
  method: 'POST';
21337
21357
  queryParams: {};
21338
- jsonBody: {};
21339
- commonParams: {
21358
+ jsonBody: {
21340
21359
  /** ID of the cloud_key `access_method` to use for the unlock operation. */
21341
21360
  access_method_id: string;
21342
21361
  /** ID of the entrance to unlock. */
21343
21362
  acs_entrance_id: string;
21344
21363
  };
21364
+ commonParams: {};
21345
21365
  formData: {};
21346
21366
  jsonResponse: {
21347
21367
  /** 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.
@@ -22439,6 +22459,8 @@ export type Routes = {
22439
22459
  issued_at: string | null;
22440
22460
  /** Indicates whether the access method has been issued. */
22441
22461
  is_issued: boolean;
22462
+ /** 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`. */
22463
+ display_status: string;
22442
22464
  /** URL of the Instant Key for mobile key access methods. */
22443
22465
  instant_key_url?: string | undefined;
22444
22466
  /** Token of the client session associated with the access method. */
@@ -23154,6 +23176,8 @@ export type Routes = {
23154
23176
  issued_at: string | null;
23155
23177
  /** Indicates whether the access method has been issued. */
23156
23178
  is_issued: boolean;
23179
+ /** 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`. */
23180
+ display_status: string;
23157
23181
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
23158
23182
  is_encoding_required?: boolean | undefined;
23159
23183
  /** 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. */
@@ -23298,6 +23322,8 @@ export type Routes = {
23298
23322
  issued_at: string | null;
23299
23323
  /** Indicates whether the access method has been issued. */
23300
23324
  is_issued: boolean;
23325
+ /** 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`. */
23326
+ display_status: string;
23301
23327
  /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
23302
23328
  is_encoding_required?: boolean | undefined;
23303
23329
  /** 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. */
@@ -23414,8 +23440,7 @@ export type Routes = {
23414
23440
  route: '/acs/access_groups/add_user';
23415
23441
  method: 'PUT' | 'POST';
23416
23442
  queryParams: {};
23417
- jsonBody: {};
23418
- commonParams: {
23443
+ jsonBody: {
23419
23444
  /** ID of the access group to which you want to add an access system user. */
23420
23445
  acs_access_group_id: string;
23421
23446
  /** 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. */
@@ -23423,6 +23448,7 @@ export type Routes = {
23423
23448
  /** 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. */
23424
23449
  user_identity_id?: string | undefined;
23425
23450
  };
23451
+ commonParams: {};
23426
23452
  formData: {};
23427
23453
  jsonResponse: {};
23428
23454
  maxDuration: undefined;
@@ -24716,8 +24742,7 @@ export type Routes = {
24716
24742
  route: '/acs/credential_provisioning_automations/launch';
24717
24743
  method: 'POST';
24718
24744
  queryParams: {};
24719
- jsonBody: {};
24720
- commonParams: {
24745
+ jsonBody: {
24721
24746
  /** ID of the user identity for which you want to launch a credential provisioning automation. */
24722
24747
  user_identity_id: string;
24723
24748
  /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
@@ -24729,6 +24754,7 @@ export type Routes = {
24729
24754
  /** 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`. */
24730
24755
  credential_manager_acs_user_id?: string | undefined;
24731
24756
  };
24757
+ commonParams: {};
24732
24758
  formData: {};
24733
24759
  jsonResponse: {
24734
24760
  /**
@@ -24923,8 +24949,7 @@ export type Routes = {
24923
24949
  route: '/acs/credentials/create';
24924
24950
  method: 'POST';
24925
24951
  queryParams: {};
24926
- jsonBody: {};
24927
- commonParams: {
24952
+ jsonBody: {
24928
24953
  /** ACS system ID of the credential manager for the new credential. */
24929
24954
  credential_manager_acs_system_id?: string | undefined;
24930
24955
  /** 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`. */
@@ -24979,6 +25004,7 @@ export type Routes = {
24979
25004
  /** 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`. */
24980
25005
  ends_at?: string | undefined;
24981
25006
  };
25007
+ commonParams: {};
24982
25008
  formData: {};
24983
25009
  jsonResponse: {
24984
25010
  /** 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).
@@ -25146,8 +25172,7 @@ export type Routes = {
25146
25172
  route: '/acs/credentials/create_offline_code';
25147
25173
  method: 'POST';
25148
25174
  queryParams: {};
25149
- jsonBody: {};
25150
- commonParams: {
25175
+ jsonBody: {
25151
25176
  /** ID of the access system user to whom the new credential belongs. */
25152
25177
  acs_user_id: string;
25153
25178
  /** 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. */
@@ -25159,6 +25184,7 @@ export type Routes = {
25159
25184
  /** 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`. */
25160
25185
  ends_at?: string | undefined;
25161
25186
  };
25187
+ commonParams: {};
25162
25188
  formData: {};
25163
25189
  jsonResponse: {
25164
25190
  /** 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).
@@ -26605,8 +26631,7 @@ export type Routes = {
26605
26631
  route: '/acs/encoders/encode_credential';
26606
26632
  method: 'POST';
26607
26633
  queryParams: {};
26608
- jsonBody: {};
26609
- commonParams: {
26634
+ jsonBody: {
26610
26635
  /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
26611
26636
  acs_encoder_id: string;
26612
26637
  /** ID of the `acs_credential` to encode onto a card. */
@@ -26614,6 +26639,7 @@ export type Routes = {
26614
26639
  /** ID of the `access_method` to encode onto a card. */
26615
26640
  access_method_id?: string | undefined;
26616
26641
  };
26642
+ commonParams: {};
26617
26643
  formData: {};
26618
26644
  jsonResponse: {
26619
26645
  /** 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.
@@ -27711,6 +27737,8 @@ export type Routes = {
27711
27737
  issued_at: string | null;
27712
27738
  /** Indicates whether the access method has been issued. */
27713
27739
  is_issued: boolean;
27740
+ /** 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`. */
27741
+ display_status: string;
27714
27742
  /** URL of the Instant Key for mobile key access methods. */
27715
27743
  instant_key_url?: string | undefined;
27716
27744
  /** Token of the client session associated with the access method. */
@@ -28508,8 +28536,7 @@ export type Routes = {
28508
28536
  route: '/acs/encoders/scan_credential';
28509
28537
  method: 'POST';
28510
28538
  queryParams: {};
28511
- jsonBody: {};
28512
- commonParams: {
28539
+ jsonBody: {
28513
28540
  /** ID of the encoder to use for the scan. */
28514
28541
  acs_encoder_id: string;
28515
28542
  /** Salto KS-specific metadata for the scan action. */
@@ -28518,6 +28545,7 @@ export type Routes = {
28518
28545
  detect_new_tags?: boolean;
28519
28546
  } | undefined;
28520
28547
  };
28548
+ commonParams: {};
28521
28549
  formData: {};
28522
28550
  jsonResponse: {
28523
28551
  /** 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.
@@ -29615,6 +29643,8 @@ export type Routes = {
29615
29643
  issued_at: string | null;
29616
29644
  /** Indicates whether the access method has been issued. */
29617
29645
  is_issued: boolean;
29646
+ /** 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`. */
29647
+ display_status: string;
29618
29648
  /** URL of the Instant Key for mobile key access methods. */
29619
29649
  instant_key_url?: string | undefined;
29620
29650
  /** Token of the client session associated with the access method. */
@@ -30307,8 +30337,7 @@ export type Routes = {
30307
30337
  route: '/acs/encoders/scan_to_assign_credential';
30308
30338
  method: 'POST';
30309
30339
  queryParams: {};
30310
- jsonBody: {};
30311
- commonParams: {
30340
+ jsonBody: {
30312
30341
  /** ID of the `acs_encoder` to use to scan the credential. */
30313
30342
  acs_encoder_id: string;
30314
30343
  /** ID of the `acs_user` to assign the scanned credential to. */
@@ -30321,6 +30350,7 @@ export type Routes = {
30321
30350
  detect_new_tags?: boolean;
30322
30351
  } | undefined;
30323
30352
  };
30353
+ commonParams: {};
30324
30354
  formData: {};
30325
30355
  jsonResponse: {
30326
30356
  /** 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.
@@ -31418,6 +31448,8 @@ export type Routes = {
31418
31448
  issued_at: string | null;
31419
31449
  /** Indicates whether the access method has been issued. */
31420
31450
  is_issued: boolean;
31451
+ /** 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`. */
31452
+ display_status: string;
31421
31453
  /** URL of the Instant Key for mobile key access methods. */
31422
31454
  instant_key_url?: string | undefined;
31423
31455
  /** Token of the client session associated with the access method. */
@@ -32848,13 +32880,13 @@ export type Routes = {
32848
32880
  route: '/acs/entrances/unlock';
32849
32881
  method: 'POST';
32850
32882
  queryParams: {};
32851
- jsonBody: {};
32852
- commonParams: {
32883
+ jsonBody: {
32853
32884
  /** ID of the entrance to unlock. */
32854
32885
  acs_entrance_id: string;
32855
32886
  /** ID of the cloud_key credential to use for the unlock operation. */
32856
32887
  acs_credential_id: string;
32857
32888
  };
32889
+ commonParams: {};
32858
32890
  formData: {};
32859
32891
  jsonResponse: {
32860
32892
  /** 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.
@@ -33952,6 +33984,8 @@ export type Routes = {
33952
33984
  issued_at: string | null;
33953
33985
  /** Indicates whether the access method has been issued. */
33954
33986
  is_issued: boolean;
33987
+ /** 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`. */
33988
+ display_status: string;
33955
33989
  /** URL of the Instant Key for mobile key access methods. */
33956
33990
  instant_key_url?: string | undefined;
33957
33991
  /** Token of the client session associated with the access method. */
@@ -35148,8 +35182,7 @@ export type Routes = {
35148
35182
  route: '/acs/systems/report_devices';
35149
35183
  method: 'POST';
35150
35184
  queryParams: {};
35151
- jsonBody: {};
35152
- commonParams: {
35185
+ jsonBody: {
35153
35186
  /** ID of the ACS system to report resources for */
35154
35187
  acs_system_id: string;
35155
35188
  /** Array of ACS encoders to report */
@@ -35176,6 +35209,7 @@ export type Routes = {
35176
35209
  };
35177
35210
  }[] | undefined;
35178
35211
  };
35212
+ commonParams: {};
35179
35213
  formData: {};
35180
35214
  jsonResponse: {};
35181
35215
  maxDuration: undefined;
@@ -35184,13 +35218,13 @@ export type Routes = {
35184
35218
  route: '/acs/users/add_to_access_group';
35185
35219
  method: 'PUT' | 'POST';
35186
35220
  queryParams: {};
35187
- jsonBody: {};
35188
- commonParams: {
35221
+ jsonBody: {
35189
35222
  /** ID of the access system user that you want to add to an access group. */
35190
35223
  acs_user_id: string;
35191
35224
  /** ID of the access group to which you want to add an access system user. */
35192
35225
  acs_access_group_id: string;
35193
35226
  };
35227
+ commonParams: {};
35194
35228
  formData: {};
35195
35229
  jsonResponse: {};
35196
35230
  maxDuration: undefined;
@@ -36367,8 +36401,7 @@ export type Routes = {
36367
36401
  route: '/acs/users/suspend';
36368
36402
  method: 'POST';
36369
36403
  queryParams: {};
36370
- jsonBody: {};
36371
- commonParams: {
36404
+ jsonBody: {
36372
36405
  /** 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. */
36373
36406
  acs_user_id?: string | undefined;
36374
36407
  /** 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. */
@@ -36376,6 +36409,7 @@ export type Routes = {
36376
36409
  /** 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. */
36377
36410
  acs_system_id?: string | undefined;
36378
36411
  };
36412
+ commonParams: {};
36379
36413
  formData: {};
36380
36414
  jsonResponse: {};
36381
36415
  maxDuration: undefined;
@@ -36951,8 +36985,7 @@ export type Routes = {
36951
36985
  route: '/acs/users/unsuspend';
36952
36986
  method: 'POST';
36953
36987
  queryParams: {};
36954
- jsonBody: {};
36955
- commonParams: {
36988
+ jsonBody: {
36956
36989
  /** 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. */
36957
36990
  acs_user_id?: string | undefined;
36958
36991
  /** 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. */
@@ -36960,6 +36993,7 @@ export type Routes = {
36960
36993
  /** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
36961
36994
  acs_system_id?: string | undefined;
36962
36995
  };
36996
+ commonParams: {};
36963
36997
  formData: {};
36964
36998
  jsonResponse: {};
36965
36999
  maxDuration: undefined;
@@ -38105,6 +38139,8 @@ export type Routes = {
38105
38139
  issued_at: string | null;
38106
38140
  /** Indicates whether the access method has been issued. */
38107
38141
  is_issued: boolean;
38142
+ /** 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`. */
38143
+ display_status: string;
38108
38144
  /** URL of the Instant Key for mobile key access methods. */
38109
38145
  instant_key_url?: string | undefined;
38110
38146
  /** Token of the client session associated with the access method. */
@@ -39900,6 +39936,8 @@ export type Routes = {
39900
39936
  issued_at: string | null;
39901
39937
  /** Indicates whether the access method has been issued. */
39902
39938
  is_issued: boolean;
39939
+ /** 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`. */
39940
+ display_status: string;
39903
39941
  /** URL of the Instant Key for mobile key access methods. */
39904
39942
  instant_key_url?: string | undefined;
39905
39943
  /** Token of the client session associated with the access method. */
@@ -40834,8 +40872,7 @@ export type Routes = {
40834
40872
  route: '/client_sessions/grant_access';
40835
40873
  method: 'PATCH' | 'POST';
40836
40874
  queryParams: {};
40837
- jsonBody: {};
40838
- commonParams: {
40875
+ jsonBody: {
40839
40876
  /** ID of the client session to which you want to grant access to resources. */
40840
40877
  client_session_id?: string | undefined;
40841
40878
  /** Your user ID for the user that you want to associate with the client session. */
@@ -40850,6 +40887,7 @@ export type Routes = {
40850
40887
  /** 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. */
40851
40888
  user_identity_id?: string | undefined;
40852
40889
  };
40890
+ commonParams: {};
40853
40891
  formData: {};
40854
40892
  jsonResponse: {
40855
40893
  /** 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.
@@ -40944,11 +40982,11 @@ export type Routes = {
40944
40982
  route: '/client_sessions/revoke';
40945
40983
  method: 'POST';
40946
40984
  queryParams: {};
40947
- jsonBody: {};
40948
- commonParams: {
40985
+ jsonBody: {
40949
40986
  /** ID of the client session that you want to revoke. */
40950
40987
  client_session_id: string;
40951
40988
  };
40989
+ commonParams: {};
40952
40990
  formData: {};
40953
40991
  jsonResponse: {};
40954
40992
  maxDuration: undefined;
@@ -41884,8 +41922,7 @@ export type Routes = {
41884
41922
  route: '/customers/create_portal';
41885
41923
  method: 'POST';
41886
41924
  queryParams: {};
41887
- jsonBody: {};
41888
- commonParams: {
41925
+ jsonBody: {
41889
41926
  features?: {
41890
41927
  /** Configuration for the connect accounts feature. */
41891
41928
  connect?: {
@@ -42331,6 +42368,7 @@ export type Routes = {
42331
42368
  }[] | undefined;
42332
42369
  } | undefined;
42333
42370
  };
42371
+ commonParams: {};
42334
42372
  formData: {};
42335
42373
  jsonResponse: {
42336
42374
  /** 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.
@@ -42423,8 +42461,7 @@ export type Routes = {
42423
42461
  route: '/customers/push_data';
42424
42462
  method: 'POST';
42425
42463
  queryParams: {};
42426
- jsonBody: {};
42427
- commonParams: {
42464
+ jsonBody: {
42428
42465
  /** Your unique identifier for the customer. */
42429
42466
  customer_key: string;
42430
42467
  /** List of general spaces or areas. */
@@ -42737,6 +42774,7 @@ export type Routes = {
42737
42774
  listing_keys?: string[] | undefined;
42738
42775
  }[] | undefined;
42739
42776
  };
42777
+ commonParams: {};
42740
42778
  formData: {};
42741
42779
  jsonResponse: {};
42742
42780
  maxDuration: undefined;
@@ -42745,13 +42783,13 @@ export type Routes = {
42745
42783
  route: '/customers/reservations/create_deep_link';
42746
42784
  method: 'POST';
42747
42785
  queryParams: {};
42748
- jsonBody: {};
42749
- commonParams: {
42786
+ jsonBody: {
42750
42787
  /** The customer_key identifying the customer who owns the reservation. */
42751
42788
  customer_key: string;
42752
42789
  /** The key of the reservation to create a deep link for. */
42753
42790
  reservation_key: string;
42754
42791
  };
42792
+ commonParams: {};
42755
42793
  formData: {};
42756
42794
  jsonResponse: {
42757
42795
  deep_link: {
@@ -45903,8 +45941,7 @@ export type Routes = {
45903
45941
  route: '/devices/report_provider_metadata';
45904
45942
  method: 'POST';
45905
45943
  queryParams: {};
45906
- jsonBody: {};
45907
- commonParams: {
45944
+ jsonBody: {
45908
45945
  /** Array of devices with provider metadata to update */
45909
45946
  devices: {
45910
45947
  /** ID of the device to update */
@@ -45926,6 +45963,7 @@ export type Routes = {
45926
45963
  } | undefined;
45927
45964
  }[];
45928
45965
  };
45966
+ commonParams: {};
45929
45967
  formData: {};
45930
45968
  jsonResponse: {};
45931
45969
  maxDuration: undefined;
@@ -47038,8 +47076,7 @@ export type Routes = {
47038
47076
  route: '/devices/unmanaged/update';
47039
47077
  method: 'POST' | 'PATCH';
47040
47078
  queryParams: {};
47041
- jsonBody: {};
47042
- commonParams: {
47079
+ jsonBody: {
47043
47080
  /** ID of the unmanaged device that you want to update. */
47044
47081
  device_id: string;
47045
47082
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
@@ -47049,6 +47086,7 @@ export type Routes = {
47049
47086
  [x: string]: string | boolean | null;
47050
47087
  } | undefined;
47051
47088
  };
47089
+ commonParams: {};
47052
47090
  formData: {};
47053
47091
  jsonResponse: {};
47054
47092
  maxDuration: undefined;
@@ -47057,8 +47095,7 @@ export type Routes = {
47057
47095
  route: '/devices/update';
47058
47096
  method: 'POST' | 'PATCH';
47059
47097
  queryParams: {};
47060
- jsonBody: {};
47061
- commonParams: {
47098
+ jsonBody: {
47062
47099
  /** ID of the device that you want to update. */
47063
47100
  device_id: string;
47064
47101
  properties?: {
@@ -47076,6 +47113,7 @@ export type Routes = {
47076
47113
  /** 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. */
47077
47114
  backup_access_code_pool_enabled?: boolean | undefined;
47078
47115
  };
47116
+ commonParams: {};
47079
47117
  formData: {};
47080
47118
  jsonResponse: {};
47081
47119
  maxDuration: undefined;
@@ -54798,6 +54836,8 @@ export type Routes = {
54798
54836
  issued_at: string | null;
54799
54837
  /** Indicates whether the access method has been issued. */
54800
54838
  is_issued: boolean;
54839
+ /** 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`. */
54840
+ display_status: string;
54801
54841
  /** URL of the Instant Key for mobile key access methods. */
54802
54842
  instant_key_url?: string | undefined;
54803
54843
  /** Token of the client session associated with the access method. */
@@ -62596,6 +62636,8 @@ export type Routes = {
62596
62636
  issued_at: string | null;
62597
62637
  /** Indicates whether the access method has been issued. */
62598
62638
  is_issued: boolean;
62639
+ /** 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`. */
62640
+ display_status: string;
62599
62641
  /** URL of the Instant Key for mobile key access methods. */
62600
62642
  instant_key_url?: string | undefined;
62601
62643
  /** Token of the client session associated with the access method. */
@@ -64392,6 +64434,8 @@ export type Routes = {
64392
64434
  issued_at: string | null;
64393
64435
  /** Indicates whether the access method has been issued. */
64394
64436
  is_issued: boolean;
64437
+ /** 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`. */
64438
+ display_status: string;
64395
64439
  /** URL of the Instant Key for mobile key access methods. */
64396
64440
  instant_key_url?: string | undefined;
64397
64441
  /** Token of the client session associated with the access method. */
@@ -66186,6 +66230,8 @@ export type Routes = {
66186
66230
  issued_at: string | null;
66187
66231
  /** Indicates whether the access method has been issued. */
66188
66232
  is_issued: boolean;
66233
+ /** 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`. */
66234
+ display_status: string;
66189
66235
  /** URL of the Instant Key for mobile key access methods. */
66190
66236
  instant_key_url?: string | undefined;
66191
66237
  /** Token of the client session associated with the access method. */
@@ -67982,6 +68028,8 @@ export type Routes = {
67982
68028
  issued_at: string | null;
67983
68029
  /** Indicates whether the access method has been issued. */
67984
68030
  is_issued: boolean;
68031
+ /** 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`. */
68032
+ display_status: string;
67985
68033
  /** URL of the Instant Key for mobile key access methods. */
67986
68034
  instant_key_url?: string | undefined;
67987
68035
  /** Token of the client session associated with the access method. */
@@ -72792,6 +72840,8 @@ export type Routes = {
72792
72840
  issued_at: string | null;
72793
72841
  /** Indicates whether the access method has been issued. */
72794
72842
  is_issued: boolean;
72843
+ /** 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`. */
72844
+ display_status: string;
72795
72845
  /** URL of the Instant Key for mobile key access methods. */
72796
72846
  instant_key_url?: string | undefined;
72797
72847
  /** Token of the client session associated with the access method. */
@@ -74607,6 +74657,8 @@ export type Routes = {
74607
74657
  issued_at: string | null;
74608
74658
  /** Indicates whether the access method has been issued. */
74609
74659
  is_issued: boolean;
74660
+ /** 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`. */
74661
+ display_status: string;
74610
74662
  /** URL of the Instant Key for mobile key access methods. */
74611
74663
  instant_key_url?: string | undefined;
74612
74664
  /** Token of the client session associated with the access method. */
@@ -76478,6 +76530,8 @@ export type Routes = {
76478
76530
  issued_at: string | null;
76479
76531
  /** Indicates whether the access method has been issued. */
76480
76532
  is_issued: boolean;
76533
+ /** 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`. */
76534
+ display_status: string;
76481
76535
  /** URL of the Instant Key for mobile key access methods. */
76482
76536
  instant_key_url?: string | undefined;
76483
76537
  /** Token of the client session associated with the access method. */
@@ -77989,11 +78043,11 @@ export type Routes = {
77989
78043
  route: '/seam/console/v1/lynx_migration/migrate_property';
77990
78044
  method: 'POST';
77991
78045
  queryParams: {};
77992
- jsonBody: {};
77993
- commonParams: {
78046
+ jsonBody: {
77994
78047
  /** ID of the space (property) to migrate. */
77995
78048
  space_id: string;
77996
78049
  };
78050
+ commonParams: {};
77997
78051
  formData: {};
77998
78052
  jsonResponse: {
77999
78053
  lynx_migration_property_run: {
@@ -78801,13 +78855,13 @@ export type Routes = {
78801
78855
  route: '/seam/console/v1/workspace/feature_flags/update';
78802
78856
  method: 'POST';
78803
78857
  queryParams: {};
78804
- jsonBody: {};
78805
- commonParams: {
78858
+ jsonBody: {
78806
78859
  /** Name of the workspace feature flag to update. */
78807
78860
  feature_flag_name: 'RESERVATION_LEGACY' | 'EXPERIMENTAL_DASHBOARD_API_ENABLED' | 'ICAL_CONNECTOR' | 'VISIONLINE_SERIALIZE_BRIDGE_REQUESTS' | 'SALTO_KS_ENTRANCES_ONLY_FOR_SPACES' | 'MANAGE_DEVICES_CONFIRMATION_MODAL' | 'RECLAIM_ORPHANED_BACKUP_ACCESS_CODES' | 'RECONCILE_ORPHANED_SMARTTHINGS_ACCESS_CODES' | 'LYNX_MIGRATION_ENABLED' | 'AURORA_CUSTOMER_FILTER_ENABLED' | 'AUTOMATION_IMMINENT_CHECK_IN_QUEUE' | 'ACCESS_METHOD_DEADLINE_ERRORS' | 'GUARD_MATERIALIZATION_ON_UNREACHABLE_DEVICE' | 'TARGETED_ACCESS_GRANT_ISSUANCE';
78808
78861
  /** Whether the feature flag should be enabled for the workspace. */
78809
78862
  enabled: boolean;
78810
78863
  };
78864
+ commonParams: {};
78811
78865
  formData: {};
78812
78866
  jsonResponse: {
78813
78867
  feature_flag: {
@@ -79011,13 +79065,13 @@ export type Routes = {
79011
79065
  route: '/seam/customer/v1/access_grants/update';
79012
79066
  method: 'POST' | 'PATCH';
79013
79067
  queryParams: {};
79014
- jsonBody: {};
79015
- commonParams: {
79068
+ jsonBody: {
79016
79069
  /** ID of the Access Grant to update. */
79017
79070
  access_grant_id: string;
79018
79071
  /** Array of location IDs to associate with the access grant. */
79019
79072
  space_ids: string[];
79020
79073
  };
79074
+ commonParams: {};
79021
79075
  formData: {};
79022
79076
  jsonResponse: {};
79023
79077
  maxDuration: undefined;
@@ -79026,13 +79080,13 @@ export type Routes = {
79026
79080
  route: '/seam/customer/v1/access_methods/encode';
79027
79081
  method: 'POST';
79028
79082
  queryParams: {};
79029
- jsonBody: {};
79030
- commonParams: {
79083
+ jsonBody: {
79031
79084
  /** ID of the encoder to use for encoding the access method. */
79032
79085
  acs_encoder_id: string;
79033
79086
  /** ID of the access method to encode onto a card. */
79034
79087
  access_method_id: string;
79035
79088
  };
79089
+ commonParams: {};
79036
79090
  formData: {};
79037
79091
  jsonResponse: {
79038
79092
  /** 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.
@@ -80130,6 +80184,8 @@ export type Routes = {
80130
80184
  issued_at: string | null;
80131
80185
  /** Indicates whether the access method has been issued. */
80132
80186
  is_issued: boolean;
80187
+ /** 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`. */
80188
+ display_status: string;
80133
80189
  /** URL of the Instant Key for mobile key access methods. */
80134
80190
  instant_key_url?: string | undefined;
80135
80191
  /** Token of the client session associated with the access method. */
@@ -81323,8 +81379,7 @@ export type Routes = {
81323
81379
  route: '/seam/customer/v1/connectors/sync';
81324
81380
  method: 'POST';
81325
81381
  queryParams: {};
81326
- jsonBody: {};
81327
- commonParams: {
81382
+ jsonBody: {
81328
81383
  /** ID of the connector to sync */
81329
81384
  connector_id: string;
81330
81385
  /** Type of the connector to sync */
@@ -81336,6 +81391,7 @@ export type Routes = {
81336
81391
  /** Unique provider resource key of the connector to sync */
81337
81392
  unique_provider_resource_key?: (string | null) | undefined;
81338
81393
  };
81394
+ commonParams: {};
81339
81395
  formData: {};
81340
81396
  jsonResponse: {
81341
81397
  connector_sync: {
@@ -81605,11 +81661,11 @@ export type Routes = {
81605
81661
  route: '/seam/customer/v1/customers/open_portal';
81606
81662
  method: 'POST';
81607
81663
  queryParams: {};
81608
- jsonBody: {};
81609
- commonParams: {
81664
+ jsonBody: {
81610
81665
  /** The customer key to open a portal for. */
81611
81666
  customer_key: string;
81612
81667
  };
81668
+ commonParams: {};
81613
81669
  formData: {};
81614
81670
  jsonResponse: {
81615
81671
  /** 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.
@@ -85829,8 +85885,7 @@ export type Routes = {
85829
85885
  route: '/seam/customer/v1/spaces/push_common_areas';
85830
85886
  method: 'POST';
85831
85887
  queryParams: {};
85832
- jsonBody: {};
85833
- commonParams: {
85888
+ jsonBody: {
85834
85889
  common_areas?: {
85835
85890
  name: string;
85836
85891
  }[] | undefined;
@@ -85841,6 +85896,7 @@ export type Routes = {
85841
85896
  }[];
85842
85897
  }[] | undefined;
85843
85898
  };
85899
+ commonParams: {};
85844
85900
  formData: {};
85845
85901
  jsonResponse: {};
85846
85902
  maxDuration: undefined;
@@ -89206,6 +89262,8 @@ export type Routes = {
89206
89262
  issued_at: string | null;
89207
89263
  /** Indicates whether the access method has been issued. */
89208
89264
  is_issued: boolean;
89265
+ /** 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`. */
89266
+ display_status: string;
89209
89267
  /** URL of the Instant Key for mobile key access methods. */
89210
89268
  instant_key_url?: string | undefined;
89211
89269
  /** Token of the client session associated with the access method. */
@@ -90637,6 +90695,8 @@ export type Routes = {
90637
90695
  issued_at: string | null;
90638
90696
  /** Indicates whether the access method has been issued. */
90639
90697
  is_issued: boolean;
90698
+ /** 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`. */
90699
+ display_status: string;
90640
90700
  /** URL of the Instant Key for mobile key access methods. */
90641
90701
  instant_key_url?: string | undefined;
90642
90702
  /** Token of the client session associated with the access method. */
@@ -92437,6 +92497,8 @@ export type Routes = {
92437
92497
  issued_at: string | null;
92438
92498
  /** Indicates whether the access method has been issued. */
92439
92499
  is_issued: boolean;
92500
+ /** 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`. */
92501
+ display_status: string;
92440
92502
  /** URL of the Instant Key for mobile key access methods. */
92441
92503
  instant_key_url?: string | undefined;
92442
92504
  /** Token of the client session associated with the access method. */
@@ -94343,6 +94405,8 @@ export type Routes = {
94343
94405
  issued_at: string | null;
94344
94406
  /** Indicates whether the access method has been issued. */
94345
94407
  is_issued: boolean;
94408
+ /** 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`. */
94409
+ display_status: string;
94346
94410
  /** URL of the Instant Key for mobile key access methods. */
94347
94411
  instant_key_url?: string | undefined;
94348
94412
  /** Token of the client session associated with the access method. */
@@ -97665,6 +97729,8 @@ export type Routes = {
97665
97729
  issued_at: string | null;
97666
97730
  /** Indicates whether the access method has been issued. */
97667
97731
  is_issued: boolean;
97732
+ /** 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`. */
97733
+ display_status: string;
97668
97734
  /** URL of the Instant Key for mobile key access methods. */
97669
97735
  instant_key_url?: string | undefined;
97670
97736
  /** Token of the client session associated with the access method. */
@@ -99469,6 +99535,8 @@ export type Routes = {
99469
99535
  issued_at: string | null;
99470
99536
  /** Indicates whether the access method has been issued. */
99471
99537
  is_issued: boolean;
99538
+ /** 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`. */
99539
+ display_status: string;
99472
99540
  /** URL of the Instant Key for mobile key access methods. */
99473
99541
  instant_key_url?: string | undefined;
99474
99542
  /** Token of the client session associated with the access method. */
@@ -104269,6 +104337,8 @@ export type Routes = {
104269
104337
  issued_at: string | null;
104270
104338
  /** Indicates whether the access method has been issued. */
104271
104339
  is_issued: boolean;
104340
+ /** 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`. */
104341
+ display_status: string;
104272
104342
  /** URL of the Instant Key for mobile key access methods. */
104273
104343
  instant_key_url?: string | undefined;
104274
104344
  /** Token of the client session associated with the access method. */
@@ -106274,6 +106344,8 @@ export type Routes = {
106274
106344
  issued_at: string | null;
106275
106345
  /** Indicates whether the access method has been issued. */
106276
106346
  is_issued: boolean;
106347
+ /** 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`. */
106348
+ display_status: string;
106277
106349
  /** URL of the Instant Key for mobile key access methods. */
106278
106350
  instant_key_url?: string | undefined;
106279
106351
  /** Token of the client session associated with the access method. */
@@ -108101,6 +108173,8 @@ export type Routes = {
108101
108173
  issued_at: string | null;
108102
108174
  /** Indicates whether the access method has been issued. */
108103
108175
  is_issued: boolean;
108176
+ /** 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`. */
108177
+ display_status: string;
108104
108178
  /** URL of the Instant Key for mobile key access methods. */
108105
108179
  instant_key_url?: string | undefined;
108106
108180
  /** Token of the client session associated with the access method. */
@@ -110040,6 +110114,8 @@ export type Routes = {
110040
110114
  issued_at: string | null;
110041
110115
  /** Indicates whether the access method has been issued. */
110042
110116
  is_issued: boolean;
110117
+ /** 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`. */
110118
+ display_status: string;
110043
110119
  /** URL of the Instant Key for mobile key access methods. */
110044
110120
  instant_key_url?: string | undefined;
110045
110121
  /** Token of the client session associated with the access method. */
@@ -110732,11 +110808,11 @@ export type Routes = {
110732
110808
  route: '/unstable_partner/building_blocks/connect_accounts';
110733
110809
  method: 'POST';
110734
110810
  queryParams: {};
110735
- jsonBody: {};
110736
- commonParams: {
110811
+ jsonBody: {
110737
110812
  /** Customer key for which you want to connect accounts. */
110738
110813
  customer_key: string;
110739
110814
  };
110815
+ commonParams: {};
110740
110816
  formData: {};
110741
110817
  jsonResponse: {
110742
110818
  /** 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.
@@ -110825,11 +110901,11 @@ export type Routes = {
110825
110901
  route: '/unstable_partner/building_blocks/manage_devices';
110826
110902
  method: 'POST';
110827
110903
  queryParams: {};
110828
- jsonBody: {};
110829
- commonParams: {
110904
+ jsonBody: {
110830
110905
  /** Customer key for which you want to manage devices. */
110831
110906
  customer_key: string;
110832
110907
  };
110908
+ commonParams: {};
110833
110909
  formData: {};
110834
110910
  jsonResponse: {
110835
110911
  /** 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.
@@ -110856,8 +110932,7 @@ export type Routes = {
110856
110932
  route: '/unstable_partner/building_blocks/organize_spaces';
110857
110933
  method: 'POST';
110858
110934
  queryParams: {};
110859
- jsonBody: {};
110860
- commonParams: {
110935
+ jsonBody: {
110861
110936
  /** Customer key for which you want to organize spaces. */
110862
110937
  customer_key: string;
110863
110938
  /** Optional list of spaces that you want to include in the new building block magic link. */
@@ -110890,6 +110965,7 @@ export type Routes = {
110890
110965
  } | undefined;
110891
110966
  }[] | undefined;
110892
110967
  };
110968
+ commonParams: {};
110893
110969
  formData: {};
110894
110970
  jsonResponse: {
110895
110971
  /** 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.
@@ -110916,8 +110992,7 @@ export type Routes = {
110916
110992
  route: '/user_identities/add_acs_user';
110917
110993
  method: 'POST' | 'PUT';
110918
110994
  queryParams: {};
110919
- jsonBody: {};
110920
- commonParams: {
110995
+ jsonBody: {
110921
110996
  /** ID of the user identity to which you want to add an access system user. */
110922
110997
  user_identity_id?: string | undefined;
110923
110998
  /** Key of the user identity to which you want to add an access system user. */
@@ -110925,6 +111000,7 @@ export type Routes = {
110925
111000
  /** ID of the access system user that you want to add to the user identity. */
110926
111001
  acs_user_id: string;
110927
111002
  };
111003
+ commonParams: {};
110928
111004
  formData: {};
110929
111005
  jsonResponse: {};
110930
111006
  maxDuration: undefined;
@@ -110933,8 +111009,7 @@ export type Routes = {
110933
111009
  route: '/user_identities/create';
110934
111010
  method: 'POST';
110935
111011
  queryParams: {};
110936
- jsonBody: {};
110937
- commonParams: {
111012
+ jsonBody: {
110938
111013
  /** Unique key for the new user identity. */
110939
111014
  user_identity_key?: (string | null) | undefined;
110940
111015
  /** Unique email address for the new user identity. */
@@ -110946,6 +111021,7 @@ export type Routes = {
110946
111021
  /** 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. */
110947
111022
  acs_system_ids?: string[] | undefined;
110948
111023
  };
111024
+ commonParams: {};
110949
111025
  formData: {};
110950
111026
  jsonResponse: {
110951
111027
  /** 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. */
@@ -111058,8 +111134,7 @@ export type Routes = {
111058
111134
  route: '/user_identities/enrollment_automations/launch';
111059
111135
  method: 'POST';
111060
111136
  queryParams: {};
111061
- jsonBody: {};
111062
- commonParams: {
111137
+ jsonBody: {
111063
111138
  /** ID of the user identity for which you want to launch an enrollment automation. */
111064
111139
  user_identity_id: string;
111065
111140
  /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
@@ -111071,6 +111146,7 @@ export type Routes = {
111071
111146
  /** 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`. */
111072
111147
  credential_manager_acs_user_id?: string | undefined;
111073
111148
  };
111149
+ commonParams: {};
111074
111150
  formData: {};
111075
111151
  jsonResponse: {
111076
111152
  /** 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/). */
@@ -111119,14 +111195,14 @@ export type Routes = {
111119
111195
  route: '/user_identities/generate_instant_key';
111120
111196
  method: 'POST';
111121
111197
  queryParams: {};
111122
- jsonBody: {};
111123
- commonParams: {
111198
+ jsonBody: {
111124
111199
  customization_profile_id?: string | undefined;
111125
111200
  /** ID of the user identity for which you want to generate an instant key. */
111126
111201
  user_identity_id: string;
111127
111202
  /** Maximum number of times the instant key can be used. Default: 1. */
111128
111203
  max_use_count?: number;
111129
111204
  };
111205
+ commonParams: {};
111130
111206
  formData: {};
111131
111207
  jsonResponse: {
111132
111208
  /** 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.
@@ -111232,13 +111308,13 @@ export type Routes = {
111232
111308
  route: '/user_identities/grant_access_to_device';
111233
111309
  method: 'PUT' | 'POST';
111234
111310
  queryParams: {};
111235
- jsonBody: {};
111236
- commonParams: {
111311
+ jsonBody: {
111237
111312
  /** ID of the user identity that you want to grant access to a device. */
111238
111313
  user_identity_id: string;
111239
111314
  /** ID of the managed device to which you want to grant access to the user identity. */
111240
111315
  device_id: string;
111241
111316
  };
111317
+ commonParams: {};
111242
111318
  formData: {};
111243
111319
  jsonResponse: {};
111244
111320
  maxDuration: undefined;
@@ -119015,6 +119091,8 @@ export type Routes = {
119015
119091
  issued_at: string | null;
119016
119092
  /** Indicates whether the access method has been issued. */
119017
119093
  is_issued: boolean;
119094
+ /** 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`. */
119095
+ display_status: string;
119018
119096
  /** URL of the Instant Key for mobile key access methods. */
119019
119097
  instant_key_url?: string | undefined;
119020
119098
  /** Token of the client session associated with the access method. */
@@ -120741,6 +120819,8 @@ export type Routes = {
120741
120819
  issued_at: string | null;
120742
120820
  /** Indicates whether the access method has been issued. */
120743
120821
  is_issued: boolean;
120822
+ /** 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`. */
120823
+ display_status: string;
120744
120824
  /** URL of the Instant Key for mobile key access methods. */
120745
120825
  instant_key_url?: string | undefined;
120746
120826
  /** Token of the client session associated with the access method. */
@@ -126836,6 +126916,8 @@ export type Routes = {
126836
126916
  issued_at: string | null;
126837
126917
  /** Indicates whether the access method has been issued. */
126838
126918
  is_issued: boolean;
126919
+ /** 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`. */
126920
+ display_status: string;
126839
126921
  /** URL of the Instant Key for mobile key access methods. */
126840
126922
  instant_key_url?: string | undefined;
126841
126923
  /** Token of the client session associated with the access method. */