@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
package/dist/connect.cjs CHANGED
@@ -1380,14 +1380,16 @@ var unmanaged_device = device.pick({
1380
1380
 
1381
1381
  // src/lib/seam/connect/models/access-codes/managed-access-code.ts
1382
1382
  var common_access_code_error = zod.z.object({
1383
- message: zod.z.string(),
1384
- is_access_code_error: zod.z.literal(true),
1385
- created_at: zod.z.string().datetime().optional()
1383
+ message: zod.z.string().describe(
1384
+ "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
1385
+ ),
1386
+ is_access_code_error: zod.z.literal(true).describe("Indicates that this is an access code error."),
1387
+ created_at: zod.z.string().datetime().optional().describe("Date and time at which Seam created the error.")
1386
1388
  });
1387
1389
  var error_code_description3 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
1388
1390
  var smartthings_failed_to_set_access_code_error = common_access_code_error.extend({
1389
1391
  error_code: zod.z.literal("smartthings_failed_to_set_access_code").describe(error_code_description3)
1390
- }).describe("Failed to set code on Smart Things device.");
1392
+ }).describe("Failed to set code on SmartThings device.");
1391
1393
  var smartthings_failed_to_set_after_multiple_retries = common_access_code_error.extend({
1392
1394
  error_code: zod.z.literal("smartthings_failed_to_set_after_multiple_retries").describe(error_code_description3)
1393
1395
  }).describe("Failed to set code after multiple retries.");
@@ -1416,7 +1418,7 @@ var igloohome_bridge_offline = common_access_code_error.extend({
1416
1418
  }).describe("Igloohome bridge is offline.");
1417
1419
  var kwikset_unable_to_confirm_code = common_access_code_error.extend({
1418
1420
  error_code: zod.z.literal("kwikset_unable_to_confirm_code").describe(error_code_description3)
1419
- }).describe("Unable to confirm the access code is set on Kwikset device.");
1421
+ }).describe("Unable to confirm that the access code is set on Kwikset device.");
1420
1422
  var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
1421
1423
  error_code: zod.z.literal("kwikset_unable_to_confirm_deletion").describe(error_code_description3)
1422
1424
  }).describe(
@@ -1424,7 +1426,7 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
1424
1426
  );
1425
1427
  var igloohome_offline_access_code_no_variance_available = common_access_code_error.extend({
1426
1428
  error_code: zod.z.literal("igloohome_offline_access_code_no_variance_available").describe(error_code_description3)
1427
- }).describe("Lock as reached max amount of codes.");
1429
+ }).describe("Lock has reached maximum amount of codes.");
1428
1430
  var august_lock_invalid_code_length = common_access_code_error.extend({
1429
1431
  error_code: zod.z.literal("august_lock_invalid_code_length").describe(error_code_description3)
1430
1432
  }).describe("Invalid code length for August lock.");
@@ -1486,7 +1488,9 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
1486
1488
  wyze_duplicate_code_name,
1487
1489
  wyze_potential_duplicate_code,
1488
1490
  dormakaba_oracode_no_valid_user_level
1489
- ]);
1491
+ ]).describe(
1492
+ "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
1493
+ );
1490
1494
  zod.z.object({
1491
1495
  smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_error.optional().nullable(),
1492
1496
  smartthings_failed_to_set_after_multiple_retries: smartthings_failed_to_set_after_multiple_retries.optional().nullable(),
@@ -1514,13 +1518,15 @@ zod.z.object({
1514
1518
  dormakaba_oracode_no_valid_user_level: dormakaba_oracode_no_valid_user_level.optional().nullable()
1515
1519
  });
1516
1520
  var common_access_code_warning = zod.z.object({
1517
- message: zod.z.string(),
1518
- created_at: zod.z.string().datetime().optional()
1521
+ message: zod.z.string().describe(
1522
+ "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
1523
+ ),
1524
+ created_at: zod.z.string().datetime().optional().describe("Date and time at which Seam created the warning.")
1519
1525
  });
1520
1526
  var warning_code_description3 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
1521
1527
  var smartthings_failed_to_set_access_code_warning = common_access_code_warning.extend({
1522
1528
  warning_code: zod.z.literal("smartthings_failed_to_set_access_code").describe(warning_code_description3)
1523
- }).describe("Failed to set code on Smart Things device.");
1529
+ }).describe("Failed to set code on SmartThings device.");
1524
1530
  var august_device_programming_delay_warning = common_access_code_warning.extend({
1525
1531
  warning_code: zod.z.literal("august_device_programming_delay").describe(warning_code_description3)
1526
1532
  }).describe("Access code has not yet been fully moved to the device.");
