@seamapi/types 1.490.0 → 1.492.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.
- package/dist/connect.cjs +80 -3
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +6643 -245
- package/dist/index.cjs +80 -3
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +10888 -2376
- package/lib/seam/connect/models/batch.js +5 -0
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customization_profiles/customization_profile.d.ts +2 -2
- package/lib/seam/connect/models/instant-keys/instant-key.d.ts +26 -0
- package/lib/seam/connect/models/instant-keys/instant-key.js +23 -0
- package/lib/seam/connect/models/instant-keys/instant-key.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +76 -0
- package/lib/seam/connect/openapi.js +65 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2201 -161
- package/package.json +1 -1
- package/src/lib/seam/connect/models/batch.ts +5 -0
- package/src/lib/seam/connect/models/instant-keys/instant-key.ts +25 -0
- package/src/lib/seam/connect/openapi.ts +68 -0
- package/src/lib/seam/connect/route-types.ts +3345 -1067
|
@@ -22179,690 +22179,1206 @@ export type Routes = {
|
|
|
22179
22179
|
user_identity_id: string
|
|
22180
22180
|
/** Date and time at which the Instant Key expires. */
|
|
22181
22181
|
expires_at: string
|
|
22182
|
-
|
|
22183
|
-
|
|
22184
|
-
|
|
22185
|
-
|
|
22186
|
-
}
|
|
22187
|
-
'/access_methods/list': {
|
|
22188
|
-
route: '/access_methods/list'
|
|
22189
|
-
method: 'GET' | 'POST'
|
|
22190
|
-
queryParams: {}
|
|
22191
|
-
jsonBody: {}
|
|
22192
|
-
commonParams: {
|
|
22193
|
-
/** ID of Access Grant to list access methods for. */
|
|
22194
|
-
access_grant_id: string
|
|
22195
|
-
/** ID of the device for which you want to retrieve all access methods. */
|
|
22196
|
-
device_id?: string | undefined
|
|
22197
|
-
/** ID of the entrance for which you want to retrieve all access methods. */
|
|
22198
|
-
acs_entrance_id?: string | undefined
|
|
22199
|
-
/** ID of the space for which you want to retrieve all access methods. */
|
|
22200
|
-
space_id?: string | undefined
|
|
22201
|
-
}
|
|
22202
|
-
formData: {}
|
|
22203
|
-
jsonResponse: {
|
|
22204
|
-
access_methods: {
|
|
22205
|
-
/** ID of the Seam workspace associated with the access method. */
|
|
22206
|
-
workspace_id: string
|
|
22207
|
-
/** ID of the access method. */
|
|
22208
|
-
access_method_id: string
|
|
22209
|
-
/** Display name of the access method. */
|
|
22210
|
-
display_name: string
|
|
22211
|
-
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
22212
|
-
mode: 'code' | 'card' | 'mobile_key'
|
|
22213
|
-
/** Date and time at which the access method was created. */
|
|
22214
|
-
created_at: string
|
|
22215
|
-
/** Date and time at which the access method was issued. */
|
|
22216
|
-
issued_at: string | null
|
|
22217
|
-
/** Indicates whether the access method has been issued. */
|
|
22218
|
-
is_issued: boolean
|
|
22219
|
-
/** URL of the Instant Key for mobile key access methods. */
|
|
22220
|
-
instant_key_url?: string | undefined
|
|
22221
|
-
/** Token of the client session associated with the access method. */
|
|
22222
|
-
client_session_token?: string | undefined
|
|
22223
|
-
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
22224
|
-
is_encoding_required?: boolean | undefined
|
|
22225
|
-
/** The actual PIN code for code access methods. */
|
|
22226
|
-
code?: string | undefined
|
|
22227
|
-
}[]
|
|
22228
|
-
}
|
|
22229
|
-
}
|
|
22230
|
-
'/acs/access_groups/add_user': {
|
|
22231
|
-
route: '/acs/access_groups/add_user'
|
|
22232
|
-
method: 'PUT' | 'POST'
|
|
22233
|
-
queryParams: {}
|
|
22234
|
-
jsonBody: {}
|
|
22235
|
-
commonParams: {
|
|
22236
|
-
/** ID of the access group to which you want to add an access system user. */
|
|
22237
|
-
acs_access_group_id: string
|
|
22238
|
-
/** 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. */
|
|
22239
|
-
acs_user_id?: string | undefined
|
|
22240
|
-
/** 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. */
|
|
22241
|
-
user_identity_id?: string | undefined
|
|
22242
|
-
}
|
|
22243
|
-
formData: {}
|
|
22244
|
-
jsonResponse: {}
|
|
22245
|
-
}
|
|
22246
|
-
'/acs/access_groups/get': {
|
|
22247
|
-
route: '/acs/access_groups/get'
|
|
22248
|
-
method: 'GET' | 'POST'
|
|
22249
|
-
queryParams: {}
|
|
22250
|
-
jsonBody: {}
|
|
22251
|
-
commonParams: {
|
|
22252
|
-
/** ID of the access group that you want to get. */
|
|
22253
|
-
acs_access_group_id: string
|
|
22254
|
-
}
|
|
22255
|
-
formData: {}
|
|
22256
|
-
jsonResponse: {
|
|
22257
|
-
/** Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
|
|
22258
|
-
|
|
22259
|
-
Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
22260
|
-
|
|
22261
|
-
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
|
|
22262
|
-
acs_access_group: {
|
|
22263
|
-
/** ID of the access group. */
|
|
22264
|
-
acs_access_group_id: string
|
|
22265
|
-
/** ID of the access control system that contains the access group. */
|
|
22266
|
-
acs_system_id: string
|
|
22267
|
-
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
22268
|
-
workspace_id: string
|
|
22269
|
-
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
22270
|
-
connected_account_id: string
|
|
22271
|
-
/** Name of the access group. */
|
|
22272
|
-
name: string
|
|
22273
|
-
/**
|
|
22274
|
-
* @deprecated Use `external_type`.*/
|
|
22275
|
-
access_group_type:
|
|
22276
|
-
| 'pti_unit'
|
|
22277
|
-
| 'pti_access_level'
|
|
22278
|
-
| 'salto_ks_access_group'
|
|
22279
|
-
| 'brivo_group'
|
|
22280
|
-
| 'salto_space_group'
|
|
22281
|
-
| 'dormakaba_community_access_group'
|
|
22282
|
-
/**
|
|
22283
|
-
* @deprecated Use `external_type_display_name`.*/
|
|
22284
|
-
access_group_type_display_name: string
|
|
22285
|
-
display_name: string
|
|
22286
|
-
/** Brand-specific terminology for the access group type. */
|
|
22287
|
-
external_type:
|
|
22288
|
-
| 'pti_unit'
|
|
22289
|
-
| 'pti_access_level'
|
|
22290
|
-
| 'salto_ks_access_group'
|
|
22291
|
-
| 'brivo_group'
|
|
22292
|
-
| 'salto_space_group'
|
|
22293
|
-
| 'dormakaba_community_access_group'
|
|
22294
|
-
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
22295
|
-
external_type_display_name: string
|
|
22296
|
-
/** Date and time at which the access group was created. */
|
|
22297
|
-
created_at: string
|
|
22298
|
-
/** Warnings associated with the `acs_access_group`. */
|
|
22299
|
-
warnings: {
|
|
22300
|
-
/** Date and time at which Seam created the warning. */
|
|
22301
|
-
created_at: string
|
|
22302
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22303
|
-
message: string
|
|
22304
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22305
|
-
warning_code: 'unknown_issue_with_acs_access_group'
|
|
22306
|
-
}[]
|
|
22307
|
-
is_managed: true
|
|
22308
|
-
}
|
|
22309
|
-
}
|
|
22310
|
-
}
|
|
22311
|
-
'/acs/access_groups/list': {
|
|
22312
|
-
route: '/acs/access_groups/list'
|
|
22313
|
-
method: 'GET' | 'POST'
|
|
22314
|
-
queryParams: {}
|
|
22315
|
-
jsonBody: {}
|
|
22316
|
-
commonParams: {
|
|
22317
|
-
/** ID of the access system for which you want to retrieve all access groups. */
|
|
22318
|
-
acs_system_id?: string | undefined
|
|
22319
|
-
/** ID of the access system user for which you want to retrieve all access groups. */
|
|
22320
|
-
acs_user_id?: string | undefined
|
|
22321
|
-
/** ID of the user identity for which you want to retrieve all access groups. */
|
|
22322
|
-
user_identity_id?: string | undefined
|
|
22323
|
-
}
|
|
22324
|
-
formData: {}
|
|
22325
|
-
jsonResponse: {
|
|
22326
|
-
acs_access_groups: {
|
|
22327
|
-
/** ID of the access group. */
|
|
22328
|
-
acs_access_group_id: string
|
|
22329
|
-
/** ID of the access control system that contains the access group. */
|
|
22330
|
-
acs_system_id: string
|
|
22331
|
-
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
22332
|
-
workspace_id: string
|
|
22333
|
-
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
22334
|
-
connected_account_id: string
|
|
22335
|
-
/** Name of the access group. */
|
|
22336
|
-
name: string
|
|
22337
|
-
/**
|
|
22338
|
-
* @deprecated Use `external_type`.*/
|
|
22339
|
-
access_group_type:
|
|
22340
|
-
| 'pti_unit'
|
|
22341
|
-
| 'pti_access_level'
|
|
22342
|
-
| 'salto_ks_access_group'
|
|
22343
|
-
| 'brivo_group'
|
|
22344
|
-
| 'salto_space_group'
|
|
22345
|
-
| 'dormakaba_community_access_group'
|
|
22346
|
-
/**
|
|
22347
|
-
* @deprecated Use `external_type_display_name`.*/
|
|
22348
|
-
access_group_type_display_name: string
|
|
22349
|
-
display_name: string
|
|
22350
|
-
/** Brand-specific terminology for the access group type. */
|
|
22351
|
-
external_type:
|
|
22352
|
-
| 'pti_unit'
|
|
22353
|
-
| 'pti_access_level'
|
|
22354
|
-
| 'salto_ks_access_group'
|
|
22355
|
-
| 'brivo_group'
|
|
22356
|
-
| 'salto_space_group'
|
|
22357
|
-
| 'dormakaba_community_access_group'
|
|
22358
|
-
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
22359
|
-
external_type_display_name: string
|
|
22360
|
-
/** Date and time at which the access group was created. */
|
|
22361
|
-
created_at: string
|
|
22362
|
-
/** Warnings associated with the `acs_access_group`. */
|
|
22363
|
-
warnings: {
|
|
22364
|
-
/** Date and time at which Seam created the warning. */
|
|
22365
|
-
created_at: string
|
|
22366
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22367
|
-
message: string
|
|
22368
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22369
|
-
warning_code: 'unknown_issue_with_acs_access_group'
|
|
22370
|
-
}[]
|
|
22371
|
-
is_managed: true
|
|
22372
|
-
}[]
|
|
22373
|
-
}
|
|
22374
|
-
}
|
|
22375
|
-
'/acs/access_groups/list_accessible_entrances': {
|
|
22376
|
-
route: '/acs/access_groups/list_accessible_entrances'
|
|
22377
|
-
method: 'GET' | 'POST'
|
|
22378
|
-
queryParams: {}
|
|
22379
|
-
jsonBody: {}
|
|
22380
|
-
commonParams: {
|
|
22381
|
-
/** ID of the access group for which you want to retrieve all accessible entrances. */
|
|
22382
|
-
acs_access_group_id: string
|
|
22383
|
-
}
|
|
22384
|
-
formData: {}
|
|
22385
|
-
jsonResponse: {
|
|
22386
|
-
acs_entrances: {
|
|
22387
|
-
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22388
|
-
acs_system_id: string
|
|
22389
|
-
/** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22390
|
-
acs_entrance_id: string
|
|
22391
|
-
/** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
|
|
22392
|
-
created_at: string
|
|
22393
|
-
/** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22394
|
-
display_name: string
|
|
22395
|
-
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22396
|
-
connected_account_id: string
|
|
22397
|
-
/** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22398
|
-
errors: {
|
|
22399
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22400
|
-
error_code: string
|
|
22401
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22402
|
-
message: string
|
|
22403
|
-
}[]
|
|
22404
|
-
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22405
|
-
latch_metadata?:
|
|
22406
|
-
| {
|
|
22407
|
-
/** Accessibility type in the Latch access system. */
|
|
22408
|
-
accessibility_type: string
|
|
22409
|
-
/** Name of the door in the Latch access system. */
|
|
22410
|
-
door_name: string
|
|
22411
|
-
/** Type of the door in the Latch access system. */
|
|
22412
|
-
door_type: string
|
|
22413
|
-
/** Indicates whether the entrance is connected. */
|
|
22414
|
-
is_connected: boolean
|
|
22415
|
-
}
|
|
22416
|
-
| undefined
|
|
22417
|
-
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22418
|
-
visionline_metadata?:
|
|
22419
|
-
| {
|
|
22420
|
-
/** Name of the door in the Visionline access system. */
|
|
22421
|
-
door_name: string
|
|
22422
|
-
/** Category of the door in the Visionline access system. */
|
|
22423
|
-
door_category:
|
|
22424
|
-
| 'entrance'
|
|
22425
|
-
| 'guest'
|
|
22426
|
-
| 'elevator reader'
|
|
22427
|
-
| 'common'
|
|
22428
|
-
| 'common (PMS)'
|
|
22429
|
-
/** Profile for the door in the Visionline access system. */
|
|
22430
|
-
profiles?:
|
|
22182
|
+
/** ID of the customization profile associated with the Instant Key. */
|
|
22183
|
+
customization_profile_id?: string | undefined
|
|
22184
|
+
/** Customization profile associated with the Instant Key. */
|
|
22185
|
+
customization_profile?:
|
|
22431
22186
|
| {
|
|
22432
|
-
/**
|
|
22433
|
-
|
|
22434
|
-
/**
|
|
22435
|
-
|
|
22436
|
-
|
|
22187
|
+
/** Primary color of the customization profile. */
|
|
22188
|
+
primary_color?: string | undefined
|
|
22189
|
+
/** Secondary color of the customization profile. */
|
|
22190
|
+
secondary_color?: string | undefined
|
|
22191
|
+
/** URL of the logo associated with the customization profile. */
|
|
22192
|
+
logo_url?: string | undefined
|
|
22193
|
+
}
|
|
22437
22194
|
| undefined
|
|
22438
|
-
}
|
|
22439
|
-
| undefined
|
|
22440
|
-
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22441
|
-
salto_ks_metadata?:
|
|
22442
|
-
| {
|
|
22443
|
-
/** Name of the door in the Salto KS access system. */
|
|
22444
|
-
door_name: string
|
|
22445
|
-
/** Locked state of the door in the Salto KS access system. */
|
|
22446
|
-
locked_state: string
|
|
22447
|
-
/** Type of the lock in the Salto KS access system. */
|
|
22448
|
-
lock_type: string
|
|
22449
|
-
/** Indicates whether the door access device is online. */
|
|
22450
|
-
online?: boolean | undefined
|
|
22451
|
-
/** Battery level of the door access device. */
|
|
22452
|
-
battery_level: string
|
|
22453
|
-
/** Indicates whether the door is left open. */
|
|
22454
|
-
left_open_alarm?: boolean | undefined
|
|
22455
|
-
/** Indicates whether an intrusion alarm is active on the door. */
|
|
22456
|
-
intrusion_alarm?: boolean | undefined
|
|
22457
|
-
/** Indicates whether privacy mode is enabled for the lock. */
|
|
22458
|
-
privacy_mode?: boolean | undefined
|
|
22459
|
-
}
|
|
22460
|
-
| undefined
|
|
22461
|
-
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22462
|
-
dormakaba_community_metadata?:
|
|
22463
|
-
| {
|
|
22464
|
-
/** Name of the access point in the dormakaba Community access system. */
|
|
22465
|
-
access_point_name: string
|
|
22466
|
-
}
|
|
22467
|
-
| undefined
|
|
22468
|
-
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22469
|
-
assa_abloy_vostio_metadata?:
|
|
22470
|
-
| {
|
|
22471
|
-
/** Type of the door in the Vostio access system. */
|
|
22472
|
-
door_type:
|
|
22473
|
-
| 'CommonDoor'
|
|
22474
|
-
| 'EntranceDoor'
|
|
22475
|
-
| 'GuestDoor'
|
|
22476
|
-
| 'Elevator'
|
|
22477
|
-
/** Name of the door in the Vostio access system. */
|
|
22478
|
-
door_name: string
|
|
22479
|
-
/** Number of the door in the Vostio access system. */
|
|
22480
|
-
door_number?: number | undefined
|
|
22481
|
-
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
22482
|
-
stand_open?: boolean | undefined
|
|
22483
|
-
/** PMS ID of the door in the Vostio access system. */
|
|
22484
|
-
pms_id?: string | undefined
|
|
22485
|
-
}
|
|
22486
|
-
| undefined
|
|
22487
|
-
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22488
|
-
salto_space_metadata?:
|
|
22489
|
-
| {
|
|
22490
|
-
/**
|
|
22491
|
-
* @deprecated use door_id.*/
|
|
22492
|
-
ext_door_id?: string | undefined
|
|
22493
|
-
/** Door ID in the Salto Space access system. */
|
|
22494
|
-
door_id?: string | undefined
|
|
22495
|
-
/** Name of the door in the Salto Space access system. */
|
|
22496
|
-
door_name?: string | undefined
|
|
22497
|
-
/** Description of the door in the Salto Space access system. */
|
|
22498
|
-
door_description?: string | undefined
|
|
22499
|
-
/** Name of the room in the Salto Space access system. */
|
|
22500
|
-
room_name?: string | undefined
|
|
22501
|
-
/** Description of the room in the Salto Space access system. */
|
|
22502
|
-
room_description?: string | undefined
|
|
22503
|
-
}
|
|
22504
|
-
| undefined
|
|
22505
|
-
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22506
|
-
dormakaba_ambiance_metadata?:
|
|
22507
|
-
| {
|
|
22508
|
-
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
22509
|
-
access_point_name: string
|
|
22510
|
-
}
|
|
22511
|
-
| undefined
|
|
22512
|
-
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
22513
|
-
can_unlock_with_mobile_key?: boolean | undefined
|
|
22514
|
-
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
22515
|
-
can_unlock_with_card?: boolean | undefined
|
|
22516
|
-
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
22517
|
-
can_unlock_with_code?: boolean | undefined
|
|
22518
|
-
}[]
|
|
22519
|
-
}
|
|
22520
|
-
}
|
|
22521
|
-
'/acs/access_groups/list_users': {
|
|
22522
|
-
route: '/acs/access_groups/list_users'
|
|
22523
|
-
method: 'GET' | 'POST'
|
|
22524
|
-
queryParams: {}
|
|
22525
|
-
jsonBody: {}
|
|
22526
|
-
commonParams: {
|
|
22527
|
-
/** ID of the access group for which you want to retrieve all access system users. */
|
|
22528
|
-
acs_access_group_id: string
|
|
22529
|
-
}
|
|
22530
|
-
formData: {}
|
|
22531
|
-
jsonResponse: {
|
|
22532
|
-
acs_users: {
|
|
22533
|
-
/** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
22534
|
-
acs_user_id: string
|
|
22535
|
-
/** ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
22536
|
-
acs_system_id: string
|
|
22537
|
-
hid_acs_system_id?: string | undefined
|
|
22538
|
-
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
22539
|
-
workspace_id: string
|
|
22540
|
-
/** Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. */
|
|
22541
|
-
created_at: string
|
|
22542
|
-
/** Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
22543
|
-
display_name: string
|
|
22544
|
-
/** Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. */
|
|
22545
|
-
external_type?:
|
|
22546
|
-
| (
|
|
22547
|
-
| 'pti_user'
|
|
22548
|
-
| 'brivo_user'
|
|
22549
|
-
| 'hid_credential_manager_user'
|
|
22550
|
-
| 'salto_site_user'
|
|
22551
|
-
| 'latch_user'
|
|
22552
|
-
| 'dormakaba_community_user'
|
|
22553
|
-
| 'salto_space_user'
|
|
22554
|
-
)
|
|
22555
|
-
| undefined
|
|
22556
|
-
/** Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. */
|
|
22557
|
-
external_type_display_name?: string | undefined
|
|
22558
|
-
/** Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
|
|
22559
|
-
is_suspended?: boolean | undefined
|
|
22560
|
-
/** `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. */
|
|
22561
|
-
access_schedule?:
|
|
22562
|
-
| {
|
|
22563
|
-
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
22564
|
-
starts_at: string
|
|
22565
|
-
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
22566
|
-
ends_at: string | null
|
|
22567
|
-
}
|
|
22195
|
+
}[]
|
|
22568
22196
|
| undefined
|
|
22569
|
-
|
|
22570
|
-
|
|
22571
|
-
|
|
22572
|
-
|
|
22573
|
-
|
|
22574
|
-
|
|
22575
|
-
|
|
22576
|
-
|
|
22577
|
-
|
|
22578
|
-
|
|
22579
|
-
|
|
22580
|
-
|
|
22581
|
-
|
|
22582
|
-
|
|
22583
|
-
|
|
22584
|
-
|
|
22585
|
-
|
|
22586
|
-
|
|
22587
|
-
/** Date and time at which
|
|
22588
|
-
created_at: string
|
|
22589
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22590
|
-
message: string
|
|
22591
|
-
warning_code: 'salto_ks_user_not_subscribed'
|
|
22592
|
-
}
|
|
22593
|
-
| {
|
|
22594
|
-
/** Date and time at which Seam created the warning. */
|
|
22595
|
-
created_at: string
|
|
22596
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22597
|
-
message: string
|
|
22598
|
-
warning_code: 'unknown_issue_with_acs_user'
|
|
22599
|
-
}
|
|
22600
|
-
| {
|
|
22601
|
-
/** Date and time at which Seam created the warning. */
|
|
22602
|
-
created_at: string
|
|
22603
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22604
|
-
message: string
|
|
22605
|
-
warning_code: 'latch_resident_user'
|
|
22606
|
-
}
|
|
22607
|
-
)[]
|
|
22608
|
-
/** Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
22609
|
-
errors: (
|
|
22610
|
-
| {
|
|
22611
|
-
/** Date and time at which Seam created the error. */
|
|
22612
|
-
created_at: string
|
|
22613
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22614
|
-
message: string
|
|
22615
|
-
error_code: 'deleted_externally'
|
|
22616
|
-
}
|
|
22617
|
-
| {
|
|
22618
|
-
/** Date and time at which Seam created the error. */
|
|
22619
|
-
created_at: string
|
|
22620
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22621
|
-
message: string
|
|
22622
|
-
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
22623
|
-
}
|
|
22624
|
-
| {
|
|
22625
|
-
/** Date and time at which Seam created the error. */
|
|
22626
|
-
created_at: string
|
|
22627
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22628
|
-
message: string
|
|
22629
|
-
error_code: 'failed_to_create_on_acs_system'
|
|
22630
|
-
}
|
|
22631
|
-
| {
|
|
22632
|
-
/** Date and time at which Seam created the error. */
|
|
22633
|
-
created_at: string
|
|
22634
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22635
|
-
message: string
|
|
22636
|
-
error_code: 'failed_to_update_on_acs_system'
|
|
22637
|
-
}
|
|
22638
|
-
| {
|
|
22639
|
-
/** Date and time at which Seam created the error. */
|
|
22640
|
-
created_at: string
|
|
22641
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22642
|
-
message: string
|
|
22643
|
-
error_code: 'failed_to_delete_on_acs_system'
|
|
22644
|
-
}
|
|
22645
|
-
| {
|
|
22646
|
-
/** Date and time at which Seam created the error. */
|
|
22197
|
+
access_codes?:
|
|
22198
|
+
| {
|
|
22199
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
22200
|
+
common_code_key: string | null
|
|
22201
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
22202
|
+
is_scheduled_on_device?: boolean | undefined
|
|
22203
|
+
/** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
|
|
22204
|
+
type: 'time_bound' | 'ongoing'
|
|
22205
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
22206
|
+
is_waiting_for_code_assignment?: boolean | undefined
|
|
22207
|
+
/** Unique identifier for the access code. */
|
|
22208
|
+
access_code_id: string
|
|
22209
|
+
/** Unique identifier for the device associated with the access code. */
|
|
22210
|
+
device_id: string
|
|
22211
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
22212
|
+
name: string | null
|
|
22213
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
22214
|
+
code: string | null
|
|
22215
|
+
/** Date and time at which the access code was created. */
|
|
22647
22216
|
created_at: string
|
|
22648
|
-
/**
|
|
22649
|
-
|
|
22650
|
-
|
|
22651
|
-
|
|
22652
|
-
|
|
22653
|
-
|
|
22654
|
-
|
|
22655
|
-
|
|
22656
|
-
|
|
22657
|
-
|
|
22658
|
-
|
|
22659
|
-
/** Detailed description of the mutation. */
|
|
22660
|
-
message: string
|
|
22661
|
-
/** Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system. */
|
|
22662
|
-
mutation_code: 'creating'
|
|
22663
|
-
}
|
|
22664
|
-
| {
|
|
22665
|
-
/** Date and time at which the mutation was created. */
|
|
22666
|
-
created_at: string
|
|
22667
|
-
/** Detailed description of the mutation. */
|
|
22668
|
-
message: string
|
|
22669
|
-
/** Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system. */
|
|
22670
|
-
mutation_code: 'deleting'
|
|
22671
|
-
}
|
|
22672
|
-
| {
|
|
22673
|
-
/** Date and time at which the mutation was created. */
|
|
22674
|
-
created_at: string
|
|
22675
|
-
/** Detailed description of the mutation. */
|
|
22676
|
-
message: string
|
|
22677
|
-
/** Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system. */
|
|
22678
|
-
mutation_code: 'updating_user_information'
|
|
22679
|
-
/** Old access system user information. */
|
|
22680
|
-
from: {
|
|
22681
|
-
/** Email address of the access system user. */
|
|
22682
|
-
email_address?: (string | null) | undefined
|
|
22683
|
-
/** Full name of the access system user. */
|
|
22684
|
-
full_name?: (string | null) | undefined
|
|
22685
|
-
/** Phone number of the access system user. */
|
|
22686
|
-
phone_number?: ((string | undefined) | null) | undefined
|
|
22217
|
+
/** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
22218
|
+
errors: (
|
|
22219
|
+
| {
|
|
22220
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22221
|
+
message: string
|
|
22222
|
+
/** Indicates that this is an access code error. */
|
|
22223
|
+
is_access_code_error: true
|
|
22224
|
+
/** Date and time at which Seam created the error. */
|
|
22225
|
+
created_at?: string | undefined
|
|
22226
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22227
|
+
error_code: 'smartthings_failed_to_set_access_code'
|
|
22687
22228
|
}
|
|
22688
|
-
|
|
22689
|
-
|
|
22690
|
-
|
|
22691
|
-
|
|
22692
|
-
|
|
22693
|
-
|
|
22694
|
-
|
|
22695
|
-
|
|
22229
|
+
| {
|
|
22230
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22231
|
+
message: string
|
|
22232
|
+
/** Indicates that this is an access code error. */
|
|
22233
|
+
is_access_code_error: true
|
|
22234
|
+
/** Date and time at which Seam created the error. */
|
|
22235
|
+
created_at?: string | undefined
|
|
22236
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22237
|
+
error_code: 'smartthings_failed_to_set_after_multiple_retries'
|
|
22696
22238
|
}
|
|
22697
|
-
|
|
22698
|
-
|
|
22699
|
-
|
|
22700
|
-
|
|
22701
|
-
|
|
22702
|
-
|
|
22703
|
-
|
|
22704
|
-
|
|
22705
|
-
|
|
22706
|
-
from: {
|
|
22707
|
-
/** Starting time for the access schedule. */
|
|
22708
|
-
starts_at: string | null
|
|
22709
|
-
/** Starting time for the access schedule. */
|
|
22710
|
-
ends_at: string | null
|
|
22239
|
+
| {
|
|
22240
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22241
|
+
message: string
|
|
22242
|
+
/** Indicates that this is an access code error. */
|
|
22243
|
+
is_access_code_error: true
|
|
22244
|
+
/** Date and time at which Seam created the error. */
|
|
22245
|
+
created_at?: string | undefined
|
|
22246
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22247
|
+
error_code: 'smartthings_no_free_slots_available'
|
|
22711
22248
|
}
|
|
22712
|
-
|
|
22713
|
-
|
|
22714
|
-
|
|
22715
|
-
|
|
22716
|
-
|
|
22717
|
-
|
|
22249
|
+
| {
|
|
22250
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22251
|
+
message: string
|
|
22252
|
+
/** Indicates that this is an access code error. */
|
|
22253
|
+
is_access_code_error: true
|
|
22254
|
+
/** Date and time at which Seam created the error. */
|
|
22255
|
+
created_at?: string | undefined
|
|
22256
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22257
|
+
error_code: 'failed_to_set_on_device'
|
|
22718
22258
|
}
|
|
22719
|
-
|
|
22720
|
-
|
|
22721
|
-
|
|
22722
|
-
|
|
22723
|
-
|
|
22724
|
-
|
|
22725
|
-
|
|
22726
|
-
|
|
22727
|
-
|
|
22728
|
-
from: {
|
|
22729
|
-
is_suspended: boolean
|
|
22259
|
+
| {
|
|
22260
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22261
|
+
message: string
|
|
22262
|
+
/** Indicates that this is an access code error. */
|
|
22263
|
+
is_access_code_error: true
|
|
22264
|
+
/** Date and time at which Seam created the error. */
|
|
22265
|
+
created_at?: string | undefined
|
|
22266
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22267
|
+
error_code: 'failed_to_remove_from_device'
|
|
22730
22268
|
}
|
|
22731
|
-
|
|
22732
|
-
|
|
22733
|
-
|
|
22269
|
+
| {
|
|
22270
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22271
|
+
message: string
|
|
22272
|
+
/** Indicates that this is an access code error. */
|
|
22273
|
+
is_access_code_error: true
|
|
22274
|
+
/** Date and time at which Seam created the error. */
|
|
22275
|
+
created_at?: string | undefined
|
|
22276
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22277
|
+
error_code: 'duplicate_code_on_device'
|
|
22734
22278
|
}
|
|
22735
|
-
|
|
22736
|
-
|
|
22737
|
-
|
|
22738
|
-
|
|
22739
|
-
|
|
22740
|
-
|
|
22741
|
-
|
|
22742
|
-
|
|
22743
|
-
|
|
22744
|
-
from: {
|
|
22745
|
-
/** Old access group ID. */
|
|
22746
|
-
acs_access_group_id: string | null
|
|
22279
|
+
| {
|
|
22280
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22281
|
+
message: string
|
|
22282
|
+
/** Indicates that this is an access code error. */
|
|
22283
|
+
is_access_code_error: true
|
|
22284
|
+
/** Date and time at which Seam created the error. */
|
|
22285
|
+
created_at?: string | undefined
|
|
22286
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22287
|
+
error_code: 'duplicate_code_attempt_prevented'
|
|
22747
22288
|
}
|
|
22748
|
-
|
|
22749
|
-
|
|
22750
|
-
|
|
22751
|
-
|
|
22289
|
+
| {
|
|
22290
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22291
|
+
message: string
|
|
22292
|
+
/** Indicates that this is an access code error. */
|
|
22293
|
+
is_access_code_error: true
|
|
22294
|
+
/** Date and time at which Seam created the error. */
|
|
22295
|
+
created_at?: string | undefined
|
|
22296
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22297
|
+
error_code: 'no_space_for_access_code_on_device'
|
|
22752
22298
|
}
|
|
22753
|
-
|
|
22754
|
-
|
|
22299
|
+
| {
|
|
22300
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22301
|
+
message: string
|
|
22302
|
+
/** Indicates that this is an access code error. */
|
|
22303
|
+
is_access_code_error: true
|
|
22304
|
+
/** Date and time at which Seam created the error. */
|
|
22305
|
+
created_at?: string | undefined
|
|
22306
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22307
|
+
error_code: 'igloohome_bridge_too_many_pending_jobs'
|
|
22308
|
+
}
|
|
22309
|
+
| {
|
|
22310
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22311
|
+
message: string
|
|
22312
|
+
/** Indicates that this is an access code error. */
|
|
22313
|
+
is_access_code_error: true
|
|
22314
|
+
/** Date and time at which Seam created the error. */
|
|
22315
|
+
created_at?: string | undefined
|
|
22316
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22317
|
+
error_code: 'igloohome_bridge_offline'
|
|
22318
|
+
}
|
|
22319
|
+
| {
|
|
22320
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22321
|
+
message: string
|
|
22322
|
+
/** Indicates that this is an access code error. */
|
|
22323
|
+
is_access_code_error: true
|
|
22324
|
+
/** Date and time at which Seam created the error. */
|
|
22325
|
+
created_at?: string | undefined
|
|
22326
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22327
|
+
error_code: 'igloohome_offline_access_code_no_variance_available'
|
|
22328
|
+
}
|
|
22329
|
+
| {
|
|
22330
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22331
|
+
message: string
|
|
22332
|
+
/** Indicates that this is an access code error. */
|
|
22333
|
+
is_access_code_error: true
|
|
22334
|
+
/** Date and time at which Seam created the error. */
|
|
22335
|
+
created_at?: string | undefined
|
|
22336
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22337
|
+
error_code: 'kwikset_unable_to_confirm_code'
|
|
22338
|
+
}
|
|
22339
|
+
| {
|
|
22340
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22341
|
+
message: string
|
|
22342
|
+
/** Indicates that this is an access code error. */
|
|
22343
|
+
is_access_code_error: true
|
|
22344
|
+
/** Date and time at which Seam created the error. */
|
|
22345
|
+
created_at?: string | undefined
|
|
22346
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22347
|
+
error_code: 'kwikset_unable_to_confirm_deletion'
|
|
22348
|
+
}
|
|
22349
|
+
| {
|
|
22350
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22351
|
+
message: string
|
|
22352
|
+
/** Indicates that this is an access code error. */
|
|
22353
|
+
is_access_code_error: true
|
|
22354
|
+
/** Date and time at which Seam created the error. */
|
|
22355
|
+
created_at?: string | undefined
|
|
22356
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22357
|
+
error_code: 'code_modified_external_to_seam'
|
|
22358
|
+
}
|
|
22359
|
+
| {
|
|
22360
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22361
|
+
message: string
|
|
22362
|
+
/** Indicates that this is an access code error. */
|
|
22363
|
+
is_access_code_error: true
|
|
22364
|
+
/** Date and time at which Seam created the error. */
|
|
22365
|
+
created_at?: string | undefined
|
|
22366
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22367
|
+
error_code: 'august_lock_invalid_code_length'
|
|
22368
|
+
}
|
|
22369
|
+
| {
|
|
22370
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22371
|
+
message: string
|
|
22372
|
+
/** Indicates that this is an access code error. */
|
|
22373
|
+
is_access_code_error: true
|
|
22374
|
+
/** Date and time at which Seam created the error. */
|
|
22375
|
+
created_at?: string | undefined
|
|
22376
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22377
|
+
error_code: 'august_device_programming_delay'
|
|
22378
|
+
}
|
|
22379
|
+
| {
|
|
22380
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22381
|
+
message: string
|
|
22382
|
+
/** Indicates that this is an access code error. */
|
|
22383
|
+
is_access_code_error: true
|
|
22384
|
+
/** Date and time at which Seam created the error. */
|
|
22385
|
+
created_at?: string | undefined
|
|
22386
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22387
|
+
error_code: 'august_device_slots_full'
|
|
22388
|
+
}
|
|
22389
|
+
| {
|
|
22390
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22391
|
+
message: string
|
|
22392
|
+
/** Indicates that this is an access code error. */
|
|
22393
|
+
is_access_code_error: true
|
|
22394
|
+
/** Date and time at which Seam created the error. */
|
|
22395
|
+
created_at?: string | undefined
|
|
22396
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22397
|
+
error_code: 'august_lock_missing_keypad'
|
|
22398
|
+
}
|
|
22399
|
+
| {
|
|
22400
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22401
|
+
message: string
|
|
22402
|
+
/** Indicates that this is an access code error. */
|
|
22403
|
+
is_access_code_error: true
|
|
22404
|
+
/** Date and time at which Seam created the error. */
|
|
22405
|
+
created_at?: string | undefined
|
|
22406
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22407
|
+
error_code: 'august_lock_temporarily_offline'
|
|
22408
|
+
}
|
|
22409
|
+
| {
|
|
22410
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22411
|
+
message: string
|
|
22412
|
+
/** Indicates that this is an access code error. */
|
|
22413
|
+
is_access_code_error: true
|
|
22414
|
+
/** Date and time at which Seam created the error. */
|
|
22415
|
+
created_at?: string | undefined
|
|
22416
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22417
|
+
error_code: 'salto_ks_user_not_subscribed'
|
|
22418
|
+
}
|
|
22419
|
+
| {
|
|
22420
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22421
|
+
message: string
|
|
22422
|
+
/** Indicates that this is an access code error. */
|
|
22423
|
+
is_access_code_error: true
|
|
22424
|
+
/** Date and time at which Seam created the error. */
|
|
22425
|
+
created_at?: string | undefined
|
|
22426
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22427
|
+
error_code: 'hubitat_device_programming_delay'
|
|
22428
|
+
}
|
|
22429
|
+
| {
|
|
22430
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22431
|
+
message: string
|
|
22432
|
+
/** Indicates that this is an access code error. */
|
|
22433
|
+
is_access_code_error: true
|
|
22434
|
+
/** Date and time at which Seam created the error. */
|
|
22435
|
+
created_at?: string | undefined
|
|
22436
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22437
|
+
error_code: 'hubitat_no_free_positions_available'
|
|
22438
|
+
}
|
|
22439
|
+
| {
|
|
22440
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22441
|
+
message: string
|
|
22442
|
+
/** Indicates that this is an access code error. */
|
|
22443
|
+
is_access_code_error: true
|
|
22444
|
+
/** Date and time at which Seam created the error. */
|
|
22445
|
+
created_at?: string | undefined
|
|
22446
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22447
|
+
error_code: 'wyze_duplicate_code_name'
|
|
22448
|
+
}
|
|
22449
|
+
| {
|
|
22450
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22451
|
+
message: string
|
|
22452
|
+
/** Indicates that this is an access code error. */
|
|
22453
|
+
is_access_code_error: true
|
|
22454
|
+
/** Date and time at which Seam created the error. */
|
|
22455
|
+
created_at?: string | undefined
|
|
22456
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22457
|
+
error_code: 'wyze_potential_duplicate_code'
|
|
22458
|
+
}
|
|
22459
|
+
| {
|
|
22460
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22461
|
+
message: string
|
|
22462
|
+
/** Indicates that this is an access code error. */
|
|
22463
|
+
is_access_code_error: true
|
|
22464
|
+
/** Date and time at which Seam created the error. */
|
|
22465
|
+
created_at?: string | undefined
|
|
22466
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22467
|
+
error_code: 'dormakaba_oracode_no_valid_user_level'
|
|
22468
|
+
}
|
|
22469
|
+
| {
|
|
22470
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22471
|
+
message: string
|
|
22472
|
+
/** Indicates that the error is not a device error. */
|
|
22473
|
+
is_device_error: false
|
|
22474
|
+
/** Date and time at which Seam created the error. */
|
|
22475
|
+
created_at: string
|
|
22476
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22477
|
+
error_code: 'account_disconnected'
|
|
22478
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
22479
|
+
is_connected_account_error: true
|
|
22480
|
+
}
|
|
22481
|
+
| {
|
|
22482
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22483
|
+
message: string
|
|
22484
|
+
/** Indicates that the error is not a device error. */
|
|
22485
|
+
is_device_error: false
|
|
22486
|
+
/** Date and time at which Seam created the error. */
|
|
22487
|
+
created_at: string
|
|
22488
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22489
|
+
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
22490
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
22491
|
+
is_connected_account_error: true
|
|
22492
|
+
}
|
|
22493
|
+
| {
|
|
22494
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22495
|
+
message: string
|
|
22496
|
+
/** Indicates that the error is a device error. */
|
|
22497
|
+
is_device_error: true
|
|
22498
|
+
/** Date and time at which Seam created the error. */
|
|
22499
|
+
created_at: string
|
|
22500
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22501
|
+
error_code: 'device_offline'
|
|
22502
|
+
}
|
|
22503
|
+
| {
|
|
22504
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22505
|
+
message: string
|
|
22506
|
+
/** Indicates that the error is a device error. */
|
|
22507
|
+
is_device_error: true
|
|
22508
|
+
/** Date and time at which Seam created the error. */
|
|
22509
|
+
created_at: string
|
|
22510
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22511
|
+
error_code: 'device_removed'
|
|
22512
|
+
}
|
|
22513
|
+
| {
|
|
22514
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22515
|
+
message: string
|
|
22516
|
+
/** Indicates that the error is a device error. */
|
|
22517
|
+
is_device_error: true
|
|
22518
|
+
/** Date and time at which Seam created the error. */
|
|
22519
|
+
created_at: string
|
|
22520
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22521
|
+
error_code: 'hub_disconnected'
|
|
22522
|
+
}
|
|
22523
|
+
| {
|
|
22524
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22525
|
+
message: string
|
|
22526
|
+
/** Indicates that the error is a device error. */
|
|
22527
|
+
is_device_error: true
|
|
22528
|
+
/** Date and time at which Seam created the error. */
|
|
22529
|
+
created_at: string
|
|
22530
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22531
|
+
error_code: 'device_disconnected'
|
|
22532
|
+
}
|
|
22533
|
+
| {
|
|
22534
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22535
|
+
message: string
|
|
22536
|
+
/** Indicates that the error is a device error. */
|
|
22537
|
+
is_device_error: true
|
|
22538
|
+
/** Date and time at which Seam created the error. */
|
|
22539
|
+
created_at: string
|
|
22540
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22541
|
+
error_code: 'empty_backup_access_code_pool'
|
|
22542
|
+
}
|
|
22543
|
+
| {
|
|
22544
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22545
|
+
message: string
|
|
22546
|
+
/** Indicates that the error is a device error. */
|
|
22547
|
+
is_device_error: true
|
|
22548
|
+
/** Date and time at which Seam created the error. */
|
|
22549
|
+
created_at: string
|
|
22550
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22551
|
+
error_code: 'august_lock_not_authorized'
|
|
22552
|
+
}
|
|
22553
|
+
| {
|
|
22554
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22555
|
+
message: string
|
|
22556
|
+
/** Indicates that the error is a device error. */
|
|
22557
|
+
is_device_error: true
|
|
22558
|
+
/** Date and time at which Seam created the error. */
|
|
22559
|
+
created_at: string
|
|
22560
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22561
|
+
error_code: 'august_lock_missing_bridge'
|
|
22562
|
+
}
|
|
22563
|
+
| {
|
|
22564
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22565
|
+
message: string
|
|
22566
|
+
/** Indicates that the error is a device error. */
|
|
22567
|
+
is_device_error: true
|
|
22568
|
+
/** Date and time at which Seam created the error. */
|
|
22569
|
+
created_at: string
|
|
22570
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22571
|
+
error_code: 'ttlock_lock_not_paired_to_gateway'
|
|
22572
|
+
}
|
|
22573
|
+
| {
|
|
22574
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22575
|
+
message: string
|
|
22576
|
+
/** Indicates that the error is a device error. */
|
|
22577
|
+
is_device_error: true
|
|
22578
|
+
/** Date and time at which Seam created the error. */
|
|
22579
|
+
created_at: string
|
|
22580
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22581
|
+
error_code: 'missing_device_credentials'
|
|
22582
|
+
}
|
|
22583
|
+
| {
|
|
22584
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22585
|
+
message: string
|
|
22586
|
+
/** Indicates that the error is a device error. */
|
|
22587
|
+
is_device_error: true
|
|
22588
|
+
/** Date and time at which Seam created the error. */
|
|
22589
|
+
created_at: string
|
|
22590
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22591
|
+
error_code: 'auxiliary_heat_running'
|
|
22592
|
+
}
|
|
22593
|
+
| {
|
|
22594
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22595
|
+
message: string
|
|
22596
|
+
/** Indicates that the error is a device error. */
|
|
22597
|
+
is_device_error: true
|
|
22598
|
+
/** Date and time at which Seam created the error. */
|
|
22599
|
+
created_at: string
|
|
22600
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22601
|
+
error_code: 'subscription_required'
|
|
22602
|
+
}
|
|
22603
|
+
| {
|
|
22604
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22605
|
+
message: string
|
|
22606
|
+
/** Indicates that the error is a device error. */
|
|
22607
|
+
is_device_error: true
|
|
22608
|
+
/** Date and time at which Seam created the error. */
|
|
22609
|
+
created_at: string
|
|
22610
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22611
|
+
error_code: 'lockly_missing_wifi_bridge'
|
|
22612
|
+
}
|
|
22613
|
+
| {
|
|
22614
|
+
/** Date and time at which Seam created the error. */
|
|
22615
|
+
created_at: string
|
|
22616
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22617
|
+
message: string
|
|
22618
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
22619
|
+
is_connected_account_error?: boolean | undefined
|
|
22620
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
22621
|
+
is_bridge_error?: boolean | undefined
|
|
22622
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22623
|
+
error_code: 'invalid_credentials'
|
|
22624
|
+
}
|
|
22625
|
+
| {
|
|
22626
|
+
/** Date and time at which Seam created the error. */
|
|
22627
|
+
created_at: string
|
|
22628
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22629
|
+
message: string
|
|
22630
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
22631
|
+
is_connected_account_error?: boolean | undefined
|
|
22632
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
22633
|
+
is_bridge_error?: boolean | undefined
|
|
22634
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22635
|
+
error_code: 'bridge_disconnected'
|
|
22636
|
+
}
|
|
22637
|
+
)[]
|
|
22638
|
+
/** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
22639
|
+
warnings: (
|
|
22640
|
+
| {
|
|
22641
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22642
|
+
message: string
|
|
22643
|
+
/** Date and time at which Seam created the warning. */
|
|
22644
|
+
created_at?: string | undefined
|
|
22645
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22646
|
+
warning_code: 'smartthings_failed_to_set_access_code'
|
|
22647
|
+
}
|
|
22648
|
+
| {
|
|
22649
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22650
|
+
message: string
|
|
22651
|
+
/** Date and time at which Seam created the warning. */
|
|
22652
|
+
created_at?: string | undefined
|
|
22653
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22654
|
+
warning_code: 'schlage_detected_duplicate'
|
|
22655
|
+
}
|
|
22656
|
+
| {
|
|
22657
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22658
|
+
message: string
|
|
22659
|
+
/** Date and time at which Seam created the warning. */
|
|
22660
|
+
created_at?: string | undefined
|
|
22661
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22662
|
+
warning_code: 'schlage_creation_outage'
|
|
22663
|
+
}
|
|
22664
|
+
| {
|
|
22665
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22666
|
+
message: string
|
|
22667
|
+
/** Date and time at which Seam created the warning. */
|
|
22668
|
+
created_at?: string | undefined
|
|
22669
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22670
|
+
warning_code: 'code_modified_external_to_seam'
|
|
22671
|
+
}
|
|
22672
|
+
| {
|
|
22673
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22674
|
+
message: string
|
|
22675
|
+
/** Date and time at which Seam created the warning. */
|
|
22676
|
+
created_at?: string | undefined
|
|
22677
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22678
|
+
warning_code: 'delay_in_setting_on_device'
|
|
22679
|
+
}
|
|
22680
|
+
| {
|
|
22681
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22682
|
+
message: string
|
|
22683
|
+
/** Date and time at which Seam created the warning. */
|
|
22684
|
+
created_at?: string | undefined
|
|
22685
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22686
|
+
warning_code: 'delay_in_removing_from_device'
|
|
22687
|
+
}
|
|
22688
|
+
| {
|
|
22689
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22690
|
+
message: string
|
|
22691
|
+
/** Date and time at which Seam created the warning. */
|
|
22692
|
+
created_at?: string | undefined
|
|
22693
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22694
|
+
warning_code: 'third_party_integration_detected'
|
|
22695
|
+
}
|
|
22696
|
+
| {
|
|
22697
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22698
|
+
message: string
|
|
22699
|
+
/** Date and time at which Seam created the warning. */
|
|
22700
|
+
created_at?: string | undefined
|
|
22701
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22702
|
+
warning_code: 'august_device_programming_delay'
|
|
22703
|
+
}
|
|
22704
|
+
| {
|
|
22705
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22706
|
+
message: string
|
|
22707
|
+
/** Date and time at which Seam created the warning. */
|
|
22708
|
+
created_at?: string | undefined
|
|
22709
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22710
|
+
warning_code: 'august_lock_temporarily_offline'
|
|
22711
|
+
}
|
|
22712
|
+
| {
|
|
22713
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22714
|
+
message: string
|
|
22715
|
+
/** Date and time at which Seam created the warning. */
|
|
22716
|
+
created_at?: string | undefined
|
|
22717
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22718
|
+
warning_code: 'igloo_algopin_must_be_used_within_24_hours'
|
|
22719
|
+
}
|
|
22720
|
+
| {
|
|
22721
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22722
|
+
message: string
|
|
22723
|
+
/** Date and time at which Seam created the warning. */
|
|
22724
|
+
created_at?: string | undefined
|
|
22725
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22726
|
+
warning_code: 'management_transferred'
|
|
22727
|
+
}
|
|
22728
|
+
| {
|
|
22729
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22730
|
+
message: string
|
|
22731
|
+
/** Date and time at which Seam created the warning. */
|
|
22732
|
+
created_at?: string | undefined
|
|
22733
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22734
|
+
warning_code: 'kwikset_unable_to_confirm_code'
|
|
22735
|
+
}
|
|
22736
|
+
)[]
|
|
22737
|
+
/** Indicates whether Seam manages the access code. */
|
|
22738
|
+
is_managed: true
|
|
22739
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
22740
|
+
starts_at?: (string | null) | undefined
|
|
22741
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
22742
|
+
ends_at?: (string | null) | undefined
|
|
22743
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
22744
|
+
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
22745
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
22746
|
+
is_backup_access_code_available: boolean
|
|
22747
|
+
/** Indicates whether the access code is a backup code. */
|
|
22748
|
+
is_backup?: boolean | undefined
|
|
22749
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
22750
|
+
pulled_backup_access_code_id?: (string | null) | undefined
|
|
22751
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
22752
|
+
is_external_modification_allowed: boolean
|
|
22753
|
+
/** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
22754
|
+
is_one_time_use: boolean
|
|
22755
|
+
/** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
|
|
22756
|
+
is_offline_access_code: boolean
|
|
22757
|
+
}[]
|
|
22758
|
+
| undefined
|
|
22759
|
+
unmanaged_access_codes?:
|
|
22760
|
+
| {
|
|
22761
|
+
/** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
|
|
22762
|
+
type: 'time_bound' | 'ongoing'
|
|
22763
|
+
/** Unique identifier for the access code. */
|
|
22764
|
+
access_code_id: string
|
|
22765
|
+
/** Unique identifier for the device associated with the access code. */
|
|
22766
|
+
device_id: string
|
|
22767
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
22768
|
+
name: string | null
|
|
22769
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
22770
|
+
code: string | null
|
|
22771
|
+
/** Date and time at which the access code was created. */
|
|
22772
|
+
created_at: string
|
|
22773
|
+
/** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
22774
|
+
errors: (
|
|
22775
|
+
| {
|
|
22776
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22777
|
+
message: string
|
|
22778
|
+
/** Indicates that this is an access code error. */
|
|
22779
|
+
is_access_code_error: true
|
|
22780
|
+
/** Date and time at which Seam created the error. */
|
|
22781
|
+
created_at?: string | undefined
|
|
22782
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22783
|
+
error_code: 'smartthings_failed_to_set_access_code'
|
|
22784
|
+
}
|
|
22785
|
+
| {
|
|
22786
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22787
|
+
message: string
|
|
22788
|
+
/** Indicates that this is an access code error. */
|
|
22789
|
+
is_access_code_error: true
|
|
22790
|
+
/** Date and time at which Seam created the error. */
|
|
22791
|
+
created_at?: string | undefined
|
|
22792
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22793
|
+
error_code: 'smartthings_failed_to_set_after_multiple_retries'
|
|
22794
|
+
}
|
|
22795
|
+
| {
|
|
22796
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22797
|
+
message: string
|
|
22798
|
+
/** Indicates that this is an access code error. */
|
|
22799
|
+
is_access_code_error: true
|
|
22800
|
+
/** Date and time at which Seam created the error. */
|
|
22801
|
+
created_at?: string | undefined
|
|
22802
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22803
|
+
error_code: 'smartthings_no_free_slots_available'
|
|
22804
|
+
}
|
|
22805
|
+
| {
|
|
22806
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22807
|
+
message: string
|
|
22808
|
+
/** Indicates that this is an access code error. */
|
|
22809
|
+
is_access_code_error: true
|
|
22810
|
+
/** Date and time at which Seam created the error. */
|
|
22811
|
+
created_at?: string | undefined
|
|
22812
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22813
|
+
error_code: 'failed_to_set_on_device'
|
|
22814
|
+
}
|
|
22815
|
+
| {
|
|
22816
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22817
|
+
message: string
|
|
22818
|
+
/** Indicates that this is an access code error. */
|
|
22819
|
+
is_access_code_error: true
|
|
22820
|
+
/** Date and time at which Seam created the error. */
|
|
22821
|
+
created_at?: string | undefined
|
|
22822
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22823
|
+
error_code: 'failed_to_remove_from_device'
|
|
22824
|
+
}
|
|
22825
|
+
| {
|
|
22826
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22827
|
+
message: string
|
|
22828
|
+
/** Indicates that this is an access code error. */
|
|
22829
|
+
is_access_code_error: true
|
|
22830
|
+
/** Date and time at which Seam created the error. */
|
|
22831
|
+
created_at?: string | undefined
|
|
22832
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22833
|
+
error_code: 'duplicate_code_on_device'
|
|
22834
|
+
}
|
|
22835
|
+
| {
|
|
22836
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22837
|
+
message: string
|
|
22838
|
+
/** Indicates that this is an access code error. */
|
|
22839
|
+
is_access_code_error: true
|
|
22840
|
+
/** Date and time at which Seam created the error. */
|
|
22841
|
+
created_at?: string | undefined
|
|
22842
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22843
|
+
error_code: 'duplicate_code_attempt_prevented'
|
|
22844
|
+
}
|
|
22845
|
+
| {
|
|
22846
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22847
|
+
message: string
|
|
22848
|
+
/** Indicates that this is an access code error. */
|
|
22849
|
+
is_access_code_error: true
|
|
22850
|
+
/** Date and time at which Seam created the error. */
|
|
22851
|
+
created_at?: string | undefined
|
|
22852
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22853
|
+
error_code: 'no_space_for_access_code_on_device'
|
|
22854
|
+
}
|
|
22855
|
+
| {
|
|
22856
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22857
|
+
message: string
|
|
22858
|
+
/** Indicates that this is an access code error. */
|
|
22859
|
+
is_access_code_error: true
|
|
22860
|
+
/** Date and time at which Seam created the error. */
|
|
22861
|
+
created_at?: string | undefined
|
|
22862
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22863
|
+
error_code: 'igloohome_bridge_too_many_pending_jobs'
|
|
22864
|
+
}
|
|
22865
|
+
| {
|
|
22866
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22867
|
+
message: string
|
|
22868
|
+
/** Indicates that this is an access code error. */
|
|
22869
|
+
is_access_code_error: true
|
|
22870
|
+
/** Date and time at which Seam created the error. */
|
|
22871
|
+
created_at?: string | undefined
|
|
22872
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22873
|
+
error_code: 'igloohome_bridge_offline'
|
|
22874
|
+
}
|
|
22875
|
+
| {
|
|
22876
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22877
|
+
message: string
|
|
22878
|
+
/** Indicates that this is an access code error. */
|
|
22879
|
+
is_access_code_error: true
|
|
22880
|
+
/** Date and time at which Seam created the error. */
|
|
22881
|
+
created_at?: string | undefined
|
|
22882
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22883
|
+
error_code: 'igloohome_offline_access_code_no_variance_available'
|
|
22884
|
+
}
|
|
22885
|
+
| {
|
|
22886
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22887
|
+
message: string
|
|
22888
|
+
/** Indicates that this is an access code error. */
|
|
22889
|
+
is_access_code_error: true
|
|
22890
|
+
/** Date and time at which Seam created the error. */
|
|
22891
|
+
created_at?: string | undefined
|
|
22892
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22893
|
+
error_code: 'kwikset_unable_to_confirm_code'
|
|
22894
|
+
}
|
|
22895
|
+
| {
|
|
22896
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22897
|
+
message: string
|
|
22898
|
+
/** Indicates that this is an access code error. */
|
|
22899
|
+
is_access_code_error: true
|
|
22900
|
+
/** Date and time at which Seam created the error. */
|
|
22901
|
+
created_at?: string | undefined
|
|
22902
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22903
|
+
error_code: 'kwikset_unable_to_confirm_deletion'
|
|
22904
|
+
}
|
|
22905
|
+
| {
|
|
22906
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22907
|
+
message: string
|
|
22908
|
+
/** Indicates that this is an access code error. */
|
|
22909
|
+
is_access_code_error: true
|
|
22910
|
+
/** Date and time at which Seam created the error. */
|
|
22911
|
+
created_at?: string | undefined
|
|
22912
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22913
|
+
error_code: 'code_modified_external_to_seam'
|
|
22914
|
+
}
|
|
22915
|
+
| {
|
|
22916
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22917
|
+
message: string
|
|
22918
|
+
/** Indicates that this is an access code error. */
|
|
22919
|
+
is_access_code_error: true
|
|
22920
|
+
/** Date and time at which Seam created the error. */
|
|
22921
|
+
created_at?: string | undefined
|
|
22922
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22923
|
+
error_code: 'august_lock_invalid_code_length'
|
|
22924
|
+
}
|
|
22925
|
+
| {
|
|
22926
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22927
|
+
message: string
|
|
22928
|
+
/** Indicates that this is an access code error. */
|
|
22929
|
+
is_access_code_error: true
|
|
22930
|
+
/** Date and time at which Seam created the error. */
|
|
22931
|
+
created_at?: string | undefined
|
|
22932
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22933
|
+
error_code: 'august_device_programming_delay'
|
|
22934
|
+
}
|
|
22935
|
+
| {
|
|
22936
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22937
|
+
message: string
|
|
22938
|
+
/** Indicates that this is an access code error. */
|
|
22939
|
+
is_access_code_error: true
|
|
22940
|
+
/** Date and time at which Seam created the error. */
|
|
22941
|
+
created_at?: string | undefined
|
|
22942
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22943
|
+
error_code: 'august_device_slots_full'
|
|
22944
|
+
}
|
|
22945
|
+
| {
|
|
22946
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22947
|
+
message: string
|
|
22948
|
+
/** Indicates that this is an access code error. */
|
|
22949
|
+
is_access_code_error: true
|
|
22950
|
+
/** Date and time at which Seam created the error. */
|
|
22951
|
+
created_at?: string | undefined
|
|
22952
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22953
|
+
error_code: 'august_lock_missing_keypad'
|
|
22954
|
+
}
|
|
22955
|
+
| {
|
|
22956
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22957
|
+
message: string
|
|
22958
|
+
/** Indicates that this is an access code error. */
|
|
22959
|
+
is_access_code_error: true
|
|
22960
|
+
/** Date and time at which Seam created the error. */
|
|
22961
|
+
created_at?: string | undefined
|
|
22962
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22963
|
+
error_code: 'august_lock_temporarily_offline'
|
|
22964
|
+
}
|
|
22965
|
+
| {
|
|
22966
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22967
|
+
message: string
|
|
22968
|
+
/** Indicates that this is an access code error. */
|
|
22969
|
+
is_access_code_error: true
|
|
22970
|
+
/** Date and time at which Seam created the error. */
|
|
22971
|
+
created_at?: string | undefined
|
|
22972
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22973
|
+
error_code: 'salto_ks_user_not_subscribed'
|
|
22974
|
+
}
|
|
22975
|
+
| {
|
|
22976
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22977
|
+
message: string
|
|
22978
|
+
/** Indicates that this is an access code error. */
|
|
22979
|
+
is_access_code_error: true
|
|
22980
|
+
/** Date and time at which Seam created the error. */
|
|
22981
|
+
created_at?: string | undefined
|
|
22982
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22983
|
+
error_code: 'hubitat_device_programming_delay'
|
|
22984
|
+
}
|
|
22985
|
+
| {
|
|
22986
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22987
|
+
message: string
|
|
22988
|
+
/** Indicates that this is an access code error. */
|
|
22989
|
+
is_access_code_error: true
|
|
22990
|
+
/** Date and time at which Seam created the error. */
|
|
22991
|
+
created_at?: string | undefined
|
|
22992
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
22993
|
+
error_code: 'hubitat_no_free_positions_available'
|
|
22994
|
+
}
|
|
22995
|
+
| {
|
|
22996
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22997
|
+
message: string
|
|
22998
|
+
/** Indicates that this is an access code error. */
|
|
22999
|
+
is_access_code_error: true
|
|
23000
|
+
/** Date and time at which Seam created the error. */
|
|
23001
|
+
created_at?: string | undefined
|
|
23002
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23003
|
+
error_code: 'wyze_duplicate_code_name'
|
|
23004
|
+
}
|
|
23005
|
+
| {
|
|
23006
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23007
|
+
message: string
|
|
23008
|
+
/** Indicates that this is an access code error. */
|
|
23009
|
+
is_access_code_error: true
|
|
23010
|
+
/** Date and time at which Seam created the error. */
|
|
23011
|
+
created_at?: string | undefined
|
|
23012
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23013
|
+
error_code: 'wyze_potential_duplicate_code'
|
|
23014
|
+
}
|
|
23015
|
+
| {
|
|
23016
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23017
|
+
message: string
|
|
23018
|
+
/** Indicates that this is an access code error. */
|
|
23019
|
+
is_access_code_error: true
|
|
23020
|
+
/** Date and time at which Seam created the error. */
|
|
23021
|
+
created_at?: string | undefined
|
|
23022
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23023
|
+
error_code: 'dormakaba_oracode_no_valid_user_level'
|
|
23024
|
+
}
|
|
23025
|
+
| {
|
|
23026
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23027
|
+
message: string
|
|
23028
|
+
/** Indicates that the error is not a device error. */
|
|
23029
|
+
is_device_error: false
|
|
23030
|
+
/** Date and time at which Seam created the error. */
|
|
23031
|
+
created_at: string
|
|
23032
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23033
|
+
error_code: 'account_disconnected'
|
|
23034
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
23035
|
+
is_connected_account_error: true
|
|
23036
|
+
}
|
|
23037
|
+
| {
|
|
23038
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23039
|
+
message: string
|
|
23040
|
+
/** Indicates that the error is not a device error. */
|
|
23041
|
+
is_device_error: false
|
|
23042
|
+
/** Date and time at which Seam created the error. */
|
|
23043
|
+
created_at: string
|
|
23044
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23045
|
+
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
23046
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
23047
|
+
is_connected_account_error: true
|
|
23048
|
+
}
|
|
23049
|
+
| {
|
|
23050
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23051
|
+
message: string
|
|
23052
|
+
/** Indicates that the error is a device error. */
|
|
23053
|
+
is_device_error: true
|
|
23054
|
+
/** Date and time at which Seam created the error. */
|
|
23055
|
+
created_at: string
|
|
23056
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23057
|
+
error_code: 'device_offline'
|
|
23058
|
+
}
|
|
23059
|
+
| {
|
|
23060
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23061
|
+
message: string
|
|
23062
|
+
/** Indicates that the error is a device error. */
|
|
23063
|
+
is_device_error: true
|
|
23064
|
+
/** Date and time at which Seam created the error. */
|
|
23065
|
+
created_at: string
|
|
23066
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23067
|
+
error_code: 'device_removed'
|
|
23068
|
+
}
|
|
23069
|
+
| {
|
|
23070
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23071
|
+
message: string
|
|
23072
|
+
/** Indicates that the error is a device error. */
|
|
23073
|
+
is_device_error: true
|
|
23074
|
+
/** Date and time at which Seam created the error. */
|
|
23075
|
+
created_at: string
|
|
23076
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23077
|
+
error_code: 'hub_disconnected'
|
|
23078
|
+
}
|
|
23079
|
+
| {
|
|
23080
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23081
|
+
message: string
|
|
23082
|
+
/** Indicates that the error is a device error. */
|
|
23083
|
+
is_device_error: true
|
|
23084
|
+
/** Date and time at which Seam created the error. */
|
|
23085
|
+
created_at: string
|
|
23086
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23087
|
+
error_code: 'device_disconnected'
|
|
23088
|
+
}
|
|
23089
|
+
| {
|
|
23090
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23091
|
+
message: string
|
|
23092
|
+
/** Indicates that the error is a device error. */
|
|
23093
|
+
is_device_error: true
|
|
23094
|
+
/** Date and time at which Seam created the error. */
|
|
23095
|
+
created_at: string
|
|
23096
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23097
|
+
error_code: 'empty_backup_access_code_pool'
|
|
23098
|
+
}
|
|
23099
|
+
| {
|
|
23100
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23101
|
+
message: string
|
|
23102
|
+
/** Indicates that the error is a device error. */
|
|
23103
|
+
is_device_error: true
|
|
23104
|
+
/** Date and time at which Seam created the error. */
|
|
23105
|
+
created_at: string
|
|
23106
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23107
|
+
error_code: 'august_lock_not_authorized'
|
|
23108
|
+
}
|
|
23109
|
+
| {
|
|
23110
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23111
|
+
message: string
|
|
23112
|
+
/** Indicates that the error is a device error. */
|
|
23113
|
+
is_device_error: true
|
|
23114
|
+
/** Date and time at which Seam created the error. */
|
|
23115
|
+
created_at: string
|
|
23116
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23117
|
+
error_code: 'august_lock_missing_bridge'
|
|
23118
|
+
}
|
|
23119
|
+
| {
|
|
23120
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23121
|
+
message: string
|
|
23122
|
+
/** Indicates that the error is a device error. */
|
|
23123
|
+
is_device_error: true
|
|
23124
|
+
/** Date and time at which Seam created the error. */
|
|
23125
|
+
created_at: string
|
|
23126
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23127
|
+
error_code: 'ttlock_lock_not_paired_to_gateway'
|
|
23128
|
+
}
|
|
23129
|
+
| {
|
|
23130
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23131
|
+
message: string
|
|
23132
|
+
/** Indicates that the error is a device error. */
|
|
23133
|
+
is_device_error: true
|
|
23134
|
+
/** Date and time at which Seam created the error. */
|
|
23135
|
+
created_at: string
|
|
23136
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23137
|
+
error_code: 'missing_device_credentials'
|
|
23138
|
+
}
|
|
23139
|
+
| {
|
|
23140
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23141
|
+
message: string
|
|
23142
|
+
/** Indicates that the error is a device error. */
|
|
23143
|
+
is_device_error: true
|
|
23144
|
+
/** Date and time at which Seam created the error. */
|
|
23145
|
+
created_at: string
|
|
23146
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23147
|
+
error_code: 'auxiliary_heat_running'
|
|
23148
|
+
}
|
|
23149
|
+
| {
|
|
23150
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23151
|
+
message: string
|
|
23152
|
+
/** Indicates that the error is a device error. */
|
|
23153
|
+
is_device_error: true
|
|
23154
|
+
/** Date and time at which Seam created the error. */
|
|
23155
|
+
created_at: string
|
|
23156
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23157
|
+
error_code: 'subscription_required'
|
|
23158
|
+
}
|
|
23159
|
+
| {
|
|
23160
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23161
|
+
message: string
|
|
23162
|
+
/** Indicates that the error is a device error. */
|
|
23163
|
+
is_device_error: true
|
|
23164
|
+
/** Date and time at which Seam created the error. */
|
|
23165
|
+
created_at: string
|
|
23166
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23167
|
+
error_code: 'lockly_missing_wifi_bridge'
|
|
23168
|
+
}
|
|
23169
|
+
| {
|
|
23170
|
+
/** Date and time at which Seam created the error. */
|
|
23171
|
+
created_at: string
|
|
23172
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23173
|
+
message: string
|
|
23174
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
23175
|
+
is_connected_account_error?: boolean | undefined
|
|
23176
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
23177
|
+
is_bridge_error?: boolean | undefined
|
|
23178
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23179
|
+
error_code: 'invalid_credentials'
|
|
23180
|
+
}
|
|
23181
|
+
| {
|
|
23182
|
+
/** Date and time at which Seam created the error. */
|
|
23183
|
+
created_at: string
|
|
23184
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23185
|
+
message: string
|
|
23186
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
23187
|
+
is_connected_account_error?: boolean | undefined
|
|
23188
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
23189
|
+
is_bridge_error?: boolean | undefined
|
|
23190
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23191
|
+
error_code: 'bridge_disconnected'
|
|
23192
|
+
}
|
|
23193
|
+
)[]
|
|
23194
|
+
/** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
23195
|
+
warnings: (
|
|
23196
|
+
| {
|
|
23197
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23198
|
+
message: string
|
|
23199
|
+
/** Date and time at which Seam created the warning. */
|
|
23200
|
+
created_at?: string | undefined
|
|
23201
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23202
|
+
warning_code: 'smartthings_failed_to_set_access_code'
|
|
23203
|
+
}
|
|
23204
|
+
| {
|
|
23205
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23206
|
+
message: string
|
|
23207
|
+
/** Date and time at which Seam created the warning. */
|
|
23208
|
+
created_at?: string | undefined
|
|
23209
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23210
|
+
warning_code: 'schlage_detected_duplicate'
|
|
23211
|
+
}
|
|
23212
|
+
| {
|
|
23213
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23214
|
+
message: string
|
|
23215
|
+
/** Date and time at which Seam created the warning. */
|
|
23216
|
+
created_at?: string | undefined
|
|
23217
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23218
|
+
warning_code: 'schlage_creation_outage'
|
|
23219
|
+
}
|
|
23220
|
+
| {
|
|
23221
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23222
|
+
message: string
|
|
23223
|
+
/** Date and time at which Seam created the warning. */
|
|
23224
|
+
created_at?: string | undefined
|
|
23225
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23226
|
+
warning_code: 'code_modified_external_to_seam'
|
|
23227
|
+
}
|
|
23228
|
+
| {
|
|
23229
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23230
|
+
message: string
|
|
23231
|
+
/** Date and time at which Seam created the warning. */
|
|
23232
|
+
created_at?: string | undefined
|
|
23233
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23234
|
+
warning_code: 'delay_in_setting_on_device'
|
|
23235
|
+
}
|
|
23236
|
+
| {
|
|
23237
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23238
|
+
message: string
|
|
23239
|
+
/** Date and time at which Seam created the warning. */
|
|
23240
|
+
created_at?: string | undefined
|
|
23241
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23242
|
+
warning_code: 'delay_in_removing_from_device'
|
|
23243
|
+
}
|
|
23244
|
+
| {
|
|
23245
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23246
|
+
message: string
|
|
23247
|
+
/** Date and time at which Seam created the warning. */
|
|
23248
|
+
created_at?: string | undefined
|
|
23249
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23250
|
+
warning_code: 'third_party_integration_detected'
|
|
23251
|
+
}
|
|
23252
|
+
| {
|
|
23253
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23254
|
+
message: string
|
|
23255
|
+
/** Date and time at which Seam created the warning. */
|
|
23256
|
+
created_at?: string | undefined
|
|
23257
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23258
|
+
warning_code: 'august_device_programming_delay'
|
|
23259
|
+
}
|
|
23260
|
+
| {
|
|
23261
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23262
|
+
message: string
|
|
23263
|
+
/** Date and time at which Seam created the warning. */
|
|
23264
|
+
created_at?: string | undefined
|
|
23265
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23266
|
+
warning_code: 'august_lock_temporarily_offline'
|
|
23267
|
+
}
|
|
23268
|
+
| {
|
|
23269
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23270
|
+
message: string
|
|
23271
|
+
/** Date and time at which Seam created the warning. */
|
|
23272
|
+
created_at?: string | undefined
|
|
23273
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23274
|
+
warning_code: 'igloo_algopin_must_be_used_within_24_hours'
|
|
23275
|
+
}
|
|
23276
|
+
| {
|
|
23277
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23278
|
+
message: string
|
|
23279
|
+
/** Date and time at which Seam created the warning. */
|
|
23280
|
+
created_at?: string | undefined
|
|
23281
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23282
|
+
warning_code: 'management_transferred'
|
|
23283
|
+
}
|
|
23284
|
+
| {
|
|
23285
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23286
|
+
message: string
|
|
23287
|
+
/** Date and time at which Seam created the warning. */
|
|
23288
|
+
created_at?: string | undefined
|
|
23289
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23290
|
+
warning_code: 'kwikset_unable_to_confirm_code'
|
|
23291
|
+
}
|
|
23292
|
+
)[]
|
|
23293
|
+
/** Indicates that Seam does not manage the access code. */
|
|
23294
|
+
is_managed: false
|
|
23295
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
23296
|
+
starts_at?: (string | null) | undefined
|
|
23297
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
23298
|
+
ends_at?: (string | null) | undefined
|
|
23299
|
+
/** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
|
|
23300
|
+
status: 'set'
|
|
23301
|
+
}[]
|
|
22755
23302
|
| undefined
|
|
22756
|
-
/** The last time an internal sync job completed for this access system user. */
|
|
22757
|
-
last_successful_sync_at: string | null
|
|
22758
|
-
/**
|
|
22759
|
-
The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
|
|
22760
|
-
*/
|
|
22761
|
-
connected_account_id: string
|
|
22762
|
-
/** Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
22763
|
-
full_name?: string | undefined
|
|
22764
|
-
/**
|
|
22765
|
-
* @deprecated use email_address.*/
|
|
22766
|
-
email?: string | undefined
|
|
22767
|
-
/** Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
22768
|
-
email_address?: string | undefined
|
|
22769
|
-
/** Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). */
|
|
22770
|
-
phone_number?: string | undefined
|
|
22771
|
-
is_managed: true
|
|
22772
|
-
}[]
|
|
22773
|
-
}
|
|
22774
|
-
}
|
|
22775
|
-
'/acs/access_groups/remove_user': {
|
|
22776
|
-
route: '/acs/access_groups/remove_user'
|
|
22777
|
-
method: 'DELETE' | 'POST'
|
|
22778
|
-
queryParams: {}
|
|
22779
|
-
jsonBody: {}
|
|
22780
|
-
commonParams: {
|
|
22781
|
-
/** ID of the access group from which you want to remove an access system user. */
|
|
22782
|
-
acs_access_group_id: string
|
|
22783
|
-
/** ID of the access system user that you want to remove from an access group. */
|
|
22784
|
-
acs_user_id?: string | undefined
|
|
22785
|
-
/** ID of the user identity associated with the user that you want to remove from an access group. */
|
|
22786
|
-
user_identity_id?: string | undefined
|
|
22787
|
-
}
|
|
22788
|
-
formData: {}
|
|
22789
|
-
jsonResponse: {}
|
|
22790
|
-
}
|
|
22791
|
-
'/acs/access_groups/unmanaged/get': {
|
|
22792
|
-
route: '/acs/access_groups/unmanaged/get'
|
|
22793
|
-
method: 'GET' | 'POST'
|
|
22794
|
-
queryParams: {}
|
|
22795
|
-
jsonBody: {}
|
|
22796
|
-
commonParams: {
|
|
22797
|
-
/** ID of the unmanaged access group that you want to get. */
|
|
22798
|
-
acs_access_group_id: string
|
|
22799
|
-
}
|
|
22800
|
-
formData: {}
|
|
22801
|
-
jsonResponse: {
|
|
22802
|
-
/** */
|
|
22803
|
-
acs_access_group: {
|
|
22804
|
-
/** ID of the access group. */
|
|
22805
|
-
acs_access_group_id: string
|
|
22806
|
-
/** ID of the access control system that contains the access group. */
|
|
22807
|
-
acs_system_id: string
|
|
22808
|
-
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
22809
|
-
workspace_id: string
|
|
22810
|
-
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
22811
|
-
connected_account_id: string
|
|
22812
|
-
/** Name of the access group. */
|
|
22813
|
-
name: string
|
|
22814
|
-
/**
|
|
22815
|
-
* @deprecated Use `external_type`.*/
|
|
22816
|
-
access_group_type:
|
|
22817
|
-
| 'pti_unit'
|
|
22818
|
-
| 'pti_access_level'
|
|
22819
|
-
| 'salto_ks_access_group'
|
|
22820
|
-
| 'brivo_group'
|
|
22821
|
-
| 'salto_space_group'
|
|
22822
|
-
| 'dormakaba_community_access_group'
|
|
22823
|
-
/**
|
|
22824
|
-
* @deprecated Use `external_type_display_name`.*/
|
|
22825
|
-
access_group_type_display_name: string
|
|
22826
|
-
display_name: string
|
|
22827
|
-
/** Brand-specific terminology for the access group type. */
|
|
22828
|
-
external_type:
|
|
22829
|
-
| 'pti_unit'
|
|
22830
|
-
| 'pti_access_level'
|
|
22831
|
-
| 'salto_ks_access_group'
|
|
22832
|
-
| 'brivo_group'
|
|
22833
|
-
| 'salto_space_group'
|
|
22834
|
-
| 'dormakaba_community_access_group'
|
|
22835
|
-
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
22836
|
-
external_type_display_name: string
|
|
22837
|
-
/** Date and time at which the access group was created. */
|
|
22838
|
-
created_at: string
|
|
22839
|
-
/** Warnings associated with the `acs_access_group`. */
|
|
22840
|
-
warnings: {
|
|
22841
|
-
/** Date and time at which Seam created the warning. */
|
|
22842
|
-
created_at: string
|
|
22843
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22844
|
-
message: string
|
|
22845
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22846
|
-
warning_code: 'unknown_issue_with_acs_access_group'
|
|
22847
|
-
}[]
|
|
22848
|
-
is_managed: false
|
|
22849
23303
|
}
|
|
22850
23304
|
}
|
|
22851
23305
|
}
|
|
22852
|
-
'/
|
|
22853
|
-
route: '/
|
|
23306
|
+
'/access_methods/list': {
|
|
23307
|
+
route: '/access_methods/list'
|
|
22854
23308
|
method: 'GET' | 'POST'
|
|
22855
23309
|
queryParams: {}
|
|
22856
23310
|
jsonBody: {}
|
|
22857
23311
|
commonParams: {
|
|
22858
|
-
/** ID of
|
|
22859
|
-
|
|
22860
|
-
/** ID of the
|
|
23312
|
+
/** ID of Access Grant to list access methods for. */
|
|
23313
|
+
access_grant_id: string
|
|
23314
|
+
/** ID of the device for which you want to retrieve all access methods. */
|
|
23315
|
+
device_id?: string | undefined
|
|
23316
|
+
/** ID of the entrance for which you want to retrieve all access methods. */
|
|
23317
|
+
acs_entrance_id?: string | undefined
|
|
23318
|
+
/** ID of the space for which you want to retrieve all access methods. */
|
|
23319
|
+
space_id?: string | undefined
|
|
23320
|
+
}
|
|
23321
|
+
formData: {}
|
|
23322
|
+
jsonResponse: {
|
|
23323
|
+
access_methods: {
|
|
23324
|
+
/** ID of the Seam workspace associated with the access method. */
|
|
23325
|
+
workspace_id: string
|
|
23326
|
+
/** ID of the access method. */
|
|
23327
|
+
access_method_id: string
|
|
23328
|
+
/** Display name of the access method. */
|
|
23329
|
+
display_name: string
|
|
23330
|
+
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
23331
|
+
mode: 'code' | 'card' | 'mobile_key'
|
|
23332
|
+
/** Date and time at which the access method was created. */
|
|
23333
|
+
created_at: string
|
|
23334
|
+
/** Date and time at which the access method was issued. */
|
|
23335
|
+
issued_at: string | null
|
|
23336
|
+
/** Indicates whether the access method has been issued. */
|
|
23337
|
+
is_issued: boolean
|
|
23338
|
+
/** URL of the Instant Key for mobile key access methods. */
|
|
23339
|
+
instant_key_url?: string | undefined
|
|
23340
|
+
/** Token of the client session associated with the access method. */
|
|
23341
|
+
client_session_token?: string | undefined
|
|
23342
|
+
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
23343
|
+
is_encoding_required?: boolean | undefined
|
|
23344
|
+
/** The actual PIN code for code access methods. */
|
|
23345
|
+
code?: string | undefined
|
|
23346
|
+
}[]
|
|
23347
|
+
}
|
|
23348
|
+
}
|
|
23349
|
+
'/acs/access_groups/add_user': {
|
|
23350
|
+
route: '/acs/access_groups/add_user'
|
|
23351
|
+
method: 'PUT' | 'POST'
|
|
23352
|
+
queryParams: {}
|
|
23353
|
+
jsonBody: {}
|
|
23354
|
+
commonParams: {
|
|
23355
|
+
/** ID of the access group to which you want to add an access system user. */
|
|
23356
|
+
acs_access_group_id: string
|
|
23357
|
+
/** 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. */
|
|
22861
23358
|
acs_user_id?: string | undefined
|
|
23359
|
+
/** 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. */
|
|
23360
|
+
user_identity_id?: string | undefined
|
|
23361
|
+
}
|
|
23362
|
+
formData: {}
|
|
23363
|
+
jsonResponse: {}
|
|
23364
|
+
}
|
|
23365
|
+
'/acs/access_groups/get': {
|
|
23366
|
+
route: '/acs/access_groups/get'
|
|
23367
|
+
method: 'GET' | 'POST'
|
|
23368
|
+
queryParams: {}
|
|
23369
|
+
jsonBody: {}
|
|
23370
|
+
commonParams: {
|
|
23371
|
+
/** ID of the access group that you want to get. */
|
|
23372
|
+
acs_access_group_id: string
|
|
22862
23373
|
}
|
|
22863
23374
|
formData: {}
|
|
22864
23375
|
jsonResponse: {
|
|
22865
|
-
|
|
23376
|
+
/** Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
|
|
23377
|
+
|
|
23378
|
+
Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
23379
|
+
|
|
23380
|
+
To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
|
|
23381
|
+
acs_access_group: {
|
|
22866
23382
|
/** ID of the access group. */
|
|
22867
23383
|
acs_access_group_id: string
|
|
22868
23384
|
/** ID of the access control system that contains the access group. */
|
|
@@ -22907,487 +23423,678 @@ export type Routes = {
|
|
|
22907
23423
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22908
23424
|
warning_code: 'unknown_issue_with_acs_access_group'
|
|
22909
23425
|
}[]
|
|
22910
|
-
is_managed:
|
|
22911
|
-
}
|
|
23426
|
+
is_managed: true
|
|
23427
|
+
}
|
|
22912
23428
|
}
|
|
22913
23429
|
}
|
|
22914
|
-
'/acs/
|
|
22915
|
-
route: '/acs/
|
|
23430
|
+
'/acs/access_groups/list': {
|
|
23431
|
+
route: '/acs/access_groups/list'
|
|
22916
23432
|
method: 'GET' | 'POST'
|
|
22917
23433
|
queryParams: {}
|
|
22918
23434
|
jsonBody: {}
|
|
22919
23435
|
commonParams: {
|
|
22920
|
-
/** ID of the access system for which you want to
|
|
22921
|
-
acs_system_id
|
|
22922
|
-
|
|
22923
|
-
|
|
22924
|
-
|
|
22925
|
-
|
|
22926
|
-
|
|
23436
|
+
/** ID of the access system for which you want to retrieve all access groups. */
|
|
23437
|
+
acs_system_id?: string | undefined
|
|
23438
|
+
/** ID of the access system user for which you want to retrieve all access groups. */
|
|
23439
|
+
acs_user_id?: string | undefined
|
|
23440
|
+
/** ID of the user identity for which you want to retrieve all access groups. */
|
|
23441
|
+
user_identity_id?: string | undefined
|
|
23442
|
+
}
|
|
23443
|
+
formData: {}
|
|
23444
|
+
jsonResponse: {
|
|
23445
|
+
acs_access_groups: {
|
|
23446
|
+
/** ID of the access group. */
|
|
23447
|
+
acs_access_group_id: string
|
|
23448
|
+
/** ID of the access control system that contains the access group. */
|
|
22927
23449
|
acs_system_id: string
|
|
23450
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
23451
|
+
workspace_id: string
|
|
23452
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
23453
|
+
connected_account_id: string
|
|
23454
|
+
/** Name of the access group. */
|
|
23455
|
+
name: string
|
|
23456
|
+
/**
|
|
23457
|
+
* @deprecated Use `external_type`.*/
|
|
23458
|
+
access_group_type:
|
|
23459
|
+
| 'pti_unit'
|
|
23460
|
+
| 'pti_access_level'
|
|
23461
|
+
| 'salto_ks_access_group'
|
|
23462
|
+
| 'brivo_group'
|
|
23463
|
+
| 'salto_space_group'
|
|
23464
|
+
| 'dormakaba_community_access_group'
|
|
23465
|
+
/**
|
|
23466
|
+
* @deprecated Use `external_type_display_name`.*/
|
|
23467
|
+
access_group_type_display_name: string
|
|
22928
23468
|
display_name: string
|
|
22929
|
-
|
|
23469
|
+
/** Brand-specific terminology for the access group type. */
|
|
23470
|
+
external_type:
|
|
23471
|
+
| 'pti_unit'
|
|
23472
|
+
| 'pti_access_level'
|
|
23473
|
+
| 'salto_ks_access_group'
|
|
23474
|
+
| 'brivo_group'
|
|
23475
|
+
| 'salto_space_group'
|
|
23476
|
+
| 'dormakaba_community_access_group'
|
|
23477
|
+
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
22930
23478
|
external_type_display_name: string
|
|
23479
|
+
/** Date and time at which the access group was created. */
|
|
22931
23480
|
created_at: string
|
|
22932
|
-
|
|
23481
|
+
/** Warnings associated with the `acs_access_group`. */
|
|
23482
|
+
warnings: {
|
|
23483
|
+
/** Date and time at which Seam created the warning. */
|
|
23484
|
+
created_at: string
|
|
23485
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23486
|
+
message: string
|
|
23487
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23488
|
+
warning_code: 'unknown_issue_with_acs_access_group'
|
|
23489
|
+
}[]
|
|
23490
|
+
is_managed: true
|
|
22933
23491
|
}[]
|
|
22934
23492
|
}
|
|
22935
23493
|
}
|
|
22936
|
-
'/acs/
|
|
22937
|
-
route: '/acs/
|
|
22938
|
-
method: 'POST'
|
|
23494
|
+
'/acs/access_groups/list_accessible_entrances': {
|
|
23495
|
+
route: '/acs/access_groups/list_accessible_entrances'
|
|
23496
|
+
method: 'GET' | 'POST'
|
|
22939
23497
|
queryParams: {}
|
|
22940
23498
|
jsonBody: {}
|
|
22941
23499
|
commonParams: {
|
|
22942
|
-
/** ID of the
|
|
22943
|
-
|
|
22944
|
-
/** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
|
|
22945
|
-
credential_manager_acs_system_id: string
|
|
22946
|
-
/** ID of the credential pool for which you want to launch a credential provisioning automation. */
|
|
22947
|
-
acs_credential_pool_id?: string | undefined
|
|
22948
|
-
/** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
|
|
22949
|
-
create_credential_manager_user?: boolean | undefined
|
|
22950
|
-
/** 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`. */
|
|
22951
|
-
credential_manager_acs_user_id?: string | undefined
|
|
22952
|
-
}
|
|
22953
|
-
formData: {}
|
|
22954
|
-
jsonResponse: {
|
|
22955
|
-
/**
|
|
22956
|
-
* @deprecated Not used.*/
|
|
22957
|
-
acs_credential_provisioning_automation: {
|
|
22958
|
-
acs_credential_provisioning_automation_id: string
|
|
22959
|
-
credential_manager_acs_system_id: string
|
|
22960
|
-
user_identity_id: string
|
|
22961
|
-
created_at: string
|
|
22962
|
-
workspace_id: string
|
|
22963
|
-
}
|
|
22964
|
-
}
|
|
22965
|
-
}
|
|
22966
|
-
'/acs/credentials/assign': {
|
|
22967
|
-
route: '/acs/credentials/assign'
|
|
22968
|
-
method: 'PATCH' | 'POST'
|
|
22969
|
-
queryParams: {}
|
|
22970
|
-
jsonBody: {
|
|
22971
|
-
/** ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. */
|
|
22972
|
-
acs_user_id?: string | undefined
|
|
22973
|
-
/** ID of the user identity to whom you want to assign a credential. 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 credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
|
|
22974
|
-
user_identity_id?: string | undefined
|
|
22975
|
-
/** ID of the credential that you want to assign to an access system user. */
|
|
22976
|
-
acs_credential_id: string
|
|
23500
|
+
/** ID of the access group for which you want to retrieve all accessible entrances. */
|
|
23501
|
+
acs_access_group_id: string
|
|
22977
23502
|
}
|
|
22978
|
-
commonParams: {}
|
|
22979
23503
|
formData: {}
|
|
22980
23504
|
jsonResponse: {
|
|
22981
|
-
|
|
22982
|
-
|
|
22983
|
-
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
22984
|
-
|
|
22985
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
|
|
22986
|
-
acs_credential: {
|
|
22987
|
-
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22988
|
-
acs_credential_id: string
|
|
22989
|
-
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
22990
|
-
acs_user_id?: string | undefined
|
|
22991
|
-
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
22992
|
-
user_identity_id?: string | undefined
|
|
22993
|
-
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
22994
|
-
connected_account_id: string
|
|
22995
|
-
acs_credential_pool_id?: string | undefined
|
|
22996
|
-
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23505
|
+
acs_entrances: {
|
|
23506
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22997
23507
|
acs_system_id: string
|
|
22998
|
-
/** ID of the
|
|
22999
|
-
|
|
23000
|
-
/**
|
|
23001
|
-
display_name: string
|
|
23002
|
-
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23003
|
-
code?: (string | undefined) | null
|
|
23004
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
23005
|
-
is_one_time_use?: boolean | undefined
|
|
23006
|
-
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23007
|
-
card_number?: (string | undefined) | null
|
|
23008
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
23009
|
-
is_issued?: boolean | undefined
|
|
23010
|
-
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
23011
|
-
issued_at?: (string | undefined) | null
|
|
23012
|
-
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
23013
|
-
access_method: 'code' | 'card' | 'mobile_key'
|
|
23014
|
-
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
23015
|
-
external_type?:
|
|
23016
|
-
| (
|
|
23017
|
-
| 'pti_card'
|
|
23018
|
-
| 'brivo_credential'
|
|
23019
|
-
| 'hid_credential'
|
|
23020
|
-
| 'visionline_card'
|
|
23021
|
-
| 'salto_ks_credential'
|
|
23022
|
-
| 'assa_abloy_vostio_key'
|
|
23023
|
-
| 'salto_space_key'
|
|
23024
|
-
| 'latch_access'
|
|
23025
|
-
)
|
|
23026
|
-
| undefined
|
|
23027
|
-
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23028
|
-
external_type_display_name?: string | undefined
|
|
23029
|
-
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
23508
|
+
/** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23509
|
+
acs_entrance_id: string
|
|
23510
|
+
/** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
|
|
23030
23511
|
created_at: string
|
|
23031
|
-
/**
|
|
23032
|
-
|
|
23033
|
-
/**
|
|
23034
|
-
|
|
23035
|
-
/**
|
|
23036
|
-
ends_at?: string | undefined
|
|
23037
|
-
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23512
|
+
/** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23513
|
+
display_name: string
|
|
23514
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23515
|
+
connected_account_id: string
|
|
23516
|
+
/** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23038
23517
|
errors: {
|
|
23518
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
23039
23519
|
error_code: string
|
|
23520
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23040
23521
|
message: string
|
|
23041
23522
|
}[]
|
|
23042
|
-
/**
|
|
23043
|
-
|
|
23044
|
-
| {
|
|
23045
|
-
/** Date and time at which Seam created the warning. */
|
|
23046
|
-
created_at: string
|
|
23047
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23048
|
-
message: string
|
|
23049
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23050
|
-
warning_code: 'waiting_to_be_issued'
|
|
23051
|
-
}
|
|
23523
|
+
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23524
|
+
latch_metadata?:
|
|
23052
23525
|
| {
|
|
23053
|
-
/**
|
|
23054
|
-
|
|
23055
|
-
/**
|
|
23056
|
-
|
|
23057
|
-
/**
|
|
23058
|
-
|
|
23526
|
+
/** Accessibility type in the Latch access system. */
|
|
23527
|
+
accessibility_type: string
|
|
23528
|
+
/** Name of the door in the Latch access system. */
|
|
23529
|
+
door_name: string
|
|
23530
|
+
/** Type of the door in the Latch access system. */
|
|
23531
|
+
door_type: string
|
|
23532
|
+
/** Indicates whether the entrance is connected. */
|
|
23533
|
+
is_connected: boolean
|
|
23059
23534
|
}
|
|
23535
|
+
| undefined
|
|
23536
|
+
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23537
|
+
visionline_metadata?:
|
|
23060
23538
|
| {
|
|
23061
|
-
/**
|
|
23062
|
-
|
|
23063
|
-
/**
|
|
23064
|
-
|
|
23065
|
-
|
|
23066
|
-
|
|
23539
|
+
/** Name of the door in the Visionline access system. */
|
|
23540
|
+
door_name: string
|
|
23541
|
+
/** Category of the door in the Visionline access system. */
|
|
23542
|
+
door_category:
|
|
23543
|
+
| 'entrance'
|
|
23544
|
+
| 'guest'
|
|
23545
|
+
| 'elevator reader'
|
|
23546
|
+
| 'common'
|
|
23547
|
+
| 'common (PMS)'
|
|
23548
|
+
/** Profile for the door in the Visionline access system. */
|
|
23549
|
+
profiles?:
|
|
23550
|
+
| {
|
|
23551
|
+
/** Door profile ID in the Visionline access system. */
|
|
23552
|
+
visionline_door_profile_id: string
|
|
23553
|
+
/** Door profile type in the Visionline access system. */
|
|
23554
|
+
visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch'
|
|
23555
|
+
}[]
|
|
23556
|
+
| undefined
|
|
23067
23557
|
}
|
|
23558
|
+
| undefined
|
|
23559
|
+
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23560
|
+
salto_ks_metadata?:
|
|
23068
23561
|
| {
|
|
23069
|
-
/**
|
|
23070
|
-
|
|
23071
|
-
/**
|
|
23072
|
-
|
|
23073
|
-
/**
|
|
23074
|
-
|
|
23562
|
+
/** Name of the door in the Salto KS access system. */
|
|
23563
|
+
door_name: string
|
|
23564
|
+
/** Locked state of the door in the Salto KS access system. */
|
|
23565
|
+
locked_state: string
|
|
23566
|
+
/** Type of the lock in the Salto KS access system. */
|
|
23567
|
+
lock_type: string
|
|
23568
|
+
/** Indicates whether the door access device is online. */
|
|
23569
|
+
online?: boolean | undefined
|
|
23570
|
+
/** Battery level of the door access device. */
|
|
23571
|
+
battery_level: string
|
|
23572
|
+
/** Indicates whether the door is left open. */
|
|
23573
|
+
left_open_alarm?: boolean | undefined
|
|
23574
|
+
/** Indicates whether an intrusion alarm is active on the door. */
|
|
23575
|
+
intrusion_alarm?: boolean | undefined
|
|
23576
|
+
/** Indicates whether privacy mode is enabled for the lock. */
|
|
23577
|
+
privacy_mode?: boolean | undefined
|
|
23075
23578
|
}
|
|
23579
|
+
| undefined
|
|
23580
|
+
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23581
|
+
dormakaba_community_metadata?:
|
|
23076
23582
|
| {
|
|
23077
|
-
/**
|
|
23078
|
-
|
|
23079
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23080
|
-
message: string
|
|
23081
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23082
|
-
warning_code: 'unknown_issue_with_acs_credential'
|
|
23583
|
+
/** Name of the access point in the dormakaba Community access system. */
|
|
23584
|
+
access_point_name: string
|
|
23083
23585
|
}
|
|
23586
|
+
| undefined
|
|
23587
|
+
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23588
|
+
assa_abloy_vostio_metadata?:
|
|
23084
23589
|
| {
|
|
23085
|
-
/**
|
|
23086
|
-
|
|
23087
|
-
|
|
23088
|
-
|
|
23089
|
-
|
|
23090
|
-
|
|
23590
|
+
/** Type of the door in the Vostio access system. */
|
|
23591
|
+
door_type:
|
|
23592
|
+
| 'CommonDoor'
|
|
23593
|
+
| 'EntranceDoor'
|
|
23594
|
+
| 'GuestDoor'
|
|
23595
|
+
| 'Elevator'
|
|
23596
|
+
/** Name of the door in the Vostio access system. */
|
|
23597
|
+
door_name: string
|
|
23598
|
+
/** Number of the door in the Vostio access system. */
|
|
23599
|
+
door_number?: number | undefined
|
|
23600
|
+
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
23601
|
+
stand_open?: boolean | undefined
|
|
23602
|
+
/** PMS ID of the door in the Vostio access system. */
|
|
23603
|
+
pms_id?: string | undefined
|
|
23091
23604
|
}
|
|
23092
|
-
)[]
|
|
23093
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
23094
|
-
is_multi_phone_sync_credential?: boolean | undefined
|
|
23095
|
-
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
23096
|
-
is_latest_desired_state_synced_with_provider?:
|
|
23097
|
-
| (boolean | null)
|
|
23098
|
-
| undefined
|
|
23099
|
-
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
23100
|
-
latest_desired_state_synced_with_provider_at?:
|
|
23101
|
-
| (string | null)
|
|
23102
23605
|
| undefined
|
|
23103
|
-
/**
|
|
23104
|
-
|
|
23606
|
+
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23607
|
+
salto_space_metadata?:
|
|
23105
23608
|
| {
|
|
23106
|
-
/**
|
|
23107
|
-
|
|
23108
|
-
|
|
23109
|
-
|
|
23110
|
-
|
|
23111
|
-
|
|
23112
|
-
|
|
23113
|
-
|
|
23114
|
-
|
|
23115
|
-
|
|
23116
|
-
|
|
23117
|
-
|
|
23118
|
-
|
|
23119
|
-
card_id?: string | undefined
|
|
23120
|
-
/** ID of the credential in the Visionline access system. */
|
|
23121
|
-
credential_id?: string | undefined
|
|
23609
|
+
/**
|
|
23610
|
+
* @deprecated use door_id.*/
|
|
23611
|
+
ext_door_id?: string | undefined
|
|
23612
|
+
/** Door ID in the Salto Space access system. */
|
|
23613
|
+
door_id?: string | undefined
|
|
23614
|
+
/** Name of the door in the Salto Space access system. */
|
|
23615
|
+
door_name?: string | undefined
|
|
23616
|
+
/** Description of the door in the Salto Space access system. */
|
|
23617
|
+
door_description?: string | undefined
|
|
23618
|
+
/** Name of the room in the Salto Space access system. */
|
|
23619
|
+
room_name?: string | undefined
|
|
23620
|
+
/** Description of the room in the Salto Space access system. */
|
|
23621
|
+
room_description?: string | undefined
|
|
23122
23622
|
}
|
|
23123
23623
|
| undefined
|
|
23124
|
-
/**
|
|
23125
|
-
|
|
23624
|
+
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23625
|
+
dormakaba_ambiance_metadata?:
|
|
23126
23626
|
| {
|
|
23127
|
-
/**
|
|
23128
|
-
|
|
23129
|
-
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
23130
|
-
override_guest_acs_entrance_ids?: string[] | undefined
|
|
23131
|
-
/** Key ID in the Vostio access system. */
|
|
23132
|
-
key_id?: string | undefined
|
|
23133
|
-
/** Key issuing request ID in the Vostio access system. */
|
|
23134
|
-
key_issuing_request_id?: string | undefined
|
|
23135
|
-
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
23136
|
-
door_names?: string[] | undefined
|
|
23137
|
-
/** Endpoint ID in the Vostio access system. */
|
|
23138
|
-
endpoint_id?: string | undefined
|
|
23627
|
+
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
23628
|
+
access_point_name: string
|
|
23139
23629
|
}
|
|
23140
23630
|
| undefined
|
|
23141
|
-
|
|
23142
|
-
|
|
23631
|
+
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
23632
|
+
can_unlock_with_mobile_key?: boolean | undefined
|
|
23633
|
+
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
23634
|
+
can_unlock_with_card?: boolean | undefined
|
|
23635
|
+
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
23636
|
+
can_unlock_with_code?: boolean | undefined
|
|
23637
|
+
}[]
|
|
23143
23638
|
}
|
|
23144
23639
|
}
|
|
23145
|
-
'/acs/
|
|
23146
|
-
route: '/acs/
|
|
23147
|
-
method: 'POST'
|
|
23640
|
+
'/acs/access_groups/list_users': {
|
|
23641
|
+
route: '/acs/access_groups/list_users'
|
|
23642
|
+
method: 'GET' | 'POST'
|
|
23148
23643
|
queryParams: {}
|
|
23149
23644
|
jsonBody: {}
|
|
23150
23645
|
commonParams: {
|
|
23151
|
-
/**
|
|
23152
|
-
|
|
23153
|
-
/** 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`. */
|
|
23154
|
-
acs_user_id?: string | undefined
|
|
23155
|
-
/** ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created. */
|
|
23156
|
-
user_identity_id?: string | undefined
|
|
23157
|
-
/** ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
|
|
23158
|
-
acs_system_id?: string | undefined
|
|
23159
|
-
/** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. */
|
|
23160
|
-
access_method: 'code' | 'card' | 'mobile_key'
|
|
23161
|
-
/** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview). */
|
|
23162
|
-
code?: string | undefined
|
|
23163
|
-
/** Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
23164
|
-
is_multi_phone_sync_credential?: boolean
|
|
23165
|
-
/** Set of IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
|
|
23166
|
-
allowed_acs_entrance_ids?: string[]
|
|
23167
|
-
/** Visionline-specific metadata for the new credential. */
|
|
23168
|
-
visionline_metadata?:
|
|
23169
|
-
| {
|
|
23170
|
-
/**
|
|
23171
|
-
* @deprecated Read-only endpoint references moved to `endpoint`.*/
|
|
23172
|
-
assa_abloy_credential_service_mobile_endpoint_id?:
|
|
23173
|
-
| string
|
|
23174
|
-
| undefined
|
|
23175
|
-
card_format?: ('TLCode' | 'rfid48') | undefined
|
|
23176
|
-
card_function_type?: 'guest' | 'staff'
|
|
23177
|
-
/**
|
|
23178
|
-
* @deprecated Use `override` instead.*/
|
|
23179
|
-
is_override_key?: boolean | undefined
|
|
23180
|
-
override?: boolean | undefined
|
|
23181
|
-
auto_join?: boolean | undefined
|
|
23182
|
-
joiner_acs_credential_ids?: string[] | undefined
|
|
23183
|
-
}
|
|
23184
|
-
| undefined
|
|
23185
|
-
/** Vostio-specific metadata for the new credential. */
|
|
23186
|
-
assa_abloy_vostio_metadata?:
|
|
23187
|
-
| {
|
|
23188
|
-
auto_join?: boolean | undefined
|
|
23189
|
-
override_all_guest_acs_entrances?: boolean | undefined
|
|
23190
|
-
join_all_guest_acs_entrances?: boolean | undefined
|
|
23191
|
-
override_guest_acs_entrance_ids?: string[] | undefined
|
|
23192
|
-
}
|
|
23193
|
-
| undefined
|
|
23194
|
-
/** Salto Space-specific metadata for the new credential. */
|
|
23195
|
-
salto_space_metadata?:
|
|
23196
|
-
| {
|
|
23197
|
-
/** Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
|
|
23198
|
-
assign_new_key?: boolean | undefined
|
|
23199
|
-
/** Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
|
|
23200
|
-
update_current_key?: boolean | undefined
|
|
23201
|
-
}
|
|
23202
|
-
| undefined
|
|
23203
|
-
/** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23204
|
-
starts_at?: string | undefined
|
|
23205
|
-
/** 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`. */
|
|
23206
|
-
ends_at?: string | undefined
|
|
23646
|
+
/** ID of the access group for which you want to retrieve all access system users. */
|
|
23647
|
+
acs_access_group_id: string
|
|
23207
23648
|
}
|
|
23208
23649
|
formData: {}
|
|
23209
23650
|
jsonResponse: {
|
|
23210
|
-
|
|
23211
|
-
|
|
23212
|
-
|
|
23213
|
-
|
|
23214
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
|
|
23215
|
-
acs_credential: {
|
|
23216
|
-
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23217
|
-
acs_credential_id: string
|
|
23218
|
-
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23219
|
-
acs_user_id?: string | undefined
|
|
23220
|
-
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23221
|
-
user_identity_id?: string | undefined
|
|
23222
|
-
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23223
|
-
connected_account_id: string
|
|
23224
|
-
acs_credential_pool_id?: string | undefined
|
|
23225
|
-
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23651
|
+
acs_users: {
|
|
23652
|
+
/** ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23653
|
+
acs_user_id: string
|
|
23654
|
+
/** ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23226
23655
|
acs_system_id: string
|
|
23227
|
-
|
|
23228
|
-
|
|
23229
|
-
|
|
23656
|
+
hid_acs_system_id?: string | undefined
|
|
23657
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23658
|
+
workspace_id: string
|
|
23659
|
+
/** Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. */
|
|
23660
|
+
created_at: string
|
|
23661
|
+
/** Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23230
23662
|
display_name: string
|
|
23231
|
-
/**
|
|
23232
|
-
code?: (string | undefined) | null
|
|
23233
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
23234
|
-
is_one_time_use?: boolean | undefined
|
|
23235
|
-
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23236
|
-
card_number?: (string | undefined) | null
|
|
23237
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
23238
|
-
is_issued?: boolean | undefined
|
|
23239
|
-
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
23240
|
-
issued_at?: (string | undefined) | null
|
|
23241
|
-
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
23242
|
-
access_method: 'code' | 'card' | 'mobile_key'
|
|
23243
|
-
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
23663
|
+
/** Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. */
|
|
23244
23664
|
external_type?:
|
|
23245
23665
|
| (
|
|
23246
|
-
| '
|
|
23247
|
-
| '
|
|
23248
|
-
| '
|
|
23249
|
-
| '
|
|
23250
|
-
| '
|
|
23251
|
-
| '
|
|
23252
|
-
| '
|
|
23253
|
-
| 'latch_access'
|
|
23666
|
+
| 'pti_user'
|
|
23667
|
+
| 'brivo_user'
|
|
23668
|
+
| 'hid_credential_manager_user'
|
|
23669
|
+
| 'salto_site_user'
|
|
23670
|
+
| 'latch_user'
|
|
23671
|
+
| 'dormakaba_community_user'
|
|
23672
|
+
| 'salto_space_user'
|
|
23254
23673
|
)
|
|
23255
23674
|
| undefined
|
|
23256
|
-
/** Display name that corresponds to the brand-specific terminology for the [
|
|
23675
|
+
/** Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. */
|
|
23257
23676
|
external_type_display_name?: string | undefined
|
|
23258
|
-
/**
|
|
23259
|
-
|
|
23260
|
-
/**
|
|
23261
|
-
|
|
23262
|
-
|
|
23263
|
-
|
|
23264
|
-
|
|
23265
|
-
|
|
23266
|
-
|
|
23267
|
-
|
|
23268
|
-
|
|
23269
|
-
|
|
23270
|
-
|
|
23271
|
-
/**
|
|
23677
|
+
/** Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). */
|
|
23678
|
+
is_suspended?: boolean | undefined
|
|
23679
|
+
/** `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. */
|
|
23680
|
+
access_schedule?:
|
|
23681
|
+
| {
|
|
23682
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23683
|
+
starts_at: string
|
|
23684
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23685
|
+
ends_at: string | null
|
|
23686
|
+
}
|
|
23687
|
+
| undefined
|
|
23688
|
+
/** ID of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23689
|
+
user_identity_id?: string | undefined
|
|
23690
|
+
/** Full name of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23691
|
+
user_identity_full_name?: (string | null) | undefined
|
|
23692
|
+
/** Email address of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23693
|
+
user_identity_email_address?: (string | null) | undefined
|
|
23694
|
+
/** Phone number of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). */
|
|
23695
|
+
user_identity_phone_number?: (string | null) | undefined
|
|
23696
|
+
/** Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23272
23697
|
warnings: (
|
|
23273
23698
|
| {
|
|
23274
23699
|
/** Date and time at which Seam created the warning. */
|
|
23275
23700
|
created_at: string
|
|
23276
23701
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23277
23702
|
message: string
|
|
23278
|
-
|
|
23279
|
-
warning_code: 'waiting_to_be_issued'
|
|
23703
|
+
warning_code: 'being_deleted'
|
|
23280
23704
|
}
|
|
23281
23705
|
| {
|
|
23282
23706
|
/** Date and time at which Seam created the warning. */
|
|
23283
23707
|
created_at: string
|
|
23284
23708
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23285
23709
|
message: string
|
|
23286
|
-
|
|
23287
|
-
warning_code: 'schedule_externally_modified'
|
|
23710
|
+
warning_code: 'salto_ks_user_not_subscribed'
|
|
23288
23711
|
}
|
|
23289
23712
|
| {
|
|
23290
23713
|
/** Date and time at which Seam created the warning. */
|
|
23291
23714
|
created_at: string
|
|
23292
23715
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23293
23716
|
message: string
|
|
23294
|
-
|
|
23295
|
-
warning_code: 'schedule_modified'
|
|
23717
|
+
warning_code: 'unknown_issue_with_acs_user'
|
|
23296
23718
|
}
|
|
23297
23719
|
| {
|
|
23298
23720
|
/** Date and time at which Seam created the warning. */
|
|
23299
23721
|
created_at: string
|
|
23300
23722
|
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23301
23723
|
message: string
|
|
23302
|
-
|
|
23303
|
-
warning_code: 'being_deleted'
|
|
23724
|
+
warning_code: 'latch_resident_user'
|
|
23304
23725
|
}
|
|
23726
|
+
)[]
|
|
23727
|
+
/** Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23728
|
+
errors: (
|
|
23305
23729
|
| {
|
|
23306
|
-
/** Date and time at which Seam created the
|
|
23730
|
+
/** Date and time at which Seam created the error. */
|
|
23307
23731
|
created_at: string
|
|
23308
|
-
/** Detailed description of the
|
|
23732
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23309
23733
|
message: string
|
|
23310
|
-
|
|
23311
|
-
warning_code: 'unknown_issue_with_acs_credential'
|
|
23734
|
+
error_code: 'deleted_externally'
|
|
23312
23735
|
}
|
|
23313
23736
|
| {
|
|
23314
|
-
/** Date and time at which Seam created the
|
|
23737
|
+
/** Date and time at which Seam created the error. */
|
|
23315
23738
|
created_at: string
|
|
23316
|
-
/** Detailed description of the
|
|
23739
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23317
23740
|
message: string
|
|
23318
|
-
|
|
23319
|
-
warning_code: 'needs_to_be_reissued'
|
|
23741
|
+
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
23320
23742
|
}
|
|
23321
|
-
)[]
|
|
23322
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
23323
|
-
is_multi_phone_sync_credential?: boolean | undefined
|
|
23324
|
-
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
23325
|
-
is_latest_desired_state_synced_with_provider?:
|
|
23326
|
-
| (boolean | null)
|
|
23327
|
-
| undefined
|
|
23328
|
-
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
23329
|
-
latest_desired_state_synced_with_provider_at?:
|
|
23330
|
-
| (string | null)
|
|
23331
|
-
| undefined
|
|
23332
|
-
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23333
|
-
visionline_metadata?:
|
|
23334
23743
|
| {
|
|
23335
|
-
/**
|
|
23336
|
-
|
|
23337
|
-
/**
|
|
23338
|
-
|
|
23339
|
-
|
|
23340
|
-
guest_acs_entrance_ids?: string[] | undefined
|
|
23341
|
-
/** Common entrance IDs in the Visionline access system. */
|
|
23342
|
-
common_acs_entrance_ids?: string[] | undefined
|
|
23343
|
-
/** Indicates whether the credential is valid. */
|
|
23344
|
-
is_valid?: boolean | undefined
|
|
23345
|
-
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23346
|
-
auto_join?: boolean | undefined
|
|
23347
|
-
/** ID of the card in the Visionline access system. */
|
|
23348
|
-
card_id?: string | undefined
|
|
23349
|
-
/** ID of the credential in the Visionline access system. */
|
|
23350
|
-
credential_id?: string | undefined
|
|
23744
|
+
/** Date and time at which Seam created the error. */
|
|
23745
|
+
created_at: string
|
|
23746
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23747
|
+
message: string
|
|
23748
|
+
error_code: 'failed_to_create_on_acs_system'
|
|
23351
23749
|
}
|
|
23352
|
-
| undefined
|
|
23353
|
-
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23354
|
-
assa_abloy_vostio_metadata?:
|
|
23355
23750
|
| {
|
|
23356
|
-
/**
|
|
23357
|
-
|
|
23358
|
-
/**
|
|
23359
|
-
|
|
23360
|
-
|
|
23361
|
-
|
|
23362
|
-
|
|
23363
|
-
|
|
23364
|
-
|
|
23365
|
-
|
|
23366
|
-
|
|
23367
|
-
|
|
23751
|
+
/** Date and time at which Seam created the error. */
|
|
23752
|
+
created_at: string
|
|
23753
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23754
|
+
message: string
|
|
23755
|
+
error_code: 'failed_to_update_on_acs_system'
|
|
23756
|
+
}
|
|
23757
|
+
| {
|
|
23758
|
+
/** Date and time at which Seam created the error. */
|
|
23759
|
+
created_at: string
|
|
23760
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23761
|
+
message: string
|
|
23762
|
+
error_code: 'failed_to_delete_on_acs_system'
|
|
23763
|
+
}
|
|
23764
|
+
| {
|
|
23765
|
+
/** Date and time at which Seam created the error. */
|
|
23766
|
+
created_at: string
|
|
23767
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23768
|
+
message: string
|
|
23769
|
+
error_code: 'latch_conflict_with_resident_user'
|
|
23368
23770
|
}
|
|
23771
|
+
)[]
|
|
23772
|
+
/** Pending mutations associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */
|
|
23773
|
+
pending_mutations?:
|
|
23774
|
+
| (
|
|
23775
|
+
| {
|
|
23776
|
+
/** Date and time at which the mutation was created. */
|
|
23777
|
+
created_at: string
|
|
23778
|
+
/** Detailed description of the mutation. */
|
|
23779
|
+
message: string
|
|
23780
|
+
/** Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system. */
|
|
23781
|
+
mutation_code: 'creating'
|
|
23782
|
+
}
|
|
23783
|
+
| {
|
|
23784
|
+
/** Date and time at which the mutation was created. */
|
|
23785
|
+
created_at: string
|
|
23786
|
+
/** Detailed description of the mutation. */
|
|
23787
|
+
message: string
|
|
23788
|
+
/** Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system. */
|
|
23789
|
+
mutation_code: 'deleting'
|
|
23790
|
+
}
|
|
23791
|
+
| {
|
|
23792
|
+
/** Date and time at which the mutation was created. */
|
|
23793
|
+
created_at: string
|
|
23794
|
+
/** Detailed description of the mutation. */
|
|
23795
|
+
message: string
|
|
23796
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system. */
|
|
23797
|
+
mutation_code: 'updating_user_information'
|
|
23798
|
+
/** Old access system user information. */
|
|
23799
|
+
from: {
|
|
23800
|
+
/** Email address of the access system user. */
|
|
23801
|
+
email_address?: (string | null) | undefined
|
|
23802
|
+
/** Full name of the access system user. */
|
|
23803
|
+
full_name?: (string | null) | undefined
|
|
23804
|
+
/** Phone number of the access system user. */
|
|
23805
|
+
phone_number?: ((string | undefined) | null) | undefined
|
|
23806
|
+
}
|
|
23807
|
+
/** New access system user information. */
|
|
23808
|
+
to: {
|
|
23809
|
+
/** Email address of the access system user. */
|
|
23810
|
+
email_address?: (string | null) | undefined
|
|
23811
|
+
/** Full name of the access system user. */
|
|
23812
|
+
full_name?: (string | null) | undefined
|
|
23813
|
+
/** Phone number of the access system user. */
|
|
23814
|
+
phone_number?: ((string | undefined) | null) | undefined
|
|
23815
|
+
}
|
|
23816
|
+
}
|
|
23817
|
+
| {
|
|
23818
|
+
/** Date and time at which the mutation was created. */
|
|
23819
|
+
created_at: string
|
|
23820
|
+
/** Detailed description of the mutation. */
|
|
23821
|
+
message: string
|
|
23822
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system. */
|
|
23823
|
+
mutation_code: 'updating_access_schedule'
|
|
23824
|
+
/** Old access schedule information. */
|
|
23825
|
+
from: {
|
|
23826
|
+
/** Starting time for the access schedule. */
|
|
23827
|
+
starts_at: string | null
|
|
23828
|
+
/** Starting time for the access schedule. */
|
|
23829
|
+
ends_at: string | null
|
|
23830
|
+
}
|
|
23831
|
+
/** New access schedule information. */
|
|
23832
|
+
to: {
|
|
23833
|
+
/** Starting time for the access schedule. */
|
|
23834
|
+
starts_at: string | null
|
|
23835
|
+
/** Starting time for the access schedule. */
|
|
23836
|
+
ends_at: string | null
|
|
23837
|
+
}
|
|
23838
|
+
}
|
|
23839
|
+
| {
|
|
23840
|
+
/** Date and time at which the mutation was created. */
|
|
23841
|
+
created_at: string
|
|
23842
|
+
/** Detailed description of the mutation. */
|
|
23843
|
+
message: string
|
|
23844
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system. */
|
|
23845
|
+
mutation_code: 'updating_suspension_state'
|
|
23846
|
+
/** Old user suspension state information. */
|
|
23847
|
+
from: {
|
|
23848
|
+
is_suspended: boolean
|
|
23849
|
+
}
|
|
23850
|
+
/** New user suspension state information. */
|
|
23851
|
+
to: {
|
|
23852
|
+
is_suspended: boolean
|
|
23853
|
+
}
|
|
23854
|
+
}
|
|
23855
|
+
| {
|
|
23856
|
+
/** Date and time at which the mutation was created. */
|
|
23857
|
+
created_at: string
|
|
23858
|
+
/** Detailed description of the mutation. */
|
|
23859
|
+
message: string
|
|
23860
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system. */
|
|
23861
|
+
mutation_code: 'updating_group_membership'
|
|
23862
|
+
/** Old access group membership. */
|
|
23863
|
+
from: {
|
|
23864
|
+
/** Old access group ID. */
|
|
23865
|
+
acs_access_group_id: string | null
|
|
23866
|
+
}
|
|
23867
|
+
/** New access group membership. */
|
|
23868
|
+
to: {
|
|
23869
|
+
/** New access group ID. */
|
|
23870
|
+
acs_access_group_id: string | null
|
|
23871
|
+
}
|
|
23872
|
+
}
|
|
23873
|
+
)[]
|
|
23369
23874
|
| undefined
|
|
23875
|
+
/** The last time an internal sync job completed for this access system user. */
|
|
23876
|
+
last_successful_sync_at: string | null
|
|
23877
|
+
/**
|
|
23878
|
+
The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
|
|
23879
|
+
*/
|
|
23880
|
+
connected_account_id: string
|
|
23881
|
+
/** Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23882
|
+
full_name?: string | undefined
|
|
23883
|
+
/**
|
|
23884
|
+
* @deprecated use email_address.*/
|
|
23885
|
+
email?: string | undefined
|
|
23886
|
+
/** Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
23887
|
+
email_address?: string | undefined
|
|
23888
|
+
/** Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). */
|
|
23889
|
+
phone_number?: string | undefined
|
|
23370
23890
|
is_managed: true
|
|
23891
|
+
}[]
|
|
23892
|
+
}
|
|
23893
|
+
}
|
|
23894
|
+
'/acs/access_groups/remove_user': {
|
|
23895
|
+
route: '/acs/access_groups/remove_user'
|
|
23896
|
+
method: 'DELETE' | 'POST'
|
|
23897
|
+
queryParams: {}
|
|
23898
|
+
jsonBody: {}
|
|
23899
|
+
commonParams: {
|
|
23900
|
+
/** ID of the access group from which you want to remove an access system user. */
|
|
23901
|
+
acs_access_group_id: string
|
|
23902
|
+
/** ID of the access system user that you want to remove from an access group. */
|
|
23903
|
+
acs_user_id?: string | undefined
|
|
23904
|
+
/** ID of the user identity associated with the user that you want to remove from an access group. */
|
|
23905
|
+
user_identity_id?: string | undefined
|
|
23906
|
+
}
|
|
23907
|
+
formData: {}
|
|
23908
|
+
jsonResponse: {}
|
|
23909
|
+
}
|
|
23910
|
+
'/acs/access_groups/unmanaged/get': {
|
|
23911
|
+
route: '/acs/access_groups/unmanaged/get'
|
|
23912
|
+
method: 'GET' | 'POST'
|
|
23913
|
+
queryParams: {}
|
|
23914
|
+
jsonBody: {}
|
|
23915
|
+
commonParams: {
|
|
23916
|
+
/** ID of the unmanaged access group that you want to get. */
|
|
23917
|
+
acs_access_group_id: string
|
|
23918
|
+
}
|
|
23919
|
+
formData: {}
|
|
23920
|
+
jsonResponse: {
|
|
23921
|
+
/** */
|
|
23922
|
+
acs_access_group: {
|
|
23923
|
+
/** ID of the access group. */
|
|
23924
|
+
acs_access_group_id: string
|
|
23925
|
+
/** ID of the access control system that contains the access group. */
|
|
23926
|
+
acs_system_id: string
|
|
23927
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
23928
|
+
workspace_id: string
|
|
23929
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
23930
|
+
connected_account_id: string
|
|
23931
|
+
/** Name of the access group. */
|
|
23932
|
+
name: string
|
|
23933
|
+
/**
|
|
23934
|
+
* @deprecated Use `external_type`.*/
|
|
23935
|
+
access_group_type:
|
|
23936
|
+
| 'pti_unit'
|
|
23937
|
+
| 'pti_access_level'
|
|
23938
|
+
| 'salto_ks_access_group'
|
|
23939
|
+
| 'brivo_group'
|
|
23940
|
+
| 'salto_space_group'
|
|
23941
|
+
| 'dormakaba_community_access_group'
|
|
23942
|
+
/**
|
|
23943
|
+
* @deprecated Use `external_type_display_name`.*/
|
|
23944
|
+
access_group_type_display_name: string
|
|
23945
|
+
display_name: string
|
|
23946
|
+
/** Brand-specific terminology for the access group type. */
|
|
23947
|
+
external_type:
|
|
23948
|
+
| 'pti_unit'
|
|
23949
|
+
| 'pti_access_level'
|
|
23950
|
+
| 'salto_ks_access_group'
|
|
23951
|
+
| 'brivo_group'
|
|
23952
|
+
| 'salto_space_group'
|
|
23953
|
+
| 'dormakaba_community_access_group'
|
|
23954
|
+
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
23955
|
+
external_type_display_name: string
|
|
23956
|
+
/** Date and time at which the access group was created. */
|
|
23957
|
+
created_at: string
|
|
23958
|
+
/** Warnings associated with the `acs_access_group`. */
|
|
23959
|
+
warnings: {
|
|
23960
|
+
/** Date and time at which Seam created the warning. */
|
|
23961
|
+
created_at: string
|
|
23962
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23963
|
+
message: string
|
|
23964
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23965
|
+
warning_code: 'unknown_issue_with_acs_access_group'
|
|
23966
|
+
}[]
|
|
23967
|
+
is_managed: false
|
|
23371
23968
|
}
|
|
23372
23969
|
}
|
|
23373
23970
|
}
|
|
23374
|
-
'/acs/
|
|
23375
|
-
route: '/acs/
|
|
23971
|
+
'/acs/access_groups/unmanaged/list': {
|
|
23972
|
+
route: '/acs/access_groups/unmanaged/list'
|
|
23973
|
+
method: 'GET' | 'POST'
|
|
23974
|
+
queryParams: {}
|
|
23975
|
+
jsonBody: {}
|
|
23976
|
+
commonParams: {
|
|
23977
|
+
/** ID of the access system for which you want to retrieve all unmanaged access groups. */
|
|
23978
|
+
acs_system_id?: string | undefined
|
|
23979
|
+
/** ID of the access system user for which you want to retrieve all unmanaged access groups. */
|
|
23980
|
+
acs_user_id?: string | undefined
|
|
23981
|
+
}
|
|
23982
|
+
formData: {}
|
|
23983
|
+
jsonResponse: {
|
|
23984
|
+
acs_access_groups: {
|
|
23985
|
+
/** ID of the access group. */
|
|
23986
|
+
acs_access_group_id: string
|
|
23987
|
+
/** ID of the access control system that contains the access group. */
|
|
23988
|
+
acs_system_id: string
|
|
23989
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
23990
|
+
workspace_id: string
|
|
23991
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
23992
|
+
connected_account_id: string
|
|
23993
|
+
/** Name of the access group. */
|
|
23994
|
+
name: string
|
|
23995
|
+
/**
|
|
23996
|
+
* @deprecated Use `external_type`.*/
|
|
23997
|
+
access_group_type:
|
|
23998
|
+
| 'pti_unit'
|
|
23999
|
+
| 'pti_access_level'
|
|
24000
|
+
| 'salto_ks_access_group'
|
|
24001
|
+
| 'brivo_group'
|
|
24002
|
+
| 'salto_space_group'
|
|
24003
|
+
| 'dormakaba_community_access_group'
|
|
24004
|
+
/**
|
|
24005
|
+
* @deprecated Use `external_type_display_name`.*/
|
|
24006
|
+
access_group_type_display_name: string
|
|
24007
|
+
display_name: string
|
|
24008
|
+
/** Brand-specific terminology for the access group type. */
|
|
24009
|
+
external_type:
|
|
24010
|
+
| 'pti_unit'
|
|
24011
|
+
| 'pti_access_level'
|
|
24012
|
+
| 'salto_ks_access_group'
|
|
24013
|
+
| 'brivo_group'
|
|
24014
|
+
| 'salto_space_group'
|
|
24015
|
+
| 'dormakaba_community_access_group'
|
|
24016
|
+
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
24017
|
+
external_type_display_name: string
|
|
24018
|
+
/** Date and time at which the access group was created. */
|
|
24019
|
+
created_at: string
|
|
24020
|
+
/** Warnings associated with the `acs_access_group`. */
|
|
24021
|
+
warnings: {
|
|
24022
|
+
/** Date and time at which Seam created the warning. */
|
|
24023
|
+
created_at: string
|
|
24024
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24025
|
+
message: string
|
|
24026
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24027
|
+
warning_code: 'unknown_issue_with_acs_access_group'
|
|
24028
|
+
}[]
|
|
24029
|
+
is_managed: false
|
|
24030
|
+
}[]
|
|
24031
|
+
}
|
|
24032
|
+
}
|
|
24033
|
+
'/acs/credential_pools/list': {
|
|
24034
|
+
route: '/acs/credential_pools/list'
|
|
24035
|
+
method: 'GET' | 'POST'
|
|
24036
|
+
queryParams: {}
|
|
24037
|
+
jsonBody: {}
|
|
24038
|
+
commonParams: {
|
|
24039
|
+
/** ID of the access system for which you want to list credential pools. */
|
|
24040
|
+
acs_system_id: string
|
|
24041
|
+
}
|
|
24042
|
+
formData: {}
|
|
24043
|
+
jsonResponse: {
|
|
24044
|
+
acs_credential_pools: {
|
|
24045
|
+
acs_credential_pool_id: string
|
|
24046
|
+
acs_system_id: string
|
|
24047
|
+
display_name: string
|
|
24048
|
+
external_type: 'hid_part_number'
|
|
24049
|
+
external_type_display_name: string
|
|
24050
|
+
created_at: string
|
|
24051
|
+
workspace_id: string
|
|
24052
|
+
}[]
|
|
24053
|
+
}
|
|
24054
|
+
}
|
|
24055
|
+
'/acs/credential_provisioning_automations/launch': {
|
|
24056
|
+
route: '/acs/credential_provisioning_automations/launch'
|
|
23376
24057
|
method: 'POST'
|
|
23377
24058
|
queryParams: {}
|
|
23378
24059
|
jsonBody: {}
|
|
23379
24060
|
commonParams: {
|
|
23380
|
-
/** ID of the
|
|
23381
|
-
|
|
23382
|
-
/**
|
|
23383
|
-
|
|
23384
|
-
/**
|
|
23385
|
-
|
|
23386
|
-
/**
|
|
23387
|
-
|
|
23388
|
-
/**
|
|
23389
|
-
|
|
24061
|
+
/** ID of the user identity for which you want to launch a credential provisioning automation. */
|
|
24062
|
+
user_identity_id: string
|
|
24063
|
+
/** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
|
|
24064
|
+
credential_manager_acs_system_id: string
|
|
24065
|
+
/** ID of the credential pool for which you want to launch a credential provisioning automation. */
|
|
24066
|
+
acs_credential_pool_id?: string | undefined
|
|
24067
|
+
/** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
|
|
24068
|
+
create_credential_manager_user?: boolean | undefined
|
|
24069
|
+
/** 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`. */
|
|
24070
|
+
credential_manager_acs_user_id?: string | undefined
|
|
24071
|
+
}
|
|
24072
|
+
formData: {}
|
|
24073
|
+
jsonResponse: {
|
|
24074
|
+
/**
|
|
24075
|
+
* @deprecated Not used.*/
|
|
24076
|
+
acs_credential_provisioning_automation: {
|
|
24077
|
+
acs_credential_provisioning_automation_id: string
|
|
24078
|
+
credential_manager_acs_system_id: string
|
|
24079
|
+
user_identity_id: string
|
|
24080
|
+
created_at: string
|
|
24081
|
+
workspace_id: string
|
|
24082
|
+
}
|
|
24083
|
+
}
|
|
24084
|
+
}
|
|
24085
|
+
'/acs/credentials/assign': {
|
|
24086
|
+
route: '/acs/credentials/assign'
|
|
24087
|
+
method: 'PATCH' | 'POST'
|
|
24088
|
+
queryParams: {}
|
|
24089
|
+
jsonBody: {
|
|
24090
|
+
/** ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. */
|
|
24091
|
+
acs_user_id?: string | undefined
|
|
24092
|
+
/** ID of the user identity to whom you want to assign a credential. 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 credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
|
|
24093
|
+
user_identity_id?: string | undefined
|
|
24094
|
+
/** ID of the credential that you want to assign to an access system user. */
|
|
24095
|
+
acs_credential_id: string
|
|
23390
24096
|
}
|
|
24097
|
+
commonParams: {}
|
|
23391
24098
|
formData: {}
|
|
23392
24099
|
jsonResponse: {
|
|
23393
24100
|
/** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
@@ -23554,26 +24261,68 @@ export type Routes = {
|
|
|
23554
24261
|
}
|
|
23555
24262
|
}
|
|
23556
24263
|
}
|
|
23557
|
-
'/acs/credentials/
|
|
23558
|
-
route: '/acs/credentials/
|
|
23559
|
-
method: '
|
|
23560
|
-
queryParams: {}
|
|
23561
|
-
jsonBody: {}
|
|
23562
|
-
commonParams: {
|
|
23563
|
-
/** ID of the credential that you want to delete. */
|
|
23564
|
-
acs_credential_id: string
|
|
23565
|
-
}
|
|
23566
|
-
formData: {}
|
|
23567
|
-
jsonResponse: {}
|
|
23568
|
-
}
|
|
23569
|
-
'/acs/credentials/get': {
|
|
23570
|
-
route: '/acs/credentials/get'
|
|
23571
|
-
method: 'GET' | 'POST'
|
|
24264
|
+
'/acs/credentials/create': {
|
|
24265
|
+
route: '/acs/credentials/create'
|
|
24266
|
+
method: 'POST'
|
|
23572
24267
|
queryParams: {}
|
|
23573
24268
|
jsonBody: {}
|
|
23574
24269
|
commonParams: {
|
|
23575
|
-
/** ID of the credential
|
|
23576
|
-
|
|
24270
|
+
/** ACS system ID of the credential manager for the new credential. */
|
|
24271
|
+
credential_manager_acs_system_id?: string | undefined
|
|
24272
|
+
/** 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`. */
|
|
24273
|
+
acs_user_id?: string | undefined
|
|
24274
|
+
/** ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created. */
|
|
24275
|
+
user_identity_id?: string | undefined
|
|
24276
|
+
/** ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
|
|
24277
|
+
acs_system_id?: string | undefined
|
|
24278
|
+
/** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. */
|
|
24279
|
+
access_method: 'code' | 'card' | 'mobile_key'
|
|
24280
|
+
/** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview). */
|
|
24281
|
+
code?: string | undefined
|
|
24282
|
+
/** Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
24283
|
+
is_multi_phone_sync_credential?: boolean
|
|
24284
|
+
/** Set of IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
|
|
24285
|
+
allowed_acs_entrance_ids?: string[]
|
|
24286
|
+
/** Visionline-specific metadata for the new credential. */
|
|
24287
|
+
visionline_metadata?:
|
|
24288
|
+
| {
|
|
24289
|
+
/**
|
|
24290
|
+
* @deprecated Read-only endpoint references moved to `endpoint`.*/
|
|
24291
|
+
assa_abloy_credential_service_mobile_endpoint_id?:
|
|
24292
|
+
| string
|
|
24293
|
+
| undefined
|
|
24294
|
+
card_format?: ('TLCode' | 'rfid48') | undefined
|
|
24295
|
+
card_function_type?: 'guest' | 'staff'
|
|
24296
|
+
/**
|
|
24297
|
+
* @deprecated Use `override` instead.*/
|
|
24298
|
+
is_override_key?: boolean | undefined
|
|
24299
|
+
override?: boolean | undefined
|
|
24300
|
+
auto_join?: boolean | undefined
|
|
24301
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
24302
|
+
}
|
|
24303
|
+
| undefined
|
|
24304
|
+
/** Vostio-specific metadata for the new credential. */
|
|
24305
|
+
assa_abloy_vostio_metadata?:
|
|
24306
|
+
| {
|
|
24307
|
+
auto_join?: boolean | undefined
|
|
24308
|
+
override_all_guest_acs_entrances?: boolean | undefined
|
|
24309
|
+
join_all_guest_acs_entrances?: boolean | undefined
|
|
24310
|
+
override_guest_acs_entrance_ids?: string[] | undefined
|
|
24311
|
+
}
|
|
24312
|
+
| undefined
|
|
24313
|
+
/** Salto Space-specific metadata for the new credential. */
|
|
24314
|
+
salto_space_metadata?:
|
|
24315
|
+
| {
|
|
24316
|
+
/** Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
|
|
24317
|
+
assign_new_key?: boolean | undefined
|
|
24318
|
+
/** Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
|
|
24319
|
+
update_current_key?: boolean | undefined
|
|
24320
|
+
}
|
|
24321
|
+
| undefined
|
|
24322
|
+
/** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
24323
|
+
starts_at?: string | undefined
|
|
24324
|
+
/** 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`. */
|
|
24325
|
+
ends_at?: string | undefined
|
|
23577
24326
|
}
|
|
23578
24327
|
formData: {}
|
|
23579
24328
|
jsonResponse: {
|
|
@@ -23741,21 +24490,391 @@ export type Routes = {
|
|
|
23741
24490
|
}
|
|
23742
24491
|
}
|
|
23743
24492
|
}
|
|
23744
|
-
'/acs/credentials/
|
|
23745
|
-
route: '/acs/credentials/
|
|
23746
|
-
method: '
|
|
24493
|
+
'/acs/credentials/create_offline_code': {
|
|
24494
|
+
route: '/acs/credentials/create_offline_code'
|
|
24495
|
+
method: 'POST'
|
|
23747
24496
|
queryParams: {}
|
|
23748
24497
|
jsonBody: {}
|
|
23749
|
-
commonParams:
|
|
23750
|
-
|
|
23751
|
-
|
|
23752
|
-
|
|
23753
|
-
|
|
23754
|
-
|
|
23755
|
-
|
|
23756
|
-
|
|
23757
|
-
|
|
23758
|
-
|
|
24498
|
+
commonParams: {
|
|
24499
|
+
/** ID of the access system user to whom the new credential belongs. */
|
|
24500
|
+
acs_user_id: string
|
|
24501
|
+
/** IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
|
|
24502
|
+
allowed_acs_entrance_id: string
|
|
24503
|
+
/** Indicates whether the code is one-time-use or reusable. */
|
|
24504
|
+
is_one_time_use?: boolean
|
|
24505
|
+
/** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
24506
|
+
starts_at?: string | undefined
|
|
24507
|
+
/** 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`. */
|
|
24508
|
+
ends_at?: string | undefined
|
|
24509
|
+
}
|
|
24510
|
+
formData: {}
|
|
24511
|
+
jsonResponse: {
|
|
24512
|
+
/** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
24513
|
+
|
|
24514
|
+
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
24515
|
+
|
|
24516
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
|
|
24517
|
+
acs_credential: {
|
|
24518
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24519
|
+
acs_credential_id: string
|
|
24520
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
24521
|
+
acs_user_id?: string | undefined
|
|
24522
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
24523
|
+
user_identity_id?: string | undefined
|
|
24524
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
24525
|
+
connected_account_id: string
|
|
24526
|
+
acs_credential_pool_id?: string | undefined
|
|
24527
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24528
|
+
acs_system_id: string
|
|
24529
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24530
|
+
parent_acs_credential_id?: string | undefined
|
|
24531
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
24532
|
+
display_name: string
|
|
24533
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24534
|
+
code?: (string | undefined) | null
|
|
24535
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
24536
|
+
is_one_time_use?: boolean | undefined
|
|
24537
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24538
|
+
card_number?: (string | undefined) | null
|
|
24539
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
24540
|
+
is_issued?: boolean | undefined
|
|
24541
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
24542
|
+
issued_at?: (string | undefined) | null
|
|
24543
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
24544
|
+
access_method: 'code' | 'card' | 'mobile_key'
|
|
24545
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
24546
|
+
external_type?:
|
|
24547
|
+
| (
|
|
24548
|
+
| 'pti_card'
|
|
24549
|
+
| 'brivo_credential'
|
|
24550
|
+
| 'hid_credential'
|
|
24551
|
+
| 'visionline_card'
|
|
24552
|
+
| 'salto_ks_credential'
|
|
24553
|
+
| 'assa_abloy_vostio_key'
|
|
24554
|
+
| 'salto_space_key'
|
|
24555
|
+
| 'latch_access'
|
|
24556
|
+
)
|
|
24557
|
+
| undefined
|
|
24558
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
24559
|
+
external_type_display_name?: string | undefined
|
|
24560
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
24561
|
+
created_at: string
|
|
24562
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24563
|
+
workspace_id: string
|
|
24564
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
24565
|
+
starts_at?: string | undefined
|
|
24566
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity 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`. */
|
|
24567
|
+
ends_at?: string | undefined
|
|
24568
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24569
|
+
errors: {
|
|
24570
|
+
error_code: string
|
|
24571
|
+
message: string
|
|
24572
|
+
}[]
|
|
24573
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24574
|
+
warnings: (
|
|
24575
|
+
| {
|
|
24576
|
+
/** Date and time at which Seam created the warning. */
|
|
24577
|
+
created_at: string
|
|
24578
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24579
|
+
message: string
|
|
24580
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24581
|
+
warning_code: 'waiting_to_be_issued'
|
|
24582
|
+
}
|
|
24583
|
+
| {
|
|
24584
|
+
/** Date and time at which Seam created the warning. */
|
|
24585
|
+
created_at: string
|
|
24586
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24587
|
+
message: string
|
|
24588
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24589
|
+
warning_code: 'schedule_externally_modified'
|
|
24590
|
+
}
|
|
24591
|
+
| {
|
|
24592
|
+
/** Date and time at which Seam created the warning. */
|
|
24593
|
+
created_at: string
|
|
24594
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24595
|
+
message: string
|
|
24596
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24597
|
+
warning_code: 'schedule_modified'
|
|
24598
|
+
}
|
|
24599
|
+
| {
|
|
24600
|
+
/** Date and time at which Seam created the warning. */
|
|
24601
|
+
created_at: string
|
|
24602
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24603
|
+
message: string
|
|
24604
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24605
|
+
warning_code: 'being_deleted'
|
|
24606
|
+
}
|
|
24607
|
+
| {
|
|
24608
|
+
/** Date and time at which Seam created the warning. */
|
|
24609
|
+
created_at: string
|
|
24610
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24611
|
+
message: string
|
|
24612
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24613
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
24614
|
+
}
|
|
24615
|
+
| {
|
|
24616
|
+
/** Date and time at which Seam created the warning. */
|
|
24617
|
+
created_at: string
|
|
24618
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24619
|
+
message: string
|
|
24620
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24621
|
+
warning_code: 'needs_to_be_reissued'
|
|
24622
|
+
}
|
|
24623
|
+
)[]
|
|
24624
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
24625
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
24626
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
24627
|
+
is_latest_desired_state_synced_with_provider?:
|
|
24628
|
+
| (boolean | null)
|
|
24629
|
+
| undefined
|
|
24630
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
24631
|
+
latest_desired_state_synced_with_provider_at?:
|
|
24632
|
+
| (string | null)
|
|
24633
|
+
| undefined
|
|
24634
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24635
|
+
visionline_metadata?:
|
|
24636
|
+
| {
|
|
24637
|
+
/** Card function type in the Visionline access system. */
|
|
24638
|
+
card_function_type: 'guest' | 'staff'
|
|
24639
|
+
/** IDs of the credentials to which you want to join. */
|
|
24640
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
24641
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
24642
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
24643
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
24644
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
24645
|
+
/** Indicates whether the credential is valid. */
|
|
24646
|
+
is_valid?: boolean | undefined
|
|
24647
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
24648
|
+
auto_join?: boolean | undefined
|
|
24649
|
+
/** ID of the card in the Visionline access system. */
|
|
24650
|
+
card_id?: string | undefined
|
|
24651
|
+
/** ID of the credential in the Visionline access system. */
|
|
24652
|
+
credential_id?: string | undefined
|
|
24653
|
+
}
|
|
24654
|
+
| undefined
|
|
24655
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24656
|
+
assa_abloy_vostio_metadata?:
|
|
24657
|
+
| {
|
|
24658
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
24659
|
+
auto_join?: boolean | undefined
|
|
24660
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
24661
|
+
override_guest_acs_entrance_ids?: string[] | undefined
|
|
24662
|
+
/** Key ID in the Vostio access system. */
|
|
24663
|
+
key_id?: string | undefined
|
|
24664
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
24665
|
+
key_issuing_request_id?: string | undefined
|
|
24666
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
24667
|
+
door_names?: string[] | undefined
|
|
24668
|
+
/** Endpoint ID in the Vostio access system. */
|
|
24669
|
+
endpoint_id?: string | undefined
|
|
24670
|
+
}
|
|
24671
|
+
| undefined
|
|
24672
|
+
is_managed: true
|
|
24673
|
+
}
|
|
24674
|
+
}
|
|
24675
|
+
}
|
|
24676
|
+
'/acs/credentials/delete': {
|
|
24677
|
+
route: '/acs/credentials/delete'
|
|
24678
|
+
method: 'DELETE' | 'POST'
|
|
24679
|
+
queryParams: {}
|
|
24680
|
+
jsonBody: {}
|
|
24681
|
+
commonParams: {
|
|
24682
|
+
/** ID of the credential that you want to delete. */
|
|
24683
|
+
acs_credential_id: string
|
|
24684
|
+
}
|
|
24685
|
+
formData: {}
|
|
24686
|
+
jsonResponse: {}
|
|
24687
|
+
}
|
|
24688
|
+
'/acs/credentials/get': {
|
|
24689
|
+
route: '/acs/credentials/get'
|
|
24690
|
+
method: 'GET' | 'POST'
|
|
24691
|
+
queryParams: {}
|
|
24692
|
+
jsonBody: {}
|
|
24693
|
+
commonParams: {
|
|
24694
|
+
/** ID of the credential that you want to get. */
|
|
24695
|
+
acs_credential_id: string
|
|
24696
|
+
}
|
|
24697
|
+
formData: {}
|
|
24698
|
+
jsonResponse: {
|
|
24699
|
+
/** Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
24700
|
+
|
|
24701
|
+
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
24702
|
+
|
|
24703
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. */
|
|
24704
|
+
acs_credential: {
|
|
24705
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24706
|
+
acs_credential_id: string
|
|
24707
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
24708
|
+
acs_user_id?: string | undefined
|
|
24709
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
24710
|
+
user_identity_id?: string | undefined
|
|
24711
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
24712
|
+
connected_account_id: string
|
|
24713
|
+
acs_credential_pool_id?: string | undefined
|
|
24714
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24715
|
+
acs_system_id: string
|
|
24716
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24717
|
+
parent_acs_credential_id?: string | undefined
|
|
24718
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
24719
|
+
display_name: string
|
|
24720
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24721
|
+
code?: (string | undefined) | null
|
|
24722
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
24723
|
+
is_one_time_use?: boolean | undefined
|
|
24724
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24725
|
+
card_number?: (string | undefined) | null
|
|
24726
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
24727
|
+
is_issued?: boolean | undefined
|
|
24728
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
24729
|
+
issued_at?: (string | undefined) | null
|
|
24730
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
24731
|
+
access_method: 'code' | 'card' | 'mobile_key'
|
|
24732
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
24733
|
+
external_type?:
|
|
24734
|
+
| (
|
|
24735
|
+
| 'pti_card'
|
|
24736
|
+
| 'brivo_credential'
|
|
24737
|
+
| 'hid_credential'
|
|
24738
|
+
| 'visionline_card'
|
|
24739
|
+
| 'salto_ks_credential'
|
|
24740
|
+
| 'assa_abloy_vostio_key'
|
|
24741
|
+
| 'salto_space_key'
|
|
24742
|
+
| 'latch_access'
|
|
24743
|
+
)
|
|
24744
|
+
| undefined
|
|
24745
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
24746
|
+
external_type_display_name?: string | undefined
|
|
24747
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
24748
|
+
created_at: string
|
|
24749
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24750
|
+
workspace_id: string
|
|
24751
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
24752
|
+
starts_at?: string | undefined
|
|
24753
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity 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`. */
|
|
24754
|
+
ends_at?: string | undefined
|
|
24755
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24756
|
+
errors: {
|
|
24757
|
+
error_code: string
|
|
24758
|
+
message: string
|
|
24759
|
+
}[]
|
|
24760
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24761
|
+
warnings: (
|
|
24762
|
+
| {
|
|
24763
|
+
/** Date and time at which Seam created the warning. */
|
|
24764
|
+
created_at: string
|
|
24765
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24766
|
+
message: string
|
|
24767
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24768
|
+
warning_code: 'waiting_to_be_issued'
|
|
24769
|
+
}
|
|
24770
|
+
| {
|
|
24771
|
+
/** Date and time at which Seam created the warning. */
|
|
24772
|
+
created_at: string
|
|
24773
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24774
|
+
message: string
|
|
24775
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24776
|
+
warning_code: 'schedule_externally_modified'
|
|
24777
|
+
}
|
|
24778
|
+
| {
|
|
24779
|
+
/** Date and time at which Seam created the warning. */
|
|
24780
|
+
created_at: string
|
|
24781
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24782
|
+
message: string
|
|
24783
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24784
|
+
warning_code: 'schedule_modified'
|
|
24785
|
+
}
|
|
24786
|
+
| {
|
|
24787
|
+
/** Date and time at which Seam created the warning. */
|
|
24788
|
+
created_at: string
|
|
24789
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24790
|
+
message: string
|
|
24791
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24792
|
+
warning_code: 'being_deleted'
|
|
24793
|
+
}
|
|
24794
|
+
| {
|
|
24795
|
+
/** Date and time at which Seam created the warning. */
|
|
24796
|
+
created_at: string
|
|
24797
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24798
|
+
message: string
|
|
24799
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24800
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
24801
|
+
}
|
|
24802
|
+
| {
|
|
24803
|
+
/** Date and time at which Seam created the warning. */
|
|
24804
|
+
created_at: string
|
|
24805
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
24806
|
+
message: string
|
|
24807
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
24808
|
+
warning_code: 'needs_to_be_reissued'
|
|
24809
|
+
}
|
|
24810
|
+
)[]
|
|
24811
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
24812
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
24813
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
24814
|
+
is_latest_desired_state_synced_with_provider?:
|
|
24815
|
+
| (boolean | null)
|
|
24816
|
+
| undefined
|
|
24817
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
24818
|
+
latest_desired_state_synced_with_provider_at?:
|
|
24819
|
+
| (string | null)
|
|
24820
|
+
| undefined
|
|
24821
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24822
|
+
visionline_metadata?:
|
|
24823
|
+
| {
|
|
24824
|
+
/** Card function type in the Visionline access system. */
|
|
24825
|
+
card_function_type: 'guest' | 'staff'
|
|
24826
|
+
/** IDs of the credentials to which you want to join. */
|
|
24827
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
24828
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
24829
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
24830
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
24831
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
24832
|
+
/** Indicates whether the credential is valid. */
|
|
24833
|
+
is_valid?: boolean | undefined
|
|
24834
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
24835
|
+
auto_join?: boolean | undefined
|
|
24836
|
+
/** ID of the card in the Visionline access system. */
|
|
24837
|
+
card_id?: string | undefined
|
|
24838
|
+
/** ID of the credential in the Visionline access system. */
|
|
24839
|
+
credential_id?: string | undefined
|
|
24840
|
+
}
|
|
24841
|
+
| undefined
|
|
24842
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
24843
|
+
assa_abloy_vostio_metadata?:
|
|
24844
|
+
| {
|
|
24845
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
24846
|
+
auto_join?: boolean | undefined
|
|
24847
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
24848
|
+
override_guest_acs_entrance_ids?: string[] | undefined
|
|
24849
|
+
/** Key ID in the Vostio access system. */
|
|
24850
|
+
key_id?: string | undefined
|
|
24851
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
24852
|
+
key_issuing_request_id?: string | undefined
|
|
24853
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
24854
|
+
door_names?: string[] | undefined
|
|
24855
|
+
/** Endpoint ID in the Vostio access system. */
|
|
24856
|
+
endpoint_id?: string | undefined
|
|
24857
|
+
}
|
|
24858
|
+
| undefined
|
|
24859
|
+
is_managed: true
|
|
24860
|
+
}
|
|
24861
|
+
}
|
|
24862
|
+
}
|
|
24863
|
+
'/acs/credentials/list': {
|
|
24864
|
+
route: '/acs/credentials/list'
|
|
24865
|
+
method: 'GET' | 'POST'
|
|
24866
|
+
queryParams: {}
|
|
24867
|
+
jsonBody: {}
|
|
24868
|
+
commonParams: (
|
|
24869
|
+
| {
|
|
24870
|
+
/** ID of the access system user for which you want to retrieve all credentials. */
|
|
24871
|
+
acs_user_id: string
|
|
24872
|
+
}
|
|
24873
|
+
| {
|
|
24874
|
+
/** ID of the access system for which you want to retrieve all credentials. */
|
|
24875
|
+
acs_system_id: string
|
|
24876
|
+
}
|
|
24877
|
+
| {
|
|
23759
24878
|
/** ID of the access system user for which you want to retrieve all credentials. */
|
|
23760
24879
|
acs_user_id: string
|
|
23761
24880
|
/** ID of the access system for which you want to retrieve all credentials. */
|
|
@@ -44470,6 +45589,19 @@ export type Routes = {
|
|
|
44470
45589
|
user_identity_id: string
|
|
44471
45590
|
/** Date and time at which the Instant Key expires. */
|
|
44472
45591
|
expires_at: string
|
|
45592
|
+
/** ID of the customization profile associated with the Instant Key. */
|
|
45593
|
+
customization_profile_id?: string | undefined
|
|
45594
|
+
/** Customization profile associated with the Instant Key. */
|
|
45595
|
+
customization_profile?:
|
|
45596
|
+
| {
|
|
45597
|
+
/** Primary color of the customization profile. */
|
|
45598
|
+
primary_color?: string | undefined
|
|
45599
|
+
/** Secondary color of the customization profile. */
|
|
45600
|
+
secondary_color?: string | undefined
|
|
45601
|
+
/** URL of the logo associated with the customization profile. */
|
|
45602
|
+
logo_url?: string | undefined
|
|
45603
|
+
}
|
|
45604
|
+
| undefined
|
|
44473
45605
|
}
|
|
44474
45606
|
}
|
|
44475
45607
|
}
|
|
@@ -44499,6 +45631,19 @@ export type Routes = {
|
|
|
44499
45631
|
user_identity_id: string
|
|
44500
45632
|
/** Date and time at which the Instant Key expires. */
|
|
44501
45633
|
expires_at: string
|
|
45634
|
+
/** ID of the customization profile associated with the Instant Key. */
|
|
45635
|
+
customization_profile_id?: string | undefined
|
|
45636
|
+
/** Customization profile associated with the Instant Key. */
|
|
45637
|
+
customization_profile?:
|
|
45638
|
+
| {
|
|
45639
|
+
/** Primary color of the customization profile. */
|
|
45640
|
+
primary_color?: string | undefined
|
|
45641
|
+
/** Secondary color of the customization profile. */
|
|
45642
|
+
secondary_color?: string | undefined
|
|
45643
|
+
/** URL of the logo associated with the customization profile. */
|
|
45644
|
+
logo_url?: string | undefined
|
|
45645
|
+
}
|
|
45646
|
+
| undefined
|
|
44502
45647
|
}[]
|
|
44503
45648
|
}
|
|
44504
45649
|
}
|
|
@@ -88614,6 +89759,7 @@ export type Routes = {
|
|
|
88614
89759
|
queryParams: {}
|
|
88615
89760
|
jsonBody: {}
|
|
88616
89761
|
commonParams: {
|
|
89762
|
+
customization_profile_id?: string | undefined
|
|
88617
89763
|
/** ID of the user identity for which you want to generate an instant key. */
|
|
88618
89764
|
user_identity_id: string
|
|
88619
89765
|
/** Maximum number of times the instant key can be used. Default: 1. */
|
|
@@ -88639,6 +89785,19 @@ export type Routes = {
|
|
|
88639
89785
|
user_identity_id: string
|
|
88640
89786
|
/** Date and time at which the Instant Key expires. */
|
|
88641
89787
|
expires_at: string
|
|
89788
|
+
/** ID of the customization profile associated with the Instant Key. */
|
|
89789
|
+
customization_profile_id?: string | undefined
|
|
89790
|
+
/** Customization profile associated with the Instant Key. */
|
|
89791
|
+
customization_profile?:
|
|
89792
|
+
| {
|
|
89793
|
+
/** Primary color of the customization profile. */
|
|
89794
|
+
primary_color?: string | undefined
|
|
89795
|
+
/** Secondary color of the customization profile. */
|
|
89796
|
+
secondary_color?: string | undefined
|
|
89797
|
+
/** URL of the logo associated with the customization profile. */
|
|
89798
|
+
logo_url?: string | undefined
|
|
89799
|
+
}
|
|
89800
|
+
| undefined
|
|
88642
89801
|
}
|
|
88643
89802
|
}
|
|
88644
89803
|
}
|
|
@@ -99688,6 +100847,1125 @@ export type Routes = {
|
|
|
99688
100847
|
user_identity_id: string
|
|
99689
100848
|
/** Date and time at which the Instant Key expires. */
|
|
99690
100849
|
expires_at: string
|
|
100850
|
+
/** ID of the customization profile associated with the Instant Key. */
|
|
100851
|
+
customization_profile_id?: string | undefined
|
|
100852
|
+
/** Customization profile associated with the Instant Key. */
|
|
100853
|
+
customization_profile?:
|
|
100854
|
+
| {
|
|
100855
|
+
/** Primary color of the customization profile. */
|
|
100856
|
+
primary_color?: string | undefined
|
|
100857
|
+
/** Secondary color of the customization profile. */
|
|
100858
|
+
secondary_color?: string | undefined
|
|
100859
|
+
/** URL of the logo associated with the customization profile. */
|
|
100860
|
+
logo_url?: string | undefined
|
|
100861
|
+
}
|
|
100862
|
+
| undefined
|
|
100863
|
+
}[]
|
|
100864
|
+
| undefined
|
|
100865
|
+
access_codes?:
|
|
100866
|
+
| {
|
|
100867
|
+
/** Unique identifier for a group of access codes that share the same code. */
|
|
100868
|
+
common_code_key: string | null
|
|
100869
|
+
/** Indicates whether the code is set on the device according to a preconfigured schedule. */
|
|
100870
|
+
is_scheduled_on_device?: boolean | undefined
|
|
100871
|
+
/** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
|
|
100872
|
+
type: 'time_bound' | 'ongoing'
|
|
100873
|
+
/** Indicates whether the access code is waiting for a code assignment. */
|
|
100874
|
+
is_waiting_for_code_assignment?: boolean | undefined
|
|
100875
|
+
/** Unique identifier for the access code. */
|
|
100876
|
+
access_code_id: string
|
|
100877
|
+
/** Unique identifier for the device associated with the access code. */
|
|
100878
|
+
device_id: string
|
|
100879
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
100880
|
+
name: string | null
|
|
100881
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
100882
|
+
code: string | null
|
|
100883
|
+
/** Date and time at which the access code was created. */
|
|
100884
|
+
created_at: string
|
|
100885
|
+
/** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
100886
|
+
errors: (
|
|
100887
|
+
| {
|
|
100888
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100889
|
+
message: string
|
|
100890
|
+
/** Indicates that this is an access code error. */
|
|
100891
|
+
is_access_code_error: true
|
|
100892
|
+
/** Date and time at which Seam created the error. */
|
|
100893
|
+
created_at?: string | undefined
|
|
100894
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100895
|
+
error_code: 'smartthings_failed_to_set_access_code'
|
|
100896
|
+
}
|
|
100897
|
+
| {
|
|
100898
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100899
|
+
message: string
|
|
100900
|
+
/** Indicates that this is an access code error. */
|
|
100901
|
+
is_access_code_error: true
|
|
100902
|
+
/** Date and time at which Seam created the error. */
|
|
100903
|
+
created_at?: string | undefined
|
|
100904
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100905
|
+
error_code: 'smartthings_failed_to_set_after_multiple_retries'
|
|
100906
|
+
}
|
|
100907
|
+
| {
|
|
100908
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100909
|
+
message: string
|
|
100910
|
+
/** Indicates that this is an access code error. */
|
|
100911
|
+
is_access_code_error: true
|
|
100912
|
+
/** Date and time at which Seam created the error. */
|
|
100913
|
+
created_at?: string | undefined
|
|
100914
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100915
|
+
error_code: 'smartthings_no_free_slots_available'
|
|
100916
|
+
}
|
|
100917
|
+
| {
|
|
100918
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100919
|
+
message: string
|
|
100920
|
+
/** Indicates that this is an access code error. */
|
|
100921
|
+
is_access_code_error: true
|
|
100922
|
+
/** Date and time at which Seam created the error. */
|
|
100923
|
+
created_at?: string | undefined
|
|
100924
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100925
|
+
error_code: 'failed_to_set_on_device'
|
|
100926
|
+
}
|
|
100927
|
+
| {
|
|
100928
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100929
|
+
message: string
|
|
100930
|
+
/** Indicates that this is an access code error. */
|
|
100931
|
+
is_access_code_error: true
|
|
100932
|
+
/** Date and time at which Seam created the error. */
|
|
100933
|
+
created_at?: string | undefined
|
|
100934
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100935
|
+
error_code: 'failed_to_remove_from_device'
|
|
100936
|
+
}
|
|
100937
|
+
| {
|
|
100938
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100939
|
+
message: string
|
|
100940
|
+
/** Indicates that this is an access code error. */
|
|
100941
|
+
is_access_code_error: true
|
|
100942
|
+
/** Date and time at which Seam created the error. */
|
|
100943
|
+
created_at?: string | undefined
|
|
100944
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100945
|
+
error_code: 'duplicate_code_on_device'
|
|
100946
|
+
}
|
|
100947
|
+
| {
|
|
100948
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100949
|
+
message: string
|
|
100950
|
+
/** Indicates that this is an access code error. */
|
|
100951
|
+
is_access_code_error: true
|
|
100952
|
+
/** Date and time at which Seam created the error. */
|
|
100953
|
+
created_at?: string | undefined
|
|
100954
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100955
|
+
error_code: 'duplicate_code_attempt_prevented'
|
|
100956
|
+
}
|
|
100957
|
+
| {
|
|
100958
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100959
|
+
message: string
|
|
100960
|
+
/** Indicates that this is an access code error. */
|
|
100961
|
+
is_access_code_error: true
|
|
100962
|
+
/** Date and time at which Seam created the error. */
|
|
100963
|
+
created_at?: string | undefined
|
|
100964
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100965
|
+
error_code: 'no_space_for_access_code_on_device'
|
|
100966
|
+
}
|
|
100967
|
+
| {
|
|
100968
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100969
|
+
message: string
|
|
100970
|
+
/** Indicates that this is an access code error. */
|
|
100971
|
+
is_access_code_error: true
|
|
100972
|
+
/** Date and time at which Seam created the error. */
|
|
100973
|
+
created_at?: string | undefined
|
|
100974
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100975
|
+
error_code: 'igloohome_bridge_too_many_pending_jobs'
|
|
100976
|
+
}
|
|
100977
|
+
| {
|
|
100978
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100979
|
+
message: string
|
|
100980
|
+
/** Indicates that this is an access code error. */
|
|
100981
|
+
is_access_code_error: true
|
|
100982
|
+
/** Date and time at which Seam created the error. */
|
|
100983
|
+
created_at?: string | undefined
|
|
100984
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100985
|
+
error_code: 'igloohome_bridge_offline'
|
|
100986
|
+
}
|
|
100987
|
+
| {
|
|
100988
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100989
|
+
message: string
|
|
100990
|
+
/** Indicates that this is an access code error. */
|
|
100991
|
+
is_access_code_error: true
|
|
100992
|
+
/** Date and time at which Seam created the error. */
|
|
100993
|
+
created_at?: string | undefined
|
|
100994
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
100995
|
+
error_code: 'igloohome_offline_access_code_no_variance_available'
|
|
100996
|
+
}
|
|
100997
|
+
| {
|
|
100998
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100999
|
+
message: string
|
|
101000
|
+
/** Indicates that this is an access code error. */
|
|
101001
|
+
is_access_code_error: true
|
|
101002
|
+
/** Date and time at which Seam created the error. */
|
|
101003
|
+
created_at?: string | undefined
|
|
101004
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101005
|
+
error_code: 'kwikset_unable_to_confirm_code'
|
|
101006
|
+
}
|
|
101007
|
+
| {
|
|
101008
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101009
|
+
message: string
|
|
101010
|
+
/** Indicates that this is an access code error. */
|
|
101011
|
+
is_access_code_error: true
|
|
101012
|
+
/** Date and time at which Seam created the error. */
|
|
101013
|
+
created_at?: string | undefined
|
|
101014
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101015
|
+
error_code: 'kwikset_unable_to_confirm_deletion'
|
|
101016
|
+
}
|
|
101017
|
+
| {
|
|
101018
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101019
|
+
message: string
|
|
101020
|
+
/** Indicates that this is an access code error. */
|
|
101021
|
+
is_access_code_error: true
|
|
101022
|
+
/** Date and time at which Seam created the error. */
|
|
101023
|
+
created_at?: string | undefined
|
|
101024
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101025
|
+
error_code: 'code_modified_external_to_seam'
|
|
101026
|
+
}
|
|
101027
|
+
| {
|
|
101028
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101029
|
+
message: string
|
|
101030
|
+
/** Indicates that this is an access code error. */
|
|
101031
|
+
is_access_code_error: true
|
|
101032
|
+
/** Date and time at which Seam created the error. */
|
|
101033
|
+
created_at?: string | undefined
|
|
101034
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101035
|
+
error_code: 'august_lock_invalid_code_length'
|
|
101036
|
+
}
|
|
101037
|
+
| {
|
|
101038
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101039
|
+
message: string
|
|
101040
|
+
/** Indicates that this is an access code error. */
|
|
101041
|
+
is_access_code_error: true
|
|
101042
|
+
/** Date and time at which Seam created the error. */
|
|
101043
|
+
created_at?: string | undefined
|
|
101044
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101045
|
+
error_code: 'august_device_programming_delay'
|
|
101046
|
+
}
|
|
101047
|
+
| {
|
|
101048
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101049
|
+
message: string
|
|
101050
|
+
/** Indicates that this is an access code error. */
|
|
101051
|
+
is_access_code_error: true
|
|
101052
|
+
/** Date and time at which Seam created the error. */
|
|
101053
|
+
created_at?: string | undefined
|
|
101054
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101055
|
+
error_code: 'august_device_slots_full'
|
|
101056
|
+
}
|
|
101057
|
+
| {
|
|
101058
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101059
|
+
message: string
|
|
101060
|
+
/** Indicates that this is an access code error. */
|
|
101061
|
+
is_access_code_error: true
|
|
101062
|
+
/** Date and time at which Seam created the error. */
|
|
101063
|
+
created_at?: string | undefined
|
|
101064
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101065
|
+
error_code: 'august_lock_missing_keypad'
|
|
101066
|
+
}
|
|
101067
|
+
| {
|
|
101068
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101069
|
+
message: string
|
|
101070
|
+
/** Indicates that this is an access code error. */
|
|
101071
|
+
is_access_code_error: true
|
|
101072
|
+
/** Date and time at which Seam created the error. */
|
|
101073
|
+
created_at?: string | undefined
|
|
101074
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101075
|
+
error_code: 'august_lock_temporarily_offline'
|
|
101076
|
+
}
|
|
101077
|
+
| {
|
|
101078
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101079
|
+
message: string
|
|
101080
|
+
/** Indicates that this is an access code error. */
|
|
101081
|
+
is_access_code_error: true
|
|
101082
|
+
/** Date and time at which Seam created the error. */
|
|
101083
|
+
created_at?: string | undefined
|
|
101084
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101085
|
+
error_code: 'salto_ks_user_not_subscribed'
|
|
101086
|
+
}
|
|
101087
|
+
| {
|
|
101088
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101089
|
+
message: string
|
|
101090
|
+
/** Indicates that this is an access code error. */
|
|
101091
|
+
is_access_code_error: true
|
|
101092
|
+
/** Date and time at which Seam created the error. */
|
|
101093
|
+
created_at?: string | undefined
|
|
101094
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101095
|
+
error_code: 'hubitat_device_programming_delay'
|
|
101096
|
+
}
|
|
101097
|
+
| {
|
|
101098
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101099
|
+
message: string
|
|
101100
|
+
/** Indicates that this is an access code error. */
|
|
101101
|
+
is_access_code_error: true
|
|
101102
|
+
/** Date and time at which Seam created the error. */
|
|
101103
|
+
created_at?: string | undefined
|
|
101104
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101105
|
+
error_code: 'hubitat_no_free_positions_available'
|
|
101106
|
+
}
|
|
101107
|
+
| {
|
|
101108
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101109
|
+
message: string
|
|
101110
|
+
/** Indicates that this is an access code error. */
|
|
101111
|
+
is_access_code_error: true
|
|
101112
|
+
/** Date and time at which Seam created the error. */
|
|
101113
|
+
created_at?: string | undefined
|
|
101114
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101115
|
+
error_code: 'wyze_duplicate_code_name'
|
|
101116
|
+
}
|
|
101117
|
+
| {
|
|
101118
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101119
|
+
message: string
|
|
101120
|
+
/** Indicates that this is an access code error. */
|
|
101121
|
+
is_access_code_error: true
|
|
101122
|
+
/** Date and time at which Seam created the error. */
|
|
101123
|
+
created_at?: string | undefined
|
|
101124
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101125
|
+
error_code: 'wyze_potential_duplicate_code'
|
|
101126
|
+
}
|
|
101127
|
+
| {
|
|
101128
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101129
|
+
message: string
|
|
101130
|
+
/** Indicates that this is an access code error. */
|
|
101131
|
+
is_access_code_error: true
|
|
101132
|
+
/** Date and time at which Seam created the error. */
|
|
101133
|
+
created_at?: string | undefined
|
|
101134
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101135
|
+
error_code: 'dormakaba_oracode_no_valid_user_level'
|
|
101136
|
+
}
|
|
101137
|
+
| {
|
|
101138
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101139
|
+
message: string
|
|
101140
|
+
/** Indicates that the error is not a device error. */
|
|
101141
|
+
is_device_error: false
|
|
101142
|
+
/** Date and time at which Seam created the error. */
|
|
101143
|
+
created_at: string
|
|
101144
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101145
|
+
error_code: 'account_disconnected'
|
|
101146
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
101147
|
+
is_connected_account_error: true
|
|
101148
|
+
}
|
|
101149
|
+
| {
|
|
101150
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101151
|
+
message: string
|
|
101152
|
+
/** Indicates that the error is not a device error. */
|
|
101153
|
+
is_device_error: false
|
|
101154
|
+
/** Date and time at which Seam created the error. */
|
|
101155
|
+
created_at: string
|
|
101156
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101157
|
+
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
101158
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
101159
|
+
is_connected_account_error: true
|
|
101160
|
+
}
|
|
101161
|
+
| {
|
|
101162
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101163
|
+
message: string
|
|
101164
|
+
/** Indicates that the error is a device error. */
|
|
101165
|
+
is_device_error: true
|
|
101166
|
+
/** Date and time at which Seam created the error. */
|
|
101167
|
+
created_at: string
|
|
101168
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101169
|
+
error_code: 'device_offline'
|
|
101170
|
+
}
|
|
101171
|
+
| {
|
|
101172
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101173
|
+
message: string
|
|
101174
|
+
/** Indicates that the error is a device error. */
|
|
101175
|
+
is_device_error: true
|
|
101176
|
+
/** Date and time at which Seam created the error. */
|
|
101177
|
+
created_at: string
|
|
101178
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101179
|
+
error_code: 'device_removed'
|
|
101180
|
+
}
|
|
101181
|
+
| {
|
|
101182
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101183
|
+
message: string
|
|
101184
|
+
/** Indicates that the error is a device error. */
|
|
101185
|
+
is_device_error: true
|
|
101186
|
+
/** Date and time at which Seam created the error. */
|
|
101187
|
+
created_at: string
|
|
101188
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101189
|
+
error_code: 'hub_disconnected'
|
|
101190
|
+
}
|
|
101191
|
+
| {
|
|
101192
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101193
|
+
message: string
|
|
101194
|
+
/** Indicates that the error is a device error. */
|
|
101195
|
+
is_device_error: true
|
|
101196
|
+
/** Date and time at which Seam created the error. */
|
|
101197
|
+
created_at: string
|
|
101198
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101199
|
+
error_code: 'device_disconnected'
|
|
101200
|
+
}
|
|
101201
|
+
| {
|
|
101202
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101203
|
+
message: string
|
|
101204
|
+
/** Indicates that the error is a device error. */
|
|
101205
|
+
is_device_error: true
|
|
101206
|
+
/** Date and time at which Seam created the error. */
|
|
101207
|
+
created_at: string
|
|
101208
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101209
|
+
error_code: 'empty_backup_access_code_pool'
|
|
101210
|
+
}
|
|
101211
|
+
| {
|
|
101212
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101213
|
+
message: string
|
|
101214
|
+
/** Indicates that the error is a device error. */
|
|
101215
|
+
is_device_error: true
|
|
101216
|
+
/** Date and time at which Seam created the error. */
|
|
101217
|
+
created_at: string
|
|
101218
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101219
|
+
error_code: 'august_lock_not_authorized'
|
|
101220
|
+
}
|
|
101221
|
+
| {
|
|
101222
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101223
|
+
message: string
|
|
101224
|
+
/** Indicates that the error is a device error. */
|
|
101225
|
+
is_device_error: true
|
|
101226
|
+
/** Date and time at which Seam created the error. */
|
|
101227
|
+
created_at: string
|
|
101228
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101229
|
+
error_code: 'august_lock_missing_bridge'
|
|
101230
|
+
}
|
|
101231
|
+
| {
|
|
101232
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101233
|
+
message: string
|
|
101234
|
+
/** Indicates that the error is a device error. */
|
|
101235
|
+
is_device_error: true
|
|
101236
|
+
/** Date and time at which Seam created the error. */
|
|
101237
|
+
created_at: string
|
|
101238
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101239
|
+
error_code: 'ttlock_lock_not_paired_to_gateway'
|
|
101240
|
+
}
|
|
101241
|
+
| {
|
|
101242
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101243
|
+
message: string
|
|
101244
|
+
/** Indicates that the error is a device error. */
|
|
101245
|
+
is_device_error: true
|
|
101246
|
+
/** Date and time at which Seam created the error. */
|
|
101247
|
+
created_at: string
|
|
101248
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101249
|
+
error_code: 'missing_device_credentials'
|
|
101250
|
+
}
|
|
101251
|
+
| {
|
|
101252
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101253
|
+
message: string
|
|
101254
|
+
/** Indicates that the error is a device error. */
|
|
101255
|
+
is_device_error: true
|
|
101256
|
+
/** Date and time at which Seam created the error. */
|
|
101257
|
+
created_at: string
|
|
101258
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101259
|
+
error_code: 'auxiliary_heat_running'
|
|
101260
|
+
}
|
|
101261
|
+
| {
|
|
101262
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101263
|
+
message: string
|
|
101264
|
+
/** Indicates that the error is a device error. */
|
|
101265
|
+
is_device_error: true
|
|
101266
|
+
/** Date and time at which Seam created the error. */
|
|
101267
|
+
created_at: string
|
|
101268
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101269
|
+
error_code: 'subscription_required'
|
|
101270
|
+
}
|
|
101271
|
+
| {
|
|
101272
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101273
|
+
message: string
|
|
101274
|
+
/** Indicates that the error is a device error. */
|
|
101275
|
+
is_device_error: true
|
|
101276
|
+
/** Date and time at which Seam created the error. */
|
|
101277
|
+
created_at: string
|
|
101278
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101279
|
+
error_code: 'lockly_missing_wifi_bridge'
|
|
101280
|
+
}
|
|
101281
|
+
| {
|
|
101282
|
+
/** Date and time at which Seam created the error. */
|
|
101283
|
+
created_at: string
|
|
101284
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101285
|
+
message: string
|
|
101286
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
101287
|
+
is_connected_account_error?: boolean | undefined
|
|
101288
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
101289
|
+
is_bridge_error?: boolean | undefined
|
|
101290
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101291
|
+
error_code: 'invalid_credentials'
|
|
101292
|
+
}
|
|
101293
|
+
| {
|
|
101294
|
+
/** Date and time at which Seam created the error. */
|
|
101295
|
+
created_at: string
|
|
101296
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101297
|
+
message: string
|
|
101298
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
101299
|
+
is_connected_account_error?: boolean | undefined
|
|
101300
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
101301
|
+
is_bridge_error?: boolean | undefined
|
|
101302
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101303
|
+
error_code: 'bridge_disconnected'
|
|
101304
|
+
}
|
|
101305
|
+
)[]
|
|
101306
|
+
/** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
101307
|
+
warnings: (
|
|
101308
|
+
| {
|
|
101309
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101310
|
+
message: string
|
|
101311
|
+
/** Date and time at which Seam created the warning. */
|
|
101312
|
+
created_at?: string | undefined
|
|
101313
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101314
|
+
warning_code: 'smartthings_failed_to_set_access_code'
|
|
101315
|
+
}
|
|
101316
|
+
| {
|
|
101317
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101318
|
+
message: string
|
|
101319
|
+
/** Date and time at which Seam created the warning. */
|
|
101320
|
+
created_at?: string | undefined
|
|
101321
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101322
|
+
warning_code: 'schlage_detected_duplicate'
|
|
101323
|
+
}
|
|
101324
|
+
| {
|
|
101325
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101326
|
+
message: string
|
|
101327
|
+
/** Date and time at which Seam created the warning. */
|
|
101328
|
+
created_at?: string | undefined
|
|
101329
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101330
|
+
warning_code: 'schlage_creation_outage'
|
|
101331
|
+
}
|
|
101332
|
+
| {
|
|
101333
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101334
|
+
message: string
|
|
101335
|
+
/** Date and time at which Seam created the warning. */
|
|
101336
|
+
created_at?: string | undefined
|
|
101337
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101338
|
+
warning_code: 'code_modified_external_to_seam'
|
|
101339
|
+
}
|
|
101340
|
+
| {
|
|
101341
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101342
|
+
message: string
|
|
101343
|
+
/** Date and time at which Seam created the warning. */
|
|
101344
|
+
created_at?: string | undefined
|
|
101345
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101346
|
+
warning_code: 'delay_in_setting_on_device'
|
|
101347
|
+
}
|
|
101348
|
+
| {
|
|
101349
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101350
|
+
message: string
|
|
101351
|
+
/** Date and time at which Seam created the warning. */
|
|
101352
|
+
created_at?: string | undefined
|
|
101353
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101354
|
+
warning_code: 'delay_in_removing_from_device'
|
|
101355
|
+
}
|
|
101356
|
+
| {
|
|
101357
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101358
|
+
message: string
|
|
101359
|
+
/** Date and time at which Seam created the warning. */
|
|
101360
|
+
created_at?: string | undefined
|
|
101361
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101362
|
+
warning_code: 'third_party_integration_detected'
|
|
101363
|
+
}
|
|
101364
|
+
| {
|
|
101365
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101366
|
+
message: string
|
|
101367
|
+
/** Date and time at which Seam created the warning. */
|
|
101368
|
+
created_at?: string | undefined
|
|
101369
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101370
|
+
warning_code: 'august_device_programming_delay'
|
|
101371
|
+
}
|
|
101372
|
+
| {
|
|
101373
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101374
|
+
message: string
|
|
101375
|
+
/** Date and time at which Seam created the warning. */
|
|
101376
|
+
created_at?: string | undefined
|
|
101377
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101378
|
+
warning_code: 'august_lock_temporarily_offline'
|
|
101379
|
+
}
|
|
101380
|
+
| {
|
|
101381
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101382
|
+
message: string
|
|
101383
|
+
/** Date and time at which Seam created the warning. */
|
|
101384
|
+
created_at?: string | undefined
|
|
101385
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101386
|
+
warning_code: 'igloo_algopin_must_be_used_within_24_hours'
|
|
101387
|
+
}
|
|
101388
|
+
| {
|
|
101389
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101390
|
+
message: string
|
|
101391
|
+
/** Date and time at which Seam created the warning. */
|
|
101392
|
+
created_at?: string | undefined
|
|
101393
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101394
|
+
warning_code: 'management_transferred'
|
|
101395
|
+
}
|
|
101396
|
+
| {
|
|
101397
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101398
|
+
message: string
|
|
101399
|
+
/** Date and time at which Seam created the warning. */
|
|
101400
|
+
created_at?: string | undefined
|
|
101401
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101402
|
+
warning_code: 'kwikset_unable_to_confirm_code'
|
|
101403
|
+
}
|
|
101404
|
+
)[]
|
|
101405
|
+
/** Indicates whether Seam manages the access code. */
|
|
101406
|
+
is_managed: true
|
|
101407
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
101408
|
+
starts_at?: (string | null) | undefined
|
|
101409
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
101410
|
+
ends_at?: (string | null) | undefined
|
|
101411
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
101412
|
+
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
|
|
101413
|
+
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
101414
|
+
is_backup_access_code_available: boolean
|
|
101415
|
+
/** Indicates whether the access code is a backup code. */
|
|
101416
|
+
is_backup?: boolean | undefined
|
|
101417
|
+
/** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
|
|
101418
|
+
pulled_backup_access_code_id?: (string | null) | undefined
|
|
101419
|
+
/** Indicates whether changes to the access code from external sources are permitted. */
|
|
101420
|
+
is_external_modification_allowed: boolean
|
|
101421
|
+
/** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
101422
|
+
is_one_time_use: boolean
|
|
101423
|
+
/** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
|
|
101424
|
+
is_offline_access_code: boolean
|
|
101425
|
+
}[]
|
|
101426
|
+
| undefined
|
|
101427
|
+
unmanaged_access_codes?:
|
|
101428
|
+
| {
|
|
101429
|
+
/** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
|
|
101430
|
+
type: 'time_bound' | 'ongoing'
|
|
101431
|
+
/** Unique identifier for the access code. */
|
|
101432
|
+
access_code_id: string
|
|
101433
|
+
/** Unique identifier for the device associated with the access code. */
|
|
101434
|
+
device_id: string
|
|
101435
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
101436
|
+
name: string | null
|
|
101437
|
+
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
101438
|
+
code: string | null
|
|
101439
|
+
/** Date and time at which the access code was created. */
|
|
101440
|
+
created_at: string
|
|
101441
|
+
/** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
101442
|
+
errors: (
|
|
101443
|
+
| {
|
|
101444
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101445
|
+
message: string
|
|
101446
|
+
/** Indicates that this is an access code error. */
|
|
101447
|
+
is_access_code_error: true
|
|
101448
|
+
/** Date and time at which Seam created the error. */
|
|
101449
|
+
created_at?: string | undefined
|
|
101450
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101451
|
+
error_code: 'smartthings_failed_to_set_access_code'
|
|
101452
|
+
}
|
|
101453
|
+
| {
|
|
101454
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101455
|
+
message: string
|
|
101456
|
+
/** Indicates that this is an access code error. */
|
|
101457
|
+
is_access_code_error: true
|
|
101458
|
+
/** Date and time at which Seam created the error. */
|
|
101459
|
+
created_at?: string | undefined
|
|
101460
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101461
|
+
error_code: 'smartthings_failed_to_set_after_multiple_retries'
|
|
101462
|
+
}
|
|
101463
|
+
| {
|
|
101464
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101465
|
+
message: string
|
|
101466
|
+
/** Indicates that this is an access code error. */
|
|
101467
|
+
is_access_code_error: true
|
|
101468
|
+
/** Date and time at which Seam created the error. */
|
|
101469
|
+
created_at?: string | undefined
|
|
101470
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101471
|
+
error_code: 'smartthings_no_free_slots_available'
|
|
101472
|
+
}
|
|
101473
|
+
| {
|
|
101474
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101475
|
+
message: string
|
|
101476
|
+
/** Indicates that this is an access code error. */
|
|
101477
|
+
is_access_code_error: true
|
|
101478
|
+
/** Date and time at which Seam created the error. */
|
|
101479
|
+
created_at?: string | undefined
|
|
101480
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101481
|
+
error_code: 'failed_to_set_on_device'
|
|
101482
|
+
}
|
|
101483
|
+
| {
|
|
101484
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101485
|
+
message: string
|
|
101486
|
+
/** Indicates that this is an access code error. */
|
|
101487
|
+
is_access_code_error: true
|
|
101488
|
+
/** Date and time at which Seam created the error. */
|
|
101489
|
+
created_at?: string | undefined
|
|
101490
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101491
|
+
error_code: 'failed_to_remove_from_device'
|
|
101492
|
+
}
|
|
101493
|
+
| {
|
|
101494
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101495
|
+
message: string
|
|
101496
|
+
/** Indicates that this is an access code error. */
|
|
101497
|
+
is_access_code_error: true
|
|
101498
|
+
/** Date and time at which Seam created the error. */
|
|
101499
|
+
created_at?: string | undefined
|
|
101500
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101501
|
+
error_code: 'duplicate_code_on_device'
|
|
101502
|
+
}
|
|
101503
|
+
| {
|
|
101504
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101505
|
+
message: string
|
|
101506
|
+
/** Indicates that this is an access code error. */
|
|
101507
|
+
is_access_code_error: true
|
|
101508
|
+
/** Date and time at which Seam created the error. */
|
|
101509
|
+
created_at?: string | undefined
|
|
101510
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101511
|
+
error_code: 'duplicate_code_attempt_prevented'
|
|
101512
|
+
}
|
|
101513
|
+
| {
|
|
101514
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101515
|
+
message: string
|
|
101516
|
+
/** Indicates that this is an access code error. */
|
|
101517
|
+
is_access_code_error: true
|
|
101518
|
+
/** Date and time at which Seam created the error. */
|
|
101519
|
+
created_at?: string | undefined
|
|
101520
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101521
|
+
error_code: 'no_space_for_access_code_on_device'
|
|
101522
|
+
}
|
|
101523
|
+
| {
|
|
101524
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101525
|
+
message: string
|
|
101526
|
+
/** Indicates that this is an access code error. */
|
|
101527
|
+
is_access_code_error: true
|
|
101528
|
+
/** Date and time at which Seam created the error. */
|
|
101529
|
+
created_at?: string | undefined
|
|
101530
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101531
|
+
error_code: 'igloohome_bridge_too_many_pending_jobs'
|
|
101532
|
+
}
|
|
101533
|
+
| {
|
|
101534
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101535
|
+
message: string
|
|
101536
|
+
/** Indicates that this is an access code error. */
|
|
101537
|
+
is_access_code_error: true
|
|
101538
|
+
/** Date and time at which Seam created the error. */
|
|
101539
|
+
created_at?: string | undefined
|
|
101540
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101541
|
+
error_code: 'igloohome_bridge_offline'
|
|
101542
|
+
}
|
|
101543
|
+
| {
|
|
101544
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101545
|
+
message: string
|
|
101546
|
+
/** Indicates that this is an access code error. */
|
|
101547
|
+
is_access_code_error: true
|
|
101548
|
+
/** Date and time at which Seam created the error. */
|
|
101549
|
+
created_at?: string | undefined
|
|
101550
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101551
|
+
error_code: 'igloohome_offline_access_code_no_variance_available'
|
|
101552
|
+
}
|
|
101553
|
+
| {
|
|
101554
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101555
|
+
message: string
|
|
101556
|
+
/** Indicates that this is an access code error. */
|
|
101557
|
+
is_access_code_error: true
|
|
101558
|
+
/** Date and time at which Seam created the error. */
|
|
101559
|
+
created_at?: string | undefined
|
|
101560
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101561
|
+
error_code: 'kwikset_unable_to_confirm_code'
|
|
101562
|
+
}
|
|
101563
|
+
| {
|
|
101564
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101565
|
+
message: string
|
|
101566
|
+
/** Indicates that this is an access code error. */
|
|
101567
|
+
is_access_code_error: true
|
|
101568
|
+
/** Date and time at which Seam created the error. */
|
|
101569
|
+
created_at?: string | undefined
|
|
101570
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101571
|
+
error_code: 'kwikset_unable_to_confirm_deletion'
|
|
101572
|
+
}
|
|
101573
|
+
| {
|
|
101574
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101575
|
+
message: string
|
|
101576
|
+
/** Indicates that this is an access code error. */
|
|
101577
|
+
is_access_code_error: true
|
|
101578
|
+
/** Date and time at which Seam created the error. */
|
|
101579
|
+
created_at?: string | undefined
|
|
101580
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101581
|
+
error_code: 'code_modified_external_to_seam'
|
|
101582
|
+
}
|
|
101583
|
+
| {
|
|
101584
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101585
|
+
message: string
|
|
101586
|
+
/** Indicates that this is an access code error. */
|
|
101587
|
+
is_access_code_error: true
|
|
101588
|
+
/** Date and time at which Seam created the error. */
|
|
101589
|
+
created_at?: string | undefined
|
|
101590
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101591
|
+
error_code: 'august_lock_invalid_code_length'
|
|
101592
|
+
}
|
|
101593
|
+
| {
|
|
101594
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101595
|
+
message: string
|
|
101596
|
+
/** Indicates that this is an access code error. */
|
|
101597
|
+
is_access_code_error: true
|
|
101598
|
+
/** Date and time at which Seam created the error. */
|
|
101599
|
+
created_at?: string | undefined
|
|
101600
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101601
|
+
error_code: 'august_device_programming_delay'
|
|
101602
|
+
}
|
|
101603
|
+
| {
|
|
101604
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101605
|
+
message: string
|
|
101606
|
+
/** Indicates that this is an access code error. */
|
|
101607
|
+
is_access_code_error: true
|
|
101608
|
+
/** Date and time at which Seam created the error. */
|
|
101609
|
+
created_at?: string | undefined
|
|
101610
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101611
|
+
error_code: 'august_device_slots_full'
|
|
101612
|
+
}
|
|
101613
|
+
| {
|
|
101614
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101615
|
+
message: string
|
|
101616
|
+
/** Indicates that this is an access code error. */
|
|
101617
|
+
is_access_code_error: true
|
|
101618
|
+
/** Date and time at which Seam created the error. */
|
|
101619
|
+
created_at?: string | undefined
|
|
101620
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101621
|
+
error_code: 'august_lock_missing_keypad'
|
|
101622
|
+
}
|
|
101623
|
+
| {
|
|
101624
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101625
|
+
message: string
|
|
101626
|
+
/** Indicates that this is an access code error. */
|
|
101627
|
+
is_access_code_error: true
|
|
101628
|
+
/** Date and time at which Seam created the error. */
|
|
101629
|
+
created_at?: string | undefined
|
|
101630
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101631
|
+
error_code: 'august_lock_temporarily_offline'
|
|
101632
|
+
}
|
|
101633
|
+
| {
|
|
101634
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101635
|
+
message: string
|
|
101636
|
+
/** Indicates that this is an access code error. */
|
|
101637
|
+
is_access_code_error: true
|
|
101638
|
+
/** Date and time at which Seam created the error. */
|
|
101639
|
+
created_at?: string | undefined
|
|
101640
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101641
|
+
error_code: 'salto_ks_user_not_subscribed'
|
|
101642
|
+
}
|
|
101643
|
+
| {
|
|
101644
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101645
|
+
message: string
|
|
101646
|
+
/** Indicates that this is an access code error. */
|
|
101647
|
+
is_access_code_error: true
|
|
101648
|
+
/** Date and time at which Seam created the error. */
|
|
101649
|
+
created_at?: string | undefined
|
|
101650
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101651
|
+
error_code: 'hubitat_device_programming_delay'
|
|
101652
|
+
}
|
|
101653
|
+
| {
|
|
101654
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101655
|
+
message: string
|
|
101656
|
+
/** Indicates that this is an access code error. */
|
|
101657
|
+
is_access_code_error: true
|
|
101658
|
+
/** Date and time at which Seam created the error. */
|
|
101659
|
+
created_at?: string | undefined
|
|
101660
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101661
|
+
error_code: 'hubitat_no_free_positions_available'
|
|
101662
|
+
}
|
|
101663
|
+
| {
|
|
101664
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101665
|
+
message: string
|
|
101666
|
+
/** Indicates that this is an access code error. */
|
|
101667
|
+
is_access_code_error: true
|
|
101668
|
+
/** Date and time at which Seam created the error. */
|
|
101669
|
+
created_at?: string | undefined
|
|
101670
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101671
|
+
error_code: 'wyze_duplicate_code_name'
|
|
101672
|
+
}
|
|
101673
|
+
| {
|
|
101674
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101675
|
+
message: string
|
|
101676
|
+
/** Indicates that this is an access code error. */
|
|
101677
|
+
is_access_code_error: true
|
|
101678
|
+
/** Date and time at which Seam created the error. */
|
|
101679
|
+
created_at?: string | undefined
|
|
101680
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101681
|
+
error_code: 'wyze_potential_duplicate_code'
|
|
101682
|
+
}
|
|
101683
|
+
| {
|
|
101684
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101685
|
+
message: string
|
|
101686
|
+
/** Indicates that this is an access code error. */
|
|
101687
|
+
is_access_code_error: true
|
|
101688
|
+
/** Date and time at which Seam created the error. */
|
|
101689
|
+
created_at?: string | undefined
|
|
101690
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101691
|
+
error_code: 'dormakaba_oracode_no_valid_user_level'
|
|
101692
|
+
}
|
|
101693
|
+
| {
|
|
101694
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101695
|
+
message: string
|
|
101696
|
+
/** Indicates that the error is not a device error. */
|
|
101697
|
+
is_device_error: false
|
|
101698
|
+
/** Date and time at which Seam created the error. */
|
|
101699
|
+
created_at: string
|
|
101700
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101701
|
+
error_code: 'account_disconnected'
|
|
101702
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
101703
|
+
is_connected_account_error: true
|
|
101704
|
+
}
|
|
101705
|
+
| {
|
|
101706
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101707
|
+
message: string
|
|
101708
|
+
/** Indicates that the error is not a device error. */
|
|
101709
|
+
is_device_error: false
|
|
101710
|
+
/** Date and time at which Seam created the error. */
|
|
101711
|
+
created_at: string
|
|
101712
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101713
|
+
error_code: 'salto_ks_subscription_limit_exceeded'
|
|
101714
|
+
/** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
|
|
101715
|
+
is_connected_account_error: true
|
|
101716
|
+
}
|
|
101717
|
+
| {
|
|
101718
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101719
|
+
message: string
|
|
101720
|
+
/** Indicates that the error is a device error. */
|
|
101721
|
+
is_device_error: true
|
|
101722
|
+
/** Date and time at which Seam created the error. */
|
|
101723
|
+
created_at: string
|
|
101724
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101725
|
+
error_code: 'device_offline'
|
|
101726
|
+
}
|
|
101727
|
+
| {
|
|
101728
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101729
|
+
message: string
|
|
101730
|
+
/** Indicates that the error is a device error. */
|
|
101731
|
+
is_device_error: true
|
|
101732
|
+
/** Date and time at which Seam created the error. */
|
|
101733
|
+
created_at: string
|
|
101734
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101735
|
+
error_code: 'device_removed'
|
|
101736
|
+
}
|
|
101737
|
+
| {
|
|
101738
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101739
|
+
message: string
|
|
101740
|
+
/** Indicates that the error is a device error. */
|
|
101741
|
+
is_device_error: true
|
|
101742
|
+
/** Date and time at which Seam created the error. */
|
|
101743
|
+
created_at: string
|
|
101744
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101745
|
+
error_code: 'hub_disconnected'
|
|
101746
|
+
}
|
|
101747
|
+
| {
|
|
101748
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101749
|
+
message: string
|
|
101750
|
+
/** Indicates that the error is a device error. */
|
|
101751
|
+
is_device_error: true
|
|
101752
|
+
/** Date and time at which Seam created the error. */
|
|
101753
|
+
created_at: string
|
|
101754
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101755
|
+
error_code: 'device_disconnected'
|
|
101756
|
+
}
|
|
101757
|
+
| {
|
|
101758
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101759
|
+
message: string
|
|
101760
|
+
/** Indicates that the error is a device error. */
|
|
101761
|
+
is_device_error: true
|
|
101762
|
+
/** Date and time at which Seam created the error. */
|
|
101763
|
+
created_at: string
|
|
101764
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101765
|
+
error_code: 'empty_backup_access_code_pool'
|
|
101766
|
+
}
|
|
101767
|
+
| {
|
|
101768
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101769
|
+
message: string
|
|
101770
|
+
/** Indicates that the error is a device error. */
|
|
101771
|
+
is_device_error: true
|
|
101772
|
+
/** Date and time at which Seam created the error. */
|
|
101773
|
+
created_at: string
|
|
101774
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101775
|
+
error_code: 'august_lock_not_authorized'
|
|
101776
|
+
}
|
|
101777
|
+
| {
|
|
101778
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101779
|
+
message: string
|
|
101780
|
+
/** Indicates that the error is a device error. */
|
|
101781
|
+
is_device_error: true
|
|
101782
|
+
/** Date and time at which Seam created the error. */
|
|
101783
|
+
created_at: string
|
|
101784
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101785
|
+
error_code: 'august_lock_missing_bridge'
|
|
101786
|
+
}
|
|
101787
|
+
| {
|
|
101788
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101789
|
+
message: string
|
|
101790
|
+
/** Indicates that the error is a device error. */
|
|
101791
|
+
is_device_error: true
|
|
101792
|
+
/** Date and time at which Seam created the error. */
|
|
101793
|
+
created_at: string
|
|
101794
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101795
|
+
error_code: 'ttlock_lock_not_paired_to_gateway'
|
|
101796
|
+
}
|
|
101797
|
+
| {
|
|
101798
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101799
|
+
message: string
|
|
101800
|
+
/** Indicates that the error is a device error. */
|
|
101801
|
+
is_device_error: true
|
|
101802
|
+
/** Date and time at which Seam created the error. */
|
|
101803
|
+
created_at: string
|
|
101804
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101805
|
+
error_code: 'missing_device_credentials'
|
|
101806
|
+
}
|
|
101807
|
+
| {
|
|
101808
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101809
|
+
message: string
|
|
101810
|
+
/** Indicates that the error is a device error. */
|
|
101811
|
+
is_device_error: true
|
|
101812
|
+
/** Date and time at which Seam created the error. */
|
|
101813
|
+
created_at: string
|
|
101814
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101815
|
+
error_code: 'auxiliary_heat_running'
|
|
101816
|
+
}
|
|
101817
|
+
| {
|
|
101818
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101819
|
+
message: string
|
|
101820
|
+
/** Indicates that the error is a device error. */
|
|
101821
|
+
is_device_error: true
|
|
101822
|
+
/** Date and time at which Seam created the error. */
|
|
101823
|
+
created_at: string
|
|
101824
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101825
|
+
error_code: 'subscription_required'
|
|
101826
|
+
}
|
|
101827
|
+
| {
|
|
101828
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101829
|
+
message: string
|
|
101830
|
+
/** Indicates that the error is a device error. */
|
|
101831
|
+
is_device_error: true
|
|
101832
|
+
/** Date and time at which Seam created the error. */
|
|
101833
|
+
created_at: string
|
|
101834
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101835
|
+
error_code: 'lockly_missing_wifi_bridge'
|
|
101836
|
+
}
|
|
101837
|
+
| {
|
|
101838
|
+
/** Date and time at which Seam created the error. */
|
|
101839
|
+
created_at: string
|
|
101840
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101841
|
+
message: string
|
|
101842
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
101843
|
+
is_connected_account_error?: boolean | undefined
|
|
101844
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
101845
|
+
is_bridge_error?: boolean | undefined
|
|
101846
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101847
|
+
error_code: 'invalid_credentials'
|
|
101848
|
+
}
|
|
101849
|
+
| {
|
|
101850
|
+
/** Date and time at which Seam created the error. */
|
|
101851
|
+
created_at: string
|
|
101852
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101853
|
+
message: string
|
|
101854
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
101855
|
+
is_connected_account_error?: boolean | undefined
|
|
101856
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
101857
|
+
is_bridge_error?: boolean | undefined
|
|
101858
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101859
|
+
error_code: 'bridge_disconnected'
|
|
101860
|
+
}
|
|
101861
|
+
)[]
|
|
101862
|
+
/** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
|
|
101863
|
+
warnings: (
|
|
101864
|
+
| {
|
|
101865
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101866
|
+
message: string
|
|
101867
|
+
/** Date and time at which Seam created the warning. */
|
|
101868
|
+
created_at?: string | undefined
|
|
101869
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101870
|
+
warning_code: 'smartthings_failed_to_set_access_code'
|
|
101871
|
+
}
|
|
101872
|
+
| {
|
|
101873
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101874
|
+
message: string
|
|
101875
|
+
/** Date and time at which Seam created the warning. */
|
|
101876
|
+
created_at?: string | undefined
|
|
101877
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101878
|
+
warning_code: 'schlage_detected_duplicate'
|
|
101879
|
+
}
|
|
101880
|
+
| {
|
|
101881
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101882
|
+
message: string
|
|
101883
|
+
/** Date and time at which Seam created the warning. */
|
|
101884
|
+
created_at?: string | undefined
|
|
101885
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101886
|
+
warning_code: 'schlage_creation_outage'
|
|
101887
|
+
}
|
|
101888
|
+
| {
|
|
101889
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101890
|
+
message: string
|
|
101891
|
+
/** Date and time at which Seam created the warning. */
|
|
101892
|
+
created_at?: string | undefined
|
|
101893
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101894
|
+
warning_code: 'code_modified_external_to_seam'
|
|
101895
|
+
}
|
|
101896
|
+
| {
|
|
101897
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101898
|
+
message: string
|
|
101899
|
+
/** Date and time at which Seam created the warning. */
|
|
101900
|
+
created_at?: string | undefined
|
|
101901
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101902
|
+
warning_code: 'delay_in_setting_on_device'
|
|
101903
|
+
}
|
|
101904
|
+
| {
|
|
101905
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101906
|
+
message: string
|
|
101907
|
+
/** Date and time at which Seam created the warning. */
|
|
101908
|
+
created_at?: string | undefined
|
|
101909
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101910
|
+
warning_code: 'delay_in_removing_from_device'
|
|
101911
|
+
}
|
|
101912
|
+
| {
|
|
101913
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101914
|
+
message: string
|
|
101915
|
+
/** Date and time at which Seam created the warning. */
|
|
101916
|
+
created_at?: string | undefined
|
|
101917
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101918
|
+
warning_code: 'third_party_integration_detected'
|
|
101919
|
+
}
|
|
101920
|
+
| {
|
|
101921
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101922
|
+
message: string
|
|
101923
|
+
/** Date and time at which Seam created the warning. */
|
|
101924
|
+
created_at?: string | undefined
|
|
101925
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101926
|
+
warning_code: 'august_device_programming_delay'
|
|
101927
|
+
}
|
|
101928
|
+
| {
|
|
101929
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101930
|
+
message: string
|
|
101931
|
+
/** Date and time at which Seam created the warning. */
|
|
101932
|
+
created_at?: string | undefined
|
|
101933
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
101934
|
+
warning_code: 'august_lock_temporarily_offline'
|
|
101935
|
+
}
|
|
101936
|
+
| {
|
|
101937
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101938
|
+
message: string
|
|
101939
|
+
/** Date and time at which Seam created the warning. */
|
|
101940
|
+
created_at?: string | undefined
|
|
101941
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101942
|
+
warning_code: 'igloo_algopin_must_be_used_within_24_hours'
|
|
101943
|
+
}
|
|
101944
|
+
| {
|
|
101945
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101946
|
+
message: string
|
|
101947
|
+
/** Date and time at which Seam created the warning. */
|
|
101948
|
+
created_at?: string | undefined
|
|
101949
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101950
|
+
warning_code: 'management_transferred'
|
|
101951
|
+
}
|
|
101952
|
+
| {
|
|
101953
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
101954
|
+
message: string
|
|
101955
|
+
/** Date and time at which Seam created the warning. */
|
|
101956
|
+
created_at?: string | undefined
|
|
101957
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
101958
|
+
warning_code: 'kwikset_unable_to_confirm_code'
|
|
101959
|
+
}
|
|
101960
|
+
)[]
|
|
101961
|
+
/** Indicates that Seam does not manage the access code. */
|
|
101962
|
+
is_managed: false
|
|
101963
|
+
/** Date and time at which the time-bound access code becomes active. */
|
|
101964
|
+
starts_at?: (string | null) | undefined
|
|
101965
|
+
/** Date and time after which the time-bound access code becomes inactive. */
|
|
101966
|
+
ends_at?: (string | null) | undefined
|
|
101967
|
+
/** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
|
|
101968
|
+
status: 'set'
|
|
99691
101969
|
}[]
|
|
99692
101970
|
| undefined
|
|
99693
101971
|
}
|