@seamapi/types 1.375.2 → 1.377.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.
Files changed (31) hide show
  1. package/dist/connect.cjs +1708 -529
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1588 -363
  4. package/lib/seam/connect/models/access-codes/managed-access-code.js +48 -23
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +13 -2
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +182 -150
  9. package/lib/seam/connect/models/acs/acs-users/acs-user.js +2 -3
  10. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  11. package/lib/seam/connect/models/acs/acs-users/index.d.ts +1 -1
  12. package/lib/seam/connect/models/acs/acs-users/index.js +1 -1
  13. package/lib/seam/connect/models/acs/acs-users/index.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-users/{pending-modifications.d.ts → pending-mutations.d.ts} +191 -106
  15. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +90 -0
  16. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -0
  17. package/lib/seam/connect/openapi.d.ts +257 -58
  18. package/lib/seam/connect/openapi.js +1588 -436
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +1155 -161
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
  23. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
  24. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +2 -3
  25. package/src/lib/seam/connect/models/acs/acs-users/index.ts +1 -1
  26. package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +110 -0
  27. package/src/lib/seam/connect/openapi.ts +1928 -446
  28. package/src/lib/seam/connect/route-types.ts +1162 -161
  29. package/lib/seam/connect/models/acs/acs-users/pending-modifications.js +0 -85
  30. package/lib/seam/connect/models/acs/acs-users/pending-modifications.js.map +0 -1
  31. package/src/lib/seam/connect/models/acs/acs-users/pending-modifications.ts +0 -109
