@seamapi/types 1.359.0 → 1.360.1

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 (36) hide show
  1. package/dist/connect.cjs +964 -570
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +3805 -2953
  4. package/lib/seam/connect/models/acs/acs-credential.js +94 -51
  5. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-encoder.js +12 -7
  7. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js +37 -14
  9. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-system.js +48 -41
  11. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-user.js +45 -32
  13. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  14. package/lib/seam/connect/models/events/devices.d.ts +60 -0
  15. package/lib/seam/connect/models/events/devices.js +10 -0
  16. package/lib/seam/connect/models/events/devices.js.map +1 -1
  17. package/lib/seam/connect/models/events/seam-event.d.ts +30 -1
  18. package/lib/seam/connect/models/thermostats/climate-preset.js +12 -10
  19. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  20. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +19 -12
  21. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  22. package/lib/seam/connect/openapi.d.ts +161 -23
  23. package/lib/seam/connect/openapi.js +611 -401
  24. package/lib/seam/connect/openapi.js.map +1 -1
  25. package/lib/seam/connect/route-types.d.ts +3615 -2930
  26. package/package.json +2 -2
  27. package/src/lib/seam/connect/models/acs/acs-credential.ts +162 -51
  28. package/src/lib/seam/connect/models/acs/acs-encoder.ts +22 -7
  29. package/src/lib/seam/connect/models/acs/acs-entrance.ts +65 -18
  30. package/src/lib/seam/connect/models/acs/acs-system.ts +81 -52
  31. package/src/lib/seam/connect/models/acs/acs-user.ts +69 -32
  32. package/src/lib/seam/connect/models/events/devices.ts +13 -0
  33. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +28 -10
  34. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +31 -12
  35. package/src/lib/seam/connect/openapi.ts +755 -401
  36. package/src/lib/seam/connect/route-types.ts +3617 -2928
package/dist/connect.cjs CHANGED
@@ -214,13 +214,23 @@ zod.z.array(fan_mode_setting);
214
214
 
215
215
  // src/lib/seam/connect/models/thermostats/climate-preset.ts
