@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.
@@ -7924,8 +7924,7 @@ export type Routes = {
7924
7924
  route: '/access_codes/unmanaged/convert_to_managed'
7925
7925
  method: 'POST' | 'PATCH'
7926
7926
  queryParams: {}
7927
- jsonBody: {}
7928
- commonParams: {
7927
+ jsonBody: {
7929
7928
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
7930
7929
  access_code_id: string
7931
7930
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. */
@@ -7937,6 +7936,7 @@ export type Routes = {
7937
7936
  /** */
7938
7937
  sync?: boolean
7939
7938
  }
7939
+ commonParams: {}
7940
7940
  formData: {}
7941
7941
  jsonResponse: {}
7942
7942
  maxDuration: undefined
@@ -10891,8 +10891,7 @@ export type Routes = {
10891
10891
  route: '/access_codes/unmanaged/update'
10892
10892
  method: 'PATCH' | 'POST'
10893
10893
  queryParams: {}
10894
- jsonBody: {}
10895
- commonParams: {
10894
+ jsonBody: {
10896
10895
  /** ID of the unmanaged access code that you want to update. */
10897
10896
  access_code_id: string
10898
10897
  is_managed: boolean
@@ -10903,6 +10902,7 @@ export type Routes = {
10903
10902
  /** Indicates whether to force the unmanaged access code update. */
10904
10903
  force?: boolean | undefined
10905
10904
  }
10905
+ commonParams: {}
10906
10906
  formData: {}
10907
10907
  jsonResponse: {}
10908
10908
  maxDuration: undefined
@@ -13061,8 +13061,7 @@ export type Routes = {
13061
13061
  route: '/access_grants/create'
13062
13062
  method: 'POST'
13063
13063
  queryParams: {}
13064
- jsonBody: {}
13065
- commonParams: (
13064
+ jsonBody: (
13066
13065
  | {
13067
13066
  /** ID of user identity for whom access is being granted. */
13068
13067
  user_identity_id: string
@@ -13127,6 +13126,7 @@ export type Routes = {
13127
13126
  /** ID of the customization profile to apply to the Access Grant and its access methods. */
13128
13127
  customization_profile_id?: string | undefined
13129
13128
  }
13129
+ commonParams: {}
13130
13130
  formData: {}
13131
13131
  jsonResponse: {
13132
13132
  /** 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. */
@@ -16903,8 +16903,7 @@ export type Routes = {
16903
16903
  route: '/access_grants/request_access_methods'
16904
16904
  method: 'POST'
16905
16905
  queryParams: {}
16906
- jsonBody: {}
16907
- commonParams: {
16906
+ jsonBody: {
16908
16907
  /** ID of the Access Grant to add access methods to. */
16909
16908
  access_grant_id: string
16910
16909
  /** Array of requested access methods to add to the access grant. */
@@ -16917,6 +16916,7 @@ export type Routes = {
16917
16916
  instant_key_max_use_count?: number | undefined
16918
16917
  }[]
16919
16918
  }
16919
+ commonParams: {}
16920
16920
  formData: {}
16921
16921
  jsonResponse: {
16922
16922
  /** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
@@ -17561,8 +17561,7 @@ export type Routes = {
17561
17561
  route: '/access_grants/update'
17562
17562
  method: 'POST' | 'PATCH'
17563
17563
  queryParams: {}
17564
- jsonBody: {}
17565
- commonParams: {
17564
+ jsonBody: {
17566
17565
  /** Display name for the access grant. */
17567
17566
  name?: (string | null) | undefined
17568
17567
  /** ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`. */
@@ -17574,6 +17573,7 @@ export type Routes = {
17574
17573
  /** Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
17575
17574
  ends_at?: (string | null) | undefined
17576
17575
  }
17576
+ commonParams: {}
17577
17577
  formData: {}
17578
17578
  jsonResponse: {}
17579
17579
  maxDuration: undefined
@@ -17582,13 +17582,13 @@ export type Routes = {
17582
17582
  route: '/access_methods/assign_card'
17583
17583
  method: 'POST'
17584
17584
  queryParams: {}
17585
- jsonBody: {}
17586
- commonParams: {
17585
+ jsonBody: {
17587
17586
  /** ID of the `access_method` to assign the credential to. */
17588
17587
  access_method_id: string
17589
17588
  /** Card number of the credential to assign. */
17590
17589
  card_number: string
17591
17590
  }
17591
+ commonParams: {}
17592
17592
  formData: {}
17593
17593
  jsonResponse: {
17594
17594
  /** 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.
@@ -19704,13 +19704,13 @@ export type Routes = {
19704
19704
  route: '/access_methods/encode'
19705
19705
  method: 'POST'
19706
19706
  queryParams: {}
19707
- jsonBody: {}
19708
- commonParams: {
19707
+ jsonBody: {
19709
19708
  /** ID of the `acs_encoder` to use to encode the `access_method`. */
19710
19709
  acs_encoder_id: string
19711
19710
  /** ID of the `access_method` to encode onto a card. */
19712
19711
  access_method_id: string
19713
19712
  }
19713
+ commonParams: {}
19714
19714
  formData: {}
19715
19715
  jsonResponse: {
19716
19716
  /** 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.
@@ -24993,13 +24993,13 @@ export type Routes = {
24993
24993
  route: '/access_methods/unlock_door'
24994
24994
  method: 'POST'
24995
24995
  queryParams: {}
24996
- jsonBody: {}
24997
- commonParams: {
24996
+ jsonBody: {
24998
24997
  /** ID of the cloud_key `access_method` to use for the unlock operation. */
24999
24998
  access_method_id: string
25000
24999
  /** ID of the entrance to unlock. */
25001
25000
  acs_entrance_id: string
25002
25001
  }
25002
+ commonParams: {}
25003
25003
  formData: {}
25004
25004
  jsonResponse: {
25005
25005
  /** 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.
@@ -27394,8 +27394,7 @@ export type Routes = {
27394
27394
  route: '/acs/access_groups/add_user'
27395
27395
  method: 'PUT' | 'POST'
27396
27396
  queryParams: {}
27397
- jsonBody: {}
27398
- commonParams: {
27397
+ jsonBody: {
27399
27398
  /** ID of the access group to which you want to add an access system user. */
27400
27399
  acs_access_group_id: string
27401
27400
  /** ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. */
@@ -27403,6 +27402,7 @@ export type Routes = {
27403
27402
  /** ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
27404
27403
  user_identity_id?: string | undefined
27405
27404
  }
27405
+ commonParams: {}
27406
27406
  formData: {}
27407
27407
  jsonResponse: {}
27408
27408
  maxDuration: undefined
@@ -28932,8 +28932,7 @@ export type Routes = {
28932
28932
  route: '/acs/credential_provisioning_automations/launch'
28933
28933
  method: 'POST'
28934
28934
  queryParams: {}
28935
- jsonBody: {}
28936
- commonParams: {
28935
+ jsonBody: {
28937
28936
  /** ID of the user identity for which you want to launch a credential provisioning automation. */
28938
28937
  user_identity_id: string
28939
28938
  /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
@@ -28945,6 +28944,7 @@ export type Routes = {
28945
28944
  /** ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
28946
28945
  credential_manager_acs_user_id?: string | undefined
28947
28946
  }
28947
+ commonParams: {}
28948
28948
  formData: {}
28949
28949
  jsonResponse: {
28950
28950
  /**
@@ -29173,8 +29173,7 @@ export type Routes = {
29173
29173
  route: '/acs/credentials/create'
29174
29174
  method: 'POST'
29175
29175
  queryParams: {}
29176
- jsonBody: {}
29177
- commonParams: {
29176
+ jsonBody: {
29178
29177
  /** ACS system ID of the credential manager for the new credential. */
29179
29178
  credential_manager_acs_system_id?: string | undefined
29180
29179
  /** ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
@@ -29238,6 +29237,7 @@ export type Routes = {
29238
29237
  /** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
29239
29238
  ends_at?: string | undefined
29240
29239
  }
29240
+ commonParams: {}
29241
29241
  formData: {}
29242
29242
  jsonResponse: {
29243
29243
  /** Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
@@ -29439,8 +29439,7 @@ export type Routes = {
29439
29439
  route: '/acs/credentials/create_offline_code'
29440
29440
  method: 'POST'
29441
29441
  queryParams: {}
29442
- jsonBody: {}
29443
- commonParams: {
29442
+ jsonBody: {
29444
29443
  /** ID of the access system user to whom the new credential belongs. */
29445
29444
  acs_user_id: string
29446
29445
  /** IDs of the [`acs_entrance`s](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access. */
@@ -29452,6 +29451,7 @@ export type Routes = {
29452
29451
  /** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
29453
29452
  ends_at?: string | undefined
29454
29453
  }
29454
+ commonParams: {}
29455
29455
  formData: {}
29456
29456
  jsonResponse: {
29457
29457
  /** 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).
@@ -29873,27 +29873,13 @@ export type Routes = {
29873
29873
  method: 'GET' | 'POST'
29874
29874
  queryParams: {}
29875
29875
  jsonBody: {}
29876
- commonParams: (
29877
- | {
29878
- /** ID of the access system user for which you want to retrieve all credentials. */
29879
- acs_user_id: string
29880
- }
29881
- | {
29882
- /** ID of the access system for which you want to retrieve all credentials. */
29883
- acs_system_id: string
29884
- }
29885
- | {
29886
- /** ID of the access system user for which you want to retrieve all credentials. */
29887
- acs_user_id: string
29888
- /** ID of the access system for which you want to retrieve all credentials. */
29889
- acs_system_id: string
29890
- }
29891
- | {
29892
- /** ID of the user identity for which you want to retrieve all credentials. */
29893
- user_identity_id: string
29894
- }
29895
- | {}
29896
- ) & {
29876
+ commonParams: {
29877
+ /** ID of the access system user for which you want to retrieve all credentials. */
29878
+ acs_user_id?: string | undefined
29879
+ /** ID of the access system for which you want to retrieve all credentials. */
29880
+ acs_system_id?: string | undefined
29881
+ /** ID of the user identity for which you want to retrieve all credentials. */
29882
+ user_identity_id?: string | undefined
29897
29883
  /** Number of credentials to return. */
29898
29884
  limit?: number
29899
29885
  /** 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. */
@@ -30794,26 +30780,13 @@ export type Routes = {
30794
30780
  method: 'GET' | 'POST'
30795
30781
  queryParams: {}
30796
30782
  jsonBody: {}
30797
- commonParams: (
30798
- | {
30799
- /** ID of the access system user for which you want to retrieve all credentials. */
30800
- acs_user_id: string
30801
- }
30802
- | {
30803
- /** ID of the access system for which you want to retrieve all credentials. */
30804
- acs_system_id: string
30805
- }
30806
- | {
30807
- /** ID of the access system user for which you want to retrieve all credentials. */
30808
- acs_user_id: string
30809
- /** ID of the access system for which you want to retrieve all credentials. */
30810
- acs_system_id: string
30811
- }
30812
- | {
30813
- /** ID of the user identity for which you want to retrieve all credentials. */
30814
- user_identity_id: string
30815
- }
30816
- ) & {
30783
+ commonParams: {
30784
+ /** ID of the access system user for which you want to retrieve all credentials. */
30785
+ acs_user_id?: string | undefined
30786
+ /** ID of the access system for which you want to retrieve all credentials. */
30787
+ acs_system_id?: string | undefined
30788
+ /** ID of the user identity for which you want to retrieve all credentials. */
30789
+ user_identity_id?: string | undefined
30817
30790
  /** 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`. */
30818
30791
  search?: string | undefined
30819
30792
  }
@@ -31220,8 +31193,7 @@ export type Routes = {
31220
31193
  route: '/acs/encoders/encode_credential'
31221
31194
  method: 'POST'
31222
31195
  queryParams: {}
31223
- jsonBody: {}
31224
- commonParams: {
31196
+ jsonBody: {
31225
31197
  /** ID of the `acs_encoder` to use to encode the `acs_credential`. */
31226
31198
  acs_encoder_id: string
31227
31199
  /** ID of the `acs_credential` to encode onto a card. */
@@ -31229,6 +31201,7 @@ export type Routes = {
31229
31201
  /** ID of the `access_method` to encode onto a card. */
31230
31202
  access_method_id?: string | undefined
31231
31203
  }
31204
+ commonParams: {}
31232
31205
  formData: {}
31233
31206
  jsonResponse: {
31234
31207
  /** 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.
@@ -33374,20 +33347,13 @@ export type Routes = {
33374
33347
  method: 'GET' | 'POST'
33375
33348
  queryParams: {}
33376
33349
  jsonBody: {}
33377
- commonParams: (
33378
- | {
33379
- /** ID of the access system for which you want to retrieve all encoders. */
33380
- acs_system_id: string
33381
- }
33382
- | {
33383
- /** IDs of the access systems for which you want to retrieve all encoders. */
33384
- acs_system_ids: string[]
33385
- }
33386
- | {
33387
- /** IDs of the encoders that you want to retrieve. */
33388
- acs_encoder_ids: string[]
33389
- }
33390
- ) & {
33350
+ commonParams: {
33351
+ /** ID of the access system for which you want to retrieve all encoders. */
33352
+ acs_system_id?: string | undefined
33353
+ /** IDs of the access systems for which you want to retrieve all encoders. */
33354
+ acs_system_ids?: string[] | undefined
33355
+ /** IDs of the encoders that you want to retrieve. */
33356
+ acs_encoder_ids?: string[] | undefined
33391
33357
  /** Number of encoders to return. */
33392
33358
  limit?: number
33393
33359
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
@@ -33434,8 +33400,7 @@ export type Routes = {
33434
33400
  route: '/acs/encoders/scan_credential'
33435
33401
  method: 'POST'
33436
33402
  queryParams: {}
33437
- jsonBody: {}
33438
- commonParams: {
33403
+ jsonBody: {
33439
33404
  /** ID of the encoder to use for the scan. */
33440
33405
  acs_encoder_id: string
33441
33406
  /** Salto KS-specific metadata for the scan action. */
@@ -33446,6 +33411,7 @@ export type Routes = {
33446
33411
  }
33447
33412
  | undefined
33448
33413
  }
33414
+ commonParams: {}
33449
33415
  formData: {}
33450
33416
  jsonResponse: {
33451
33417
  /** 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.
@@ -35539,8 +35505,7 @@ export type Routes = {
35539
35505
  route: '/acs/encoders/scan_to_assign_credential'
35540
35506
  method: 'POST'
35541
35507
  queryParams: {}
35542
- jsonBody: {}
35543
- commonParams: {
35508
+ jsonBody: {
35544
35509
  /** ID of the `acs_encoder` to use to scan the credential. */
35545
35510
  acs_encoder_id: string
35546
35511
  /** ID of the `acs_user` to assign the scanned credential to. */
@@ -35555,6 +35520,7 @@ export type Routes = {
35555
35520
  }
35556
35521
  | undefined
35557
35522
  }
35523
+ commonParams: {}
35558
35524
  formData: {}
35559
35525
  jsonResponse: {
35560
35526
  /** 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.
@@ -38542,13 +38508,13 @@ export type Routes = {
38542
38508
  route: '/acs/entrances/unlock'
38543
38509
  method: 'POST'
38544
38510
  queryParams: {}
38545
- jsonBody: {}
38546
- commonParams: {
38511
+ jsonBody: {
38547
38512
  /** ID of the entrance to unlock. */
38548
38513
  acs_entrance_id: string
38549
38514
  /** ID of the cloud_key credential to use for the unlock operation. */
38550
38515
  acs_credential_id: string
38551
38516
  }
38517
+ commonParams: {}
38552
38518
  formData: {}
38553
38519
  jsonResponse: {
38554
38520
  /** 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.
@@ -41317,8 +41283,7 @@ export type Routes = {
41317
41283
  route: '/acs/systems/report_devices'
41318
41284
  method: 'POST'
41319
41285
  queryParams: {}
41320
- jsonBody: {}
41321
- commonParams: {
41286
+ jsonBody: {
41322
41287
  /** ID of the ACS system to report resources for */
41323
41288
  acs_system_id: string
41324
41289
  /** Array of ACS encoders to report */
@@ -41349,6 +41314,7 @@ export type Routes = {
41349
41314
  }[]
41350
41315
  | undefined
41351
41316
  }
41317
+ commonParams: {}
41352
41318
  formData: {}
41353
41319
  jsonResponse: {}
41354
41320
  maxDuration: undefined
@@ -41357,13 +41323,13 @@ export type Routes = {
41357
41323
  route: '/acs/users/add_to_access_group'
41358
41324
  method: 'PUT' | 'POST'
41359
41325
  queryParams: {}
41360
- jsonBody: {}
41361
- commonParams: {
41326
+ jsonBody: {
41362
41327
  /** ID of the access system user that you want to add to an access group. */
41363
41328
  acs_user_id: string
41364
41329
  /** ID of the access group to which you want to add an access system user. */
41365
41330
  acs_access_group_id: string
41366
41331
  }
41332
+ commonParams: {}
41367
41333
  formData: {}
41368
41334
  jsonResponse: {}
41369
41335
  maxDuration: undefined
@@ -42728,8 +42694,7 @@ export type Routes = {
42728
42694
  route: '/acs/users/suspend'
42729
42695
  method: 'POST'
42730
42696
  queryParams: {}
42731
- jsonBody: {}
42732
- commonParams: {
42697
+ jsonBody: {
42733
42698
  /** 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. */
42734
42699
  acs_user_id?: string | undefined
42735
42700
  /** 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. */
@@ -42737,6 +42702,7 @@ export type Routes = {
42737
42702
  /** 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. */
42738
42703
  acs_system_id?: string | undefined
42739
42704
  }
42705
+ commonParams: {}
42740
42706
  formData: {}
42741
42707
  jsonResponse: {}
42742
42708
  maxDuration: undefined
@@ -43398,8 +43364,7 @@ export type Routes = {
43398
43364
  route: '/acs/users/unsuspend'
43399
43365
  method: 'POST'
43400
43366
  queryParams: {}
43401
- jsonBody: {}
43402
- commonParams: {
43367
+ jsonBody: {
43403
43368
  /** 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. */
43404
43369
  acs_user_id?: string | undefined
43405
43370
  /** 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. */
@@ -43407,6 +43372,7 @@ export type Routes = {
43407
43372
  /** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
43408
43373
  acs_system_id?: string | undefined
43409
43374
  }
43375
+ commonParams: {}
43410
43376
  formData: {}
43411
43377
  jsonResponse: {}
43412
43378
  maxDuration: undefined
@@ -47892,8 +47858,7 @@ export type Routes = {
47892
47858
  route: '/client_sessions/grant_access'
47893
47859
  method: 'PATCH' | 'POST'
47894
47860
  queryParams: {}
47895
- jsonBody: {}
47896
- commonParams: {
47861
+ jsonBody: {
47897
47862
  /** ID of the client session to which you want to grant access to resources. */
47898
47863
  client_session_id?: string | undefined
47899
47864
  /** Your user ID for the user that you want to associate with the client session. */
@@ -47908,6 +47873,7 @@ export type Routes = {
47908
47873
  /** 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. */
47909
47874
  user_identity_id?: string | undefined
47910
47875
  }
47876
+ commonParams: {}
47911
47877
  formData: {}
47912
47878
  jsonResponse: {
47913
47879
  /** 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.
@@ -48002,11 +47968,11 @@ export type Routes = {
48002
47968
  route: '/client_sessions/revoke'
48003
47969
  method: 'POST'
48004
47970
  queryParams: {}
48005
- jsonBody: {}
48006
- commonParams: {
47971
+ jsonBody: {
48007
47972
  /** ID of the client session that you want to revoke. */
48008
47973
  client_session_id: string
48009
47974
  }
47975
+ commonParams: {}
48010
47976
  formData: {}
48011
47977
  jsonResponse: {}
48012
47978
  maxDuration: undefined
@@ -49145,8 +49111,7 @@ export type Routes = {
49145
49111
  route: '/customers/create_portal'
49146
49112
  method: 'POST'
49147
49113
  queryParams: {}
49148
- jsonBody: {}
49149
- commonParams: {
49114
+ jsonBody: {
49150
49115
  features?: {
49151
49116
  /** Configuration for the connect accounts feature. */
49152
49117
  connect?: {
@@ -49687,6 +49652,7 @@ export type Routes = {
49687
49652
  }
49688
49653
  | undefined
49689
49654
  }
49655
+ commonParams: {}
49690
49656
  formData: {}
49691
49657
  jsonResponse: {
49692
49658
  /** 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.
@@ -49779,8 +49745,7 @@ export type Routes = {
49779
49745
  route: '/customers/push_data'
49780
49746
  method: 'POST'
49781
49747
  queryParams: {}
49782
- jsonBody: {}
49783
- commonParams: {
49748
+ jsonBody: {
49784
49749
  /** Your unique identifier for the customer. */
49785
49750
  customer_key: string
49786
49751
  /** List of general spaces or areas. */
@@ -50139,6 +50104,7 @@ export type Routes = {
50139
50104
  }[]
50140
50105
  | undefined
50141
50106
  }
50107
+ commonParams: {}
50142
50108
  formData: {}
50143
50109
  jsonResponse: {}
50144
50110
  maxDuration: undefined
@@ -50147,13 +50113,13 @@ export type Routes = {
50147
50113
  route: '/customers/reservations/create_deep_link'
50148
50114
  method: 'POST'
50149
50115
  queryParams: {}
50150
- jsonBody: {}
50151
- commonParams: {
50116
+ jsonBody: {
50152
50117
  /** The customer_key identifying the customer who owns the reservation. */
50153
50118
  customer_key: string
50154
50119
  /** The key of the reservation to create a deep link for. */
50155
50120
  reservation_key: string
50156
50121
  }
50122
+ commonParams: {}
50157
50123
  formData: {}
50158
50124
  jsonResponse: {
50159
50125
  deep_link: {
@@ -54331,8 +54297,7 @@ export type Routes = {
54331
54297
  route: '/devices/report_provider_metadata'
54332
54298
  method: 'POST'
54333
54299
  queryParams: {}
54334
- jsonBody: {}
54335
- commonParams: {
54300
+ jsonBody: {
54336
54301
  /** Array of devices with provider metadata to update */
54337
54302
  devices: {
54338
54303
  /** ID of the device to update */
@@ -55647,6 +55612,7 @@ export type Routes = {
55647
55612
  | undefined
55648
55613
  }[]
55649
55614
  }
55615
+ commonParams: {}
55650
55616
  formData: {}
55651
55617
  jsonResponse: {}
55652
55618
  maxDuration: undefined
@@ -57164,8 +57130,7 @@ export type Routes = {
57164
57130
  route: '/devices/unmanaged/update'
57165
57131
  method: 'POST' | 'PATCH'
57166
57132
  queryParams: {}
57167
- jsonBody: {}
57168
- commonParams: {
57133
+ jsonBody: {
57169
57134
  /** ID of the unmanaged device that you want to update. */
57170
57135
  device_id: string
57171
57136
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
@@ -57177,6 +57142,7 @@ export type Routes = {
57177
57142
  }
57178
57143
  | undefined
57179
57144
  }
57145
+ commonParams: {}
57180
57146
  formData: {}
57181
57147
  jsonResponse: {}
57182
57148
  maxDuration: undefined
@@ -57185,8 +57151,7 @@ export type Routes = {
57185
57151
  route: '/devices/update'
57186
57152
  method: 'POST' | 'PATCH'
57187
57153
  queryParams: {}
57188
- jsonBody: {}
57189
- commonParams: {
57154
+ jsonBody: {
57190
57155
  /** ID of the device that you want to update. */
57191
57156
  device_id: string
57192
57157
  properties?:
@@ -57208,6 +57173,7 @@ export type Routes = {
57208
57173
  /** 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. */
57209
57174
  backup_access_code_pool_enabled?: boolean | undefined
57210
57175
  }
57176
+ commonParams: {}
57211
57177
  formData: {}
57212
57178
  jsonResponse: {}
57213
57179
  maxDuration: undefined
@@ -60861,7 +60827,7 @@ export type Routes = {
60861
60827
  /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
60862
60828
  since?: string | undefined
60863
60829
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
60864
- between?: (string | Date)[] | undefined
60830
+ between?: string[] | undefined
60865
60831
  /** ID of the device for which you want to list events. */
60866
60832
  device_id?: string | undefined
60867
60833
  /** IDs of the devices for which you want to list events. */
@@ -93950,11 +93916,11 @@ export type Routes = {
93950
93916
  route: '/seam/console/v1/lynx_migration/migrate_property'
93951
93917
  method: 'POST'
93952
93918
  queryParams: {}
93953
- jsonBody: {}
93954
- commonParams: {
93919
+ jsonBody: {
93955
93920
  /** ID of the space (property) to migrate. */
93956
93921
  space_id: string
93957
93922
  }
93923
+ commonParams: {}
93958
93924
  formData: {}
93959
93925
  jsonResponse: {
93960
93926
  lynx_migration_property_run: {
@@ -94813,8 +94779,7 @@ export type Routes = {
94813
94779
  route: '/seam/console/v1/workspace/feature_flags/update'
94814
94780
  method: 'POST'
94815
94781
  queryParams: {}
94816
- jsonBody: {}
94817
- commonParams: {
94782
+ jsonBody: {
94818
94783
  /** Name of the workspace feature flag to update. */
94819
94784
  feature_flag_name:
94820
94785
  | 'RESERVATION_LEGACY'
@@ -94834,6 +94799,7 @@ export type Routes = {
94834
94799
  /** Whether the feature flag should be enabled for the workspace. */
94835
94800
  enabled: boolean
94836
94801
  }
94802
+ commonParams: {}
94837
94803
  formData: {}
94838
94804
  jsonResponse: {
94839
94805
  feature_flag: {
@@ -95067,13 +95033,13 @@ export type Routes = {
95067
95033
  route: '/seam/customer/v1/access_grants/update'
95068
95034
  method: 'POST' | 'PATCH'
95069
95035
  queryParams: {}
95070
- jsonBody: {}
95071
- commonParams: {
95036
+ jsonBody: {
95072
95037
  /** ID of the Access Grant to update. */
95073
95038
  access_grant_id: string
95074
95039
  /** Array of location IDs to associate with the access grant. */
95075
95040
  space_ids: string[]
95076
95041
  }
95042
+ commonParams: {}
95077
95043
  formData: {}
95078
95044
  jsonResponse: {}
95079
95045
  maxDuration: undefined
@@ -95082,13 +95048,13 @@ export type Routes = {
95082
95048
  route: '/seam/customer/v1/access_methods/encode'
95083
95049
  method: 'POST'
95084
95050
  queryParams: {}
95085
- jsonBody: {}
95086
- commonParams: {
95051
+ jsonBody: {
95087
95052
  /** ID of the encoder to use for encoding the access method. */
95088
95053
  acs_encoder_id: string
95089
95054
  /** ID of the access method to encode onto a card. */
95090
95055
  access_method_id: string
95091
95056
  }
95057
+ commonParams: {}
95092
95058
  formData: {}
95093
95059
  jsonResponse: {
95094
95060
  /** 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.
@@ -97781,8 +97747,7 @@ export type Routes = {
97781
97747
  route: '/seam/customer/v1/connectors/sync'
97782
97748
  method: 'POST'
97783
97749
  queryParams: {}
97784
- jsonBody: {}
97785
- commonParams: {
97750
+ jsonBody: {
97786
97751
  /** ID of the connector to sync */
97787
97752
  connector_id: string
97788
97753
  /** Type of the connector to sync */
@@ -97794,6 +97759,7 @@ export type Routes = {
97794
97759
  /** Unique provider resource key of the connector to sync */
97795
97760
  unique_provider_resource_key?: (string | null) | undefined
97796
97761
  }
97762
+ commonParams: {}
97797
97763
  formData: {}
97798
97764
  jsonResponse: {
97799
97765
  connector_sync: {
@@ -98131,11 +98097,11 @@ export type Routes = {
98131
98097
  route: '/seam/customer/v1/customers/open_portal'
98132
98098
  method: 'POST'
98133
98099
  queryParams: {}
98134
- jsonBody: {}
98135
- commonParams: {
98100
+ jsonBody: {
98136
98101
  /** The customer key to open a portal for. */
98137
98102
  customer_key: string
98138
98103
  }
98104
+ commonParams: {}
98139
98105
  formData: {}
98140
98106
  jsonResponse: {
98141
98107
  /** 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.
@@ -98188,7 +98154,7 @@ export type Routes = {
98188
98154
  /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
98189
98155
  since?: string | undefined
98190
98156
  /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
98191
- between?: (string | Date)[] | undefined
98157
+ between?: string[] | undefined
98192
98158
  /** Type of the events that you want to list. */
98193
98159
  event_type?:
98194
98160
  | (
@@ -102527,7 +102493,7 @@ export type Routes = {
102527
102493
  /** Timestamp by which to limit returned reservations. Returns reservations created after this timestamp. */
102528
102494
  created_after?: Date | undefined
102529
102495
  /** Lower and upper timestamps to filter reservations whose time range overlaps with the given interval. */
102530
- between?: (string | Date)[] | undefined
102496
+ between?: string[] | undefined
102531
102497
  /** 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. */
102532
102498
  search?: string | undefined
102533
102499
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
@@ -103139,8 +103105,7 @@ export type Routes = {
103139
103105
  route: '/seam/customer/v1/spaces/push_common_areas'
103140
103106
  method: 'POST'
103141
103107
  queryParams: {}
103142
- jsonBody: {}
103143
- commonParams: {
103108
+ jsonBody: {
103144
103109
  common_areas?:
103145
103110
  | {
103146
103111
  name: string
@@ -103155,6 +103120,7 @@ export type Routes = {
103155
103120
  }[]
103156
103121
  | undefined
103157
103122
  }
103123
+ commonParams: {}
103158
103124
  formData: {}
103159
103125
  jsonResponse: {}
103160
103126
  maxDuration: undefined
@@ -132740,11 +132706,11 @@ export type Routes = {
132740
132706
  route: '/unstable_partner/building_blocks/connect_accounts'
132741
132707
  method: 'POST'
132742
132708
  queryParams: {}
132743
- jsonBody: {}
132744
- commonParams: {
132709
+ jsonBody: {
132745
132710
  /** Customer key for which you want to connect accounts. */
132746
132711
  customer_key: string
132747
132712
  }
132713
+ commonParams: {}
132748
132714
  formData: {}
132749
132715
  jsonResponse: {
132750
132716
  /** 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.
@@ -132840,11 +132806,11 @@ export type Routes = {
132840
132806
  route: '/unstable_partner/building_blocks/manage_devices'
132841
132807
  method: 'POST'
132842
132808
  queryParams: {}
132843
- jsonBody: {}
132844
- commonParams: {
132809
+ jsonBody: {
132845
132810
  /** Customer key for which you want to manage devices. */
132846
132811
  customer_key: string
132847
132812
  }
132813
+ commonParams: {}
132848
132814
  formData: {}
132849
132815
  jsonResponse: {
132850
132816
  /** 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.
@@ -132871,8 +132837,7 @@ export type Routes = {
132871
132837
  route: '/unstable_partner/building_blocks/organize_spaces'
132872
132838
  method: 'POST'
132873
132839
  queryParams: {}
132874
- jsonBody: {}
132875
- commonParams: {
132840
+ jsonBody: {
132876
132841
  /** Customer key for which you want to organize spaces. */
132877
132842
  customer_key: string
132878
132843
  /** Optional list of spaces that you want to include in the new building block magic link. */
@@ -132911,6 +132876,7 @@ export type Routes = {
132911
132876
  }[]
132912
132877
  | undefined
132913
132878
  }
132879
+ commonParams: {}
132914
132880
  formData: {}
132915
132881
  jsonResponse: {
132916
132882
  /** 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.
@@ -132937,8 +132903,7 @@ export type Routes = {
132937
132903
  route: '/user_identities/add_acs_user'
132938
132904
  method: 'POST' | 'PUT'
132939
132905
  queryParams: {}
132940
- jsonBody: {}
132941
- commonParams: {
132906
+ jsonBody: {
132942
132907
  /** ID of the user identity to which you want to add an access system user. */
132943
132908
  user_identity_id?: string | undefined
132944
132909
  /** Key of the user identity to which you want to add an access system user. */
@@ -132946,6 +132911,7 @@ export type Routes = {
132946
132911
  /** ID of the access system user that you want to add to the user identity. */
132947
132912
  acs_user_id: string
132948
132913
  }
132914
+ commonParams: {}
132949
132915
  formData: {}
132950
132916
  jsonResponse: {}
132951
132917
  maxDuration: undefined
@@ -132954,8 +132920,7 @@ export type Routes = {
132954
132920
  route: '/user_identities/create'
132955
132921
  method: 'POST'
132956
132922
  queryParams: {}
132957
- jsonBody: {}
132958
- commonParams: {
132923
+ jsonBody: {
132959
132924
  /** Unique key for the new user identity. */
132960
132925
  user_identity_key?: (string | null) | undefined
132961
132926
  /** Unique email address for the new user identity. */
@@ -132967,6 +132932,7 @@ export type Routes = {
132967
132932
  /** 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. */
132968
132933
  acs_system_ids?: string[] | undefined
132969
132934
  }
132935
+ commonParams: {}
132970
132936
  formData: {}
132971
132937
  jsonResponse: {
132972
132938
  /** 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. */
@@ -133082,8 +133048,7 @@ export type Routes = {
133082
133048
  route: '/user_identities/enrollment_automations/launch'
133083
133049
  method: 'POST'
133084
133050
  queryParams: {}
133085
- jsonBody: {}
133086
- commonParams: {
133051
+ jsonBody: {
133087
133052
  /** ID of the user identity for which you want to launch an enrollment automation. */
133088
133053
  user_identity_id: string
133089
133054
  /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
@@ -133095,6 +133060,7 @@ export type Routes = {
133095
133060
  /** 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`. */
133096
133061
  credential_manager_acs_user_id?: string | undefined
133097
133062
  }
133063
+ commonParams: {}
133098
133064
  formData: {}
133099
133065
  jsonResponse: {
133100
133066
  /** 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/). */
@@ -133143,14 +133109,14 @@ export type Routes = {
133143
133109
  route: '/user_identities/generate_instant_key'
133144
133110
  method: 'POST'
133145
133111
  queryParams: {}
133146
- jsonBody: {}
133147
- commonParams: {
133112
+ jsonBody: {
133148
133113
  customization_profile_id?: string | undefined
133149
133114
  /** ID of the user identity for which you want to generate an instant key. */
133150
133115
  user_identity_id: string
133151
133116
  /** Maximum number of times the instant key can be used. Default: 1. */
133152
133117
  max_use_count?: number
133153
133118
  }
133119
+ commonParams: {}
133154
133120
  formData: {}
133155
133121
  jsonResponse: {
133156
133122
  /** 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.
@@ -133263,13 +133229,13 @@ export type Routes = {
133263
133229
  route: '/user_identities/grant_access_to_device'
133264
133230
  method: 'PUT' | 'POST'
133265
133231
  queryParams: {}
133266
- jsonBody: {}
133267
- commonParams: {
133232
+ jsonBody: {
133268
133233
  /** ID of the user identity that you want to grant access to a device. */
133269
133234
  user_identity_id: string
133270
133235
  /** ID of the managed device to which you want to grant access to the user identity. */
133271
133236
  device_id: string
133272
133237
  }
133238
+ commonParams: {}
133273
133239
  formData: {}
133274
133240
  jsonResponse: {}
133275
133241
  maxDuration: undefined