@@ -1547,7 +1553,7 @@ var delay_in_removing_from_device = common_access_code_warning.extend({
1547
1553
  var third_party_integration_detected2 = common_access_code_warning.extend({
1548
1554
  warning_code: zod.z.literal("third_party_integration_detected").describe(warning_code_description3)
1549
1555
  }).describe(
1550
- "Third party integration detected that may cause access codes to fail."
1556
+ "Third-party integration detected that may cause access codes to fail."
1551
1557
  );
1552
1558
  var igloo_algopin_must_be_used_within_24_hours = common_access_code_warning.extend({
1553
1559
  warning_code: zod.z.literal("igloo_algopin_must_be_used_within_24_hours").describe(warning_code_description3)
@@ -1557,7 +1563,7 @@ var management_transferred = common_access_code_warning.extend({
1557
1563
  }).describe("Management was transferred to another workspace.");
1558
1564
  var kwikset_unable_to_confirm_code_warning = common_access_code_warning.extend({
1559
1565
  warning_code: zod.z.literal("kwikset_unable_to_confirm_code").describe(warning_code_description3)
1560
- }).describe("Unable to confirm the access code is set on Kwikset device.");
1566
+ }).describe("Unable to confirm that the access code is set on Kwikset device.");
1561
1567
  var access_code_warning = zod.z.discriminatedUnion("warning_code", [
1562
1568
  smartthings_failed_to_set_access_code_warning,
1563
1569
  schlage_detected_duplicate,
@@ -1571,7 +1577,9 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
1571
1577
  igloo_algopin_must_be_used_within_24_hours,
1572
1578
  management_transferred,
1573
1579
  kwikset_unable_to_confirm_code_warning
1574
- ]);
1580
+ ]).describe(
1581
+ "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
1582
+ );
1575
1583
  zod.z.object({
1576
1584
  smartthings_failed_to_set_access_code: smartthings_failed_to_set_access_code_warning.optional().nullable(),
1577
1585
  schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),
@@ -1594,7 +1602,7 @@ var access_code = zod.z.object({
1594
1602
  "Indicates whether the code is set on the device according to a preconfigured schedule."
1595
1603
  ),
1596
1604
  type: zod.z.enum(["time_bound", "ongoing"]).describe(
1597
- '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.'
1605
+ "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."
1598
1606
  ),
1599
1607
  is_waiting_for_code_assignment: zod.z.boolean().optional().describe(
1600
1608
  "Indicates whether the access code is waiting for a code assignment."
@@ -1616,10 +1624,10 @@ var access_code = zod.z.object({
1616
1624
  ...device_and_connected_account_error_options
1617
1625
  ])
1618
1626
  ).describe(
1619
- '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.'
1627
+ "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
1620
1628
  ),
1621
1629
  warnings: zod.z.array(access_code_warning).describe(
1622
- '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.'
1630
+ "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
1623
1631
  ),
1624
1632
  is_managed: zod.z.literal(true).describe("Indicates whether Seam manages the access code."),
1625
1633
  starts_at: zod.z.string().datetime().nullable().optional().describe(
@@ -1628,9 +1636,9 @@ var access_code = zod.z.object({
1628
1636
  ends_at: zod.z.string().datetime().nullable().optional().describe(
1629
1637
  "Date and time after which the time-bound access code becomes inactive."
1630
1638
  ),
1631
- status: zod.z.enum(["setting", "set", "unset", "removing", "unknown"]).describe(`
1632
- 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.
1633
- `),
1639
+ status: zod.z.enum(["setting", "set", "unset", "removing", "unknown"]).describe(
1640
+ "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."
1641
+ ),
1634
1642
  is_backup_access_code_available: zod.z.boolean().describe(
1635
1643
  "Indicates whether a backup access code is available for use if the primary access code is lost or compromised."
1636
1644
  ),
@@ -1642,15 +1650,22 @@ var access_code = zod.z.object({
1642
1650
  "Indicates whether changes to the access code from external sources are permitted."
1643
1651
  ),
1644
1652
  is_one_time_use: zod.z.boolean().describe(
1645
- 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.'
1653
+ "Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use."
1646
1654
  ),
1647
1655
  is_offline_access_code: zod.z.boolean().describe(
1648
- '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.'
1656
+ "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."
1649
1657
  )
1650
1658
  }).describe(`
1651
1659
  ---
1652
1660
  route_path: /access_codes
1653
1661
  ---
1662
+ Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
1663
+
1664
+ 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.
1665
+
1666
+ 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\`.
1667
+
1668
+ 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\u2014and you do not need to be near the locks\u2014to 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.
1654
1669
  `);
1655
1670
  var unmanaged_access_code = access_code.pick({
1656
1671
  type: true,
@@ -1665,12 +1680,21 @@ var unmanaged_access_code = access_code.pick({
1665
1680
  starts_at: true,
1666
1681
  ends_at: true
1667
1682
  }).extend({
1668
- is_managed: zod.z.literal(false),
1669
- status: zod.z.enum(["set"])
1683
+ is_managed: zod.z.literal(false).describe("Indicates that Seam does not manage the access code."),
1684
+ status: zod.z.enum(["set"]).describe(
1685
+ "Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational."
1686
+ )
1670
1687
  }).describe(`
1671
1688
  ---
1672
1689
  route_path: /access_codes/unmanaged
1673
1690
  ---
1691
+ Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
1692
+
1693
+ 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.
1694
+
1695
+ 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.
1696
+
1697
+ 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.
1674
1698
  `);
1675
1699
  var acs_access_group_external_type = zod.z.enum([
1676
1700
  "pti_unit",
@@ -2378,79 +2402,82 @@ var start_end_schedule = zod.z.object({
2378
2402
  ).nullable()
2379
2403
  });
2380
2404
  var schedule = start_end_schedule;
2381
- var common_pending_modification = zod.z.object({
2405
+ var common_pending_mutation = zod.z.object({
2382
2406
  created_at: zod.z.string().datetime()
2383
2407
  });
2384
- var lifecycle_create = common_pending_modification.extend({
2385
- modification_code: zod.z.literal("create")
2408
+ var creating = common_pending_mutation.extend({
2409
+ mutation_code: zod.z.literal("creating")
2386
2410
  });
2387
- var acs_user_profile = zod.z.object({
2411
+ var deleting = common_pending_mutation.extend({
2412
+ mutation_code: zod.z.literal("deleting")
2413
+ });
2414
+ var acs_user_info = zod.z.object({
2388
2415
  email_address: zod.z.string().email().nullable(),
2389
2416
  full_name: zod.z.string().nullable(),
2390
2417
  phone_number: phone_number.optional().nullable()
2391
2418
  });
2392
- var profile_pending_modification = common_pending_modification.extend({
2393
- modification_code: zod.z.literal("profile"),
2394
- modified_from: acs_user_profile.partial(),
2395
- modified_to: acs_user_profile.partial()
2419
+ var updating_user_information_mutation = common_pending_mutation.extend({
2420
+ mutation_code: zod.z.literal("updating_user_information"),
2421
+ from: acs_user_info.partial(),
2422
+ to: acs_user_info.partial()
2396
2423
  });
2397
- var access_schedule_pending_modification = common_pending_modification.extend(
2398
- {
2399
- modification_code: zod.z.literal("access_schedule"),
2400
- modified_from: schedule,
2401
- modified_to: schedule
2402
- }
2403
- );
2404
- var suspension_state_pending_modification = common_pending_modification.extend({
2405
- modification_code: zod.z.literal("suspension_state"),
2406
- modified_from: zod.z.object({ is_suspended: zod.z.boolean() }),
2407
- modified_to: zod.z.object({ is_suspended: zod.z.boolean() })
2424
+ var updating_access_schedule_mutation = common_pending_mutation.extend({
2425
+ mutation_code: zod.z.literal("updating_access_schedule"),
2426
+ from: schedule,
2427
+ to: schedule
2408
2428
  });
2409
- var acs_access_group_membership_pending_modification = common_pending_modification.extend({
2410
- modification_code: zod.z.literal("acs_access_group_membership"),
2411
- modified_from: zod.z.object({
2429
+ var updating_suspension_state_mutation = common_pending_mutation.extend({
2430
+ mutation_code: zod.z.literal("updating_suspension_state"),
2431
+ from: zod.z.object({ is_suspended: zod.z.boolean() }),
2432
+ to: zod.z.object({ is_suspended: zod.z.boolean() })
2433
+ });
2434
+ var updating_group_membership_mutation = common_pending_mutation.extend({
2435
+ mutation_code: zod.z.literal("updating_group_membership"),
2436
+ from: zod.z.object({
2412
2437
  acs_access_group_id: zod.z.string().uuid().nullable()
2413
2438
  }),
2414
- modified_to: zod.z.object({
2439
+ to: zod.z.object({
2415
2440
  acs_access_group_id: zod.z.string().uuid().nullable()
2416
2441
  })
2417
2442
  });
2418
- var acs_user_pending_modification = zod.z.discriminatedUnion(
2419
- "modification_code",
2443
+ var acs_user_pending_mutations = zod.z.discriminatedUnion(
2444
+ "mutation_code",
2420
2445
  [
2421
- lifecycle_create,
2422
- profile_pending_modification,
2423
- access_schedule_pending_modification,
2424
- suspension_state_pending_modification,
2425
- acs_access_group_membership_pending_modification
2446
+ creating,
2447
+ deleting,
2448
+ updating_user_information_mutation,
2449
+ updating_access_schedule_mutation,
2450
+ updating_suspension_state_mutation,
2451
+ updating_group_membership_mutation
2426
2452
  ]
2427
2453
  );
2428
2454
  zod.z.object({
2429
- lifecycle_create: lifecycle_create.optional().nullable(),
2430
- "profile.full_name": common_pending_modification.extend({
2431
- modification_code: zod.z.literal("profile"),
2432
- modified_from: zod.z.object({
2455
+ creating: creating.optional().nullable(),
2456
+ deleting: deleting.optional().nullable(),
2457
+ "updating_user_information.full_name": common_pending_mutation.extend({
2458
+ mutation_code: zod.z.literal("updating_user_information"),
2459
+ from: zod.z.object({
2433
2460
  full_name: zod.z.string().nullable()
2434
2461
  }),
2435
- modified_to: zod.z.object({
2462
+ to: zod.z.object({
2436
2463
  full_name: zod.z.string().nullable()
2437
2464
  })
2438
2465
  }).optional().nullable(),
2439
- "profile.email_address": common_pending_modification.extend({
2440
- modification_code: zod.z.literal("profile"),
2441
- modified_from: zod.z.object({
2466
+ "updating_user_information.email_address": common_pending_mutation.extend({
2467
+ mutation_code: zod.z.literal("updating_user_information"),
2468
+ from: zod.z.object({
2442
2469
  email_address: zod.z.string().email().nullable()
2443
2470
  }),
2444
- modified_to: zod.z.object({
2471
+ to: zod.z.object({
2445
2472
  email_address: zod.z.string().email().nullable()
2446
2473
  })
2447
2474
  }).optional().nullable(),
2448
- "profile.phone_number": common_pending_modification.extend({
2449
- modification_code: zod.z.literal("profile"),
2450
- modified_from: zod.z.object({
2475
+ "updating_user_information.phone_number": common_pending_mutation.extend({
2476
+ mutation_code: zod.z.literal("updating_user_information"),
2477
+ from: zod.z.object({
2451
2478
  phone_number: phone_number.nullable()
2452
2479
  }),
2453
- modified_to: zod.z.object({
2480
+ to: zod.z.object({
2454
2481
  phone_number: phone_number.nullable()
2455
2482
  })
2456
2483
  }).optional().nullable()
@@ -2637,7 +2664,7 @@ var common_acs_user = zod.z.object({
2637
2664
  errors: zod.z.array(acs_user_errors).describe(
2638
2665
  "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2639
2666
  ),
2640
- pending_modifications: zod.z.array(acs_user_pending_modification).optional().describe(`
2667
+ pending_mutations: zod.z.array(acs_user_pending_mutations).optional().describe(`
2641
2668
  ---
2642
2669
  undocumented: Experimental.
2643
2670
  ---
@@ -4198,6 +4225,7 @@ var openapi_default = {
4198
4225
  components: {
4199
4226
  schemas: {
4200
4227
  access_code: {
4228
+ description: "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn 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.\n\nSeam 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`.\n\nIn 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\u2014and you do not need to be near the locks\u2014to 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.",
4201
4229
  properties: {
4202
4230
  access_code_id: {
4203
4231
  description: "Unique identifier for the access code.",
@@ -4231,21 +4259,32 @@ var openapi_default = {
4231
4259
  type: "string"
4232
4260
  },
4233
4261
  errors: {
4234
- description: '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.',
4262
+ description: "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
4235
4263
  items: {
4236
4264
  discriminator: { propertyName: "error_code" },
4237
4265
  oneOf: [
4238
4266
  {
4239
- description: "Failed to set code on Smart Things device.",
4267
+ description: "Failed to set code on SmartThings device.",
4240
4268
  properties: {
4241
- created_at: { format: "date-time", type: "string" },
4269
+ created_at: {
4270
+ description: "Date and time at which Seam created the error.",
4271
+ format: "date-time",
4272
+ type: "string"
4273
+ },
4242
4274
  error_code: {
4243
4275
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4244
4276
  enum: ["smartthings_failed_to_set_access_code"],
4245
4277
  type: "string"
4246
4278
  },
4247
- is_access_code_error: { enum: [true], type: "boolean" },
4248
- message: { type: "string" }
4279
+ is_access_code_error: {
4280
+ description: "Indicates that this is an access code error.",
4281
+ enum: [true],
4282
+ type: "boolean"
4283
+ },
4284
+ message: {
4285
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4286
+ type: "string"
4287
+ }
4249
4288
  },
4250
4289
  required: ["message", "is_access_code_error", "error_code"],
4251
4290
  type: "object"
@@ -4253,7 +4292,11 @@ var openapi_default = {
4253
4292
  {
4254
4293
  description: "Failed to set code after multiple retries.",
4255
4294
  properties: {
4256
- created_at: { format: "date-time", type: "string" },
4295
+ created_at: {
4296
+ description: "Date and time at which Seam created the error.",
4297
+ format: "date-time",
4298
+ type: "string"
4299
+ },
4257
4300
  error_code: {
4258
4301
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4259
4302
  enum: [
@@ -4261,8 +4304,15 @@ var openapi_default = {
4261
4304
  ],
4262
4305
  type: "string"
4263
4306
  },
4264
- is_access_code_error: { enum: [true], type: "boolean" },
4265
- message: { type: "string" }
4307
+ is_access_code_error: {
4308
+ description: "Indicates that this is an access code error.",
4309
+ enum: [true],
4310
+ type: "boolean"
4311
+ },
4312
+ message: {
4313
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4314
+ type: "string"
4315
+ }
4266
4316
  },
4267
4317
  required: ["message", "is_access_code_error", "error_code"],
4268
4318
  type: "object"
@@ -4270,14 +4320,25 @@ var openapi_default = {
4270
4320
  {
4271
4321
  description: "No free slots available on the device.",
4272
4322
  properties: {
4273
- created_at: { format: "date-time", type: "string" },
4323
+ created_at: {
4324
+ description: "Date and time at which Seam created the error.",
4325
+ format: "date-time",
4326
+ type: "string"
4327
+ },
4274
4328
  error_code: {
4275
4329
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4276
4330
  enum: ["smartthings_no_free_slots_available"],
4277
4331
  type: "string"
4278
4332
  },
4279
- is_access_code_error: { enum: [true], type: "boolean" },
4280
- message: { type: "string" }
4333
+ is_access_code_error: {
4334
+ description: "Indicates that this is an access code error.",
4335
+ enum: [true],
4336
+ type: "boolean"
4337
+ },
4338
+ message: {
4339
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4340
+ type: "string"
4341
+ }
4281
4342
  },
4282
4343
  required: ["message", "is_access_code_error", "error_code"],
4283
4344
  type: "object"
@@ -4285,14 +4346,25 @@ var openapi_default = {
4285
4346
  {
4286
4347
  description: "Failed to set code on device.",
4287
4348
  properties: {
4288
- created_at: { format: "date-time", type: "string" },
4349
+ created_at: {
4350
+ description: "Date and time at which Seam created the error.",
4351
+ format: "date-time",
4352
+ type: "string"
4353
+ },
4289
4354
  error_code: {
4290
4355
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4291
4356
  enum: ["failed_to_set_on_device"],
4292
4357
  type: "string"
4293
4358
  },
4294
- is_access_code_error: { enum: [true], type: "boolean" },
4295
- message: { type: "string" }
4359
+ is_access_code_error: {
4360
+ description: "Indicates that this is an access code error.",
4361
+ enum: [true],
4362
+ type: "boolean"
4363
+ },
4364
+ message: {
4365
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4366
+ type: "string"
4367
+ }
4296
4368
  },
4297
4369
  required: ["message", "is_access_code_error", "error_code"],
4298
4370
  type: "object"
@@ -4300,14 +4372,25 @@ var openapi_default = {
4300
4372
  {
4301
4373
  description: "Failed to remove code from device.",
4302
4374
  properties: {
4303
- created_at: { format: "date-time", type: "string" },
4375
+ created_at: {
4376
+ description: "Date and time at which Seam created the error.",
4377
+ format: "date-time",
4378
+ type: "string"
4379
+ },
4304
4380
  error_code: {
4305
4381
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4306
4382
  enum: ["failed_to_remove_from_device"],
4307
4383
  type: "string"
4308
4384
  },
4309
- is_access_code_error: { enum: [true], type: "boolean" },
4310
- message: { type: "string" }
4385
+ is_access_code_error: {
4386
+ description: "Indicates that this is an access code error.",
4387
+ enum: [true],
4388
+ type: "boolean"
4389
+ },
4390
+ message: {
4391
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4392
+ type: "string"
4393
+ }
4311
4394
  },
4312
4395
  required: ["message", "is_access_code_error", "error_code"],
4313
4396
  type: "object"
@@ -4315,14 +4398,25 @@ var openapi_default = {
4315
4398
  {
4316
4399
  description: "Duplicate access code detected on device.",
4317
4400
  properties: {
4318
- created_at: { format: "date-time", type: "string" },
4401
+ created_at: {
4402
+ description: "Date and time at which Seam created the error.",
4403
+ format: "date-time",
4404
+ type: "string"
4405
+ },
4319
4406
  error_code: {
4320
4407
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4321
4408
  enum: ["duplicate_code_on_device"],
4322
4409
  type: "string"
4323
4410
  },
4324
- is_access_code_error: { enum: [true], type: "boolean" },
4325
- message: { type: "string" }
4411
+ is_access_code_error: {
4412
+ description: "Indicates that this is an access code error.",
4413
+ enum: [true],
4414
+ type: "boolean"
4415
+ },
4416
+ message: {
4417
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4418
+ type: "string"
4419
+ }
4326
4420
  },
4327
4421
  required: ["message", "is_access_code_error", "error_code"],
4328
4422
  type: "object"
@@ -4330,14 +4424,25 @@ var openapi_default = {
4330
4424
  {
4331
4425
  description: "An attempt to modify this access code was prevented.",
4332
4426
  properties: {
4333
- created_at: { format: "date-time", type: "string" },
4427
+ created_at: {
4428
+ description: "Date and time at which Seam created the error.",
4429
+ format: "date-time",
4430
+ type: "string"
4431
+ },
4334
4432
  error_code: {
4335
4433
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4336
4434
  enum: ["duplicate_code_attempt_prevented"],
4337
4435
  type: "string"
4338
4436
  },
4339
- is_access_code_error: { enum: [true], type: "boolean" },
4340
- message: { type: "string" }
4437
+ is_access_code_error: {
4438
+ description: "Indicates that this is an access code error.",
4439
+ enum: [true],
4440
+ type: "boolean"
4441
+ },
4442
+ message: {
4443
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4444
+ type: "string"
4445
+ }
4341
4446
  },
4342
4447
  required: ["message", "is_access_code_error", "error_code"],
4343
4448
  type: "object"
@@ -4345,14 +4450,25 @@ var openapi_default = {
4345
4450
  {
4346
4451
  description: "Igloohome bridge has too many pending jobs in the queue.",
4347
4452
  properties: {
4348
- created_at: { format: "date-time", type: "string" },
4453
+ created_at: {
4454
+ description: "Date and time at which Seam created the error.",
4455
+ format: "date-time",
4456
+ type: "string"
4457
+ },
4349
4458
  error_code: {
4350
4459
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4351
4460
  enum: ["igloohome_bridge_too_many_pending_jobs"],
4352
4461
  type: "string"
4353
4462
  },
4354
- is_access_code_error: { enum: [true], type: "boolean" },
4355
- message: { type: "string" }
4463
+ is_access_code_error: {
4464
+ description: "Indicates that this is an access code error.",
4465
+ enum: [true],
4466
+ type: "boolean"
4467
+ },
4468
+ message: {
4469
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4470
+ type: "string"
4471
+ }
4356
4472
  },
4357
4473
  required: ["message", "is_access_code_error", "error_code"],
4358
4474
  type: "object"
@@ -4360,22 +4476,37 @@ var openapi_default = {
4360
4476
  {
4361
4477
  description: "Igloohome bridge is offline.",
4362
4478
  properties: {
4363
- created_at: { format: "date-time", type: "string" },
4479
+ created_at: {
4480
+ description: "Date and time at which Seam created the error.",
4481
+ format: "date-time",
4482
+ type: "string"
4483
+ },
4364
4484
  error_code: {
4365
4485
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4366
4486
  enum: ["igloohome_bridge_offline"],
4367
4487
  type: "string"
4368
4488
  },
4369
- is_access_code_error: { enum: [true], type: "boolean" },
4370
- message: { type: "string" }
4489
+ is_access_code_error: {
4490
+ description: "Indicates that this is an access code error.",
4491
+ enum: [true],
4492
+ type: "boolean"
4493
+ },
4494
+ message: {
4495
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4496
+ type: "string"
4497
+ }
4371
4498
  },
4372
4499
  required: ["message", "is_access_code_error", "error_code"],
4373
4500
  type: "object"
4374
4501
  },
4375
4502
  {
4376
- description: "Lock as reached max amount of codes.",
4503
+ description: "Lock has reached maximum amount of codes.",
4377
4504
  properties: {
4378
- created_at: { format: "date-time", type: "string" },
4505
+ created_at: {
4506
+ description: "Date and time at which Seam created the error.",
4507
+ format: "date-time",
4508
+ type: "string"
4509
+ },
4379
4510
  error_code: {
4380
4511
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4381
4512
  enum: [
@@ -4383,23 +4514,41 @@ var openapi_default = {
4383
4514
  ],
4384
4515
  type: "string"
4385
4516
  },
4386
- is_access_code_error: { enum: [true], type: "boolean" },
4387
- message: { type: "string" }
4517
+ is_access_code_error: {
4518
+ description: "Indicates that this is an access code error.",
4519
+ enum: [true],
4520
+ type: "boolean"
4521
+ },
4522
+ message: {
4523
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4524
+ type: "string"
4525
+ }
4388
4526
  },
4389
4527
  required: ["message", "is_access_code_error", "error_code"],
4390
4528
  type: "object"
4391
4529
  },
4392
4530
  {
4393
- description: "Unable to confirm the access code is set on Kwikset device.",
4531
+ description: "Unable to confirm that the access code is set on Kwikset device.",
4394
4532
  properties: {
4395
- created_at: { format: "date-time", type: "string" },
4533
+ created_at: {
4534
+ description: "Date and time at which Seam created the error.",
4535
+ format: "date-time",
4536
+ type: "string"
4537
+ },
4396
4538
  error_code: {
4397
4539
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4398
4540
  enum: ["kwikset_unable_to_confirm_code"],
4399
4541
  type: "string"
4400
4542
  },
4401
- is_access_code_error: { enum: [true], type: "boolean" },
4402
- message: { type: "string" }
4543
+ is_access_code_error: {
4544
+ description: "Indicates that this is an access code error.",
4545
+ enum: [true],
4546
+ type: "boolean"
4547
+ },
4548
+ message: {
4549
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4550
+ type: "string"
4551
+ }
4403
4552
  },
4404
4553
  required: ["message", "is_access_code_error", "error_code"],
4405
4554
  type: "object"
@@ -4407,14 +4556,25 @@ var openapi_default = {
4407
4556
  {
4408
4557
  description: "Unable to confirm the deletion of the access code on Kwikset device.",
4409
4558
  properties: {
4410
- created_at: { format: "date-time", type: "string" },
4559
+ created_at: {
4560
+ description: "Date and time at which Seam created the error.",
4561
+ format: "date-time",
4562
+ type: "string"
4563
+ },
4411
4564
  error_code: {
4412
4565
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4413
4566
  enum: ["kwikset_unable_to_confirm_deletion"],
4414
4567
  type: "string"
4415
4568
  },
4416
- is_access_code_error: { enum: [true], type: "boolean" },
4417
- message: { type: "string" }
4569
+ is_access_code_error: {
4570
+ description: "Indicates that this is an access code error.",
4571
+ enum: [true],
4572
+ type: "boolean"
4573
+ },
4574
+ message: {
4575
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4576
+ type: "string"
4577
+ }
4418
4578
  },
4419
4579
  required: ["message", "is_access_code_error", "error_code"],
4420
4580
  type: "object"
@@ -4422,14 +4582,25 @@ var openapi_default = {
4422
4582
  {
4423
4583
  description: "Code was modified or removed externally after Seam successfully set it on the device.",
4424
4584
  properties: {
4425
- created_at: { format: "date-time", type: "string" },
4585
+ created_at: {
4586
+ description: "Date and time at which Seam created the error.",
4587
+ format: "date-time",
4588
+ type: "string"
4589
+ },
4426
4590
  error_code: {
4427
4591
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4428
4592
  enum: ["code_modified_external_to_seam"],
4429
4593
  type: "string"
4430
4594
  },
4431
- is_access_code_error: { enum: [true], type: "boolean" },
4432
- message: { type: "string" }
4595
+ is_access_code_error: {
4596
+ description: "Indicates that this is an access code error.",
4597
+ enum: [true],
4598
+ type: "boolean"
4599
+ },
4600
+ message: {
4601
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4602
+ type: "string"
4603
+ }
4433
4604
  },
4434
4605
  required: ["message", "is_access_code_error", "error_code"],
4435
4606
  type: "object"
@@ -4437,14 +4608,25 @@ var openapi_default = {
4437
4608
  {
4438
4609
  description: "Invalid code length for August lock.",
4439
4610
  properties: {
4440
- created_at: { format: "date-time", type: "string" },
4611
+ created_at: {
4612
+ description: "Date and time at which Seam created the error.",
4613
+ format: "date-time",
4614
+ type: "string"
4615
+ },
4441
4616
  error_code: {
4442
4617
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4443
4618
  enum: ["august_lock_invalid_code_length"],
4444
4619
  type: "string"
4445
4620
  },
4446
- is_access_code_error: { enum: [true], type: "boolean" },
4447
- message: { type: "string" }
4621
+ is_access_code_error: {
4622
+ description: "Indicates that this is an access code error.",
4623
+ enum: [true],
4624
+ type: "boolean"
4625
+ },
4626
+ message: {
4627
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4628
+ type: "string"
4629
+ }
4448
4630
  },
4449
4631
  required: ["message", "is_access_code_error", "error_code"],
4450
4632
  type: "object"
@@ -4452,14 +4634,25 @@ var openapi_default = {
4452
4634
  {
4453
4635
  description: "Access code has not yet been fully moved to the device.",
4454
4636
  properties: {
4455
- created_at: { format: "date-time", type: "string" },
4637
+ created_at: {
4638
+ description: "Date and time at which Seam created the error.",
4639
+ format: "date-time",
4640
+ type: "string"
4641
+ },
4456
4642
  error_code: {
4457
4643
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4458
4644
  enum: ["august_device_programming_delay"],
4459
4645
  type: "string"
4460
4646
  },
4461
- is_access_code_error: { enum: [true], type: "boolean" },
4462
- message: { type: "string" }
4647
+ is_access_code_error: {
4648
+ description: "Indicates that this is an access code error.",
4649
+ enum: [true],
4650
+ type: "boolean"
4651
+ },
4652
+ message: {
4653
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4654
+ type: "string"
4655
+ }
4463
4656
  },
4464
4657
  required: ["message", "is_access_code_error", "error_code"],
4465
4658
  type: "object"
@@ -4467,14 +4660,25 @@ var openapi_default = {
4467
4660
  {
4468
4661
  description: "All access code slots on the device are full.",
4469
4662
  properties: {
4470
- created_at: { format: "date-time", type: "string" },
4663
+ created_at: {
4664
+ description: "Date and time at which Seam created the error.",
4665
+ format: "date-time",
4666
+ type: "string"
4667
+ },
4471
4668
  error_code: {
4472
4669
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4473
4670
  enum: ["august_device_slots_full"],
4474
4671
  type: "string"
4475
4672
  },
4476
- is_access_code_error: { enum: [true], type: "boolean" },
4477
- message: { type: "string" }
4673
+ is_access_code_error: {
4674
+ description: "Indicates that this is an access code error.",
4675
+ enum: [true],
4676
+ type: "boolean"
4677
+ },
4678
+ message: {
4679
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4680
+ type: "string"
4681
+ }
4478
4682
  },
4479
4683
  required: ["message", "is_access_code_error", "error_code"],
4480
4684
  type: "object"
@@ -4482,14 +4686,25 @@ var openapi_default = {
4482
4686
  {
4483
4687
  description: "August lock is missing a keypad.",
4484
4688
  properties: {
4485
- created_at: { format: "date-time", type: "string" },
4486
- error_code: {
4487
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4689
+ created_at: {
4690
+ description: "Date and time at which Seam created the error.",
4691
+ format: "date-time",
4692
+ type: "string"
4693
+ },
4694
+ error_code: {
4695
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4488
4696
  enum: ["august_lock_missing_keypad"],
4489
4697
  type: "string"
4490
4698
  },
4491
- is_access_code_error: { enum: [true], type: "boolean" },
4492
- message: { type: "string" }
4699
+ is_access_code_error: {
4700
+ description: "Indicates that this is an access code error.",
4701
+ enum: [true],
4702
+ type: "boolean"
4703
+ },
4704
+ message: {
4705
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4706
+ type: "string"
4707
+ }
4493
4708
  },
4494
4709
  required: ["message", "is_access_code_error", "error_code"],
4495
4710
  type: "object"
@@ -4497,14 +4712,25 @@ var openapi_default = {
4497
4712
  {
4498
4713
  description: "August lock is temporarily offline.",
4499
4714
  properties: {
4500
- created_at: { format: "date-time", type: "string" },
4715
+ created_at: {
4716
+ description: "Date and time at which Seam created the error.",
4717
+ format: "date-time",
4718
+ type: "string"
4719
+ },
4501
4720
  error_code: {
4502
4721
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4503
4722
  enum: ["august_lock_temporarily_offline"],
4504
4723
  type: "string"
4505
4724
  },
4506
- is_access_code_error: { enum: [true], type: "boolean" },
4507
- message: { type: "string" }
4725
+ is_access_code_error: {
4726
+ description: "Indicates that this is an access code error.",
4727
+ enum: [true],
4728
+ type: "boolean"
4729
+ },
4730
+ message: {
4731
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4732
+ type: "string"
4733
+ }
4508
4734
  },
4509
4735
  required: ["message", "is_access_code_error", "error_code"],
4510
4736
  type: "object"
@@ -4512,14 +4738,25 @@ var openapi_default = {
4512
4738
  {
4513
4739
  description: "Salto site user is not subscribed.",
4514
4740
  properties: {
4515
- created_at: { format: "date-time", type: "string" },
4741
+ created_at: {
4742
+ description: "Date and time at which Seam created the error.",
4743
+ format: "date-time",
4744
+ type: "string"
4745
+ },
4516
4746
  error_code: {
4517
4747
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4518
4748
  enum: ["salto_ks_user_not_subscribed"],
4519
4749
  type: "string"
4520
4750
  },
4521
- is_access_code_error: { enum: [true], type: "boolean" },
4522
- message: { type: "string" }
4751
+ is_access_code_error: {
4752
+ description: "Indicates that this is an access code error.",
4753
+ enum: [true],
4754
+ type: "boolean"
4755
+ },
4756
+ message: {
4757
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4758
+ type: "string"
4759
+ }
4523
4760
  },
4524
4761
  required: ["message", "is_access_code_error", "error_code"],
4525
4762
  type: "object"
@@ -4527,14 +4764,25 @@ var openapi_default = {
4527
4764
  {
4528
4765
  description: "Access code has not yet been fully moved to the device.",
4529
4766
  properties: {
4530
- created_at: { format: "date-time", type: "string" },
4767
+ created_at: {
4768
+ description: "Date and time at which Seam created the error.",
4769
+ format: "date-time",
4770
+ type: "string"
4771
+ },
4531
4772
  error_code: {
4532
4773
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4533
4774
  enum: ["hubitat_device_programming_delay"],
4534
4775
  type: "string"
4535
4776
  },
4536
- is_access_code_error: { enum: [true], type: "boolean" },
4537
- message: { type: "string" }
4777
+ is_access_code_error: {
4778
+ description: "Indicates that this is an access code error.",
4779
+ enum: [true],
4780
+ type: "boolean"
4781
+ },
4782
+ message: {
4783
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4784
+ type: "string"
4785
+ }
4538
4786
  },
4539
4787
  required: ["message", "is_access_code_error", "error_code"],
4540
4788
  type: "object"
@@ -4542,14 +4790,25 @@ var openapi_default = {
4542
4790
  {
4543
4791
  description: "No free positions available on the device.",
4544
4792
  properties: {
4545
- created_at: { format: "date-time", type: "string" },
4793
+ created_at: {
4794
+ description: "Date and time at which Seam created the error.",
4795
+ format: "date-time",
4796
+ type: "string"
4797
+ },
4546
4798
  error_code: {
4547
4799
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4548
4800
  enum: ["hubitat_no_free_positions_available"],
4549
4801
  type: "string"
4550
4802
  },
4551
- is_access_code_error: { enum: [true], type: "boolean" },
4552
- message: { type: "string" }
4803
+ is_access_code_error: {
4804
+ description: "Indicates that this is an access code error.",
4805
+ enum: [true],
4806
+ type: "boolean"
4807
+ },
4808
+ message: {
4809
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4810
+ type: "string"
4811
+ }
4553
4812
  },
4554
4813
  required: ["message", "is_access_code_error", "error_code"],
4555
4814
  type: "object"
@@ -4557,14 +4816,25 @@ var openapi_default = {
4557
4816
  {
4558
4817
  description: "Duplicate access code name detected.",
4559
4818
  properties: {
4560
- created_at: { format: "date-time", type: "string" },
4819
+ created_at: {
4820
+ description: "Date and time at which Seam created the error.",
4821
+ format: "date-time",
4822
+ type: "string"
4823
+ },
4561
4824
  error_code: {
4562
4825
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4563
4826
  enum: ["wyze_duplicate_code_name"],
4564
4827
  type: "string"
4565
4828
  },
4566
- is_access_code_error: { enum: [true], type: "boolean" },
4567
- message: { type: "string" }
4829
+ is_access_code_error: {
4830
+ description: "Indicates that this is an access code error.",
4831
+ enum: [true],
4832
+ type: "boolean"
4833
+ },
4834
+ message: {
4835
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4836
+ type: "string"
4837
+ }
4568
4838
  },
4569
4839
  required: ["message", "is_access_code_error", "error_code"],
4570
4840
  type: "object"
@@ -4572,14 +4842,25 @@ var openapi_default = {
4572
4842
  {
4573
4843
  description: "Potential duplicate access code detected.",
4574
4844
  properties: {
4575
- created_at: { format: "date-time", type: "string" },
4845
+ created_at: {
4846
+ description: "Date and time at which Seam created the error.",
4847
+ format: "date-time",
4848
+ type: "string"
4849
+ },
4576
4850
  error_code: {
4577
4851
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4578
4852
  enum: ["wyze_potential_duplicate_code"],
4579
4853
  type: "string"
4580
4854
  },
4581
- is_access_code_error: { enum: [true], type: "boolean" },
4582
- message: { type: "string" }
4855
+ is_access_code_error: {
4856
+ description: "Indicates that this is an access code error.",
4857
+ enum: [true],
4858
+ type: "boolean"
4859
+ },
4860
+ message: {
4861
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4862
+ type: "string"
4863
+ }
4583
4864
  },
4584
4865
  required: ["message", "is_access_code_error", "error_code"],
4585
4866
  type: "object"
@@ -4587,14 +4868,25 @@ var openapi_default = {
4587
4868
  {
4588
4869
  description: "No valid user level for Oracode.",
4589
4870
  properties: {
4590
- created_at: { format: "date-time", type: "string" },
4871
+ created_at: {
4872
+ description: "Date and time at which Seam created the error.",
4873
+ format: "date-time",
4874
+ type: "string"
4875
+ },
4591
4876
  error_code: {
4592
4877
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4593
4878
  enum: ["dormakaba_oracode_no_valid_user_level"],
4594
4879
  type: "string"
4595
4880
  },
4596
- is_access_code_error: { enum: [true], type: "boolean" },
4597
- message: { type: "string" }
4881
+ is_access_code_error: {
4882
+ description: "Indicates that this is an access code error.",
4883
+ enum: [true],
4884
+ type: "boolean"
4885
+ },
4886
+ message: {
4887
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
4888
+ type: "string"
4889
+ }
4598
4890
  },
4599
4891
  required: ["message", "is_access_code_error", "error_code"],
4600
4892
  type: "object"
@@ -4931,11 +5223,11 @@ var openapi_default = {
4931
5223
  type: "boolean"
4932
5224
  },
4933
5225
  is_offline_access_code: {
4934
- description: '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.',
5226
+ description: "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.",
4935
5227
  type: "boolean"
4936
5228
  },
4937
5229
  is_one_time_use: {
4938
- description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
5230
+ description: "Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.",
4939
5231
  type: "boolean"
4940
5232
  },
4941
5233
  is_scheduled_on_device: {
@@ -4964,25 +5256,33 @@ var openapi_default = {
4964
5256
  type: "string"
4965
5257
  },
4966
5258
  status: {
4967
- description: '\n 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.\n ',
5259
+ description: "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.",
4968
5260
  enum: ["setting", "set", "unset", "removing", "unknown"],
4969
5261
  type: "string"
4970
5262
  },
4971
5263
  type: {
4972
- description: '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.',
5264
+ description: "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.",
4973
5265
  enum: ["time_bound", "ongoing"],
4974
5266
  type: "string"
4975
5267
  },
4976
5268
  warnings: {
4977
- description: '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.',
5269
+ description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
4978
5270
  items: {
5271
+ description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
4979
5272
  discriminator: { propertyName: "warning_code" },
4980
5273
  oneOf: [
4981
5274
  {
4982
- description: "Failed to set code on Smart Things device.",
5275
+ description: "Failed to set code on SmartThings device.",
4983
5276
  properties: {
4984
- created_at: { format: "date-time", type: "string" },
4985
- message: { type: "string" },
5277
+ created_at: {
5278
+ description: "Date and time at which Seam created the warning.",
5279
+ format: "date-time",
5280
+ type: "string"
5281
+ },
5282
+ message: {
5283
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5284
+ type: "string"
5285
+ },
4986
5286
  warning_code: {
4987
5287
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
4988
5288
  enum: ["smartthings_failed_to_set_access_code"],
@@ -4995,8 +5295,15 @@ var openapi_default = {
4995
5295
  {
4996
5296
  description: "Duplicate access code detected.",
4997
5297
  properties: {
4998
- created_at: { format: "date-time", type: "string" },
4999
- message: { type: "string" },
5298
+ created_at: {
5299
+ description: "Date and time at which Seam created the warning.",
5300
+ format: "date-time",
5301
+ type: "string"
5302
+ },
5303
+ message: {
5304
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5305
+ type: "string"
5306
+ },
5000
5307
  warning_code: {
5001
5308
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5002
5309
  enum: ["schlage_detected_duplicate"],
@@ -5009,8 +5316,15 @@ var openapi_default = {
5009
5316
  {
5010
5317
  description: "Received an error when attempting to create this code.",
5011
5318
  properties: {
5012
- created_at: { format: "date-time", type: "string" },
5013
- message: { type: "string" },
5319
+ created_at: {
5320
+ description: "Date and time at which Seam created the warning.",
5321
+ format: "date-time",
5322
+ type: "string"
5323
+ },
5324
+ message: {
5325
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5326
+ type: "string"
5327
+ },
5014
5328
  warning_code: {
5015
5329
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5016
5330
  enum: ["schlage_creation_outage"],
@@ -5023,8 +5337,15 @@ var openapi_default = {
5023
5337
  {
5024
5338
  description: "Code was modified or removed externally after Seam successfully set it on the device.",
5025
5339
  properties: {
5026
- created_at: { format: "date-time", type: "string" },
5027
- message: { type: "string" },
5340
+ created_at: {
5341
+ description: "Date and time at which Seam created the warning.",
5342
+ format: "date-time",
5343
+ type: "string"
5344
+ },
5345
+ message: {
5346
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5347
+ type: "string"
5348
+ },
5028
5349
  warning_code: {
5029
5350
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5030
5351
  enum: ["code_modified_external_to_seam"],
@@ -5037,8 +5358,15 @@ var openapi_default = {
5037
5358
  {
5038
5359
  description: "Delay in setting code on device.",
5039
5360
  properties: {
5040
- created_at: { format: "date-time", type: "string" },
5041
- message: { type: "string" },
5361
+ created_at: {
5362
+ description: "Date and time at which Seam created the warning.",
5363
+ format: "date-time",
5364
+ type: "string"
5365
+ },
5366
+ message: {
5367
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5368
+ type: "string"
5369
+ },
5042
5370
  warning_code: {
5043
5371
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5044
5372
  enum: ["delay_in_setting_on_device"],
@@ -5051,8 +5379,15 @@ var openapi_default = {
5051
5379
  {
5052
5380
  description: "Delay in removing code from device.",
5053
5381
  properties: {
5054
- created_at: { format: "date-time", type: "string" },
5055
- message: { type: "string" },
5382
+ created_at: {
5383
+ description: "Date and time at which Seam created the warning.",
5384
+ format: "date-time",
5385
+ type: "string"
5386
+ },
5387
+ message: {
5388
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5389
+ type: "string"
5390
+ },
5056
5391
  warning_code: {
5057
5392
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5058
5393
  enum: ["delay_in_removing_from_device"],
@@ -5063,10 +5398,17 @@ var openapi_default = {
5063
5398
  type: "object"
5064
5399
  },
5065
5400
  {
5066
- description: "Third party integration detected that may cause access codes to fail.",
5401
+ description: "Third-party integration detected that may cause access codes to fail.",
5067
5402
  properties: {
5068
- created_at: { format: "date-time", type: "string" },
5069
- message: { type: "string" },
5403
+ created_at: {
5404
+ description: "Date and time at which Seam created the warning.",
5405
+ format: "date-time",
5406
+ type: "string"
5407
+ },
5408
+ message: {
5409
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5410
+ type: "string"
5411
+ },
5070
5412
  warning_code: {
5071
5413
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5072
5414
  enum: ["third_party_integration_detected"],
@@ -5079,8 +5421,15 @@ var openapi_default = {
5079
5421
  {
5080
5422
  description: "Access code has not yet been fully moved to the device.",
5081
5423
  properties: {
5082
- created_at: { format: "date-time", type: "string" },
5083
- message: { type: "string" },
5424
+ created_at: {
5425
+ description: "Date and time at which Seam created the warning.",
5426
+ format: "date-time",
5427
+ type: "string"
5428
+ },
5429
+ message: {
5430
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5431
+ type: "string"
5432
+ },
5084
5433
  warning_code: {
5085
5434
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5086
5435
  enum: ["august_device_programming_delay"],
@@ -5093,8 +5442,15 @@ var openapi_default = {
5093
5442
  {
5094
5443
  description: "August lock is temporarily offline.",
5095
5444
  properties: {
5096
- created_at: { format: "date-time", type: "string" },
5097
- message: { type: "string" },
5445
+ created_at: {
5446
+ description: "Date and time at which Seam created the warning.",
5447
+ format: "date-time",
5448
+ type: "string"
5449
+ },
5450
+ message: {
5451
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5452
+ type: "string"
5453
+ },
5098
5454
  warning_code: {
5099
5455
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
5100
5456
  enum: ["august_lock_temporarily_offline"],
@@ -5107,8 +5463,15 @@ var openapi_default = {
5107
5463
  {
5108
5464
  description: "Algopins must be used within 24 hours.",
5109
5465
  properties: {
5110
- created_at: { format: "date-time", type: "string" },
5111
- message: { type: "string" },
5466
+ created_at: {
5467
+ description: "Date and time at which Seam created the warning.",
5468
+ format: "date-time",
5469
+ type: "string"
5470
+ },
5471
+ message: {
5472
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5473
+ type: "string"
5474
+ },
5112
5475
  warning_code: {
5113
5476
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5114
5477
  enum: ["igloo_algopin_must_be_used_within_24_hours"],
@@ -5121,8 +5484,15 @@ var openapi_default = {
5121
5484
  {
5122
5485
  description: "Management was transferred to another workspace.",
5123
5486
  properties: {
5124
- created_at: { format: "date-time", type: "string" },
5125
- message: { type: "string" },
5487
+ created_at: {
5488
+ description: "Date and time at which Seam created the warning.",
5489
+ format: "date-time",
5490
+ type: "string"
5491
+ },
5492
+ message: {
5493
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5494
+ type: "string"
5495
+ },
5126
5496
  warning_code: {
5127
5497
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5128
5498
  enum: ["management_transferred"],
@@ -5133,10 +5503,17 @@ var openapi_default = {
5133
5503
  type: "object"
5134
5504
  },
5135
5505
  {
5136
- description: "Unable to confirm the access code is set on Kwikset device.",
5506
+ description: "Unable to confirm that the access code is set on Kwikset device.",
5137
5507
  properties: {
5138
- created_at: { format: "date-time", type: "string" },
5139
- message: { type: "string" },
5508
+ created_at: {
5509
+ description: "Date and time at which Seam created the warning.",
5510
+ format: "date-time",
5511
+ type: "string"
5512
+ },
5513
+ message: {
5514
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5515
+ type: "string"
5516
+ },
5140
5517
  warning_code: {
5141
5518
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5142
5519
  enum: ["kwikset_unable_to_confirm_code"],
@@ -6425,23 +6802,30 @@ var openapi_default = {
6425
6802
  type: "string",
6426
6803
  "x-undocumented": "Only used internally."
6427
6804
  },
6428
- pending_modifications: {
6805
+ pending_mutations: {
6429
6806
  items: {
6430
- discriminator: { propertyName: "modification_code" },
6807
+ discriminator: { propertyName: "mutation_code" },
6431
6808
  oneOf: [
6432
6809
  {
6433
6810
  properties: {
6434
6811
  created_at: { format: "date-time", type: "string" },
6435
- modification_code: { enum: ["create"], type: "string" }
6812
+ mutation_code: { enum: ["creating"], type: "string" }
6813
+ },
6814
+ required: ["created_at", "mutation_code"],
6815
+ type: "object"
6816
+ },
6817
+ {
6818
+ properties: {
6819
+ created_at: { format: "date-time", type: "string" },
6820
+ mutation_code: { enum: ["deleting"], type: "string" }
6436
6821
  },
6437
- required: ["created_at", "modification_code"],
6822
+ required: ["created_at", "mutation_code"],
6438
6823
  type: "object"
6439
6824
  },
6440
6825
  {
6441
6826
  properties: {
6442
6827
  created_at: { format: "date-time", type: "string" },
6443
- modification_code: { enum: ["profile"], type: "string" },
6444
- modified_from: {
6828
+ from: {
6445
6829
  properties: {
6446
6830
  email_address: {
6447
6831
  format: "email",
@@ -6453,7 +6837,11 @@ var openapi_default = {
6453
6837
  },
6454
6838
  type: "object"
6455
6839
  },
6456
- modified_to: {
6840
+ mutation_code: {
6841
+ enum: ["updating_user_information"],
6842
+ type: "string"
6843
+ },
6844
+ to: {
6457
6845
  properties: {
6458
6846
  email_address: {
6459
6847
  format: "email",
@@ -6466,22 +6854,13 @@ var openapi_default = {
6466
6854
  type: "object"
6467
6855
  }
6468
6856
  },
6469
- required: [
6470
- "created_at",
6471
- "modification_code",
6472
- "modified_from",
6473
- "modified_to"
6474
- ],
6857
+ required: ["created_at", "mutation_code", "from", "to"],
6475
6858
  type: "object"
6476
6859
  },
6477
6860
  {
6478
6861
  properties: {
6479
6862
  created_at: { format: "date-time", type: "string" },
6480
- modification_code: {
6481
- enum: ["access_schedule"],
6482
- type: "string"
6483
- },
6484
- modified_from: {
6863
+ from: {
6485
6864
  properties: {
6486
6865
  ends_at: {
6487
6866
  description: "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.",
@@ -6498,7 +6877,11 @@ var openapi_default = {
6498
6877
  required: ["starts_at", "ends_at"],
6499
6878
  type: "object"
6500
6879
  },
6501
- modified_to: {
6880
+ mutation_code: {
6881
+ enum: ["updating_access_schedule"],
6882
+ type: "string"
6883
+ },
6884
+ to: {
6502
6885
  properties: {
6503
6886
  ends_at: {
6504
6887
  description: "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.",
@@ -6516,48 +6899,34 @@ var openapi_default = {
6516
6899
  type: "object"
6517
6900
  }
6518
6901
  },
6519
- required: [
6520
- "created_at",
6521
- "modification_code",
6522
- "modified_from",
6523
- "modified_to"
6524
- ],
6902
+ required: ["created_at", "mutation_code", "from", "to"],
6525
6903
  type: "object"
6526
6904
  },
6527
6905
  {
6528
6906
  properties: {
6529
6907
  created_at: { format: "date-time", type: "string" },
6530
- modification_code: {
6531
- enum: ["suspension_state"],
6532
- type: "string"
6533
- },
6534
- modified_from: {
6908
+ from: {
6535
6909
  properties: { is_suspended: { type: "boolean" } },
6536
6910
  required: ["is_suspended"],
6537
6911
  type: "object"
6538
6912
  },
6539
- modified_to: {
6913
+ mutation_code: {
6914
+ enum: ["updating_suspension_state"],
6915
+ type: "string"
6916
+ },
6917
+ to: {
6540
6918
  properties: { is_suspended: { type: "boolean" } },
6541
6919
  required: ["is_suspended"],
6542
6920
  type: "object"
6543
6921
  }
6544
6922
  },
6545
- required: [
6546
- "created_at",
6547
- "modification_code",
6548
- "modified_from",
6549
- "modified_to"
6550
- ],
6923
+ required: ["created_at", "mutation_code", "from", "to"],
6551
6924
  type: "object"
6552
6925
  },
6553
6926
  {
6554
6927
  properties: {
6555
6928
  created_at: { format: "date-time", type: "string" },
6556
- modification_code: {
6557
- enum: ["acs_access_group_membership"],
6558
- type: "string"
6559
- },
6560
- modified_from: {
6929
+ from: {
6561
6930
  properties: {
6562
6931
  acs_access_group_id: {
6563
6932
  format: "uuid",
@@ -6568,7 +6937,11 @@ var openapi_default = {
6568
6937
  required: ["acs_access_group_id"],
6569
6938
  type: "object"
6570
6939
  },
6571
- modified_to: {
6940
+ mutation_code: {
6941
+ enum: ["updating_group_membership"],
6942
+ type: "string"
6943
+ },
6944
+ to: {
6572
6945
  properties: {
6573
6946
  acs_access_group_id: {
6574
6947
  format: "uuid",
@@ -6580,12 +6953,7 @@ var openapi_default = {
6580
6953
  type: "object"
6581
6954
  }
6582
6955
  },
6583
- required: [
6584
- "created_at",
6585
- "modification_code",
6586
- "modified_from",
6587
- "modified_to"
6588
- ],
6956
+ required: ["created_at", "mutation_code", "from", "to"],
6589
6957
  type: "object"
6590
6958
  }
6591
6959
  ]
@@ -16546,6 +16914,7 @@ var openapi_default = {
16546
16914
  "x-route-path": "/thermostats/schedules"
16547
16915
  },
16548
16916
  unmanaged_access_code: {
16917
+ description: "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn 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.\n\nWhen 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.\n\nPrior 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.",
16549
16918
  properties: {
16550
16919
  access_code_id: {
16551
16920
  description: "Unique identifier for the access code.",
@@ -16574,21 +16943,32 @@ var openapi_default = {
16574
16943
  type: "string"
16575
16944
  },
16576
16945
  errors: {
16577
- description: '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.',
16946
+ description: "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
16578
16947
  items: {
16579
16948
  discriminator: { propertyName: "error_code" },
16580
16949
  oneOf: [
16581
16950
  {
16582
- description: "Failed to set code on Smart Things device.",
16951
+ description: "Failed to set code on SmartThings device.",
16583
16952
  properties: {
16584
- created_at: { format: "date-time", type: "string" },
16953
+ created_at: {
16954
+ description: "Date and time at which Seam created the error.",
16955
+ format: "date-time",
16956
+ type: "string"
16957
+ },
16585
16958
  error_code: {
16586
16959
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16587
16960
  enum: ["smartthings_failed_to_set_access_code"],
16588
16961
  type: "string"
16589
16962
  },
16590
- is_access_code_error: { enum: [true], type: "boolean" },
16591
- message: { type: "string" }
16963
+ is_access_code_error: {
16964
+ description: "Indicates that this is an access code error.",
16965
+ enum: [true],
16966
+ type: "boolean"
16967
+ },
16968
+ message: {
16969
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
16970
+ type: "string"
16971
+ }
16592
16972
  },
16593
16973
  required: ["message", "is_access_code_error", "error_code"],
16594
16974
  type: "object"
@@ -16596,7 +16976,11 @@ var openapi_default = {
16596
16976
  {
16597
16977
  description: "Failed to set code after multiple retries.",
16598
16978
  properties: {
16599
- created_at: { format: "date-time", type: "string" },
16979
+ created_at: {
16980
+ description: "Date and time at which Seam created the error.",
16981
+ format: "date-time",
16982
+ type: "string"
16983
+ },
16600
16984
  error_code: {
16601
16985
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16602
16986
  enum: [
@@ -16604,8 +16988,15 @@ var openapi_default = {
16604
16988
  ],
16605
16989
  type: "string"
16606
16990
  },
16607
- is_access_code_error: { enum: [true], type: "boolean" },
16608
- message: { type: "string" }
16991
+ is_access_code_error: {
16992
+ description: "Indicates that this is an access code error.",
16993
+ enum: [true],
16994
+ type: "boolean"
16995
+ },
16996
+ message: {
16997
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
16998
+ type: "string"
16999
+ }
16609
17000
  },
16610
17001
  required: ["message", "is_access_code_error", "error_code"],
16611
17002
  type: "object"
@@ -16613,14 +17004,25 @@ var openapi_default = {
16613
17004
  {
16614
17005
  description: "No free slots available on the device.",
16615
17006
  properties: {
16616
- created_at: { format: "date-time", type: "string" },
17007
+ created_at: {
17008
+ description: "Date and time at which Seam created the error.",
17009
+ format: "date-time",
17010
+ type: "string"
17011
+ },
16617
17012
  error_code: {
16618
17013
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16619
17014
  enum: ["smartthings_no_free_slots_available"],
16620
17015
  type: "string"
16621
17016
  },
16622
- is_access_code_error: { enum: [true], type: "boolean" },
16623
- message: { type: "string" }
17017
+ is_access_code_error: {
17018
+ description: "Indicates that this is an access code error.",
17019
+ enum: [true],
17020
+ type: "boolean"
17021
+ },
17022
+ message: {
17023
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17024
+ type: "string"
17025
+ }
16624
17026
  },
16625
17027
  required: ["message", "is_access_code_error", "error_code"],
16626
17028
  type: "object"
@@ -16628,14 +17030,25 @@ var openapi_default = {
16628
17030
  {
16629
17031
  description: "Failed to set code on device.",
16630
17032
  properties: {
16631
- created_at: { format: "date-time", type: "string" },
17033
+ created_at: {
17034
+ description: "Date and time at which Seam created the error.",
17035
+ format: "date-time",
17036
+ type: "string"
17037
+ },
16632
17038
  error_code: {
16633
17039
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16634
17040
  enum: ["failed_to_set_on_device"],
16635
17041
  type: "string"
16636
17042
  },
16637
- is_access_code_error: { enum: [true], type: "boolean" },
16638
- message: { type: "string" }
17043
+ is_access_code_error: {
17044
+ description: "Indicates that this is an access code error.",
17045
+ enum: [true],
17046
+ type: "boolean"
17047
+ },
17048
+ message: {
17049
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17050
+ type: "string"
17051
+ }
16639
17052
  },
16640
17053
  required: ["message", "is_access_code_error", "error_code"],
16641
17054
  type: "object"
@@ -16643,14 +17056,25 @@ var openapi_default = {
16643
17056
  {
16644
17057
  description: "Failed to remove code from device.",
16645
17058
  properties: {
16646
- created_at: { format: "date-time", type: "string" },
17059
+ created_at: {
17060
+ description: "Date and time at which Seam created the error.",
17061
+ format: "date-time",
17062
+ type: "string"
17063
+ },
16647
17064
  error_code: {
16648
17065
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16649
17066
  enum: ["failed_to_remove_from_device"],
16650
17067
  type: "string"
16651
17068
  },
16652
- is_access_code_error: { enum: [true], type: "boolean" },
16653
- message: { type: "string" }
17069
+ is_access_code_error: {
17070
+ description: "Indicates that this is an access code error.",
17071
+ enum: [true],
17072
+ type: "boolean"
17073
+ },
17074
+ message: {
17075
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17076
+ type: "string"
17077
+ }
16654
17078
  },
16655
17079
  required: ["message", "is_access_code_error", "error_code"],
16656
17080
  type: "object"
@@ -16658,14 +17082,25 @@ var openapi_default = {
16658
17082
  {
16659
17083
  description: "Duplicate access code detected on device.",
16660
17084
  properties: {
16661
- created_at: { format: "date-time", type: "string" },
17085
+ created_at: {
17086
+ description: "Date and time at which Seam created the error.",
17087
+ format: "date-time",
17088
+ type: "string"
17089
+ },
16662
17090
  error_code: {
16663
17091
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16664
17092
  enum: ["duplicate_code_on_device"],
16665
17093
  type: "string"
16666
17094
  },
16667
- is_access_code_error: { enum: [true], type: "boolean" },
16668
- message: { type: "string" }
17095
+ is_access_code_error: {
17096
+ description: "Indicates that this is an access code error.",
17097
+ enum: [true],
17098
+ type: "boolean"
17099
+ },
17100
+ message: {
17101
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17102
+ type: "string"
17103
+ }
16669
17104
  },
16670
17105
  required: ["message", "is_access_code_error", "error_code"],
16671
17106
  type: "object"
@@ -16673,14 +17108,25 @@ var openapi_default = {
16673
17108
  {
16674
17109
  description: "An attempt to modify this access code was prevented.",
16675
17110
  properties: {
16676
- created_at: { format: "date-time", type: "string" },
17111
+ created_at: {
17112
+ description: "Date and time at which Seam created the error.",
17113
+ format: "date-time",
17114
+ type: "string"
17115
+ },
16677
17116
  error_code: {
16678
17117
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16679
17118
  enum: ["duplicate_code_attempt_prevented"],
16680
17119
  type: "string"
16681
17120
  },
16682
- is_access_code_error: { enum: [true], type: "boolean" },
16683
- message: { type: "string" }
17121
+ is_access_code_error: {
17122
+ description: "Indicates that this is an access code error.",
17123
+ enum: [true],
17124
+ type: "boolean"
17125
+ },
17126
+ message: {
17127
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17128
+ type: "string"
17129
+ }
16684
17130
  },
16685
17131
  required: ["message", "is_access_code_error", "error_code"],
16686
17132
  type: "object"
@@ -16688,14 +17134,25 @@ var openapi_default = {
16688
17134
  {
16689
17135
  description: "Igloohome bridge has too many pending jobs in the queue.",
16690
17136
  properties: {
16691
- created_at: { format: "date-time", type: "string" },
17137
+ created_at: {
17138
+ description: "Date and time at which Seam created the error.",
17139
+ format: "date-time",
17140
+ type: "string"
17141
+ },
16692
17142
  error_code: {
16693
17143
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16694
17144
  enum: ["igloohome_bridge_too_many_pending_jobs"],
16695
17145
  type: "string"
16696
17146
  },
16697
- is_access_code_error: { enum: [true], type: "boolean" },
16698
- message: { type: "string" }
17147
+ is_access_code_error: {
17148
+ description: "Indicates that this is an access code error.",
17149
+ enum: [true],
17150
+ type: "boolean"
17151
+ },
17152
+ message: {
17153
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17154
+ type: "string"
17155
+ }
16699
17156
  },
16700
17157
  required: ["message", "is_access_code_error", "error_code"],
16701
17158
  type: "object"
@@ -16703,22 +17160,37 @@ var openapi_default = {
16703
17160
  {
16704
17161
  description: "Igloohome bridge is offline.",
16705
17162
  properties: {
16706
- created_at: { format: "date-time", type: "string" },
17163
+ created_at: {
17164
+ description: "Date and time at which Seam created the error.",
17165
+ format: "date-time",
17166
+ type: "string"
17167
+ },
16707
17168
  error_code: {
16708
17169
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16709
17170
  enum: ["igloohome_bridge_offline"],
16710
17171
  type: "string"
16711
17172
  },
16712
- is_access_code_error: { enum: [true], type: "boolean" },
16713
- message: { type: "string" }
17173
+ is_access_code_error: {
17174
+ description: "Indicates that this is an access code error.",
17175
+ enum: [true],
17176
+ type: "boolean"
17177
+ },
17178
+ message: {
17179
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17180
+ type: "string"
17181
+ }
16714
17182
  },
16715
17183
  required: ["message", "is_access_code_error", "error_code"],
16716
17184
  type: "object"
16717
17185
  },
16718
17186
  {
16719
- description: "Lock as reached max amount of codes.",
17187
+ description: "Lock has reached maximum amount of codes.",
16720
17188
  properties: {
16721
- created_at: { format: "date-time", type: "string" },
17189
+ created_at: {
17190
+ description: "Date and time at which Seam created the error.",
17191
+ format: "date-time",
17192
+ type: "string"
17193
+ },
16722
17194
  error_code: {
16723
17195
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16724
17196
  enum: [
@@ -16726,23 +17198,41 @@ var openapi_default = {
16726
17198
  ],
16727
17199
  type: "string"
16728
17200
  },
16729
- is_access_code_error: { enum: [true], type: "boolean" },
16730
- message: { type: "string" }
17201
+ is_access_code_error: {
17202
+ description: "Indicates that this is an access code error.",
17203
+ enum: [true],
17204
+ type: "boolean"
17205
+ },
17206
+ message: {
17207
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17208
+ type: "string"
17209
+ }
16731
17210
  },
16732
17211
  required: ["message", "is_access_code_error", "error_code"],
16733
17212
  type: "object"
16734
17213
  },
16735
17214
  {
16736
- description: "Unable to confirm the access code is set on Kwikset device.",
17215
+ description: "Unable to confirm that the access code is set on Kwikset device.",
16737
17216
  properties: {
16738
- created_at: { format: "date-time", type: "string" },
17217
+ created_at: {
17218
+ description: "Date and time at which Seam created the error.",
17219
+ format: "date-time",
17220
+ type: "string"
17221
+ },
16739
17222
  error_code: {
16740
17223
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16741
17224
  enum: ["kwikset_unable_to_confirm_code"],
16742
17225
  type: "string"
16743
17226
  },
16744
- is_access_code_error: { enum: [true], type: "boolean" },
16745
- message: { type: "string" }
17227
+ is_access_code_error: {
17228
+ description: "Indicates that this is an access code error.",
17229
+ enum: [true],
17230
+ type: "boolean"
17231
+ },
17232
+ message: {
17233
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17234
+ type: "string"
17235
+ }
16746
17236
  },
16747
17237
  required: ["message", "is_access_code_error", "error_code"],
16748
17238
  type: "object"
@@ -16750,14 +17240,25 @@ var openapi_default = {
16750
17240
  {
16751
17241
  description: "Unable to confirm the deletion of the access code on Kwikset device.",
16752
17242
  properties: {
16753
- created_at: { format: "date-time", type: "string" },
17243
+ created_at: {
17244
+ description: "Date and time at which Seam created the error.",
17245
+ format: "date-time",
17246
+ type: "string"
17247
+ },
16754
17248
  error_code: {
16755
17249
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16756
17250
  enum: ["kwikset_unable_to_confirm_deletion"],
16757
17251
  type: "string"
16758
17252
  },
16759
- is_access_code_error: { enum: [true], type: "boolean" },
16760
- message: { type: "string" }
17253
+ is_access_code_error: {
17254
+ description: "Indicates that this is an access code error.",
17255
+ enum: [true],
17256
+ type: "boolean"
17257
+ },
17258
+ message: {
17259
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17260
+ type: "string"
17261
+ }
16761
17262
  },
16762
17263
  required: ["message", "is_access_code_error", "error_code"],
16763
17264
  type: "object"
@@ -16765,14 +17266,25 @@ var openapi_default = {
16765
17266
  {
16766
17267
  description: "Code was modified or removed externally after Seam successfully set it on the device.",
16767
17268
  properties: {
16768
- created_at: { format: "date-time", type: "string" },
17269
+ created_at: {
17270
+ description: "Date and time at which Seam created the error.",
17271
+ format: "date-time",
17272
+ type: "string"
17273
+ },
16769
17274
  error_code: {
16770
17275
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16771
17276
  enum: ["code_modified_external_to_seam"],
16772
17277
  type: "string"
16773
17278
  },
16774
- is_access_code_error: { enum: [true], type: "boolean" },
16775
- message: { type: "string" }
17279
+ is_access_code_error: {
17280
+ description: "Indicates that this is an access code error.",
17281
+ enum: [true],
17282
+ type: "boolean"
17283
+ },
17284
+ message: {
17285
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17286
+ type: "string"
17287
+ }
16776
17288
  },
16777
17289
  required: ["message", "is_access_code_error", "error_code"],
16778
17290
  type: "object"
@@ -16780,14 +17292,25 @@ var openapi_default = {
16780
17292
  {
16781
17293
  description: "Invalid code length for August lock.",
16782
17294
  properties: {
16783
- created_at: { format: "date-time", type: "string" },
17295
+ created_at: {
17296
+ description: "Date and time at which Seam created the error.",
17297
+ format: "date-time",
17298
+ type: "string"
17299
+ },
16784
17300
  error_code: {
16785
17301
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16786
17302
  enum: ["august_lock_invalid_code_length"],
16787
17303
  type: "string"
16788
17304
  },
16789
- is_access_code_error: { enum: [true], type: "boolean" },
16790
- message: { type: "string" }
17305
+ is_access_code_error: {
17306
+ description: "Indicates that this is an access code error.",
17307
+ enum: [true],
17308
+ type: "boolean"
17309
+ },
17310
+ message: {
17311
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17312
+ type: "string"
17313
+ }
16791
17314
  },
16792
17315
  required: ["message", "is_access_code_error", "error_code"],
16793
17316
  type: "object"
@@ -16795,14 +17318,25 @@ var openapi_default = {
16795
17318
  {
16796
17319
  description: "Access code has not yet been fully moved to the device.",
16797
17320
  properties: {
16798
- created_at: { format: "date-time", type: "string" },
17321
+ created_at: {
17322
+ description: "Date and time at which Seam created the error.",
17323
+ format: "date-time",
17324
+ type: "string"
17325
+ },
16799
17326
  error_code: {
16800
17327
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16801
17328
  enum: ["august_device_programming_delay"],
16802
17329
  type: "string"
16803
17330
  },
16804
- is_access_code_error: { enum: [true], type: "boolean" },
16805
- message: { type: "string" }
17331
+ is_access_code_error: {
17332
+ description: "Indicates that this is an access code error.",
17333
+ enum: [true],
17334
+ type: "boolean"
17335
+ },
17336
+ message: {
17337
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17338
+ type: "string"
17339
+ }
16806
17340
  },
16807
17341
  required: ["message", "is_access_code_error", "error_code"],
16808
17342
  type: "object"
@@ -16810,14 +17344,25 @@ var openapi_default = {
16810
17344
  {
16811
17345
  description: "All access code slots on the device are full.",
16812
17346
  properties: {
16813
- created_at: { format: "date-time", type: "string" },
17347
+ created_at: {
17348
+ description: "Date and time at which Seam created the error.",
17349
+ format: "date-time",
17350
+ type: "string"
17351
+ },
16814
17352
  error_code: {
16815
17353
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16816
17354
  enum: ["august_device_slots_full"],
16817
17355
  type: "string"
16818
17356
  },
16819
- is_access_code_error: { enum: [true], type: "boolean" },
16820
- message: { type: "string" }
17357
+ is_access_code_error: {
17358
+ description: "Indicates that this is an access code error.",
17359
+ enum: [true],
17360
+ type: "boolean"
17361
+ },
17362
+ message: {
17363
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17364
+ type: "string"
17365
+ }
16821
17366
  },
16822
17367
  required: ["message", "is_access_code_error", "error_code"],
16823
17368
  type: "object"
@@ -16825,29 +17370,51 @@ var openapi_default = {
16825
17370
  {
16826
17371
  description: "August lock is missing a keypad.",
16827
17372
  properties: {
16828
- created_at: { format: "date-time", type: "string" },
17373
+ created_at: {
17374
+ description: "Date and time at which Seam created the error.",
17375
+ format: "date-time",
17376
+ type: "string"
17377
+ },
16829
17378
  error_code: {
16830
17379
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16831
17380
  enum: ["august_lock_missing_keypad"],
16832
17381
  type: "string"
16833
17382
  },
16834
- is_access_code_error: { enum: [true], type: "boolean" },
16835
- message: { type: "string" }
16836
- },
16837
- required: ["message", "is_access_code_error", "error_code"],
16838
- type: "object"
16839
- },
17383
+ is_access_code_error: {
17384
+ description: "Indicates that this is an access code error.",
17385
+ enum: [true],
17386
+ type: "boolean"
17387
+ },
17388
+ message: {
17389
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17390
+ type: "string"
17391
+ }
17392
+ },
17393
+ required: ["message", "is_access_code_error", "error_code"],
17394
+ type: "object"
17395
+ },
16840
17396
  {
16841
17397
  description: "August lock is temporarily offline.",
16842
17398
  properties: {
16843
- created_at: { format: "date-time", type: "string" },
17399
+ created_at: {
17400
+ description: "Date and time at which Seam created the error.",
17401
+ format: "date-time",
17402
+ type: "string"
17403
+ },
16844
17404
  error_code: {
16845
17405
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16846
17406
  enum: ["august_lock_temporarily_offline"],
16847
17407
  type: "string"
16848
17408
  },
16849
- is_access_code_error: { enum: [true], type: "boolean" },
16850
- message: { type: "string" }
17409
+ is_access_code_error: {
17410
+ description: "Indicates that this is an access code error.",
17411
+ enum: [true],
17412
+ type: "boolean"
17413
+ },
17414
+ message: {
17415
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17416
+ type: "string"
17417
+ }
16851
17418
  },
16852
17419
  required: ["message", "is_access_code_error", "error_code"],
16853
17420
  type: "object"
@@ -16855,14 +17422,25 @@ var openapi_default = {
16855
17422
  {
16856
17423
  description: "Salto site user is not subscribed.",
16857
17424
  properties: {
16858
- created_at: { format: "date-time", type: "string" },
17425
+ created_at: {
17426
+ description: "Date and time at which Seam created the error.",
17427
+ format: "date-time",
17428
+ type: "string"
17429
+ },
16859
17430
  error_code: {
16860
17431
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16861
17432
  enum: ["salto_ks_user_not_subscribed"],
16862
17433
  type: "string"
16863
17434
  },
16864
- is_access_code_error: { enum: [true], type: "boolean" },
16865
- message: { type: "string" }
17435
+ is_access_code_error: {
17436
+ description: "Indicates that this is an access code error.",
17437
+ enum: [true],
17438
+ type: "boolean"
17439
+ },
17440
+ message: {
17441
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17442
+ type: "string"
17443
+ }
16866
17444
  },
16867
17445
  required: ["message", "is_access_code_error", "error_code"],
16868
17446
  type: "object"
@@ -16870,14 +17448,25 @@ var openapi_default = {
16870
17448
  {
16871
17449
  description: "Access code has not yet been fully moved to the device.",
16872
17450
  properties: {
16873
- created_at: { format: "date-time", type: "string" },
17451
+ created_at: {
17452
+ description: "Date and time at which Seam created the error.",
17453
+ format: "date-time",
17454
+ type: "string"
17455
+ },
16874
17456
  error_code: {
16875
17457
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16876
17458
  enum: ["hubitat_device_programming_delay"],
16877
17459
  type: "string"
16878
17460
  },
16879
- is_access_code_error: { enum: [true], type: "boolean" },
16880
- message: { type: "string" }
17461
+ is_access_code_error: {
17462
+ description: "Indicates that this is an access code error.",
17463
+ enum: [true],
17464
+ type: "boolean"
17465
+ },
17466
+ message: {
17467
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17468
+ type: "string"
17469
+ }
16881
17470
  },
16882
17471
  required: ["message", "is_access_code_error", "error_code"],
16883
17472
  type: "object"
@@ -16885,14 +17474,25 @@ var openapi_default = {
16885
17474
  {
16886
17475
  description: "No free positions available on the device.",
16887
17476
  properties: {
16888
- created_at: { format: "date-time", type: "string" },
17477
+ created_at: {
17478
+ description: "Date and time at which Seam created the error.",
17479
+ format: "date-time",
17480
+ type: "string"
17481
+ },
16889
17482
  error_code: {
16890
17483
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16891
17484
  enum: ["hubitat_no_free_positions_available"],
16892
17485
  type: "string"
16893
17486
  },
16894
- is_access_code_error: { enum: [true], type: "boolean" },
16895
- message: { type: "string" }
17487
+ is_access_code_error: {
17488
+ description: "Indicates that this is an access code error.",
17489
+ enum: [true],
17490
+ type: "boolean"
17491
+ },
17492
+ message: {
17493
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17494
+ type: "string"
17495
+ }
16896
17496
  },
16897
17497
  required: ["message", "is_access_code_error", "error_code"],
16898
17498
  type: "object"
@@ -16900,14 +17500,25 @@ var openapi_default = {
16900
17500
  {
16901
17501
  description: "Duplicate access code name detected.",
16902
17502
  properties: {
16903
- created_at: { format: "date-time", type: "string" },
17503
+ created_at: {
17504
+ description: "Date and time at which Seam created the error.",
17505
+ format: "date-time",
17506
+ type: "string"
17507
+ },
16904
17508
  error_code: {
16905
17509
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16906
17510
  enum: ["wyze_duplicate_code_name"],
16907
17511
  type: "string"
16908
17512
  },
16909
- is_access_code_error: { enum: [true], type: "boolean" },
16910
- message: { type: "string" }
17513
+ is_access_code_error: {
17514
+ description: "Indicates that this is an access code error.",
17515
+ enum: [true],
17516
+ type: "boolean"
17517
+ },
17518
+ message: {
17519
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17520
+ type: "string"
17521
+ }
16911
17522
  },
16912
17523
  required: ["message", "is_access_code_error", "error_code"],
16913
17524
  type: "object"
@@ -16915,14 +17526,25 @@ var openapi_default = {
16915
17526
  {
16916
17527
  description: "Potential duplicate access code detected.",
16917
17528
  properties: {
16918
- created_at: { format: "date-time", type: "string" },
17529
+ created_at: {
17530
+ description: "Date and time at which Seam created the error.",
17531
+ format: "date-time",
17532
+ type: "string"
17533
+ },
16919
17534
  error_code: {
16920
17535
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16921
17536
  enum: ["wyze_potential_duplicate_code"],
16922
17537
  type: "string"
16923
17538
  },
16924
- is_access_code_error: { enum: [true], type: "boolean" },
16925
- message: { type: "string" }
17539
+ is_access_code_error: {
17540
+ description: "Indicates that this is an access code error.",
17541
+ enum: [true],
17542
+ type: "boolean"
17543
+ },
17544
+ message: {
17545
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17546
+ type: "string"
17547
+ }
16926
17548
  },
16927
17549
  required: ["message", "is_access_code_error", "error_code"],
16928
17550
  type: "object"
@@ -16930,14 +17552,25 @@ var openapi_default = {
16930
17552
  {
16931
17553
  description: "No valid user level for Oracode.",
16932
17554
  properties: {
16933
- created_at: { format: "date-time", type: "string" },
17555
+ created_at: {
17556
+ description: "Date and time at which Seam created the error.",
17557
+ format: "date-time",
17558
+ type: "string"
17559
+ },
16934
17560
  error_code: {
16935
17561
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
16936
17562
  enum: ["dormakaba_oracode_no_valid_user_level"],
16937
17563
  type: "string"
16938
17564
  },
16939
- is_access_code_error: { enum: [true], type: "boolean" },
16940
- message: { type: "string" }
17565
+ is_access_code_error: {
17566
+ description: "Indicates that this is an access code error.",
17567
+ enum: [true],
17568
+ type: "boolean"
17569
+ },
17570
+ message: {
17571
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
17572
+ type: "string"
17573
+ }
16941
17574
  },
16942
17575
  required: ["message", "is_access_code_error", "error_code"],
16943
17576
  type: "object"
@@ -17256,7 +17889,11 @@ var openapi_default = {
17256
17889
  },
17257
17890
  type: "array"
17258
17891
  },
17259
- is_managed: { enum: [false], type: "boolean" },
17892
+ is_managed: {
17893
+ description: "Indicates that Seam does not manage the access code.",
17894
+ enum: [false],
17895
+ type: "boolean"
17896
+ },
17260
17897
  name: {
17261
17898
  description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
17262
17899
  nullable: true,
@@ -17268,22 +17905,34 @@ var openapi_default = {
17268
17905
  nullable: true,
17269
17906
  type: "string"
17270
17907
  },
17271
- status: { enum: ["set"], type: "string" },
17908
+ status: {
17909
+ description: "Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.",
17910
+ enum: ["set"],
17911
+ type: "string"
17912
+ },
17272
17913
  type: {
17273
- description: '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.',
17914
+ description: "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.",
17274
17915
  enum: ["time_bound", "ongoing"],
17275
17916
  type: "string"
17276
17917
  },
17277
17918
  warnings: {
17278
- description: '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.',
17919
+ description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
17279
17920
  items: {
17921
+ description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
17280
17922
  discriminator: { propertyName: "warning_code" },
17281
17923
  oneOf: [
17282
17924
  {
17283
- description: "Failed to set code on Smart Things device.",
17925
+ description: "Failed to set code on SmartThings device.",
17284
17926
  properties: {
17285
- created_at: { format: "date-time", type: "string" },
17286
- message: { type: "string" },
17927
+ created_at: {
17928
+ description: "Date and time at which Seam created the warning.",
17929
+ format: "date-time",
17930
+ type: "string"
17931
+ },
17932
+ message: {
17933
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
17934
+ type: "string"
17935
+ },
17287
17936
  warning_code: {
17288
17937
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17289
17938
  enum: ["smartthings_failed_to_set_access_code"],
@@ -17296,8 +17945,15 @@ var openapi_default = {
17296
17945
  {
17297
17946
  description: "Duplicate access code detected.",
17298
17947
  properties: {
17299
- created_at: { format: "date-time", type: "string" },
17300
- message: { type: "string" },
17948
+ created_at: {
17949
+ description: "Date and time at which Seam created the warning.",
17950
+ format: "date-time",
17951
+ type: "string"
17952
+ },
17953
+ message: {
17954
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
17955
+ type: "string"
17956
+ },
17301
17957
  warning_code: {
17302
17958
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17303
17959
  enum: ["schlage_detected_duplicate"],
@@ -17310,8 +17966,15 @@ var openapi_default = {
17310
17966
  {
17311
17967
  description: "Received an error when attempting to create this code.",
17312
17968
  properties: {
17313
- created_at: { format: "date-time", type: "string" },
17314
- message: { type: "string" },
17969
+ created_at: {
17970
+ description: "Date and time at which Seam created the warning.",
17971
+ format: "date-time",
17972
+ type: "string"
17973
+ },
17974
+ message: {
17975
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
17976
+ type: "string"
17977
+ },
17315
17978
  warning_code: {
17316
17979
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17317
17980
  enum: ["schlage_creation_outage"],
@@ -17324,8 +17987,15 @@ var openapi_default = {
17324
17987
  {
17325
17988
  description: "Code was modified or removed externally after Seam successfully set it on the device.",
17326
17989
  properties: {
17327
- created_at: { format: "date-time", type: "string" },
17328
- message: { type: "string" },
17990
+ created_at: {
17991
+ description: "Date and time at which Seam created the warning.",
17992
+ format: "date-time",
17993
+ type: "string"
17994
+ },
17995
+ message: {
17996
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
17997
+ type: "string"
17998
+ },
17329
17999
  warning_code: {
17330
18000
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17331
18001
  enum: ["code_modified_external_to_seam"],
@@ -17338,8 +18008,15 @@ var openapi_default = {
17338
18008
  {
17339
18009
  description: "Delay in setting code on device.",
17340
18010
  properties: {
17341
- created_at: { format: "date-time", type: "string" },
17342
- message: { type: "string" },
18011
+ created_at: {
18012
+ description: "Date and time at which Seam created the warning.",
18013
+ format: "date-time",
18014
+ type: "string"
18015
+ },
18016
+ message: {
18017
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18018
+ type: "string"
18019
+ },
17343
18020
  warning_code: {
17344
18021
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17345
18022
  enum: ["delay_in_setting_on_device"],
@@ -17352,8 +18029,15 @@ var openapi_default = {
17352
18029
  {
17353
18030
  description: "Delay in removing code from device.",
17354
18031
  properties: {
17355
- created_at: { format: "date-time", type: "string" },
17356
- message: { type: "string" },
18032
+ created_at: {
18033
+ description: "Date and time at which Seam created the warning.",
18034
+ format: "date-time",
18035
+ type: "string"
18036
+ },
18037
+ message: {
18038
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18039
+ type: "string"
18040
+ },
17357
18041
  warning_code: {
17358
18042
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17359
18043
  enum: ["delay_in_removing_from_device"],
@@ -17364,10 +18048,17 @@ var openapi_default = {
17364
18048
  type: "object"
17365
18049
  },
17366
18050
  {
17367
- description: "Third party integration detected that may cause access codes to fail.",
18051
+ description: "Third-party integration detected that may cause access codes to fail.",
17368
18052
  properties: {
17369
- created_at: { format: "date-time", type: "string" },
17370
- message: { type: "string" },
18053
+ created_at: {
18054
+ description: "Date and time at which Seam created the warning.",
18055
+ format: "date-time",
18056
+ type: "string"
18057
+ },
18058
+ message: {
18059
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18060
+ type: "string"
18061
+ },
17371
18062
  warning_code: {
17372
18063
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17373
18064
  enum: ["third_party_integration_detected"],
@@ -17380,8 +18071,15 @@ var openapi_default = {
17380
18071
  {
17381
18072
  description: "Access code has not yet been fully moved to the device.",
17382
18073
  properties: {
17383
- created_at: { format: "date-time", type: "string" },
17384
- message: { type: "string" },
18074
+ created_at: {
18075
+ description: "Date and time at which Seam created the warning.",
18076
+ format: "date-time",
18077
+ type: "string"
18078
+ },
18079
+ message: {
18080
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18081
+ type: "string"
18082
+ },
17385
18083
  warning_code: {
17386
18084
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17387
18085
  enum: ["august_device_programming_delay"],
@@ -17394,8 +18092,15 @@ var openapi_default = {
17394
18092
  {
17395
18093
  description: "August lock is temporarily offline.",
17396
18094
  properties: {
17397
- created_at: { format: "date-time", type: "string" },
17398
- message: { type: "string" },
18095
+ created_at: {
18096
+ description: "Date and time at which Seam created the warning.",
18097
+ format: "date-time",
18098
+ type: "string"
18099
+ },
18100
+ message: {
18101
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18102
+ type: "string"
18103
+ },
17399
18104
  warning_code: {
17400
18105
  description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
17401
18106
  enum: ["august_lock_temporarily_offline"],
@@ -17408,8 +18113,15 @@ var openapi_default = {
17408
18113
  {
17409
18114
  description: "Algopins must be used within 24 hours.",
17410
18115
  properties: {
17411
- created_at: { format: "date-time", type: "string" },
17412
- message: { type: "string" },
18116
+ created_at: {
18117
+ description: "Date and time at which Seam created the warning.",
18118
+ format: "date-time",
18119
+ type: "string"
18120
+ },
18121
+ message: {
18122
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18123
+ type: "string"
18124
+ },
17413
18125
  warning_code: {
17414
18126
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17415
18127
  enum: ["igloo_algopin_must_be_used_within_24_hours"],
@@ -17422,8 +18134,15 @@ var openapi_default = {
17422
18134
  {
17423
18135
  description: "Management was transferred to another workspace.",
17424
18136
  properties: {
17425
- created_at: { format: "date-time", type: "string" },
17426
- message: { type: "string" },
18137
+ created_at: {
18138
+ description: "Date and time at which Seam created the warning.",
18139
+ format: "date-time",
18140
+ type: "string"
18141
+ },
18142
+ message: {
18143
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18144
+ type: "string"
18145
+ },
17427
18146
  warning_code: {
17428
18147
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17429
18148
  enum: ["management_transferred"],
@@ -17434,10 +18153,17 @@ var openapi_default = {
17434
18153
  type: "object"
17435
18154
  },
17436
18155
  {
17437
- description: "Unable to confirm the access code is set on Kwikset device.",
18156
+ description: "Unable to confirm that the access code is set on Kwikset device.",
17438
18157
  properties: {
17439
- created_at: { format: "date-time", type: "string" },
17440
- message: { type: "string" },
18158
+ created_at: {
18159
+ description: "Date and time at which Seam created the warning.",
18160
+ format: "date-time",
18161
+ type: "string"
18162
+ },
18163
+ message: {
18164
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18165
+ type: "string"
18166
+ },
17441
18167
  warning_code: {
17442
18168
  description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
17443
18169
  enum: ["kwikset_unable_to_confirm_code"],
@@ -18079,23 +18805,30 @@ var openapi_default = {
18079
18805
  type: "string",
18080
18806
  "x-undocumented": "Only used internally."
18081
18807
  },
18082
- pending_modifications: {
18808
+ pending_mutations: {
18083
18809
  items: {
18084
- discriminator: { propertyName: "modification_code" },
18810
+ discriminator: { propertyName: "mutation_code" },
18085
18811
  oneOf: [
18086
18812
  {
18087
18813
  properties: {
18088
18814
  created_at: { format: "date-time", type: "string" },
18089
- modification_code: { enum: ["create"], type: "string" }
18815
+ mutation_code: { enum: ["creating"], type: "string" }
18090
18816
  },
18091
- required: ["created_at", "modification_code"],
18817
+ required: ["created_at", "mutation_code"],
18092
18818
  type: "object"
18093
18819
  },
18094
18820
  {
18095
18821
  properties: {
18096
18822
  created_at: { format: "date-time", type: "string" },
18097
- modification_code: { enum: ["profile"], type: "string" },
18098
- modified_from: {
18823
+ mutation_code: { enum: ["deleting"], type: "string" }
18824
+ },
18825
+ required: ["created_at", "mutation_code"],
18826
+ type: "object"
18827
+ },
18828
+ {
18829
+ properties: {
18830
+ created_at: { format: "date-time", type: "string" },
18831
+ from: {
18099
18832
  properties: {
18100
18833
  email_address: {
18101
18834
  format: "email",
@@ -18107,7 +18840,11 @@ var openapi_default = {
18107
18840
  },
18108
18841
  type: "object"
18109
18842
  },
18110
- modified_to: {
18843
+ mutation_code: {
18844
+ enum: ["updating_user_information"],
18845
+ type: "string"
18846
+ },
18847
+ to: {
18111
18848
  properties: {
18112
18849
  email_address: {
18113
18850
  format: "email",
@@ -18120,22 +18857,13 @@ var openapi_default = {
18120
18857
  type: "object"
18121
18858
  }
18122
18859
  },
18123
- required: [
18124
- "created_at",
18125
- "modification_code",
18126
- "modified_from",
18127
- "modified_to"
18128
- ],
18860
+ required: ["created_at", "mutation_code", "from", "to"],
18129
18861
  type: "object"
18130
18862
  },
18131
18863
  {
18132
18864
  properties: {
18133
18865
  created_at: { format: "date-time", type: "string" },
18134
- modification_code: {
18135
- enum: ["access_schedule"],
18136
- type: "string"
18137
- },
18138
- modified_from: {
18866
+ from: {
18139
18867
  properties: {
18140
18868
  ends_at: {
18141
18869
  description: "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.",
@@ -18152,7 +18880,11 @@ var openapi_default = {
18152
18880
  required: ["starts_at", "ends_at"],
18153
18881
  type: "object"
18154
18882
  },
18155
- modified_to: {
18883
+ mutation_code: {
18884
+ enum: ["updating_access_schedule"],
18885
+ type: "string"
18886
+ },
18887
+ to: {
18156
18888
  properties: {
18157
18889
  ends_at: {
18158
18890
  description: "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.",
@@ -18170,48 +18902,34 @@ var openapi_default = {
18170
18902
  type: "object"
18171
18903
  }
18172
18904
  },
18173
- required: [
18174
- "created_at",
18175
- "modification_code",
18176
- "modified_from",
18177
- "modified_to"
18178
- ],
18905
+ required: ["created_at", "mutation_code", "from", "to"],
18179
18906
  type: "object"
18180
18907
  },
18181
18908
  {
18182
18909
  properties: {
18183
18910
  created_at: { format: "date-time", type: "string" },
18184
- modification_code: {
18185
- enum: ["suspension_state"],
18186
- type: "string"
18187
- },
18188
- modified_from: {
18911
+ from: {
18189
18912
  properties: { is_suspended: { type: "boolean" } },
18190
18913
  required: ["is_suspended"],
18191
18914
  type: "object"
18192
18915
  },
18193
- modified_to: {
18916
+ mutation_code: {
18917
+ enum: ["updating_suspension_state"],
18918
+ type: "string"
18919
+ },
18920
+ to: {
18194
18921
  properties: { is_suspended: { type: "boolean" } },
18195
18922
  required: ["is_suspended"],
18196
18923
  type: "object"
18197
18924
  }
18198
18925
  },
18199
- required: [
18200
- "created_at",
18201
- "modification_code",
18202
- "modified_from",
18203
- "modified_to"
18204
- ],
18926
+ required: ["created_at", "mutation_code", "from", "to"],
18205
18927
  type: "object"
18206
18928
  },
18207
18929
  {
18208
18930
  properties: {
18209
18931
  created_at: { format: "date-time", type: "string" },
18210
- modification_code: {
18211
- enum: ["acs_access_group_membership"],
18212
- type: "string"
18213
- },
18214
- modified_from: {
18932
+ from: {
18215
18933
  properties: {
18216
18934
  acs_access_group_id: {
18217
18935
  format: "uuid",
@@ -18222,7 +18940,11 @@ var openapi_default = {
18222
18940
  required: ["acs_access_group_id"],
18223
18941
  type: "object"
18224
18942
  },
18225
- modified_to: {
18943
+ mutation_code: {
18944
+ enum: ["updating_group_membership"],
18945
+ type: "string"
18946
+ },
18947
+ to: {
18226
18948
  properties: {
18227
18949
  acs_access_group_id: {
18228
18950
  format: "uuid",
@@ -18234,12 +18956,7 @@ var openapi_default = {
18234
18956
  type: "object"
18235
18957
  }
18236
18958
  },
18237
- required: [
18238
- "created_at",
18239
- "modification_code",
18240
- "modified_from",
18241
- "modified_to"
18242
- ],
18959
+ required: ["created_at", "mutation_code", "from", "to"],
18243
18960
  type: "object"
18244
18961
  }
18245
18962
  ]
@@ -19321,40 +20038,85 @@ var openapi_default = {
19321
20038
  paths: {
19322
20039
  "/access_codes/create": {
19323
20040
  post: {
20041
+ description: "Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
19324
20042
  operationId: "accessCodesCreatePost",
19325
20043
  requestBody: {
19326
20044
  content: {
19327
20045
  "application/json": {
19328
20046
  schema: {
19329
20047
  properties: {
19330
- allow_external_modification: { type: "boolean" },
20048
+ allow_external_modification: {
20049
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
20050
+ type: "boolean"
20051
+ },
19331
20052
  attempt_for_offline_device: {
19332
20053
  default: true,
19333
20054
  type: "boolean"
19334
20055
  },
19335
20056
  code: {
20057
+ description: "Code to be used for access.",
19336
20058
  maxLength: 9,
19337
20059
  minLength: 4,
19338
20060
  pattern: "^\\d+$",
19339
20061
  type: "string"
19340
20062
  },
19341
- common_code_key: { type: "string" },
19342
- device_id: { format: "uuid", type: "string" },
19343
- ends_at: { type: "string" },
19344
- is_external_modification_allowed: { type: "boolean" },
19345
- is_offline_access_code: { type: "boolean" },
19346
- is_one_time_use: { type: "boolean" },
20063
+ common_code_key: {
20064
+ description: "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).",
20065
+ type: "string"
20066
+ },
20067
+ device_id: {
20068
+ description: "ID of the device for which to create the new access code.",
20069
+ format: "uuid",
20070
+ type: "string"
20071
+ },
20072
+ ends_at: {
20073
+ description: "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`.",
20074
+ type: "string"
20075
+ },
20076
+ is_external_modification_allowed: {
20077
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
20078
+ type: "boolean"
20079
+ },
20080
+ is_offline_access_code: {
20081
+ description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
20082
+ type: "boolean"
20083
+ },
20084
+ is_one_time_use: {
20085
+ description: "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.",
20086
+ type: "boolean"
20087
+ },
19347
20088
  max_time_rounding: {
19348
20089
  default: "1hour",
20090
+ description: "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`.",
19349
20091
  enum: ["1hour", "1day", "1h", "1d"],
19350
20092
  type: "string"
19351
20093
  },
19352
- name: { type: "string" },
19353
- prefer_native_scheduling: { type: "boolean" },
19354
- preferred_code_length: { format: "float", type: "number" },
19355
- starts_at: { type: "string" },
19356
- sync: { default: false, type: "boolean" },
19357
- use_backup_access_code_pool: { type: "boolean" },
20094
+ name: {
20095
+ description: "Name of the new access code.",
20096
+ type: "string"
20097
+ },
20098
+ prefer_native_scheduling: {
20099
+ description: "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`.",
20100
+ type: "boolean"
20101
+ },
20102
+ preferred_code_length: {
20103
+ description: "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.",
20104
+ format: "float",
20105
+ type: "number"
20106
+ },
20107
+ starts_at: {
20108
+ description: "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.",
20109
+ type: "string"
20110
+ },
20111
+ sync: {
20112
+ default: false,
20113
+ type: "boolean",
20114
+ "x-undocumented": "Only used internally."
20115
+ },
20116
+ use_backup_access_code_pool: {
20117
+ description: "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).",
20118
+ type: "boolean"
20119
+ },
19358
20120
  use_offline_access_code: { type: "boolean" }
19359
20121
  },
19360
20122
  required: ["device_id"],
@@ -19397,51 +20159,88 @@ var openapi_default = {
19397
20159
  "x-fern-sdk-group-name": ["access_codes"],
19398
20160
  "x-fern-sdk-method-name": "create",
19399
20161
  "x-fern-sdk-return-value": "access_code",
19400
- "x-response-key": "access_code"
20162
+ "x-response-key": "access_code",
20163
+ "x-title": "Create an Access Code"
19401
20164
  }
19402
20165
  },
19403
20166
  "/access_codes/create_multiple": {
19404
20167
  post: {
20168
+ description: "Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee 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).",
19405
20169
  operationId: "accessCodesCreateMultiplePost",
19406
20170
  requestBody: {
19407
20171
  content: {
19408
20172
  "application/json": {
19409
20173
  schema: {
19410
20174
  properties: {
19411
- allow_external_modification: { type: "boolean" },
20175
+ allow_external_modification: {
20176
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
20177
+ type: "boolean"
20178
+ },
19412
20179
  attempt_for_offline_device: {
19413
20180
  default: true,
19414
20181
  type: "boolean"
19415
20182
  },
19416
20183
  behavior_when_code_cannot_be_shared: {
19417
20184
  default: "throw",
20185
+ description: "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.",
19418
20186
  enum: ["throw", "create_random_code"],
19419
20187
  type: "string"
19420
20188
  },
19421
20189
  code: {
20190
+ description: "Code to be used for access.",
19422
20191
  maxLength: 9,
19423
20192
  minLength: 4,
19424
20193
  pattern: "^\\d+$",
19425
20194
  type: "string"
19426
20195
  },
19427
20196
  device_ids: {
20197
+ description: "IDs of the devices for which to create the new access codes.",
19428
20198
  items: { format: "uuid", type: "string" },
19429
20199
  type: "array"
19430
20200
  },
19431
- ends_at: { type: "string" },
19432
- is_external_modification_allowed: { type: "boolean" },
19433
- is_offline_access_code: { type: "boolean" },
19434
- is_one_time_use: { type: "boolean" },
20201
+ ends_at: {
20202
+ description: "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`.",
20203
+ type: "string"
20204
+ },
20205
+ is_external_modification_allowed: {
20206
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
20207
+ type: "boolean"
20208
+ },
20209
+ is_offline_access_code: {
20210
+ description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
20211
+ type: "boolean"
20212
+ },
20213
+ is_one_time_use: {
20214
+ description: "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.",
20215
+ type: "boolean"
20216
+ },
19435
20217
  max_time_rounding: {
19436
20218
  default: "1hour",
20219
+ description: "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`.",
19437
20220
  enum: ["1hour", "1day", "1h", "1d"],
19438
20221
  type: "string"
19439
20222
  },
19440
- name: { type: "string" },
19441
- prefer_native_scheduling: { type: "boolean" },
19442
- preferred_code_length: { format: "float", type: "number" },
19443
- starts_at: { type: "string" },
19444
- use_backup_access_code_pool: { type: "boolean" },
20223
+ name: {
20224
+ description: "Name of the new access code.",
20225
+ type: "string"
20226
+ },
20227
+ prefer_native_scheduling: {
20228
+ description: "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`.",
20229
+ type: "boolean"
20230
+ },
20231
+ preferred_code_length: {
20232
+ description: "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.",
20233
+ format: "float",
20234
+ type: "number"
20235
+ },
20236
+ starts_at: {
20237
+ description: "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.",
20238
+ type: "string"
20239
+ },
20240
+ use_backup_access_code_pool: {
20241
+ description: "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).",
20242
+ type: "boolean"
20243
+ },
19445
20244
  use_offline_access_code: { type: "boolean" }
19446
20245
  },
19447
20246
  required: ["device_ids"],
@@ -19483,49 +20282,86 @@ var openapi_default = {
19483
20282
  "x-fern-sdk-group-name": ["access_codes"],
19484
20283
  "x-fern-sdk-method-name": "create_multiple",
19485
20284
  "x-fern-sdk-return-value": "access_codes",
19486
- "x-response-key": "access_codes"
20285
+ "x-response-key": "access_codes",
20286
+ "x-title": "Create Multiple Linked Access Codes"
19487
20287
  },
19488
20288
  put: {
20289
+ description: "Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee 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).",
19489
20290
  operationId: "accessCodesCreateMultiplePut",
19490
20291
  requestBody: {
19491
20292
  content: {
19492
20293
  "application/json": {
19493
20294
  schema: {
19494
20295
  properties: {
19495
- allow_external_modification: { type: "boolean" },
20296
+ allow_external_modification: {
20297
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
20298
+ type: "boolean"
20299
+ },
19496
20300
  attempt_for_offline_device: {
19497
20301
  default: true,
19498
20302
  type: "boolean"
19499
20303
  },
19500
20304
  behavior_when_code_cannot_be_shared: {
19501
20305
  default: "throw",
20306
+ description: "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.",
19502
20307
  enum: ["throw", "create_random_code"],
19503
20308
  type: "string"
19504
20309
  },
19505
20310
  code: {
20311
+ description: "Code to be used for access.",
19506
20312
  maxLength: 9,
19507
20313
  minLength: 4,
19508
20314
  pattern: "^\\d+$",
19509
20315
  type: "string"
19510
20316
  },
19511
20317
  device_ids: {
20318
+ description: "IDs of the devices for which to create the new access codes.",
19512
20319
  items: { format: "uuid", type: "string" },
19513
20320
  type: "array"
19514
20321
  },
19515
- ends_at: { type: "string" },
19516
- is_external_modification_allowed: { type: "boolean" },
19517
- is_offline_access_code: { type: "boolean" },
19518
- is_one_time_use: { type: "boolean" },
20322
+ ends_at: {
20323
+ description: "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`.",
20324
+ type: "string"
20325
+ },
20326
+ is_external_modification_allowed: {
20327
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
20328
+ type: "boolean"
20329
+ },
20330
+ is_offline_access_code: {
20331
+ description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
20332
+ type: "boolean"
20333
+ },
20334
+ is_one_time_use: {
20335
+ description: "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.",
20336
+ type: "boolean"
20337
+ },
19519
20338
  max_time_rounding: {
19520
20339
  default: "1hour",
20340
+ description: "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`.",
19521
20341
  enum: ["1hour", "1day", "1h", "1d"],
19522
20342
  type: "string"
19523
20343
  },
19524
- name: { type: "string" },
19525
- prefer_native_scheduling: { type: "boolean" },
19526
- preferred_code_length: { format: "float", type: "number" },
19527
- starts_at: { type: "string" },
19528
- use_backup_access_code_pool: { type: "boolean" },
20344
+ name: {
20345
+ description: "Name of the new access code.",
20346
+ type: "string"
20347
+ },
20348
+ prefer_native_scheduling: {
20349
+ description: "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`.",
20350
+ type: "boolean"
20351
+ },
20352
+ preferred_code_length: {
20353
+ description: "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.",
20354
+ format: "float",
20355
+ type: "number"
20356
+ },
20357
+ starts_at: {
20358
+ description: "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.",
20359
+ type: "string"
20360
+ },
20361
+ use_backup_access_code_pool: {
20362
+ description: "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).",
20363
+ type: "boolean"
20364
+ },
19529
20365
  use_offline_access_code: { type: "boolean" }
19530
20366
  },
19531
20367
  required: ["device_ids"],
@@ -19565,20 +20401,34 @@ var openapi_default = {
19565
20401
  summary: "/access_codes/create_multiple",
19566
20402
  tags: ["/access_codes"],
19567
20403
  "x-fern-ignore": true,
19568
- "x-response-key": "access_codes"
20404
+ "x-response-key": "access_codes",
20405
+ "x-title": "Create Multiple Linked Access Codes"
19569
20406
  }
19570
20407
  },
19571
20408
  "/access_codes/delete": {
19572
20409
  post: {
20410
+ description: "Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
19573
20411
  operationId: "accessCodesDeletePost",
19574
20412
  requestBody: {
19575
20413
  content: {
19576
20414
  "application/json": {
19577
20415
  schema: {
19578
20416
  properties: {
19579
- access_code_id: { format: "uuid", type: "string" },
19580
- device_id: { format: "uuid", type: "string" },
19581
- sync: { default: false, type: "boolean" }
20417
+ access_code_id: {
20418
+ description: "ID of the access code to delete.",
20419
+ format: "uuid",
20420
+ type: "string"
20421
+ },
20422
+ device_id: {
20423
+ description: "ID of the device for which to delete the access code.",
20424
+ format: "uuid",
20425
+ type: "string"
20426
+ },
20427
+ sync: {
20428
+ default: false,
20429
+ type: "boolean",
20430
+ "x-undocumented": "Only used internally."
20431
+ }
19582
20432
  },
19583
20433
  required: ["access_code_id"],
19584
20434
  type: "object"
@@ -19618,7 +20468,8 @@ var openapi_default = {
19618
20468
  "x-action-attempt-type": "DELETE_ACCESS_CODE",
19619
20469
  "x-fern-sdk-group-name": ["access_codes"],
19620
20470
  "x-fern-sdk-method-name": "delete",
19621
- "x-response-key": null
20471
+ "x-response-key": null,
20472
+ "x-title": "Delete an Access Code"
19622
20473
  }
19623
20474
  },
19624
20475
  "/access_codes/generate_code": {
@@ -19672,15 +20523,27 @@ var openapi_default = {
19672
20523
  },
19673
20524
  "/access_codes/get": {
19674
20525
  post: {
20526
+ description: "Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.",
19675
20527
  operationId: "accessCodesGetPost",
19676
20528
  requestBody: {
19677
20529
  content: {
19678
20530
  "application/json": {
19679
20531
  schema: {
19680
20532
  properties: {
19681
- access_code_id: { format: "uuid", type: "string" },
19682
- code: { type: "string" },
19683
- device_id: { format: "uuid", type: "string" }
20533
+ access_code_id: {
20534
+ description: "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
20535
+ format: "uuid",
20536
+ type: "string"
20537
+ },
20538
+ code: {
20539
+ description: "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
20540
+ type: "string"
20541
+ },
20542
+ device_id: {
20543
+ description: "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`.",
20544
+ format: "uuid",
20545
+ type: "string"
20546
+ }
19684
20547
  },
19685
20548
  type: "object"
19686
20549
  }
@@ -19717,11 +20580,13 @@ var openapi_default = {
19717
20580
  "x-fern-sdk-group-name": ["access_codes"],
19718
20581
  "x-fern-sdk-method-name": "get",
19719
20582
  "x-fern-sdk-return-value": "access_code",
19720
- "x-response-key": "access_code"
20583
+ "x-response-key": "access_code",
20584
+ "x-title": "Get an Access Code"
19721
20585
  }
19722
20586
  },
19723
20587
  "/access_codes/list": {
19724
20588
  post: {
20589
+ description: "Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.",
19725
20590
  operationId: "accessCodesListPost",
19726
20591
  requestBody: {
19727
20592
  content: {
@@ -19729,11 +20594,19 @@ var openapi_default = {
19729
20594
  schema: {
19730
20595
  properties: {
19731
20596
  access_code_ids: {
20597
+ description: "IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.",
19732
20598
  items: { format: "uuid", type: "string" },
19733
20599
  type: "array"
19734
20600
  },
19735
- device_id: { format: "uuid", type: "string" },
19736
- user_identifier_key: { type: "string" }
20601
+ device_id: {
20602
+ description: "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.",
20603
+ format: "uuid",
20604
+ type: "string"
20605
+ },
20606
+ user_identifier_key: {
20607
+ description: "Your user ID for the user by which to filter access codes.",
20608
+ type: "string"
20609
+ }
19737
20610
  },
19738
20611
  type: "object"
19739
20612
  }
@@ -19773,19 +20646,24 @@ var openapi_default = {
19773
20646
  "x-fern-sdk-group-name": ["access_codes"],
19774
20647
  "x-fern-sdk-method-name": "list",
19775
20648
  "x-fern-sdk-return-value": "access_codes",
19776
- "x-response-key": "access_codes"
20649
+ "x-response-key": "access_codes",
20650
+ "x-title": "List Access Codes"
19777
20651
  }
19778
20652
  },
19779
20653
  "/access_codes/pull_backup_access_code": {
19780
20654
  post: {
19781
- description: "Retrieves a backup access code for an access code. See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).",
20655
+ description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code\u2014be it due to intermittent connectivity, manual removal from a device, or provider outages\u2014a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
19782
20656
  operationId: "accessCodesPullBackupAccessCodePost",
19783
20657
  requestBody: {
19784
20658
  content: {
19785
20659
  "application/json": {
19786
20660
  schema: {
19787
20661
  properties: {
19788
- access_code_id: { format: "uuid", type: "string" }
20662
+ access_code_id: {
20663
+ description: "ID of the access code for which you want to pull a backup access code.",
20664
+ format: "uuid",
20665
+ type: "string"
20666
+ }
19789
20667
  },
19790
20668
  required: ["access_code_id"],
19791
20669
  type: "object"
@@ -19826,11 +20704,13 @@ var openapi_default = {
19826
20704
  "x-fern-sdk-group-name": ["access_codes"],
19827
20705
  "x-fern-sdk-method-name": "pull_backup_access_code",
19828
20706
  "x-fern-sdk-return-value": "access_code",
19829
- "x-response-key": "access_code"
20707
+ "x-response-key": "access_code",
20708
+ "x-title": "Pull a Backup Access Code"
19830
20709
  }
19831
20710
  },
19832
20711
  "/access_codes/simulate/create_unmanaged_access_code": {
19833
20712
  post: {
20713
+ description: "Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).",
19834
20714
  operationId: "accessCodesSimulateCreateUnmanagedAccessCodePost",
19835
20715
  requestBody: {
19836
20716
  content: {
@@ -19838,13 +20718,21 @@ var openapi_default = {
19838
20718
  schema: {
19839
20719
  properties: {
19840
20720
  code: {
20721
+ description: "Code of the simulated unmanaged access code.",
19841
20722
  maxLength: 8,
19842
20723
  minLength: 4,
19843
20724
  pattern: "^\\d+$",
19844
20725
  type: "string"
19845
20726
  },
19846
- device_id: { format: "uuid", type: "string" },
19847
- name: { type: "string" }
20727
+ device_id: {
20728
+ description: "ID of the device for which you want to simulate the creation of an unmanaged access code.",
20729
+ format: "uuid",
20730
+ type: "string"
20731
+ },
20732
+ name: {
20733
+ description: "Name of the simulated unmanaged access code.",
20734
+ type: "string"
20735
+ }
19848
20736
  },
19849
20737
  required: ["device_id", "name", "code"],
19850
20738
  type: "object"
@@ -19884,22 +20772,41 @@ var openapi_default = {
19884
20772
  "x-fern-sdk-group-name": ["access_codes", "simulate"],
19885
20773
  "x-fern-sdk-method-name": "create_unmanaged_access_code",
19886
20774
  "x-fern-sdk-return-value": "access_code",
19887
- "x-response-key": "access_code"
20775
+ "x-response-key": "access_code",
20776
+ "x-title": "Simulate Creating an Unmanaged Access Code"
19888
20777
  }
19889
20778
  },
19890
20779
  "/access_codes/unmanaged/convert_to_managed": {
19891
20780
  patch: {
20781
+ description: "Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.",
19892
20782
  operationId: "accessCodesUnmanagedConvertToManagedPatch",
19893
20783
  requestBody: {
19894
20784
  content: {
19895
20785
  "application/json": {
19896
20786
  schema: {
19897
20787
  properties: {
19898
- access_code_id: { format: "uuid", type: "string" },
19899
- allow_external_modification: { type: "boolean" },
19900
- force: { type: "boolean" },
19901
- is_external_modification_allowed: { type: "boolean" },
19902
- sync: { default: false, type: "boolean" }
20788
+ access_code_id: {
20789
+ description: "ID of the unmanaged access code that you want to convert to a managed access code.",
20790
+ format: "uuid",
20791
+ type: "string"
20792
+ },
20793
+ allow_external_modification: {
20794
+ description: "Indicates whether external modification of the access code is allowed.",
20795
+ type: "boolean"
20796
+ },
20797
+ force: {
20798
+ description: "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`.",
20799
+ type: "boolean"
20800
+ },
20801
+ is_external_modification_allowed: {
20802
+ description: "Indicates whether external modification of the access code is allowed.",
20803
+ type: "boolean"
20804
+ },
20805
+ sync: {
20806
+ default: false,
20807
+ type: "boolean",
20808
+ "x-undocumented": "Only used internally."
20809
+ }
19903
20810
  },
19904
20811
  required: ["access_code_id"],
19905
20812
  type: "object"
@@ -19933,20 +20840,39 @@ var openapi_default = {
19933
20840
  tags: ["/access_codes"],
19934
20841
  "x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED",
19935
20842
  "x-fern-ignore": true,
19936
- "x-response-key": null
20843
+ "x-response-key": null,
20844
+ "x-title": "Convert an Unmanaged Access Code"
19937
20845
  },
19938
20846
  post: {
20847
+ description: "Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.",
19939
20848
  operationId: "accessCodesUnmanagedConvertToManagedPost",
19940
20849
  requestBody: {
19941
20850
  content: {
19942
20851
  "application/json": {
19943
20852
  schema: {
19944
20853
  properties: {
19945
- access_code_id: { format: "uuid", type: "string" },
19946
- allow_external_modification: { type: "boolean" },
19947
- force: { type: "boolean" },
19948
- is_external_modification_allowed: { type: "boolean" },
19949
- sync: { default: false, type: "boolean" }
20854
+ access_code_id: {
20855
+ description: "ID of the unmanaged access code that you want to convert to a managed access code.",
20856
+ format: "uuid",
20857
+ type: "string"
20858
+ },
20859
+ allow_external_modification: {
20860
+ description: "Indicates whether external modification of the access code is allowed.",
20861
+ type: "boolean"
20862
+ },
20863
+ force: {
20864
+ description: "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`.",
20865
+ type: "boolean"
20866
+ },
20867
+ is_external_modification_allowed: {
20868
+ description: "Indicates whether external modification of the access code is allowed.",
20869
+ type: "boolean"
20870
+ },
20871
+ sync: {
20872
+ default: false,
20873
+ type: "boolean",
20874
+ "x-undocumented": "Only used internally."
20875
+ }
19950
20876
  },
19951
20877
  required: ["access_code_id"],
19952
20878
  type: "object"
@@ -19981,19 +20907,29 @@ var openapi_default = {
19981
20907
  "x-action-attempt-type": "CONVERT_ACCESS_CODE_TO_MANAGED",
19982
20908
  "x-fern-sdk-group-name": ["access_codes", "unmanaged"],
19983
20909
  "x-fern-sdk-method-name": "convert_to_managed",
19984
- "x-response-key": null
20910
+ "x-response-key": null,
20911
+ "x-title": "Convert an Unmanaged Access Code"
19985
20912
  }
19986
20913
  },
19987
20914
  "/access_codes/unmanaged/delete": {
19988
20915
  post: {
20916
+ description: "Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
19989
20917
  operationId: "accessCodesUnmanagedDeletePost",
19990
20918
  requestBody: {
19991
20919
  content: {
19992
20920
  "application/json": {
19993
20921
  schema: {
19994
20922
  properties: {
19995
- access_code_id: { format: "uuid", type: "string" },
19996
- sync: { default: false, type: "boolean" }
20923
+ access_code_id: {
20924
+ description: "ID of the unmanaged access code to delete.",
20925
+ format: "uuid",
20926
+ type: "string"
20927
+ },
20928
+ sync: {
20929
+ default: false,
20930
+ type: "boolean",
20931
+ "x-undocumented": "Only used internally."
20932
+ }
19997
20933
  },
19998
20934
  required: ["access_code_id"],
19999
20935
  type: "object"
@@ -20033,20 +20969,33 @@ var openapi_default = {
20033
20969
  "x-action-attempt-type": "DELETE_ACCESS_CODE",
20034
20970
  "x-fern-sdk-group-name": ["access_codes", "unmanaged"],
20035
20971
  "x-fern-sdk-method-name": "delete",
20036
- "x-response-key": null
20972
+ "x-response-key": null,
20973
+ "x-title": "Delete an Unmanaged Access Code"
20037
20974
  }
20038
20975
  },
20039
20976
  "/access_codes/unmanaged/get": {
20040
20977
  post: {
20978
+ description: "Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.",
20041
20979
  operationId: "accessCodesUnmanagedGetPost",
20042
20980
  requestBody: {
20043
20981
  content: {
20044
20982
  "application/json": {
20045
20983
  schema: {
20046
20984
  properties: {
20047
- access_code_id: { format: "uuid", type: "string" },
20048
- code: { type: "string" },
20049
- device_id: { format: "uuid", type: "string" }
20985
+ access_code_id: {
20986
+ description: "ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
20987
+ format: "uuid",
20988
+ type: "string"
20989
+ },
20990
+ code: {
20991
+ description: "Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.",
20992
+ type: "string"
20993
+ },
20994
+ device_id: {
20995
+ description: "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`.",
20996
+ format: "uuid",
20997
+ type: "string"
20998
+ }
20050
20999
  },
20051
21000
  type: "object"
20052
21001
  }
@@ -20085,19 +21034,28 @@ var openapi_default = {
20085
21034
  "x-fern-sdk-group-name": ["access_codes", "unmanaged"],
20086
21035
  "x-fern-sdk-method-name": "get",
20087
21036
  "x-fern-sdk-return-value": "access_code",
20088
- "x-response-key": "access_code"
21037
+ "x-response-key": "access_code",
21038
+ "x-title": "Get an Unmanaged Access Code"
20089
21039
  }
20090
21040
  },
20091
21041
  "/access_codes/unmanaged/list": {
20092
21042
  post: {
21043
+ description: "Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
20093
21044
  operationId: "accessCodesUnmanagedListPost",
20094
21045
  requestBody: {
20095
21046
  content: {
20096
21047
  "application/json": {
20097
21048
  schema: {
20098
21049
  properties: {
20099
- device_id: { format: "uuid", type: "string" },
20100
- user_identifier_key: { type: "string" }
21050
+ device_id: {
21051
+ description: "ID of the device for which you want to list unmanaged access codes.",
21052
+ format: "uuid",
21053
+ type: "string"
21054
+ },
21055
+ user_identifier_key: {
21056
+ description: "Your user ID for the user by which to filter unmanaged access codes.",
21057
+ type: "string"
21058
+ }
20101
21059
  },
20102
21060
  required: ["device_id"],
20103
21061
  type: "object"
@@ -20140,21 +21098,36 @@ var openapi_default = {
20140
21098
  "x-fern-sdk-group-name": ["access_codes", "unmanaged"],
20141
21099
  "x-fern-sdk-method-name": "list",
20142
21100
  "x-fern-sdk-return-value": "access_codes",
20143
- "x-response-key": "access_codes"
21101
+ "x-response-key": "access_codes",
21102
+ "x-title": "List Unmanaged Access Codes"
20144
21103
  }
20145
21104
  },
20146
21105
  "/access_codes/unmanaged/update": {
20147
21106
  patch: {
21107
+ description: "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
20148
21108
  operationId: "accessCodesUnmanagedUpdatePatch",
20149
21109
  requestBody: {
20150
21110
  content: {
20151
21111
  "application/json": {
20152
21112
  schema: {
20153
21113
  properties: {
20154
- access_code_id: { format: "uuid", type: "string" },
20155
- allow_external_modification: { type: "boolean" },
20156
- force: { type: "boolean" },
20157
- is_external_modification_allowed: { type: "boolean" },
21114
+ access_code_id: {
21115
+ description: "ID of the unmanaged access code that you want to update.",
21116
+ format: "uuid",
21117
+ type: "string"
21118
+ },
21119
+ allow_external_modification: {
21120
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
21121
+ type: "boolean"
21122
+ },
21123
+ force: {
21124
+ description: "Indicates whether to force the unmanaged access code update.",
21125
+ type: "boolean"
21126
+ },
21127
+ is_external_modification_allowed: {
21128
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
21129
+ type: "boolean"
21130
+ },
20158
21131
  is_managed: { type: "boolean" }
20159
21132
  },
20160
21133
  required: ["access_code_id", "is_managed"],
@@ -20188,19 +21161,34 @@ var openapi_default = {
20188
21161
  summary: "/access_codes/unmanaged/update",
20189
21162
  tags: ["/access_codes"],
20190
21163
  "x-fern-ignore": true,
20191
- "x-response-key": null
21164
+ "x-response-key": null,
21165
+ "x-title": "Update an Unmanaged Access Code"
20192
21166
  },
20193
21167
  post: {
21168
+ description: "Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).",
20194
21169
  operationId: "accessCodesUnmanagedUpdatePost",
20195
21170
  requestBody: {
20196
21171
  content: {
20197
21172
  "application/json": {
20198
21173
  schema: {
20199
21174
  properties: {
20200
- access_code_id: { format: "uuid", type: "string" },
20201
- allow_external_modification: { type: "boolean" },
20202
- force: { type: "boolean" },
20203
- is_external_modification_allowed: { type: "boolean" },
21175
+ access_code_id: {
21176
+ description: "ID of the unmanaged access code that you want to update.",
21177
+ format: "uuid",
21178
+ type: "string"
21179
+ },
21180
+ allow_external_modification: {
21181
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
21182
+ type: "boolean"
21183
+ },
21184
+ force: {
21185
+ description: "Indicates whether to force the unmanaged access code update.",
21186
+ type: "boolean"
21187
+ },
21188
+ is_external_modification_allowed: {
21189
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.",
21190
+ type: "boolean"
21191
+ },
20204
21192
  is_managed: { type: "boolean" }
20205
21193
  },
20206
21194
  required: ["access_code_id", "is_managed"],
@@ -20235,47 +21223,101 @@ var openapi_default = {
20235
21223
  tags: ["/access_codes"],
20236
21224
  "x-fern-sdk-group-name": ["access_codes", "unmanaged"],
20237
21225
  "x-fern-sdk-method-name": "update",
20238
- "x-response-key": null
21226
+ "x-response-key": null,
21227
+ "x-title": "Update an Unmanaged Access Code"
20239
21228
  }
20240
21229
  },
20241
21230
  "/access_codes/update": {
20242
21231
  patch: {
21232
+ description: "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).",
20243
21233
  operationId: "accessCodesUpdatePatch",
20244
21234
  requestBody: {
20245
21235
  content: {
20246
21236
  "application/json": {
20247
21237
  schema: {
20248
21238
  properties: {
20249
- access_code_id: { format: "uuid", type: "string" },
20250
- allow_external_modification: { type: "boolean" },
21239
+ access_code_id: {
21240
+ description: "ID of the access code that you want to update.",
21241
+ format: "uuid",
21242
+ type: "string"
21243
+ },
21244
+ allow_external_modification: {
21245
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
21246
+ type: "boolean"
21247
+ },
20251
21248
  attempt_for_offline_device: {
20252
21249
  default: true,
20253
21250
  type: "boolean"
20254
21251
  },
20255
21252
  code: {
21253
+ description: "Code to be used for access.",
20256
21254
  maxLength: 9,
20257
21255
  minLength: 4,
20258
21256
  pattern: "^\\d+$",
20259
21257
  type: "string"
20260
21258
  },
20261
- device_id: { format: "uuid", type: "string" },
20262
- ends_at: { type: "string" },
20263
- is_external_modification_allowed: { type: "boolean" },
20264
- is_managed: { type: "boolean" },
20265
- is_offline_access_code: { type: "boolean" },
20266
- is_one_time_use: { type: "boolean" },
21259
+ device_id: {
21260
+ description: "ID of the device containing the access code that you want to update.",
21261
+ format: "uuid",
21262
+ type: "string"
21263
+ },
21264
+ ends_at: {
21265
+ description: "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`.",
21266
+ type: "string"
21267
+ },
21268
+ is_external_modification_allowed: {
21269
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
21270
+ type: "boolean"
21271
+ },
21272
+ is_managed: {
21273
+ description: "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`.",
21274
+ type: "boolean"
21275
+ },
21276
+ is_offline_access_code: {
21277
+ description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
21278
+ type: "boolean"
21279
+ },
21280
+ is_one_time_use: {
21281
+ description: "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.",
21282
+ type: "boolean"
21283
+ },
20267
21284
  max_time_rounding: {
20268
21285
  default: "1hour",
21286
+ description: "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`.",
20269
21287
  enum: ["1hour", "1day", "1h", "1d"],
20270
21288
  type: "string"
20271
21289
  },
20272
- name: { type: "string" },
20273
- prefer_native_scheduling: { type: "boolean" },
20274
- preferred_code_length: { format: "float", type: "number" },
20275
- starts_at: { type: "string" },
20276
- sync: { default: false, type: "boolean" },
20277
- type: { enum: ["ongoing", "time_bound"], type: "string" },
20278
- use_backup_access_code_pool: { type: "boolean" },
21290
+ name: {
21291
+ description: "Name of the new access code.",
21292
+ type: "string"
21293
+ },
21294
+ prefer_native_scheduling: {
21295
+ description: "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`.",
21296
+ type: "boolean"
21297
+ },
21298
+ preferred_code_length: {
21299
+ description: "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.",
21300
+ format: "float",
21301
+ type: "number"
21302
+ },
21303
+ starts_at: {
21304
+ description: "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.",
21305
+ type: "string"
21306
+ },
21307
+ sync: {
21308
+ default: false,
21309
+ type: "boolean",
21310
+ "x-undocumented": "Only used internally."
21311
+ },
21312
+ type: {
21313
+ description: "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).",
21314
+ enum: ["ongoing", "time_bound"],
21315
+ type: "string"
21316
+ },
21317
+ use_backup_access_code_pool: {
21318
+ description: "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).",
21319
+ type: "boolean"
21320
+ },
20279
21321
  use_offline_access_code: { type: "boolean" }
20280
21322
  },
20281
21323
  required: ["access_code_id"],
@@ -20315,45 +21357,99 @@ var openapi_default = {
20315
21357
  tags: ["/access_codes"],
20316
21358
  "x-action-attempt-type": "UPDATE_ACCESS_CODE",
20317
21359
  "x-fern-ignore": true,
20318
- "x-response-key": null
21360
+ "x-response-key": null,
21361
+ "x-title": "Update an Access Code"
20319
21362
  },
20320
21363
  post: {
21364
+ description: "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).",
20321
21365
  operationId: "accessCodesUpdatePost",
20322
21366
  requestBody: {
20323
21367
  content: {
20324
21368
  "application/json": {
20325
21369
  schema: {
20326
21370
  properties: {
20327
- access_code_id: { format: "uuid", type: "string" },
20328
- allow_external_modification: { type: "boolean" },
21371
+ access_code_id: {
21372
+ description: "ID of the access code that you want to update.",
21373
+ format: "uuid",
21374
+ type: "string"
21375
+ },
21376
+ allow_external_modification: {
21377
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
21378
+ type: "boolean"
21379
+ },
20329
21380
  attempt_for_offline_device: {
20330
21381
  default: true,
20331
21382
  type: "boolean"
20332
21383
  },
20333
21384
  code: {
21385
+ description: "Code to be used for access.",
20334
21386
  maxLength: 9,
20335
21387
  minLength: 4,
20336
21388
  pattern: "^\\d+$",
20337
21389
  type: "string"
20338
21390
  },
20339
- device_id: { format: "uuid", type: "string" },
20340
- ends_at: { type: "string" },
20341
- is_external_modification_allowed: { type: "boolean" },
20342
- is_managed: { type: "boolean" },
20343
- is_offline_access_code: { type: "boolean" },
20344
- is_one_time_use: { type: "boolean" },
21391
+ device_id: {
21392
+ description: "ID of the device containing the access code that you want to update.",
21393
+ format: "uuid",
21394
+ type: "string"
21395
+ },
21396
+ ends_at: {
21397
+ description: "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`.",
21398
+ type: "string"
21399
+ },
21400
+ is_external_modification_allowed: {
21401
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
21402
+ type: "boolean"
21403
+ },
21404
+ is_managed: {
21405
+ description: "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`.",
21406
+ type: "boolean"
21407
+ },
21408
+ is_offline_access_code: {
21409
+ description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
21410
+ type: "boolean"
21411
+ },
21412
+ is_one_time_use: {
21413
+ description: "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.",
21414
+ type: "boolean"
21415
+ },
20345
21416
  max_time_rounding: {
20346
21417
  default: "1hour",
21418
+ description: "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`.",
20347
21419
  enum: ["1hour", "1day", "1h", "1d"],
20348
21420
  type: "string"
20349
21421
  },
20350
- name: { type: "string" },
20351
- prefer_native_scheduling: { type: "boolean" },
20352
- preferred_code_length: { format: "float", type: "number" },
20353
- starts_at: { type: "string" },
20354
- sync: { default: false, type: "boolean" },
20355
- type: { enum: ["ongoing", "time_bound"], type: "string" },
20356
- use_backup_access_code_pool: { type: "boolean" },
21422
+ name: {
21423
+ description: "Name of the new access code.",
21424
+ type: "string"
21425
+ },
21426
+ prefer_native_scheduling: {
21427
+ description: "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`.",
21428
+ type: "boolean"
21429
+ },
21430
+ preferred_code_length: {
21431
+ description: "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.",
21432
+ format: "float",
21433
+ type: "number"
21434
+ },
21435
+ starts_at: {
21436
+ description: "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.",
21437
+ type: "string"
21438
+ },
21439
+ sync: {
21440
+ default: false,
21441
+ type: "boolean",
21442
+ "x-undocumented": "Only used internally."
21443
+ },
21444
+ type: {
21445
+ description: "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).",
21446
+ enum: ["ongoing", "time_bound"],
21447
+ type: "string"
21448
+ },
21449
+ use_backup_access_code_pool: {
21450
+ description: "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).",
21451
+ type: "boolean"
21452
+ },
20357
21453
  use_offline_access_code: { type: "boolean" }
20358
21454
  },
20359
21455
  required: ["access_code_id"],
@@ -20394,45 +21490,99 @@ var openapi_default = {
20394
21490
  "x-action-attempt-type": "UPDATE_ACCESS_CODE",
20395
21491
  "x-fern-sdk-group-name": ["access_codes"],
20396
21492
  "x-fern-sdk-method-name": "update",
20397
- "x-response-key": null
21493
+ "x-response-key": null,
21494
+ "x-title": "Update an Access Code"
20398
21495
  },
20399
21496
  put: {
21497
+ description: "Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).",
20400
21498
  operationId: "accessCodesUpdatePut",
20401
21499
  requestBody: {
20402
21500
  content: {
20403
21501
  "application/json": {
20404
21502
  schema: {
20405
21503
  properties: {
20406
- access_code_id: { format: "uuid", type: "string" },
20407
- allow_external_modification: { type: "boolean" },
21504
+ access_code_id: {
21505
+ description: "ID of the access code that you want to update.",
21506
+ format: "uuid",
21507
+ type: "string"
21508
+ },
21509
+ allow_external_modification: {
21510
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
21511
+ type: "boolean"
21512
+ },
20408
21513
  attempt_for_offline_device: {
20409
21514
  default: true,
20410
21515
  type: "boolean"
20411
21516
  },
20412
21517
  code: {
21518
+ description: "Code to be used for access.",
20413
21519
  maxLength: 9,
20414
21520
  minLength: 4,
20415
21521
  pattern: "^\\d+$",
20416
21522
  type: "string"
20417
21523
  },
20418
- device_id: { format: "uuid", type: "string" },
20419
- ends_at: { type: "string" },
20420
- is_external_modification_allowed: { type: "boolean" },
20421
- is_managed: { type: "boolean" },
20422
- is_offline_access_code: { type: "boolean" },
20423
- is_one_time_use: { type: "boolean" },
21524
+ device_id: {
21525
+ description: "ID of the device containing the access code that you want to update.",
21526
+ format: "uuid",
21527
+ type: "string"
21528
+ },
21529
+ ends_at: {
21530
+ description: "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`.",
21531
+ type: "string"
21532
+ },
21533
+ is_external_modification_allowed: {
21534
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.",
21535
+ type: "boolean"
21536
+ },
21537
+ is_managed: {
21538
+ description: "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`.",
21539
+ type: "boolean"
21540
+ },
21541
+ is_offline_access_code: {
21542
+ description: "Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).",
21543
+ type: "boolean"
21544
+ },
21545
+ is_one_time_use: {
21546
+ description: "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.",
21547
+ type: "boolean"
21548
+ },
20424
21549
  max_time_rounding: {
20425
21550
  default: "1hour",
21551
+ description: "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`.",
20426
21552
  enum: ["1hour", "1day", "1h", "1d"],
20427
21553
  type: "string"
20428
21554
  },
20429
- name: { type: "string" },
20430
- prefer_native_scheduling: { type: "boolean" },
20431
- preferred_code_length: { format: "float", type: "number" },
20432
- starts_at: { type: "string" },
20433
- sync: { default: false, type: "boolean" },
20434
- type: { enum: ["ongoing", "time_bound"], type: "string" },
20435
- use_backup_access_code_pool: { type: "boolean" },
21555
+ name: {
21556
+ description: "Name of the new access code.",
21557
+ type: "string"
21558
+ },
21559
+ prefer_native_scheduling: {
21560
+ description: "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`.",
21561
+ type: "boolean"
21562
+ },
21563
+ preferred_code_length: {
21564
+ description: "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.",
21565
+ format: "float",
21566
+ type: "number"
21567
+ },
21568
+ starts_at: {
21569
+ description: "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.",
21570
+ type: "string"
21571
+ },
21572
+ sync: {
21573
+ default: false,
21574
+ type: "boolean",
21575
+ "x-undocumented": "Only used internally."
21576
+ },
21577
+ type: {
21578
+ description: "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).",
21579
+ enum: ["ongoing", "time_bound"],
21580
+ type: "string"
21581
+ },
21582
+ use_backup_access_code_pool: {
21583
+ description: "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).",
21584
+ type: "boolean"
21585
+ },
20436
21586
  use_offline_access_code: { type: "boolean" }
20437
21587
  },
20438
21588
  required: ["access_code_id"],
@@ -20472,21 +21622,35 @@ var openapi_default = {
20472
21622
  tags: ["/access_codes"],
20473
21623
  "x-action-attempt-type": "UPDATE_ACCESS_CODE",
20474
21624
  "x-fern-ignore": true,
20475
- "x-response-key": null
21625
+ "x-response-key": null,
21626
+ "x-title": "Update an Access Code"
20476
21627
  }
20477
21628
  },
20478
21629
  "/access_codes/update_multiple": {
20479
21630
  patch: {
21631
+ description: "Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).",
20480
21632
  operationId: "accessCodesUpdateMultiplePatch",
20481
21633
  requestBody: {
20482
21634
  content: {
20483
21635
  "application/json": {
20484
21636
  schema: {
20485
21637
  properties: {
20486
- common_code_key: { type: "string" },
20487
- ends_at: { type: "string" },
20488
- name: { type: "string" },
20489
- starts_at: { type: "string" }
21638
+ common_code_key: {
21639
+ description: "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.",
21640
+ type: "string"
21641
+ },
21642
+ ends_at: {
21643
+ description: "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`.",
21644
+ type: "string"
21645
+ },
21646
+ name: {
21647
+ description: "Name of the new access code.",
21648
+ type: "string"
21649
+ },
21650
+ starts_at: {
21651
+ description: "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.",
21652
+ type: "string"
21653
+ }
20490
21654
  },
20491
21655
  required: ["common_code_key"],
20492
21656
  type: "object"
@@ -20519,19 +21683,33 @@ var openapi_default = {
20519
21683
  summary: "/access_codes/update_multiple",
20520
21684
  tags: ["/access_codes"],
20521
21685
  "x-fern-ignore": true,
20522
- "x-response-key": null
21686
+ "x-response-key": null,
21687
+ "x-title": "Update Multiple Linked Access Codes"
20523
21688
  },
20524
21689
  post: {
21690
+ description: "Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).",
20525
21691
  operationId: "accessCodesUpdateMultiplePost",
20526
21692
  requestBody: {
20527
21693
  content: {
20528
21694
  "application/json": {
20529
21695
  schema: {
20530
21696
  properties: {
20531
- common_code_key: { type: "string" },
20532
- ends_at: { type: "string" },
20533
- name: { type: "string" },
20534
- starts_at: { type: "string" }
21697
+ common_code_key: {
21698
+ description: "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.",
21699
+ type: "string"
21700
+ },
21701
+ ends_at: {
21702
+ description: "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`.",
21703
+ type: "string"
21704
+ },
21705
+ name: {
21706
+ description: "Name of the new access code.",
21707
+ type: "string"
21708
+ },
21709
+ starts_at: {
21710
+ description: "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.",
21711
+ type: "string"
21712
+ }
20535
21713
  },
20536
21714
  required: ["common_code_key"],
20537
21715
  type: "object"
@@ -20565,7 +21743,8 @@ var openapi_default = {
20565
21743
  tags: ["/access_codes"],
20566
21744
  "x-fern-sdk-group-name": ["access_codes"],
20567
21745
  "x-fern-sdk-method-name": "update_multiple",
20568
- "x-response-key": null
21746
+ "x-response-key": null,
21747
+ "x-title": "Update Multiple Linked Access Codes"
20569
21748
  }
20570
21749
  },
20571
21750
  "/acs/access_groups/add_user": {