@@ -4,22 +4,37 @@ export interface Routes {
4
4
  method: 'POST'
5
5
  queryParams: {}
6
6
  jsonBody: {
7
+ /** ID of the device for which to create the new access code. */
7
8
  device_id: string
9
+ /** Name of the new access code. */
8
10
  name?: string | undefined
11
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
9
12
  starts_at?: string | undefined
13
+ /** Date and time at which the validity of the new access code 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`. */
10
14
  ends_at?: string | undefined
15
+ /** Code to be used for access. */
11
16
  code?: string | undefined
17
+ /** */
12
18
  sync?: boolean
13
19
  attempt_for_offline_device?: boolean
20
+ /** Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes). */
14
21
  common_code_key?: string | undefined
22
+ /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
15
23
  prefer_native_scheduling?: boolean | undefined
24
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
16
25
  use_backup_access_code_pool?: boolean | undefined
26
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
17
27
  allow_external_modification?: boolean | undefined
28
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
18
29
  is_external_modification_allowed?: boolean | undefined
30
+ /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
19
31
  preferred_code_length?: number | undefined
20
32
  use_offline_access_code?: boolean | undefined
33
+ /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
21
34
  is_offline_access_code?: boolean | undefined
35
+ /** Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
22
36
  is_one_time_use?: boolean | undefined
37
+ /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
23
38
  max_time_rounding?: '1hour' | '1day' | '1h' | '1d'
24
39
  }
25
40
  commonParams: {}
@@ -1143,13 +1158,19 @@ export interface Routes {
1143
1158
  message: string
1144
1159
  }
1145
1160
  }
1146
- /** */
1161
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
1162
+
1163
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
1164
+
1165
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
1166
+
1167
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
1147
1168
  access_code: {
1148
1169
  /** Unique identifier for a group of access codes that share the same code. */
1149
1170
  common_code_key: string | null
1150
1171
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
1151
1172
  is_scheduled_on_device?: boolean | undefined
1152
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
1173
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
1153
1174
  type: 'time_bound' | 'ongoing'
1154
1175
  /** Indicates whether the access code is waiting for a code assignment. */
1155
1176
  is_waiting_for_code_assignment?: boolean | undefined
@@ -1163,172 +1184,244 @@ export interface Routes {
1163
1184
  code: string | null
1164
1185
  /** Date and time at which the access code was created. */
1165
1186
  created_at: string
1166
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
1187
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
1167
1188
  errors: Array<
1168
1189
  | {
1190
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1169
1191
  message: string
1192
+ /** Indicates that this is an access code error. */
1170
1193
  is_access_code_error: true
1194
+ /** Date and time at which Seam created the error. */
1171
1195
  created_at?: string | undefined
1172
1196
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1173
1197
  error_code: 'smartthings_failed_to_set_access_code'
1174
1198
  }
1175
1199
  | {
1200
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1176
1201
  message: string
1202
+ /** Indicates that this is an access code error. */
1177
1203
  is_access_code_error: true
1204
+ /** Date and time at which Seam created the error. */
1178
1205
  created_at?: string | undefined
1179
1206
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1180
1207
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
1181
1208
  }
1182
1209
  | {
1210
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1183
1211
  message: string
1212
+ /** Indicates that this is an access code error. */
1184
1213
  is_access_code_error: true
1214
+ /** Date and time at which Seam created the error. */
1185
1215
  created_at?: string | undefined
1186
1216
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1187
1217
  error_code: 'smartthings_no_free_slots_available'
1188
1218
  }
1189
1219
  | {
1220
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1190
1221
  message: string
1222
+ /** Indicates that this is an access code error. */
1191
1223
  is_access_code_error: true
1224
+ /** Date and time at which Seam created the error. */
1192
1225
  created_at?: string | undefined
1193
1226
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1194
1227
  error_code: 'failed_to_set_on_device'
1195
1228
  }
1196
1229
  | {
1230
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1197
1231
  message: string
1232
+ /** Indicates that this is an access code error. */
1198
1233
  is_access_code_error: true
1234
+ /** Date and time at which Seam created the error. */
1199
1235
  created_at?: string | undefined
1200
1236
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1201
1237
  error_code: 'failed_to_remove_from_device'
1202
1238
  }
1203
1239
  | {
1240
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1204
1241
  message: string
1242
+ /** Indicates that this is an access code error. */
1205
1243
  is_access_code_error: true
1244
+ /** Date and time at which Seam created the error. */
1206
1245
  created_at?: string | undefined
1207
1246
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1208
1247
  error_code: 'duplicate_code_on_device'
1209
1248
  }
1210
1249
  | {
1250
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1211
1251
  message: string
1252
+ /** Indicates that this is an access code error. */
1212
1253
  is_access_code_error: true
1254
+ /** Date and time at which Seam created the error. */
1213
1255
  created_at?: string | undefined
1214
1256
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1215
1257
  error_code: 'duplicate_code_attempt_prevented'
1216
1258
  }
1217
1259
  | {
1260
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1218
1261
  message: string
1262
+ /** Indicates that this is an access code error. */
1219
1263
  is_access_code_error: true
1264
+ /** Date and time at which Seam created the error. */
1220
1265
  created_at?: string | undefined
1221
1266
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1222
1267
  error_code: 'igloohome_bridge_too_many_pending_jobs'
1223
1268
  }
1224
1269
  | {
1270
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1225
1271
  message: string
1272
+ /** Indicates that this is an access code error. */
1226
1273
  is_access_code_error: true
1274
+ /** Date and time at which Seam created the error. */
1227
1275
  created_at?: string | undefined
1228
1276
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1229
1277
  error_code: 'igloohome_bridge_offline'
1230
1278
  }
1231
1279
  | {
1280
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1232
1281
  message: string
1282
+ /** Indicates that this is an access code error. */
1233
1283
  is_access_code_error: true
1284
+ /** Date and time at which Seam created the error. */
1234
1285
  created_at?: string | undefined
1235
1286
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1236
1287
  error_code: 'igloohome_offline_access_code_no_variance_available'
1237
1288
  }
1238
1289
  | {
1290
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1239
1291
  message: string
1292
+ /** Indicates that this is an access code error. */
1240
1293
  is_access_code_error: true
1294
+ /** Date and time at which Seam created the error. */
1241
1295
  created_at?: string | undefined
1242
1296
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1243
1297
  error_code: 'kwikset_unable_to_confirm_code'
1244
1298
  }
1245
1299
  | {
1300
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1246
1301
  message: string
1302
+ /** Indicates that this is an access code error. */
1247
1303
  is_access_code_error: true
1304
+ /** Date and time at which Seam created the error. */
1248
1305
  created_at?: string | undefined
1249
1306
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1250
1307
  error_code: 'kwikset_unable_to_confirm_deletion'
1251
1308
  }
1252
1309
  | {
1310
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1253
1311
  message: string
1312
+ /** Indicates that this is an access code error. */
1254
1313
  is_access_code_error: true
1314
+ /** Date and time at which Seam created the error. */
1255
1315
  created_at?: string | undefined
1256
1316
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1257
1317
  error_code: 'code_modified_external_to_seam'
1258
1318
  }
1259
1319
  | {
1320
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1260
1321
  message: string
1322
+ /** Indicates that this is an access code error. */
1261
1323
  is_access_code_error: true
1324
+ /** Date and time at which Seam created the error. */
1262
1325
  created_at?: string | undefined
1263
1326
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1264
1327
  error_code: 'august_lock_invalid_code_length'
1265
1328
  }
1266
1329
  | {
1330
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1267
1331
  message: string
1332
+ /** Indicates that this is an access code error. */
1268
1333
  is_access_code_error: true
1334
+ /** Date and time at which Seam created the error. */
1269
1335
  created_at?: string | undefined
1270
1336
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1271
1337
  error_code: 'august_device_programming_delay'
1272
1338
  }
1273
1339
  | {
1340
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1274
1341
  message: string
1342
+ /** Indicates that this is an access code error. */
1275
1343
  is_access_code_error: true
1344
+ /** Date and time at which Seam created the error. */
1276
1345
  created_at?: string | undefined
1277
1346
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1278
1347
  error_code: 'august_device_slots_full'
1279
1348
  }
1280
1349
  | {
1350
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1281
1351
  message: string
1352
+ /** Indicates that this is an access code error. */
1282
1353
  is_access_code_error: true
1354
+ /** Date and time at which Seam created the error. */
1283
1355
  created_at?: string | undefined
1284
1356
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1285
1357
  error_code: 'august_lock_missing_keypad'
1286
1358
  }
1287
1359
  | {
1360
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1288
1361
  message: string
1362
+ /** Indicates that this is an access code error. */
1289
1363
  is_access_code_error: true
1364
+ /** Date and time at which Seam created the error. */
1290
1365
  created_at?: string | undefined
1291
1366
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1292
1367
  error_code: 'august_lock_temporarily_offline'
1293
1368
  }
1294
1369
  | {
1370
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1295
1371
  message: string
1372
+ /** Indicates that this is an access code error. */
1296
1373
  is_access_code_error: true
1374
+ /** Date and time at which Seam created the error. */
1297
1375
  created_at?: string | undefined
1298
1376
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1299
1377
  error_code: 'salto_ks_user_not_subscribed'
1300
1378
  }
1301
1379
  | {
1380
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1302
1381
  message: string
1382
+ /** Indicates that this is an access code error. */
1303
1383
  is_access_code_error: true
1384
+ /** Date and time at which Seam created the error. */
1304
1385
  created_at?: string | undefined
1305
1386
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1306
1387
  error_code: 'hubitat_device_programming_delay'
1307
1388
  }
1308
1389
  | {
1390
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1309
1391
  message: string
1392
+ /** Indicates that this is an access code error. */
1310
1393
  is_access_code_error: true
1394
+ /** Date and time at which Seam created the error. */
1311
1395
  created_at?: string | undefined
1312
1396
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1313
1397
  error_code: 'hubitat_no_free_positions_available'
1314
1398
  }
1315
1399
  | {
1400
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1316
1401
  message: string
1402
+ /** Indicates that this is an access code error. */
1317
1403
  is_access_code_error: true
1404
+ /** Date and time at which Seam created the error. */
1318
1405
  created_at?: string | undefined
1319
1406
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1320
1407
  error_code: 'wyze_duplicate_code_name'
1321
1408
  }
1322
1409
  | {
1410
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1323
1411
  message: string
1412
+ /** Indicates that this is an access code error. */
1324
1413
  is_access_code_error: true
1414
+ /** Date and time at which Seam created the error. */
1325
1415
  created_at?: string | undefined
1326
1416
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1327
1417
  error_code: 'wyze_potential_duplicate_code'
1328
1418
  }
1329
1419
  | {
1420
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1330
1421
  message: string
1422
+ /** Indicates that this is an access code error. */
1331
1423
  is_access_code_error: true
1424
+ /** Date and time at which Seam created the error. */
1332
1425
  created_at?: string | undefined
1333
1426
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1334
1427
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -1445,76 +1538,100 @@ export interface Routes {
1445
1538
  error_code: 'bridge_disconnected'
1446
1539
  }
1447
1540
  >
1448
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
1541
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
1449
1542
  warnings: Array<
1450
1543
  | {
1544
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1451
1545
  message: string
1546
+ /** Date and time at which Seam created the warning. */
1452
1547
  created_at?: string | undefined
1453
1548
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1454
1549
  warning_code: 'smartthings_failed_to_set_access_code'
1455
1550
  }
1456
1551
  | {
1552
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1457
1553
  message: string
1554
+ /** Date and time at which Seam created the warning. */
1458
1555
  created_at?: string | undefined
1459
1556
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1460
1557
  warning_code: 'schlage_detected_duplicate'
1461
1558
  }
1462
1559
  | {
1560
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1463
1561
  message: string
1562
+ /** Date and time at which Seam created the warning. */
1464
1563
  created_at?: string | undefined
1465
1564
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1466
1565
  warning_code: 'schlage_creation_outage'
1467
1566
  }
1468
1567
  | {
1568
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1469
1569
  message: string
1570
+ /** Date and time at which Seam created the warning. */
1470
1571
  created_at?: string | undefined
1471
1572
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1472
1573
  warning_code: 'code_modified_external_to_seam'
1473
1574
  }
1474
1575
  | {
1576
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1475
1577
  message: string
1578
+ /** Date and time at which Seam created the warning. */
1476
1579
  created_at?: string | undefined
1477
1580
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1478
1581
  warning_code: 'delay_in_setting_on_device'
1479
1582
  }
1480
1583
  | {
1584
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1481
1585
  message: string
1586
+ /** Date and time at which Seam created the warning. */
1482
1587
  created_at?: string | undefined
1483
1588
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1484
1589
  warning_code: 'delay_in_removing_from_device'
1485
1590
  }
1486
1591
  | {
1592
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1487
1593
  message: string
1594
+ /** Date and time at which Seam created the warning. */
1488
1595
  created_at?: string | undefined
1489
1596
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1490
1597
  warning_code: 'third_party_integration_detected'
1491
1598
  }
1492
1599
  | {
1600
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1493
1601
  message: string
1602
+ /** Date and time at which Seam created the warning. */
1494
1603
  created_at?: string | undefined
1495
1604
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1496
1605
  warning_code: 'august_device_programming_delay'
1497
1606
  }
1498
1607
  | {
1608
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1499
1609
  message: string
1610
+ /** Date and time at which Seam created the warning. */
1500
1611
  created_at?: string | undefined
1501
1612
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1502
1613
  warning_code: 'august_lock_temporarily_offline'
1503
1614
  }
1504
1615
  | {
1616
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1505
1617
  message: string
1618
+ /** Date and time at which Seam created the warning. */
1506
1619
  created_at?: string | undefined
1507
1620
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1508
1621
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
1509
1622
  }
1510
1623
  | {
1624
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1511
1625
  message: string
1626
+ /** Date and time at which Seam created the warning. */
1512
1627
  created_at?: string | undefined
1513
1628
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1514
1629
  warning_code: 'management_transferred'
1515
1630
  }
1516
1631
  | {
1632
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1517
1633
  message: string
1634
+ /** Date and time at which Seam created the warning. */
1518
1635
  created_at?: string | undefined
1519
1636
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1520
1637
  warning_code: 'kwikset_unable_to_confirm_code'
@@ -1526,9 +1643,7 @@ export interface Routes {
1526
1643
  starts_at?: (string | null) | undefined
1527
1644
  /** Date and time after which the time-bound access code becomes inactive. */
1528
1645
  ends_at?: (string | null) | undefined
1529
- /**
1530
- 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.
1531
- */
1646
+ /** 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. */
1532
1647
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
1533
1648
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
1534
1649
  is_backup_access_code_available: boolean
@@ -1538,9 +1653,9 @@ export interface Routes {
1538
1653
  pulled_backup_access_code_id?: (string | null) | undefined
1539
1654
  /** Indicates whether changes to the access code from external sources are permitted. */
1540
1655
  is_external_modification_allowed: boolean
1541
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
1656
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
1542
1657
  is_one_time_use: boolean
1543
- /** 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. */
1658
+ /** 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. */
1544
1659
  is_offline_access_code: boolean
1545
1660
  }
1546
1661
  }
@@ -1550,21 +1665,35 @@ export interface Routes {
1550
1665
  method: 'POST' | 'PUT'
1551
1666
  queryParams: {}
1552
1667
  jsonBody: {
1668
+ /** IDs of the devices for which to create the new access codes. */
1553
1669
  device_ids: string[]
1670
+ /** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
1554
1671
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code'
1672
+ /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
1555
1673
  preferred_code_length?: number | undefined
1674
+ /** Name of the new access code. */
1556
1675
  name?: string | undefined
1676
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
1557
1677
  starts_at?: string | undefined
1678
+ /** Date and time at which the validity of the new access code 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`. */
1558
1679
  ends_at?: string | undefined
1680
+ /** Code to be used for access. */
1559
1681
  code?: string | undefined
1560
1682
  attempt_for_offline_device?: boolean
1683
+ /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
1561
1684
  prefer_native_scheduling?: boolean | undefined
1685
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
1562
1686
  use_backup_access_code_pool?: boolean | undefined
1687
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1563
1688
  allow_external_modification?: boolean | undefined
1689
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1564
1690
  is_external_modification_allowed?: boolean | undefined
1565
1691
  use_offline_access_code?: boolean | undefined
1692
+ /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
1566
1693
  is_offline_access_code?: boolean | undefined
1694
+ /** Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
1567
1695
  is_one_time_use?: boolean | undefined
1696
+ /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
1568
1697
  max_time_rounding?: '1hour' | '1day' | '1h' | '1d'
1569
1698
  }
1570
1699
  commonParams: {}
@@ -1575,7 +1704,7 @@ export interface Routes {
1575
1704
  common_code_key: string | null
1576
1705
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
1577
1706
  is_scheduled_on_device?: boolean | undefined
1578
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
1707
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
1579
1708
  type: 'time_bound' | 'ongoing'
1580
1709
  /** Indicates whether the access code is waiting for a code assignment. */
1581
1710
  is_waiting_for_code_assignment?: boolean | undefined
@@ -1589,172 +1718,244 @@ export interface Routes {
1589
1718
  code: string | null
1590
1719
  /** Date and time at which the access code was created. */
1591
1720
  created_at: string
1592
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
1721
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
1593
1722
  errors: Array<
1594
1723
  | {
1724
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1595
1725
  message: string
1726
+ /** Indicates that this is an access code error. */
1596
1727
  is_access_code_error: true
1728
+ /** Date and time at which Seam created the error. */
1597
1729
  created_at?: string | undefined
1598
1730
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1599
1731
  error_code: 'smartthings_failed_to_set_access_code'
1600
1732
  }
1601
1733
  | {
1734
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1602
1735
  message: string
1736
+ /** Indicates that this is an access code error. */
1603
1737
  is_access_code_error: true
1738
+ /** Date and time at which Seam created the error. */
1604
1739
  created_at?: string | undefined
1605
1740
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1606
1741
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
1607
1742
  }
1608
1743
  | {
1744
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1609
1745
  message: string
1746
+ /** Indicates that this is an access code error. */
1610
1747
  is_access_code_error: true
1748
+ /** Date and time at which Seam created the error. */
1611
1749
  created_at?: string | undefined
1612
1750
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1613
1751
  error_code: 'smartthings_no_free_slots_available'
1614
1752
  }
1615
1753
  | {
1754
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1616
1755
  message: string
1756
+ /** Indicates that this is an access code error. */
1617
1757
  is_access_code_error: true
1758
+ /** Date and time at which Seam created the error. */
1618
1759
  created_at?: string | undefined
1619
1760
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1620
1761
  error_code: 'failed_to_set_on_device'
1621
1762
  }
1622
1763
  | {
1764
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1623
1765
  message: string
1766
+ /** Indicates that this is an access code error. */
1624
1767
  is_access_code_error: true
1768
+ /** Date and time at which Seam created the error. */
1625
1769
  created_at?: string | undefined
1626
1770
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1627
1771
  error_code: 'failed_to_remove_from_device'
1628
1772
  }
1629
1773
  | {
1774
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1630
1775
  message: string
1776
+ /** Indicates that this is an access code error. */
1631
1777
  is_access_code_error: true
1778
+ /** Date and time at which Seam created the error. */
1632
1779
  created_at?: string | undefined
1633
1780
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1634
1781
  error_code: 'duplicate_code_on_device'
1635
1782
  }
1636
1783
  | {
1784
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1637
1785
  message: string
1786
+ /** Indicates that this is an access code error. */
1638
1787
  is_access_code_error: true
1788
+ /** Date and time at which Seam created the error. */
1639
1789
  created_at?: string | undefined
1640
1790
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1641
1791
  error_code: 'duplicate_code_attempt_prevented'
1642
1792
  }
1643
1793
  | {
1794
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1644
1795
  message: string
1796
+ /** Indicates that this is an access code error. */
1645
1797
  is_access_code_error: true
1798
+ /** Date and time at which Seam created the error. */
1646
1799
  created_at?: string | undefined
1647
1800
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1648
1801
  error_code: 'igloohome_bridge_too_many_pending_jobs'
1649
1802
  }
1650
1803
  | {
1804
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1651
1805
  message: string
1806
+ /** Indicates that this is an access code error. */
1652
1807
  is_access_code_error: true
1808
+ /** Date and time at which Seam created the error. */
1653
1809
  created_at?: string | undefined
1654
1810
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1655
1811
  error_code: 'igloohome_bridge_offline'
1656
1812
  }
1657
1813
  | {
1814
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1658
1815
  message: string
1816
+ /** Indicates that this is an access code error. */
1659
1817
  is_access_code_error: true
1818
+ /** Date and time at which Seam created the error. */
1660
1819
  created_at?: string | undefined
1661
1820
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1662
1821
  error_code: 'igloohome_offline_access_code_no_variance_available'
1663
1822
  }
1664
1823
  | {
1824
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1665
1825
  message: string
1826
+ /** Indicates that this is an access code error. */
1666
1827
  is_access_code_error: true
1828
+ /** Date and time at which Seam created the error. */
1667
1829
  created_at?: string | undefined
1668
1830
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1669
1831
  error_code: 'kwikset_unable_to_confirm_code'
1670
1832
  }
1671
1833
  | {
1834
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1672
1835
  message: string
1836
+ /** Indicates that this is an access code error. */
1673
1837
  is_access_code_error: true
1838
+ /** Date and time at which Seam created the error. */
1674
1839
  created_at?: string | undefined
1675
1840
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1676
1841
  error_code: 'kwikset_unable_to_confirm_deletion'
1677
1842
  }
1678
1843
  | {
1844
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1679
1845
  message: string
1846
+ /** Indicates that this is an access code error. */
1680
1847
  is_access_code_error: true
1848
+ /** Date and time at which Seam created the error. */
1681
1849
  created_at?: string | undefined
1682
1850
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1683
1851
  error_code: 'code_modified_external_to_seam'
1684
1852
  }
1685
1853
  | {
1854
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1686
1855
  message: string
1856
+ /** Indicates that this is an access code error. */
1687
1857
  is_access_code_error: true
1858
+ /** Date and time at which Seam created the error. */
1688
1859
  created_at?: string | undefined
1689
1860
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1690
1861
  error_code: 'august_lock_invalid_code_length'
1691
1862
  }
1692
1863
  | {
1864
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1693
1865
  message: string
1866
+ /** Indicates that this is an access code error. */
1694
1867
  is_access_code_error: true
1868
+ /** Date and time at which Seam created the error. */
1695
1869
  created_at?: string | undefined
1696
1870
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1697
1871
  error_code: 'august_device_programming_delay'
1698
1872
  }
1699
1873
  | {
1874
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1700
1875
  message: string
1876
+ /** Indicates that this is an access code error. */
1701
1877
  is_access_code_error: true
1878
+ /** Date and time at which Seam created the error. */
1702
1879
  created_at?: string | undefined
1703
1880
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1704
1881
  error_code: 'august_device_slots_full'
1705
1882
  }
1706
1883
  | {
1884
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1707
1885
  message: string
1886
+ /** Indicates that this is an access code error. */
1708
1887
  is_access_code_error: true
1888
+ /** Date and time at which Seam created the error. */
1709
1889
  created_at?: string | undefined
1710
1890
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1711
1891
  error_code: 'august_lock_missing_keypad'
1712
1892
  }
1713
1893
  | {
1894
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1714
1895
  message: string
1896
+ /** Indicates that this is an access code error. */
1715
1897
  is_access_code_error: true
1898
+ /** Date and time at which Seam created the error. */
1716
1899
  created_at?: string | undefined
1717
1900
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1718
1901
  error_code: 'august_lock_temporarily_offline'
1719
1902
  }
1720
1903
  | {
1904
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1721
1905
  message: string
1906
+ /** Indicates that this is an access code error. */
1722
1907
  is_access_code_error: true
1908
+ /** Date and time at which Seam created the error. */
1723
1909
  created_at?: string | undefined
1724
1910
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1725
1911
  error_code: 'salto_ks_user_not_subscribed'
1726
1912
  }
1727
1913
  | {
1914
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1728
1915
  message: string
1916
+ /** Indicates that this is an access code error. */
1729
1917
  is_access_code_error: true
1918
+ /** Date and time at which Seam created the error. */
1730
1919
  created_at?: string | undefined
1731
1920
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1732
1921
  error_code: 'hubitat_device_programming_delay'
1733
1922
  }
1734
1923
  | {
1924
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1735
1925
  message: string
1926
+ /** Indicates that this is an access code error. */
1736
1927
  is_access_code_error: true
1928
+ /** Date and time at which Seam created the error. */
1737
1929
  created_at?: string | undefined
1738
1930
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1739
1931
  error_code: 'hubitat_no_free_positions_available'
1740
1932
  }
1741
1933
  | {
1934
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1742
1935
  message: string
1936
+ /** Indicates that this is an access code error. */
1743
1937
  is_access_code_error: true
1938
+ /** Date and time at which Seam created the error. */
1744
1939
  created_at?: string | undefined
1745
1940
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1746
1941
  error_code: 'wyze_duplicate_code_name'
1747
1942
  }
1748
1943
  | {
1944
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1749
1945
  message: string
1946
+ /** Indicates that this is an access code error. */
1750
1947
  is_access_code_error: true
1948
+ /** Date and time at which Seam created the error. */
1751
1949
  created_at?: string | undefined
1752
1950
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1753
1951
  error_code: 'wyze_potential_duplicate_code'
1754
1952
  }
1755
1953
  | {
1954
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1756
1955
  message: string
1956
+ /** Indicates that this is an access code error. */
1757
1957
  is_access_code_error: true
1958
+ /** Date and time at which Seam created the error. */
1758
1959
  created_at?: string | undefined
1759
1960
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1760
1961
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -1871,76 +2072,100 @@ export interface Routes {
1871
2072
  error_code: 'bridge_disconnected'
1872
2073
  }
1873
2074
  >
1874
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
2075
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
1875
2076
  warnings: Array<
1876
2077
  | {
2078
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1877
2079
  message: string
2080
+ /** Date and time at which Seam created the warning. */
1878
2081
  created_at?: string | undefined
1879
2082
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1880
2083
  warning_code: 'smartthings_failed_to_set_access_code'
1881
2084
  }
1882
2085
  | {
2086
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1883
2087
  message: string
2088
+ /** Date and time at which Seam created the warning. */
1884
2089
  created_at?: string | undefined
1885
2090
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1886
2091
  warning_code: 'schlage_detected_duplicate'
1887
2092
  }
1888
2093
  | {
2094
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1889
2095
  message: string
2096
+ /** Date and time at which Seam created the warning. */
1890
2097
  created_at?: string | undefined
1891
2098
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1892
2099
  warning_code: 'schlage_creation_outage'
1893
2100
  }
1894
2101
  | {
2102
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1895
2103
  message: string
2104
+ /** Date and time at which Seam created the warning. */
1896
2105
  created_at?: string | undefined
1897
2106
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1898
2107
  warning_code: 'code_modified_external_to_seam'
1899
2108
  }
1900
2109
  | {
2110
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1901
2111
  message: string
2112
+ /** Date and time at which Seam created the warning. */
1902
2113
  created_at?: string | undefined
1903
2114
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1904
2115
  warning_code: 'delay_in_setting_on_device'
1905
2116
  }
1906
2117
  | {
2118
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1907
2119
  message: string
2120
+ /** Date and time at which Seam created the warning. */
1908
2121
  created_at?: string | undefined
1909
2122
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1910
2123
  warning_code: 'delay_in_removing_from_device'
1911
2124
  }
1912
2125
  | {
2126
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1913
2127
  message: string
2128
+ /** Date and time at which Seam created the warning. */
1914
2129
  created_at?: string | undefined
1915
2130
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1916
2131
  warning_code: 'third_party_integration_detected'
1917
2132
  }
1918
2133
  | {
2134
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1919
2135
  message: string
2136
+ /** Date and time at which Seam created the warning. */
1920
2137
  created_at?: string | undefined
1921
2138
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1922
2139
  warning_code: 'august_device_programming_delay'
1923
2140
  }
1924
2141
  | {
2142
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1925
2143
  message: string
2144
+ /** Date and time at which Seam created the warning. */
1926
2145
  created_at?: string | undefined
1927
2146
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1928
2147
  warning_code: 'august_lock_temporarily_offline'
1929
2148
  }
1930
2149
  | {
2150
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1931
2151
  message: string
2152
+ /** Date and time at which Seam created the warning. */
1932
2153
  created_at?: string | undefined
1933
2154
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1934
2155
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
1935
2156
  }
1936
2157
  | {
2158
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1937
2159
  message: string
2160
+ /** Date and time at which Seam created the warning. */
1938
2161
  created_at?: string | undefined
1939
2162
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1940
2163
  warning_code: 'management_transferred'
1941
2164
  }
1942
2165
  | {
2166
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1943
2167
  message: string
2168
+ /** Date and time at which Seam created the warning. */
1944
2169
  created_at?: string | undefined
1945
2170
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1946
2171
  warning_code: 'kwikset_unable_to_confirm_code'
@@ -1952,9 +2177,7 @@ export interface Routes {
1952
2177
  starts_at?: (string | null) | undefined
1953
2178
  /** Date and time after which the time-bound access code becomes inactive. */
1954
2179
  ends_at?: (string | null) | undefined
1955
- /**
1956
- 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.
1957
- */
2180
+ /** 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. */
1958
2181
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
1959
2182
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
1960
2183
  is_backup_access_code_available: boolean
@@ -1964,9 +2187,9 @@ export interface Routes {
1964
2187
  pulled_backup_access_code_id?: (string | null) | undefined
1965
2188
  /** Indicates whether changes to the access code from external sources are permitted. */
1966
2189
  is_external_modification_allowed: boolean
1967
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
2190
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
1968
2191
  is_one_time_use: boolean
1969
- /** 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. */
2192
+ /** 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. */
1970
2193
  is_offline_access_code: boolean
1971
2194
  }>
1972
2195
  }
@@ -1977,8 +2200,11 @@ export interface Routes {
1977
2200
  queryParams: {}
1978
2201
  jsonBody: {}
1979
2202
  commonParams: {
2203
+ /** ID of the device for which to delete the access code. */
1980
2204
  device_id?: string | undefined
2205
+ /** ID of the access code to delete. */
1981
2206
  access_code_id: string
2207
+ /** */
1982
2208
  sync?: boolean
1983
2209
  }
1984
2210
  formData: {}
@@ -3125,19 +3351,28 @@ export interface Routes {
3125
3351
  queryParams: {}
3126
3352
  jsonBody: {}
3127
3353
  commonParams: {
3354
+ /** ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
3128
3355
  device_id?: string | undefined
3356
+ /** ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
3129
3357
  access_code_id?: string | undefined
3358
+ /** Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
3130
3359
  code?: string | undefined
3131
3360
  }
3132
3361
  formData: {}
3133
3362
  jsonResponse: {
3134
- /** */
3363
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
3364
+
3365
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
3366
+
3367
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
3368
+
3369
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
3135
3370
  access_code: {
3136
3371
  /** Unique identifier for a group of access codes that share the same code. */
3137
3372
  common_code_key: string | null
3138
3373
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
3139
3374
  is_scheduled_on_device?: boolean | undefined
3140
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
3375
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
3141
3376
  type: 'time_bound' | 'ongoing'
3142
3377
  /** Indicates whether the access code is waiting for a code assignment. */
3143
3378
  is_waiting_for_code_assignment?: boolean | undefined
@@ -3151,172 +3386,244 @@ export interface Routes {
3151
3386
  code: string | null
3152
3387
  /** Date and time at which the access code was created. */
3153
3388
  created_at: string
3154
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
3389
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3155
3390
  errors: Array<
3156
3391
  | {
3392
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3157
3393
  message: string
3394
+ /** Indicates that this is an access code error. */
3158
3395
  is_access_code_error: true
3396
+ /** Date and time at which Seam created the error. */
3159
3397
  created_at?: string | undefined
3160
3398
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3161
3399
  error_code: 'smartthings_failed_to_set_access_code'
3162
3400
  }
3163
3401
  | {
3402
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3164
3403
  message: string
3404
+ /** Indicates that this is an access code error. */
3165
3405
  is_access_code_error: true
3406
+ /** Date and time at which Seam created the error. */
3166
3407
  created_at?: string | undefined
3167
3408
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3168
3409
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
3169
3410
  }
3170
3411
  | {
3412
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3171
3413
  message: string
3414
+ /** Indicates that this is an access code error. */
3172
3415
  is_access_code_error: true
3416
+ /** Date and time at which Seam created the error. */
3173
3417
  created_at?: string | undefined
3174
3418
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3175
3419
  error_code: 'smartthings_no_free_slots_available'
3176
3420
  }
3177
3421
  | {
3422
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3178
3423
  message: string
3424
+ /** Indicates that this is an access code error. */
3179
3425
  is_access_code_error: true
3426
+ /** Date and time at which Seam created the error. */
3180
3427
  created_at?: string | undefined
3181
3428
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3182
3429
  error_code: 'failed_to_set_on_device'
3183
3430
  }
3184
3431
  | {
3432
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3185
3433
  message: string
3434
+ /** Indicates that this is an access code error. */
3186
3435
  is_access_code_error: true
3436
+ /** Date and time at which Seam created the error. */
3187
3437
  created_at?: string | undefined
3188
3438
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3189
3439
  error_code: 'failed_to_remove_from_device'
3190
3440
  }
3191
3441
  | {
3442
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3192
3443
  message: string
3444
+ /** Indicates that this is an access code error. */
3193
3445
  is_access_code_error: true
3446
+ /** Date and time at which Seam created the error. */
3194
3447
  created_at?: string | undefined
3195
3448
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3196
3449
  error_code: 'duplicate_code_on_device'
3197
3450
  }
3198
3451
  | {
3452
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3199
3453
  message: string
3454
+ /** Indicates that this is an access code error. */
3200
3455
  is_access_code_error: true
3456
+ /** Date and time at which Seam created the error. */
3201
3457
  created_at?: string | undefined
3202
3458
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3203
3459
  error_code: 'duplicate_code_attempt_prevented'
3204
3460
  }
3205
3461
  | {
3462
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3206
3463
  message: string
3464
+ /** Indicates that this is an access code error. */
3207
3465
  is_access_code_error: true
3466
+ /** Date and time at which Seam created the error. */
3208
3467
  created_at?: string | undefined
3209
3468
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3210
3469
  error_code: 'igloohome_bridge_too_many_pending_jobs'
3211
3470
  }
3212
3471
  | {
3472
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3213
3473
  message: string
3474
+ /** Indicates that this is an access code error. */
3214
3475
  is_access_code_error: true
3476
+ /** Date and time at which Seam created the error. */
3215
3477
  created_at?: string | undefined
3216
3478
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3217
3479
  error_code: 'igloohome_bridge_offline'
3218
3480
  }
3219
3481
  | {
3482
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3220
3483
  message: string
3484
+ /** Indicates that this is an access code error. */
3221
3485
  is_access_code_error: true
3486
+ /** Date and time at which Seam created the error. */
3222
3487
  created_at?: string | undefined
3223
3488
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3224
3489
  error_code: 'igloohome_offline_access_code_no_variance_available'
3225
3490
  }
3226
3491
  | {
3492
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3227
3493
  message: string
3494
+ /** Indicates that this is an access code error. */
3228
3495
  is_access_code_error: true
3496
+ /** Date and time at which Seam created the error. */
3229
3497
  created_at?: string | undefined
3230
3498
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3231
3499
  error_code: 'kwikset_unable_to_confirm_code'
3232
3500
  }
3233
3501
  | {
3502
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3234
3503
  message: string
3504
+ /** Indicates that this is an access code error. */
3235
3505
  is_access_code_error: true
3506
+ /** Date and time at which Seam created the error. */
3236
3507
  created_at?: string | undefined
3237
3508
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3238
3509
  error_code: 'kwikset_unable_to_confirm_deletion'
3239
3510
  }
3240
3511
  | {
3512
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3241
3513
  message: string
3514
+ /** Indicates that this is an access code error. */
3242
3515
  is_access_code_error: true
3516
+ /** Date and time at which Seam created the error. */
3243
3517
  created_at?: string | undefined
3244
3518
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3245
3519
  error_code: 'code_modified_external_to_seam'
3246
3520
  }
3247
3521
  | {
3522
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3248
3523
  message: string
3524
+ /** Indicates that this is an access code error. */
3249
3525
  is_access_code_error: true
3526
+ /** Date and time at which Seam created the error. */
3250
3527
  created_at?: string | undefined
3251
3528
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3252
3529
  error_code: 'august_lock_invalid_code_length'
3253
3530
  }
3254
3531
  | {
3532
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3255
3533
  message: string
3534
+ /** Indicates that this is an access code error. */
3256
3535
  is_access_code_error: true
3536
+ /** Date and time at which Seam created the error. */
3257
3537
  created_at?: string | undefined
3258
3538
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3259
3539
  error_code: 'august_device_programming_delay'
3260
3540
  }
3261
3541
  | {
3542
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3262
3543
  message: string
3544
+ /** Indicates that this is an access code error. */
3263
3545
  is_access_code_error: true
3546
+ /** Date and time at which Seam created the error. */
3264
3547
  created_at?: string | undefined
3265
3548
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3266
3549
  error_code: 'august_device_slots_full'
3267
3550
  }
3268
3551
  | {
3552
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3269
3553
  message: string
3554
+ /** Indicates that this is an access code error. */
3270
3555
  is_access_code_error: true
3556
+ /** Date and time at which Seam created the error. */
3271
3557
  created_at?: string | undefined
3272
3558
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3273
3559
  error_code: 'august_lock_missing_keypad'
3274
3560
  }
3275
3561
  | {
3562
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3276
3563
  message: string
3564
+ /** Indicates that this is an access code error. */
3277
3565
  is_access_code_error: true
3566
+ /** Date and time at which Seam created the error. */
3278
3567
  created_at?: string | undefined
3279
3568
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3280
3569
  error_code: 'august_lock_temporarily_offline'
3281
3570
  }
3282
3571
  | {
3572
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3283
3573
  message: string
3574
+ /** Indicates that this is an access code error. */
3284
3575
  is_access_code_error: true
3576
+ /** Date and time at which Seam created the error. */
3285
3577
  created_at?: string | undefined
3286
3578
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3287
3579
  error_code: 'salto_ks_user_not_subscribed'
3288
3580
  }
3289
3581
  | {
3582
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3290
3583
  message: string
3584
+ /** Indicates that this is an access code error. */
3291
3585
  is_access_code_error: true
3586
+ /** Date and time at which Seam created the error. */
3292
3587
  created_at?: string | undefined
3293
3588
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3294
3589
  error_code: 'hubitat_device_programming_delay'
3295
3590
  }
3296
3591
  | {
3592
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3297
3593
  message: string
3594
+ /** Indicates that this is an access code error. */
3298
3595
  is_access_code_error: true
3596
+ /** Date and time at which Seam created the error. */
3299
3597
  created_at?: string | undefined
3300
3598
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3301
3599
  error_code: 'hubitat_no_free_positions_available'
3302
3600
  }
3303
3601
  | {
3602
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3304
3603
  message: string
3604
+ /** Indicates that this is an access code error. */
3305
3605
  is_access_code_error: true
3606
+ /** Date and time at which Seam created the error. */
3306
3607
  created_at?: string | undefined
3307
3608
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3308
3609
  error_code: 'wyze_duplicate_code_name'
3309
3610
  }
3310
3611
  | {
3612
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3311
3613
  message: string
3614
+ /** Indicates that this is an access code error. */
3312
3615
  is_access_code_error: true
3616
+ /** Date and time at which Seam created the error. */
3313
3617
  created_at?: string | undefined
3314
3618
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3315
3619
  error_code: 'wyze_potential_duplicate_code'
3316
3620
  }
3317
3621
  | {
3622
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3318
3623
  message: string
3624
+ /** Indicates that this is an access code error. */
3319
3625
  is_access_code_error: true
3626
+ /** Date and time at which Seam created the error. */
3320
3627
  created_at?: string | undefined
3321
3628
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3322
3629
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -3433,76 +3740,100 @@ export interface Routes {
3433
3740
  error_code: 'bridge_disconnected'
3434
3741
  }
3435
3742
  >
3436
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
3743
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3437
3744
  warnings: Array<
3438
3745
  | {
3746
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3439
3747
  message: string
3748
+ /** Date and time at which Seam created the warning. */
3440
3749
  created_at?: string | undefined
3441
3750
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3442
3751
  warning_code: 'smartthings_failed_to_set_access_code'
3443
3752
  }
3444
3753
  | {
3754
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3445
3755
  message: string
3756
+ /** Date and time at which Seam created the warning. */
3446
3757
  created_at?: string | undefined
3447
3758
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3448
3759
  warning_code: 'schlage_detected_duplicate'
3449
3760
  }
3450
3761
  | {
3762
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3451
3763
  message: string
3764
+ /** Date and time at which Seam created the warning. */
3452
3765
  created_at?: string | undefined
3453
3766
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3454
3767
  warning_code: 'schlage_creation_outage'
3455
3768
  }
3456
3769
  | {
3770
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3457
3771
  message: string
3772
+ /** Date and time at which Seam created the warning. */
3458
3773
  created_at?: string | undefined
3459
3774
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3460
3775
  warning_code: 'code_modified_external_to_seam'
3461
3776
  }
3462
3777
  | {
3778
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3463
3779
  message: string
3780
+ /** Date and time at which Seam created the warning. */
3464
3781
  created_at?: string | undefined
3465
3782
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3466
3783
  warning_code: 'delay_in_setting_on_device'
3467
3784
  }
3468
3785
  | {
3786
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3469
3787
  message: string
3788
+ /** Date and time at which Seam created the warning. */
3470
3789
  created_at?: string | undefined
3471
3790
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3472
3791
  warning_code: 'delay_in_removing_from_device'
3473
3792
  }
3474
3793
  | {
3794
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3475
3795
  message: string
3796
+ /** Date and time at which Seam created the warning. */
3476
3797
  created_at?: string | undefined
3477
3798
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3478
3799
  warning_code: 'third_party_integration_detected'
3479
3800
  }
3480
3801
  | {
3802
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3481
3803
  message: string
3804
+ /** Date and time at which Seam created the warning. */
3482
3805
  created_at?: string | undefined
3483
3806
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3484
3807
  warning_code: 'august_device_programming_delay'
3485
3808
  }
3486
3809
  | {
3810
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3487
3811
  message: string
3812
+ /** Date and time at which Seam created the warning. */
3488
3813
  created_at?: string | undefined
3489
3814
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3490
3815
  warning_code: 'august_lock_temporarily_offline'
3491
3816
  }
3492
3817
  | {
3818
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3493
3819
  message: string
3820
+ /** Date and time at which Seam created the warning. */
3494
3821
  created_at?: string | undefined
3495
3822
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3496
3823
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
3497
3824
  }
3498
3825
  | {
3826
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3499
3827
  message: string
3828
+ /** Date and time at which Seam created the warning. */
3500
3829
  created_at?: string | undefined
3501
3830
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3502
3831
  warning_code: 'management_transferred'
3503
3832
  }
3504
3833
  | {
3834
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3505
3835
  message: string
3836
+ /** Date and time at which Seam created the warning. */
3506
3837
  created_at?: string | undefined
3507
3838
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3508
3839
  warning_code: 'kwikset_unable_to_confirm_code'
@@ -3514,9 +3845,7 @@ export interface Routes {
3514
3845
  starts_at?: (string | null) | undefined
3515
3846
  /** Date and time after which the time-bound access code becomes inactive. */
3516
3847
  ends_at?: (string | null) | undefined
3517
- /**
3518
- 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.
3519
- */
3848
+ /** 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. */
3520
3849
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
3521
3850
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
3522
3851
  is_backup_access_code_available: boolean
@@ -3526,9 +3855,9 @@ export interface Routes {
3526
3855
  pulled_backup_access_code_id?: (string | null) | undefined
3527
3856
  /** Indicates whether changes to the access code from external sources are permitted. */
3528
3857
  is_external_modification_allowed: boolean
3529
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
3858
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
3530
3859
  is_one_time_use: boolean
3531
- /** 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. */
3860
+ /** 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. */
3532
3861
  is_offline_access_code: boolean
3533
3862
  }
3534
3863
  }
@@ -3539,8 +3868,11 @@ export interface Routes {
3539
3868
  queryParams: {}
3540
3869
  jsonBody: {}
3541
3870
  commonParams: {
3871
+ /** ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. */
3542
3872
  device_id?: string | undefined
3873
+ /** IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. */
3543
3874
  access_code_ids?: string[] | undefined
3875
+ /** Your user ID for the user by which to filter access codes. */
3544
3876
  user_identifier_key?: string | undefined
3545
3877
  }
3546
3878
  formData: {}
@@ -3550,7 +3882,7 @@ export interface Routes {
3550
3882
  common_code_key: string | null
3551
3883
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
3552
3884
  is_scheduled_on_device?: boolean | undefined
3553
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
3885
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
3554
3886
  type: 'time_bound' | 'ongoing'
3555
3887
  /** Indicates whether the access code is waiting for a code assignment. */
3556
3888
  is_waiting_for_code_assignment?: boolean | undefined
@@ -3564,172 +3896,244 @@ export interface Routes {
3564
3896
  code: string | null
3565
3897
  /** Date and time at which the access code was created. */
3566
3898
  created_at: string
3567
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
3899
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3568
3900
  errors: Array<
3569
3901
  | {
3902
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3570
3903
  message: string
3904
+ /** Indicates that this is an access code error. */
3571
3905
  is_access_code_error: true
3906
+ /** Date and time at which Seam created the error. */
3572
3907
  created_at?: string | undefined
3573
3908
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3574
3909
  error_code: 'smartthings_failed_to_set_access_code'
3575
3910
  }
3576
3911
  | {
3912
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3577
3913
  message: string
3914
+ /** Indicates that this is an access code error. */
3578
3915
  is_access_code_error: true
3916
+ /** Date and time at which Seam created the error. */
3579
3917
  created_at?: string | undefined
3580
3918
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3581
3919
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
3582
3920
  }
3583
3921
  | {
3922
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3584
3923
  message: string
3924
+ /** Indicates that this is an access code error. */
3585
3925
  is_access_code_error: true
3926
+ /** Date and time at which Seam created the error. */
3586
3927
  created_at?: string | undefined
3587
3928
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3588
3929
  error_code: 'smartthings_no_free_slots_available'
3589
3930
  }
3590
3931
  | {
3932
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3591
3933
  message: string
3934
+ /** Indicates that this is an access code error. */
3592
3935
  is_access_code_error: true
3936
+ /** Date and time at which Seam created the error. */
3593
3937
  created_at?: string | undefined
3594
3938
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3595
3939
  error_code: 'failed_to_set_on_device'
3596
3940
  }
3597
3941
  | {
3942
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3598
3943
  message: string
3944
+ /** Indicates that this is an access code error. */
3599
3945
  is_access_code_error: true
3946
+ /** Date and time at which Seam created the error. */
3600
3947
  created_at?: string | undefined
3601
3948
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3602
3949
  error_code: 'failed_to_remove_from_device'
3603
3950
  }
3604
3951
  | {
3952
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3605
3953
  message: string
3954
+ /** Indicates that this is an access code error. */
3606
3955
  is_access_code_error: true
3956
+ /** Date and time at which Seam created the error. */
3607
3957
  created_at?: string | undefined
3608
3958
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3609
3959
  error_code: 'duplicate_code_on_device'
3610
3960
  }
3611
3961
  | {
3962
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3612
3963
  message: string
3964
+ /** Indicates that this is an access code error. */
3613
3965
  is_access_code_error: true
3966
+ /** Date and time at which Seam created the error. */
3614
3967
  created_at?: string | undefined
3615
3968
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3616
3969
  error_code: 'duplicate_code_attempt_prevented'
3617
3970
  }
3618
3971
  | {
3972
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3619
3973
  message: string
3974
+ /** Indicates that this is an access code error. */
3620
3975
  is_access_code_error: true
3976
+ /** Date and time at which Seam created the error. */
3621
3977
  created_at?: string | undefined
3622
3978
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3623
3979
  error_code: 'igloohome_bridge_too_many_pending_jobs'
3624
3980
  }
3625
3981
  | {
3982
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3626
3983
  message: string
3984
+ /** Indicates that this is an access code error. */
3627
3985
  is_access_code_error: true
3986
+ /** Date and time at which Seam created the error. */
3628
3987
  created_at?: string | undefined
3629
3988
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3630
3989
  error_code: 'igloohome_bridge_offline'
3631
3990
  }
3632
3991
  | {
3992
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3633
3993
  message: string
3994
+ /** Indicates that this is an access code error. */
3634
3995
  is_access_code_error: true
3996
+ /** Date and time at which Seam created the error. */
3635
3997
  created_at?: string | undefined
3636
3998
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3637
3999
  error_code: 'igloohome_offline_access_code_no_variance_available'
3638
4000
  }
3639
4001
  | {
4002
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3640
4003
  message: string
4004
+ /** Indicates that this is an access code error. */
3641
4005
  is_access_code_error: true
4006
+ /** Date and time at which Seam created the error. */
3642
4007
  created_at?: string | undefined
3643
4008
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3644
4009
  error_code: 'kwikset_unable_to_confirm_code'
3645
4010
  }
3646
4011
  | {
4012
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3647
4013
  message: string
4014
+ /** Indicates that this is an access code error. */
3648
4015
  is_access_code_error: true
4016
+ /** Date and time at which Seam created the error. */
3649
4017
  created_at?: string | undefined
3650
4018
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3651
4019
  error_code: 'kwikset_unable_to_confirm_deletion'
3652
4020
  }
3653
4021
  | {
4022
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3654
4023
  message: string
4024
+ /** Indicates that this is an access code error. */
3655
4025
  is_access_code_error: true
4026
+ /** Date and time at which Seam created the error. */
3656
4027
  created_at?: string | undefined
3657
4028
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3658
4029
  error_code: 'code_modified_external_to_seam'
3659
4030
  }
3660
4031
  | {
4032
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3661
4033
  message: string
4034
+ /** Indicates that this is an access code error. */
3662
4035
  is_access_code_error: true
4036
+ /** Date and time at which Seam created the error. */
3663
4037
  created_at?: string | undefined
3664
4038
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3665
4039
  error_code: 'august_lock_invalid_code_length'
3666
4040
  }
3667
4041
  | {
4042
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3668
4043
  message: string
4044
+ /** Indicates that this is an access code error. */
3669
4045
  is_access_code_error: true
4046
+ /** Date and time at which Seam created the error. */
3670
4047
  created_at?: string | undefined
3671
4048
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3672
4049
  error_code: 'august_device_programming_delay'
3673
4050
  }
3674
4051
  | {
4052
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3675
4053
  message: string
4054
+ /** Indicates that this is an access code error. */
3676
4055
  is_access_code_error: true
4056
+ /** Date and time at which Seam created the error. */
3677
4057
  created_at?: string | undefined
3678
4058
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3679
4059
  error_code: 'august_device_slots_full'
3680
4060
  }
3681
4061
  | {
4062
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3682
4063
  message: string
4064
+ /** Indicates that this is an access code error. */
3683
4065
  is_access_code_error: true
4066
+ /** Date and time at which Seam created the error. */
3684
4067
  created_at?: string | undefined
3685
4068
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3686
4069
  error_code: 'august_lock_missing_keypad'
3687
4070
  }
3688
4071
  | {
4072
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3689
4073
  message: string
4074
+ /** Indicates that this is an access code error. */
3690
4075
  is_access_code_error: true
4076
+ /** Date and time at which Seam created the error. */
3691
4077
  created_at?: string | undefined
3692
4078
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3693
4079
  error_code: 'august_lock_temporarily_offline'
3694
4080
  }
3695
4081
  | {
4082
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3696
4083
  message: string
4084
+ /** Indicates that this is an access code error. */
3697
4085
  is_access_code_error: true
4086
+ /** Date and time at which Seam created the error. */
3698
4087
  created_at?: string | undefined
3699
4088
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3700
4089
  error_code: 'salto_ks_user_not_subscribed'
3701
4090
  }
3702
4091
  | {
4092
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3703
4093
  message: string
4094
+ /** Indicates that this is an access code error. */
3704
4095
  is_access_code_error: true
4096
+ /** Date and time at which Seam created the error. */
3705
4097
  created_at?: string | undefined
3706
4098
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3707
4099
  error_code: 'hubitat_device_programming_delay'
3708
4100
  }
3709
4101
  | {
4102
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3710
4103
  message: string
4104
+ /** Indicates that this is an access code error. */
3711
4105
  is_access_code_error: true
4106
+ /** Date and time at which Seam created the error. */
3712
4107
  created_at?: string | undefined
3713
4108
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3714
4109
  error_code: 'hubitat_no_free_positions_available'
3715
4110
  }
3716
4111
  | {
4112
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3717
4113
  message: string
4114
+ /** Indicates that this is an access code error. */
3718
4115
  is_access_code_error: true
4116
+ /** Date and time at which Seam created the error. */
3719
4117
  created_at?: string | undefined
3720
4118
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3721
4119
  error_code: 'wyze_duplicate_code_name'
3722
4120
  }
3723
4121
  | {
4122
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3724
4123
  message: string
4124
+ /** Indicates that this is an access code error. */
3725
4125
  is_access_code_error: true
4126
+ /** Date and time at which Seam created the error. */
3726
4127
  created_at?: string | undefined
3727
4128
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3728
4129
  error_code: 'wyze_potential_duplicate_code'
3729
4130
  }
3730
4131
  | {
4132
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3731
4133
  message: string
4134
+ /** Indicates that this is an access code error. */
3732
4135
  is_access_code_error: true
4136
+ /** Date and time at which Seam created the error. */
3733
4137
  created_at?: string | undefined
3734
4138
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3735
4139
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -3846,76 +4250,100 @@ export interface Routes {
3846
4250
  error_code: 'bridge_disconnected'
3847
4251
  }
3848
4252
  >
3849
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
4253
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3850
4254
  warnings: Array<
3851
4255
  | {
4256
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3852
4257
  message: string
4258
+ /** Date and time at which Seam created the warning. */
3853
4259
  created_at?: string | undefined
3854
4260
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3855
4261
  warning_code: 'smartthings_failed_to_set_access_code'
3856
4262
  }
3857
4263
  | {
4264
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3858
4265
  message: string
4266
+ /** Date and time at which Seam created the warning. */
3859
4267
  created_at?: string | undefined
3860
4268
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3861
4269
  warning_code: 'schlage_detected_duplicate'
3862
4270
  }
3863
4271
  | {
4272
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3864
4273
  message: string
4274
+ /** Date and time at which Seam created the warning. */
3865
4275
  created_at?: string | undefined
3866
4276
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3867
4277
  warning_code: 'schlage_creation_outage'
3868
4278
  }
3869
4279
  | {
4280
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3870
4281
  message: string
4282
+ /** Date and time at which Seam created the warning. */
3871
4283
  created_at?: string | undefined
3872
4284
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3873
4285
  warning_code: 'code_modified_external_to_seam'
3874
4286
  }
3875
4287
  | {
4288
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3876
4289
  message: string
4290
+ /** Date and time at which Seam created the warning. */
3877
4291
  created_at?: string | undefined
3878
4292
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3879
4293
  warning_code: 'delay_in_setting_on_device'
3880
4294
  }
3881
4295
  | {
4296
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3882
4297
  message: string
4298
+ /** Date and time at which Seam created the warning. */
3883
4299
  created_at?: string | undefined
3884
4300
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3885
4301
  warning_code: 'delay_in_removing_from_device'
3886
4302
  }
3887
4303
  | {
4304
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3888
4305
  message: string
4306
+ /** Date and time at which Seam created the warning. */
3889
4307
  created_at?: string | undefined
3890
4308
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3891
4309
  warning_code: 'third_party_integration_detected'
3892
4310
  }
3893
4311
  | {
4312
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3894
4313
  message: string
4314
+ /** Date and time at which Seam created the warning. */
3895
4315
  created_at?: string | undefined
3896
4316
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3897
4317
  warning_code: 'august_device_programming_delay'
3898
4318
  }
3899
4319
  | {
4320
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3900
4321
  message: string
4322
+ /** Date and time at which Seam created the warning. */
3901
4323
  created_at?: string | undefined
3902
4324
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3903
4325
  warning_code: 'august_lock_temporarily_offline'
3904
4326
  }
3905
4327
  | {
4328
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3906
4329
  message: string
4330
+ /** Date and time at which Seam created the warning. */
3907
4331
  created_at?: string | undefined
3908
4332
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3909
4333
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
3910
4334
  }
3911
4335
  | {
4336
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3912
4337
  message: string
4338
+ /** Date and time at which Seam created the warning. */
3913
4339
  created_at?: string | undefined
3914
4340
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3915
4341
  warning_code: 'management_transferred'
3916
4342
  }
3917
4343
  | {
4344
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3918
4345
  message: string
4346
+ /** Date and time at which Seam created the warning. */
3919
4347
  created_at?: string | undefined
3920
4348
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3921
4349
  warning_code: 'kwikset_unable_to_confirm_code'
@@ -3927,9 +4355,7 @@ export interface Routes {
3927
4355
  starts_at?: (string | null) | undefined
3928
4356
  /** Date and time after which the time-bound access code becomes inactive. */
3929
4357
  ends_at?: (string | null) | undefined
3930
- /**
3931
- 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.
3932
- */
4358
+ /** 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. */
3933
4359
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
3934
4360
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
3935
4361
  is_backup_access_code_available: boolean
@@ -3939,9 +4365,9 @@ export interface Routes {
3939
4365
  pulled_backup_access_code_id?: (string | null) | undefined
3940
4366
  /** Indicates whether changes to the access code from external sources are permitted. */
3941
4367
  is_external_modification_allowed: boolean
3942
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
4368
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
3943
4369
  is_one_time_use: boolean
3944
- /** 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. */
4370
+ /** 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. */
3945
4371
  is_offline_access_code: boolean
3946
4372
  }>
3947
4373
  }
@@ -3951,18 +4377,25 @@ export interface Routes {
3951
4377
  method: 'POST'
3952
4378
  queryParams: {}
3953
4379
  jsonBody: {
4380
+ /** ID of the access code for which you want to pull a backup access code. */
3954
4381
  access_code_id: string
3955
4382
  }
3956
4383
  commonParams: {}
3957
4384
  formData: {}
3958
4385
  jsonResponse: {
3959
- /** */
4386
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
4387
+
4388
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
4389
+
4390
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
4391
+
4392
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
3960
4393
  backup_access_code: {
3961
4394
  /** Unique identifier for a group of access codes that share the same code. */
3962
4395
  common_code_key: string | null
3963
4396
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
3964
4397
  is_scheduled_on_device?: boolean | undefined
3965
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
4398
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
3966
4399
  type: 'time_bound' | 'ongoing'
3967
4400
  /** Indicates whether the access code is waiting for a code assignment. */
3968
4401
  is_waiting_for_code_assignment?: boolean | undefined
@@ -3976,172 +4409,244 @@ export interface Routes {
3976
4409
  code: string | null
3977
4410
  /** Date and time at which the access code was created. */
3978
4411
  created_at: string
3979
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
4412
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3980
4413
  errors: Array<
3981
4414
  | {
4415
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3982
4416
  message: string
4417
+ /** Indicates that this is an access code error. */
3983
4418
  is_access_code_error: true
4419
+ /** Date and time at which Seam created the error. */
3984
4420
  created_at?: string | undefined
3985
4421
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3986
4422
  error_code: 'smartthings_failed_to_set_access_code'
3987
4423
  }
3988
4424
  | {
4425
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3989
4426
  message: string
4427
+ /** Indicates that this is an access code error. */
3990
4428
  is_access_code_error: true
4429
+ /** Date and time at which Seam created the error. */
3991
4430
  created_at?: string | undefined
3992
4431
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3993
4432
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
3994
4433
  }
3995
4434
  | {
4435
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3996
4436
  message: string
4437
+ /** Indicates that this is an access code error. */
3997
4438
  is_access_code_error: true
4439
+ /** Date and time at which Seam created the error. */
3998
4440
  created_at?: string | undefined
3999
4441
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4000
4442
  error_code: 'smartthings_no_free_slots_available'
4001
4443
  }
4002
4444
  | {
4445
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4003
4446
  message: string
4447
+ /** Indicates that this is an access code error. */
4004
4448
  is_access_code_error: true
4449
+ /** Date and time at which Seam created the error. */
4005
4450
  created_at?: string | undefined
4006
4451
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4007
4452
  error_code: 'failed_to_set_on_device'
4008
4453
  }
4009
4454
  | {
4455
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4010
4456
  message: string
4457
+ /** Indicates that this is an access code error. */
4011
4458
  is_access_code_error: true
4459
+ /** Date and time at which Seam created the error. */
4012
4460
  created_at?: string | undefined
4013
4461
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4014
4462
  error_code: 'failed_to_remove_from_device'
4015
4463
  }
4016
4464
  | {
4465
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4017
4466
  message: string
4467
+ /** Indicates that this is an access code error. */
4018
4468
  is_access_code_error: true
4469
+ /** Date and time at which Seam created the error. */
4019
4470
  created_at?: string | undefined
4020
4471
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4021
4472
  error_code: 'duplicate_code_on_device'
4022
4473
  }
4023
4474
  | {
4475
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4024
4476
  message: string
4477
+ /** Indicates that this is an access code error. */
4025
4478
  is_access_code_error: true
4479
+ /** Date and time at which Seam created the error. */
4026
4480
  created_at?: string | undefined
4027
4481
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4028
4482
  error_code: 'duplicate_code_attempt_prevented'
4029
4483
  }
4030
4484
  | {
4485
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4031
4486
  message: string
4487
+ /** Indicates that this is an access code error. */
4032
4488
  is_access_code_error: true
4489
+ /** Date and time at which Seam created the error. */
4033
4490
  created_at?: string | undefined
4034
4491
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4035
4492
  error_code: 'igloohome_bridge_too_many_pending_jobs'
4036
4493
  }
4037
4494
  | {
4495
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4038
4496
  message: string
4497
+ /** Indicates that this is an access code error. */
4039
4498
  is_access_code_error: true
4499
+ /** Date and time at which Seam created the error. */
4040
4500
  created_at?: string | undefined
4041
4501
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4042
4502
  error_code: 'igloohome_bridge_offline'
4043
4503
  }
4044
4504
  | {
4505
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4045
4506
  message: string
4507
+ /** Indicates that this is an access code error. */
4046
4508
  is_access_code_error: true
4509
+ /** Date and time at which Seam created the error. */
4047
4510
  created_at?: string | undefined
4048
4511
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4049
4512
  error_code: 'igloohome_offline_access_code_no_variance_available'
4050
4513
  }
4051
4514
  | {
4515
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4052
4516
  message: string
4517
+ /** Indicates that this is an access code error. */
4053
4518
  is_access_code_error: true
4519
+ /** Date and time at which Seam created the error. */
4054
4520
  created_at?: string | undefined
4055
4521
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4056
4522
  error_code: 'kwikset_unable_to_confirm_code'
4057
4523
  }
4058
4524
  | {
4525
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4059
4526
  message: string
4527
+ /** Indicates that this is an access code error. */
4060
4528
  is_access_code_error: true
4529
+ /** Date and time at which Seam created the error. */
4061
4530
  created_at?: string | undefined
4062
4531
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4063
4532
  error_code: 'kwikset_unable_to_confirm_deletion'
4064
4533
  }
4065
4534
  | {
4535
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4066
4536
  message: string
4537
+ /** Indicates that this is an access code error. */
4067
4538
  is_access_code_error: true
4539
+ /** Date and time at which Seam created the error. */
4068
4540
  created_at?: string | undefined
4069
4541
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4070
4542
  error_code: 'code_modified_external_to_seam'
4071
4543
  }
4072
4544
  | {
4545
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4073
4546
  message: string
4547
+ /** Indicates that this is an access code error. */
4074
4548
  is_access_code_error: true
4549
+ /** Date and time at which Seam created the error. */
4075
4550
  created_at?: string | undefined
4076
4551
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4077
4552
  error_code: 'august_lock_invalid_code_length'
4078
4553
  }
4079
4554
  | {
4555
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4080
4556
  message: string
4557
+ /** Indicates that this is an access code error. */
4081
4558
  is_access_code_error: true
4559
+ /** Date and time at which Seam created the error. */
4082
4560
  created_at?: string | undefined
4083
4561
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4084
4562
  error_code: 'august_device_programming_delay'
4085
4563
  }
4086
4564
  | {
4565
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4087
4566
  message: string
4567
+ /** Indicates that this is an access code error. */
4088
4568
  is_access_code_error: true
4569
+ /** Date and time at which Seam created the error. */
4089
4570
  created_at?: string | undefined
4090
4571
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4091
4572
  error_code: 'august_device_slots_full'
4092
4573
  }
4093
4574
  | {
4575
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4094
4576
  message: string
4577
+ /** Indicates that this is an access code error. */
4095
4578
  is_access_code_error: true
4579
+ /** Date and time at which Seam created the error. */
4096
4580
  created_at?: string | undefined
4097
4581
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4098
4582
  error_code: 'august_lock_missing_keypad'
4099
4583
  }
4100
4584
  | {
4585
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4101
4586
  message: string
4587
+ /** Indicates that this is an access code error. */
4102
4588
  is_access_code_error: true
4589
+ /** Date and time at which Seam created the error. */
4103
4590
  created_at?: string | undefined
4104
4591
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4105
4592
  error_code: 'august_lock_temporarily_offline'
4106
4593
  }
4107
4594
  | {
4595
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4108
4596
  message: string
4597
+ /** Indicates that this is an access code error. */
4109
4598
  is_access_code_error: true
4599
+ /** Date and time at which Seam created the error. */
4110
4600
  created_at?: string | undefined
4111
4601
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4112
4602
  error_code: 'salto_ks_user_not_subscribed'
4113
4603
  }
4114
4604
  | {
4605
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4115
4606
  message: string
4607
+ /** Indicates that this is an access code error. */
4116
4608
  is_access_code_error: true
4609
+ /** Date and time at which Seam created the error. */
4117
4610
  created_at?: string | undefined
4118
4611
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4119
4612
  error_code: 'hubitat_device_programming_delay'
4120
4613
  }
4121
4614
  | {
4615
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4122
4616
  message: string
4617
+ /** Indicates that this is an access code error. */
4123
4618
  is_access_code_error: true
4619
+ /** Date and time at which Seam created the error. */
4124
4620
  created_at?: string | undefined
4125
4621
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4126
4622
  error_code: 'hubitat_no_free_positions_available'
4127
4623
  }
4128
4624
  | {
4625
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4129
4626
  message: string
4627
+ /** Indicates that this is an access code error. */
4130
4628
  is_access_code_error: true
4629
+ /** Date and time at which Seam created the error. */
4131
4630
  created_at?: string | undefined
4132
4631
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4133
4632
  error_code: 'wyze_duplicate_code_name'
4134
4633
  }
4135
4634
  | {
4635
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4136
4636
  message: string
4637
+ /** Indicates that this is an access code error. */
4137
4638
  is_access_code_error: true
4639
+ /** Date and time at which Seam created the error. */
4138
4640
  created_at?: string | undefined
4139
4641
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4140
4642
  error_code: 'wyze_potential_duplicate_code'
4141
4643
  }
4142
4644
  | {
4645
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4143
4646
  message: string
4647
+ /** Indicates that this is an access code error. */
4144
4648
  is_access_code_error: true
4649
+ /** Date and time at which Seam created the error. */
4145
4650
  created_at?: string | undefined
4146
4651
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4147
4652
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -4258,76 +4763,100 @@ export interface Routes {
4258
4763
  error_code: 'bridge_disconnected'
4259
4764
  }
4260
4765
  >
4261
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
4766
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
4262
4767
  warnings: Array<
4263
4768
  | {
4769
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4264
4770
  message: string
4771
+ /** Date and time at which Seam created the warning. */
4265
4772
  created_at?: string | undefined
4266
4773
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4267
4774
  warning_code: 'smartthings_failed_to_set_access_code'
4268
4775
  }
4269
4776
  | {
4777
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4270
4778
  message: string
4779
+ /** Date and time at which Seam created the warning. */
4271
4780
  created_at?: string | undefined
4272
4781
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4273
4782
  warning_code: 'schlage_detected_duplicate'
4274
4783
  }
4275
4784
  | {
4785
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4276
4786
  message: string
4787
+ /** Date and time at which Seam created the warning. */
4277
4788
  created_at?: string | undefined
4278
4789
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4279
4790
  warning_code: 'schlage_creation_outage'
4280
4791
  }
4281
4792
  | {
4793
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4282
4794
  message: string
4795
+ /** Date and time at which Seam created the warning. */
4283
4796
  created_at?: string | undefined
4284
4797
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4285
4798
  warning_code: 'code_modified_external_to_seam'
4286
4799
  }
4287
4800
  | {
4801
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4288
4802
  message: string
4803
+ /** Date and time at which Seam created the warning. */
4289
4804
  created_at?: string | undefined
4290
4805
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4291
4806
  warning_code: 'delay_in_setting_on_device'
4292
4807
  }
4293
4808
  | {
4809
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4294
4810
  message: string
4811
+ /** Date and time at which Seam created the warning. */
4295
4812
  created_at?: string | undefined
4296
4813
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4297
4814
  warning_code: 'delay_in_removing_from_device'
4298
4815
  }
4299
4816
  | {
4817
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4300
4818
  message: string
4819
+ /** Date and time at which Seam created the warning. */
4301
4820
  created_at?: string | undefined
4302
4821
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4303
4822
  warning_code: 'third_party_integration_detected'
4304
4823
  }
4305
4824
  | {
4825
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4306
4826
  message: string
4827
+ /** Date and time at which Seam created the warning. */
4307
4828
  created_at?: string | undefined
4308
4829
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4309
4830
  warning_code: 'august_device_programming_delay'
4310
4831
  }
4311
4832
  | {
4833
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4312
4834
  message: string
4835
+ /** Date and time at which Seam created the warning. */
4313
4836
  created_at?: string | undefined
4314
4837
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4315
4838
  warning_code: 'august_lock_temporarily_offline'
4316
4839
  }
4317
4840
  | {
4841
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4318
4842
  message: string
4843
+ /** Date and time at which Seam created the warning. */
4319
4844
  created_at?: string | undefined
4320
4845
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4321
4846
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
4322
4847
  }
4323
4848
  | {
4849
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4324
4850
  message: string
4851
+ /** Date and time at which Seam created the warning. */
4325
4852
  created_at?: string | undefined
4326
4853
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4327
4854
  warning_code: 'management_transferred'
4328
4855
  }
4329
4856
  | {
4857
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4330
4858
  message: string
4859
+ /** Date and time at which Seam created the warning. */
4331
4860
  created_at?: string | undefined
4332
4861
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4333
4862
  warning_code: 'kwikset_unable_to_confirm_code'
@@ -4339,9 +4868,7 @@ export interface Routes {
4339
4868
  starts_at?: (string | null) | undefined
4340
4869
  /** Date and time after which the time-bound access code becomes inactive. */
4341
4870
  ends_at?: (string | null) | undefined
4342
- /**
4343
- 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.
4344
- */
4871
+ /** 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. */
4345
4872
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
4346
4873
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
4347
4874
  is_backup_access_code_available: boolean
@@ -4351,18 +4878,24 @@ export interface Routes {
4351
4878
  pulled_backup_access_code_id?: (string | null) | undefined
4352
4879
  /** Indicates whether changes to the access code from external sources are permitted. */
4353
4880
  is_external_modification_allowed: boolean
4354
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
4881
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
4355
4882
  is_one_time_use: boolean
4356
- /** 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. */
4883
+ /** 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. */
4357
4884
  is_offline_access_code: boolean
4358
4885
  }
4359
- /** */
4886
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
4887
+
4888
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
4889
+
4890
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
4891
+
4892
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
4360
4893
  access_code: {
4361
4894
  /** Unique identifier for a group of access codes that share the same code. */
4362
4895
  common_code_key: string | null
4363
4896
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
4364
4897
  is_scheduled_on_device?: boolean | undefined
4365
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
4898
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
4366
4899
  type: 'time_bound' | 'ongoing'
4367
4900
  /** Indicates whether the access code is waiting for a code assignment. */
4368
4901
  is_waiting_for_code_assignment?: boolean | undefined
@@ -4376,172 +4909,244 @@ export interface Routes {
4376
4909
  code: string | null
4377
4910
  /** Date and time at which the access code was created. */
4378
4911
  created_at: string
4379
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
4912
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
4380
4913
  errors: Array<
4381
4914
  | {
4915
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4382
4916
  message: string
4917
+ /** Indicates that this is an access code error. */
4383
4918
  is_access_code_error: true
4919
+ /** Date and time at which Seam created the error. */
4384
4920
  created_at?: string | undefined
4385
4921
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4386
4922
  error_code: 'smartthings_failed_to_set_access_code'
4387
4923
  }
4388
4924
  | {
4925
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4389
4926
  message: string
4927
+ /** Indicates that this is an access code error. */
4390
4928
  is_access_code_error: true
4929
+ /** Date and time at which Seam created the error. */
4391
4930
  created_at?: string | undefined
4392
4931
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4393
4932
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
4394
4933
  }
4395
4934
  | {
4935
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4396
4936
  message: string
4937
+ /** Indicates that this is an access code error. */
4397
4938
  is_access_code_error: true
4939
+ /** Date and time at which Seam created the error. */
4398
4940
  created_at?: string | undefined
4399
4941
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4400
4942
  error_code: 'smartthings_no_free_slots_available'
4401
4943
  }
4402
4944
  | {
4945
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4403
4946
  message: string
4947
+ /** Indicates that this is an access code error. */
4404
4948
  is_access_code_error: true
4949
+ /** Date and time at which Seam created the error. */
4405
4950
  created_at?: string | undefined
4406
4951
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4407
4952
  error_code: 'failed_to_set_on_device'
4408
4953
  }
4409
4954
  | {
4955
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4410
4956
  message: string
4957
+ /** Indicates that this is an access code error. */
4411
4958
  is_access_code_error: true
4959
+ /** Date and time at which Seam created the error. */
4412
4960
  created_at?: string | undefined
4413
4961
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4414
4962
  error_code: 'failed_to_remove_from_device'
4415
4963
  }
4416
4964
  | {
4965
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4417
4966
  message: string
4967
+ /** Indicates that this is an access code error. */
4418
4968
  is_access_code_error: true
4969
+ /** Date and time at which Seam created the error. */
4419
4970
  created_at?: string | undefined
4420
4971
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4421
4972
  error_code: 'duplicate_code_on_device'
4422
4973
  }
4423
4974
  | {
4975
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4424
4976
  message: string
4977
+ /** Indicates that this is an access code error. */
4425
4978
  is_access_code_error: true
4979
+ /** Date and time at which Seam created the error. */
4426
4980
  created_at?: string | undefined
4427
4981
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4428
4982
  error_code: 'duplicate_code_attempt_prevented'
4429
4983
  }
4430
4984
  | {
4985
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4431
4986
  message: string
4987
+ /** Indicates that this is an access code error. */
4432
4988
  is_access_code_error: true
4989
+ /** Date and time at which Seam created the error. */
4433
4990
  created_at?: string | undefined
4434
4991
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4435
4992
  error_code: 'igloohome_bridge_too_many_pending_jobs'
4436
4993
  }
4437
4994
  | {
4995
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4438
4996
  message: string
4997
+ /** Indicates that this is an access code error. */
4439
4998
  is_access_code_error: true
4999
+ /** Date and time at which Seam created the error. */
4440
5000
  created_at?: string | undefined
4441
5001
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4442
5002
  error_code: 'igloohome_bridge_offline'
4443
5003
  }
4444
5004
  | {
5005
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4445
5006
  message: string
5007
+ /** Indicates that this is an access code error. */
4446
5008
  is_access_code_error: true
5009
+ /** Date and time at which Seam created the error. */
4447
5010
  created_at?: string | undefined
4448
5011
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4449
5012
  error_code: 'igloohome_offline_access_code_no_variance_available'
4450
5013
  }
4451
5014
  | {
5015
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4452
5016
  message: string
5017
+ /** Indicates that this is an access code error. */
4453
5018
  is_access_code_error: true
5019
+ /** Date and time at which Seam created the error. */
4454
5020
  created_at?: string | undefined
4455
5021
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4456
5022
  error_code: 'kwikset_unable_to_confirm_code'
4457
5023
  }
4458
5024
  | {
5025
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4459
5026
  message: string
5027
+ /** Indicates that this is an access code error. */
4460
5028
  is_access_code_error: true
5029
+ /** Date and time at which Seam created the error. */
4461
5030
  created_at?: string | undefined
4462
5031
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4463
5032
  error_code: 'kwikset_unable_to_confirm_deletion'
4464
5033
  }
4465
5034
  | {
5035
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4466
5036
  message: string
5037
+ /** Indicates that this is an access code error. */
4467
5038
  is_access_code_error: true
5039
+ /** Date and time at which Seam created the error. */
4468
5040
  created_at?: string | undefined
4469
5041
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4470
5042
  error_code: 'code_modified_external_to_seam'
4471
5043
  }
4472
5044
  | {
5045
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4473
5046
  message: string
5047
+ /** Indicates that this is an access code error. */
4474
5048
  is_access_code_error: true
5049
+ /** Date and time at which Seam created the error. */
4475
5050
  created_at?: string | undefined
4476
5051
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4477
5052
  error_code: 'august_lock_invalid_code_length'
4478
5053
  }
4479
5054
  | {
5055
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4480
5056
  message: string
5057
+ /** Indicates that this is an access code error. */
4481
5058
  is_access_code_error: true
5059
+ /** Date and time at which Seam created the error. */
4482
5060
  created_at?: string | undefined
4483
5061
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4484
5062
  error_code: 'august_device_programming_delay'
4485
5063
  }
4486
5064
  | {
5065
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4487
5066
  message: string
5067
+ /** Indicates that this is an access code error. */
4488
5068
  is_access_code_error: true
5069
+ /** Date and time at which Seam created the error. */
4489
5070
  created_at?: string | undefined
4490
5071
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4491
5072
  error_code: 'august_device_slots_full'
4492
5073
  }
4493
5074
  | {
5075
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4494
5076
  message: string
5077
+ /** Indicates that this is an access code error. */
4495
5078
  is_access_code_error: true
5079
+ /** Date and time at which Seam created the error. */
4496
5080
  created_at?: string | undefined
4497
5081
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4498
5082
  error_code: 'august_lock_missing_keypad'
4499
5083
  }
4500
5084
  | {
5085
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4501
5086
  message: string
5087
+ /** Indicates that this is an access code error. */
4502
5088
  is_access_code_error: true
5089
+ /** Date and time at which Seam created the error. */
4503
5090
  created_at?: string | undefined
4504
5091
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4505
5092
  error_code: 'august_lock_temporarily_offline'
4506
5093
  }
4507
5094
  | {
5095
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4508
5096
  message: string
5097
+ /** Indicates that this is an access code error. */
4509
5098
  is_access_code_error: true
5099
+ /** Date and time at which Seam created the error. */
4510
5100
  created_at?: string | undefined
4511
5101
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4512
5102
  error_code: 'salto_ks_user_not_subscribed'
4513
5103
  }
4514
5104
  | {
5105
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4515
5106
  message: string
5107
+ /** Indicates that this is an access code error. */
4516
5108
  is_access_code_error: true
5109
+ /** Date and time at which Seam created the error. */
4517
5110
  created_at?: string | undefined
4518
5111
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4519
5112
  error_code: 'hubitat_device_programming_delay'
4520
5113
  }
4521
5114
  | {
5115
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4522
5116
  message: string
5117
+ /** Indicates that this is an access code error. */
4523
5118
  is_access_code_error: true
5119
+ /** Date and time at which Seam created the error. */
4524
5120
  created_at?: string | undefined
4525
5121
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4526
5122
  error_code: 'hubitat_no_free_positions_available'
4527
5123
  }
4528
5124
  | {
5125
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4529
5126
  message: string
5127
+ /** Indicates that this is an access code error. */
4530
5128
  is_access_code_error: true
5129
+ /** Date and time at which Seam created the error. */
4531
5130
  created_at?: string | undefined
4532
5131
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4533
5132
  error_code: 'wyze_duplicate_code_name'
4534
5133
  }
4535
5134
  | {
5135
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4536
5136
  message: string
5137
+ /** Indicates that this is an access code error. */
4537
5138
  is_access_code_error: true
5139
+ /** Date and time at which Seam created the error. */
4538
5140
  created_at?: string | undefined
4539
5141
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4540
5142
  error_code: 'wyze_potential_duplicate_code'
4541
5143
  }
4542
5144
  | {
5145
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4543
5146
  message: string
5147
+ /** Indicates that this is an access code error. */
4544
5148
  is_access_code_error: true
5149
+ /** Date and time at which Seam created the error. */
4545
5150
  created_at?: string | undefined
4546
5151
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4547
5152
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -4658,76 +5263,100 @@ export interface Routes {
4658
5263
  error_code: 'bridge_disconnected'
4659
5264
  }
4660
5265
  >
4661
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
5266
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
4662
5267
  warnings: Array<
4663
5268
  | {
5269
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4664
5270
  message: string
5271
+ /** Date and time at which Seam created the warning. */
4665
5272
  created_at?: string | undefined
4666
5273
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4667
5274
  warning_code: 'smartthings_failed_to_set_access_code'
4668
5275
  }
4669
5276
  | {
5277
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4670
5278
  message: string
5279
+ /** Date and time at which Seam created the warning. */
4671
5280
  created_at?: string | undefined
4672
5281
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4673
5282
  warning_code: 'schlage_detected_duplicate'
4674
5283
  }
4675
5284
  | {
5285
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4676
5286
  message: string
5287
+ /** Date and time at which Seam created the warning. */
4677
5288
  created_at?: string | undefined
4678
5289
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4679
5290
  warning_code: 'schlage_creation_outage'
4680
5291
  }
4681
5292
  | {
5293
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4682
5294
  message: string
5295
+ /** Date and time at which Seam created the warning. */
4683
5296
  created_at?: string | undefined
4684
5297
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4685
5298
  warning_code: 'code_modified_external_to_seam'
4686
5299
  }
4687
5300
  | {
5301
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4688
5302
  message: string
5303
+ /** Date and time at which Seam created the warning. */
4689
5304
  created_at?: string | undefined
4690
5305
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4691
5306
  warning_code: 'delay_in_setting_on_device'
4692
5307
  }
4693
5308
  | {
5309
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4694
5310
  message: string
5311
+ /** Date and time at which Seam created the warning. */
4695
5312
  created_at?: string | undefined
4696
5313
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4697
5314
  warning_code: 'delay_in_removing_from_device'
4698
5315
  }
4699
5316
  | {
5317
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4700
5318
  message: string
5319
+ /** Date and time at which Seam created the warning. */
4701
5320
  created_at?: string | undefined
4702
5321
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4703
5322
  warning_code: 'third_party_integration_detected'
4704
5323
  }
4705
5324
  | {
5325
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4706
5326
  message: string
5327
+ /** Date and time at which Seam created the warning. */
4707
5328
  created_at?: string | undefined
4708
5329
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4709
5330
  warning_code: 'august_device_programming_delay'
4710
5331
  }
4711
5332
  | {
5333
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4712
5334
  message: string
5335
+ /** Date and time at which Seam created the warning. */
4713
5336
  created_at?: string | undefined
4714
5337
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4715
5338
  warning_code: 'august_lock_temporarily_offline'
4716
5339
  }
4717
5340
  | {
5341
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4718
5342
  message: string
5343
+ /** Date and time at which Seam created the warning. */
4719
5344
  created_at?: string | undefined
4720
5345
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4721
5346
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
4722
5347
  }
4723
5348
  | {
5349
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4724
5350
  message: string
5351
+ /** Date and time at which Seam created the warning. */
4725
5352
  created_at?: string | undefined
4726
5353
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4727
5354
  warning_code: 'management_transferred'
4728
5355
  }
4729
5356
  | {
5357
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4730
5358
  message: string
5359
+ /** Date and time at which Seam created the warning. */
4731
5360
  created_at?: string | undefined
4732
5361
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4733
5362
  warning_code: 'kwikset_unable_to_confirm_code'
@@ -4739,9 +5368,7 @@ export interface Routes {
4739
5368
  starts_at?: (string | null) | undefined
4740
5369
  /** Date and time after which the time-bound access code becomes inactive. */
4741
5370
  ends_at?: (string | null) | undefined
4742
- /**
4743
- 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.
4744
- */
5371
+ /** 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. */
4745
5372
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
4746
5373
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
4747
5374
  is_backup_access_code_available: boolean
@@ -4751,9 +5378,9 @@ export interface Routes {
4751
5378
  pulled_backup_access_code_id?: (string | null) | undefined
4752
5379
  /** Indicates whether changes to the access code from external sources are permitted. */
4753
5380
  is_external_modification_allowed: boolean
4754
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
5381
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
4755
5382
  is_one_time_use: boolean
4756
- /** 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. */
5383
+ /** 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. */
4757
5384
  is_offline_access_code: boolean
4758
5385
  }
4759
5386
  }
@@ -4763,16 +5390,25 @@ export interface Routes {
4763
5390
  method: 'POST'
4764
5391
  queryParams: {}
4765
5392
  jsonBody: {
5393
+ /** ID of the device for which you want to simulate the creation of an unmanaged access code. */
4766
5394
  device_id: string
5395
+ /** Name of the simulated unmanaged access code. */
4767
5396
  name: string
5397
+ /** Code of the simulated unmanaged access code. */
4768
5398
  code: string
4769
5399
  }
4770
5400
  commonParams: {}
4771
5401
  formData: {}
4772
5402
  jsonResponse: {
4773
- /** */
5403
+ /** Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
5404
+
5405
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
5406
+
5407
+ When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
5408
+
5409
+ Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
4774
5410
  access_code: {
4775
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
5411
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
4776
5412
  type: 'time_bound' | 'ongoing'
4777
5413
  /** Unique identifier for the access code. */
4778
5414
  access_code_id: string
@@ -4784,172 +5420,244 @@ export interface Routes {
4784
5420
  code: string | null
4785
5421
  /** Date and time at which the access code was created. */
4786
5422
  created_at: string
4787
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
5423
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
4788
5424
  errors: Array<
4789
5425
  | {
5426
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4790
5427
  message: string
5428
+ /** Indicates that this is an access code error. */
4791
5429
  is_access_code_error: true
5430
+ /** Date and time at which Seam created the error. */
4792
5431
  created_at?: string | undefined
4793
5432
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4794
5433
  error_code: 'smartthings_failed_to_set_access_code'
4795
5434
  }
4796
5435
  | {
5436
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4797
5437
  message: string
5438
+ /** Indicates that this is an access code error. */
4798
5439
  is_access_code_error: true
5440
+ /** Date and time at which Seam created the error. */
4799
5441
  created_at?: string | undefined
4800
5442
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4801
5443
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
4802
5444
  }
4803
5445
  | {
5446
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4804
5447
  message: string
5448
+ /** Indicates that this is an access code error. */
4805
5449
  is_access_code_error: true
5450
+ /** Date and time at which Seam created the error. */
4806
5451
  created_at?: string | undefined
4807
5452
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4808
5453
  error_code: 'smartthings_no_free_slots_available'
4809
5454
  }
4810
5455
  | {
5456
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4811
5457
  message: string
5458
+ /** Indicates that this is an access code error. */
4812
5459
  is_access_code_error: true
5460
+ /** Date and time at which Seam created the error. */
4813
5461
  created_at?: string | undefined
4814
5462
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4815
5463
  error_code: 'failed_to_set_on_device'
4816
5464
  }
4817
5465
  | {
5466
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4818
5467
  message: string
5468
+ /** Indicates that this is an access code error. */
4819
5469
  is_access_code_error: true
5470
+ /** Date and time at which Seam created the error. */
4820
5471
  created_at?: string | undefined
4821
5472
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4822
5473
  error_code: 'failed_to_remove_from_device'
4823
5474
  }
4824
5475
  | {
5476
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4825
5477
  message: string
5478
+ /** Indicates that this is an access code error. */
4826
5479
  is_access_code_error: true
5480
+ /** Date and time at which Seam created the error. */
4827
5481
  created_at?: string | undefined
4828
5482
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4829
5483
  error_code: 'duplicate_code_on_device'
4830
5484
  }
4831
5485
  | {
5486
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4832
5487
  message: string
5488
+ /** Indicates that this is an access code error. */
4833
5489
  is_access_code_error: true
5490
+ /** Date and time at which Seam created the error. */
4834
5491
  created_at?: string | undefined
4835
5492
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4836
5493
  error_code: 'duplicate_code_attempt_prevented'
4837
5494
  }
4838
5495
  | {
5496
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4839
5497
  message: string
5498
+ /** Indicates that this is an access code error. */
4840
5499
  is_access_code_error: true
5500
+ /** Date and time at which Seam created the error. */
4841
5501
  created_at?: string | undefined
4842
5502
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4843
5503
  error_code: 'igloohome_bridge_too_many_pending_jobs'
4844
5504
  }
4845
5505
  | {
5506
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4846
5507
  message: string
5508
+ /** Indicates that this is an access code error. */
4847
5509
  is_access_code_error: true
5510
+ /** Date and time at which Seam created the error. */
4848
5511
  created_at?: string | undefined
4849
5512
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4850
5513
  error_code: 'igloohome_bridge_offline'
4851
5514
  }
4852
5515
  | {
5516
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4853
5517
  message: string
5518
+ /** Indicates that this is an access code error. */
4854
5519
  is_access_code_error: true
5520
+ /** Date and time at which Seam created the error. */
4855
5521
  created_at?: string | undefined
4856
5522
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4857
5523
  error_code: 'igloohome_offline_access_code_no_variance_available'
4858
5524
  }
4859
5525
  | {
5526
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4860
5527
  message: string
5528
+ /** Indicates that this is an access code error. */
4861
5529
  is_access_code_error: true
5530
+ /** Date and time at which Seam created the error. */
4862
5531
  created_at?: string | undefined
4863
5532
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4864
5533
  error_code: 'kwikset_unable_to_confirm_code'
4865
5534
  }
4866
5535
  | {
5536
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4867
5537
  message: string
5538
+ /** Indicates that this is an access code error. */
4868
5539
  is_access_code_error: true
5540
+ /** Date and time at which Seam created the error. */
4869
5541
  created_at?: string | undefined
4870
5542
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4871
5543
  error_code: 'kwikset_unable_to_confirm_deletion'
4872
5544
  }
4873
5545
  | {
5546
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4874
5547
  message: string
5548
+ /** Indicates that this is an access code error. */
4875
5549
  is_access_code_error: true
5550
+ /** Date and time at which Seam created the error. */
4876
5551
  created_at?: string | undefined
4877
5552
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4878
5553
  error_code: 'code_modified_external_to_seam'
4879
5554
  }
4880
5555
  | {
5556
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4881
5557
  message: string
5558
+ /** Indicates that this is an access code error. */
4882
5559
  is_access_code_error: true
5560
+ /** Date and time at which Seam created the error. */
4883
5561
  created_at?: string | undefined
4884
5562
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4885
5563
  error_code: 'august_lock_invalid_code_length'
4886
5564
  }
4887
5565
  | {
5566
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4888
5567
  message: string
5568
+ /** Indicates that this is an access code error. */
4889
5569
  is_access_code_error: true
5570
+ /** Date and time at which Seam created the error. */
4890
5571
  created_at?: string | undefined
4891
5572
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4892
5573
  error_code: 'august_device_programming_delay'
4893
5574
  }
4894
5575
  | {
5576
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4895
5577
  message: string
5578
+ /** Indicates that this is an access code error. */
4896
5579
  is_access_code_error: true
5580
+ /** Date and time at which Seam created the error. */
4897
5581
  created_at?: string | undefined
4898
5582
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4899
5583
  error_code: 'august_device_slots_full'
4900
5584
  }
4901
5585
  | {
5586
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4902
5587
  message: string
5588
+ /** Indicates that this is an access code error. */
4903
5589
  is_access_code_error: true
5590
+ /** Date and time at which Seam created the error. */
4904
5591
  created_at?: string | undefined
4905
5592
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4906
5593
  error_code: 'august_lock_missing_keypad'
4907
5594
  }
4908
5595
  | {
5596
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4909
5597
  message: string
5598
+ /** Indicates that this is an access code error. */
4910
5599
  is_access_code_error: true
5600
+ /** Date and time at which Seam created the error. */
4911
5601
  created_at?: string | undefined
4912
5602
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4913
5603
  error_code: 'august_lock_temporarily_offline'
4914
5604
  }
4915
5605
  | {
5606
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4916
5607
  message: string
5608
+ /** Indicates that this is an access code error. */
4917
5609
  is_access_code_error: true
5610
+ /** Date and time at which Seam created the error. */
4918
5611
  created_at?: string | undefined
4919
5612
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4920
5613
  error_code: 'salto_ks_user_not_subscribed'
4921
5614
  }
4922
5615
  | {
5616
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4923
5617
  message: string
5618
+ /** Indicates that this is an access code error. */
4924
5619
  is_access_code_error: true
5620
+ /** Date and time at which Seam created the error. */
4925
5621
  created_at?: string | undefined
4926
5622
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4927
5623
  error_code: 'hubitat_device_programming_delay'
4928
5624
  }
4929
5625
  | {
5626
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4930
5627
  message: string
5628
+ /** Indicates that this is an access code error. */
4931
5629
  is_access_code_error: true
5630
+ /** Date and time at which Seam created the error. */
4932
5631
  created_at?: string | undefined
4933
5632
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4934
5633
  error_code: 'hubitat_no_free_positions_available'
4935
5634
  }
4936
5635
  | {
5636
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4937
5637
  message: string
5638
+ /** Indicates that this is an access code error. */
4938
5639
  is_access_code_error: true
5640
+ /** Date and time at which Seam created the error. */
4939
5641
  created_at?: string | undefined
4940
5642
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4941
5643
  error_code: 'wyze_duplicate_code_name'
4942
5644
  }
4943
5645
  | {
5646
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4944
5647
  message: string
5648
+ /** Indicates that this is an access code error. */
4945
5649
  is_access_code_error: true
5650
+ /** Date and time at which Seam created the error. */
4946
5651
  created_at?: string | undefined
4947
5652
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4948
5653
  error_code: 'wyze_potential_duplicate_code'
4949
5654
  }
4950
5655
  | {
5656
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4951
5657
  message: string
5658
+ /** Indicates that this is an access code error. */
4952
5659
  is_access_code_error: true
5660
+ /** Date and time at which Seam created the error. */
4953
5661
  created_at?: string | undefined
4954
5662
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4955
5663
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -5066,86 +5774,112 @@ export interface Routes {
5066
5774
  error_code: 'bridge_disconnected'
5067
5775
  }
5068
5776
  >
5069
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
5777
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
5070
5778
  warnings: Array<
5071
5779
  | {
5780
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5072
5781
  message: string
5782
+ /** Date and time at which Seam created the warning. */
5073
5783
  created_at?: string | undefined
5074
5784
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5075
5785
  warning_code: 'smartthings_failed_to_set_access_code'
5076
5786
  }
5077
5787
  | {
5788
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5078
5789
  message: string
5790
+ /** Date and time at which Seam created the warning. */
5079
5791
  created_at?: string | undefined
5080
5792
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5081
5793
  warning_code: 'schlage_detected_duplicate'
5082
5794
  }
5083
5795
  | {
5796
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5084
5797
  message: string
5798
+ /** Date and time at which Seam created the warning. */
5085
5799
  created_at?: string | undefined
5086
5800
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5087
5801
  warning_code: 'schlage_creation_outage'
5088
5802
  }
5089
5803
  | {
5804
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5090
5805
  message: string
5806
+ /** Date and time at which Seam created the warning. */
5091
5807
  created_at?: string | undefined
5092
5808
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5093
5809
  warning_code: 'code_modified_external_to_seam'
5094
5810
  }
5095
5811
  | {
5812
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5096
5813
  message: string
5814
+ /** Date and time at which Seam created the warning. */
5097
5815
  created_at?: string | undefined
5098
5816
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5099
5817
  warning_code: 'delay_in_setting_on_device'
5100
5818
  }
5101
5819
  | {
5820
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5102
5821
  message: string
5822
+ /** Date and time at which Seam created the warning. */
5103
5823
  created_at?: string | undefined
5104
5824
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5105
5825
  warning_code: 'delay_in_removing_from_device'
5106
5826
  }
5107
5827
  | {
5828
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5108
5829
  message: string
5830
+ /** Date and time at which Seam created the warning. */
5109
5831
  created_at?: string | undefined
5110
5832
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5111
5833
  warning_code: 'third_party_integration_detected'
5112
5834
  }
5113
5835
  | {
5836
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5114
5837
  message: string
5838
+ /** Date and time at which Seam created the warning. */
5115
5839
  created_at?: string | undefined
5116
5840
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5117
5841
  warning_code: 'august_device_programming_delay'
5118
5842
  }
5119
5843
  | {
5844
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5120
5845
  message: string
5846
+ /** Date and time at which Seam created the warning. */
5121
5847
  created_at?: string | undefined
5122
5848
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5123
5849
  warning_code: 'august_lock_temporarily_offline'
5124
5850
  }
5125
5851
  | {
5852
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5126
5853
  message: string
5854
+ /** Date and time at which Seam created the warning. */
5127
5855
  created_at?: string | undefined
5128
5856
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5129
5857
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
5130
5858
  }
5131
5859
  | {
5860
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5132
5861
  message: string
5862
+ /** Date and time at which Seam created the warning. */
5133
5863
  created_at?: string | undefined
5134
5864
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5135
5865
  warning_code: 'management_transferred'
5136
5866
  }
5137
5867
  | {
5868
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5138
5869
  message: string
5870
+ /** Date and time at which Seam created the warning. */
5139
5871
  created_at?: string | undefined
5140
5872
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5141
5873
  warning_code: 'kwikset_unable_to_confirm_code'
5142
5874
  }
5143
5875
  >
5876
+ /** Indicates that Seam does not manage the access code. */
5144
5877
  is_managed: false
5145
5878
  /** Date and time at which the time-bound access code becomes active. */
5146
5879
  starts_at?: (string | null) | undefined
5147
5880
  /** Date and time after which the time-bound access code becomes inactive. */
5148
5881
  ends_at?: (string | null) | undefined
5882
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
5149
5883
  status: 'set'
5150
5884
  }
5151
5885
  }
@@ -5156,10 +5890,15 @@ export interface Routes {
5156
5890
  queryParams: {}
5157
5891
  jsonBody: {}
5158
5892
  commonParams: {
5893
+ /** ID of the unmanaged access code that you want to convert to a managed access code. */
5159
5894
  access_code_id: string
5895
+ /** Indicates whether external modification of the access code is allowed. */
5160
5896
  is_external_modification_allowed?: boolean | undefined
5897
+ /** Indicates whether external modification of the access code is allowed. */
5161
5898
  allow_external_modification?: boolean | undefined
5899
+ /** Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. */
5162
5900
  force?: boolean | undefined
5901
+ /** */
5163
5902
  sync?: boolean
5164
5903
  }
5165
5904
  formData: {}
@@ -5171,7 +5910,9 @@ export interface Routes {
5171
5910
  queryParams: {}
5172
5911
  jsonBody: {}
5173
5912
  commonParams: {
5913
+ /** ID of the unmanaged access code to delete. */
5174
5914
  access_code_id: string
5915
+ /** */
5175
5916
  sync?: boolean
5176
5917
  }
5177
5918
  formData: {}
@@ -6302,15 +7043,24 @@ export interface Routes {
6302
7043
  queryParams: {}
6303
7044
  jsonBody: {}
6304
7045
  commonParams: {
7046
+ /** ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
6305
7047
  device_id?: string | undefined
7048
+ /** ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
6306
7049
  access_code_id?: string | undefined
7050
+ /** Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
6307
7051
  code?: string | undefined
6308
7052
  }
6309
7053
  formData: {}
6310
7054
  jsonResponse: {
6311
- /** */
7055
+ /** Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
7056
+
7057
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
7058
+
7059
+ When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
7060
+
7061
+ Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
6312
7062
  access_code: {
6313
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
7063
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
6314
7064
  type: 'time_bound' | 'ongoing'
6315
7065
  /** Unique identifier for the access code. */
6316
7066
  access_code_id: string
@@ -6322,172 +7072,244 @@ export interface Routes {
6322
7072
  code: string | null
6323
7073
  /** Date and time at which the access code was created. */
6324
7074
  created_at: string
6325
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7075
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
6326
7076
  errors: Array<
6327
7077
  | {
7078
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6328
7079
  message: string
7080
+ /** Indicates that this is an access code error. */
6329
7081
  is_access_code_error: true
7082
+ /** Date and time at which Seam created the error. */
6330
7083
  created_at?: string | undefined
6331
7084
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6332
7085
  error_code: 'smartthings_failed_to_set_access_code'
6333
7086
  }
6334
7087
  | {
7088
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6335
7089
  message: string
7090
+ /** Indicates that this is an access code error. */
6336
7091
  is_access_code_error: true
7092
+ /** Date and time at which Seam created the error. */
6337
7093
  created_at?: string | undefined
6338
7094
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6339
7095
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
6340
7096
  }
6341
7097
  | {
7098
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6342
7099
  message: string
7100
+ /** Indicates that this is an access code error. */
6343
7101
  is_access_code_error: true
7102
+ /** Date and time at which Seam created the error. */
6344
7103
  created_at?: string | undefined
6345
7104
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6346
7105
  error_code: 'smartthings_no_free_slots_available'
6347
7106
  }
6348
7107
  | {
7108
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6349
7109
  message: string
7110
+ /** Indicates that this is an access code error. */
6350
7111
  is_access_code_error: true
7112
+ /** Date and time at which Seam created the error. */
6351
7113
  created_at?: string | undefined
6352
7114
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6353
7115
  error_code: 'failed_to_set_on_device'
6354
7116
  }
6355
7117
  | {
7118
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6356
7119
  message: string
7120
+ /** Indicates that this is an access code error. */
6357
7121
  is_access_code_error: true
7122
+ /** Date and time at which Seam created the error. */
6358
7123
  created_at?: string | undefined
6359
7124
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6360
7125
  error_code: 'failed_to_remove_from_device'
6361
7126
  }
6362
7127
  | {
7128
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6363
7129
  message: string
7130
+ /** Indicates that this is an access code error. */
6364
7131
  is_access_code_error: true
7132
+ /** Date and time at which Seam created the error. */
6365
7133
  created_at?: string | undefined
6366
7134
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6367
7135
  error_code: 'duplicate_code_on_device'
6368
7136
  }
6369
7137
  | {
7138
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6370
7139
  message: string
7140
+ /** Indicates that this is an access code error. */
6371
7141
  is_access_code_error: true
7142
+ /** Date and time at which Seam created the error. */
6372
7143
  created_at?: string | undefined
6373
7144
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6374
7145
  error_code: 'duplicate_code_attempt_prevented'
6375
7146
  }
6376
7147
  | {
7148
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6377
7149
  message: string
7150
+ /** Indicates that this is an access code error. */
6378
7151
  is_access_code_error: true
7152
+ /** Date and time at which Seam created the error. */
6379
7153
  created_at?: string | undefined
6380
7154
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6381
7155
  error_code: 'igloohome_bridge_too_many_pending_jobs'
6382
7156
  }
6383
7157
  | {
7158
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6384
7159
  message: string
7160
+ /** Indicates that this is an access code error. */
6385
7161
  is_access_code_error: true
7162
+ /** Date and time at which Seam created the error. */
6386
7163
  created_at?: string | undefined
6387
7164
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6388
7165
  error_code: 'igloohome_bridge_offline'
6389
7166
  }
6390
7167
  | {
7168
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6391
7169
  message: string
7170
+ /** Indicates that this is an access code error. */
6392
7171
  is_access_code_error: true
7172
+ /** Date and time at which Seam created the error. */
6393
7173
  created_at?: string | undefined
6394
7174
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6395
7175
  error_code: 'igloohome_offline_access_code_no_variance_available'
6396
7176
  }
6397
7177
  | {
7178
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6398
7179
  message: string
7180
+ /** Indicates that this is an access code error. */
6399
7181
  is_access_code_error: true
7182
+ /** Date and time at which Seam created the error. */
6400
7183
  created_at?: string | undefined
6401
7184
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6402
7185
  error_code: 'kwikset_unable_to_confirm_code'
6403
7186
  }
6404
7187
  | {
7188
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6405
7189
  message: string
7190
+ /** Indicates that this is an access code error. */
6406
7191
  is_access_code_error: true
7192
+ /** Date and time at which Seam created the error. */
6407
7193
  created_at?: string | undefined
6408
7194
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6409
7195
  error_code: 'kwikset_unable_to_confirm_deletion'
6410
7196
  }
6411
7197
  | {
7198
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6412
7199
  message: string
7200
+ /** Indicates that this is an access code error. */
6413
7201
  is_access_code_error: true
7202
+ /** Date and time at which Seam created the error. */
6414
7203
  created_at?: string | undefined
6415
7204
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6416
7205
  error_code: 'code_modified_external_to_seam'
6417
7206
  }
6418
7207
  | {
7208
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6419
7209
  message: string
7210
+ /** Indicates that this is an access code error. */
6420
7211
  is_access_code_error: true
7212
+ /** Date and time at which Seam created the error. */
6421
7213
  created_at?: string | undefined
6422
7214
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6423
7215
  error_code: 'august_lock_invalid_code_length'
6424
7216
  }
6425
7217
  | {
7218
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6426
7219
  message: string
7220
+ /** Indicates that this is an access code error. */
6427
7221
  is_access_code_error: true
7222
+ /** Date and time at which Seam created the error. */
6428
7223
  created_at?: string | undefined
6429
7224
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6430
7225
  error_code: 'august_device_programming_delay'
6431
7226
  }
6432
7227
  | {
7228
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6433
7229
  message: string
7230
+ /** Indicates that this is an access code error. */
6434
7231
  is_access_code_error: true
7232
+ /** Date and time at which Seam created the error. */
6435
7233
  created_at?: string | undefined
6436
7234
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6437
7235
  error_code: 'august_device_slots_full'
6438
7236
  }
6439
7237
  | {
7238
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6440
7239
  message: string
7240
+ /** Indicates that this is an access code error. */
6441
7241
  is_access_code_error: true
7242
+ /** Date and time at which Seam created the error. */
6442
7243
  created_at?: string | undefined
6443
7244
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6444
7245
  error_code: 'august_lock_missing_keypad'
6445
7246
  }
6446
7247
  | {
7248
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6447
7249
  message: string
7250
+ /** Indicates that this is an access code error. */
6448
7251
  is_access_code_error: true
7252
+ /** Date and time at which Seam created the error. */
6449
7253
  created_at?: string | undefined
6450
7254
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6451
7255
  error_code: 'august_lock_temporarily_offline'
6452
7256
  }
6453
7257
  | {
7258
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6454
7259
  message: string
7260
+ /** Indicates that this is an access code error. */
6455
7261
  is_access_code_error: true
7262
+ /** Date and time at which Seam created the error. */
6456
7263
  created_at?: string | undefined
6457
7264
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6458
7265
  error_code: 'salto_ks_user_not_subscribed'
6459
7266
  }
6460
7267
  | {
7268
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6461
7269
  message: string
7270
+ /** Indicates that this is an access code error. */
6462
7271
  is_access_code_error: true
7272
+ /** Date and time at which Seam created the error. */
6463
7273
  created_at?: string | undefined
6464
7274
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6465
7275
  error_code: 'hubitat_device_programming_delay'
6466
7276
  }
6467
7277
  | {
7278
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6468
7279
  message: string
7280
+ /** Indicates that this is an access code error. */
6469
7281
  is_access_code_error: true
7282
+ /** Date and time at which Seam created the error. */
6470
7283
  created_at?: string | undefined
6471
7284
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6472
7285
  error_code: 'hubitat_no_free_positions_available'
6473
7286
  }
6474
7287
  | {
7288
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6475
7289
  message: string
7290
+ /** Indicates that this is an access code error. */
6476
7291
  is_access_code_error: true
7292
+ /** Date and time at which Seam created the error. */
6477
7293
  created_at?: string | undefined
6478
7294
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6479
7295
  error_code: 'wyze_duplicate_code_name'
6480
7296
  }
6481
7297
  | {
7298
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6482
7299
  message: string
7300
+ /** Indicates that this is an access code error. */
6483
7301
  is_access_code_error: true
7302
+ /** Date and time at which Seam created the error. */
6484
7303
  created_at?: string | undefined
6485
7304
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6486
7305
  error_code: 'wyze_potential_duplicate_code'
6487
7306
  }
6488
7307
  | {
7308
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6489
7309
  message: string
7310
+ /** Indicates that this is an access code error. */
6490
7311
  is_access_code_error: true
7312
+ /** Date and time at which Seam created the error. */
6491
7313
  created_at?: string | undefined
6492
7314
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6493
7315
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -6604,86 +7426,112 @@ export interface Routes {
6604
7426
  error_code: 'bridge_disconnected'
6605
7427
  }
6606
7428
  >
6607
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
7429
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
6608
7430
  warnings: Array<
6609
7431
  | {
7432
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6610
7433
  message: string
7434
+ /** Date and time at which Seam created the warning. */
6611
7435
  created_at?: string | undefined
6612
7436
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6613
7437
  warning_code: 'smartthings_failed_to_set_access_code'
6614
7438
  }
6615
7439
  | {
7440
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6616
7441
  message: string
7442
+ /** Date and time at which Seam created the warning. */
6617
7443
  created_at?: string | undefined
6618
7444
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6619
7445
  warning_code: 'schlage_detected_duplicate'
6620
7446
  }
6621
7447
  | {
7448
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6622
7449
  message: string
7450
+ /** Date and time at which Seam created the warning. */
6623
7451
  created_at?: string | undefined
6624
7452
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6625
7453
  warning_code: 'schlage_creation_outage'
6626
7454
  }
6627
7455
  | {
7456
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6628
7457
  message: string
7458
+ /** Date and time at which Seam created the warning. */
6629
7459
  created_at?: string | undefined
6630
7460
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6631
7461
  warning_code: 'code_modified_external_to_seam'
6632
7462
  }
6633
7463
  | {
7464
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6634
7465
  message: string
7466
+ /** Date and time at which Seam created the warning. */
6635
7467
  created_at?: string | undefined
6636
7468
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6637
7469
  warning_code: 'delay_in_setting_on_device'
6638
7470
  }
6639
7471
  | {
7472
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6640
7473
  message: string
7474
+ /** Date and time at which Seam created the warning. */
6641
7475
  created_at?: string | undefined
6642
7476
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6643
7477
  warning_code: 'delay_in_removing_from_device'
6644
7478
  }
6645
7479
  | {
7480
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6646
7481
  message: string
7482
+ /** Date and time at which Seam created the warning. */
6647
7483
  created_at?: string | undefined
6648
7484
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6649
7485
  warning_code: 'third_party_integration_detected'
6650
7486
  }
6651
7487
  | {
7488
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6652
7489
  message: string
7490
+ /** Date and time at which Seam created the warning. */
6653
7491
  created_at?: string | undefined
6654
7492
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6655
7493
  warning_code: 'august_device_programming_delay'
6656
7494
  }
6657
7495
  | {
7496
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6658
7497
  message: string
7498
+ /** Date and time at which Seam created the warning. */
6659
7499
  created_at?: string | undefined
6660
7500
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6661
7501
  warning_code: 'august_lock_temporarily_offline'
6662
7502
  }
6663
7503
  | {
7504
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6664
7505
  message: string
7506
+ /** Date and time at which Seam created the warning. */
6665
7507
  created_at?: string | undefined
6666
7508
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6667
7509
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
6668
7510
  }
6669
7511
  | {
7512
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6670
7513
  message: string
7514
+ /** Date and time at which Seam created the warning. */
6671
7515
  created_at?: string | undefined
6672
7516
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6673
7517
  warning_code: 'management_transferred'
6674
7518
  }
6675
7519
  | {
7520
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6676
7521
  message: string
7522
+ /** Date and time at which Seam created the warning. */
6677
7523
  created_at?: string | undefined
6678
7524
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6679
7525
  warning_code: 'kwikset_unable_to_confirm_code'
6680
7526
  }
6681
7527
  >
7528
+ /** Indicates that Seam does not manage the access code. */
6682
7529
  is_managed: false
6683
7530
  /** Date and time at which the time-bound access code becomes active. */
6684
7531
  starts_at?: (string | null) | undefined
6685
7532
  /** Date and time after which the time-bound access code becomes inactive. */
6686
7533
  ends_at?: (string | null) | undefined
7534
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
6687
7535
  status: 'set'
6688
7536
  }
6689
7537
  }
@@ -6694,13 +7542,15 @@ export interface Routes {
6694
7542
  queryParams: {}
6695
7543
  jsonBody: {}
6696
7544
  commonParams: {
7545
+ /** ID of the device for which you want to list unmanaged access codes. */
6697
7546
  device_id: string
7547
+ /** Your user ID for the user by which to filter unmanaged access codes. */
6698
7548
  user_identifier_key?: string | undefined
6699
7549
  }
6700
7550
  formData: {}
6701
7551
  jsonResponse: {
6702
7552
  access_codes: Array<{
6703
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
7553
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
6704
7554
  type: 'time_bound' | 'ongoing'
6705
7555
  /** Unique identifier for the access code. */
6706
7556
  access_code_id: string
@@ -6712,172 +7562,244 @@ export interface Routes {
6712
7562
  code: string | null
6713
7563
  /** Date and time at which the access code was created. */
6714
7564
  created_at: string
6715
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7565
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
6716
7566
  errors: Array<
6717
7567
  | {
7568
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6718
7569
  message: string
7570
+ /** Indicates that this is an access code error. */
6719
7571
  is_access_code_error: true
7572
+ /** Date and time at which Seam created the error. */
6720
7573
  created_at?: string | undefined
6721
7574
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6722
7575
  error_code: 'smartthings_failed_to_set_access_code'
6723
7576
  }
6724
7577
  | {
7578
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6725
7579
  message: string
7580
+ /** Indicates that this is an access code error. */
6726
7581
  is_access_code_error: true
7582
+ /** Date and time at which Seam created the error. */
6727
7583
  created_at?: string | undefined
6728
7584
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6729
7585
  error_code: 'smartthings_failed_to_set_after_multiple_retries'
6730
7586
  }
6731
7587
  | {
7588
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6732
7589
  message: string
7590
+ /** Indicates that this is an access code error. */
6733
7591
  is_access_code_error: true
7592
+ /** Date and time at which Seam created the error. */
6734
7593
  created_at?: string | undefined
6735
7594
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6736
7595
  error_code: 'smartthings_no_free_slots_available'
6737
7596
  }
6738
7597
  | {
7598
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6739
7599
  message: string
7600
+ /** Indicates that this is an access code error. */
6740
7601
  is_access_code_error: true
7602
+ /** Date and time at which Seam created the error. */
6741
7603
  created_at?: string | undefined
6742
7604
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6743
7605
  error_code: 'failed_to_set_on_device'
6744
7606
  }
6745
7607
  | {
7608
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6746
7609
  message: string
7610
+ /** Indicates that this is an access code error. */
6747
7611
  is_access_code_error: true
7612
+ /** Date and time at which Seam created the error. */
6748
7613
  created_at?: string | undefined
6749
7614
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6750
7615
  error_code: 'failed_to_remove_from_device'
6751
7616
  }
6752
7617
  | {
7618
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6753
7619
  message: string
7620
+ /** Indicates that this is an access code error. */
6754
7621
  is_access_code_error: true
7622
+ /** Date and time at which Seam created the error. */
6755
7623
  created_at?: string | undefined
6756
7624
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6757
7625
  error_code: 'duplicate_code_on_device'
6758
7626
  }
6759
7627
  | {
7628
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6760
7629
  message: string
7630
+ /** Indicates that this is an access code error. */
6761
7631
  is_access_code_error: true
7632
+ /** Date and time at which Seam created the error. */
6762
7633
  created_at?: string | undefined
6763
7634
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6764
7635
  error_code: 'duplicate_code_attempt_prevented'
6765
7636
  }
6766
7637
  | {
7638
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6767
7639
  message: string
7640
+ /** Indicates that this is an access code error. */
6768
7641
  is_access_code_error: true
7642
+ /** Date and time at which Seam created the error. */
6769
7643
  created_at?: string | undefined
6770
7644
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6771
7645
  error_code: 'igloohome_bridge_too_many_pending_jobs'
6772
7646
  }
6773
7647
  | {
7648
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6774
7649
  message: string
7650
+ /** Indicates that this is an access code error. */
6775
7651
  is_access_code_error: true
7652
+ /** Date and time at which Seam created the error. */
6776
7653
  created_at?: string | undefined
6777
7654
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6778
7655
  error_code: 'igloohome_bridge_offline'
6779
7656
  }
6780
7657
  | {
7658
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6781
7659
  message: string
7660
+ /** Indicates that this is an access code error. */
6782
7661
  is_access_code_error: true
7662
+ /** Date and time at which Seam created the error. */
6783
7663
  created_at?: string | undefined
6784
7664
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6785
7665
  error_code: 'igloohome_offline_access_code_no_variance_available'
6786
7666
  }
6787
7667
  | {
7668
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6788
7669
  message: string
7670
+ /** Indicates that this is an access code error. */
6789
7671
  is_access_code_error: true
7672
+ /** Date and time at which Seam created the error. */
6790
7673
  created_at?: string | undefined
6791
7674
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6792
7675
  error_code: 'kwikset_unable_to_confirm_code'
6793
7676
  }
6794
7677
  | {
7678
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6795
7679
  message: string
7680
+ /** Indicates that this is an access code error. */
6796
7681
  is_access_code_error: true
7682
+ /** Date and time at which Seam created the error. */
6797
7683
  created_at?: string | undefined
6798
7684
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6799
7685
  error_code: 'kwikset_unable_to_confirm_deletion'
6800
7686
  }
6801
7687
  | {
7688
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6802
7689
  message: string
7690
+ /** Indicates that this is an access code error. */
6803
7691
  is_access_code_error: true
7692
+ /** Date and time at which Seam created the error. */
6804
7693
  created_at?: string | undefined
6805
7694
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6806
7695
  error_code: 'code_modified_external_to_seam'
6807
7696
  }
6808
7697
  | {
7698
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6809
7699
  message: string
7700
+ /** Indicates that this is an access code error. */
6810
7701
  is_access_code_error: true
7702
+ /** Date and time at which Seam created the error. */
6811
7703
  created_at?: string | undefined
6812
7704
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6813
7705
  error_code: 'august_lock_invalid_code_length'
6814
7706
  }
6815
7707
  | {
7708
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6816
7709
  message: string
7710
+ /** Indicates that this is an access code error. */
6817
7711
  is_access_code_error: true
7712
+ /** Date and time at which Seam created the error. */
6818
7713
  created_at?: string | undefined
6819
7714
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6820
7715
  error_code: 'august_device_programming_delay'
6821
7716
  }
6822
7717
  | {
7718
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6823
7719
  message: string
7720
+ /** Indicates that this is an access code error. */
6824
7721
  is_access_code_error: true
7722
+ /** Date and time at which Seam created the error. */
6825
7723
  created_at?: string | undefined
6826
7724
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6827
7725
  error_code: 'august_device_slots_full'
6828
7726
  }
6829
7727
  | {
7728
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6830
7729
  message: string
7730
+ /** Indicates that this is an access code error. */
6831
7731
  is_access_code_error: true
7732
+ /** Date and time at which Seam created the error. */
6832
7733
  created_at?: string | undefined
6833
7734
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6834
7735
  error_code: 'august_lock_missing_keypad'
6835
7736
  }
6836
7737
  | {
7738
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6837
7739
  message: string
7740
+ /** Indicates that this is an access code error. */
6838
7741
  is_access_code_error: true
7742
+ /** Date and time at which Seam created the error. */
6839
7743
  created_at?: string | undefined
6840
7744
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6841
7745
  error_code: 'august_lock_temporarily_offline'
6842
7746
  }
6843
7747
  | {
7748
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6844
7749
  message: string
7750
+ /** Indicates that this is an access code error. */
6845
7751
  is_access_code_error: true
7752
+ /** Date and time at which Seam created the error. */
6846
7753
  created_at?: string | undefined
6847
7754
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6848
7755
  error_code: 'salto_ks_user_not_subscribed'
6849
7756
  }
6850
7757
  | {
7758
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6851
7759
  message: string
7760
+ /** Indicates that this is an access code error. */
6852
7761
  is_access_code_error: true
7762
+ /** Date and time at which Seam created the error. */
6853
7763
  created_at?: string | undefined
6854
7764
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6855
7765
  error_code: 'hubitat_device_programming_delay'
6856
7766
  }
6857
7767
  | {
7768
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6858
7769
  message: string
7770
+ /** Indicates that this is an access code error. */
6859
7771
  is_access_code_error: true
7772
+ /** Date and time at which Seam created the error. */
6860
7773
  created_at?: string | undefined
6861
7774
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6862
7775
  error_code: 'hubitat_no_free_positions_available'
6863
7776
  }
6864
7777
  | {
7778
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6865
7779
  message: string
7780
+ /** Indicates that this is an access code error. */
6866
7781
  is_access_code_error: true
7782
+ /** Date and time at which Seam created the error. */
6867
7783
  created_at?: string | undefined
6868
7784
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6869
7785
  error_code: 'wyze_duplicate_code_name'
6870
7786
  }
6871
7787
  | {
7788
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6872
7789
  message: string
7790
+ /** Indicates that this is an access code error. */
6873
7791
  is_access_code_error: true
7792
+ /** Date and time at which Seam created the error. */
6874
7793
  created_at?: string | undefined
6875
7794
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6876
7795
  error_code: 'wyze_potential_duplicate_code'
6877
7796
  }
6878
7797
  | {
7798
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6879
7799
  message: string
7800
+ /** Indicates that this is an access code error. */
6880
7801
  is_access_code_error: true
7802
+ /** Date and time at which Seam created the error. */
6881
7803
  created_at?: string | undefined
6882
7804
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6883
7805
  error_code: 'dormakaba_oracode_no_valid_user_level'
@@ -6994,86 +7916,112 @@ export interface Routes {
6994
7916
  error_code: 'bridge_disconnected'
6995
7917
  }
6996
7918
  >
6997
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
7919
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
6998
7920
  warnings: Array<
6999
7921
  | {
7922
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7000
7923
  message: string
7924
+ /** Date and time at which Seam created the warning. */
7001
7925
  created_at?: string | undefined
7002
7926
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7003
7927
  warning_code: 'smartthings_failed_to_set_access_code'
7004
7928
  }
7005
7929
  | {
7930
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7006
7931
  message: string
7932
+ /** Date and time at which Seam created the warning. */
7007
7933
  created_at?: string | undefined
7008
7934
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7009
7935
  warning_code: 'schlage_detected_duplicate'
7010
7936
  }
7011
7937
  | {
7938
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7012
7939
  message: string
7940
+ /** Date and time at which Seam created the warning. */
7013
7941
  created_at?: string | undefined
7014
7942
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7015
7943
  warning_code: 'schlage_creation_outage'
7016
7944
  }
7017
7945
  | {
7946
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7018
7947
  message: string
7948
+ /** Date and time at which Seam created the warning. */
7019
7949
  created_at?: string | undefined
7020
7950
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7021
7951
  warning_code: 'code_modified_external_to_seam'
7022
7952
  }
7023
7953
  | {
7954
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7024
7955
  message: string
7956
+ /** Date and time at which Seam created the warning. */
7025
7957
  created_at?: string | undefined
7026
7958
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7027
7959
  warning_code: 'delay_in_setting_on_device'
7028
7960
  }
7029
7961
  | {
7962
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7030
7963
  message: string
7964
+ /** Date and time at which Seam created the warning. */
7031
7965
  created_at?: string | undefined
7032
7966
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7033
7967
  warning_code: 'delay_in_removing_from_device'
7034
7968
  }
7035
7969
  | {
7970
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7036
7971
  message: string
7972
+ /** Date and time at which Seam created the warning. */
7037
7973
  created_at?: string | undefined
7038
7974
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7039
7975
  warning_code: 'third_party_integration_detected'
7040
7976
  }
7041
7977
  | {
7978
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7042
7979
  message: string
7980
+ /** Date and time at which Seam created the warning. */
7043
7981
  created_at?: string | undefined
7044
7982
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7045
7983
  warning_code: 'august_device_programming_delay'
7046
7984
  }
7047
7985
  | {
7986
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7048
7987
  message: string
7988
+ /** Date and time at which Seam created the warning. */
7049
7989
  created_at?: string | undefined
7050
7990
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7051
7991
  warning_code: 'august_lock_temporarily_offline'
7052
7992
  }
7053
7993
  | {
7994
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7054
7995
  message: string
7996
+ /** Date and time at which Seam created the warning. */
7055
7997
  created_at?: string | undefined
7056
7998
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7057
7999
  warning_code: 'igloo_algopin_must_be_used_within_24_hours'
7058
8000
  }
7059
8001
  | {
8002
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7060
8003
  message: string
8004
+ /** Date and time at which Seam created the warning. */
7061
8005
  created_at?: string | undefined
7062
8006
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7063
8007
  warning_code: 'management_transferred'
7064
8008
  }
7065
8009
  | {
8010
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7066
8011
  message: string
8012
+ /** Date and time at which Seam created the warning. */
7067
8013
  created_at?: string | undefined
7068
8014
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
7069
8015
  warning_code: 'kwikset_unable_to_confirm_code'
7070
8016
  }
7071
8017
  >
8018
+ /** Indicates that Seam does not manage the access code. */
7072
8019
  is_managed: false
7073
8020
  /** Date and time at which the time-bound access code becomes active. */
7074
8021
  starts_at?: (string | null) | undefined
7075
8022
  /** Date and time after which the time-bound access code becomes inactive. */
7076
8023
  ends_at?: (string | null) | undefined
8024
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
7077
8025
  status: 'set'
7078
8026
  }>
7079
8027
  }
@@ -7084,10 +8032,14 @@ export interface Routes {
7084
8032
  queryParams: {}
7085
8033
  jsonBody: {}
7086
8034
  commonParams: {
8035
+ /** ID of the unmanaged access code that you want to update. */
7087
8036
  access_code_id: string
7088
8037
  is_managed: boolean
8038
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. */
7089
8039
  allow_external_modification?: boolean | undefined
8040
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. */
7090
8041
  is_external_modification_allowed?: boolean | undefined
8042
+ /** Indicates whether to force the unmanaged access code update. */
7091
8043
  force?: boolean | undefined
7092
8044
  }
7093
8045
  formData: {}
@@ -7098,24 +8050,41 @@ export interface Routes {
7098
8050
  method: 'POST' | 'PATCH' | 'PUT'
7099
8051
  queryParams: {}
7100
8052
  jsonBody: {
8053
+ /** Name of the new access code. */
7101
8054
  name?: string | undefined
8055
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
7102
8056
  starts_at?: string | undefined
8057
+ /** Date and time at which the validity of the new access code 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`. */
7103
8058
  ends_at?: string | undefined
8059
+ /** Code to be used for access. */
7104
8060
  code?: string | undefined
8061
+ /** */
7105
8062
  sync?: boolean
7106
8063
  attempt_for_offline_device?: boolean
8064
+ /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
7107
8065
  prefer_native_scheduling?: boolean | undefined
8066
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
7108
8067
  use_backup_access_code_pool?: boolean | undefined
8068
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
7109
8069
  allow_external_modification?: boolean | undefined
8070
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
7110
8071
  is_external_modification_allowed?: boolean | undefined
8072
+ /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
7111
8073
  preferred_code_length?: number | undefined
7112
8074
  use_offline_access_code?: boolean | undefined
8075
+ /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
7113
8076
  is_offline_access_code?: boolean | undefined
8077
+ /** Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
7114
8078
  is_one_time_use?: boolean | undefined
8079
+ /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
7115
8080
  max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined
8081
+ /** ID of the access code that you want to update. */
7116
8082
  access_code_id: string
8083
+ /** ID of the device containing the access code that you want to update. */
7117
8084
  device_id?: string | undefined
8085
+ /** Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). */
7118
8086
  type?: ('ongoing' | 'time_bound') | undefined
8087
+ /** Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`. */
7119
8088
  is_managed?: boolean | undefined
7120
8089
  }
7121
8090
  commonParams: {}
@@ -8246,9 +9215,13 @@ export interface Routes {
8246
9215
  method: 'POST' | 'PATCH'
8247
9216
  queryParams: {}
8248
9217
  jsonBody: {
9218
+ /** Date and time at which the validity of the new access code 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`. */
8249
9219
  ends_at?: string | undefined
9220
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
8250
9221
  starts_at?: string | undefined
9222
+ /** Name of the new access code. */
8251
9223
  name?: string | undefined
9224
+ /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
8252
9225
  common_code_key: string
8253
9226
  }
8254
9227
  commonParams: {}
@@ -8617,21 +9590,25 @@ export interface Routes {
8617
9590
  }
8618
9591
  >
8619
9592
  /** */
8620
- pending_modifications?:
9593
+ pending_mutations?:
8621
9594
  | Array<
8622
9595
  | {
8623
9596
  created_at: string
8624
- modification_code: 'create'
9597
+ mutation_code: 'creating'
8625
9598
  }
8626
9599
  | {
8627
9600
  created_at: string
8628
- modification_code: 'profile'
8629
- modified_from: {
9601
+ mutation_code: 'deleting'
9602
+ }
9603
+ | {
9604
+ created_at: string
9605
+ mutation_code: 'updating_user_information'
9606
+ from: {
8630
9607
  email_address?: (string | null) | undefined
8631
9608
  full_name?: (string | null) | undefined
8632
9609
  phone_number?: ((string | undefined) | null) | undefined
8633
9610
  }
8634
- modified_to: {
9611
+ to: {
8635
9612
  email_address?: (string | null) | undefined
8636
9613
  full_name?: (string | null) | undefined
8637
9614
  phone_number?: ((string | undefined) | null) | undefined
@@ -8639,14 +9616,14 @@ export interface Routes {
8639
9616
  }
8640
9617
  | {
8641
9618
  created_at: string
8642
- modification_code: 'access_schedule'
8643
- modified_from: {
9619
+ mutation_code: 'updating_access_schedule'
9620
+ from: {
8644
9621
  /** 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. */
8645
9622
  starts_at: string
8646
9623
  /** 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. */
8647
9624
  ends_at: string | null
8648
9625
  }
8649
- modified_to: {
9626
+ to: {
8650
9627
  /** 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. */
8651
9628
  starts_at: string
8652
9629
  /** 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. */
@@ -8655,21 +9632,21 @@ export interface Routes {
8655
9632
  }
8656
9633
  | {
8657
9634
  created_at: string
8658
- modification_code: 'suspension_state'
8659
- modified_from: {
9635
+ mutation_code: 'updating_suspension_state'
9636
+ from: {
8660
9637
  is_suspended: boolean
8661
9638
  }
8662
- modified_to: {
9639
+ to: {
8663
9640
  is_suspended: boolean
8664
9641
  }
8665
9642
  }
8666
9643
  | {
8667
9644
  created_at: string
8668
- modification_code: 'acs_access_group_membership'
8669
- modified_from: {
9645
+ mutation_code: 'updating_group_membership'
9646
+ from: {
8670
9647
  acs_access_group_id: string | null
8671
9648
  }
8672
- modified_to: {
9649
+ to: {
8673
9650
  acs_access_group_id: string | null
8674
9651
  }
8675
9652
  }
@@ -13942,21 +14919,25 @@ export interface Routes {
13942
14919
  }
13943
14920
  >
13944
14921
  /** */
13945
- pending_modifications?:
14922
+ pending_mutations?:
13946
14923
  | Array<
13947
14924
  | {
13948
14925
  created_at: string
13949
- modification_code: 'create'
14926
+ mutation_code: 'creating'
14927
+ }
14928
+ | {
14929
+ created_at: string
14930
+ mutation_code: 'deleting'
13950
14931
  }
13951
14932
  | {
13952
14933
  created_at: string
13953
- modification_code: 'profile'
13954
- modified_from: {
14934
+ mutation_code: 'updating_user_information'
14935
+ from: {
13955
14936
  email_address?: (string | null) | undefined
13956
14937
  full_name?: (string | null) | undefined
13957
14938
  phone_number?: ((string | undefined) | null) | undefined
13958
14939
  }
13959
- modified_to: {
14940
+ to: {
13960
14941
  email_address?: (string | null) | undefined
13961
14942
  full_name?: (string | null) | undefined
13962
14943
  phone_number?: ((string | undefined) | null) | undefined
@@ -13964,14 +14945,14 @@ export interface Routes {
13964
14945
  }
13965
14946
  | {
13966
14947
  created_at: string
13967
- modification_code: 'access_schedule'
13968
- modified_from: {
14948
+ mutation_code: 'updating_access_schedule'
14949
+ from: {
13969
14950
  /** 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. */
13970
14951
  starts_at: string
13971
14952
  /** 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. */
13972
14953
  ends_at: string | null
13973
14954
  }
13974
- modified_to: {
14955
+ to: {
13975
14956
  /** 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. */
13976
14957
  starts_at: string
13977
14958
  /** 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. */
@@ -13980,21 +14961,21 @@ export interface Routes {
13980
14961
  }
13981
14962
  | {
13982
14963
  created_at: string
13983
- modification_code: 'suspension_state'
13984
- modified_from: {
14964
+ mutation_code: 'updating_suspension_state'
14965
+ from: {
13985
14966
  is_suspended: boolean
13986
14967
  }
13987
- modified_to: {
14968
+ to: {
13988
14969
  is_suspended: boolean
13989
14970
  }
13990
14971
  }
13991
14972
  | {
13992
14973
  created_at: string
13993
- modification_code: 'acs_access_group_membership'
13994
- modified_from: {
14974
+ mutation_code: 'updating_group_membership'
14975
+ from: {
13995
14976
  acs_access_group_id: string | null
13996
14977
  }
13997
- modified_to: {
14978
+ to: {
13998
14979
  acs_access_group_id: string | null
13999
14980
  }
14000
14981
  }
@@ -14157,21 +15138,25 @@ export interface Routes {
14157
15138
  }
14158
15139
  >
14159
15140
  /** */
14160
- pending_modifications?:
15141
+ pending_mutations?:
14161
15142
  | Array<
14162
15143
  | {
14163
15144
  created_at: string
14164
- modification_code: 'create'
15145
+ mutation_code: 'creating'
15146
+ }
15147
+ | {
15148
+ created_at: string
15149
+ mutation_code: 'deleting'
14165
15150
  }
14166
15151
  | {
14167
15152
  created_at: string
14168
- modification_code: 'profile'
14169
- modified_from: {
15153
+ mutation_code: 'updating_user_information'
15154
+ from: {
14170
15155
  email_address?: (string | null) | undefined
14171
15156
  full_name?: (string | null) | undefined
14172
15157
  phone_number?: ((string | undefined) | null) | undefined
14173
15158
  }
14174
- modified_to: {
15159
+ to: {
14175
15160
  email_address?: (string | null) | undefined
14176
15161
  full_name?: (string | null) | undefined
14177
15162
  phone_number?: ((string | undefined) | null) | undefined
@@ -14179,14 +15164,14 @@ export interface Routes {
14179
15164
  }
14180
15165
  | {
14181
15166
  created_at: string
14182
- modification_code: 'access_schedule'
14183
- modified_from: {
15167
+ mutation_code: 'updating_access_schedule'
15168
+ from: {
14184
15169
  /** 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. */
14185
15170
  starts_at: string
14186
15171
  /** 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. */
14187
15172
  ends_at: string | null
14188
15173
  }
14189
- modified_to: {
15174
+ to: {
14190
15175
  /** 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. */
14191
15176
  starts_at: string
14192
15177
  /** 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. */
@@ -14195,21 +15180,21 @@ export interface Routes {
14195
15180
  }
14196
15181
  | {
14197
15182
  created_at: string
14198
- modification_code: 'suspension_state'
14199
- modified_from: {
15183
+ mutation_code: 'updating_suspension_state'
15184
+ from: {
14200
15185
  is_suspended: boolean
14201
15186
  }
14202
- modified_to: {
15187
+ to: {
14203
15188
  is_suspended: boolean
14204
15189
  }
14205
15190
  }
14206
15191
  | {
14207
15192
  created_at: string
14208
- modification_code: 'acs_access_group_membership'
14209
- modified_from: {
15193
+ mutation_code: 'updating_group_membership'
15194
+ from: {
14210
15195
  acs_access_group_id: string | null
14211
15196
  }
14212
- modified_to: {
15197
+ to: {
14213
15198
  acs_access_group_id: string | null
14214
15199
  }
14215
15200
  }
@@ -14368,21 +15353,25 @@ export interface Routes {
14368
15353
  }
14369
15354
  >
14370
15355
  /** */
14371
- pending_modifications?:
15356
+ pending_mutations?:
14372
15357
  | Array<
14373
15358
  | {
14374
15359
  created_at: string
14375
- modification_code: 'create'
15360
+ mutation_code: 'creating'
14376
15361
  }
14377
15362
  | {
14378
15363
  created_at: string
14379
- modification_code: 'profile'
14380
- modified_from: {
15364
+ mutation_code: 'deleting'
15365
+ }
15366
+ | {
15367
+ created_at: string
15368
+ mutation_code: 'updating_user_information'
15369
+ from: {
14381
15370
  email_address?: (string | null) | undefined
14382
15371
  full_name?: (string | null) | undefined
14383
15372
  phone_number?: ((string | undefined) | null) | undefined
14384
15373
  }
14385
- modified_to: {
15374
+ to: {
14386
15375
  email_address?: (string | null) | undefined
14387
15376
  full_name?: (string | null) | undefined
14388
15377
  phone_number?: ((string | undefined) | null) | undefined
@@ -14390,14 +15379,14 @@ export interface Routes {
14390
15379
  }
14391
15380
  | {
14392
15381
  created_at: string
14393
- modification_code: 'access_schedule'
14394
- modified_from: {
15382
+ mutation_code: 'updating_access_schedule'
15383
+ from: {
14395
15384
  /** 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. */
14396
15385
  starts_at: string
14397
15386
  /** 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. */
14398
15387
  ends_at: string | null
14399
15388
  }
14400
- modified_to: {
15389
+ to: {
14401
15390
  /** 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. */
14402
15391
  starts_at: string
14403
15392
  /** 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. */
@@ -14406,21 +15395,21 @@ export interface Routes {
14406
15395
  }
14407
15396
  | {
14408
15397
  created_at: string
14409
- modification_code: 'suspension_state'
14410
- modified_from: {
15398
+ mutation_code: 'updating_suspension_state'
15399
+ from: {
14411
15400
  is_suspended: boolean
14412
15401
  }
14413
- modified_to: {
15402
+ to: {
14414
15403
  is_suspended: boolean
14415
15404
  }
14416
15405
  }
14417
15406
  | {
14418
15407
  created_at: string
14419
- modification_code: 'acs_access_group_membership'
14420
- modified_from: {
15408
+ mutation_code: 'updating_group_membership'
15409
+ from: {
14421
15410
  acs_access_group_id: string | null
14422
15411
  }
14423
- modified_to: {
15412
+ to: {
14424
15413
  acs_access_group_id: string | null
14425
15414
  }
14426
15415
  }
@@ -14711,21 +15700,25 @@ export interface Routes {
14711
15700
  }
14712
15701
  >
14713
15702
  /** */
14714
- pending_modifications?:
15703
+ pending_mutations?:
14715
15704
  | Array<
14716
15705
  | {
14717
15706
  created_at: string
14718
- modification_code: 'create'
15707
+ mutation_code: 'creating'
14719
15708
  }
14720
15709
  | {
14721
15710
  created_at: string
14722
- modification_code: 'profile'
14723
- modified_from: {
15711
+ mutation_code: 'deleting'
15712
+ }
15713
+ | {
15714
+ created_at: string
15715
+ mutation_code: 'updating_user_information'
15716
+ from: {
14724
15717
  email_address?: (string | null) | undefined
14725
15718
  full_name?: (string | null) | undefined
14726
15719
  phone_number?: ((string | undefined) | null) | undefined
14727
15720
  }
14728
- modified_to: {
15721
+ to: {
14729
15722
  email_address?: (string | null) | undefined
14730
15723
  full_name?: (string | null) | undefined
14731
15724
  phone_number?: ((string | undefined) | null) | undefined
@@ -14733,14 +15726,14 @@ export interface Routes {
14733
15726
  }
14734
15727
  | {
14735
15728
  created_at: string
14736
- modification_code: 'access_schedule'
14737
- modified_from: {
15729
+ mutation_code: 'updating_access_schedule'
15730
+ from: {
14738
15731
  /** 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. */
14739
15732
  starts_at: string
14740
15733
  /** 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. */
14741
15734
  ends_at: string | null
14742
15735
  }
14743
- modified_to: {
15736
+ to: {
14744
15737
  /** 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. */
14745
15738
  starts_at: string
14746
15739
  /** 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. */
@@ -14749,21 +15742,21 @@ export interface Routes {
14749
15742
  }
14750
15743
  | {
14751
15744
  created_at: string
14752
- modification_code: 'suspension_state'
14753
- modified_from: {
15745
+ mutation_code: 'updating_suspension_state'
15746
+ from: {
14754
15747
  is_suspended: boolean
14755
15748
  }
14756
- modified_to: {
15749
+ to: {
14757
15750
  is_suspended: boolean
14758
15751
  }
14759
15752
  }
14760
15753
  | {
14761
15754
  created_at: string
14762
- modification_code: 'acs_access_group_membership'
14763
- modified_from: {
15755
+ mutation_code: 'updating_group_membership'
15756
+ from: {
14764
15757
  acs_access_group_id: string | null
14765
15758
  }
14766
- modified_to: {
15759
+ to: {
14767
15760
  acs_access_group_id: string | null
14768
15761
  }
14769
15762
  }
@@ -14912,21 +15905,25 @@ export interface Routes {
14912
15905
  }
14913
15906
  >
14914
15907
  /** */
14915
- pending_modifications?:
15908
+ pending_mutations?:
14916
15909
  | Array<
14917
15910
  | {
14918
15911
  created_at: string
14919
- modification_code: 'create'
15912
+ mutation_code: 'creating'
15913
+ }
15914
+ | {
15915
+ created_at: string
15916
+ mutation_code: 'deleting'
14920
15917
  }
14921
15918
  | {
14922
15919
  created_at: string
14923
- modification_code: 'profile'
14924
- modified_from: {
15920
+ mutation_code: 'updating_user_information'
15921
+ from: {
14925
15922
  email_address?: (string | null) | undefined
14926
15923
  full_name?: (string | null) | undefined
14927
15924
  phone_number?: ((string | undefined) | null) | undefined
14928
15925
  }
14929
- modified_to: {
15926
+ to: {
14930
15927
  email_address?: (string | null) | undefined
14931
15928
  full_name?: (string | null) | undefined
14932
15929
  phone_number?: ((string | undefined) | null) | undefined
@@ -14934,14 +15931,14 @@ export interface Routes {
14934
15931
  }
14935
15932
  | {
14936
15933
  created_at: string
14937
- modification_code: 'access_schedule'
14938
- modified_from: {
15934
+ mutation_code: 'updating_access_schedule'
15935
+ from: {
14939
15936
  /** 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. */
14940
15937
  starts_at: string
14941
15938
  /** 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. */
14942
15939
  ends_at: string | null
14943
15940
  }
14944
- modified_to: {
15941
+ to: {
14945
15942
  /** 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. */
14946
15943
  starts_at: string
14947
15944
  /** 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. */
@@ -14950,21 +15947,21 @@ export interface Routes {
14950
15947
  }
14951
15948
  | {
14952
15949
  created_at: string
14953
- modification_code: 'suspension_state'
14954
- modified_from: {
15950
+ mutation_code: 'updating_suspension_state'
15951
+ from: {
14955
15952
  is_suspended: boolean
14956
15953
  }
14957
- modified_to: {
15954
+ to: {
14958
15955
  is_suspended: boolean
14959
15956
  }
14960
15957
  }
14961
15958
  | {
14962
15959
  created_at: string
14963
- modification_code: 'acs_access_group_membership'
14964
- modified_from: {
15960
+ mutation_code: 'updating_group_membership'
15961
+ from: {
14965
15962
  acs_access_group_id: string | null
14966
15963
  }
14967
- modified_to: {
15964
+ to: {
14968
15965
  acs_access_group_id: string | null
14969
15966
  }
14970
15967
  }
@@ -49893,21 +50890,25 @@ export interface Routes {
49893
50890
  }
49894
50891
  >
49895
50892
  /** */
49896
- pending_modifications?:
50893
+ pending_mutations?:
49897
50894
  | Array<
49898
50895
  | {
49899
50896
  created_at: string
49900
- modification_code: 'create'
50897
+ mutation_code: 'creating'
50898
+ }
50899
+ | {
50900
+ created_at: string
50901
+ mutation_code: 'deleting'
49901
50902
  }
49902
50903
  | {
49903
50904
  created_at: string
49904
- modification_code: 'profile'
49905
- modified_from: {
50905
+ mutation_code: 'updating_user_information'
50906
+ from: {
49906
50907
  email_address?: (string | null) | undefined
49907
50908
  full_name?: (string | null) | undefined
49908
50909
  phone_number?: ((string | undefined) | null) | undefined
49909
50910
  }
49910
- modified_to: {
50911
+ to: {
49911
50912
  email_address?: (string | null) | undefined
49912
50913
  full_name?: (string | null) | undefined
49913
50914
  phone_number?: ((string | undefined) | null) | undefined
@@ -49915,14 +50916,14 @@ export interface Routes {
49915
50916
  }
49916
50917
  | {
49917
50918
  created_at: string
49918
- modification_code: 'access_schedule'
49919
- modified_from: {
50919
+ mutation_code: 'updating_access_schedule'
50920
+ from: {
49920
50921
  /** 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. */
49921
50922
  starts_at: string
49922
50923
  /** 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. */
49923
50924
  ends_at: string | null
49924
50925
  }
49925
- modified_to: {
50926
+ to: {
49926
50927
  /** 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. */
49927
50928
  starts_at: string
49928
50929
  /** 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. */
@@ -49931,21 +50932,21 @@ export interface Routes {
49931
50932
  }
49932
50933
  | {
49933
50934
  created_at: string
49934
- modification_code: 'suspension_state'
49935
- modified_from: {
50935
+ mutation_code: 'updating_suspension_state'
50936
+ from: {
49936
50937
  is_suspended: boolean
49937
50938
  }
49938
- modified_to: {
50939
+ to: {
49939
50940
  is_suspended: boolean
49940
50941
  }
49941
50942
  }
49942
50943
  | {
49943
50944
  created_at: string
49944
- modification_code: 'acs_access_group_membership'
49945
- modified_from: {
50945
+ mutation_code: 'updating_group_membership'
50946
+ from: {
49946
50947
  acs_access_group_id: string | null
49947
50948
  }
49948
- modified_to: {
50949
+ to: {
49949
50950
  acs_access_group_id: string | null
49950
50951
  }
49951
50952
  }