@seamapi/types 1.1002.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).
|
|
@@ -31193,8 +31193,7 @@ export type Routes = {
|
|
|
31193
31193
|
route: '/acs/encoders/encode_credential'
|
|
31194
31194
|
method: 'POST'
|
|
31195
31195
|
queryParams: {}
|
|
31196
|
-
jsonBody: {
|
|
31197
|
-
commonParams: {
|
|
31196
|
+
jsonBody: {
|
|
31198
31197
|
/** ID of the `acs_encoder` to use to encode the `acs_credential`. */
|
|
31199
31198
|
acs_encoder_id: string
|
|
31200
31199
|
/** ID of the `acs_credential` to encode onto a card. */
|
|
@@ -31202,6 +31201,7 @@ export type Routes = {
|
|
|
31202
31201
|
/** ID of the `access_method` to encode onto a card. */
|
|
31203
31202
|
access_method_id?: string | undefined
|
|
31204
31203
|
}
|
|
31204
|
+
commonParams: {}
|
|
31205
31205
|
formData: {}
|
|
31206
31206
|
jsonResponse: {
|
|
31207
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.
|
|
@@ -33400,8 +33400,7 @@ export type Routes = {
|
|
|
33400
33400
|
route: '/acs/encoders/scan_credential'
|
|
33401
33401
|
method: 'POST'
|
|
33402
33402
|
queryParams: {}
|
|
33403
|
-
jsonBody: {
|
|
33404
|
-
commonParams: {
|
|
33403
|
+
jsonBody: {
|
|
33405
33404
|
/** ID of the encoder to use for the scan. */
|
|
33406
33405
|
acs_encoder_id: string
|
|
33407
33406
|
/** Salto KS-specific metadata for the scan action. */
|
|
@@ -33412,6 +33411,7 @@ export type Routes = {
|
|
|
33412
33411
|
}
|
|
33413
33412
|
| undefined
|
|
33414
33413
|
}
|
|
33414
|
+
commonParams: {}
|
|
33415
33415
|
formData: {}
|
|
33416
33416
|
jsonResponse: {
|
|
33417
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.
|
|
@@ -35505,8 +35505,7 @@ export type Routes = {
|
|
|
35505
35505
|
route: '/acs/encoders/scan_to_assign_credential'
|
|
35506
35506
|
method: 'POST'
|
|
35507
35507
|
queryParams: {}
|
|
35508
|
-
jsonBody: {
|
|
35509
|
-
commonParams: {
|
|
35508
|
+
jsonBody: {
|
|
35510
35509
|
/** ID of the `acs_encoder` to use to scan the credential. */
|
|
35511
35510
|
acs_encoder_id: string
|
|
35512
35511
|
/** ID of the `acs_user` to assign the scanned credential to. */
|
|
@@ -35521,6 +35520,7 @@ export type Routes = {
|
|
|
35521
35520
|
}
|
|
35522
35521
|
| undefined
|
|
35523
35522
|
}
|
|
35523
|
+
commonParams: {}
|
|
35524
35524
|
formData: {}
|
|
35525
35525
|
jsonResponse: {
|
|
35526
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.
|
|
@@ -38508,13 +38508,13 @@ export type Routes = {
|
|
|
38508
38508
|
route: '/acs/entrances/unlock'
|
|
38509
38509
|
method: 'POST'
|
|
38510
38510
|
queryParams: {}
|
|
38511
|
-
jsonBody: {
|
|
38512
|
-
commonParams: {
|
|
38511
|
+
jsonBody: {
|
|
38513
38512
|
/** ID of the entrance to unlock. */
|
|
38514
38513
|
acs_entrance_id: string
|
|
38515
38514
|
/** ID of the cloud_key credential to use for the unlock operation. */
|
|
38516
38515
|
acs_credential_id: string
|
|
38517
38516
|
}
|
|
38517
|
+
commonParams: {}
|
|
38518
38518
|
formData: {}
|
|
38519
38519
|
jsonResponse: {
|
|
38520
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.
|
|
@@ -41283,8 +41283,7 @@ export type Routes = {
|
|
|
41283
41283
|
route: '/acs/systems/report_devices'
|
|
41284
41284
|
method: 'POST'
|
|
41285
41285
|
queryParams: {}
|
|
41286
|
-
jsonBody: {
|
|
41287
|
-
commonParams: {
|
|
41286
|
+
jsonBody: {
|
|
41288
41287
|
/** ID of the ACS system to report resources for */
|
|
41289
41288
|
acs_system_id: string
|
|
41290
41289
|
/** Array of ACS encoders to report */
|
|
@@ -41315,6 +41314,7 @@ export type Routes = {
|
|
|
41315
41314
|
}[]
|
|
41316
41315
|
| undefined
|
|
41317
41316
|
}
|
|
41317
|
+
commonParams: {}
|
|
41318
41318
|
formData: {}
|
|
41319
41319
|
jsonResponse: {}
|
|
41320
41320
|
maxDuration: undefined
|
|
@@ -41323,13 +41323,13 @@ export type Routes = {
|
|
|
41323
41323
|
route: '/acs/users/add_to_access_group'
|
|
41324
41324
|
method: 'PUT' | 'POST'
|
|
41325
41325
|
queryParams: {}
|
|
41326
|
-
jsonBody: {
|
|
41327
|
-
commonParams: {
|
|
41326
|
+
jsonBody: {
|
|
41328
41327
|
/** ID of the access system user that you want to add to an access group. */
|
|
41329
41328
|
acs_user_id: string
|
|
41330
41329
|
/** ID of the access group to which you want to add an access system user. */
|
|
41331
41330
|
acs_access_group_id: string
|
|
41332
41331
|
}
|
|
41332
|
+
commonParams: {}
|
|
41333
41333
|
formData: {}
|
|
41334
41334
|
jsonResponse: {}
|
|
41335
41335
|
maxDuration: undefined
|
|
@@ -42694,8 +42694,7 @@ export type Routes = {
|
|
|
42694
42694
|
route: '/acs/users/suspend'
|
|
42695
42695
|
method: 'POST'
|
|
42696
42696
|
queryParams: {}
|
|
42697
|
-
jsonBody: {
|
|
42698
|
-
commonParams: {
|
|
42697
|
+
jsonBody: {
|
|
42699
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. */
|
|
42700
42699
|
acs_user_id?: string | undefined
|
|
42701
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. */
|
|
@@ -42703,6 +42702,7 @@ export type Routes = {
|
|
|
42703
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. */
|
|
42704
42703
|
acs_system_id?: string | undefined
|
|
42705
42704
|
}
|
|
42705
|
+
commonParams: {}
|
|
42706
42706
|
formData: {}
|
|
42707
42707
|
jsonResponse: {}
|
|
42708
42708
|
maxDuration: undefined
|
|
@@ -43364,8 +43364,7 @@ export type Routes = {
|
|
|
43364
43364
|
route: '/acs/users/unsuspend'
|
|
43365
43365
|
method: 'POST'
|
|
43366
43366
|
queryParams: {}
|
|
43367
|
-
jsonBody: {
|
|
43368
|
-
commonParams: {
|
|
43367
|
+
jsonBody: {
|
|
43369
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. */
|
|
43370
43369
|
acs_user_id?: string | undefined
|
|
43371
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. */
|
|
@@ -43373,6 +43372,7 @@ export type Routes = {
|
|
|
43373
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. */
|
|
43374
43373
|
acs_system_id?: string | undefined
|
|
43375
43374
|
}
|
|
43375
|
+
commonParams: {}
|
|
43376
43376
|
formData: {}
|
|
43377
43377
|
jsonResponse: {}
|
|
43378
43378
|
maxDuration: undefined
|
|
@@ -47858,8 +47858,7 @@ export type Routes = {
|
|
|
47858
47858
|
route: '/client_sessions/grant_access'
|
|
47859
47859
|
method: 'PATCH' | 'POST'
|
|
47860
47860
|
queryParams: {}
|
|
47861
|
-
jsonBody: {
|
|
47862
|
-
commonParams: {
|
|
47861
|
+
jsonBody: {
|
|
47863
47862
|
/** ID of the client session to which you want to grant access to resources. */
|
|
47864
47863
|
client_session_id?: string | undefined
|
|
47865
47864
|
/** Your user ID for the user that you want to associate with the client session. */
|
|
@@ -47874,6 +47873,7 @@ export type Routes = {
|
|
|
47874
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. */
|
|
47875
47874
|
user_identity_id?: string | undefined
|
|
47876
47875
|
}
|
|
47876
|
+
commonParams: {}
|
|
47877
47877
|
formData: {}
|
|
47878
47878
|
jsonResponse: {
|
|
47879
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.
|
|
@@ -47968,11 +47968,11 @@ export type Routes = {
|
|
|
47968
47968
|
route: '/client_sessions/revoke'
|
|
47969
47969
|
method: 'POST'
|
|
47970
47970
|
queryParams: {}
|
|
47971
|
-
jsonBody: {
|
|
47972
|
-
commonParams: {
|
|
47971
|
+
jsonBody: {
|
|
47973
47972
|
/** ID of the client session that you want to revoke. */
|
|
47974
47973
|
client_session_id: string
|
|
47975
47974
|
}
|
|
47975
|
+
commonParams: {}
|
|
47976
47976
|
formData: {}
|
|
47977
47977
|
jsonResponse: {}
|
|
47978
47978
|
maxDuration: undefined
|
|
@@ -49111,8 +49111,7 @@ export type Routes = {
|
|
|
49111
49111
|
route: '/customers/create_portal'
|
|
49112
49112
|
method: 'POST'
|
|
49113
49113
|
queryParams: {}
|
|
49114
|
-
jsonBody: {
|
|
49115
|
-
commonParams: {
|
|
49114
|
+
jsonBody: {
|
|
49116
49115
|
features?: {
|
|
49117
49116
|
/** Configuration for the connect accounts feature. */
|
|
49118
49117
|
connect?: {
|
|
@@ -49653,6 +49652,7 @@ export type Routes = {
|
|
|
49653
49652
|
}
|
|
49654
49653
|
| undefined
|
|
49655
49654
|
}
|
|
49655
|
+
commonParams: {}
|
|
49656
49656
|
formData: {}
|
|
49657
49657
|
jsonResponse: {
|
|
49658
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.
|
|
@@ -49745,8 +49745,7 @@ export type Routes = {
|
|
|
49745
49745
|
route: '/customers/push_data'
|
|
49746
49746
|
method: 'POST'
|
|
49747
49747
|
queryParams: {}
|
|
49748
|
-
jsonBody: {
|
|
49749
|
-
commonParams: {
|
|
49748
|
+
jsonBody: {
|
|
49750
49749
|
/** Your unique identifier for the customer. */
|
|
49751
49750
|
customer_key: string
|
|
49752
49751
|
/** List of general spaces or areas. */
|
|
@@ -50105,6 +50104,7 @@ export type Routes = {
|
|
|
50105
50104
|
}[]
|
|
50106
50105
|
| undefined
|
|
50107
50106
|
}
|
|
50107
|
+
commonParams: {}
|
|
50108
50108
|
formData: {}
|
|
50109
50109
|
jsonResponse: {}
|
|
50110
50110
|
maxDuration: undefined
|
|
@@ -50113,13 +50113,13 @@ export type Routes = {
|
|
|
50113
50113
|
route: '/customers/reservations/create_deep_link'
|
|
50114
50114
|
method: 'POST'
|
|
50115
50115
|
queryParams: {}
|
|
50116
|
-
jsonBody: {
|
|
50117
|
-
commonParams: {
|
|
50116
|
+
jsonBody: {
|
|
50118
50117
|
/** The customer_key identifying the customer who owns the reservation. */
|
|
50119
50118
|
customer_key: string
|
|
50120
50119
|
/** The key of the reservation to create a deep link for. */
|
|
50121
50120
|
reservation_key: string
|
|
50122
50121
|
}
|
|
50122
|
+
commonParams: {}
|
|
50123
50123
|
formData: {}
|
|
50124
50124
|
jsonResponse: {
|
|
50125
50125
|
deep_link: {
|
|
@@ -54297,8 +54297,7 @@ export type Routes = {
|
|
|
54297
54297
|
route: '/devices/report_provider_metadata'
|
|
54298
54298
|
method: 'POST'
|
|
54299
54299
|
queryParams: {}
|
|
54300
|
-
jsonBody: {
|
|
54301
|
-
commonParams: {
|
|
54300
|
+
jsonBody: {
|
|
54302
54301
|
/** Array of devices with provider metadata to update */
|
|
54303
54302
|
devices: {
|
|
54304
54303
|
/** ID of the device to update */
|
|
@@ -55613,6 +55612,7 @@ export type Routes = {
|
|
|
55613
55612
|
| undefined
|
|
55614
55613
|
}[]
|
|
55615
55614
|
}
|
|
55615
|
+
commonParams: {}
|
|
55616
55616
|
formData: {}
|
|
55617
55617
|
jsonResponse: {}
|
|
55618
55618
|
maxDuration: undefined
|
|
@@ -57130,8 +57130,7 @@ export type Routes = {
|
|
|
57130
57130
|
route: '/devices/unmanaged/update'
|
|
57131
57131
|
method: 'POST' | 'PATCH'
|
|
57132
57132
|
queryParams: {}
|
|
57133
|
-
jsonBody: {
|
|
57134
|
-
commonParams: {
|
|
57133
|
+
jsonBody: {
|
|
57135
57134
|
/** ID of the unmanaged device that you want to update. */
|
|
57136
57135
|
device_id: string
|
|
57137
57136
|
/** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
|
|
@@ -57143,6 +57142,7 @@ export type Routes = {
|
|
|
57143
57142
|
}
|
|
57144
57143
|
| undefined
|
|
57145
57144
|
}
|
|
57145
|
+
commonParams: {}
|
|
57146
57146
|
formData: {}
|
|
57147
57147
|
jsonResponse: {}
|
|
57148
57148
|
maxDuration: undefined
|
|
@@ -57151,8 +57151,7 @@ export type Routes = {
|
|
|
57151
57151
|
route: '/devices/update'
|
|
57152
57152
|
method: 'POST' | 'PATCH'
|
|
57153
57153
|
queryParams: {}
|
|
57154
|
-
jsonBody: {
|
|
57155
|
-
commonParams: {
|
|
57154
|
+
jsonBody: {
|
|
57156
57155
|
/** ID of the device that you want to update. */
|
|
57157
57156
|
device_id: string
|
|
57158
57157
|
properties?:
|
|
@@ -57174,6 +57173,7 @@ export type Routes = {
|
|
|
57174
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. */
|
|
57175
57174
|
backup_access_code_pool_enabled?: boolean | undefined
|
|
57176
57175
|
}
|
|
57176
|
+
commonParams: {}
|
|
57177
57177
|
formData: {}
|
|
57178
57178
|
jsonResponse: {}
|
|
57179
57179
|
maxDuration: undefined
|
|
@@ -93916,11 +93916,11 @@ export type Routes = {
|
|
|
93916
93916
|
route: '/seam/console/v1/lynx_migration/migrate_property'
|
|
93917
93917
|
method: 'POST'
|
|
93918
93918
|
queryParams: {}
|
|
93919
|
-
jsonBody: {
|
|
93920
|
-
commonParams: {
|
|
93919
|
+
jsonBody: {
|
|
93921
93920
|
/** ID of the space (property) to migrate. */
|
|
93922
93921
|
space_id: string
|
|
93923
93922
|
}
|
|
93923
|
+
commonParams: {}
|
|
93924
93924
|
formData: {}
|
|
93925
93925
|
jsonResponse: {
|
|
93926
93926
|
lynx_migration_property_run: {
|
|
@@ -94779,8 +94779,7 @@ export type Routes = {
|
|
|
94779
94779
|
route: '/seam/console/v1/workspace/feature_flags/update'
|
|
94780
94780
|
method: 'POST'
|
|
94781
94781
|
queryParams: {}
|
|
94782
|
-
jsonBody: {
|
|
94783
|
-
commonParams: {
|
|
94782
|
+
jsonBody: {
|
|
94784
94783
|
/** Name of the workspace feature flag to update. */
|
|
94785
94784
|
feature_flag_name:
|
|
94786
94785
|
| 'RESERVATION_LEGACY'
|
|
@@ -94800,6 +94799,7 @@ export type Routes = {
|
|
|
94800
94799
|
/** Whether the feature flag should be enabled for the workspace. */
|
|
94801
94800
|
enabled: boolean
|
|
94802
94801
|
}
|
|
94802
|
+
commonParams: {}
|
|
94803
94803
|
formData: {}
|
|
94804
94804
|
jsonResponse: {
|
|
94805
94805
|
feature_flag: {
|
|
@@ -95033,13 +95033,13 @@ export type Routes = {
|
|
|
95033
95033
|
route: '/seam/customer/v1/access_grants/update'
|
|
95034
95034
|
method: 'POST' | 'PATCH'
|
|
95035
95035
|
queryParams: {}
|
|
95036
|
-
jsonBody: {
|
|
95037
|
-
commonParams: {
|
|
95036
|
+
jsonBody: {
|
|
95038
95037
|
/** ID of the Access Grant to update. */
|
|
95039
95038
|
access_grant_id: string
|
|
95040
95039
|
/** Array of location IDs to associate with the access grant. */
|
|
95041
95040
|
space_ids: string[]
|
|
95042
95041
|
}
|
|
95042
|
+
commonParams: {}
|
|
95043
95043
|
formData: {}
|
|
95044
95044
|
jsonResponse: {}
|
|
95045
95045
|
maxDuration: undefined
|
|
@@ -95048,13 +95048,13 @@ export type Routes = {
|
|
|
95048
95048
|
route: '/seam/customer/v1/access_methods/encode'
|
|
95049
95049
|
method: 'POST'
|
|
95050
95050
|
queryParams: {}
|
|
95051
|
-
jsonBody: {
|
|
95052
|
-
commonParams: {
|
|
95051
|
+
jsonBody: {
|
|
95053
95052
|
/** ID of the encoder to use for encoding the access method. */
|
|
95054
95053
|
acs_encoder_id: string
|
|
95055
95054
|
/** ID of the access method to encode onto a card. */
|
|
95056
95055
|
access_method_id: string
|
|
95057
95056
|
}
|
|
95057
|
+
commonParams: {}
|
|
95058
95058
|
formData: {}
|
|
95059
95059
|
jsonResponse: {
|
|
95060
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.
|
|
@@ -97747,8 +97747,7 @@ export type Routes = {
|
|
|
97747
97747
|
route: '/seam/customer/v1/connectors/sync'
|
|
97748
97748
|
method: 'POST'
|
|
97749
97749
|
queryParams: {}
|
|
97750
|
-
jsonBody: {
|
|
97751
|
-
commonParams: {
|
|
97750
|
+
jsonBody: {
|
|
97752
97751
|
/** ID of the connector to sync */
|
|
97753
97752
|
connector_id: string
|
|
97754
97753
|
/** Type of the connector to sync */
|
|
@@ -97760,6 +97759,7 @@ export type Routes = {
|
|
|
97760
97759
|
/** Unique provider resource key of the connector to sync */
|
|
97761
97760
|
unique_provider_resource_key?: (string | null) | undefined
|
|
97762
97761
|
}
|
|
97762
|
+
commonParams: {}
|
|
97763
97763
|
formData: {}
|
|
97764
97764
|
jsonResponse: {
|
|
97765
97765
|
connector_sync: {
|
|
@@ -98097,11 +98097,11 @@ export type Routes = {
|
|
|
98097
98097
|
route: '/seam/customer/v1/customers/open_portal'
|
|
98098
98098
|
method: 'POST'
|
|
98099
98099
|
queryParams: {}
|
|
98100
|
-
jsonBody: {
|
|
98101
|
-
commonParams: {
|
|
98100
|
+
jsonBody: {
|
|
98102
98101
|
/** The customer key to open a portal for. */
|
|
98103
98102
|
customer_key: string
|
|
98104
98103
|
}
|
|
98104
|
+
commonParams: {}
|
|
98105
98105
|
formData: {}
|
|
98106
98106
|
jsonResponse: {
|
|
98107
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.
|
|
@@ -103105,8 +103105,7 @@ export type Routes = {
|
|
|
103105
103105
|
route: '/seam/customer/v1/spaces/push_common_areas'
|
|
103106
103106
|
method: 'POST'
|
|
103107
103107
|
queryParams: {}
|
|
103108
|
-
jsonBody: {
|
|
103109
|
-
commonParams: {
|
|
103108
|
+
jsonBody: {
|
|
103110
103109
|
common_areas?:
|
|
103111
103110
|
| {
|
|
103112
103111
|
name: string
|
|
@@ -103121,6 +103120,7 @@ export type Routes = {
|
|
|
103121
103120
|
}[]
|
|
103122
103121
|
| undefined
|
|
103123
103122
|
}
|
|
103123
|
+
commonParams: {}
|
|
103124
103124
|
formData: {}
|
|
103125
103125
|
jsonResponse: {}
|
|
103126
103126
|
maxDuration: undefined
|
|
@@ -132706,11 +132706,11 @@ export type Routes = {
|
|
|
132706
132706
|
route: '/unstable_partner/building_blocks/connect_accounts'
|
|
132707
132707
|
method: 'POST'
|
|
132708
132708
|
queryParams: {}
|
|
132709
|
-
jsonBody: {
|
|
132710
|
-
commonParams: {
|
|
132709
|
+
jsonBody: {
|
|
132711
132710
|
/** Customer key for which you want to connect accounts. */
|
|
132712
132711
|
customer_key: string
|
|
132713
132712
|
}
|
|
132713
|
+
commonParams: {}
|
|
132714
132714
|
formData: {}
|
|
132715
132715
|
jsonResponse: {
|
|
132716
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.
|
|
@@ -132806,11 +132806,11 @@ export type Routes = {
|
|
|
132806
132806
|
route: '/unstable_partner/building_blocks/manage_devices'
|
|
132807
132807
|
method: 'POST'
|
|
132808
132808
|
queryParams: {}
|
|
132809
|
-
jsonBody: {
|
|
132810
|
-
commonParams: {
|
|
132809
|
+
jsonBody: {
|
|
132811
132810
|
/** Customer key for which you want to manage devices. */
|
|
132812
132811
|
customer_key: string
|
|
132813
132812
|
}
|
|
132813
|
+
commonParams: {}
|
|
132814
132814
|
formData: {}
|
|
132815
132815
|
jsonResponse: {
|
|
132816
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.
|
|
@@ -132837,8 +132837,7 @@ export type Routes = {
|
|
|
132837
132837
|
route: '/unstable_partner/building_blocks/organize_spaces'
|
|
132838
132838
|
method: 'POST'
|
|
132839
132839
|
queryParams: {}
|
|
132840
|
-
jsonBody: {
|
|
132841
|
-
commonParams: {
|
|
132840
|
+
jsonBody: {
|
|
132842
132841
|
/** Customer key for which you want to organize spaces. */
|
|
132843
132842
|
customer_key: string
|
|
132844
132843
|
/** Optional list of spaces that you want to include in the new building block magic link. */
|
|
@@ -132877,6 +132876,7 @@ export type Routes = {
|
|
|
132877
132876
|
}[]
|
|
132878
132877
|
| undefined
|
|
132879
132878
|
}
|
|
132879
|
+
commonParams: {}
|
|
132880
132880
|
formData: {}
|
|
132881
132881
|
jsonResponse: {
|
|
132882
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.
|
|
@@ -132903,8 +132903,7 @@ export type Routes = {
|
|
|
132903
132903
|
route: '/user_identities/add_acs_user'
|
|
132904
132904
|
method: 'POST' | 'PUT'
|
|
132905
132905
|
queryParams: {}
|
|
132906
|
-
jsonBody: {
|
|
132907
|
-
commonParams: {
|
|
132906
|
+
jsonBody: {
|
|
132908
132907
|
/** ID of the user identity to which you want to add an access system user. */
|
|
132909
132908
|
user_identity_id?: string | undefined
|
|
132910
132909
|
/** Key of the user identity to which you want to add an access system user. */
|
|
@@ -132912,6 +132911,7 @@ export type Routes = {
|
|
|
132912
132911
|
/** ID of the access system user that you want to add to the user identity. */
|
|
132913
132912
|
acs_user_id: string
|
|
132914
132913
|
}
|
|
132914
|
+
commonParams: {}
|
|
132915
132915
|
formData: {}
|
|
132916
132916
|
jsonResponse: {}
|
|
132917
132917
|
maxDuration: undefined
|
|
@@ -132920,8 +132920,7 @@ export type Routes = {
|
|
|
132920
132920
|
route: '/user_identities/create'
|
|
132921
132921
|
method: 'POST'
|
|
132922
132922
|
queryParams: {}
|
|
132923
|
-
jsonBody: {
|
|
132924
|
-
commonParams: {
|
|
132923
|
+
jsonBody: {
|
|
132925
132924
|
/** Unique key for the new user identity. */
|
|
132926
132925
|
user_identity_key?: (string | null) | undefined
|
|
132927
132926
|
/** Unique email address for the new user identity. */
|
|
@@ -132933,6 +132932,7 @@ export type Routes = {
|
|
|
132933
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. */
|
|
132934
132933
|
acs_system_ids?: string[] | undefined
|
|
132935
132934
|
}
|
|
132935
|
+
commonParams: {}
|
|
132936
132936
|
formData: {}
|
|
132937
132937
|
jsonResponse: {
|
|
132938
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. */
|
|
@@ -133048,8 +133048,7 @@ export type Routes = {
|
|
|
133048
133048
|
route: '/user_identities/enrollment_automations/launch'
|
|
133049
133049
|
method: 'POST'
|
|
133050
133050
|
queryParams: {}
|
|
133051
|
-
jsonBody: {
|
|
133052
|
-
commonParams: {
|
|
133051
|
+
jsonBody: {
|
|
133053
133052
|
/** ID of the user identity for which you want to launch an enrollment automation. */
|
|
133054
133053
|
user_identity_id: string
|
|
133055
133054
|
/** ID of the desired access system that serves as the credential manager for the enrollment automation. */
|
|
@@ -133061,6 +133060,7 @@ export type Routes = {
|
|
|
133061
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`. */
|
|
133062
133061
|
credential_manager_acs_user_id?: string | undefined
|
|
133063
133062
|
}
|
|
133063
|
+
commonParams: {}
|
|
133064
133064
|
formData: {}
|
|
133065
133065
|
jsonResponse: {
|
|
133066
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/). */
|
|
@@ -133109,14 +133109,14 @@ export type Routes = {
|
|
|
133109
133109
|
route: '/user_identities/generate_instant_key'
|
|
133110
133110
|
method: 'POST'
|
|
133111
133111
|
queryParams: {}
|
|
133112
|
-
jsonBody: {
|
|
133113
|
-
commonParams: {
|
|
133112
|
+
jsonBody: {
|
|
133114
133113
|
customization_profile_id?: string | undefined
|
|
133115
133114
|
/** ID of the user identity for which you want to generate an instant key. */
|
|
133116
133115
|
user_identity_id: string
|
|
133117
133116
|
/** Maximum number of times the instant key can be used. Default: 1. */
|
|
133118
133117
|
max_use_count?: number
|
|
133119
133118
|
}
|
|
133119
|
+
commonParams: {}
|
|
133120
133120
|
formData: {}
|
|
133121
133121
|
jsonResponse: {
|
|
133122
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.
|
|
@@ -133229,13 +133229,13 @@ export type Routes = {
|
|
|
133229
133229
|
route: '/user_identities/grant_access_to_device'
|
|
133230
133230
|
method: 'PUT' | 'POST'
|
|
133231
133231
|
queryParams: {}
|
|
133232
|
-
jsonBody: {
|
|
133233
|
-
commonParams: {
|
|
133232
|
+
jsonBody: {
|
|
133234
133233
|
/** ID of the user identity that you want to grant access to a device. */
|
|
133235
133234
|
user_identity_id: string
|
|
133236
133235
|
/** ID of the managed device to which you want to grant access to the user identity. */
|
|
133237
133236
|
device_id: string
|
|
133238
133237
|
}
|
|
133238
|
+
commonParams: {}
|
|
133239
133239
|
formData: {}
|
|
133240
133240
|
jsonResponse: {}
|
|
133241
133241
|
maxDuration: undefined
|