216
216
  var climate_preset = zod.z.object({
217
- climate_preset_key: zod.z.string().describe("Unique key to identify the climate preset."),
218
- can_edit: zod.z.boolean().describe("Indicates whether this climate preset key can be edited."),
219
- can_delete: zod.z.boolean().describe("Indicates whether this climate preset key can be deleted."),
220
- name: zod.z.string().nullable().default(null).optional().describe("User-friendly name to identify the climate preset."),
221
- display_name: zod.z.string().describe("Display name for the climate preset."),
217
+ climate_preset_key: zod.z.string().describe(
218
+ "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)."
219
+ ),
220
+ can_edit: zod.z.boolean().describe(
221
+ "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited."
222
+ ),
223
+ can_delete: zod.z.boolean().describe(
224
+ "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted."
225
+ ),
226
+ name: zod.z.string().nullable().default(null).optional().describe(
227
+ "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)."
228
+ ),
229
+ display_name: zod.z.string().describe(
230
+ "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)."
231
+ ),
222
232
  fan_mode_setting: fan_mode_setting.optional().describe(
223
- "Desired fan mode setting, such as `on`, `auto`, or `circulate`."
233
+ "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`."
224
234
  ),
225
235
  hvac_mode_setting: hvac_mode_setting.optional().describe(
226
236
  "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`."
@@ -228,49 +238,67 @@ var climate_preset = zod.z.object({
228
238
  cooling_set_point_celsius: zod.z.number().optional().describe(
229
239
  "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)."
230
240
  ),
231
- heating_set_point_celsius: zod.z.number().optional().describe("Temperature to which the thermostat should heat (in \xB0C)."),
232
- cooling_set_point_fahrenheit: zod.z.number().optional().describe("Temperature to which the thermostat should cool (in \xB0F)."),
233
- heating_set_point_fahrenheit: zod.z.number().optional().describe("Temperature to which the thermostat should heat (in \xB0F)."),
241
+ heating_set_point_celsius: zod.z.number().optional().describe(
242
+ "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)."
243
+ ),
244
+ cooling_set_point_fahrenheit: zod.z.number().optional().describe(
245
+ "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)."
246
+ ),
247
+ heating_set_point_fahrenheit: zod.z.number().optional().describe(
248
+ "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)."
249
+ ),
234
250
  manual_override_allowed: zod.z.boolean().describe(
235
251
  `
236
252
  ---
237
253
  deprecated: Use 'thermostat_schedule.is_override_allowed'
238
254
  ---
239
- Indicates whether a person at the thermostat can change the thermostat's settings.`
255
+ Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).`
240
256
  )
241
257
  });
242
258
  var climate_setting = climate_preset.partial();
243
259
  var thermostat_schedule = zod.z.object({
244
- thermostat_schedule_id: zod.z.string().uuid().describe("ID of the thermostat schedule."),
245
- device_id: zod.z.string().uuid().describe("ID of the desired thermostat device."),
246
- name: zod.z.string().optional().describe("User-friendly name to identify the thermostat schedule."),
260
+ thermostat_schedule_id: zod.z.string().uuid().describe(
261
+ "ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)."
262
+ ),
263
+ device_id: zod.z.string().uuid().describe(
264
+ "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device."
265
+ ),
266
+ name: zod.z.string().optional().describe(
267
+ "User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)."
268
+ ),
247
269
  climate_preset_key: zod.z.string().describe(
248
- "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule."
270
+ "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)."
249
271
  ),
250
272
  max_override_period_minutes: zod.z.number().int().nonnegative().describe(
251
- "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)."
273
+ "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)."
252
274
  ),
253
275
  starts_at: zod.z.string().datetime().describe(
254
- "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
276
+ "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
255
277
  ),
256
278
  unstable_is_override_allowed: zod.z.boolean().optional().describe(
257
279
  `
258
280
  ---
259
281
  undocumented: Unstable
260
282
  ---
261
- Indicates whether a person at the thermostat can change the thermostat's settings.`
283
+ Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.`
262
284
  ),
263
285
  ends_at: zod.z.string().datetime().describe(
264
- "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
286
+ "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
287
+ ),
288
+ created_at: zod.z.string().datetime().describe(
289
+ "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created."
265
290
  ),
266
- created_at: zod.z.string().datetime().describe("Date and time at which the thermostat schedule was created."),
267
291
  errors: zod.z.array(
268
292
  zod.z.object({
269
- error_code: zod.z.string(),
270
- message: zod.z.string()
293
+ error_code: zod.z.string().describe(
294
+ "Unique identifier of the type of error. Enables quick recognition and categorization of the issue."
295
+ ),
296
+ message: zod.z.string().describe(
297
+ "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
298
+ )
271
299
  })
272
300
  ).describe(
273
- "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it."
301
+ "Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules)."
274
302
  )
275
303
  }).describe(`
276
304
  ---
@@ -1663,29 +1691,33 @@ var common_acs_credential_warning = zod.z.object({
1663
1691
  var warning_code_description5 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
1664
1692
  var waiting_to_be_issued = common_acs_credential_warning.extend({
1665
1693
  warning_code: zod.z.literal("waiting_to_be_issued").describe(warning_code_description5)
1666
- }).describe("Indicates that the credential is waiting to be issued.");
1694
+ }).describe(
1695
+ "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued."
1696
+ );
1667
1697
  var schedule_externally_modified = common_acs_credential_warning.extend({
1668
1698
  warning_code: zod.z.literal("schedule_externally_modified").describe(warning_code_description5)
1669
1699
  }).describe(
1670
- "Indicates that the schedule of one of the credential's children was modified externally."
1700
+ "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally."
1671
1701
  );
1672
1702
  var schedule_modified = common_acs_credential_warning.extend({
1673
1703
  warning_code: zod.z.literal("schedule_modified").describe(warning_code_description5)
1674
1704
  }).describe(
1675
- "Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past."
1705
+ "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past."
1676
1706
  );
1677
1707
  var being_deleted = common_acs_credential_warning.extend({
1678
1708
  warning_code: zod.z.literal("being_deleted").describe(warning_code_description5)
1679
- }).describe("Indicates that this credential is being deleted.");
1709
+ }).describe(
1710
+ "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted."
1711
+ );
1680
1712
  var unknown_issue_with_acs_credential = common_acs_credential_warning.extend({
1681
1713
  warning_code: zod.z.literal("unknown_issue_with_acs_credential").describe(warning_code_description5)
1682
1714
  }).describe(
1683
- "An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential."
1715
+ "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential."
1684
1716
  );
1685
1717
  var needs_to_be_reissued = common_acs_credential_warning.extend({
1686
1718
  warning_code: zod.z.literal("needs_to_be_reissued").describe(warning_code_description5)
1687
1719
  }).describe(
1688
- "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential."
1720
+ "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential."
1689
1721
  );
1690
1722
  var acs_credential_warning = zod.z.discriminatedUnion("warning_code", [
1691
1723
  waiting_to_be_issued,
@@ -1694,7 +1726,9 @@ var acs_credential_warning = zod.z.discriminatedUnion("warning_code", [
1694
1726
  being_deleted,
1695
1727
  unknown_issue_with_acs_credential,
1696
1728
  needs_to_be_reissued
1697
- ]).describe("Warning associated with the `acs_credential`.");
1729
+ ]).describe(
1730
+ "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1731
+ );
1698
1732
  zod.z.object({
1699
1733
  waiting_to_be_issued: waiting_to_be_issued.optional().nullable(),
1700
1734
  schedule_externally_modified: schedule_externally_modified.optional().nullable(),
@@ -1704,56 +1738,84 @@ zod.z.object({
1704
1738
  needs_to_be_reissued: needs_to_be_reissued.optional().nullable()
1705
1739
  });
1706
1740
  var common_acs_credential = zod.z.object({
1707
- acs_credential_id: zod.z.string().uuid().describe("ID of the credential."),
1708
- acs_user_id: zod.z.string().uuid().optional().describe("ID of the ACS user to whom the credential belongs."),
1741
+ acs_credential_id: zod.z.string().uuid().describe(
1742
+ "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1743
+ ),
1744
+ acs_user_id: zod.z.string().uuid().optional().describe(
1745
+ "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs."
1746
+ ),
1709
1747
  acs_credential_pool_id: zod.z.string().uuid().optional(),
1710
- acs_system_id: zod.z.string().uuid().describe("ID of the access control system that contains the credential."),
1711
- parent_acs_credential_id: zod.z.string().uuid().optional().describe("ID of the parent credential."),
1712
- display_name: zod.z.string().min(1).describe("Display name that corresponds to the credential type."),
1713
- code: zod.z.string().optional().nullable().describe("Access (PIN) code for the credential."),
1748
+ acs_system_id: zod.z.string().uuid().describe(
1749
+ "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1750
+ ),
1751
+ parent_acs_credential_id: zod.z.string().uuid().optional().describe(
1752
+ "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1753
+ ),
1754
+ display_name: zod.z.string().min(1).describe(
1755
+ "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type."
1756
+ ),
1757
+ code: zod.z.string().optional().nullable().describe(
1758
+ "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1759
+ ),
1714
1760
  is_one_time_use: zod.z.boolean().optional().describe(
1715
- 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.'
1761
+ "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use."
1762
+ ),
1763
+ card_number: zod.z.string().optional().nullable().describe(
1764
+ "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1765
+ ),
1766
+ is_issued: zod.z.boolean().optional().describe(
1767
+ "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card."
1768
+ ),
1769
+ issued_at: zod.z.string().datetime().optional().nullable().describe(
1770
+ "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card."
1716
1771
  ),
1717
- card_number: zod.z.string().optional().nullable(),
1718
- is_issued: zod.z.boolean().optional(),
1719
- issued_at: zod.z.string().datetime().optional().nullable(),
1720
1772
  access_method: acs_credential_access_method_type.describe(
1721
- "Access method for the credential. Supported values: `code`, `card`, `mobile_key`."
1773
+ "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`."
1722
1774
  ),
1723
1775
  external_type: acs_credential_external_type.optional().describe(
1724
- "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`."
1776
+ "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`."
1725
1777
  ),
1726
1778
  external_type_display_name: zod.z.string().optional().describe(
1727
- "Display name that corresponds to the brand-specific terminology for the credential type."
1779
+ "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type."
1780
+ ),
1781
+ created_at: zod.z.string().datetime().describe(
1782
+ "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created."
1728
1783
  ),
1729
- created_at: zod.z.string().datetime().describe("Date and time at which the credential was created."),
1730
1784
  workspace_id: zod.z.string().uuid().describe(
1731
- "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential."
1785
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1732
1786
  ),
1733
1787
  starts_at: zod.z.string().optional().describe(
1734
- "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
1788
+ "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
1735
1789
  ),
1736
1790
  ends_at: zod.z.string().optional().describe(
1737
- "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`."
1791
+ "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`."
1738
1792
  ),
1739
1793
  errors: zod.z.array(
1740
1794
  zod.z.object({
1741
1795
  error_code: zod.z.string(),
1742
1796
  message: zod.z.string()
1743
1797
  })
1744
- ).describe("Errors associated with the `acs_credential`."),
1745
- warnings: zod.z.array(acs_credential_warning).describe("Warnings associated with the `acs_credential`."),
1798
+ ).describe(
1799
+ "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1800
+ ),
1801
+ warnings: zod.z.array(acs_credential_warning).describe(
1802
+ "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1803
+ ),
1746
1804
  is_multi_phone_sync_credential: zod.z.boolean().optional().describe(
1747
- "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)."
1805
+ "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)."
1748
1806
  ),
1749
1807
  is_latest_desired_state_synced_with_provider: zod.z.boolean().nullable().optional().describe(
1750
- "Indicates whether the latest state of the credential has been synced from Seam to the provider."
1808
+ "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider."
1751
1809
  ),
1752
1810
  latest_desired_state_synced_with_provider_at: zod.z.string().datetime().nullable().optional().describe(
1753
- "Date and time at which the state of the credential was most recently synced from Seam to the provider."
1811
+ "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider."
1754
1812
  ),
1755
- visionline_metadata: acs_credential_visionline_metadata.optional().describe("Visionline-specific metadata for the credential."),
1756
- assa_abloy_vostio_metadata: acs_credential_vostio_metadata.optional().describe("Vostio-specific metadata for the credential.")
1813
+ visionline_metadata: acs_credential_visionline_metadata.optional().describe(
1814
+ "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1815
+ ),
1816
+ assa_abloy_vostio_metadata: acs_credential_vostio_metadata.optional().describe(
1817
+ "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1818
+ )
1757
1819
  });
1758
1820
  var acs_credential = common_acs_credential.merge(
1759
1821
  zod.z.object({
@@ -1763,7 +1825,7 @@ var acs_credential = common_acs_credential.merge(
1763
1825
  ---
1764
1826
  route_path: /acs/credentials
1765
1827
  ---
1766
- Means by which a user gains access at an entrance. The \`acs_credential\` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
1828
+ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
1767
1829
  `);
1768
1830
  var unmanaged_acs_credential = common_acs_credential.merge(
1769
1831
  zod.z.object({
@@ -1773,29 +1835,63 @@ var unmanaged_acs_credential = common_acs_credential.merge(
1773
1835
  ---
1774
1836
  route_path: /acs/credentials/unmanaged
1775
1837
  ---
1776
- Means by which a user gains access at an entrance. The \`unmanaged_acs_credential\` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
1838
+ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`unmanaged_acs_credential\` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each \`acs_credential\` object, you define the access method. You can also specify additional properties, such as a PIN code.
1777
1839
  `);
1778
1840
  var acs_credential_on_encoder = zod.z.object({
1779
- created_at: zod.z.string().datetime().nullable().describe("Date and time the credential was created."),
1841
+ created_at: zod.z.string().datetime().nullable().describe(
1842
+ "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created."
1843
+ ),
1780
1844
  is_issued: zod.z.boolean().nullable(),
1781
- starts_at: zod.z.string().datetime().nullable().describe("Date and time the credential will become useable."),
1782
- ends_at: zod.z.string().datetime().nullable().describe("Date and time the credential will stop being useable."),
1783
- card_number: zod.z.string().nullable().describe("A number or string that physically identifies this card."),
1845
+ starts_at: zod.z.string().datetime().nullable().describe(
1846
+ "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable."
1847
+ ),
1848
+ ends_at: zod.z.string().datetime().nullable().describe(
1849
+ "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable."
1850
+ ),
1851
+ card_number: zod.z.string().nullable().describe(
1852
+ "A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1853
+ ),
1784
1854
  visionline_metadata: zod.z.object({
1785
- card_id: zod.z.string(),
1855
+ card_id: zod.z.string().describe(
1856
+ "Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1857
+ ),
1786
1858
  // TODO card_function_type: z.enum(["guest", "staff"]), // computed, looks at door ops, and checks is guest op is present.
1787
- cancelled: zod.z.boolean(),
1788
- discarded: zod.z.boolean(),
1789
- expired: zod.z.boolean(),
1790
- overwritten: zod.z.boolean(),
1791
- overridden: zod.z.boolean().optional(),
1792
- pending_auto_update: zod.z.boolean(),
1793
- card_format: zod.z.enum(["TLCode", "rfid48"]),
1794
- card_holder: zod.z.string().optional(),
1795
- number_of_issued_cards: zod.z.number(),
1796
- guest_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional(),
1797
- common_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
1798
- }).optional().describe("Visionline-specific metadata for the credential.")
1859
+ cancelled: zod.z.boolean().describe(
1860
+ "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled."
1861
+ ),
1862
+ discarded: zod.z.boolean().describe(
1863
+ "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded."
1864
+ ),
1865
+ expired: zod.z.boolean().describe(
1866
+ "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired."
1867
+ ),
1868
+ overwritten: zod.z.boolean().describe(
1869
+ "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten."
1870
+ ),
1871
+ overridden: zod.z.boolean().optional().describe(
1872
+ "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden."
1873
+ ),
1874
+ pending_auto_update: zod.z.boolean().describe(
1875
+ "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update."
1876
+ ),
1877
+ card_format: zod.z.enum(["TLCode", "rfid48"]).describe(
1878
+ "Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1879
+ ),
1880
+ card_holder: zod.z.string().optional().describe(
1881
+ "Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1882
+ ),
1883
+ number_of_issued_cards: zod.z.number().describe(
1884
+ "Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1885
+ ),
1886
+ guest_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
1887
+ "IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1888
+ ),
1889
+ common_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
1890
+ "IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1891
+ )
1892
+ }).optional().describe(
1893
+ "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
1894
+ )
1799
1895
  });
1800
1896
  var common_acs_encoder_error = zod.z.object({
1801
1897
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
@@ -1809,22 +1905,32 @@ var acs_encoder_removed = common_acs_encoder_error.extend({
1809
1905
  });
1810
1906
  var acs_encoder_error = (
1811
1907
  // z.union([
1812
- acs_encoder_removed.describe("Error associated with the `acs_encoder`.")
1908
+ acs_encoder_removed.describe(
1909
+ "Error associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
1910
+ )
1813
1911
  );
1814
1912
  zod.z.object({
1815
1913
  acs_encoder_removed: acs_encoder_removed.optional().nullable()
1816
1914
  });
1817
1915
  var acs_encoder = zod.z.object({
1818
- acs_encoder_id: zod.z.string().uuid().describe("ID of the `acs_encoder`."),
1916
+ acs_encoder_id: zod.z.string().uuid().describe(
1917
+ "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners."
1918
+ ),
1819
1919
  acs_system_id: zod.z.string().uuid().describe(
1820
- "ID of the access control system that contains the `acs_encoder`."
1920
+ "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
1821
1921
  ),
1822
1922
  workspace_id: zod.z.string().uuid().describe(
1823
- "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`."
1923
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
1924
+ ),
1925
+ errors: zod.z.array(acs_encoder_error).describe(
1926
+ "Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
1824
1927
  ),
1825
- errors: zod.z.array(acs_encoder_error).describe("Errors associated with the `acs_encoder`."),
1826
- created_at: zod.z.string().datetime().describe("Date and time at which the `acs_encoder` was created."),
1827
- display_name: zod.z.string().describe("Display name for the `acs_encoder`.")
1928
+ created_at: zod.z.string().datetime().describe(
1929
+ "Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created."
1930
+ ),
1931
+ display_name: zod.z.string().describe(
1932
+ "Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners)."
1933
+ )
1828
1934
  }).describe(`
1829
1935
  ---
1830
1936
  route_path: /acs/encoders
@@ -1839,22 +1945,48 @@ var acs_entrance_salto_space_metadata = zod.z.object({
1839
1945
 
1840
1946
  // src/lib/seam/connect/models/acs/acs-entrance.ts
1841
1947
  var acs_entrance = zod.z.object({
1842
- acs_system_id: zod.z.string().uuid().describe("ID of the access control system that contains the entrance."),
1843
- acs_entrance_id: zod.z.string().uuid().describe("ID of the entrance."),
1844
- created_at: zod.z.string().datetime().describe("Date and time at which the entrance was created."),
1845
- display_name: zod.z.string().describe("Display name for the entrance."),
1948
+ acs_system_id: zod.z.string().uuid().describe(
1949
+ "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1950
+ ),
1951
+ acs_entrance_id: zod.z.string().uuid().describe(
1952
+ "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1953
+ ),
1954
+ created_at: zod.z.string().datetime().describe(
1955
+ "Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created."
1956
+ ),
1957
+ display_name: zod.z.string().describe(
1958
+ "Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1959
+ ),
1846
1960
  errors: zod.z.array(
1847
1961
  zod.z.object({
1848
- error_code: zod.z.string(),
1849
- message: zod.z.string()
1962
+ error_code: zod.z.string().describe(
1963
+ "Unique identifier of the type of error. Enables quick recognition and categorization of the issue."
1964
+ ),
1965
+ message: zod.z.string().describe(
1966
+ "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
1967
+ )
1850
1968
  })
1969
+ ).describe(
1970
+ "Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1851
1971
  ),
1852
- latch_metadata: acs_entrance_latch_metadata.optional(),
1853
- visionline_metadata: acs_entrance_visionline_metadata.optional(),
1854
- salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
1855
- dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata.optional(),
1856
- assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata.optional(),
1857
- salto_space_metadata: acs_entrance_salto_space_metadata.optional()
1972
+ latch_metadata: acs_entrance_latch_metadata.optional().describe(
1973
+ "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1974
+ ),
1975
+ visionline_metadata: acs_entrance_visionline_metadata.optional().describe(
1976
+ "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1977
+ ),
1978
+ salto_ks_metadata: acs_entrance_salto_ks_metadata.optional().describe(
1979
+ "Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1980
+ ),
1981
+ dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata.optional().describe(
1982
+ "dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1983
+ ),
1984
+ assa_abloy_vostio_metadata: acs_entrance_assa_abloy_vostio_metadata.optional().describe(
1985
+ "ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1986
+ ),
1987
+ salto_space_metadata: acs_entrance_salto_space_metadata.optional().describe(
1988
+ "Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
1989
+ )
1858
1990
  }).describe(`
1859
1991
  ---
1860
1992
  route_path: /acs/entrances
@@ -1863,20 +1995,22 @@ var acs_entrance = zod.z.object({
1863
1995
  `);
1864
1996
  var acs_system_capability_flags = zod.z.object({
1865
1997
  can_automate_enrollment: zod.z.boolean().optional().describe(
1866
- "Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`."
1998
+ "Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
1867
1999
  ),
1868
2000
  can_create_acs_access_groups: zod.z.boolean().optional().describe(
1869
- "Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems)."
2001
+ "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems)."
1870
2002
  ),
1871
2003
  can_remove_acs_users_from_acs_access_groups: zod.z.boolean().optional().describe(
1872
- "Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems)."
2004
+ "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems)."
1873
2005
  ),
1874
2006
  can_add_acs_users_to_acs_access_groups: zod.z.boolean().optional().describe(
1875
- "Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems)."
2007
+ "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems)."
1876
2008
  )
1877
2009
  });
1878
2010
  var location = zod.z.object({
1879
- time_zone: zod.z.string().nullable().describe("Time zone in which the `acs_system` is located.")
2011
+ time_zone: zod.z.string().nullable().describe(
2012
+ "Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located."
2013
+ )
1880
2014
  });
1881
2015
  var acs_system_external_type = zod.z.enum([
1882
2016
  "pti_site",
@@ -1900,14 +2034,15 @@ var common_acs_system_error = zod.z.object({
1900
2034
  )
1901
2035
  });
1902
2036
  var error_code_description5 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
2037
+ var warning_code_description6 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
1903
2038
  var seam_bridge_disconnected = common_acs_system_error.extend({
1904
2039
  error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description5)
1905
- }).describe(`Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
1906
- This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
2040
+ }).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
2041
+ This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
1907
2042
  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
1908
2043
  var visionline_instance_unreachable = common_acs_system_error.extend({
1909
2044
  error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description5)
1910
- }).describe(`Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
2045
+ }).describe(`Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
1911
2046
  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
1912
2047
  See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`);
1913
2048
  var salto_ks_subscription_limit_exceeded2 = common_acs_system_error.extend({
@@ -1918,18 +2053,18 @@ var salto_ks_subscription_limit_exceeded2 = common_acs_system_error.extend({
1918
2053
  var acs_system_disconnected = common_acs_system_error.extend({
1919
2054
  error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description5)
1920
2055
  }).describe(
1921
- "Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue."
2056
+ "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue."
1922
2057
  );
1923
2058
  var account_disconnected2 = common_acs_system_error.extend({
1924
2059
  error_code: zod.z.literal("account_disconnected").describe(error_code_description5)
1925
2060
  }).describe(
1926
- "Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access."
2061
+ "Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access."
1927
2062
  );
1928
2063
  var salto_ks_certification_expired = common_acs_system_error.extend({
1929
- error_code: zod.z.literal("salto_ks_certification_expired").describe(
1930
- "Indicates that the access system has lost its Salto KS certification. Please contact support to regain access."
1931
- )
1932
- });
2064
+ error_code: zod.z.literal("salto_ks_certification_expired").describe(error_code_description5)
2065
+ }).describe(
2066
+ "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access."
2067
+ );
1933
2068
  var acs_system_error = zod.z.discriminatedUnion("error_code", [
1934
2069
  seam_bridge_disconnected,
1935
2070
  visionline_instance_unreachable,
@@ -1937,7 +2072,9 @@ var acs_system_error = zod.z.discriminatedUnion("error_code", [
1937
2072
  acs_system_disconnected,
1938
2073
  account_disconnected2,
1939
2074
  salto_ks_certification_expired
1940
- ]).describe("Error associated with the `acs_system`.");
2075
+ ]).describe(
2076
+ "Error associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2077
+ );
1941
2078
  zod.z.object({
1942
2079
  seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
1943
2080
  visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
@@ -1953,39 +2090,40 @@ var common_acs_system_warning = zod.z.object({
1953
2090
  )
1954
2091
  });
1955
2092
  var salto_ks_subscription_limit_almost_reached2 = common_acs_system_warning.extend({
1956
- warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(
1957
- "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this."
1958
- )
1959
- });
2093
+ warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description6)
2094
+ }).describe(
2095
+ "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue."
2096
+ );
1960
2097
  var time_zone_does_not_match_location = common_acs_system_warning.extend({
1961
- warning_code: zod.z.literal("time_zone_does_not_match_location").describe(
1962
- "Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances."
1963
- ),
2098
+ warning_code: zod.z.literal("time_zone_does_not_match_location").describe(warning_code_description6),
1964
2099
  misconfigured_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
1965
- });
2100
+ }).describe(
2101
+ "Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
2102
+ );
1966
2103
  var acs_system_warning = zod.z.discriminatedUnion("warning_code", [
1967
2104
  salto_ks_subscription_limit_almost_reached2,
1968
2105
  time_zone_does_not_match_location
1969
- ]).describe("Warning associated with the `acs_system`.");
2106
+ ]).describe(
2107
+ "Warning associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2108
+ );
1970
2109
  zod.z.object({
1971
2110
  salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached2.optional().nullable(),
1972
2111
  time_zone_does_not_match_location: time_zone_does_not_match_location.optional().nullable()
1973
2112
  });
1974
2113
  var acs_system = zod.z.object({
1975
2114
  default_credential_manager_acs_system_id: zod.z.string().uuid().nullable().optional().describe(
1976
- `
1977
- ---
1978
- draft: Needs review
1979
- ---
1980
- ID of the default credential manager acs_system for this access control system.
1981
- `
2115
+ "ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2116
+ ),
2117
+ acs_system_id: zod.z.string().uuid().describe(
2118
+ "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
1982
2119
  ),
1983
- acs_system_id: zod.z.string().uuid().describe("ID of the `acs_system`."),
1984
- external_type: acs_system_external_type.describe("Brand-specific terminology for the `acs_system` type.").optional(),
2120
+ external_type: acs_system_external_type.describe(
2121
+ "Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type."
2122
+ ).optional(),
1985
2123
  external_type_display_name: zod.z.string().describe(
1986
- "Display name that corresponds to the brand-specific terminology for the `acs_system` type."
2124
+ "Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type."
1987
2125
  ).optional(),
1988
- is_credential_manager: zod.z.boolean().describe("Indicates if the `acs_system` is a credential manager."),
2126
+ is_credential_manager: zod.z.boolean().describe("Indicates whether the `acs_system` is a credential manager."),
1989
2127
  visionline_metadata: zod.z.object({
1990
2128
  mobile_access_uuid: zod.z.string().describe(
1991
2129
  "Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset."
@@ -1994,7 +2132,7 @@ var acs_system = zod.z.object({
1994
2132
  "Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager."
1995
2133
  ),
1996
2134
  lan_address: zod.z.string().describe(
1997
- "IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network."
2135
+ "IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network."
1998
2136
  )
1999
2137
  }).optional(),
2000
2138
  system_type: acs_system_external_type.describe(
@@ -2010,24 +2148,36 @@ var acs_system = zod.z.object({
2010
2148
  ---
2011
2149
  `),
2012
2150
  location,
2013
- name: zod.z.string().describe("Name of the `acs_system`."),
2014
- created_at: zod.z.string().datetime().describe("Date and time at which the `acs_system` was created."),
2151
+ name: zod.z.string().describe(
2152
+ "Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2153
+ ),
2154
+ created_at: zod.z.string().datetime().describe(
2155
+ "Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created."
2156
+ ),
2015
2157
  workspace_id: zod.z.string().uuid().describe(
2016
- "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`."
2158
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2017
2159
  ),
2018
2160
  connected_account_ids: zod.z.array(zod.z.string().uuid()).describe(`
2019
2161
  ---
2020
2162
  deprecated: Use \`connected_account_id\`.
2021
2163
  ---
2022
- IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the \`acs_system\`.
2164
+ IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
2023
2165
  `),
2024
2166
  connected_account_id: zod.z.string().uuid().describe(
2025
- "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`."
2167
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2168
+ ),
2169
+ image_url: zod.z.string().describe(
2170
+ "URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2171
+ ),
2172
+ image_alt_text: zod.z.string().describe(
2173
+ "Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image."
2026
2174
  ),
2027
- image_url: zod.z.string().describe("URL for the image that represents the `acs_system`."),
2028
- image_alt_text: zod.z.string().describe("Alternative text for the `acs_system` image."),
2029
- errors: zod.z.array(acs_system_error).describe("Errors associated with the `acs_system`."),
2030
- warnings: zod.z.array(acs_system_warning).describe("Warnings associated with the `acs_system`.")
2175
+ errors: zod.z.array(acs_system_error).describe(
2176
+ "Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2177
+ ),
2178
+ warnings: zod.z.array(acs_system_warning).describe(
2179
+ "Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2180
+ )
2031
2181
  }).merge(acs_system_capability_flags).describe(`
2032
2182
  ---
2033
2183
  route_path: /acs/systems
@@ -2071,27 +2221,27 @@ var common_acs_user_error = zod.z.object({
2071
2221
  var acs_users_deleted_externally = common_acs_user_error.extend({
2072
2222
  error_code: zod.z.literal("deleted_externally")
2073
2223
  }).describe(
2074
- `Indicates that the ACS user was deleted from the ACS system outside of Seam.`
2224
+ `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.`
2075
2225
  );
2076
2226
  var acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error.extend({
2077
2227
  error_code: zod.z.literal("salto_ks_subscription_limit_exceeded")
2078
2228
  }).describe(
2079
- `Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.`
2229
+ `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.`
2080
2230
  );
2081
2231
  var acs_users_failed_to_create_on_acs_system = common_acs_user_error.extend({
2082
2232
  error_code: zod.z.literal("failed_to_create_on_acs_system")
2083
2233
  }).describe(
2084
- `Indicates that the user was not created on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`
2234
+ `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`
2085
2235
  );
2086
2236
  var acs_users_failed_to_update_on_acs_system = common_acs_user_error.extend({
2087
2237
  error_code: zod.z.literal("failed_to_update_on_acs_system")
2088
2238
  }).describe(
2089
- `Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`
2239
+ `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`
2090
2240
  );
2091
2241
  var acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
2092
2242
  error_code: zod.z.literal("failed_to_delete_on_acs_system")
2093
2243
  }).describe(
2094
- `Indicates that the user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.`
2244
+ `Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`
2095
2245
  );
2096
2246
  var acs_user_errors = zod.z.discriminatedUnion("error_code", [
2097
2247
  acs_users_deleted_externally,
@@ -2099,7 +2249,9 @@ var acs_user_errors = zod.z.discriminatedUnion("error_code", [
2099
2249
  acs_users_failed_to_create_on_acs_system,
2100
2250
  acs_users_failed_to_update_on_acs_system,
2101
2251
  acs_users_failed_to_delete_on_acs_system
2102
- ]).describe("Error associated with the `acs_user`.");
2252
+ ]).describe(
2253
+ "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2254
+ );
2103
2255
  zod.z.object({
2104
2256
  deleted_externally: acs_users_deleted_externally.optional().nullable(),
2105
2257
  salto_ks_subscription_limit_exceeded: acs_users_salto_ks_subscription_limit_exceeded.optional().nullable(),
@@ -2108,23 +2260,25 @@ zod.z.object({
2108
2260
  failed_to_delete_on_acs_system: acs_users_failed_to_delete_on_acs_system.optional().nullable()
2109
2261
  });
2110
2262
  var common_acs_user_warning = zod.z.object({
2111
- created_at: zod.z.string().datetime(),
2112
- message: zod.z.string()
2263
+ created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
2264
+ message: zod.z.string().describe(
2265
+ "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it."
2266
+ )
2113
2267
  });
2114
2268
  var acs_users_being_deleted = common_acs_user_warning.extend({
2115
2269
  warning_code: zod.z.literal("being_deleted")
2116
2270
  }).describe(
2117
- `Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.`
2271
+ "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly."
2118
2272
  );
2119
2273
  var acs_users_salto_ks_user_not_subscribed = common_acs_user_warning.extend({
2120
2274
  warning_code: zod.z.literal("salto_ks_user_not_subscribed")
2121
2275
  }).describe(
2122
- `Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn\u2019t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.`
2276
+ "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn\u2019t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed."
2123
2277
  );
2124
2278
  var unknown_issue_with_acs_user = common_acs_user_warning.extend({
2125
2279
  warning_code: zod.z.literal("unknown_issue_with_acs_user")
2126
2280
  }).describe(
2127
- "An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user."
2281
+ "An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user."
2128
2282
  );
2129
2283
  zod.z.object({
2130
2284
  being_deleted: acs_users_being_deleted.optional().nullable(),
@@ -2135,7 +2289,9 @@ var acs_users_warnings = zod.z.discriminatedUnion("warning_code", [
2135
2289
  acs_users_being_deleted,
2136
2290
  acs_users_salto_ks_user_not_subscribed,
2137
2291
  unknown_issue_with_acs_user
2138
- ]).describe("Warning associated with the `acs_user`.");
2292
+ ]).describe(
2293
+ "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2294
+ );
2139
2295
  var common_acs_user_modification = zod.z.object({
2140
2296
  created_at: zod.z.string().datetime().describe("Date and time at which this modification was requested."),
2141
2297
  message: zod.z.string().describe("Detailed description of the modification.")
@@ -2143,59 +2299,73 @@ var common_acs_user_modification = zod.z.object({
2143
2299
  var acs_user_suspension_state_modification = common_acs_user_modification.extend({
2144
2300
  modification_code: zod.z.literal("suspension_state")
2145
2301
  }).describe(
2146
- "Indicates that the acs_user's is_suspended state was updated on Seam and will soon be applied on the user on the ACS System"
2302
+ "Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) `is_suspended` state was updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2147
2303
  );
2148
2304
  var acs_user_profile_modification = common_acs_user_modification.extend({
2149
2305
  modification_code: zod.z.literal("profile")
2150
2306
  }).describe(
2151
- "Indicates that the acs_user's profile details (name, email, phone) were updated on Seam and will soon be applied on the user on the ACS System"
2307
+ "Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) profile details (name, email, phone) were updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2152
2308
  );
2153
2309
  zod.z.object({
2154
2310
  suspension_state: acs_user_suspension_state_modification.optional().nullable(),
2155
2311
  profile: acs_user_profile_modification.optional().nullable()
2156
2312
  });
2157
2313
  var user_fields = zod.z.object({
2158
- full_name: zod.z.string().optional().describe("Full name of the `acs_user`."),
2314
+ full_name: zod.z.string().optional().describe(
2315
+ "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2316
+ ),
2159
2317
  email: zod.z.string().email().optional().describe(`
2160
2318
  ---
2161
2319
  deprecated: use email_address.
2162
2320
  ---
2163
2321
  `),
2164
- email_address: zod.z.string().email().optional().describe("Email address of the `acs_user`."),
2322
+ email_address: zod.z.string().email().optional().describe(
2323
+ "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2324
+ ),
2165
2325
  phone_number: phone_number.optional().describe(
2166
- "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`)."
2326
+ "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)."
2167
2327
  )
2168
2328
  });
2169
2329
  var common_acs_user = zod.z.object({
2170
- acs_user_id: zod.z.string().uuid().describe("ID of the `acs_user`."),
2330
+ acs_user_id: zod.z.string().uuid().describe(
2331
+ "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2332
+ ),
2171
2333
  acs_system_id: zod.z.string().uuid().describe(
2172
- "ID of the access control system that contains the `acs_user`."
2334
+ "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2173
2335
  ),
2174
2336
  hid_acs_system_id: zod.z.string().uuid().optional(),
2175
2337
  workspace_id: zod.z.string().uuid().describe(
2176
- "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`."
2338
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2339
+ ),
2340
+ created_at: zod.z.string().datetime().describe(
2341
+ "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created."
2342
+ ),
2343
+ display_name: zod.z.string().describe(
2344
+ "Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2345
+ ),
2346
+ external_type: acs_user_external_type.optional().describe(
2347
+ "Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type."
2177
2348
  ),
2178
- created_at: zod.z.string().datetime().describe("Date and time at which the `acs_user` was created."),
2179
- display_name: zod.z.string().describe("Display name for the `acs_user`."),
2180
- external_type: acs_user_external_type.optional().describe("Brand-specific terminology for the `acs_user` type."),
2181
2349
  external_type_display_name: zod.z.string().optional().describe(
2182
- "Display name that corresponds to the brand-specific terminology for the `acs_user` type."
2350
+ "Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type."
2183
2351
  ),
2184
2352
  is_suspended: zod.z.boolean().optional().describe(
2185
- "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users)."
2353
+ "Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users)."
2186
2354
  ),
2187
2355
  access_schedule: schedule.optional().describe(
2188
- "`starts_at` and `ends_at` timestamps for the `acs_user`'s access."
2356
+ "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access."
2357
+ ),
2358
+ user_identity_id: zod.z.string().optional().describe(
2359
+ "ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2189
2360
  ),
2190
- user_identity_id: zod.z.string().optional().describe("ID of the user identity associated with the `acs_user`."),
2191
2361
  user_identity_full_name: zod.z.string().nullable().optional().describe(
2192
- "Full name of the user identity associated with the `acs_user`."
2362
+ "Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2193
2363
  ),
2194
2364
  user_identity_email_address: zod.z.string().nullable().optional().describe(
2195
- "Email address of the user identity associated with the `acs_user`."
2365
+ "Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2196
2366
  ),
2197
2367
  user_identity_phone_number: zod.z.string().nullable().optional().describe(
2198
- "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`)."
2368
+ "Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`)."
2199
2369
  ),
2200
2370
  latest_desired_state_synced_with_provider_at: zod.z.string().datetime().nullable().optional().describe(`
2201
2371
  ---
@@ -2207,8 +2377,12 @@ var common_acs_user = zod.z.object({
2207
2377
  undocumented: Only used internally.
2208
2378
  ---
2209
2379
  `),
2210
- warnings: zod.z.array(acs_users_warnings).describe("Warnings associated with the `acs_user`."),
2211
- errors: zod.z.array(acs_user_errors).describe("Errors associated with the `acs_user`.")
2380
+ warnings: zod.z.array(acs_users_warnings).describe(
2381
+ "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2382
+ ),
2383
+ errors: zod.z.array(acs_user_errors).describe(
2384
+ "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
2385
+ )
2212
2386
  }).merge(user_fields);
2213
2387
  var acs_user = common_acs_user.merge(
2214
2388
  zod.z.object({
@@ -3518,6 +3692,15 @@ var temperature_changed_event = device_event.extend({
3518
3692
  ---
3519
3693
  A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 \xB0C.
3520
3694
  `);
3695
+ var device_name_changed_event = device_event.extend({
3696
+ event_type: zod.z.literal("device.name_changed"),
3697
+ new_name: zod.z.string().describe("The new name of the device.")
3698
+ }).describe(`
3699
+ ---
3700
+ route_path: /devices
3701
+ ---
3702
+ The name of a [device](https://docs.seam.co/latest/core-concepts/devices) was changed.
3703
+ `);
3521
3704
  var device_events = [
3522
3705
  device_connected_event,
3523
3706
  device_added_event,
@@ -3550,7 +3733,8 @@ var device_events = [
3550
3733
  temperature_threshold_exceeded_event,
3551
3734
  temperature_threshold_no_longer_exceeded_event,
3552
3735
  temperature_reached_set_point_event,
3553
- temperature_changed_event
3736
+ temperature_changed_event,
3737
+ device_name_changed_event
3554
3738
  ];
3555
3739
  var enrollment_automation_event = common_event.extend({
3556
3740
  enrollment_automation_id: zod.z.string().uuid().describe(
@@ -4623,31 +4807,31 @@ var openapi_default = {
4623
4807
  "x-route-path": "/acs/access_groups"
4624
4808
  },
4625
4809
  acs_credential: {
4626
- description: "Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
4810
+ description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
4627
4811
  properties: {
4628
4812
  access_method: {
4629
- description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
4813
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
4630
4814
  enum: ["code", "card", "mobile_key"],
4631
4815
  type: "string"
4632
4816
  },
4633
4817
  acs_credential_id: {
4634
- description: "ID of the credential.",
4818
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4635
4819
  format: "uuid",
4636
4820
  type: "string"
4637
4821
  },
4638
4822
  acs_credential_pool_id: { format: "uuid", type: "string" },
4639
4823
  acs_system_id: {
4640
- description: "ID of the access control system that contains the credential.",
4824
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4641
4825
  format: "uuid",
4642
4826
  type: "string"
4643
4827
  },
4644
4828
  acs_user_id: {
4645
- description: "ID of the ACS user to whom the credential belongs.",
4829
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
4646
4830
  format: "uuid",
4647
4831
  type: "string"
4648
4832
  },
4649
4833
  assa_abloy_vostio_metadata: {
4650
- description: "Vostio-specific metadata for the credential.",
4834
+ description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4651
4835
  properties: {
4652
4836
  door_names: { items: { type: "string" }, type: "array" },
4653
4837
  endpoint_id: { type: "string" },
@@ -4660,28 +4844,32 @@ var openapi_default = {
4660
4844
  },
4661
4845
  type: "object"
4662
4846
  },
4663
- card_number: { nullable: true, type: "string" },
4847
+ card_number: {
4848
+ description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4849
+ nullable: true,
4850
+ type: "string"
4851
+ },
4664
4852
  code: {
4665
- description: "Access (PIN) code for the credential.",
4853
+ description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4666
4854
  nullable: true,
4667
4855
  type: "string"
4668
4856
  },
4669
4857
  created_at: {
4670
- description: "Date and time at which the credential was created.",
4858
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
4671
4859
  format: "date-time",
4672
4860
  type: "string"
4673
4861
  },
4674
4862
  display_name: {
4675
- description: "Display name that corresponds to the credential type.",
4863
+ description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
4676
4864
  minLength: 1,
4677
4865
  type: "string"
4678
4866
  },
4679
4867
  ends_at: {
4680
- description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
4868
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
4681
4869
  type: "string"
4682
4870
  },
4683
4871
  errors: {
4684
- description: "Errors associated with the `acs_credential`.",
4872
+ description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4685
4873
  items: {
4686
4874
  properties: {
4687
4875
  error_code: { type: "string" },
@@ -4693,7 +4881,7 @@ var openapi_default = {
4693
4881
  type: "array"
4694
4882
  },
4695
4883
  external_type: {
4696
- description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
4884
+ description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
4697
4885
  enum: [
4698
4886
  "pti_card",
4699
4887
  "brivo_credential",
@@ -4706,42 +4894,50 @@ var openapi_default = {
4706
4894
  type: "string"
4707
4895
  },
4708
4896
  external_type_display_name: {
4709
- description: "Display name that corresponds to the brand-specific terminology for the credential type.",
4897
+ description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
4710
4898
  type: "string"
4711
4899
  },
4712
- is_issued: { type: "boolean" },
4900
+ is_issued: {
4901
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
4902
+ type: "boolean"
4903
+ },
4713
4904
  is_latest_desired_state_synced_with_provider: {
4714
- description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
4905
+ description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
4715
4906
  nullable: true,
4716
4907
  type: "boolean"
4717
4908
  },
4718
4909
  is_managed: { enum: [true], type: "boolean" },
4719
4910
  is_multi_phone_sync_credential: {
4720
- description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
4911
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
4721
4912
  type: "boolean"
4722
4913
  },
4723
4914
  is_one_time_use: {
4724
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
4915
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
4725
4916
  type: "boolean"
4726
4917
  },
4727
- issued_at: { format: "date-time", nullable: true, type: "string" },
4918
+ issued_at: {
4919
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
4920
+ format: "date-time",
4921
+ nullable: true,
4922
+ type: "string"
4923
+ },
4728
4924
  latest_desired_state_synced_with_provider_at: {
4729
- description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
4925
+ description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
4730
4926
  format: "date-time",
4731
4927
  nullable: true,
4732
4928
  type: "string"
4733
4929
  },
4734
4930
  parent_acs_credential_id: {
4735
- description: "ID of the parent credential.",
4931
+ description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4736
4932
  format: "uuid",
4737
4933
  type: "string"
4738
4934
  },
4739
4935
  starts_at: {
4740
- description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
4936
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
4741
4937
  type: "string"
4742
4938
  },
4743
4939
  visionline_metadata: {
4744
- description: "Visionline-specific metadata for the credential.",
4940
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4745
4941
  properties: {
4746
4942
  auto_join: { type: "boolean" },
4747
4943
  card_function_type: { enum: ["guest", "staff"], type: "string" },
@@ -4765,13 +4961,13 @@ var openapi_default = {
4765
4961
  type: "object"
4766
4962
  },
4767
4963
  warnings: {
4768
- description: "Warnings associated with the `acs_credential`.",
4964
+ description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4769
4965
  items: {
4770
- description: "Warning associated with the `acs_credential`.",
4966
+ description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4771
4967
  discriminator: { propertyName: "warning_code" },
4772
4968
  oneOf: [
4773
4969
  {
4774
- description: "Indicates that the credential is waiting to be issued.",
4970
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
4775
4971
  properties: {
4776
4972
  created_at: {
4777
4973
  description: "Date and time at which Seam created the warning.",
@@ -4792,7 +4988,7 @@ var openapi_default = {
4792
4988
  type: "object"
4793
4989
  },
4794
4990
  {
4795
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
4991
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
4796
4992
  properties: {
4797
4993
  created_at: {
4798
4994
  description: "Date and time at which Seam created the warning.",
@@ -4813,7 +5009,7 @@ var openapi_default = {
4813
5009
  type: "object"
4814
5010
  },
4815
5011
  {
4816
- description: "Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.",
5012
+ description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
4817
5013
  properties: {
4818
5014
  created_at: {
4819
5015
  description: "Date and time at which Seam created the warning.",
@@ -4834,7 +5030,7 @@ var openapi_default = {
4834
5030
  type: "object"
4835
5031
  },
4836
5032
  {
4837
- description: "Indicates that this credential is being deleted.",
5033
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
4838
5034
  properties: {
4839
5035
  created_at: {
4840
5036
  description: "Date and time at which Seam created the warning.",
@@ -4855,7 +5051,7 @@ var openapi_default = {
4855
5051
  type: "object"
4856
5052
  },
4857
5053
  {
4858
- description: "An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.",
5054
+ description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
4859
5055
  properties: {
4860
5056
  created_at: {
4861
5057
  description: "Date and time at which Seam created the warning.",
@@ -4876,7 +5072,7 @@ var openapi_default = {
4876
5072
  type: "object"
4877
5073
  },
4878
5074
  {
4879
- description: "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.",
5075
+ description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
4880
5076
  properties: {
4881
5077
  created_at: {
4882
5078
  description: "Date and time at which Seam created the warning.",
@@ -4901,7 +5097,7 @@ var openapi_default = {
4901
5097
  type: "array"
4902
5098
  },
4903
5099
  workspace_id: {
4904
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
5100
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
4905
5101
  format: "uuid",
4906
5102
  type: "string"
4907
5103
  }
@@ -4967,28 +5163,28 @@ var openapi_default = {
4967
5163
  description: "Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
4968
5164
  properties: {
4969
5165
  acs_encoder_id: {
4970
- description: "ID of the `acs_encoder`.",
5166
+ description: "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.",
4971
5167
  format: "uuid",
4972
5168
  type: "string"
4973
5169
  },
4974
5170
  acs_system_id: {
4975
- description: "ID of the access control system that contains the `acs_encoder`.",
5171
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
4976
5172
  format: "uuid",
4977
5173
  type: "string"
4978
5174
  },
4979
5175
  created_at: {
4980
- description: "Date and time at which the `acs_encoder` was created.",
5176
+ description: "Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.",
4981
5177
  format: "date-time",
4982
5178
  type: "string"
4983
5179
  },
4984
5180
  display_name: {
4985
- description: "Display name for the `acs_encoder`.",
5181
+ description: "Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
4986
5182
  type: "string"
4987
5183
  },
4988
5184
  errors: {
4989
- description: "Errors associated with the `acs_encoder`.",
5185
+ description: "Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
4990
5186
  items: {
4991
- description: "Error associated with the `acs_encoder`.",
5187
+ description: "Error associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
4992
5188
  properties: {
4993
5189
  created_at: {
4994
5190
  description: "Date and time at which Seam created the error.",
@@ -5011,7 +5207,7 @@ var openapi_default = {
5011
5207
  type: "array"
5012
5208
  },
5013
5209
  workspace_id: {
5014
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.",
5210
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
5015
5211
  format: "uuid",
5016
5212
  type: "string"
5017
5213
  }
@@ -5031,16 +5227,17 @@ var openapi_default = {
5031
5227
  description: "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5032
5228
  properties: {
5033
5229
  acs_entrance_id: {
5034
- description: "ID of the entrance.",
5230
+ description: "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5035
5231
  format: "uuid",
5036
5232
  type: "string"
5037
5233
  },
5038
5234
  acs_system_id: {
5039
- description: "ID of the access control system that contains the entrance.",
5235
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5040
5236
  format: "uuid",
5041
5237
  type: "string"
5042
5238
  },
5043
5239
  assa_abloy_vostio_metadata: {
5240
+ description: "ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5044
5241
  properties: {
5045
5242
  door_name: { type: "string" },
5046
5243
  door_number: { format: "float", type: "number" },
@@ -5055,24 +5252,32 @@ var openapi_default = {
5055
5252
  type: "object"
5056
5253
  },
5057
5254
  created_at: {
5058
- description: "Date and time at which the entrance was created.",
5255
+ description: "Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.",
5059
5256
  format: "date-time",
5060
5257
  type: "string"
5061
5258
  },
5062
5259
  display_name: {
5063
- description: "Display name for the entrance.",
5260
+ description: "Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5064
5261
  type: "string"
5065
5262
  },
5066
5263
  dormakaba_community_metadata: {
5264
+ description: "dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5067
5265
  properties: { access_point_name: { type: "string" } },
5068
5266
  required: ["access_point_name"],
5069
5267
  type: "object"
5070
5268
  },
5071
5269
  errors: {
5270
+ description: "Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5072
5271
  items: {
5073
5272
  properties: {
5074
- error_code: { type: "string" },
5075
- message: { type: "string" }
5273
+ error_code: {
5274
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
5275
+ type: "string"
5276
+ },
5277
+ message: {
5278
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
5279
+ type: "string"
5280
+ }
5076
5281
  },
5077
5282
  required: ["error_code", "message"],
5078
5283
  type: "object"
@@ -5080,6 +5285,7 @@ var openapi_default = {
5080
5285
  type: "array"
5081
5286
  },
5082
5287
  latch_metadata: {
5288
+ description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5083
5289
  properties: {
5084
5290
  accessibility_type: { type: "string" },
5085
5291
  door_name: { type: "string" },
@@ -5095,6 +5301,7 @@ var openapi_default = {
5095
5301
  type: "object"
5096
5302
  },
5097
5303
  salto_ks_metadata: {
5304
+ description: "Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5098
5305
  properties: {
5099
5306
  battery_level: { type: "string" },
5100
5307
  door_name: { type: "string" },
@@ -5114,6 +5321,7 @@ var openapi_default = {
5114
5321
  type: "object"
5115
5322
  },
5116
5323
  salto_space_metadata: {
5324
+ description: "Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5117
5325
  properties: {
5118
5326
  door_description: { type: "string" },
5119
5327
  door_name: { type: "string" },
@@ -5123,6 +5331,7 @@ var openapi_default = {
5123
5331
  type: "object"
5124
5332
  },
5125
5333
  visionline_metadata: {
5334
+ description: "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5126
5335
  properties: {
5127
5336
  door_category: {
5128
5337
  enum: [
@@ -5171,58 +5380,57 @@ var openapi_default = {
5171
5380
  description: "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5172
5381
  properties: {
5173
5382
  acs_system_id: {
5174
- description: "ID of the `acs_system`.",
5383
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5175
5384
  format: "uuid",
5176
5385
  type: "string"
5177
5386
  },
5178
5387
  can_add_acs_users_to_acs_access_groups: {
5179
- description: "Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).",
5388
+ description: "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).",
5180
5389
  type: "boolean"
5181
5390
  },
5182
5391
  can_automate_enrollment: {
5183
- description: "Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.",
5392
+ description: "Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5184
5393
  type: "boolean"
5185
5394
  },
5186
5395
  can_create_acs_access_groups: {
5187
- description: "Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).",
5396
+ description: "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).",
5188
5397
  type: "boolean"
5189
5398
  },
5190
5399
  can_remove_acs_users_from_acs_access_groups: {
5191
- description: "Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).",
5400
+ description: "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).",
5192
5401
  type: "boolean"
5193
5402
  },
5194
5403
  connected_account_id: {
5195
- description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.",
5404
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5196
5405
  format: "uuid",
5197
5406
  type: "string"
5198
5407
  },
5199
5408
  connected_account_ids: {
5200
5409
  deprecated: true,
5201
- description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`.",
5410
+ description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5202
5411
  items: { format: "uuid", type: "string" },
5203
5412
  type: "array",
5204
5413
  "x-deprecated": "Use `connected_account_id`."
5205
5414
  },
5206
5415
  created_at: {
5207
- description: "Date and time at which the `acs_system` was created.",
5416
+ description: "Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.",
5208
5417
  format: "date-time",
5209
5418
  type: "string"
5210
5419
  },
5211
5420
  default_credential_manager_acs_system_id: {
5212
- description: "ID of the default credential manager acs_system for this access control system.",
5421
+ description: "ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5213
5422
  format: "uuid",
5214
5423
  nullable: true,
5215
- type: "string",
5216
- "x-draft": "Needs review"
5424
+ type: "string"
5217
5425
  },
5218
5426
  errors: {
5219
- description: "Errors associated with the `acs_system`.",
5427
+ description: "Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5220
5428
  items: {
5221
- description: "Error associated with the `acs_system`.",
5429
+ description: "Error associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5222
5430
  discriminator: { propertyName: "error_code" },
5223
5431
  oneOf: [
5224
5432
  {
5225
- description: "Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
5433
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
5226
5434
  properties: {
5227
5435
  created_at: {
5228
5436
  description: "Date and time at which Seam created the error.",
@@ -5243,7 +5451,7 @@ var openapi_default = {
5243
5451
  type: "object"
5244
5452
  },
5245
5453
  {
5246
- description: "Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).",
5454
+ description: "Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).",
5247
5455
  properties: {
5248
5456
  created_at: {
5249
5457
  description: "Date and time at which Seam created the error.",
@@ -5285,7 +5493,7 @@ var openapi_default = {
5285
5493
  type: "object"
5286
5494
  },
5287
5495
  {
5288
- description: "Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.",
5496
+ description: "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue.",
5289
5497
  properties: {
5290
5498
  created_at: {
5291
5499
  description: "Date and time at which Seam created the error.",
@@ -5306,7 +5514,7 @@ var openapi_default = {
5306
5514
  type: "object"
5307
5515
  },
5308
5516
  {
5309
- description: "Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access.",
5517
+ description: "Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.",
5310
5518
  properties: {
5311
5519
  created_at: {
5312
5520
  description: "Date and time at which Seam created the error.",
@@ -5327,6 +5535,7 @@ var openapi_default = {
5327
5535
  type: "object"
5328
5536
  },
5329
5537
  {
5538
+ description: "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.",
5330
5539
  properties: {
5331
5540
  created_at: {
5332
5541
  description: "Date and time at which Seam created the error.",
@@ -5334,7 +5543,7 @@ var openapi_default = {
5334
5543
  type: "string"
5335
5544
  },
5336
5545
  error_code: {
5337
- description: "Indicates that the access system has lost its Salto KS certification. Please contact support to regain access.",
5546
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
5338
5547
  enum: ["salto_ks_certification_expired"],
5339
5548
  type: "string"
5340
5549
  },
@@ -5351,7 +5560,7 @@ var openapi_default = {
5351
5560
  type: "array"
5352
5561
  },
5353
5562
  external_type: {
5354
- description: "Brand-specific terminology for the `acs_system` type.",
5563
+ description: "Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.",
5355
5564
  enum: [
5356
5565
  "pti_site",
5357
5566
  "alta_org",
@@ -5370,25 +5579,25 @@ var openapi_default = {
5370
5579
  type: "string"
5371
5580
  },
5372
5581
  external_type_display_name: {
5373
- description: "Display name that corresponds to the brand-specific terminology for the `acs_system` type.",
5582
+ description: "Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.",
5374
5583
  type: "string"
5375
5584
  },
5376
5585
  image_alt_text: {
5377
- description: "Alternative text for the `acs_system` image.",
5586
+ description: "Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.",
5378
5587
  type: "string"
5379
5588
  },
5380
5589
  image_url: {
5381
- description: "URL for the image that represents the `acs_system`.",
5590
+ description: "URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5382
5591
  type: "string"
5383
5592
  },
5384
5593
  is_credential_manager: {
5385
- description: "Indicates if the `acs_system` is a credential manager.",
5594
+ description: "Indicates whether the `acs_system` is a credential manager.",
5386
5595
  type: "boolean"
5387
5596
  },
5388
5597
  location: {
5389
5598
  properties: {
5390
5599
  time_zone: {
5391
- description: "Time zone in which the `acs_system` is located.",
5600
+ description: "Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.",
5392
5601
  nullable: true,
5393
5602
  type: "string"
5394
5603
  }
@@ -5396,7 +5605,10 @@ var openapi_default = {
5396
5605
  required: ["time_zone"],
5397
5606
  type: "object"
5398
5607
  },
5399
- name: { description: "Name of the `acs_system`.", type: "string" },
5608
+ name: {
5609
+ description: "Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5610
+ type: "string"
5611
+ },
5400
5612
  system_type: {
5401
5613
  deprecated: true,
5402
5614
  enum: [
@@ -5425,7 +5637,7 @@ var openapi_default = {
5425
5637
  visionline_metadata: {
5426
5638
  properties: {
5427
5639
  lan_address: {
5428
- description: "IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.",
5640
+ description: "IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network.",
5429
5641
  type: "string"
5430
5642
  },
5431
5643
  mobile_access_uuid: {
@@ -5441,12 +5653,13 @@ var openapi_default = {
5441
5653
  type: "object"
5442
5654
  },
5443
5655
  warnings: {
5444
- description: "Warnings associated with the `acs_system`.",
5656
+ description: "Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5445
5657
  items: {
5446
- description: "Warning associated with the `acs_system`.",
5658
+ description: "Warning associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5447
5659
  discriminator: { propertyName: "warning_code" },
5448
5660
  oneOf: [
5449
5661
  {
5662
+ description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.",
5450
5663
  properties: {
5451
5664
  created_at: {
5452
5665
  description: "Date and time at which Seam created the warning.",
@@ -5458,7 +5671,7 @@ var openapi_default = {
5458
5671
  type: "string"
5459
5672
  },
5460
5673
  warning_code: {
5461
- description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.",
5674
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5462
5675
  enum: ["salto_ks_subscription_limit_almost_reached"],
5463
5676
  type: "string"
5464
5677
  }
@@ -5467,6 +5680,7 @@ var openapi_default = {
5467
5680
  type: "object"
5468
5681
  },
5469
5682
  {
5683
+ description: "Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
5470
5684
  properties: {
5471
5685
  created_at: {
5472
5686
  description: "Date and time at which Seam created the warning.",
@@ -5482,7 +5696,7 @@ var openapi_default = {
5482
5696
  type: "array"
5483
5697
  },
5484
5698
  warning_code: {
5485
- description: "Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.",
5699
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
5486
5700
  enum: ["time_zone_does_not_match_location"],
5487
5701
  type: "string"
5488
5702
  }
@@ -5495,7 +5709,7 @@ var openapi_default = {
5495
5709
  type: "array"
5496
5710
  },
5497
5711
  workspace_id: {
5498
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.",
5712
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5499
5713
  format: "uuid",
5500
5714
  type: "string"
5501
5715
  }
@@ -5521,7 +5735,7 @@ var openapi_default = {
5521
5735
  description: "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5522
5736
  properties: {
5523
5737
  access_schedule: {
5524
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
5738
+ description: "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
5525
5739
  properties: {
5526
5740
  ends_at: {
5527
5741
  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.",
@@ -5539,22 +5753,22 @@ var openapi_default = {
5539
5753
  type: "object"
5540
5754
  },
5541
5755
  acs_system_id: {
5542
- description: "ID of the access control system that contains the `acs_user`.",
5756
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5543
5757
  format: "uuid",
5544
5758
  type: "string"
5545
5759
  },
5546
5760
  acs_user_id: {
5547
- description: "ID of the `acs_user`.",
5761
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5548
5762
  format: "uuid",
5549
5763
  type: "string"
5550
5764
  },
5551
5765
  created_at: {
5552
- description: "Date and time at which the `acs_user` was created.",
5766
+ description: "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.",
5553
5767
  format: "date-time",
5554
5768
  type: "string"
5555
5769
  },
5556
5770
  display_name: {
5557
- description: "Display name for the `acs_user`.",
5771
+ description: "Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5558
5772
  type: "string"
5559
5773
  },
5560
5774
  email: {
@@ -5564,18 +5778,18 @@ var openapi_default = {
5564
5778
  "x-deprecated": "use email_address."
5565
5779
  },
5566
5780
  email_address: {
5567
- description: "Email address of the `acs_user`.",
5781
+ description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5568
5782
  format: "email",
5569
5783
  type: "string"
5570
5784
  },
5571
5785
  errors: {
5572
- description: "Errors associated with the `acs_user`.",
5786
+ description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5573
5787
  items: {
5574
- description: "Error associated with the `acs_user`.",
5788
+ description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5575
5789
  discriminator: { propertyName: "error_code" },
5576
5790
  oneOf: [
5577
5791
  {
5578
- description: "Indicates that the ACS user was deleted from the ACS system outside of Seam.",
5792
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.",
5579
5793
  properties: {
5580
5794
  created_at: {
5581
5795
  description: "Date and time at which Seam created the error.",
@@ -5595,7 +5809,7 @@ var openapi_default = {
5595
5809
  type: "object"
5596
5810
  },
5597
5811
  {
5598
- description: "Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.",
5812
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.",
5599
5813
  properties: {
5600
5814
  created_at: {
5601
5815
  description: "Date and time at which Seam created the error.",
@@ -5615,7 +5829,7 @@ var openapi_default = {
5615
5829
  type: "object"
5616
5830
  },
5617
5831
  {
5618
- description: "Indicates that the user was not created on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
5832
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
5619
5833
  properties: {
5620
5834
  created_at: {
5621
5835
  description: "Date and time at which Seam created the error.",
@@ -5635,7 +5849,7 @@ var openapi_default = {
5635
5849
  type: "object"
5636
5850
  },
5637
5851
  {
5638
- description: "Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
5852
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
5639
5853
  properties: {
5640
5854
  created_at: {
5641
5855
  description: "Date and time at which Seam created the error.",
@@ -5655,7 +5869,7 @@ var openapi_default = {
5655
5869
  type: "object"
5656
5870
  },
5657
5871
  {
5658
- description: "Indicates that the user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
5872
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
5659
5873
  properties: {
5660
5874
  created_at: {
5661
5875
  description: "Date and time at which Seam created the error.",
@@ -5679,7 +5893,7 @@ var openapi_default = {
5679
5893
  type: "array"
5680
5894
  },
5681
5895
  external_type: {
5682
- description: "Brand-specific terminology for the `acs_user` type.",
5896
+ description: "Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.",
5683
5897
  enum: [
5684
5898
  "pti_user",
5685
5899
  "brivo_user",
@@ -5692,11 +5906,11 @@ var openapi_default = {
5692
5906
  type: "string"
5693
5907
  },
5694
5908
  external_type_display_name: {
5695
- description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
5909
+ description: "Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.",
5696
5910
  type: "string"
5697
5911
  },
5698
5912
  full_name: {
5699
- description: "Full name of the `acs_user`.",
5913
+ description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5700
5914
  type: "string"
5701
5915
  },
5702
5916
  hid_acs_system_id: { format: "uuid", type: "string" },
@@ -5707,7 +5921,7 @@ var openapi_default = {
5707
5921
  },
5708
5922
  is_managed: { enum: [true], type: "boolean" },
5709
5923
  is_suspended: {
5710
- description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
5924
+ description: "Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
5711
5925
  type: "boolean"
5712
5926
  },
5713
5927
  latest_desired_state_synced_with_provider_at: {
@@ -5717,49 +5931,63 @@ var openapi_default = {
5717
5931
  "x-undocumented": "Only used internally."
5718
5932
  },
5719
5933
  phone_number: {
5720
- description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
5934
+ description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
5721
5935
  type: "string"
5722
5936
  },
5723
5937
  user_identity_email_address: {
5724
- description: "Email address of the user identity associated with the `acs_user`.",
5938
+ description: "Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5725
5939
  nullable: true,
5726
5940
  type: "string"
5727
5941
  },
5728
5942
  user_identity_full_name: {
5729
- description: "Full name of the user identity associated with the `acs_user`.",
5943
+ description: "Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5730
5944
  nullable: true,
5731
5945
  type: "string"
5732
5946
  },
5733
5947
  user_identity_id: {
5734
- description: "ID of the user identity associated with the `acs_user`.",
5948
+ description: "ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5735
5949
  type: "string"
5736
5950
  },
5737
5951
  user_identity_phone_number: {
5738
- description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
5952
+ description: "Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
5739
5953
  nullable: true,
5740
5954
  type: "string"
5741
5955
  },
5742
5956
  warnings: {
5743
- description: "Warnings associated with the `acs_user`.",
5957
+ description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5744
5958
  items: {
5745
- description: "Warning associated with the `acs_user`.",
5959
+ description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5746
5960
  discriminator: { propertyName: "warning_code" },
5747
5961
  oneOf: [
5748
5962
  {
5749
- description: "Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.",
5963
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.",
5750
5964
  properties: {
5751
- created_at: { format: "date-time", type: "string" },
5752
- message: { type: "string" },
5965
+ created_at: {
5966
+ description: "Date and time at which Seam created the warning.",
5967
+ format: "date-time",
5968
+ type: "string"
5969
+ },
5970
+ message: {
5971
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5972
+ type: "string"
5973
+ },
5753
5974
  warning_code: { enum: ["being_deleted"], type: "string" }
5754
5975
  },
5755
5976
  required: ["created_at", "message", "warning_code"],
5756
5977
  type: "object"
5757
5978
  },
5758
5979
  {
5759
- description: "Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn\u2019t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.",
5980
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn\u2019t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.",
5760
5981
  properties: {
5761
- created_at: { format: "date-time", type: "string" },
5762
- message: { type: "string" },
5982
+ created_at: {
5983
+ description: "Date and time at which Seam created the warning.",
5984
+ format: "date-time",
5985
+ type: "string"
5986
+ },
5987
+ message: {
5988
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
5989
+ type: "string"
5990
+ },
5763
5991
  warning_code: {
5764
5992
  enum: ["salto_ks_user_not_subscribed"],
5765
5993
  type: "string"
@@ -5769,10 +5997,17 @@ var openapi_default = {
5769
5997
  type: "object"
5770
5998
  },
5771
5999
  {
5772
- description: "An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.",
6000
+ description: "An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.",
5773
6001
  properties: {
5774
- created_at: { format: "date-time", type: "string" },
5775
- message: { type: "string" },
6002
+ created_at: {
6003
+ description: "Date and time at which Seam created the warning.",
6004
+ format: "date-time",
6005
+ type: "string"
6006
+ },
6007
+ message: {
6008
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
6009
+ type: "string"
6010
+ },
5776
6011
  warning_code: {
5777
6012
  enum: ["unknown_issue_with_acs_user"],
5778
6013
  type: "string"
@@ -5786,7 +6021,7 @@ var openapi_default = {
5786
6021
  type: "array"
5787
6022
  },
5788
6023
  workspace_id: {
5789
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
6024
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
5790
6025
  format: "uuid",
5791
6026
  type: "string"
5792
6027
  }
@@ -5999,56 +6234,84 @@ var openapi_default = {
5999
6234
  nullable: true,
6000
6235
  properties: {
6001
6236
  card_number: {
6002
- description: "A number or string that physically identifies this card.",
6237
+ description: "A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6003
6238
  nullable: true,
6004
6239
  type: "string"
6005
6240
  },
6006
6241
  created_at: {
6007
- description: "Date and time the credential was created.",
6242
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
6008
6243
  format: "date-time",
6009
6244
  nullable: true,
6010
6245
  type: "string"
6011
6246
  },
6012
6247
  ends_at: {
6013
- description: "Date and time the credential will stop being useable.",
6248
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable.",
6014
6249
  format: "date-time",
6015
6250
  nullable: true,
6016
6251
  type: "string"
6017
6252
  },
6018
6253
  is_issued: { nullable: true, type: "boolean" },
6019
6254
  starts_at: {
6020
- description: "Date and time the credential will become useable.",
6255
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable.",
6021
6256
  format: "date-time",
6022
6257
  nullable: true,
6023
6258
  type: "string"
6024
6259
  },
6025
6260
  visionline_metadata: {
6026
- description: "Visionline-specific metadata for the credential.",
6261
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6027
6262
  properties: {
6028
- cancelled: { type: "boolean" },
6263
+ cancelled: {
6264
+ description: "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled.",
6265
+ type: "boolean"
6266
+ },
6029
6267
  card_format: {
6268
+ description: "Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6030
6269
  enum: ["TLCode", "rfid48"],
6031
6270
  type: "string"
6032
6271
  },
6033
- card_holder: { type: "string" },
6034
- card_id: { type: "string" },
6272
+ card_holder: {
6273
+ description: "Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6274
+ type: "string"
6275
+ },
6276
+ card_id: {
6277
+ description: "Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6278
+ type: "string"
6279
+ },
6035
6280
  common_acs_entrance_ids: {
6281
+ description: "IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6036
6282
  items: { format: "uuid", type: "string" },
6037
6283
  type: "array"
6038
6284
  },
6039
- discarded: { type: "boolean" },
6040
- expired: { type: "boolean" },
6285
+ discarded: {
6286
+ description: "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded.",
6287
+ type: "boolean"
6288
+ },
6289
+ expired: {
6290
+ description: "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired.",
6291
+ type: "boolean"
6292
+ },
6041
6293
  guest_acs_entrance_ids: {
6294
+ description: "IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6042
6295
  items: { format: "uuid", type: "string" },
6043
6296
  type: "array"
6044
6297
  },
6045
6298
  number_of_issued_cards: {
6299
+ description: "Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6046
6300
  format: "float",
6047
6301
  type: "number"
6048
6302
  },
6049
- overridden: { type: "boolean" },
6050
- overwritten: { type: "boolean" },
6051
- pending_auto_update: { type: "boolean" }
6303
+ overridden: {
6304
+ description: "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden.",
6305
+ type: "boolean"
6306
+ },
6307
+ overwritten: {
6308
+ description: "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten.",
6309
+ type: "boolean"
6310
+ },
6311
+ pending_auto_update: {
6312
+ description: "Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update.",
6313
+ type: "boolean"
6314
+ }
6052
6315
  },
6053
6316
  required: [
6054
6317
  "card_id",
@@ -6077,15 +6340,15 @@ var openapi_default = {
6077
6340
  nullable: true,
6078
6341
  oneOf: [
6079
6342
  {
6080
- description: "Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
6343
+ description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
6081
6344
  properties: {
6082
6345
  access_method: {
6083
- description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
6346
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
6084
6347
  enum: ["code", "card", "mobile_key"],
6085
6348
  type: "string"
6086
6349
  },
6087
6350
  acs_credential_id: {
6088
- description: "ID of the credential.",
6351
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6089
6352
  format: "uuid",
6090
6353
  type: "string"
6091
6354
  },
@@ -6094,17 +6357,17 @@ var openapi_default = {
6094
6357
  type: "string"
6095
6358
  },
6096
6359
  acs_system_id: {
6097
- description: "ID of the access control system that contains the credential.",
6360
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6098
6361
  format: "uuid",
6099
6362
  type: "string"
6100
6363
  },
6101
6364
  acs_user_id: {
6102
- description: "ID of the ACS user to whom the credential belongs.",
6365
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
6103
6366
  format: "uuid",
6104
6367
  type: "string"
6105
6368
  },
6106
6369
  assa_abloy_vostio_metadata: {
6107
- description: "Vostio-specific metadata for the credential.",
6370
+ description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6108
6371
  properties: {
6109
6372
  door_names: {
6110
6373
  items: { type: "string" },
@@ -6120,28 +6383,32 @@ var openapi_default = {
6120
6383
  },
6121
6384
  type: "object"
6122
6385
  },
6123
- card_number: { nullable: true, type: "string" },
6386
+ card_number: {
6387
+ description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6388
+ nullable: true,
6389
+ type: "string"
6390
+ },
6124
6391
  code: {
6125
- description: "Access (PIN) code for the credential.",
6392
+ description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6126
6393
  nullable: true,
6127
6394
  type: "string"
6128
6395
  },
6129
6396
  created_at: {
6130
- description: "Date and time at which the credential was created.",
6397
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
6131
6398
  format: "date-time",
6132
6399
  type: "string"
6133
6400
  },
6134
6401
  display_name: {
6135
- description: "Display name that corresponds to the credential type.",
6402
+ description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
6136
6403
  minLength: 1,
6137
6404
  type: "string"
6138
6405
  },
6139
6406
  ends_at: {
6140
- description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
6407
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
6141
6408
  type: "string"
6142
6409
  },
6143
6410
  errors: {
6144
- description: "Errors associated with the `acs_credential`.",
6411
+ description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6145
6412
  items: {
6146
6413
  properties: {
6147
6414
  error_code: { type: "string" },
@@ -6153,7 +6420,7 @@ var openapi_default = {
6153
6420
  type: "array"
6154
6421
  },
6155
6422
  external_type: {
6156
- description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
6423
+ description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
6157
6424
  enum: [
6158
6425
  "pti_card",
6159
6426
  "brivo_credential",
@@ -6166,46 +6433,50 @@ var openapi_default = {
6166
6433
  type: "string"
6167
6434
  },
6168
6435
  external_type_display_name: {
6169
- description: "Display name that corresponds to the brand-specific terminology for the credential type.",
6436
+ description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
6170
6437
  type: "string"
6171
6438
  },
6172
- is_issued: { type: "boolean" },
6439
+ is_issued: {
6440
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
6441
+ type: "boolean"
6442
+ },
6173
6443
  is_latest_desired_state_synced_with_provider: {
6174
- description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
6444
+ description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
6175
6445
  nullable: true,
6176
6446
  type: "boolean"
6177
6447
  },
6178
6448
  is_managed: { enum: [true], type: "boolean" },
6179
6449
  is_multi_phone_sync_credential: {
6180
- description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
6450
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
6181
6451
  type: "boolean"
6182
6452
  },
6183
6453
  is_one_time_use: {
6184
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
6454
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
6185
6455
  type: "boolean"
6186
6456
  },
6187
6457
  issued_at: {
6458
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
6188
6459
  format: "date-time",
6189
6460
  nullable: true,
6190
6461
  type: "string"
6191
6462
  },
6192
6463
  latest_desired_state_synced_with_provider_at: {
6193
- description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
6464
+ description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
6194
6465
  format: "date-time",
6195
6466
  nullable: true,
6196
6467
  type: "string"
6197
6468
  },
6198
6469
  parent_acs_credential_id: {
6199
- description: "ID of the parent credential.",
6470
+ description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6200
6471
  format: "uuid",
6201
6472
  type: "string"
6202
6473
  },
6203
6474
  starts_at: {
6204
- description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
6475
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
6205
6476
  type: "string"
6206
6477
  },
6207
6478
  visionline_metadata: {
6208
- description: "Visionline-specific metadata for the credential.",
6479
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6209
6480
  properties: {
6210
6481
  auto_join: { type: "boolean" },
6211
6482
  card_function_type: {
@@ -6232,13 +6503,13 @@ var openapi_default = {
6232
6503
  type: "object"
6233
6504
  },
6234
6505
  warnings: {
6235
- description: "Warnings associated with the `acs_credential`.",
6506
+ description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6236
6507
  items: {
6237
- description: "Warning associated with the `acs_credential`.",
6508
+ description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6238
6509
  discriminator: { propertyName: "warning_code" },
6239
6510
  oneOf: [
6240
6511
  {
6241
- description: "Indicates that the credential is waiting to be issued.",
6512
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
6242
6513
  properties: {
6243
6514
  created_at: {
6244
6515
  description: "Date and time at which Seam created the warning.",
@@ -6263,7 +6534,7 @@ var openapi_default = {
6263
6534
  type: "object"
6264
6535
  },
6265
6536
  {
6266
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
6537
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
6267
6538
  properties: {
6268
6539
  created_at: {
6269
6540
  description: "Date and time at which Seam created the warning.",
@@ -6288,7 +6559,7 @@ var openapi_default = {
6288
6559
  type: "object"
6289
6560
  },
6290
6561
  {
6291
- description: "Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.",
6562
+ description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
6292
6563
  properties: {
6293
6564
  created_at: {
6294
6565
  description: "Date and time at which Seam created the warning.",
@@ -6313,7 +6584,7 @@ var openapi_default = {
6313
6584
  type: "object"
6314
6585
  },
6315
6586
  {
6316
- description: "Indicates that this credential is being deleted.",
6587
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
6317
6588
  properties: {
6318
6589
  created_at: {
6319
6590
  description: "Date and time at which Seam created the warning.",
@@ -6338,7 +6609,7 @@ var openapi_default = {
6338
6609
  type: "object"
6339
6610
  },
6340
6611
  {
6341
- description: "An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.",
6612
+ description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
6342
6613
  properties: {
6343
6614
  created_at: {
6344
6615
  description: "Date and time at which Seam created the warning.",
@@ -6365,7 +6636,7 @@ var openapi_default = {
6365
6636
  type: "object"
6366
6637
  },
6367
6638
  {
6368
- description: "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.",
6639
+ description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
6369
6640
  properties: {
6370
6641
  created_at: {
6371
6642
  description: "Date and time at which Seam created the warning.",
@@ -6394,7 +6665,7 @@ var openapi_default = {
6394
6665
  type: "array"
6395
6666
  },
6396
6667
  workspace_id: {
6397
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
6668
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6398
6669
  format: "uuid",
6399
6670
  type: "string"
6400
6671
  }
@@ -6414,15 +6685,15 @@ var openapi_default = {
6414
6685
  "x-route-path": "/acs/credentials"
6415
6686
  },
6416
6687
  {
6417
- description: "Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
6688
+ description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
6418
6689
  properties: {
6419
6690
  access_method: {
6420
- description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
6691
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
6421
6692
  enum: ["code", "card", "mobile_key"],
6422
6693
  type: "string"
6423
6694
  },
6424
6695
  acs_credential_id: {
6425
- description: "ID of the credential.",
6696
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6426
6697
  format: "uuid",
6427
6698
  type: "string"
6428
6699
  },
@@ -6431,17 +6702,17 @@ var openapi_default = {
6431
6702
  type: "string"
6432
6703
  },
6433
6704
  acs_system_id: {
6434
- description: "ID of the access control system that contains the credential.",
6705
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6435
6706
  format: "uuid",
6436
6707
  type: "string"
6437
6708
  },
6438
6709
  acs_user_id: {
6439
- description: "ID of the ACS user to whom the credential belongs.",
6710
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
6440
6711
  format: "uuid",
6441
6712
  type: "string"
6442
6713
  },
6443
6714
  assa_abloy_vostio_metadata: {
6444
- description: "Vostio-specific metadata for the credential.",
6715
+ description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6445
6716
  properties: {
6446
6717
  door_names: {
6447
6718
  items: { type: "string" },
@@ -6457,28 +6728,32 @@ var openapi_default = {
6457
6728
  },
6458
6729
  type: "object"
6459
6730
  },
6460
- card_number: { nullable: true, type: "string" },
6731
+ card_number: {
6732
+ description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6733
+ nullable: true,
6734
+ type: "string"
6735
+ },
6461
6736
  code: {
6462
- description: "Access (PIN) code for the credential.",
6737
+ description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6463
6738
  nullable: true,
6464
6739
  type: "string"
6465
6740
  },
6466
6741
  created_at: {
6467
- description: "Date and time at which the credential was created.",
6742
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
6468
6743
  format: "date-time",
6469
6744
  type: "string"
6470
6745
  },
6471
6746
  display_name: {
6472
- description: "Display name that corresponds to the credential type.",
6747
+ description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
6473
6748
  minLength: 1,
6474
6749
  type: "string"
6475
6750
  },
6476
6751
  ends_at: {
6477
- description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
6752
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
6478
6753
  type: "string"
6479
6754
  },
6480
6755
  errors: {
6481
- description: "Errors associated with the `acs_credential`.",
6756
+ description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6482
6757
  items: {
6483
6758
  properties: {
6484
6759
  error_code: { type: "string" },
@@ -6490,7 +6765,7 @@ var openapi_default = {
6490
6765
  type: "array"
6491
6766
  },
6492
6767
  external_type: {
6493
- description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
6768
+ description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
6494
6769
  enum: [
6495
6770
  "pti_card",
6496
6771
  "brivo_credential",
@@ -6503,46 +6778,50 @@ var openapi_default = {
6503
6778
  type: "string"
6504
6779
  },
6505
6780
  external_type_display_name: {
6506
- description: "Display name that corresponds to the brand-specific terminology for the credential type.",
6781
+ description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
6507
6782
  type: "string"
6508
6783
  },
6509
- is_issued: { type: "boolean" },
6784
+ is_issued: {
6785
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
6786
+ type: "boolean"
6787
+ },
6510
6788
  is_latest_desired_state_synced_with_provider: {
6511
- description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
6789
+ description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
6512
6790
  nullable: true,
6513
6791
  type: "boolean"
6514
6792
  },
6515
6793
  is_managed: { enum: [false], type: "boolean" },
6516
6794
  is_multi_phone_sync_credential: {
6517
- description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
6795
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
6518
6796
  type: "boolean"
6519
6797
  },
6520
6798
  is_one_time_use: {
6521
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
6799
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
6522
6800
  type: "boolean"
6523
6801
  },
6524
6802
  issued_at: {
6803
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
6525
6804
  format: "date-time",
6526
6805
  nullable: true,
6527
6806
  type: "string"
6528
6807
  },
6529
6808
  latest_desired_state_synced_with_provider_at: {
6530
- description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
6809
+ description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
6531
6810
  format: "date-time",
6532
6811
  nullable: true,
6533
6812
  type: "string"
6534
6813
  },
6535
6814
  parent_acs_credential_id: {
6536
- description: "ID of the parent credential.",
6815
+ description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6537
6816
  format: "uuid",
6538
6817
  type: "string"
6539
6818
  },
6540
6819
  starts_at: {
6541
- description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
6820
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
6542
6821
  type: "string"
6543
6822
  },
6544
6823
  visionline_metadata: {
6545
- description: "Visionline-specific metadata for the credential.",
6824
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6546
6825
  properties: {
6547
6826
  auto_join: { type: "boolean" },
6548
6827
  card_function_type: {
@@ -6569,13 +6848,13 @@ var openapi_default = {
6569
6848
  type: "object"
6570
6849
  },
6571
6850
  warnings: {
6572
- description: "Warnings associated with the `acs_credential`.",
6851
+ description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6573
6852
  items: {
6574
- description: "Warning associated with the `acs_credential`.",
6853
+ description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6575
6854
  discriminator: { propertyName: "warning_code" },
6576
6855
  oneOf: [
6577
6856
  {
6578
- description: "Indicates that the credential is waiting to be issued.",
6857
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
6579
6858
  properties: {
6580
6859
  created_at: {
6581
6860
  description: "Date and time at which Seam created the warning.",
@@ -6600,7 +6879,7 @@ var openapi_default = {
6600
6879
  type: "object"
6601
6880
  },
6602
6881
  {
6603
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
6882
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
6604
6883
  properties: {
6605
6884
  created_at: {
6606
6885
  description: "Date and time at which Seam created the warning.",
@@ -6625,7 +6904,7 @@ var openapi_default = {
6625
6904
  type: "object"
6626
6905
  },
6627
6906
  {
6628
- description: "Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.",
6907
+ description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
6629
6908
  properties: {
6630
6909
  created_at: {
6631
6910
  description: "Date and time at which Seam created the warning.",
@@ -6650,7 +6929,7 @@ var openapi_default = {
6650
6929
  type: "object"
6651
6930
  },
6652
6931
  {
6653
- description: "Indicates that this credential is being deleted.",
6932
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
6654
6933
  properties: {
6655
6934
  created_at: {
6656
6935
  description: "Date and time at which Seam created the warning.",
@@ -6675,7 +6954,7 @@ var openapi_default = {
6675
6954
  type: "object"
6676
6955
  },
6677
6956
  {
6678
- description: "An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.",
6957
+ description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
6679
6958
  properties: {
6680
6959
  created_at: {
6681
6960
  description: "Date and time at which Seam created the warning.",
@@ -6702,7 +6981,7 @@ var openapi_default = {
6702
6981
  type: "object"
6703
6982
  },
6704
6983
  {
6705
- description: "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.",
6984
+ description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
6706
6985
  properties: {
6707
6986
  created_at: {
6708
6987
  description: "Date and time at which Seam created the warning.",
@@ -6731,7 +7010,7 @@ var openapi_default = {
6731
7010
  type: "array"
6732
7011
  },
6733
7012
  workspace_id: {
6734
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
7013
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6735
7014
  format: "uuid",
6736
7015
  type: "string"
6737
7016
  }
@@ -6880,18 +7159,18 @@ var openapi_default = {
6880
7159
  action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
6881
7160
  error: { nullable: true },
6882
7161
  result: {
6883
- description: "Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
7162
+ description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
6884
7163
  oneOf: [
6885
7164
  {
6886
- description: "Means by which a user gains access at an entrance. The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
7165
+ description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
6887
7166
  properties: {
6888
7167
  access_method: {
6889
- description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
7168
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
6890
7169
  enum: ["code", "card", "mobile_key"],
6891
7170
  type: "string"
6892
7171
  },
6893
7172
  acs_credential_id: {
6894
- description: "ID of the credential.",
7173
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6895
7174
  format: "uuid",
6896
7175
  type: "string"
6897
7176
  },
@@ -6900,17 +7179,17 @@ var openapi_default = {
6900
7179
  type: "string"
6901
7180
  },
6902
7181
  acs_system_id: {
6903
- description: "ID of the access control system that contains the credential.",
7182
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6904
7183
  format: "uuid",
6905
7184
  type: "string"
6906
7185
  },
6907
7186
  acs_user_id: {
6908
- description: "ID of the ACS user to whom the credential belongs.",
7187
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
6909
7188
  format: "uuid",
6910
7189
  type: "string"
6911
7190
  },
6912
7191
  assa_abloy_vostio_metadata: {
6913
- description: "Vostio-specific metadata for the credential.",
7192
+ description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6914
7193
  properties: {
6915
7194
  door_names: {
6916
7195
  items: { type: "string" },
@@ -6926,28 +7205,32 @@ var openapi_default = {
6926
7205
  },
6927
7206
  type: "object"
6928
7207
  },
6929
- card_number: { nullable: true, type: "string" },
7208
+ card_number: {
7209
+ description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7210
+ nullable: true,
7211
+ type: "string"
7212
+ },
6930
7213
  code: {
6931
- description: "Access (PIN) code for the credential.",
7214
+ description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6932
7215
  nullable: true,
6933
7216
  type: "string"
6934
7217
  },
6935
7218
  created_at: {
6936
- description: "Date and time at which the credential was created.",
7219
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
6937
7220
  format: "date-time",
6938
7221
  type: "string"
6939
7222
  },
6940
7223
  display_name: {
6941
- description: "Display name that corresponds to the credential type.",
7224
+ description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
6942
7225
  minLength: 1,
6943
7226
  type: "string"
6944
7227
  },
6945
7228
  ends_at: {
6946
- description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
7229
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
6947
7230
  type: "string"
6948
7231
  },
6949
7232
  errors: {
6950
- description: "Errors associated with the `acs_credential`.",
7233
+ description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
6951
7234
  items: {
6952
7235
  properties: {
6953
7236
  error_code: { type: "string" },
@@ -6959,7 +7242,7 @@ var openapi_default = {
6959
7242
  type: "array"
6960
7243
  },
6961
7244
  external_type: {
6962
- description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
7245
+ description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
6963
7246
  enum: [
6964
7247
  "pti_card",
6965
7248
  "brivo_credential",
@@ -6972,46 +7255,50 @@ var openapi_default = {
6972
7255
  type: "string"
6973
7256
  },
6974
7257
  external_type_display_name: {
6975
- description: "Display name that corresponds to the brand-specific terminology for the credential type.",
7258
+ description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
6976
7259
  type: "string"
6977
7260
  },
6978
- is_issued: { type: "boolean" },
7261
+ is_issued: {
7262
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
7263
+ type: "boolean"
7264
+ },
6979
7265
  is_latest_desired_state_synced_with_provider: {
6980
- description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
7266
+ description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
6981
7267
  nullable: true,
6982
7268
  type: "boolean"
6983
7269
  },
6984
7270
  is_managed: { enum: [true], type: "boolean" },
6985
7271
  is_multi_phone_sync_credential: {
6986
- description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
7272
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
6987
7273
  type: "boolean"
6988
7274
  },
6989
7275
  is_one_time_use: {
6990
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
7276
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
6991
7277
  type: "boolean"
6992
7278
  },
6993
7279
  issued_at: {
7280
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
6994
7281
  format: "date-time",
6995
7282
  nullable: true,
6996
7283
  type: "string"
6997
7284
  },
6998
7285
  latest_desired_state_synced_with_provider_at: {
6999
- description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
7286
+ description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
7000
7287
  format: "date-time",
7001
7288
  nullable: true,
7002
7289
  type: "string"
7003
7290
  },
7004
7291
  parent_acs_credential_id: {
7005
- description: "ID of the parent credential.",
7292
+ description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7006
7293
  format: "uuid",
7007
7294
  type: "string"
7008
7295
  },
7009
7296
  starts_at: {
7010
- description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7297
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7011
7298
  type: "string"
7012
7299
  },
7013
7300
  visionline_metadata: {
7014
- description: "Visionline-specific metadata for the credential.",
7301
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7015
7302
  properties: {
7016
7303
  auto_join: { type: "boolean" },
7017
7304
  card_function_type: {
@@ -7038,13 +7325,13 @@ var openapi_default = {
7038
7325
  type: "object"
7039
7326
  },
7040
7327
  warnings: {
7041
- description: "Warnings associated with the `acs_credential`.",
7328
+ description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7042
7329
  items: {
7043
- description: "Warning associated with the `acs_credential`.",
7330
+ description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7044
7331
  discriminator: { propertyName: "warning_code" },
7045
7332
  oneOf: [
7046
7333
  {
7047
- description: "Indicates that the credential is waiting to be issued.",
7334
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
7048
7335
  properties: {
7049
7336
  created_at: {
7050
7337
  description: "Date and time at which Seam created the warning.",
@@ -7069,7 +7356,7 @@ var openapi_default = {
7069
7356
  type: "object"
7070
7357
  },
7071
7358
  {
7072
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
7359
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
7073
7360
  properties: {
7074
7361
  created_at: {
7075
7362
  description: "Date and time at which Seam created the warning.",
@@ -7094,7 +7381,7 @@ var openapi_default = {
7094
7381
  type: "object"
7095
7382
  },
7096
7383
  {
7097
- description: "Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.",
7384
+ description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
7098
7385
  properties: {
7099
7386
  created_at: {
7100
7387
  description: "Date and time at which Seam created the warning.",
@@ -7119,7 +7406,7 @@ var openapi_default = {
7119
7406
  type: "object"
7120
7407
  },
7121
7408
  {
7122
- description: "Indicates that this credential is being deleted.",
7409
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
7123
7410
  properties: {
7124
7411
  created_at: {
7125
7412
  description: "Date and time at which Seam created the warning.",
@@ -7144,7 +7431,7 @@ var openapi_default = {
7144
7431
  type: "object"
7145
7432
  },
7146
7433
  {
7147
- description: "An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.",
7434
+ description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
7148
7435
  properties: {
7149
7436
  created_at: {
7150
7437
  description: "Date and time at which Seam created the warning.",
@@ -7169,7 +7456,7 @@ var openapi_default = {
7169
7456
  type: "object"
7170
7457
  },
7171
7458
  {
7172
- description: "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.",
7459
+ description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
7173
7460
  properties: {
7174
7461
  created_at: {
7175
7462
  description: "Date and time at which Seam created the warning.",
@@ -7198,7 +7485,7 @@ var openapi_default = {
7198
7485
  type: "array"
7199
7486
  },
7200
7487
  workspace_id: {
7201
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
7488
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7202
7489
  format: "uuid",
7203
7490
  type: "string"
7204
7491
  }
@@ -7218,15 +7505,15 @@ var openapi_default = {
7218
7505
  "x-route-path": "/acs/credentials"
7219
7506
  },
7220
7507
  {
7221
- description: "Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
7508
+ description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
7222
7509
  properties: {
7223
7510
  access_method: {
7224
- description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
7511
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
7225
7512
  enum: ["code", "card", "mobile_key"],
7226
7513
  type: "string"
7227
7514
  },
7228
7515
  acs_credential_id: {
7229
- description: "ID of the credential.",
7516
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7230
7517
  format: "uuid",
7231
7518
  type: "string"
7232
7519
  },
@@ -7235,17 +7522,17 @@ var openapi_default = {
7235
7522
  type: "string"
7236
7523
  },
7237
7524
  acs_system_id: {
7238
- description: "ID of the access control system that contains the credential.",
7525
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7239
7526
  format: "uuid",
7240
7527
  type: "string"
7241
7528
  },
7242
7529
  acs_user_id: {
7243
- description: "ID of the ACS user to whom the credential belongs.",
7530
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
7244
7531
  format: "uuid",
7245
7532
  type: "string"
7246
7533
  },
7247
7534
  assa_abloy_vostio_metadata: {
7248
- description: "Vostio-specific metadata for the credential.",
7535
+ description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7249
7536
  properties: {
7250
7537
  door_names: {
7251
7538
  items: { type: "string" },
@@ -7261,28 +7548,32 @@ var openapi_default = {
7261
7548
  },
7262
7549
  type: "object"
7263
7550
  },
7264
- card_number: { nullable: true, type: "string" },
7551
+ card_number: {
7552
+ description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7553
+ nullable: true,
7554
+ type: "string"
7555
+ },
7265
7556
  code: {
7266
- description: "Access (PIN) code for the credential.",
7557
+ description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7267
7558
  nullable: true,
7268
7559
  type: "string"
7269
7560
  },
7270
7561
  created_at: {
7271
- description: "Date and time at which the credential was created.",
7562
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
7272
7563
  format: "date-time",
7273
7564
  type: "string"
7274
7565
  },
7275
7566
  display_name: {
7276
- description: "Display name that corresponds to the credential type.",
7567
+ description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
7277
7568
  minLength: 1,
7278
7569
  type: "string"
7279
7570
  },
7280
7571
  ends_at: {
7281
- description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
7572
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
7282
7573
  type: "string"
7283
7574
  },
7284
7575
  errors: {
7285
- description: "Errors associated with the `acs_credential`.",
7576
+ description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7286
7577
  items: {
7287
7578
  properties: {
7288
7579
  error_code: { type: "string" },
@@ -7294,7 +7585,7 @@ var openapi_default = {
7294
7585
  type: "array"
7295
7586
  },
7296
7587
  external_type: {
7297
- description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
7588
+ description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
7298
7589
  enum: [
7299
7590
  "pti_card",
7300
7591
  "brivo_credential",
@@ -7307,46 +7598,50 @@ var openapi_default = {
7307
7598
  type: "string"
7308
7599
  },
7309
7600
  external_type_display_name: {
7310
- description: "Display name that corresponds to the brand-specific terminology for the credential type.",
7601
+ description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
7311
7602
  type: "string"
7312
7603
  },
7313
- is_issued: { type: "boolean" },
7604
+ is_issued: {
7605
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
7606
+ type: "boolean"
7607
+ },
7314
7608
  is_latest_desired_state_synced_with_provider: {
7315
- description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
7609
+ description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
7316
7610
  nullable: true,
7317
7611
  type: "boolean"
7318
7612
  },
7319
7613
  is_managed: { enum: [false], type: "boolean" },
7320
7614
  is_multi_phone_sync_credential: {
7321
- description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
7615
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
7322
7616
  type: "boolean"
7323
7617
  },
7324
7618
  is_one_time_use: {
7325
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
7619
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
7326
7620
  type: "boolean"
7327
7621
  },
7328
7622
  issued_at: {
7623
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
7329
7624
  format: "date-time",
7330
7625
  nullable: true,
7331
7626
  type: "string"
7332
7627
  },
7333
7628
  latest_desired_state_synced_with_provider_at: {
7334
- description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
7629
+ description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
7335
7630
  format: "date-time",
7336
7631
  nullable: true,
7337
7632
  type: "string"
7338
7633
  },
7339
7634
  parent_acs_credential_id: {
7340
- description: "ID of the parent credential.",
7635
+ description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7341
7636
  format: "uuid",
7342
7637
  type: "string"
7343
7638
  },
7344
7639
  starts_at: {
7345
- description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7640
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7346
7641
  type: "string"
7347
7642
  },
7348
7643
  visionline_metadata: {
7349
- description: "Visionline-specific metadata for the credential.",
7644
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7350
7645
  properties: {
7351
7646
  auto_join: { type: "boolean" },
7352
7647
  card_function_type: {
@@ -7373,13 +7668,13 @@ var openapi_default = {
7373
7668
  type: "object"
7374
7669
  },
7375
7670
  warnings: {
7376
- description: "Warnings associated with the `acs_credential`.",
7671
+ description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7377
7672
  items: {
7378
- description: "Warning associated with the `acs_credential`.",
7673
+ description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7379
7674
  discriminator: { propertyName: "warning_code" },
7380
7675
  oneOf: [
7381
7676
  {
7382
- description: "Indicates that the credential is waiting to be issued.",
7677
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
7383
7678
  properties: {
7384
7679
  created_at: {
7385
7680
  description: "Date and time at which Seam created the warning.",
@@ -7404,7 +7699,7 @@ var openapi_default = {
7404
7699
  type: "object"
7405
7700
  },
7406
7701
  {
7407
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
7702
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
7408
7703
  properties: {
7409
7704
  created_at: {
7410
7705
  description: "Date and time at which Seam created the warning.",
@@ -7429,7 +7724,7 @@ var openapi_default = {
7429
7724
  type: "object"
7430
7725
  },
7431
7726
  {
7432
- description: "Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.",
7727
+ description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
7433
7728
  properties: {
7434
7729
  created_at: {
7435
7730
  description: "Date and time at which Seam created the warning.",
@@ -7454,7 +7749,7 @@ var openapi_default = {
7454
7749
  type: "object"
7455
7750
  },
7456
7751
  {
7457
- description: "Indicates that this credential is being deleted.",
7752
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
7458
7753
  properties: {
7459
7754
  created_at: {
7460
7755
  description: "Date and time at which Seam created the warning.",
@@ -7479,7 +7774,7 @@ var openapi_default = {
7479
7774
  type: "object"
7480
7775
  },
7481
7776
  {
7482
- description: "An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.",
7777
+ description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
7483
7778
  properties: {
7484
7779
  created_at: {
7485
7780
  description: "Date and time at which Seam created the warning.",
@@ -7504,7 +7799,7 @@ var openapi_default = {
7504
7799
  type: "object"
7505
7800
  },
7506
7801
  {
7507
- description: "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.",
7802
+ description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
7508
7803
  properties: {
7509
7804
  created_at: {
7510
7805
  description: "Date and time at which Seam created the warning.",
@@ -7533,7 +7828,7 @@ var openapi_default = {
7533
7828
  type: "array"
7534
7829
  },
7535
7830
  workspace_id: {
7536
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
7831
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7537
7832
  format: "uuid",
7538
7833
  type: "string"
7539
7834
  }
@@ -10097,30 +10392,36 @@ var openapi_default = {
10097
10392
  nullable: true,
10098
10393
  properties: {
10099
10394
  climate_preset_key: {
10100
- description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
10395
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
10101
10396
  type: "string"
10102
10397
  },
10103
10398
  created_at: {
10104
- description: "Date and time at which the thermostat schedule was created.",
10399
+ description: "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.",
10105
10400
  format: "date-time",
10106
10401
  type: "string"
10107
10402
  },
10108
10403
  device_id: {
10109
- description: "ID of the desired thermostat device.",
10404
+ description: "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.",
10110
10405
  format: "uuid",
10111
10406
  type: "string"
10112
10407
  },
10113
10408
  ends_at: {
10114
- description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10409
+ description: "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10115
10410
  format: "date-time",
10116
10411
  type: "string"
10117
10412
  },
10118
10413
  errors: {
10119
- description: "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.",
10414
+ description: "Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
10120
10415
  items: {
10121
10416
  properties: {
10122
- error_code: { type: "string" },
10123
- message: { type: "string" }
10417
+ error_code: {
10418
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
10419
+ type: "string"
10420
+ },
10421
+ message: {
10422
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
10423
+ type: "string"
10424
+ }
10124
10425
  },
10125
10426
  required: ["error_code", "message"],
10126
10427
  type: "object"
@@ -10128,26 +10429,26 @@ var openapi_default = {
10128
10429
  type: "array"
10129
10430
  },
10130
10431
  max_override_period_minutes: {
10131
- description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
10432
+ description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
10132
10433
  minimum: 0,
10133
10434
  type: "integer"
10134
10435
  },
10135
10436
  name: {
10136
- description: "User-friendly name to identify the thermostat schedule.",
10437
+ description: "User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
10137
10438
  type: "string"
10138
10439
  },
10139
10440
  starts_at: {
10140
- description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10441
+ description: "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10141
10442
  format: "date-time",
10142
10443
  type: "string"
10143
10444
  },
10144
10445
  thermostat_schedule_id: {
10145
- description: "ID of the thermostat schedule.",
10446
+ description: "ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
10146
10447
  format: "uuid",
10147
10448
  type: "string"
10148
10449
  },
10149
10450
  unstable_is_override_allowed: {
10150
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
10451
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.",
10151
10452
  type: "boolean",
10152
10453
  "x-undocumented": "Unstable"
10153
10454
  }
@@ -10169,15 +10470,15 @@ var openapi_default = {
10169
10470
  items: {
10170
10471
  properties: {
10171
10472
  can_delete: {
10172
- description: "Indicates whether this climate preset key can be deleted.",
10473
+ description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.",
10173
10474
  type: "boolean"
10174
10475
  },
10175
10476
  can_edit: {
10176
- description: "Indicates whether this climate preset key can be edited.",
10477
+ description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.",
10177
10478
  type: "boolean"
10178
10479
  },
10179
10480
  climate_preset_key: {
10180
- description: "Unique key to identify the climate preset.",
10481
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10181
10482
  type: "string"
10182
10483
  },
10183
10484
  cooling_set_point_celsius: {
@@ -10186,26 +10487,26 @@ var openapi_default = {
10186
10487
  type: "number"
10187
10488
  },
10188
10489
  cooling_set_point_fahrenheit: {
10189
- description: "Temperature to which the thermostat should cool (in \xB0F).",
10490
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10190
10491
  format: "float",
10191
10492
  type: "number"
10192
10493
  },
10193
10494
  display_name: {
10194
- description: "Display name for the climate preset.",
10495
+ description: "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10195
10496
  type: "string"
10196
10497
  },
10197
10498
  fan_mode_setting: {
10198
- description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
10499
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
10199
10500
  enum: ["auto", "on", "circulate"],
10200
10501
  type: "string"
10201
10502
  },
10202
10503
  heating_set_point_celsius: {
10203
- description: "Temperature to which the thermostat should heat (in \xB0C).",
10504
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10204
10505
  format: "float",
10205
10506
  type: "number"
10206
10507
  },
10207
10508
  heating_set_point_fahrenheit: {
10208
- description: "Temperature to which the thermostat should heat (in \xB0F).",
10509
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10209
10510
  format: "float",
10210
10511
  type: "number"
10211
10512
  },
@@ -10216,13 +10517,13 @@ var openapi_default = {
10216
10517
  },
10217
10518
  manual_override_allowed: {
10218
10519
  deprecated: true,
10219
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
10520
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
10220
10521
  type: "boolean",
10221
10522
  "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
10222
10523
  },
10223
10524
  name: {
10224
10525
  default: null,
10225
- description: "User-friendly name to identify the climate preset.",
10526
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10226
10527
  nullable: true,
10227
10528
  type: "string"
10228
10529
  }
@@ -10255,15 +10556,15 @@ var openapi_default = {
10255
10556
  current_climate_setting: {
10256
10557
  properties: {
10257
10558
  can_delete: {
10258
- description: "Indicates whether this climate preset key can be deleted.",
10559
+ description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.",
10259
10560
  type: "boolean"
10260
10561
  },
10261
10562
  can_edit: {
10262
- description: "Indicates whether this climate preset key can be edited.",
10563
+ description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.",
10263
10564
  type: "boolean"
10264
10565
  },
10265
10566
  climate_preset_key: {
10266
- description: "Unique key to identify the climate preset.",
10567
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10267
10568
  type: "string"
10268
10569
  },
10269
10570
  cooling_set_point_celsius: {
@@ -10272,26 +10573,26 @@ var openapi_default = {
10272
10573
  type: "number"
10273
10574
  },
10274
10575
  cooling_set_point_fahrenheit: {
10275
- description: "Temperature to which the thermostat should cool (in \xB0F).",
10576
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10276
10577
  format: "float",
10277
10578
  type: "number"
10278
10579
  },
10279
10580
  display_name: {
10280
- description: "Display name for the climate preset.",
10581
+ description: "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10281
10582
  type: "string"
10282
10583
  },
10283
10584
  fan_mode_setting: {
10284
- description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
10585
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
10285
10586
  enum: ["auto", "on", "circulate"],
10286
10587
  type: "string"
10287
10588
  },
10288
10589
  heating_set_point_celsius: {
10289
- description: "Temperature to which the thermostat should heat (in \xB0C).",
10590
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10290
10591
  format: "float",
10291
10592
  type: "number"
10292
10593
  },
10293
10594
  heating_set_point_fahrenheit: {
10294
- description: "Temperature to which the thermostat should heat (in \xB0F).",
10595
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10295
10596
  format: "float",
10296
10597
  type: "number"
10297
10598
  },
@@ -10302,13 +10603,13 @@ var openapi_default = {
10302
10603
  },
10303
10604
  manual_override_allowed: {
10304
10605
  deprecated: true,
10305
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
10606
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
10306
10607
  type: "boolean",
10307
10608
  "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
10308
10609
  },
10309
10610
  name: {
10310
10611
  default: null,
10311
- description: "User-friendly name to identify the climate preset.",
10612
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10312
10613
  nullable: true,
10313
10614
  type: "string"
10314
10615
  }
@@ -10319,15 +10620,15 @@ var openapi_default = {
10319
10620
  deprecated: true,
10320
10621
  properties: {
10321
10622
  can_delete: {
10322
- description: "Indicates whether this climate preset key can be deleted.",
10623
+ description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.",
10323
10624
  type: "boolean"
10324
10625
  },
10325
10626
  can_edit: {
10326
- description: "Indicates whether this climate preset key can be edited.",
10627
+ description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.",
10327
10628
  type: "boolean"
10328
10629
  },
10329
10630
  climate_preset_key: {
10330
- description: "Unique key to identify the climate preset.",
10631
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10331
10632
  type: "string"
10332
10633
  },
10333
10634
  cooling_set_point_celsius: {
@@ -10336,26 +10637,26 @@ var openapi_default = {
10336
10637
  type: "number"
10337
10638
  },
10338
10639
  cooling_set_point_fahrenheit: {
10339
- description: "Temperature to which the thermostat should cool (in \xB0F).",
10640
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10340
10641
  format: "float",
10341
10642
  type: "number"
10342
10643
  },
10343
10644
  display_name: {
10344
- description: "Display name for the climate preset.",
10645
+ description: "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10345
10646
  type: "string"
10346
10647
  },
10347
10648
  fan_mode_setting: {
10348
- description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
10649
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
10349
10650
  enum: ["auto", "on", "circulate"],
10350
10651
  type: "string"
10351
10652
  },
10352
10653
  heating_set_point_celsius: {
10353
- description: "Temperature to which the thermostat should heat (in \xB0C).",
10654
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10354
10655
  format: "float",
10355
10656
  type: "number"
10356
10657
  },
10357
10658
  heating_set_point_fahrenheit: {
10358
- description: "Temperature to which the thermostat should heat (in \xB0F).",
10659
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
10359
10660
  format: "float",
10360
10661
  type: "number"
10361
10662
  },
@@ -10366,13 +10667,13 @@ var openapi_default = {
10366
10667
  },
10367
10668
  manual_override_allowed: {
10368
10669
  deprecated: true,
10369
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
10670
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
10370
10671
  type: "boolean",
10371
10672
  "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
10372
10673
  },
10373
10674
  name: {
10374
10675
  default: null,
10375
- description: "User-friendly name to identify the climate preset.",
10676
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
10376
10677
  nullable: true,
10377
10678
  type: "string"
10378
10679
  }
@@ -14419,7 +14720,7 @@ var openapi_default = {
14419
14720
  type: "number"
14420
14721
  },
14421
14722
  cooling_set_point_fahrenheit: {
14422
- description: "Temperature to which the thermostat should cool (in \xB0F).",
14723
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
14423
14724
  format: "float",
14424
14725
  type: "number"
14425
14726
  },
@@ -14443,17 +14744,17 @@ var openapi_default = {
14443
14744
  type: "string"
14444
14745
  },
14445
14746
  fan_mode_setting: {
14446
- description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
14747
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
14447
14748
  enum: ["auto", "on", "circulate"],
14448
14749
  type: "string"
14449
14750
  },
14450
14751
  heating_set_point_celsius: {
14451
- description: "Temperature to which the thermostat should heat (in \xB0C).",
14752
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
14452
14753
  format: "float",
14453
14754
  type: "number"
14454
14755
  },
14455
14756
  heating_set_point_fahrenheit: {
14456
- description: "Temperature to which the thermostat should heat (in \xB0F).",
14757
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
14457
14758
  format: "float",
14458
14759
  type: "number"
14459
14760
  },
@@ -14805,6 +15106,58 @@ var openapi_default = {
14805
15106
  type: "object",
14806
15107
  "x-route-path": "/thermostats"
14807
15108
  },
15109
+ {
15110
+ description: "The name of a [device](https://docs.seam.co/latest/core-concepts/devices) was changed.",
15111
+ properties: {
15112
+ connected_account_id: {
15113
+ description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
15114
+ format: "uuid",
15115
+ type: "string"
15116
+ },
15117
+ created_at: {
15118
+ description: "Date and time at which the event was created.",
15119
+ format: "date-time",
15120
+ type: "string"
15121
+ },
15122
+ device_id: {
15123
+ description: "ID of the device.",
15124
+ format: "uuid",
15125
+ type: "string"
15126
+ },
15127
+ event_id: {
15128
+ description: "ID of the event.",
15129
+ format: "uuid",
15130
+ type: "string"
15131
+ },
15132
+ event_type: { enum: ["device.name_changed"], type: "string" },
15133
+ new_name: {
15134
+ description: "The new name of the device.",
15135
+ type: "string"
15136
+ },
15137
+ occurred_at: {
15138
+ description: "Date and time at which the event occurred.",
15139
+ format: "date-time",
15140
+ type: "string"
15141
+ },
15142
+ workspace_id: {
15143
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).",
15144
+ format: "uuid",
15145
+ type: "string"
15146
+ }
15147
+ },
15148
+ required: [
15149
+ "event_id",
15150
+ "workspace_id",
15151
+ "created_at",
15152
+ "occurred_at",
15153
+ "device_id",
15154
+ "connected_account_id",
15155
+ "event_type",
15156
+ "new_name"
15157
+ ],
15158
+ type: "object",
15159
+ "x-route-path": "/devices"
15160
+ },
14808
15161
  {
14809
15162
  description: "An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.",
14810
15163
  properties: {
@@ -15074,30 +15427,36 @@ var openapi_default = {
15074
15427
  description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
15075
15428
  properties: {
15076
15429
  climate_preset_key: {
15077
- description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
15430
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
15078
15431
  type: "string"
15079
15432
  },
15080
15433
  created_at: {
15081
- description: "Date and time at which the thermostat schedule was created.",
15434
+ description: "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.",
15082
15435
  format: "date-time",
15083
15436
  type: "string"
15084
15437
  },
15085
15438
  device_id: {
15086
- description: "ID of the desired thermostat device.",
15439
+ description: "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.",
15087
15440
  format: "uuid",
15088
15441
  type: "string"
15089
15442
  },
15090
15443
  ends_at: {
15091
- description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15444
+ description: "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15092
15445
  format: "date-time",
15093
15446
  type: "string"
15094
15447
  },
15095
15448
  errors: {
15096
- description: "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.",
15449
+ description: "Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
15097
15450
  items: {
15098
15451
  properties: {
15099
- error_code: { type: "string" },
15100
- message: { type: "string" }
15452
+ error_code: {
15453
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15454
+ type: "string"
15455
+ },
15456
+ message: {
15457
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
15458
+ type: "string"
15459
+ }
15101
15460
  },
15102
15461
  required: ["error_code", "message"],
15103
15462
  type: "object"
@@ -15105,26 +15464,26 @@ var openapi_default = {
15105
15464
  type: "array"
15106
15465
  },
15107
15466
  max_override_period_minutes: {
15108
- description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
15467
+ description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
15109
15468
  minimum: 0,
15110
15469
  type: "integer"
15111
15470
  },
15112
15471
  name: {
15113
- description: "User-friendly name to identify the thermostat schedule.",
15472
+ description: "User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
15114
15473
  type: "string"
15115
15474
  },
15116
15475
  starts_at: {
15117
- description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15476
+ description: "Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
15118
15477
  format: "date-time",
15119
15478
  type: "string"
15120
15479
  },
15121
15480
  thermostat_schedule_id: {
15122
- description: "ID of the thermostat schedule.",
15481
+ description: "ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
15123
15482
  format: "uuid",
15124
15483
  type: "string"
15125
15484
  },
15126
15485
  unstable_is_override_allowed: {
15127
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
15486
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.",
15128
15487
  type: "boolean",
15129
15488
  "x-undocumented": "Unstable"
15130
15489
  }
@@ -16031,31 +16390,31 @@ var openapi_default = {
16031
16390
  "x-route-path": "/acs/access_groups/unmanaged"
16032
16391
  },
16033
16392
  unmanaged_acs_credential: {
16034
- description: "Means by which a user gains access at an entrance. The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
16393
+ description: "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.",
16035
16394
  properties: {
16036
16395
  access_method: {
16037
- description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
16396
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
16038
16397
  enum: ["code", "card", "mobile_key"],
16039
16398
  type: "string"
16040
16399
  },
16041
16400
  acs_credential_id: {
16042
- description: "ID of the credential.",
16401
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16043
16402
  format: "uuid",
16044
16403
  type: "string"
16045
16404
  },
16046
16405
  acs_credential_pool_id: { format: "uuid", type: "string" },
16047
16406
  acs_system_id: {
16048
- description: "ID of the access control system that contains the credential.",
16407
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16049
16408
  format: "uuid",
16050
16409
  type: "string"
16051
16410
  },
16052
16411
  acs_user_id: {
16053
- description: "ID of the ACS user to whom the credential belongs.",
16412
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
16054
16413
  format: "uuid",
16055
16414
  type: "string"
16056
16415
  },
16057
16416
  assa_abloy_vostio_metadata: {
16058
- description: "Vostio-specific metadata for the credential.",
16417
+ description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16059
16418
  properties: {
16060
16419
  door_names: { items: { type: "string" }, type: "array" },
16061
16420
  endpoint_id: { type: "string" },
@@ -16068,28 +16427,32 @@ var openapi_default = {
16068
16427
  },
16069
16428
  type: "object"
16070
16429
  },
16071
- card_number: { nullable: true, type: "string" },
16430
+ card_number: {
16431
+ description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16432
+ nullable: true,
16433
+ type: "string"
16434
+ },
16072
16435
  code: {
16073
- description: "Access (PIN) code for the credential.",
16436
+ description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16074
16437
  nullable: true,
16075
16438
  type: "string"
16076
16439
  },
16077
16440
  created_at: {
16078
- description: "Date and time at which the credential was created.",
16441
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
16079
16442
  format: "date-time",
16080
16443
  type: "string"
16081
16444
  },
16082
16445
  display_name: {
16083
- description: "Display name that corresponds to the credential type.",
16446
+ description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
16084
16447
  minLength: 1,
16085
16448
  type: "string"
16086
16449
  },
16087
16450
  ends_at: {
16088
- description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
16451
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
16089
16452
  type: "string"
16090
16453
  },
16091
16454
  errors: {
16092
- description: "Errors associated with the `acs_credential`.",
16455
+ description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16093
16456
  items: {
16094
16457
  properties: {
16095
16458
  error_code: { type: "string" },
@@ -16101,7 +16464,7 @@ var openapi_default = {
16101
16464
  type: "array"
16102
16465
  },
16103
16466
  external_type: {
16104
- description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
16467
+ description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
16105
16468
  enum: [
16106
16469
  "pti_card",
16107
16470
  "brivo_credential",
@@ -16114,42 +16477,50 @@ var openapi_default = {
16114
16477
  type: "string"
16115
16478
  },
16116
16479
  external_type_display_name: {
16117
- description: "Display name that corresponds to the brand-specific terminology for the credential type.",
16480
+ description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
16118
16481
  type: "string"
16119
16482
  },
16120
- is_issued: { type: "boolean" },
16483
+ is_issued: {
16484
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
16485
+ type: "boolean"
16486
+ },
16121
16487
  is_latest_desired_state_synced_with_provider: {
16122
- description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
16488
+ description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
16123
16489
  nullable: true,
16124
16490
  type: "boolean"
16125
16491
  },
16126
16492
  is_managed: { enum: [false], type: "boolean" },
16127
16493
  is_multi_phone_sync_credential: {
16128
- description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
16494
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
16129
16495
  type: "boolean"
16130
16496
  },
16131
16497
  is_one_time_use: {
16132
- description: 'Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.',
16498
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
16133
16499
  type: "boolean"
16134
16500
  },
16135
- issued_at: { format: "date-time", nullable: true, type: "string" },
16501
+ issued_at: {
16502
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
16503
+ format: "date-time",
16504
+ nullable: true,
16505
+ type: "string"
16506
+ },
16136
16507
  latest_desired_state_synced_with_provider_at: {
16137
- description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
16508
+ description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
16138
16509
  format: "date-time",
16139
16510
  nullable: true,
16140
16511
  type: "string"
16141
16512
  },
16142
16513
  parent_acs_credential_id: {
16143
- description: "ID of the parent credential.",
16514
+ description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16144
16515
  format: "uuid",
16145
16516
  type: "string"
16146
16517
  },
16147
16518
  starts_at: {
16148
- description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
16519
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
16149
16520
  type: "string"
16150
16521
  },
16151
16522
  visionline_metadata: {
16152
- description: "Visionline-specific metadata for the credential.",
16523
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16153
16524
  properties: {
16154
16525
  auto_join: { type: "boolean" },
16155
16526
  card_function_type: { enum: ["guest", "staff"], type: "string" },
@@ -16173,13 +16544,13 @@ var openapi_default = {
16173
16544
  type: "object"
16174
16545
  },
16175
16546
  warnings: {
16176
- description: "Warnings associated with the `acs_credential`.",
16547
+ description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16177
16548
  items: {
16178
- description: "Warning associated with the `acs_credential`.",
16549
+ description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16179
16550
  discriminator: { propertyName: "warning_code" },
16180
16551
  oneOf: [
16181
16552
  {
16182
- description: "Indicates that the credential is waiting to be issued.",
16553
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
16183
16554
  properties: {
16184
16555
  created_at: {
16185
16556
  description: "Date and time at which Seam created the warning.",
@@ -16200,7 +16571,7 @@ var openapi_default = {
16200
16571
  type: "object"
16201
16572
  },
16202
16573
  {
16203
- description: "Indicates that the schedule of one of the credential's children was modified externally.",
16574
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
16204
16575
  properties: {
16205
16576
  created_at: {
16206
16577
  description: "Date and time at which Seam created the warning.",
@@ -16221,7 +16592,7 @@ var openapi_default = {
16221
16592
  type: "object"
16222
16593
  },
16223
16594
  {
16224
- description: "Indicates that the schedule of this credential was modified to avoid creating a credential with a start date in the past.",
16595
+ description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
16225
16596
  properties: {
16226
16597
  created_at: {
16227
16598
  description: "Date and time at which Seam created the warning.",
@@ -16242,7 +16613,7 @@ var openapi_default = {
16242
16613
  type: "object"
16243
16614
  },
16244
16615
  {
16245
- description: "Indicates that this credential is being deleted.",
16616
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
16246
16617
  properties: {
16247
16618
  created_at: {
16248
16619
  description: "Date and time at which Seam created the warning.",
@@ -16263,7 +16634,7 @@ var openapi_default = {
16263
16634
  type: "object"
16264
16635
  },
16265
16636
  {
16266
- description: "An unknown issue occurred while syncing the state of this credential with the provider. This issue may affect the proper functioning of this credential.",
16637
+ description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
16267
16638
  properties: {
16268
16639
  created_at: {
16269
16640
  description: "Date and time at which Seam created the warning.",
@@ -16284,7 +16655,7 @@ var openapi_default = {
16284
16655
  type: "object"
16285
16656
  },
16286
16657
  {
16287
- description: "Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.",
16658
+ description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
16288
16659
  properties: {
16289
16660
  created_at: {
16290
16661
  description: "Date and time at which Seam created the warning.",
@@ -16309,7 +16680,7 @@ var openapi_default = {
16309
16680
  type: "array"
16310
16681
  },
16311
16682
  workspace_id: {
16312
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
16683
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
16313
16684
  format: "uuid",
16314
16685
  type: "string"
16315
16686
  }
@@ -16332,7 +16703,7 @@ var openapi_default = {
16332
16703
  description: "Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
16333
16704
  properties: {
16334
16705
  access_schedule: {
16335
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
16706
+ description: "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.",
16336
16707
  properties: {
16337
16708
  ends_at: {
16338
16709
  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.",
@@ -16350,22 +16721,22 @@ var openapi_default = {
16350
16721
  type: "object"
16351
16722
  },
16352
16723
  acs_system_id: {
16353
- description: "ID of the access control system that contains the `acs_user`.",
16724
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16354
16725
  format: "uuid",
16355
16726
  type: "string"
16356
16727
  },
16357
16728
  acs_user_id: {
16358
- description: "ID of the `acs_user`.",
16729
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16359
16730
  format: "uuid",
16360
16731
  type: "string"
16361
16732
  },
16362
16733
  created_at: {
16363
- description: "Date and time at which the `acs_user` was created.",
16734
+ description: "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.",
16364
16735
  format: "date-time",
16365
16736
  type: "string"
16366
16737
  },
16367
16738
  display_name: {
16368
- description: "Display name for the `acs_user`.",
16739
+ description: "Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16369
16740
  type: "string"
16370
16741
  },
16371
16742
  email: {
@@ -16375,18 +16746,18 @@ var openapi_default = {
16375
16746
  "x-deprecated": "use email_address."
16376
16747
  },
16377
16748
  email_address: {
16378
- description: "Email address of the `acs_user`.",
16749
+ description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16379
16750
  format: "email",
16380
16751
  type: "string"
16381
16752
  },
16382
16753
  errors: {
16383
- description: "Errors associated with the `acs_user`.",
16754
+ description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16384
16755
  items: {
16385
- description: "Error associated with the `acs_user`.",
16756
+ description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16386
16757
  discriminator: { propertyName: "error_code" },
16387
16758
  oneOf: [
16388
16759
  {
16389
- description: "Indicates that the ACS user was deleted from the ACS system outside of Seam.",
16760
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.",
16390
16761
  properties: {
16391
16762
  created_at: {
16392
16763
  description: "Date and time at which Seam created the error.",
@@ -16406,7 +16777,7 @@ var openapi_default = {
16406
16777
  type: "object"
16407
16778
  },
16408
16779
  {
16409
- description: "Indicates that the user could not be subscribed on Salto KS because the subscription limit has been exceeded.",
16780
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.",
16410
16781
  properties: {
16411
16782
  created_at: {
16412
16783
  description: "Date and time at which Seam created the error.",
@@ -16426,7 +16797,7 @@ var openapi_default = {
16426
16797
  type: "object"
16427
16798
  },
16428
16799
  {
16429
- description: "Indicates that the user was not created on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
16800
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
16430
16801
  properties: {
16431
16802
  created_at: {
16432
16803
  description: "Date and time at which Seam created the error.",
@@ -16446,7 +16817,7 @@ var openapi_default = {
16446
16817
  type: "object"
16447
16818
  },
16448
16819
  {
16449
- description: "Indicates that the user was not updated on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
16820
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
16450
16821
  properties: {
16451
16822
  created_at: {
16452
16823
  description: "Date and time at which Seam created the error.",
@@ -16466,7 +16837,7 @@ var openapi_default = {
16466
16837
  type: "object"
16467
16838
  },
16468
16839
  {
16469
- description: "Indicates that the user was not deleted on the ACS system. This is likely due to an internal unexpected error. Please contact Seam's support if you encounter this.",
16840
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
16470
16841
  properties: {
16471
16842
  created_at: {
16472
16843
  description: "Date and time at which Seam created the error.",
@@ -16490,7 +16861,7 @@ var openapi_default = {
16490
16861
  type: "array"
16491
16862
  },
16492
16863
  external_type: {
16493
- description: "Brand-specific terminology for the `acs_user` type.",
16864
+ description: "Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.",
16494
16865
  enum: [
16495
16866
  "pti_user",
16496
16867
  "brivo_user",
@@ -16503,11 +16874,11 @@ var openapi_default = {
16503
16874
  type: "string"
16504
16875
  },
16505
16876
  external_type_display_name: {
16506
- description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
16877
+ description: "Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.",
16507
16878
  type: "string"
16508
16879
  },
16509
16880
  full_name: {
16510
- description: "Full name of the `acs_user`.",
16881
+ description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16511
16882
  type: "string"
16512
16883
  },
16513
16884
  hid_acs_system_id: { format: "uuid", type: "string" },
@@ -16518,7 +16889,7 @@ var openapi_default = {
16518
16889
  },
16519
16890
  is_managed: { enum: [false], type: "boolean" },
16520
16891
  is_suspended: {
16521
- description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
16892
+ description: "Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
16522
16893
  type: "boolean"
16523
16894
  },
16524
16895
  latest_desired_state_synced_with_provider_at: {
@@ -16528,49 +16899,63 @@ var openapi_default = {
16528
16899
  "x-undocumented": "Only used internally."
16529
16900
  },
16530
16901
  phone_number: {
16531
- description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
16902
+ description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
16532
16903
  type: "string"
16533
16904
  },
16534
16905
  user_identity_email_address: {
16535
- description: "Email address of the user identity associated with the `acs_user`.",
16906
+ description: "Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16536
16907
  nullable: true,
16537
16908
  type: "string"
16538
16909
  },
16539
16910
  user_identity_full_name: {
16540
- description: "Full name of the user identity associated with the `acs_user`.",
16911
+ description: "Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16541
16912
  nullable: true,
16542
16913
  type: "string"
16543
16914
  },
16544
16915
  user_identity_id: {
16545
- description: "ID of the user identity associated with the `acs_user`.",
16916
+ description: "ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16546
16917
  type: "string"
16547
16918
  },
16548
16919
  user_identity_phone_number: {
16549
- description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
16920
+ description: "Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
16550
16921
  nullable: true,
16551
16922
  type: "string"
16552
16923
  },
16553
16924
  warnings: {
16554
- description: "Warnings associated with the `acs_user`.",
16925
+ description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16555
16926
  items: {
16556
- description: "Warning associated with the `acs_user`.",
16927
+ description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16557
16928
  discriminator: { propertyName: "warning_code" },
16558
16929
  oneOf: [
16559
16930
  {
16560
- description: "Indicates that the user is being deleted from the ACS system. This is a temporary state, and the user will be deleted shortly.",
16931
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.",
16561
16932
  properties: {
16562
- created_at: { format: "date-time", type: "string" },
16563
- message: { type: "string" },
16933
+ created_at: {
16934
+ description: "Date and time at which Seam created the warning.",
16935
+ format: "date-time",
16936
+ type: "string"
16937
+ },
16938
+ message: {
16939
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
16940
+ type: "string"
16941
+ },
16564
16942
  warning_code: { enum: ["being_deleted"], type: "string" }
16565
16943
  },
16566
16944
  required: ["created_at", "message", "warning_code"],
16567
16945
  type: "object"
16568
16946
  },
16569
16947
  {
16570
- description: "Indicates that the user is not subscribed on the Salto KS, so they cannot unlock doors or perform any actions. This occur when the their access schedule hasn\u2019t started yet, or if their access schedule has ended, or if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.",
16948
+ description: "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn\u2019t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.",
16571
16949
  properties: {
16572
- created_at: { format: "date-time", type: "string" },
16573
- message: { type: "string" },
16950
+ created_at: {
16951
+ description: "Date and time at which Seam created the warning.",
16952
+ format: "date-time",
16953
+ type: "string"
16954
+ },
16955
+ message: {
16956
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
16957
+ type: "string"
16958
+ },
16574
16959
  warning_code: {
16575
16960
  enum: ["salto_ks_user_not_subscribed"],
16576
16961
  type: "string"
@@ -16580,10 +16965,17 @@ var openapi_default = {
16580
16965
  type: "object"
16581
16966
  },
16582
16967
  {
16583
- description: "An unknown issue occurred while syncing the state of this user with the provider. This issue may affect the proper functioning of this user.",
16968
+ description: "An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.",
16584
16969
  properties: {
16585
- created_at: { format: "date-time", type: "string" },
16586
- message: { type: "string" },
16970
+ created_at: {
16971
+ description: "Date and time at which Seam created the warning.",
16972
+ format: "date-time",
16973
+ type: "string"
16974
+ },
16975
+ message: {
16976
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
16977
+ type: "string"
16978
+ },
16587
16979
  warning_code: {
16588
16980
  enum: ["unknown_issue_with_acs_user"],
16589
16981
  type: "string"
@@ -16597,7 +16989,7 @@ var openapi_default = {
16597
16989
  type: "array"
16598
16990
  },
16599
16991
  workspace_id: {
16600
- description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
16992
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
16601
16993
  format: "uuid",
16602
16994
  type: "string"
16603
16995
  }
@@ -21509,7 +21901,7 @@ var openapi_default = {
21509
21901
  "x-deprecated": "use email_address."
21510
21902
  },
21511
21903
  email_address: {
21512
- description: "Email address of the `acs_user`.",
21904
+ description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
21513
21905
  format: "email",
21514
21906
  type: "string"
21515
21907
  },
@@ -21518,7 +21910,7 @@ var openapi_default = {
21518
21910
  type: "string"
21519
21911
  },
21520
21912
  phone_number: {
21521
- description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
21913
+ description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
21522
21914
  type: "string"
21523
21915
  },
21524
21916
  user_identity_id: {
@@ -22148,7 +22540,7 @@ var openapi_default = {
22148
22540
  type: "object"
22149
22541
  },
22150
22542
  acs_user_id: {
22151
- description: "ID of the `acs_user`.",
22543
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
22152
22544
  format: "uuid",
22153
22545
  type: "string"
22154
22546
  },
@@ -22159,17 +22551,17 @@ var openapi_default = {
22159
22551
  "x-deprecated": "use email_address."
22160
22552
  },
22161
22553
  email_address: {
22162
- description: "Email address of the `acs_user`.",
22554
+ description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
22163
22555
  format: "email",
22164
22556
  type: "string"
22165
22557
  },
22166
22558
  full_name: {
22167
- description: "Full name of the `acs_user`.",
22559
+ description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
22168
22560
  type: "string"
22169
22561
  },
22170
22562
  hid_acs_system_id: { format: "uuid", type: "string" },
22171
22563
  phone_number: {
22172
- description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
22564
+ description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
22173
22565
  type: "string"
22174
22566
  }
22175
22567
  },
@@ -22225,7 +22617,7 @@ var openapi_default = {
22225
22617
  type: "object"
22226
22618
  },
22227
22619
  acs_user_id: {
22228
- description: "ID of the `acs_user`.",
22620
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
22229
22621
  format: "uuid",
22230
22622
  type: "string"
22231
22623
  },
@@ -22236,17 +22628,17 @@ var openapi_default = {
22236
22628
  "x-deprecated": "use email_address."
22237
22629
  },
22238
22630
  email_address: {
22239
- description: "Email address of the `acs_user`.",
22631
+ description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
22240
22632
  format: "email",
22241
22633
  type: "string"
22242
22634
  },
22243
22635
  full_name: {
22244
- description: "Full name of the `acs_user`.",
22636
+ description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
22245
22637
  type: "string"
22246
22638
  },
22247
22639
  hid_acs_system_id: { format: "uuid", type: "string" },
22248
22640
  phone_number: {
22249
- description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
22641
+ description: "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
22250
22642
  type: "string"
22251
22643
  }
22252
22644
  },
@@ -24790,6 +25182,7 @@ var openapi_default = {
24790
25182
  "thermostat.temperature_threshold_no_longer_exceeded",
24791
25183
  "thermostat.temperature_reached_set_point",
24792
25184
  "thermostat.temperature_changed",
25185
+ "device.name_changed",
24793
25186
  "enrollment_automation.deleted",
24794
25187
  "phone.deactivated"
24795
25188
  ],
@@ -24871,6 +25264,7 @@ var openapi_default = {
24871
25264
  "thermostat.temperature_threshold_no_longer_exceeded",
24872
25265
  "thermostat.temperature_reached_set_point",
24873
25266
  "thermostat.temperature_changed",
25267
+ "device.name_changed",
24874
25268
  "enrollment_automation.deleted",
24875
25269
  "phone.deactivated"
24876
25270
  ],
@@ -26932,7 +27326,7 @@ var openapi_default = {
26932
27326
  schema: {
26933
27327
  properties: {
26934
27328
  climate_preset_key: {
26935
- description: "Unique key to identify the climate preset.",
27329
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
26936
27330
  type: "string"
26937
27331
  },
26938
27332
  cooling_set_point_celsius: {
@@ -26941,7 +27335,7 @@ var openapi_default = {
26941
27335
  type: "number"
26942
27336
  },
26943
27337
  cooling_set_point_fahrenheit: {
26944
- description: "Temperature to which the thermostat should cool (in \xB0F).",
27338
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
26945
27339
  format: "float",
26946
27340
  type: "number"
26947
27341
  },
@@ -26951,17 +27345,17 @@ var openapi_default = {
26951
27345
  type: "string"
26952
27346
  },
26953
27347
  fan_mode_setting: {
26954
- description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
27348
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
26955
27349
  enum: ["auto", "on", "circulate"],
26956
27350
  type: "string"
26957
27351
  },
26958
27352
  heating_set_point_celsius: {
26959
- description: "Temperature to which the thermostat should heat (in \xB0C).",
27353
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
26960
27354
  format: "float",
26961
27355
  type: "number"
26962
27356
  },
26963
27357
  heating_set_point_fahrenheit: {
26964
- description: "Temperature to which the thermostat should heat (in \xB0F).",
27358
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
26965
27359
  format: "float",
26966
27360
  type: "number"
26967
27361
  },
@@ -26979,7 +27373,7 @@ var openapi_default = {
26979
27373
  },
26980
27374
  name: {
26981
27375
  default: null,
26982
- description: "User-friendly name to identify the climate preset.",
27376
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
26983
27377
  nullable: true,
26984
27378
  type: "string"
26985
27379
  }
@@ -28692,7 +29086,7 @@ var openapi_default = {
28692
29086
  schema: {
28693
29087
  properties: {
28694
29088
  climate_preset_key: {
28695
- description: "Unique key to identify the climate preset.",
29089
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
28696
29090
  type: "string"
28697
29091
  },
28698
29092
  cooling_set_point_celsius: {
@@ -28701,7 +29095,7 @@ var openapi_default = {
28701
29095
  type: "number"
28702
29096
  },
28703
29097
  cooling_set_point_fahrenheit: {
28704
- description: "Temperature to which the thermostat should cool (in \xB0F).",
29098
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
28705
29099
  format: "float",
28706
29100
  type: "number"
28707
29101
  },
@@ -28711,17 +29105,17 @@ var openapi_default = {
28711
29105
  type: "string"
28712
29106
  },
28713
29107
  fan_mode_setting: {
28714
- description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
29108
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
28715
29109
  enum: ["auto", "on", "circulate"],
28716
29110
  type: "string"
28717
29111
  },
28718
29112
  heating_set_point_celsius: {
28719
- description: "Temperature to which the thermostat should heat (in \xB0C).",
29113
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
28720
29114
  format: "float",
28721
29115
  type: "number"
28722
29116
  },
28723
29117
  heating_set_point_fahrenheit: {
28724
- description: "Temperature to which the thermostat should heat (in \xB0F).",
29118
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
28725
29119
  format: "float",
28726
29120
  type: "number"
28727
29121
  },
@@ -28732,13 +29126,13 @@ var openapi_default = {
28732
29126
  },
28733
29127
  manual_override_allowed: {
28734
29128
  deprecated: true,
28735
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
29129
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
28736
29130
  type: "boolean",
28737
29131
  "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
28738
29132
  },
28739
29133
  name: {
28740
29134
  default: null,
28741
- description: "User-friendly name to identify the climate preset.",
29135
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
28742
29136
  nullable: true,
28743
29137
  type: "string"
28744
29138
  }
@@ -28789,7 +29183,7 @@ var openapi_default = {
28789
29183
  schema: {
28790
29184
  properties: {
28791
29185
  climate_preset_key: {
28792
- description: "Unique key to identify the climate preset.",
29186
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
28793
29187
  type: "string"
28794
29188
  },
28795
29189
  cooling_set_point_celsius: {
@@ -28798,7 +29192,7 @@ var openapi_default = {
28798
29192
  type: "number"
28799
29193
  },
28800
29194
  cooling_set_point_fahrenheit: {
28801
- description: "Temperature to which the thermostat should cool (in \xB0F).",
29195
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
28802
29196
  format: "float",
28803
29197
  type: "number"
28804
29198
  },
@@ -28808,17 +29202,17 @@ var openapi_default = {
28808
29202
  type: "string"
28809
29203
  },
28810
29204
  fan_mode_setting: {
28811
- description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
29205
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
28812
29206
  enum: ["auto", "on", "circulate"],
28813
29207
  type: "string"
28814
29208
  },
28815
29209
  heating_set_point_celsius: {
28816
- description: "Temperature to which the thermostat should heat (in \xB0C).",
29210
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
28817
29211
  format: "float",
28818
29212
  type: "number"
28819
29213
  },
28820
29214
  heating_set_point_fahrenheit: {
28821
- description: "Temperature to which the thermostat should heat (in \xB0F).",
29215
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
28822
29216
  format: "float",
28823
29217
  type: "number"
28824
29218
  },
@@ -28829,13 +29223,13 @@ var openapi_default = {
28829
29223
  },
28830
29224
  manual_override_allowed: {
28831
29225
  deprecated: true,
28832
- description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
29226
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
28833
29227
  type: "boolean",
28834
29228
  "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
28835
29229
  },
28836
29230
  name: {
28837
29231
  default: null,
28838
- description: "User-friendly name to identify the climate preset.",
29232
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
28839
29233
  nullable: true,
28840
29234
  type: "string"
28841
29235
  }