@seamapi/types 1.1001.0 → 1.1003.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.
@@ -6941,8 +6941,7 @@ export type Routes = {
6941
6941
  route: '/access_codes/unmanaged/convert_to_managed';
6942
6942
  method: 'POST' | 'PATCH';
6943
6943
  queryParams: {};
6944
- jsonBody: {};
6945
- commonParams: {
6944
+ jsonBody: {
6946
6945
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
6947
6946
  access_code_id: string;
6948
6947
  /** 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 +6953,7 @@ export type Routes = {
6954
6953
  /** */
6955
6954
  sync?: boolean;
6956
6955
  };
6956
+ commonParams: {};
6957
6957
  formData: {};
6958
6958
  jsonResponse: {};
6959
6959
  maxDuration: undefined;
@@ -9524,8 +9524,7 @@ export type Routes = {
9524
9524
  route: '/access_codes/unmanaged/update';
9525
9525
  method: 'PATCH' | 'POST';
9526
9526
  queryParams: {};
9527
- jsonBody: {};
9528
- commonParams: {
9527
+ jsonBody: {
9529
9528
  /** ID of the unmanaged access code that you want to update. */
9530
9529
  access_code_id: string;
9531
9530
  is_managed: boolean;
@@ -9536,6 +9535,7 @@ export type Routes = {
9536
9535
  /** Indicates whether to force the unmanaged access code update. */
9537
9536
  force?: boolean | undefined;
9538
9537
  };
9538
+ commonParams: {};
9539
9539
  formData: {};
9540
9540
  jsonResponse: {};
9541
9541
  maxDuration: undefined;
@@ -11390,8 +11390,7 @@ export type Routes = {
11390
11390
  route: '/access_grants/create';
11391
11391
  method: 'POST';
11392
11392
  queryParams: {};
11393
- jsonBody: {};
11394
- commonParams: ({
11393
+ jsonBody: ({
11395
11394
  /** ID of user identity for whom access is being granted. */
11396
11395
  user_identity_id: string;
11397
11396
  } | {
@@ -11451,6 +11450,7 @@ export type Routes = {
11451
11450
  /** ID of the customization profile to apply to the Access Grant and its access methods. */
11452
11451
  customization_profile_id?: string | undefined;
11453
11452
  };
11453
+ commonParams: {};
11454
11454
  formData: {};
11455
11455
  jsonResponse: {
11456
11456
  /** 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. */
@@ -14511,8 +14511,7 @@ export type Routes = {
14511
14511
  route: '/access_grants/request_access_methods';
14512
14512
  method: 'POST';
14513
14513
  queryParams: {};
14514
- jsonBody: {};
14515
- commonParams: {
14514
+ jsonBody: {
14516
14515
  /** ID of the Access Grant to add access methods to. */
14517
14516
  access_grant_id: string;
14518
14517
  /** Array of requested access methods to add to the access grant. */
@@ -14525,6 +14524,7 @@ export type Routes = {
14525
14524
  instant_key_max_use_count?: number | undefined;
14526
14525
  }[];
14527
14526
  };
14527
+ commonParams: {};
14528
14528
  formData: {};
14529
14529
  jsonResponse: {
14530
14530
  /** 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 +15121,7 @@ export type Routes = {
15121
15121
  route: '/access_grants/update';
15122
15122
  method: 'POST' | 'PATCH';
15123
15123
  queryParams: {};
15124
- jsonBody: {};
15125
- commonParams: {
15124
+ jsonBody: {
15126
15125
  /** Display name for the access grant. */
15127
15126
  name?: (string | null) | undefined;
15128
15127
  /** ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`. */
@@ -15134,6 +15133,7 @@ export type Routes = {
15134
15133
  /** 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
15134
  ends_at?: (string | null) | undefined;
15136
15135
  };
15136
+ commonParams: {};
15137
15137
  formData: {};
15138
15138
  jsonResponse: {};
15139
15139
  maxDuration: undefined;
@@ -15142,13 +15142,13 @@ export type Routes = {
15142
15142
  route: '/access_methods/assign_card';
15143
15143
  method: 'POST';
15144
15144
  queryParams: {};
15145
- jsonBody: {};
15146
- commonParams: {
15145
+ jsonBody: {
15147
15146
  /** ID of the `access_method` to assign the credential to. */
15148
15147
  access_method_id: string;
15149
15148
  /** Card number of the credential to assign. */
15150
15149
  card_number: string;
15151
15150
  };
15151
+ commonParams: {};
15152
15152
  formData: {};
15153
15153
  jsonResponse: {
15154
15154
  /** 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.
@@ -16957,13 +16957,13 @@ export type Routes = {
16957
16957
  route: '/access_methods/encode';
16958
16958
  method: 'POST';
16959
16959
  queryParams: {};
16960
- jsonBody: {};
16961
- commonParams: {
16960
+ jsonBody: {
16962
16961
  /** ID of the `acs_encoder` to use to encode the `access_method`. */
16963
16962
  acs_encoder_id: string;
16964
16963
  /** ID of the `access_method` to encode onto a card. */
16965
16964
  access_method_id: string;
16966
16965
  };
16966
+ commonParams: {};
16967
16967
  formData: {};
16968
16968
  jsonResponse: {
16969
16969
  /** 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.
@@ -21335,13 +21335,13 @@ export type Routes = {
21335
21335
  route: '/access_methods/unlock_door';
21336
21336
  method: 'POST';
21337
21337
  queryParams: {};
21338
- jsonBody: {};
21339
- commonParams: {
21338
+ jsonBody: {
21340
21339
  /** ID of the cloud_key `access_method` to use for the unlock operation. */
21341
21340
  access_method_id: string;
21342
21341
  /** ID of the entrance to unlock. */
21343
21342
  acs_entrance_id: string;
21344
21343
  };
21344
+ commonParams: {};
21345
21345
  formData: {};
21346
21346
  jsonResponse: {
21347
21347
  /** 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.
@@ -23414,8 +23414,7 @@ export type Routes = {
23414
23414
  route: '/acs/access_groups/add_user';
23415
23415
  method: 'PUT' | 'POST';
23416
23416
  queryParams: {};
23417
- jsonBody: {};
23418
- commonParams: {
23417
+ jsonBody: {
23419
23418
  /** ID of the access group to which you want to add an access system user. */
23420
23419
  acs_access_group_id: string;
23421
23420
  /** 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 +23422,7 @@ export type Routes = {
23423
23422
  /** 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
23423
  user_identity_id?: string | undefined;
23425
23424
  };
23425
+ commonParams: {};
23426
23426
  formData: {};
23427
23427
  jsonResponse: {};
23428
23428
  maxDuration: undefined;
@@ -24716,8 +24716,7 @@ export type Routes = {
24716
24716
  route: '/acs/credential_provisioning_automations/launch';
24717
24717
  method: 'POST';
24718
24718
  queryParams: {};
24719
- jsonBody: {};
24720
- commonParams: {
24719
+ jsonBody: {
24721
24720
  /** ID of the user identity for which you want to launch a credential provisioning automation. */
24722
24721
  user_identity_id: string;
24723
24722
  /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
@@ -24729,6 +24728,7 @@ export type Routes = {
24729
24728
  /** 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
24729
  credential_manager_acs_user_id?: string | undefined;
24731
24730
  };
24731
+ commonParams: {};
24732
24732
  formData: {};
24733
24733
  jsonResponse: {
24734
24734
  /**
@@ -24923,8 +24923,7 @@ export type Routes = {
24923
24923
  route: '/acs/credentials/create';
24924
24924
  method: 'POST';
24925
24925
  queryParams: {};
24926
- jsonBody: {};
24927
- commonParams: {
24926
+ jsonBody: {
24928
24927
  /** ACS system ID of the credential manager for the new credential. */
24929
24928
  credential_manager_acs_system_id?: string | undefined;
24930
24929
  /** 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 +24978,7 @@ export type Routes = {
24979
24978
  /** 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
24979
  ends_at?: string | undefined;
24981
24980
  };
24981
+ commonParams: {};
24982
24982
  formData: {};
24983
24983
  jsonResponse: {
24984
24984
  /** 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 +25146,7 @@ export type Routes = {
25146
25146
  route: '/acs/credentials/create_offline_code';
25147
25147
  method: 'POST';
25148
25148
  queryParams: {};
25149
- jsonBody: {};
25150
- commonParams: {
25149
+ jsonBody: {
25151
25150
  /** ID of the access system user to whom the new credential belongs. */
25152
25151
  acs_user_id: string;
25153
25152
  /** 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 +25158,7 @@ export type Routes = {
25159
25158
  /** 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
25159
  ends_at?: string | undefined;
25161
25160
  };
25161
+ commonParams: {};
25162
25162
  formData: {};
25163
25163
  jsonResponse: {
25164
25164
  /** 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).
@@ -25512,21 +25512,13 @@ export type Routes = {
25512
25512
  method: 'GET' | 'POST';
25513
25513
  queryParams: {};
25514
25514
  jsonBody: {};
25515
- commonParams: ({
25516
- /** ID of the access system user for which you want to retrieve all credentials. */
25517
- acs_user_id: string;
25518
- } | {
25519
- /** ID of the access system for which you want to retrieve all credentials. */
25520
- acs_system_id: string;
25521
- } | {
25515
+ commonParams: {
25522
25516
  /** ID of the access system user for which you want to retrieve all credentials. */
25523
- acs_user_id: string;
25517
+ acs_user_id?: string | undefined;
25524
25518
  /** ID of the access system for which you want to retrieve all credentials. */
25525
- acs_system_id: string;
25526
- } | {
25519
+ acs_system_id?: string | undefined;
25527
25520
  /** ID of the user identity for which you want to retrieve all credentials. */
25528
- user_identity_id: string;
25529
- } | {}) & {
25521
+ user_identity_id?: string | undefined;
25530
25522
  /** Number of credentials to return. */
25531
25523
  limit?: number;
25532
25524
  /** Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. */
@@ -26268,21 +26260,13 @@ export type Routes = {
26268
26260
  method: 'GET' | 'POST';
26269
26261
  queryParams: {};
26270
26262
  jsonBody: {};
26271
- commonParams: ({
26272
- /** ID of the access system user for which you want to retrieve all credentials. */
26273
- acs_user_id: string;
26274
- } | {
26275
- /** ID of the access system for which you want to retrieve all credentials. */
26276
- acs_system_id: string;
26277
- } | {
26263
+ commonParams: {
26278
26264
  /** ID of the access system user for which you want to retrieve all credentials. */
26279
- acs_user_id: string;
26265
+ acs_user_id?: string | undefined;
26280
26266
  /** ID of the access system for which you want to retrieve all credentials. */
26281
- acs_system_id: string;
26282
- } | {
26267
+ acs_system_id?: string | undefined;
26283
26268
  /** ID of the user identity for which you want to retrieve all credentials. */
26284
- user_identity_id: string;
26285
- }) & {
26269
+ user_identity_id?: string | undefined;
26286
26270
  /** String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`. */
26287
26271
  search?: string | undefined;
26288
26272
  };
@@ -26621,8 +26605,7 @@ export type Routes = {
26621
26605
  route: '/acs/encoders/encode_credential';
26622
26606
  method: 'POST';
26623
26607
  queryParams: {};
26624
- jsonBody: {};
26625
- commonParams: {
26608
+ jsonBody: {
26626
26609
  /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
26627
26610
  acs_encoder_id: string;
26628
26611
  /** ID of the `acs_credential` to encode onto a card. */
@@ -26630,6 +26613,7 @@ export type Routes = {
26630
26613
  /** ID of the `access_method` to encode onto a card. */
26631
26614
  access_method_id?: string | undefined;
26632
26615
  };
26616
+ commonParams: {};
26633
26617
  formData: {};
26634
26618
  jsonResponse: {
26635
26619
  /** 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.
@@ -28471,16 +28455,13 @@ export type Routes = {
28471
28455
  method: 'GET' | 'POST';
28472
28456
  queryParams: {};
28473
28457
  jsonBody: {};
28474
- commonParams: ({
28458
+ commonParams: {
28475
28459
  /** ID of the access system for which you want to retrieve all encoders. */
28476
- acs_system_id: string;
28477
- } | {
28460
+ acs_system_id?: string | undefined;
28478
28461
  /** IDs of the access systems for which you want to retrieve all encoders. */
28479
- acs_system_ids: string[];
28480
- } | {
28462
+ acs_system_ids?: string[] | undefined;
28481
28463
  /** IDs of the encoders that you want to retrieve. */
28482
- acs_encoder_ids: string[];
28483
- }) & {
28464
+ acs_encoder_ids?: string[] | undefined;
28484
28465
  /** Number of encoders to return. */
28485
28466
  limit?: number;
28486
28467
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
@@ -28527,8 +28508,7 @@ export type Routes = {
28527
28508
  route: '/acs/encoders/scan_credential';
28528
28509
  method: 'POST';
28529
28510
  queryParams: {};
28530
- jsonBody: {};
28531
- commonParams: {
28511
+ jsonBody: {
28532
28512
  /** ID of the encoder to use for the scan. */
28533
28513
  acs_encoder_id: string;
28534
28514
  /** Salto KS-specific metadata for the scan action. */
@@ -28537,6 +28517,7 @@ export type Routes = {
28537
28517
  detect_new_tags?: boolean;
28538
28518
  } | undefined;
28539
28519
  };
28520
+ commonParams: {};
28540
28521
  formData: {};
28541
28522
  jsonResponse: {
28542
28523
  /** 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.
@@ -30326,8 +30307,7 @@ export type Routes = {
30326
30307
  route: '/acs/encoders/scan_to_assign_credential';
30327
30308
  method: 'POST';
30328
30309
  queryParams: {};
30329
- jsonBody: {};
30330
- commonParams: {
30310
+ jsonBody: {
30331
30311
  /** ID of the `acs_encoder` to use to scan the credential. */
30332
30312
  acs_encoder_id: string;
30333
30313
  /** ID of the `acs_user` to assign the scanned credential to. */
@@ -30340,6 +30320,7 @@ export type Routes = {
30340
30320
  detect_new_tags?: boolean;
30341
30321
  } | undefined;
30342
30322
  };
30323
+ commonParams: {};
30343
30324
  formData: {};
30344
30325
  jsonResponse: {
30345
30326
  /** 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.
@@ -32867,13 +32848,13 @@ export type Routes = {
32867
32848
  route: '/acs/entrances/unlock';
32868
32849
  method: 'POST';
32869
32850
  queryParams: {};
32870
- jsonBody: {};
32871
- commonParams: {
32851
+ jsonBody: {
32872
32852
  /** ID of the entrance to unlock. */
32873
32853
  acs_entrance_id: string;
32874
32854
  /** ID of the cloud_key credential to use for the unlock operation. */
32875
32855
  acs_credential_id: string;
32876
32856
  };
32857
+ commonParams: {};
32877
32858
  formData: {};
32878
32859
  jsonResponse: {
32879
32860
  /** 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.
@@ -35167,8 +35148,7 @@ export type Routes = {
35167
35148
  route: '/acs/systems/report_devices';
35168
35149
  method: 'POST';
35169
35150
  queryParams: {};
35170
- jsonBody: {};
35171
- commonParams: {
35151
+ jsonBody: {
35172
35152
  /** ID of the ACS system to report resources for */
35173
35153
  acs_system_id: string;
35174
35154
  /** Array of ACS encoders to report */
@@ -35195,6 +35175,7 @@ export type Routes = {
35195
35175
  };
35196
35176
  }[] | undefined;
35197
35177
  };
35178
+ commonParams: {};
35198
35179
  formData: {};
35199
35180
  jsonResponse: {};
35200
35181
  maxDuration: undefined;
@@ -35203,13 +35184,13 @@ export type Routes = {
35203
35184
  route: '/acs/users/add_to_access_group';
35204
35185
  method: 'PUT' | 'POST';
35205
35186
  queryParams: {};
35206
- jsonBody: {};
35207
- commonParams: {
35187
+ jsonBody: {
35208
35188
  /** ID of the access system user that you want to add to an access group. */
35209
35189
  acs_user_id: string;
35210
35190
  /** ID of the access group to which you want to add an access system user. */
35211
35191
  acs_access_group_id: string;
35212
35192
  };
35193
+ commonParams: {};
35213
35194
  formData: {};
35214
35195
  jsonResponse: {};
35215
35196
  maxDuration: undefined;
@@ -36386,8 +36367,7 @@ export type Routes = {
36386
36367
  route: '/acs/users/suspend';
36387
36368
  method: 'POST';
36388
36369
  queryParams: {};
36389
- jsonBody: {};
36390
- commonParams: {
36370
+ jsonBody: {
36391
36371
  /** 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. */
36392
36372
  acs_user_id?: string | undefined;
36393
36373
  /** 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. */
@@ -36395,6 +36375,7 @@ export type Routes = {
36395
36375
  /** 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. */
36396
36376
  acs_system_id?: string | undefined;
36397
36377
  };
36378
+ commonParams: {};
36398
36379
  formData: {};
36399
36380
  jsonResponse: {};
36400
36381
  maxDuration: undefined;
@@ -36970,8 +36951,7 @@ export type Routes = {
36970
36951
  route: '/acs/users/unsuspend';
36971
36952
  method: 'POST';
36972
36953
  queryParams: {};
36973
- jsonBody: {};
36974
- commonParams: {
36954
+ jsonBody: {
36975
36955
  /** 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. */
36976
36956
  acs_user_id?: string | undefined;
36977
36957
  /** 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. */
@@ -36979,6 +36959,7 @@ export type Routes = {
36979
36959
  /** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
36980
36960
  acs_system_id?: string | undefined;
36981
36961
  };
36962
+ commonParams: {};
36982
36963
  formData: {};
36983
36964
  jsonResponse: {};
36984
36965
  maxDuration: undefined;
@@ -40853,8 +40834,7 @@ export type Routes = {
40853
40834
  route: '/client_sessions/grant_access';
40854
40835
  method: 'PATCH' | 'POST';
40855
40836
  queryParams: {};
40856
- jsonBody: {};
40857
- commonParams: {
40837
+ jsonBody: {
40858
40838
  /** ID of the client session to which you want to grant access to resources. */
40859
40839
  client_session_id?: string | undefined;
40860
40840
  /** Your user ID for the user that you want to associate with the client session. */
@@ -40869,6 +40849,7 @@ export type Routes = {
40869
40849
  /** 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. */
40870
40850
  user_identity_id?: string | undefined;
40871
40851
  };
40852
+ commonParams: {};
40872
40853
  formData: {};
40873
40854
  jsonResponse: {
40874
40855
  /** 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.
@@ -40963,11 +40944,11 @@ export type Routes = {
40963
40944
  route: '/client_sessions/revoke';
40964
40945
  method: 'POST';
40965
40946
  queryParams: {};
40966
- jsonBody: {};
40967
- commonParams: {
40947
+ jsonBody: {
40968
40948
  /** ID of the client session that you want to revoke. */
40969
40949
  client_session_id: string;
40970
40950
  };
40951
+ commonParams: {};
40971
40952
  formData: {};
40972
40953
  jsonResponse: {};
40973
40954
  maxDuration: undefined;
@@ -41903,8 +41884,7 @@ export type Routes = {
41903
41884
  route: '/customers/create_portal';
41904
41885
  method: 'POST';
41905
41886
  queryParams: {};
41906
- jsonBody: {};
41907
- commonParams: {
41887
+ jsonBody: {
41908
41888
  features?: {
41909
41889
  /** Configuration for the connect accounts feature. */
41910
41890
  connect?: {
@@ -42350,6 +42330,7 @@ export type Routes = {
42350
42330
  }[] | undefined;
42351
42331
  } | undefined;
42352
42332
  };
42333
+ commonParams: {};
42353
42334
  formData: {};
42354
42335
  jsonResponse: {
42355
42336
  /** 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.
@@ -42442,8 +42423,7 @@ export type Routes = {
42442
42423
  route: '/customers/push_data';
42443
42424
  method: 'POST';
42444
42425
  queryParams: {};
42445
- jsonBody: {};
42446
- commonParams: {
42426
+ jsonBody: {
42447
42427
  /** Your unique identifier for the customer. */
42448
42428
  customer_key: string;
42449
42429
  /** List of general spaces or areas. */
@@ -42756,6 +42736,7 @@ export type Routes = {
42756
42736
  listing_keys?: string[] | undefined;
42757
42737
  }[] | undefined;
42758
42738
  };
42739
+ commonParams: {};
42759
42740
  formData: {};
42760
42741
  jsonResponse: {};
42761
42742
  maxDuration: undefined;
@@ -42764,13 +42745,13 @@ export type Routes = {
42764
42745
  route: '/customers/reservations/create_deep_link';
42765
42746
  method: 'POST';
42766
42747
  queryParams: {};
42767
- jsonBody: {};
42768
- commonParams: {
42748
+ jsonBody: {
42769
42749
  /** The customer_key identifying the customer who owns the reservation. */
42770
42750
  customer_key: string;
42771
42751
  /** The key of the reservation to create a deep link for. */
42772
42752
  reservation_key: string;
42773
42753
  };
42754
+ commonParams: {};
42774
42755
  formData: {};
42775
42756
  jsonResponse: {
42776
42757
  deep_link: {
@@ -45922,8 +45903,7 @@ export type Routes = {
45922
45903
  route: '/devices/report_provider_metadata';
45923
45904
  method: 'POST';
45924
45905
  queryParams: {};
45925
- jsonBody: {};
45926
- commonParams: {
45906
+ jsonBody: {
45927
45907
  /** Array of devices with provider metadata to update */
45928
45908
  devices: {
45929
45909
  /** ID of the device to update */
@@ -45945,6 +45925,7 @@ export type Routes = {
45945
45925
  } | undefined;
45946
45926
  }[];
45947
45927
  };
45928
+ commonParams: {};
45948
45929
  formData: {};
45949
45930
  jsonResponse: {};
45950
45931
  maxDuration: undefined;
@@ -47057,8 +47038,7 @@ export type Routes = {
47057
47038
  route: '/devices/unmanaged/update';
47058
47039
  method: 'POST' | 'PATCH';
47059
47040
  queryParams: {};
47060
- jsonBody: {};
47061
- commonParams: {
47041
+ jsonBody: {
47062
47042
  /** ID of the unmanaged device that you want to update. */
47063
47043
  device_id: string;
47064
47044
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
@@ -47068,6 +47048,7 @@ export type Routes = {
47068
47048
  [x: string]: string | boolean | null;
47069
47049
  } | undefined;
47070
47050
  };
47051
+ commonParams: {};
47071
47052
  formData: {};
47072
47053
  jsonResponse: {};
47073
47054
  maxDuration: undefined;
@@ -47076,8 +47057,7 @@ export type Routes = {
47076
47057
  route: '/devices/update';
47077
47058
  method: 'POST' | 'PATCH';
47078
47059
  queryParams: {};
47079
- jsonBody: {};
47080
- commonParams: {
47060
+ jsonBody: {
47081
47061
  /** ID of the device that you want to update. */
47082
47062
  device_id: string;
47083
47063
  properties?: {
@@ -47095,6 +47075,7 @@ export type Routes = {
47095
47075
  /** 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. */
47096
47076
  backup_access_code_pool_enabled?: boolean | undefined;
47097
47077
  };
47078
+ commonParams: {};
47098
47079
  formData: {};
47099
47080
  jsonResponse: {};
47100
47081
  maxDuration: undefined;
@@ -50343,7 +50324,7 @@ export type Routes = {
50343
50324
  /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
50344
50325
  since?: string | undefined;
50345
50326
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
50346
- between?: (string | Date)[] | undefined;
50327
+ between?: string[] | undefined;
50347
50328
  /** ID of the device for which you want to list events. */
50348
50329
  device_id?: string | undefined;
50349
50330
  /** IDs of the devices for which you want to list events. */
@@ -78008,11 +77989,11 @@ export type Routes = {
78008
77989
  route: '/seam/console/v1/lynx_migration/migrate_property';
78009
77990
  method: 'POST';
78010
77991
  queryParams: {};
78011
- jsonBody: {};
78012
- commonParams: {
77992
+ jsonBody: {
78013
77993
  /** ID of the space (property) to migrate. */
78014
77994
  space_id: string;
78015
77995
  };
77996
+ commonParams: {};
78016
77997
  formData: {};
78017
77998
  jsonResponse: {
78018
77999
  lynx_migration_property_run: {
@@ -78820,13 +78801,13 @@ export type Routes = {
78820
78801
  route: '/seam/console/v1/workspace/feature_flags/update';
78821
78802
  method: 'POST';
78822
78803
  queryParams: {};
78823
- jsonBody: {};
78824
- commonParams: {
78804
+ jsonBody: {
78825
78805
  /** Name of the workspace feature flag to update. */
78826
78806
  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';
78827
78807
  /** Whether the feature flag should be enabled for the workspace. */
78828
78808
  enabled: boolean;
78829
78809
  };
78810
+ commonParams: {};
78830
78811
  formData: {};
78831
78812
  jsonResponse: {
78832
78813
  feature_flag: {
@@ -79030,13 +79011,13 @@ export type Routes = {
79030
79011
  route: '/seam/customer/v1/access_grants/update';
79031
79012
  method: 'POST' | 'PATCH';
79032
79013
  queryParams: {};
79033
- jsonBody: {};
79034
- commonParams: {
79014
+ jsonBody: {
79035
79015
  /** ID of the Access Grant to update. */
79036
79016
  access_grant_id: string;
79037
79017
  /** Array of location IDs to associate with the access grant. */
79038
79018
  space_ids: string[];
79039
79019
  };
79020
+ commonParams: {};
79040
79021
  formData: {};
79041
79022
  jsonResponse: {};
79042
79023
  maxDuration: undefined;
@@ -79045,13 +79026,13 @@ export type Routes = {
79045
79026
  route: '/seam/customer/v1/access_methods/encode';
79046
79027
  method: 'POST';
79047
79028
  queryParams: {};
79048
- jsonBody: {};
79049
- commonParams: {
79029
+ jsonBody: {
79050
79030
  /** ID of the encoder to use for encoding the access method. */
79051
79031
  acs_encoder_id: string;
79052
79032
  /** ID of the access method to encode onto a card. */
79053
79033
  access_method_id: string;
79054
79034
  };
79035
+ commonParams: {};
79055
79036
  formData: {};
79056
79037
  jsonResponse: {
79057
79038
  /** 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.
@@ -81342,8 +81323,7 @@ export type Routes = {
81342
81323
  route: '/seam/customer/v1/connectors/sync';
81343
81324
  method: 'POST';
81344
81325
  queryParams: {};
81345
- jsonBody: {};
81346
- commonParams: {
81326
+ jsonBody: {
81347
81327
  /** ID of the connector to sync */
81348
81328
  connector_id: string;
81349
81329
  /** Type of the connector to sync */
@@ -81355,6 +81335,7 @@ export type Routes = {
81355
81335
  /** Unique provider resource key of the connector to sync */
81356
81336
  unique_provider_resource_key?: (string | null) | undefined;
81357
81337
  };
81338
+ commonParams: {};
81358
81339
  formData: {};
81359
81340
  jsonResponse: {
81360
81341
  connector_sync: {
@@ -81624,11 +81605,11 @@ export type Routes = {
81624
81605
  route: '/seam/customer/v1/customers/open_portal';
81625
81606
  method: 'POST';
81626
81607
  queryParams: {};
81627
- jsonBody: {};
81628
- commonParams: {
81608
+ jsonBody: {
81629
81609
  /** The customer key to open a portal for. */
81630
81610
  customer_key: string;
81631
81611
  };
81612
+ commonParams: {};
81632
81613
  formData: {};
81633
81614
  jsonResponse: {
81634
81615
  /** 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.
@@ -81681,7 +81662,7 @@ export type Routes = {
81681
81662
  /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
81682
81663
  since?: string | undefined;
81683
81664
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
81684
- between?: (string | Date)[] | undefined;
81665
+ between?: string[] | undefined;
81685
81666
  /** Type of the events that you want to list. */
81686
81667
  event_type?: ('access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted') | undefined;
81687
81668
  /** Types of the events that you want to list. */
@@ -85287,7 +85268,7 @@ export type Routes = {
85287
85268
  /** Timestamp by which to limit returned reservations. Returns reservations created after this timestamp. */
85288
85269
  created_after?: Date | undefined;
85289
85270
  /** Lower and upper timestamps to filter reservations whose time range overlaps with the given interval. */
85290
- between?: (string | Date)[] | undefined;
85271
+ between?: string[] | undefined;
85291
85272
  /** String for which to search. Filters returned reservations to include all records that satisfy a partial match using `reservation_id`, `reservation_key`, `name`, `guest_name`, or space names. */
85292
85273
  search?: string | undefined;
85293
85274
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
@@ -85848,8 +85829,7 @@ export type Routes = {
85848
85829
  route: '/seam/customer/v1/spaces/push_common_areas';
85849
85830
  method: 'POST';
85850
85831
  queryParams: {};
85851
- jsonBody: {};
85852
- commonParams: {
85832
+ jsonBody: {
85853
85833
  common_areas?: {
85854
85834
  name: string;
85855
85835
  }[] | undefined;
@@ -85860,6 +85840,7 @@ export type Routes = {
85860
85840
  }[];
85861
85841
  }[] | undefined;
85862
85842
  };
85843
+ commonParams: {};
85863
85844
  formData: {};
85864
85845
  jsonResponse: {};
85865
85846
  maxDuration: undefined;
@@ -110751,11 +110732,11 @@ export type Routes = {
110751
110732
  route: '/unstable_partner/building_blocks/connect_accounts';
110752
110733
  method: 'POST';
110753
110734
  queryParams: {};
110754
- jsonBody: {};
110755
- commonParams: {
110735
+ jsonBody: {
110756
110736
  /** Customer key for which you want to connect accounts. */
110757
110737
  customer_key: string;
110758
110738
  };
110739
+ commonParams: {};
110759
110740
  formData: {};
110760
110741
  jsonResponse: {
110761
110742
  /** 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.
@@ -110844,11 +110825,11 @@ export type Routes = {
110844
110825
  route: '/unstable_partner/building_blocks/manage_devices';
110845
110826
  method: 'POST';
110846
110827
  queryParams: {};
110847
- jsonBody: {};
110848
- commonParams: {
110828
+ jsonBody: {
110849
110829
  /** Customer key for which you want to manage devices. */
110850
110830
  customer_key: string;
110851
110831
  };
110832
+ commonParams: {};
110852
110833
  formData: {};
110853
110834
  jsonResponse: {
110854
110835
  /** 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.
@@ -110875,8 +110856,7 @@ export type Routes = {
110875
110856
  route: '/unstable_partner/building_blocks/organize_spaces';
110876
110857
  method: 'POST';
110877
110858
  queryParams: {};
110878
- jsonBody: {};
110879
- commonParams: {
110859
+ jsonBody: {
110880
110860
  /** Customer key for which you want to organize spaces. */
110881
110861
  customer_key: string;
110882
110862
  /** Optional list of spaces that you want to include in the new building block magic link. */
@@ -110909,6 +110889,7 @@ export type Routes = {
110909
110889
  } | undefined;
110910
110890
  }[] | undefined;
110911
110891
  };
110892
+ commonParams: {};
110912
110893
  formData: {};
110913
110894
  jsonResponse: {
110914
110895
  /** 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.
@@ -110935,8 +110916,7 @@ export type Routes = {
110935
110916
  route: '/user_identities/add_acs_user';
110936
110917
  method: 'POST' | 'PUT';
110937
110918
  queryParams: {};
110938
- jsonBody: {};
110939
- commonParams: {
110919
+ jsonBody: {
110940
110920
  /** ID of the user identity to which you want to add an access system user. */
110941
110921
  user_identity_id?: string | undefined;
110942
110922
  /** Key of the user identity to which you want to add an access system user. */
@@ -110944,6 +110924,7 @@ export type Routes = {
110944
110924
  /** ID of the access system user that you want to add to the user identity. */
110945
110925
  acs_user_id: string;
110946
110926
  };
110927
+ commonParams: {};
110947
110928
  formData: {};
110948
110929
  jsonResponse: {};
110949
110930
  maxDuration: undefined;
@@ -110952,8 +110933,7 @@ export type Routes = {
110952
110933
  route: '/user_identities/create';
110953
110934
  method: 'POST';
110954
110935
  queryParams: {};
110955
- jsonBody: {};
110956
- commonParams: {
110936
+ jsonBody: {
110957
110937
  /** Unique key for the new user identity. */
110958
110938
  user_identity_key?: (string | null) | undefined;
110959
110939
  /** Unique email address for the new user identity. */
@@ -110965,6 +110945,7 @@ export type Routes = {
110965
110945
  /** 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. */
110966
110946
  acs_system_ids?: string[] | undefined;
110967
110947
  };
110948
+ commonParams: {};
110968
110949
  formData: {};
110969
110950
  jsonResponse: {
110970
110951
  /** 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. */
@@ -111077,8 +111058,7 @@ export type Routes = {
111077
111058
  route: '/user_identities/enrollment_automations/launch';
111078
111059
  method: 'POST';
111079
111060
  queryParams: {};
111080
- jsonBody: {};
111081
- commonParams: {
111061
+ jsonBody: {
111082
111062
  /** ID of the user identity for which you want to launch an enrollment automation. */
111083
111063
  user_identity_id: string;
111084
111064
  /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
@@ -111090,6 +111070,7 @@ export type Routes = {
111090
111070
  /** 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`. */
111091
111071
  credential_manager_acs_user_id?: string | undefined;
111092
111072
  };
111073
+ commonParams: {};
111093
111074
  formData: {};
111094
111075
  jsonResponse: {
111095
111076
  /** 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/). */
@@ -111138,14 +111119,14 @@ export type Routes = {
111138
111119
  route: '/user_identities/generate_instant_key';
111139
111120
  method: 'POST';
111140
111121
  queryParams: {};
111141
- jsonBody: {};
111142
- commonParams: {
111122
+ jsonBody: {
111143
111123
  customization_profile_id?: string | undefined;
111144
111124
  /** ID of the user identity for which you want to generate an instant key. */
111145
111125
  user_identity_id: string;
111146
111126
  /** Maximum number of times the instant key can be used. Default: 1. */
111147
111127
  max_use_count?: number;
111148
111128
  };
111129
+ commonParams: {};
111149
111130
  formData: {};
111150
111131
  jsonResponse: {
111151
111132
  /** 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.
@@ -111251,13 +111232,13 @@ export type Routes = {
111251
111232
  route: '/user_identities/grant_access_to_device';
111252
111233
  method: 'PUT' | 'POST';
111253
111234
  queryParams: {};
111254
- jsonBody: {};
111255
- commonParams: {
111235
+ jsonBody: {
111256
111236
  /** ID of the user identity that you want to grant access to a device. */
111257
111237
  user_identity_id: string;
111258
111238
  /** ID of the managed device to which you want to grant access to the user identity. */
111259
111239
  device_id: string;
111260
111240
  };
111241
+ commonParams: {};
111261
111242
  formData: {};
111262
111243
  jsonResponse: {};
111263
111244
  maxDuration: undefined;