@seamapi/types 1.360.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.
- package/dist/connect.cjs +899 -569
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +3626 -2951
- package/lib/seam/connect/models/acs/acs-credential.js +94 -51
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-encoder.js +12 -7
- package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.js +37 -14
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.js +48 -41
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-user.js +45 -32
- package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
- package/lib/seam/connect/models/thermostats/climate-preset.js +12 -10
- package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +19 -12
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +45 -23
- package/lib/seam/connect/openapi.js +557 -401
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3581 -2928
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential.ts +162 -51
- package/src/lib/seam/connect/models/acs/acs-encoder.ts +22 -7
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +65 -18
- package/src/lib/seam/connect/models/acs/acs-system.ts +81 -52
- package/src/lib/seam/connect/models/acs/acs-user.ts +69 -32
- package/src/lib/seam/connect/models/thermostats/climate-preset.ts +28 -10
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +31 -12
- package/src/lib/seam/connect/openapi.ts +698 -401
- package/src/lib/seam/connect/route-types.ts +3581 -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(
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
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(
|
|
232
|
-
|
|
233
|
-
|
|
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(
|
|
245
|
-
|
|
246
|
-
|
|
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
|
-
|
|
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
|
-
"
|
|
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(
|
|
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
|
|
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(
|
|
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
|
|
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
|
|
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(
|
|
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(
|
|
1708
|
-
|
|
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(
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
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
|
-
|
|
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(
|
|
1745
|
-
|
|
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."
|
|
1812
|
+
),
|
|
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)."
|
|
1754
1815
|
),
|
|
1755
|
-
|
|
1756
|
-
|
|
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
|
|
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
|
|
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(
|
|
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(
|
|
1782
|
-
|
|
1783
|
-
|
|
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
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
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(
|
|
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(
|
|
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
|
|
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
|
|
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)."
|
|
1927
|
+
),
|
|
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."
|
|
1824
1930
|
),
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
|
|
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(
|
|
1843
|
-
|
|
1844
|
-
|
|
1845
|
-
|
|
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
|
-
|
|
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)."
|
|
1971
|
+
),
|
|
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)."
|
|
1851
1977
|
),
|
|
1852
|
-
|
|
1853
|
-
|
|
1854
|
-
|
|
1855
|
-
dormakaba_community_metadata: acs_entrance_dormakaba_community_metadata.optional()
|
|
1856
|
-
|
|
1857
|
-
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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(
|
|
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
|
|
1906
|
-
This error might also occur if
|
|
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
|
|
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 [
|
|
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
|
|
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
|
-
|
|
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(
|
|
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
|
-
|
|
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(
|
|
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)."
|
|
1982
2116
|
),
|
|
1983
|
-
acs_system_id: zod.z.string().uuid().describe(
|
|
1984
|
-
|
|
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)."
|
|
2119
|
+
),
|
|
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
|
|
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
|
|
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
|
|
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(
|
|
2014
|
-
|
|
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
|
|
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
|
|
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
|
|
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."
|
|
2174
|
+
),
|
|
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)."
|
|
2026
2177
|
),
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
warnings: zod.z.array(acs_system_warning).describe("Warnings associated with the `acs_system`.")
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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(
|
|
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
|
-
|
|
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
|
-
|
|
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(
|
|
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
|
|
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
|
|
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(
|
|
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(
|
|
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
|
|
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(
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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(
|
|
2211
|
-
|
|
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({
|
|
@@ -4633,31 +4807,31 @@ var openapi_default = {
|
|
|
4633
4807
|
"x-route-path": "/acs/access_groups"
|
|
4634
4808
|
},
|
|
4635
4809
|
acs_credential: {
|
|
4636
|
-
description: "Means by which
|
|
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.",
|
|
4637
4811
|
properties: {
|
|
4638
4812
|
access_method: {
|
|
4639
|
-
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`.",
|
|
4640
4814
|
enum: ["code", "card", "mobile_key"],
|
|
4641
4815
|
type: "string"
|
|
4642
4816
|
},
|
|
4643
4817
|
acs_credential_id: {
|
|
4644
|
-
description: "ID of the credential.",
|
|
4818
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
4645
4819
|
format: "uuid",
|
|
4646
4820
|
type: "string"
|
|
4647
4821
|
},
|
|
4648
4822
|
acs_credential_pool_id: { format: "uuid", type: "string" },
|
|
4649
4823
|
acs_system_id: {
|
|
4650
|
-
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).",
|
|
4651
4825
|
format: "uuid",
|
|
4652
4826
|
type: "string"
|
|
4653
4827
|
},
|
|
4654
4828
|
acs_user_id: {
|
|
4655
|
-
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.",
|
|
4656
4830
|
format: "uuid",
|
|
4657
4831
|
type: "string"
|
|
4658
4832
|
},
|
|
4659
4833
|
assa_abloy_vostio_metadata: {
|
|
4660
|
-
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).",
|
|
4661
4835
|
properties: {
|
|
4662
4836
|
door_names: { items: { type: "string" }, type: "array" },
|
|
4663
4837
|
endpoint_id: { type: "string" },
|
|
@@ -4670,28 +4844,32 @@ var openapi_default = {
|
|
|
4670
4844
|
},
|
|
4671
4845
|
type: "object"
|
|
4672
4846
|
},
|
|
4673
|
-
card_number: {
|
|
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
|
+
},
|
|
4674
4852
|
code: {
|
|
4675
|
-
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).",
|
|
4676
4854
|
nullable: true,
|
|
4677
4855
|
type: "string"
|
|
4678
4856
|
},
|
|
4679
4857
|
created_at: {
|
|
4680
|
-
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.",
|
|
4681
4859
|
format: "date-time",
|
|
4682
4860
|
type: "string"
|
|
4683
4861
|
},
|
|
4684
4862
|
display_name: {
|
|
4685
|
-
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.",
|
|
4686
4864
|
minLength: 1,
|
|
4687
4865
|
type: "string"
|
|
4688
4866
|
},
|
|
4689
4867
|
ends_at: {
|
|
4690
|
-
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`.",
|
|
4691
4869
|
type: "string"
|
|
4692
4870
|
},
|
|
4693
4871
|
errors: {
|
|
4694
|
-
description: "Errors associated with the
|
|
4872
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
4695
4873
|
items: {
|
|
4696
4874
|
properties: {
|
|
4697
4875
|
error_code: { type: "string" },
|
|
@@ -4703,7 +4881,7 @@ var openapi_default = {
|
|
|
4703
4881
|
type: "array"
|
|
4704
4882
|
},
|
|
4705
4883
|
external_type: {
|
|
4706
|
-
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`.",
|
|
4707
4885
|
enum: [
|
|
4708
4886
|
"pti_card",
|
|
4709
4887
|
"brivo_credential",
|
|
@@ -4716,42 +4894,50 @@ var openapi_default = {
|
|
|
4716
4894
|
type: "string"
|
|
4717
4895
|
},
|
|
4718
4896
|
external_type_display_name: {
|
|
4719
|
-
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.",
|
|
4720
4898
|
type: "string"
|
|
4721
4899
|
},
|
|
4722
|
-
is_issued: {
|
|
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
|
+
},
|
|
4723
4904
|
is_latest_desired_state_synced_with_provider: {
|
|
4724
|
-
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.",
|
|
4725
4906
|
nullable: true,
|
|
4726
4907
|
type: "boolean"
|
|
4727
4908
|
},
|
|
4728
4909
|
is_managed: { enum: [true], type: "boolean" },
|
|
4729
4910
|
is_multi_phone_sync_credential: {
|
|
4730
|
-
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).",
|
|
4731
4912
|
type: "boolean"
|
|
4732
4913
|
},
|
|
4733
4914
|
is_one_time_use: {
|
|
4734
|
-
description:
|
|
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.",
|
|
4735
4916
|
type: "boolean"
|
|
4736
4917
|
},
|
|
4737
|
-
issued_at: {
|
|
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
|
+
},
|
|
4738
4924
|
latest_desired_state_synced_with_provider_at: {
|
|
4739
|
-
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.",
|
|
4740
4926
|
format: "date-time",
|
|
4741
4927
|
nullable: true,
|
|
4742
4928
|
type: "string"
|
|
4743
4929
|
},
|
|
4744
4930
|
parent_acs_credential_id: {
|
|
4745
|
-
description: "ID of the parent credential.",
|
|
4931
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
4746
4932
|
format: "uuid",
|
|
4747
4933
|
type: "string"
|
|
4748
4934
|
},
|
|
4749
4935
|
starts_at: {
|
|
4750
|
-
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.",
|
|
4751
4937
|
type: "string"
|
|
4752
4938
|
},
|
|
4753
4939
|
visionline_metadata: {
|
|
4754
|
-
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).",
|
|
4755
4941
|
properties: {
|
|
4756
4942
|
auto_join: { type: "boolean" },
|
|
4757
4943
|
card_function_type: { enum: ["guest", "staff"], type: "string" },
|
|
@@ -4775,13 +4961,13 @@ var openapi_default = {
|
|
|
4775
4961
|
type: "object"
|
|
4776
4962
|
},
|
|
4777
4963
|
warnings: {
|
|
4778
|
-
description: "Warnings associated with the
|
|
4964
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
4779
4965
|
items: {
|
|
4780
|
-
description: "Warning associated with the
|
|
4966
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
4781
4967
|
discriminator: { propertyName: "warning_code" },
|
|
4782
4968
|
oneOf: [
|
|
4783
4969
|
{
|
|
4784
|
-
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.",
|
|
4785
4971
|
properties: {
|
|
4786
4972
|
created_at: {
|
|
4787
4973
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -4802,7 +4988,7 @@ var openapi_default = {
|
|
|
4802
4988
|
type: "object"
|
|
4803
4989
|
},
|
|
4804
4990
|
{
|
|
4805
|
-
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.",
|
|
4806
4992
|
properties: {
|
|
4807
4993
|
created_at: {
|
|
4808
4994
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -4823,7 +5009,7 @@ var openapi_default = {
|
|
|
4823
5009
|
type: "object"
|
|
4824
5010
|
},
|
|
4825
5011
|
{
|
|
4826
|
-
description: "Indicates that the schedule of
|
|
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.",
|
|
4827
5013
|
properties: {
|
|
4828
5014
|
created_at: {
|
|
4829
5015
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -4844,7 +5030,7 @@ var openapi_default = {
|
|
|
4844
5030
|
type: "object"
|
|
4845
5031
|
},
|
|
4846
5032
|
{
|
|
4847
|
-
description: "Indicates that
|
|
5033
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
4848
5034
|
properties: {
|
|
4849
5035
|
created_at: {
|
|
4850
5036
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -4865,7 +5051,7 @@ var openapi_default = {
|
|
|
4865
5051
|
type: "object"
|
|
4866
5052
|
},
|
|
4867
5053
|
{
|
|
4868
|
-
description: "An unknown issue occurred while syncing the state of
|
|
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.",
|
|
4869
5055
|
properties: {
|
|
4870
5056
|
created_at: {
|
|
4871
5057
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -4886,7 +5072,7 @@ var openapi_default = {
|
|
|
4886
5072
|
type: "object"
|
|
4887
5073
|
},
|
|
4888
5074
|
{
|
|
4889
|
-
description: "Access permissions for
|
|
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.",
|
|
4890
5076
|
properties: {
|
|
4891
5077
|
created_at: {
|
|
4892
5078
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -4911,7 +5097,7 @@ var openapi_default = {
|
|
|
4911
5097
|
type: "array"
|
|
4912
5098
|
},
|
|
4913
5099
|
workspace_id: {
|
|
4914
|
-
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).",
|
|
4915
5101
|
format: "uuid",
|
|
4916
5102
|
type: "string"
|
|
4917
5103
|
}
|
|
@@ -4977,28 +5163,28 @@ var openapi_default = {
|
|
|
4977
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).",
|
|
4978
5164
|
properties: {
|
|
4979
5165
|
acs_encoder_id: {
|
|
4980
|
-
description: "ID of the
|
|
5166
|
+
description: "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.",
|
|
4981
5167
|
format: "uuid",
|
|
4982
5168
|
type: "string"
|
|
4983
5169
|
},
|
|
4984
5170
|
acs_system_id: {
|
|
4985
|
-
description: "ID of the access control system that contains the
|
|
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).",
|
|
4986
5172
|
format: "uuid",
|
|
4987
5173
|
type: "string"
|
|
4988
5174
|
},
|
|
4989
5175
|
created_at: {
|
|
4990
|
-
description: "Date and time at which the
|
|
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.",
|
|
4991
5177
|
format: "date-time",
|
|
4992
5178
|
type: "string"
|
|
4993
5179
|
},
|
|
4994
5180
|
display_name: {
|
|
4995
|
-
description: "Display name for the
|
|
5181
|
+
description: "Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
|
|
4996
5182
|
type: "string"
|
|
4997
5183
|
},
|
|
4998
5184
|
errors: {
|
|
4999
|
-
description: "Errors associated with the
|
|
5185
|
+
description: "Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
|
|
5000
5186
|
items: {
|
|
5001
|
-
description: "Error associated with the
|
|
5187
|
+
description: "Error associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
|
|
5002
5188
|
properties: {
|
|
5003
5189
|
created_at: {
|
|
5004
5190
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5021,7 +5207,7 @@ var openapi_default = {
|
|
|
5021
5207
|
type: "array"
|
|
5022
5208
|
},
|
|
5023
5209
|
workspace_id: {
|
|
5024
|
-
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
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).",
|
|
5025
5211
|
format: "uuid",
|
|
5026
5212
|
type: "string"
|
|
5027
5213
|
}
|
|
@@ -5041,16 +5227,17 @@ var openapi_default = {
|
|
|
5041
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).",
|
|
5042
5228
|
properties: {
|
|
5043
5229
|
acs_entrance_id: {
|
|
5044
|
-
description: "ID of the entrance.",
|
|
5230
|
+
description: "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
5045
5231
|
format: "uuid",
|
|
5046
5232
|
type: "string"
|
|
5047
5233
|
},
|
|
5048
5234
|
acs_system_id: {
|
|
5049
|
-
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).",
|
|
5050
5236
|
format: "uuid",
|
|
5051
5237
|
type: "string"
|
|
5052
5238
|
},
|
|
5053
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).",
|
|
5054
5241
|
properties: {
|
|
5055
5242
|
door_name: { type: "string" },
|
|
5056
5243
|
door_number: { format: "float", type: "number" },
|
|
@@ -5065,24 +5252,32 @@ var openapi_default = {
|
|
|
5065
5252
|
type: "object"
|
|
5066
5253
|
},
|
|
5067
5254
|
created_at: {
|
|
5068
|
-
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.",
|
|
5069
5256
|
format: "date-time",
|
|
5070
5257
|
type: "string"
|
|
5071
5258
|
},
|
|
5072
5259
|
display_name: {
|
|
5073
|
-
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).",
|
|
5074
5261
|
type: "string"
|
|
5075
5262
|
},
|
|
5076
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).",
|
|
5077
5265
|
properties: { access_point_name: { type: "string" } },
|
|
5078
5266
|
required: ["access_point_name"],
|
|
5079
5267
|
type: "object"
|
|
5080
5268
|
},
|
|
5081
5269
|
errors: {
|
|
5270
|
+
description: "Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
5082
5271
|
items: {
|
|
5083
5272
|
properties: {
|
|
5084
|
-
error_code: {
|
|
5085
|
-
|
|
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
|
+
}
|
|
5086
5281
|
},
|
|
5087
5282
|
required: ["error_code", "message"],
|
|
5088
5283
|
type: "object"
|
|
@@ -5090,6 +5285,7 @@ var openapi_default = {
|
|
|
5090
5285
|
type: "array"
|
|
5091
5286
|
},
|
|
5092
5287
|
latch_metadata: {
|
|
5288
|
+
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
5093
5289
|
properties: {
|
|
5094
5290
|
accessibility_type: { type: "string" },
|
|
5095
5291
|
door_name: { type: "string" },
|
|
@@ -5105,6 +5301,7 @@ var openapi_default = {
|
|
|
5105
5301
|
type: "object"
|
|
5106
5302
|
},
|
|
5107
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).",
|
|
5108
5305
|
properties: {
|
|
5109
5306
|
battery_level: { type: "string" },
|
|
5110
5307
|
door_name: { type: "string" },
|
|
@@ -5124,6 +5321,7 @@ var openapi_default = {
|
|
|
5124
5321
|
type: "object"
|
|
5125
5322
|
},
|
|
5126
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).",
|
|
5127
5325
|
properties: {
|
|
5128
5326
|
door_description: { type: "string" },
|
|
5129
5327
|
door_name: { type: "string" },
|
|
@@ -5133,6 +5331,7 @@ var openapi_default = {
|
|
|
5133
5331
|
type: "object"
|
|
5134
5332
|
},
|
|
5135
5333
|
visionline_metadata: {
|
|
5334
|
+
description: "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
5136
5335
|
properties: {
|
|
5137
5336
|
door_category: {
|
|
5138
5337
|
enum: [
|
|
@@ -5181,58 +5380,57 @@ var openapi_default = {
|
|
|
5181
5380
|
description: "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5182
5381
|
properties: {
|
|
5183
5382
|
acs_system_id: {
|
|
5184
|
-
description: "ID of the
|
|
5383
|
+
description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5185
5384
|
format: "uuid",
|
|
5186
5385
|
type: "string"
|
|
5187
5386
|
},
|
|
5188
5387
|
can_add_acs_users_to_acs_access_groups: {
|
|
5189
|
-
description: "Indicates whether the
|
|
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).",
|
|
5190
5389
|
type: "boolean"
|
|
5191
5390
|
},
|
|
5192
5391
|
can_automate_enrollment: {
|
|
5193
|
-
description: "Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
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).",
|
|
5194
5393
|
type: "boolean"
|
|
5195
5394
|
},
|
|
5196
5395
|
can_create_acs_access_groups: {
|
|
5197
|
-
description: "Indicates whether the
|
|
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).",
|
|
5198
5397
|
type: "boolean"
|
|
5199
5398
|
},
|
|
5200
5399
|
can_remove_acs_users_from_acs_access_groups: {
|
|
5201
|
-
description: "Indicates whether the
|
|
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).",
|
|
5202
5401
|
type: "boolean"
|
|
5203
5402
|
},
|
|
5204
5403
|
connected_account_id: {
|
|
5205
|
-
description: "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the
|
|
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).",
|
|
5206
5405
|
format: "uuid",
|
|
5207
5406
|
type: "string"
|
|
5208
5407
|
},
|
|
5209
5408
|
connected_account_ids: {
|
|
5210
5409
|
deprecated: true,
|
|
5211
|
-
description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the
|
|
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).",
|
|
5212
5411
|
items: { format: "uuid", type: "string" },
|
|
5213
5412
|
type: "array",
|
|
5214
5413
|
"x-deprecated": "Use `connected_account_id`."
|
|
5215
5414
|
},
|
|
5216
5415
|
created_at: {
|
|
5217
|
-
description: "Date and time at which the
|
|
5416
|
+
description: "Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.",
|
|
5218
5417
|
format: "date-time",
|
|
5219
5418
|
type: "string"
|
|
5220
5419
|
},
|
|
5221
5420
|
default_credential_manager_acs_system_id: {
|
|
5222
|
-
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).",
|
|
5223
5422
|
format: "uuid",
|
|
5224
5423
|
nullable: true,
|
|
5225
|
-
type: "string"
|
|
5226
|
-
"x-draft": "Needs review"
|
|
5424
|
+
type: "string"
|
|
5227
5425
|
},
|
|
5228
5426
|
errors: {
|
|
5229
|
-
description: "Errors associated with the
|
|
5427
|
+
description: "Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5230
5428
|
items: {
|
|
5231
|
-
description: "Error associated with the
|
|
5429
|
+
description: "Error associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5232
5430
|
discriminator: { propertyName: "error_code" },
|
|
5233
5431
|
oneOf: [
|
|
5234
5432
|
{
|
|
5235
|
-
description: "Indicates that the Seam API cannot communicate with
|
|
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).",
|
|
5236
5434
|
properties: {
|
|
5237
5435
|
created_at: {
|
|
5238
5436
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5253,7 +5451,7 @@ var openapi_default = {
|
|
|
5253
5451
|
type: "object"
|
|
5254
5452
|
},
|
|
5255
5453
|
{
|
|
5256
|
-
description: "Indicates that
|
|
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).",
|
|
5257
5455
|
properties: {
|
|
5258
5456
|
created_at: {
|
|
5259
5457
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5295,7 +5493,7 @@ var openapi_default = {
|
|
|
5295
5493
|
type: "object"
|
|
5296
5494
|
},
|
|
5297
5495
|
{
|
|
5298
|
-
description: "Indicates that the access system has been disconnected. See [
|
|
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.",
|
|
5299
5497
|
properties: {
|
|
5300
5498
|
created_at: {
|
|
5301
5499
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5316,7 +5514,7 @@ var openapi_default = {
|
|
|
5316
5514
|
type: "object"
|
|
5317
5515
|
},
|
|
5318
5516
|
{
|
|
5319
|
-
description: "Indicates that the login credentials are invalid. Reconnect the account using
|
|
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.",
|
|
5320
5518
|
properties: {
|
|
5321
5519
|
created_at: {
|
|
5322
5520
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5337,6 +5535,7 @@ var openapi_default = {
|
|
|
5337
5535
|
type: "object"
|
|
5338
5536
|
},
|
|
5339
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.",
|
|
5340
5539
|
properties: {
|
|
5341
5540
|
created_at: {
|
|
5342
5541
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5344,7 +5543,7 @@ var openapi_default = {
|
|
|
5344
5543
|
type: "string"
|
|
5345
5544
|
},
|
|
5346
5545
|
error_code: {
|
|
5347
|
-
description: "
|
|
5546
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
5348
5547
|
enum: ["salto_ks_certification_expired"],
|
|
5349
5548
|
type: "string"
|
|
5350
5549
|
},
|
|
@@ -5361,7 +5560,7 @@ var openapi_default = {
|
|
|
5361
5560
|
type: "array"
|
|
5362
5561
|
},
|
|
5363
5562
|
external_type: {
|
|
5364
|
-
description: "Brand-specific terminology for the
|
|
5563
|
+
description: "Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.",
|
|
5365
5564
|
enum: [
|
|
5366
5565
|
"pti_site",
|
|
5367
5566
|
"alta_org",
|
|
@@ -5380,25 +5579,25 @@ var openapi_default = {
|
|
|
5380
5579
|
type: "string"
|
|
5381
5580
|
},
|
|
5382
5581
|
external_type_display_name: {
|
|
5383
|
-
description: "Display name that corresponds to the brand-specific terminology for the
|
|
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.",
|
|
5384
5583
|
type: "string"
|
|
5385
5584
|
},
|
|
5386
5585
|
image_alt_text: {
|
|
5387
|
-
description: "Alternative text for the
|
|
5586
|
+
description: "Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.",
|
|
5388
5587
|
type: "string"
|
|
5389
5588
|
},
|
|
5390
5589
|
image_url: {
|
|
5391
|
-
description: "URL for the image that represents the
|
|
5590
|
+
description: "URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5392
5591
|
type: "string"
|
|
5393
5592
|
},
|
|
5394
5593
|
is_credential_manager: {
|
|
5395
|
-
description: "Indicates
|
|
5594
|
+
description: "Indicates whether the `acs_system` is a credential manager.",
|
|
5396
5595
|
type: "boolean"
|
|
5397
5596
|
},
|
|
5398
5597
|
location: {
|
|
5399
5598
|
properties: {
|
|
5400
5599
|
time_zone: {
|
|
5401
|
-
description: "Time zone in which the
|
|
5600
|
+
description: "Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.",
|
|
5402
5601
|
nullable: true,
|
|
5403
5602
|
type: "string"
|
|
5404
5603
|
}
|
|
@@ -5406,7 +5605,10 @@ var openapi_default = {
|
|
|
5406
5605
|
required: ["time_zone"],
|
|
5407
5606
|
type: "object"
|
|
5408
5607
|
},
|
|
5409
|
-
name: {
|
|
5608
|
+
name: {
|
|
5609
|
+
description: "Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5610
|
+
type: "string"
|
|
5611
|
+
},
|
|
5410
5612
|
system_type: {
|
|
5411
5613
|
deprecated: true,
|
|
5412
5614
|
enum: [
|
|
@@ -5435,7 +5637,7 @@ var openapi_default = {
|
|
|
5435
5637
|
visionline_metadata: {
|
|
5436
5638
|
properties: {
|
|
5437
5639
|
lan_address: {
|
|
5438
|
-
description: "IP address or hostname of the main Visionline server relative to
|
|
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.",
|
|
5439
5641
|
type: "string"
|
|
5440
5642
|
},
|
|
5441
5643
|
mobile_access_uuid: {
|
|
@@ -5451,12 +5653,13 @@ var openapi_default = {
|
|
|
5451
5653
|
type: "object"
|
|
5452
5654
|
},
|
|
5453
5655
|
warnings: {
|
|
5454
|
-
description: "Warnings associated with the
|
|
5656
|
+
description: "Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5455
5657
|
items: {
|
|
5456
|
-
description: "Warning associated with the
|
|
5658
|
+
description: "Warning associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
5457
5659
|
discriminator: { propertyName: "warning_code" },
|
|
5458
5660
|
oneOf: [
|
|
5459
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.",
|
|
5460
5663
|
properties: {
|
|
5461
5664
|
created_at: {
|
|
5462
5665
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -5468,7 +5671,7 @@ var openapi_default = {
|
|
|
5468
5671
|
type: "string"
|
|
5469
5672
|
},
|
|
5470
5673
|
warning_code: {
|
|
5471
|
-
description: "
|
|
5674
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5472
5675
|
enum: ["salto_ks_subscription_limit_almost_reached"],
|
|
5473
5676
|
type: "string"
|
|
5474
5677
|
}
|
|
@@ -5477,6 +5680,7 @@ var openapi_default = {
|
|
|
5477
5680
|
type: "object"
|
|
5478
5681
|
},
|
|
5479
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).",
|
|
5480
5684
|
properties: {
|
|
5481
5685
|
created_at: {
|
|
5482
5686
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -5492,7 +5696,7 @@ var openapi_default = {
|
|
|
5492
5696
|
type: "array"
|
|
5493
5697
|
},
|
|
5494
5698
|
warning_code: {
|
|
5495
|
-
description: "
|
|
5699
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
5496
5700
|
enum: ["time_zone_does_not_match_location"],
|
|
5497
5701
|
type: "string"
|
|
5498
5702
|
}
|
|
@@ -5505,7 +5709,7 @@ var openapi_default = {
|
|
|
5505
5709
|
type: "array"
|
|
5506
5710
|
},
|
|
5507
5711
|
workspace_id: {
|
|
5508
|
-
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
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).",
|
|
5509
5713
|
format: "uuid",
|
|
5510
5714
|
type: "string"
|
|
5511
5715
|
}
|
|
@@ -5531,7 +5735,7 @@ var openapi_default = {
|
|
|
5531
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).",
|
|
5532
5736
|
properties: {
|
|
5533
5737
|
access_schedule: {
|
|
5534
|
-
description: "`starts_at` and `ends_at` timestamps for the
|
|
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.",
|
|
5535
5739
|
properties: {
|
|
5536
5740
|
ends_at: {
|
|
5537
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.",
|
|
@@ -5549,22 +5753,22 @@ var openapi_default = {
|
|
|
5549
5753
|
type: "object"
|
|
5550
5754
|
},
|
|
5551
5755
|
acs_system_id: {
|
|
5552
|
-
description: "ID of the access control system that contains the
|
|
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).",
|
|
5553
5757
|
format: "uuid",
|
|
5554
5758
|
type: "string"
|
|
5555
5759
|
},
|
|
5556
5760
|
acs_user_id: {
|
|
5557
|
-
description: "ID of the
|
|
5761
|
+
description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5558
5762
|
format: "uuid",
|
|
5559
5763
|
type: "string"
|
|
5560
5764
|
},
|
|
5561
5765
|
created_at: {
|
|
5562
|
-
description: "Date and time at which the
|
|
5766
|
+
description: "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.",
|
|
5563
5767
|
format: "date-time",
|
|
5564
5768
|
type: "string"
|
|
5565
5769
|
},
|
|
5566
5770
|
display_name: {
|
|
5567
|
-
description: "Display name for the
|
|
5771
|
+
description: "Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5568
5772
|
type: "string"
|
|
5569
5773
|
},
|
|
5570
5774
|
email: {
|
|
@@ -5574,18 +5778,18 @@ var openapi_default = {
|
|
|
5574
5778
|
"x-deprecated": "use email_address."
|
|
5575
5779
|
},
|
|
5576
5780
|
email_address: {
|
|
5577
|
-
description: "Email address of the
|
|
5781
|
+
description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5578
5782
|
format: "email",
|
|
5579
5783
|
type: "string"
|
|
5580
5784
|
},
|
|
5581
5785
|
errors: {
|
|
5582
|
-
description: "Errors associated with the
|
|
5786
|
+
description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5583
5787
|
items: {
|
|
5584
|
-
description: "
|
|
5788
|
+
description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5585
5789
|
discriminator: { propertyName: "error_code" },
|
|
5586
5790
|
oneOf: [
|
|
5587
5791
|
{
|
|
5588
|
-
description: "Indicates that the ACS user was deleted from the
|
|
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.",
|
|
5589
5793
|
properties: {
|
|
5590
5794
|
created_at: {
|
|
5591
5795
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5605,7 +5809,7 @@ var openapi_default = {
|
|
|
5605
5809
|
type: "object"
|
|
5606
5810
|
},
|
|
5607
5811
|
{
|
|
5608
|
-
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.",
|
|
5609
5813
|
properties: {
|
|
5610
5814
|
created_at: {
|
|
5611
5815
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5625,7 +5829,7 @@ var openapi_default = {
|
|
|
5625
5829
|
type: "object"
|
|
5626
5830
|
},
|
|
5627
5831
|
{
|
|
5628
|
-
description: "Indicates that the user was not created on the
|
|
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).",
|
|
5629
5833
|
properties: {
|
|
5630
5834
|
created_at: {
|
|
5631
5835
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5645,7 +5849,7 @@ var openapi_default = {
|
|
|
5645
5849
|
type: "object"
|
|
5646
5850
|
},
|
|
5647
5851
|
{
|
|
5648
|
-
description: "Indicates that the user was not updated on the
|
|
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).",
|
|
5649
5853
|
properties: {
|
|
5650
5854
|
created_at: {
|
|
5651
5855
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5665,7 +5869,7 @@ var openapi_default = {
|
|
|
5665
5869
|
type: "object"
|
|
5666
5870
|
},
|
|
5667
5871
|
{
|
|
5668
|
-
description: "Indicates that the user was not deleted on the
|
|
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).",
|
|
5669
5873
|
properties: {
|
|
5670
5874
|
created_at: {
|
|
5671
5875
|
description: "Date and time at which Seam created the error.",
|
|
@@ -5689,7 +5893,7 @@ var openapi_default = {
|
|
|
5689
5893
|
type: "array"
|
|
5690
5894
|
},
|
|
5691
5895
|
external_type: {
|
|
5692
|
-
description: "Brand-specific terminology for the
|
|
5896
|
+
description: "Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.",
|
|
5693
5897
|
enum: [
|
|
5694
5898
|
"pti_user",
|
|
5695
5899
|
"brivo_user",
|
|
@@ -5702,11 +5906,11 @@ var openapi_default = {
|
|
|
5702
5906
|
type: "string"
|
|
5703
5907
|
},
|
|
5704
5908
|
external_type_display_name: {
|
|
5705
|
-
description: "Display name that corresponds to the brand-specific terminology for the
|
|
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.",
|
|
5706
5910
|
type: "string"
|
|
5707
5911
|
},
|
|
5708
5912
|
full_name: {
|
|
5709
|
-
description: "Full name of the
|
|
5913
|
+
description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5710
5914
|
type: "string"
|
|
5711
5915
|
},
|
|
5712
5916
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
@@ -5717,7 +5921,7 @@ var openapi_default = {
|
|
|
5717
5921
|
},
|
|
5718
5922
|
is_managed: { enum: [true], type: "boolean" },
|
|
5719
5923
|
is_suspended: {
|
|
5720
|
-
description: "Indicates whether the
|
|
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).",
|
|
5721
5925
|
type: "boolean"
|
|
5722
5926
|
},
|
|
5723
5927
|
latest_desired_state_synced_with_provider_at: {
|
|
@@ -5727,49 +5931,63 @@ var openapi_default = {
|
|
|
5727
5931
|
"x-undocumented": "Only used internally."
|
|
5728
5932
|
},
|
|
5729
5933
|
phone_number: {
|
|
5730
|
-
description: "Phone number of the
|
|
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`).",
|
|
5731
5935
|
type: "string"
|
|
5732
5936
|
},
|
|
5733
5937
|
user_identity_email_address: {
|
|
5734
|
-
description: "Email address of the user identity associated with the
|
|
5938
|
+
description: "Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5735
5939
|
nullable: true,
|
|
5736
5940
|
type: "string"
|
|
5737
5941
|
},
|
|
5738
5942
|
user_identity_full_name: {
|
|
5739
|
-
description: "Full name of the user identity associated with the
|
|
5943
|
+
description: "Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5740
5944
|
nullable: true,
|
|
5741
5945
|
type: "string"
|
|
5742
5946
|
},
|
|
5743
5947
|
user_identity_id: {
|
|
5744
|
-
description: "ID of the user identity associated with the
|
|
5948
|
+
description: "ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5745
5949
|
type: "string"
|
|
5746
5950
|
},
|
|
5747
5951
|
user_identity_phone_number: {
|
|
5748
|
-
description: "Phone number of the user identity associated with the
|
|
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`).",
|
|
5749
5953
|
nullable: true,
|
|
5750
5954
|
type: "string"
|
|
5751
5955
|
},
|
|
5752
5956
|
warnings: {
|
|
5753
|
-
description: "Warnings associated with the
|
|
5957
|
+
description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5754
5958
|
items: {
|
|
5755
|
-
description: "
|
|
5959
|
+
description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
5756
5960
|
discriminator: { propertyName: "warning_code" },
|
|
5757
5961
|
oneOf: [
|
|
5758
5962
|
{
|
|
5759
|
-
description: "Indicates that the user is being deleted from the
|
|
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.",
|
|
5760
5964
|
properties: {
|
|
5761
|
-
created_at: {
|
|
5762
|
-
|
|
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
|
+
},
|
|
5763
5974
|
warning_code: { enum: ["being_deleted"], type: "string" }
|
|
5764
5975
|
},
|
|
5765
5976
|
required: ["created_at", "message", "warning_code"],
|
|
5766
5977
|
type: "object"
|
|
5767
5978
|
},
|
|
5768
5979
|
{
|
|
5769
|
-
description: "Indicates that the user is not subscribed on
|
|
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.",
|
|
5770
5981
|
properties: {
|
|
5771
|
-
created_at: {
|
|
5772
|
-
|
|
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
|
+
},
|
|
5773
5991
|
warning_code: {
|
|
5774
5992
|
enum: ["salto_ks_user_not_subscribed"],
|
|
5775
5993
|
type: "string"
|
|
@@ -5779,10 +5997,17 @@ var openapi_default = {
|
|
|
5779
5997
|
type: "object"
|
|
5780
5998
|
},
|
|
5781
5999
|
{
|
|
5782
|
-
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.",
|
|
5783
6001
|
properties: {
|
|
5784
|
-
created_at: {
|
|
5785
|
-
|
|
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
|
+
},
|
|
5786
6011
|
warning_code: {
|
|
5787
6012
|
enum: ["unknown_issue_with_acs_user"],
|
|
5788
6013
|
type: "string"
|
|
@@ -5796,7 +6021,7 @@ var openapi_default = {
|
|
|
5796
6021
|
type: "array"
|
|
5797
6022
|
},
|
|
5798
6023
|
workspace_id: {
|
|
5799
|
-
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
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).",
|
|
5800
6025
|
format: "uuid",
|
|
5801
6026
|
type: "string"
|
|
5802
6027
|
}
|
|
@@ -6009,56 +6234,84 @@ var openapi_default = {
|
|
|
6009
6234
|
nullable: true,
|
|
6010
6235
|
properties: {
|
|
6011
6236
|
card_number: {
|
|
6012
|
-
description: "A number or string that physically identifies
|
|
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).",
|
|
6013
6238
|
nullable: true,
|
|
6014
6239
|
type: "string"
|
|
6015
6240
|
},
|
|
6016
6241
|
created_at: {
|
|
6017
|
-
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.",
|
|
6018
6243
|
format: "date-time",
|
|
6019
6244
|
nullable: true,
|
|
6020
6245
|
type: "string"
|
|
6021
6246
|
},
|
|
6022
6247
|
ends_at: {
|
|
6023
|
-
description: "Date and time the credential will stop being
|
|
6248
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable.",
|
|
6024
6249
|
format: "date-time",
|
|
6025
6250
|
nullable: true,
|
|
6026
6251
|
type: "string"
|
|
6027
6252
|
},
|
|
6028
6253
|
is_issued: { nullable: true, type: "boolean" },
|
|
6029
6254
|
starts_at: {
|
|
6030
|
-
description: "Date and time the credential
|
|
6255
|
+
description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable.",
|
|
6031
6256
|
format: "date-time",
|
|
6032
6257
|
nullable: true,
|
|
6033
6258
|
type: "string"
|
|
6034
6259
|
},
|
|
6035
6260
|
visionline_metadata: {
|
|
6036
|
-
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).",
|
|
6037
6262
|
properties: {
|
|
6038
|
-
cancelled: {
|
|
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
|
+
},
|
|
6039
6267
|
card_format: {
|
|
6268
|
+
description: "Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6040
6269
|
enum: ["TLCode", "rfid48"],
|
|
6041
6270
|
type: "string"
|
|
6042
6271
|
},
|
|
6043
|
-
card_holder: {
|
|
6044
|
-
|
|
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
|
+
},
|
|
6045
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).",
|
|
6046
6282
|
items: { format: "uuid", type: "string" },
|
|
6047
6283
|
type: "array"
|
|
6048
6284
|
},
|
|
6049
|
-
discarded: {
|
|
6050
|
-
|
|
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
|
+
},
|
|
6051
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).",
|
|
6052
6295
|
items: { format: "uuid", type: "string" },
|
|
6053
6296
|
type: "array"
|
|
6054
6297
|
},
|
|
6055
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).",
|
|
6056
6300
|
format: "float",
|
|
6057
6301
|
type: "number"
|
|
6058
6302
|
},
|
|
6059
|
-
overridden: {
|
|
6060
|
-
|
|
6061
|
-
|
|
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
|
+
}
|
|
6062
6315
|
},
|
|
6063
6316
|
required: [
|
|
6064
6317
|
"card_id",
|
|
@@ -6087,15 +6340,15 @@ var openapi_default = {
|
|
|
6087
6340
|
nullable: true,
|
|
6088
6341
|
oneOf: [
|
|
6089
6342
|
{
|
|
6090
|
-
description: "Means by which
|
|
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.",
|
|
6091
6344
|
properties: {
|
|
6092
6345
|
access_method: {
|
|
6093
|
-
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`.",
|
|
6094
6347
|
enum: ["code", "card", "mobile_key"],
|
|
6095
6348
|
type: "string"
|
|
6096
6349
|
},
|
|
6097
6350
|
acs_credential_id: {
|
|
6098
|
-
description: "ID of the credential.",
|
|
6351
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6099
6352
|
format: "uuid",
|
|
6100
6353
|
type: "string"
|
|
6101
6354
|
},
|
|
@@ -6104,17 +6357,17 @@ var openapi_default = {
|
|
|
6104
6357
|
type: "string"
|
|
6105
6358
|
},
|
|
6106
6359
|
acs_system_id: {
|
|
6107
|
-
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).",
|
|
6108
6361
|
format: "uuid",
|
|
6109
6362
|
type: "string"
|
|
6110
6363
|
},
|
|
6111
6364
|
acs_user_id: {
|
|
6112
|
-
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.",
|
|
6113
6366
|
format: "uuid",
|
|
6114
6367
|
type: "string"
|
|
6115
6368
|
},
|
|
6116
6369
|
assa_abloy_vostio_metadata: {
|
|
6117
|
-
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).",
|
|
6118
6371
|
properties: {
|
|
6119
6372
|
door_names: {
|
|
6120
6373
|
items: { type: "string" },
|
|
@@ -6130,28 +6383,32 @@ var openapi_default = {
|
|
|
6130
6383
|
},
|
|
6131
6384
|
type: "object"
|
|
6132
6385
|
},
|
|
6133
|
-
card_number: {
|
|
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
|
+
},
|
|
6134
6391
|
code: {
|
|
6135
|
-
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).",
|
|
6136
6393
|
nullable: true,
|
|
6137
6394
|
type: "string"
|
|
6138
6395
|
},
|
|
6139
6396
|
created_at: {
|
|
6140
|
-
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.",
|
|
6141
6398
|
format: "date-time",
|
|
6142
6399
|
type: "string"
|
|
6143
6400
|
},
|
|
6144
6401
|
display_name: {
|
|
6145
|
-
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.",
|
|
6146
6403
|
minLength: 1,
|
|
6147
6404
|
type: "string"
|
|
6148
6405
|
},
|
|
6149
6406
|
ends_at: {
|
|
6150
|
-
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`.",
|
|
6151
6408
|
type: "string"
|
|
6152
6409
|
},
|
|
6153
6410
|
errors: {
|
|
6154
|
-
description: "Errors associated with the
|
|
6411
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6155
6412
|
items: {
|
|
6156
6413
|
properties: {
|
|
6157
6414
|
error_code: { type: "string" },
|
|
@@ -6163,7 +6420,7 @@ var openapi_default = {
|
|
|
6163
6420
|
type: "array"
|
|
6164
6421
|
},
|
|
6165
6422
|
external_type: {
|
|
6166
|
-
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`.",
|
|
6167
6424
|
enum: [
|
|
6168
6425
|
"pti_card",
|
|
6169
6426
|
"brivo_credential",
|
|
@@ -6176,46 +6433,50 @@ var openapi_default = {
|
|
|
6176
6433
|
type: "string"
|
|
6177
6434
|
},
|
|
6178
6435
|
external_type_display_name: {
|
|
6179
|
-
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.",
|
|
6180
6437
|
type: "string"
|
|
6181
6438
|
},
|
|
6182
|
-
is_issued: {
|
|
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
|
+
},
|
|
6183
6443
|
is_latest_desired_state_synced_with_provider: {
|
|
6184
|
-
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.",
|
|
6185
6445
|
nullable: true,
|
|
6186
6446
|
type: "boolean"
|
|
6187
6447
|
},
|
|
6188
6448
|
is_managed: { enum: [true], type: "boolean" },
|
|
6189
6449
|
is_multi_phone_sync_credential: {
|
|
6190
|
-
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).",
|
|
6191
6451
|
type: "boolean"
|
|
6192
6452
|
},
|
|
6193
6453
|
is_one_time_use: {
|
|
6194
|
-
description:
|
|
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.",
|
|
6195
6455
|
type: "boolean"
|
|
6196
6456
|
},
|
|
6197
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.",
|
|
6198
6459
|
format: "date-time",
|
|
6199
6460
|
nullable: true,
|
|
6200
6461
|
type: "string"
|
|
6201
6462
|
},
|
|
6202
6463
|
latest_desired_state_synced_with_provider_at: {
|
|
6203
|
-
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.",
|
|
6204
6465
|
format: "date-time",
|
|
6205
6466
|
nullable: true,
|
|
6206
6467
|
type: "string"
|
|
6207
6468
|
},
|
|
6208
6469
|
parent_acs_credential_id: {
|
|
6209
|
-
description: "ID of the parent credential.",
|
|
6470
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6210
6471
|
format: "uuid",
|
|
6211
6472
|
type: "string"
|
|
6212
6473
|
},
|
|
6213
6474
|
starts_at: {
|
|
6214
|
-
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.",
|
|
6215
6476
|
type: "string"
|
|
6216
6477
|
},
|
|
6217
6478
|
visionline_metadata: {
|
|
6218
|
-
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).",
|
|
6219
6480
|
properties: {
|
|
6220
6481
|
auto_join: { type: "boolean" },
|
|
6221
6482
|
card_function_type: {
|
|
@@ -6242,13 +6503,13 @@ var openapi_default = {
|
|
|
6242
6503
|
type: "object"
|
|
6243
6504
|
},
|
|
6244
6505
|
warnings: {
|
|
6245
|
-
description: "Warnings associated with the
|
|
6506
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6246
6507
|
items: {
|
|
6247
|
-
description: "Warning associated with the
|
|
6508
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6248
6509
|
discriminator: { propertyName: "warning_code" },
|
|
6249
6510
|
oneOf: [
|
|
6250
6511
|
{
|
|
6251
|
-
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.",
|
|
6252
6513
|
properties: {
|
|
6253
6514
|
created_at: {
|
|
6254
6515
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6273,7 +6534,7 @@ var openapi_default = {
|
|
|
6273
6534
|
type: "object"
|
|
6274
6535
|
},
|
|
6275
6536
|
{
|
|
6276
|
-
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.",
|
|
6277
6538
|
properties: {
|
|
6278
6539
|
created_at: {
|
|
6279
6540
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6298,7 +6559,7 @@ var openapi_default = {
|
|
|
6298
6559
|
type: "object"
|
|
6299
6560
|
},
|
|
6300
6561
|
{
|
|
6301
|
-
description: "Indicates that the schedule of
|
|
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.",
|
|
6302
6563
|
properties: {
|
|
6303
6564
|
created_at: {
|
|
6304
6565
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6323,7 +6584,7 @@ var openapi_default = {
|
|
|
6323
6584
|
type: "object"
|
|
6324
6585
|
},
|
|
6325
6586
|
{
|
|
6326
|
-
description: "Indicates that
|
|
6587
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
6327
6588
|
properties: {
|
|
6328
6589
|
created_at: {
|
|
6329
6590
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6348,7 +6609,7 @@ var openapi_default = {
|
|
|
6348
6609
|
type: "object"
|
|
6349
6610
|
},
|
|
6350
6611
|
{
|
|
6351
|
-
description: "An unknown issue occurred while syncing the state of
|
|
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.",
|
|
6352
6613
|
properties: {
|
|
6353
6614
|
created_at: {
|
|
6354
6615
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6375,7 +6636,7 @@ var openapi_default = {
|
|
|
6375
6636
|
type: "object"
|
|
6376
6637
|
},
|
|
6377
6638
|
{
|
|
6378
|
-
description: "Access permissions for
|
|
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.",
|
|
6379
6640
|
properties: {
|
|
6380
6641
|
created_at: {
|
|
6381
6642
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6404,7 +6665,7 @@ var openapi_default = {
|
|
|
6404
6665
|
type: "array"
|
|
6405
6666
|
},
|
|
6406
6667
|
workspace_id: {
|
|
6407
|
-
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).",
|
|
6408
6669
|
format: "uuid",
|
|
6409
6670
|
type: "string"
|
|
6410
6671
|
}
|
|
@@ -6424,15 +6685,15 @@ var openapi_default = {
|
|
|
6424
6685
|
"x-route-path": "/acs/credentials"
|
|
6425
6686
|
},
|
|
6426
6687
|
{
|
|
6427
|
-
description: "Means by which
|
|
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.",
|
|
6428
6689
|
properties: {
|
|
6429
6690
|
access_method: {
|
|
6430
|
-
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`.",
|
|
6431
6692
|
enum: ["code", "card", "mobile_key"],
|
|
6432
6693
|
type: "string"
|
|
6433
6694
|
},
|
|
6434
6695
|
acs_credential_id: {
|
|
6435
|
-
description: "ID of the credential.",
|
|
6696
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6436
6697
|
format: "uuid",
|
|
6437
6698
|
type: "string"
|
|
6438
6699
|
},
|
|
@@ -6441,17 +6702,17 @@ var openapi_default = {
|
|
|
6441
6702
|
type: "string"
|
|
6442
6703
|
},
|
|
6443
6704
|
acs_system_id: {
|
|
6444
|
-
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).",
|
|
6445
6706
|
format: "uuid",
|
|
6446
6707
|
type: "string"
|
|
6447
6708
|
},
|
|
6448
6709
|
acs_user_id: {
|
|
6449
|
-
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.",
|
|
6450
6711
|
format: "uuid",
|
|
6451
6712
|
type: "string"
|
|
6452
6713
|
},
|
|
6453
6714
|
assa_abloy_vostio_metadata: {
|
|
6454
|
-
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).",
|
|
6455
6716
|
properties: {
|
|
6456
6717
|
door_names: {
|
|
6457
6718
|
items: { type: "string" },
|
|
@@ -6467,28 +6728,32 @@ var openapi_default = {
|
|
|
6467
6728
|
},
|
|
6468
6729
|
type: "object"
|
|
6469
6730
|
},
|
|
6470
|
-
card_number: {
|
|
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
|
+
},
|
|
6471
6736
|
code: {
|
|
6472
|
-
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).",
|
|
6473
6738
|
nullable: true,
|
|
6474
6739
|
type: "string"
|
|
6475
6740
|
},
|
|
6476
6741
|
created_at: {
|
|
6477
|
-
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.",
|
|
6478
6743
|
format: "date-time",
|
|
6479
6744
|
type: "string"
|
|
6480
6745
|
},
|
|
6481
6746
|
display_name: {
|
|
6482
|
-
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.",
|
|
6483
6748
|
minLength: 1,
|
|
6484
6749
|
type: "string"
|
|
6485
6750
|
},
|
|
6486
6751
|
ends_at: {
|
|
6487
|
-
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`.",
|
|
6488
6753
|
type: "string"
|
|
6489
6754
|
},
|
|
6490
6755
|
errors: {
|
|
6491
|
-
description: "Errors associated with the
|
|
6756
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6492
6757
|
items: {
|
|
6493
6758
|
properties: {
|
|
6494
6759
|
error_code: { type: "string" },
|
|
@@ -6500,7 +6765,7 @@ var openapi_default = {
|
|
|
6500
6765
|
type: "array"
|
|
6501
6766
|
},
|
|
6502
6767
|
external_type: {
|
|
6503
|
-
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`.",
|
|
6504
6769
|
enum: [
|
|
6505
6770
|
"pti_card",
|
|
6506
6771
|
"brivo_credential",
|
|
@@ -6513,46 +6778,50 @@ var openapi_default = {
|
|
|
6513
6778
|
type: "string"
|
|
6514
6779
|
},
|
|
6515
6780
|
external_type_display_name: {
|
|
6516
|
-
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.",
|
|
6517
6782
|
type: "string"
|
|
6518
6783
|
},
|
|
6519
|
-
is_issued: {
|
|
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
|
+
},
|
|
6520
6788
|
is_latest_desired_state_synced_with_provider: {
|
|
6521
|
-
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.",
|
|
6522
6790
|
nullable: true,
|
|
6523
6791
|
type: "boolean"
|
|
6524
6792
|
},
|
|
6525
6793
|
is_managed: { enum: [false], type: "boolean" },
|
|
6526
6794
|
is_multi_phone_sync_credential: {
|
|
6527
|
-
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).",
|
|
6528
6796
|
type: "boolean"
|
|
6529
6797
|
},
|
|
6530
6798
|
is_one_time_use: {
|
|
6531
|
-
description:
|
|
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.",
|
|
6532
6800
|
type: "boolean"
|
|
6533
6801
|
},
|
|
6534
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.",
|
|
6535
6804
|
format: "date-time",
|
|
6536
6805
|
nullable: true,
|
|
6537
6806
|
type: "string"
|
|
6538
6807
|
},
|
|
6539
6808
|
latest_desired_state_synced_with_provider_at: {
|
|
6540
|
-
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.",
|
|
6541
6810
|
format: "date-time",
|
|
6542
6811
|
nullable: true,
|
|
6543
6812
|
type: "string"
|
|
6544
6813
|
},
|
|
6545
6814
|
parent_acs_credential_id: {
|
|
6546
|
-
description: "ID of the parent credential.",
|
|
6815
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6547
6816
|
format: "uuid",
|
|
6548
6817
|
type: "string"
|
|
6549
6818
|
},
|
|
6550
6819
|
starts_at: {
|
|
6551
|
-
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.",
|
|
6552
6821
|
type: "string"
|
|
6553
6822
|
},
|
|
6554
6823
|
visionline_metadata: {
|
|
6555
|
-
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).",
|
|
6556
6825
|
properties: {
|
|
6557
6826
|
auto_join: { type: "boolean" },
|
|
6558
6827
|
card_function_type: {
|
|
@@ -6579,13 +6848,13 @@ var openapi_default = {
|
|
|
6579
6848
|
type: "object"
|
|
6580
6849
|
},
|
|
6581
6850
|
warnings: {
|
|
6582
|
-
description: "Warnings associated with the
|
|
6851
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6583
6852
|
items: {
|
|
6584
|
-
description: "Warning associated with the
|
|
6853
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6585
6854
|
discriminator: { propertyName: "warning_code" },
|
|
6586
6855
|
oneOf: [
|
|
6587
6856
|
{
|
|
6588
|
-
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.",
|
|
6589
6858
|
properties: {
|
|
6590
6859
|
created_at: {
|
|
6591
6860
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6610,7 +6879,7 @@ var openapi_default = {
|
|
|
6610
6879
|
type: "object"
|
|
6611
6880
|
},
|
|
6612
6881
|
{
|
|
6613
|
-
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.",
|
|
6614
6883
|
properties: {
|
|
6615
6884
|
created_at: {
|
|
6616
6885
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6635,7 +6904,7 @@ var openapi_default = {
|
|
|
6635
6904
|
type: "object"
|
|
6636
6905
|
},
|
|
6637
6906
|
{
|
|
6638
|
-
description: "Indicates that the schedule of
|
|
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.",
|
|
6639
6908
|
properties: {
|
|
6640
6909
|
created_at: {
|
|
6641
6910
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6660,7 +6929,7 @@ var openapi_default = {
|
|
|
6660
6929
|
type: "object"
|
|
6661
6930
|
},
|
|
6662
6931
|
{
|
|
6663
|
-
description: "Indicates that
|
|
6932
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
6664
6933
|
properties: {
|
|
6665
6934
|
created_at: {
|
|
6666
6935
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6685,7 +6954,7 @@ var openapi_default = {
|
|
|
6685
6954
|
type: "object"
|
|
6686
6955
|
},
|
|
6687
6956
|
{
|
|
6688
|
-
description: "An unknown issue occurred while syncing the state of
|
|
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.",
|
|
6689
6958
|
properties: {
|
|
6690
6959
|
created_at: {
|
|
6691
6960
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6712,7 +6981,7 @@ var openapi_default = {
|
|
|
6712
6981
|
type: "object"
|
|
6713
6982
|
},
|
|
6714
6983
|
{
|
|
6715
|
-
description: "Access permissions for
|
|
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.",
|
|
6716
6985
|
properties: {
|
|
6717
6986
|
created_at: {
|
|
6718
6987
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -6741,7 +7010,7 @@ var openapi_default = {
|
|
|
6741
7010
|
type: "array"
|
|
6742
7011
|
},
|
|
6743
7012
|
workspace_id: {
|
|
6744
|
-
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).",
|
|
6745
7014
|
format: "uuid",
|
|
6746
7015
|
type: "string"
|
|
6747
7016
|
}
|
|
@@ -6890,18 +7159,18 @@ var openapi_default = {
|
|
|
6890
7159
|
action_type: { enum: ["ENCODE_CREDENTIAL"], type: "string" },
|
|
6891
7160
|
error: { nullable: true },
|
|
6892
7161
|
result: {
|
|
6893
|
-
description: "Means by which
|
|
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.",
|
|
6894
7163
|
oneOf: [
|
|
6895
7164
|
{
|
|
6896
|
-
description: "Means by which
|
|
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.",
|
|
6897
7166
|
properties: {
|
|
6898
7167
|
access_method: {
|
|
6899
|
-
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`.",
|
|
6900
7169
|
enum: ["code", "card", "mobile_key"],
|
|
6901
7170
|
type: "string"
|
|
6902
7171
|
},
|
|
6903
7172
|
acs_credential_id: {
|
|
6904
|
-
description: "ID of the credential.",
|
|
7173
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6905
7174
|
format: "uuid",
|
|
6906
7175
|
type: "string"
|
|
6907
7176
|
},
|
|
@@ -6910,17 +7179,17 @@ var openapi_default = {
|
|
|
6910
7179
|
type: "string"
|
|
6911
7180
|
},
|
|
6912
7181
|
acs_system_id: {
|
|
6913
|
-
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).",
|
|
6914
7183
|
format: "uuid",
|
|
6915
7184
|
type: "string"
|
|
6916
7185
|
},
|
|
6917
7186
|
acs_user_id: {
|
|
6918
|
-
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.",
|
|
6919
7188
|
format: "uuid",
|
|
6920
7189
|
type: "string"
|
|
6921
7190
|
},
|
|
6922
7191
|
assa_abloy_vostio_metadata: {
|
|
6923
|
-
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).",
|
|
6924
7193
|
properties: {
|
|
6925
7194
|
door_names: {
|
|
6926
7195
|
items: { type: "string" },
|
|
@@ -6936,28 +7205,32 @@ var openapi_default = {
|
|
|
6936
7205
|
},
|
|
6937
7206
|
type: "object"
|
|
6938
7207
|
},
|
|
6939
|
-
card_number: {
|
|
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
|
+
},
|
|
6940
7213
|
code: {
|
|
6941
|
-
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).",
|
|
6942
7215
|
nullable: true,
|
|
6943
7216
|
type: "string"
|
|
6944
7217
|
},
|
|
6945
7218
|
created_at: {
|
|
6946
|
-
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.",
|
|
6947
7220
|
format: "date-time",
|
|
6948
7221
|
type: "string"
|
|
6949
7222
|
},
|
|
6950
7223
|
display_name: {
|
|
6951
|
-
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.",
|
|
6952
7225
|
minLength: 1,
|
|
6953
7226
|
type: "string"
|
|
6954
7227
|
},
|
|
6955
7228
|
ends_at: {
|
|
6956
|
-
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`.",
|
|
6957
7230
|
type: "string"
|
|
6958
7231
|
},
|
|
6959
7232
|
errors: {
|
|
6960
|
-
description: "Errors associated with the
|
|
7233
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
6961
7234
|
items: {
|
|
6962
7235
|
properties: {
|
|
6963
7236
|
error_code: { type: "string" },
|
|
@@ -6969,7 +7242,7 @@ var openapi_default = {
|
|
|
6969
7242
|
type: "array"
|
|
6970
7243
|
},
|
|
6971
7244
|
external_type: {
|
|
6972
|
-
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`.",
|
|
6973
7246
|
enum: [
|
|
6974
7247
|
"pti_card",
|
|
6975
7248
|
"brivo_credential",
|
|
@@ -6982,46 +7255,50 @@ var openapi_default = {
|
|
|
6982
7255
|
type: "string"
|
|
6983
7256
|
},
|
|
6984
7257
|
external_type_display_name: {
|
|
6985
|
-
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.",
|
|
6986
7259
|
type: "string"
|
|
6987
7260
|
},
|
|
6988
|
-
is_issued: {
|
|
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
|
+
},
|
|
6989
7265
|
is_latest_desired_state_synced_with_provider: {
|
|
6990
|
-
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.",
|
|
6991
7267
|
nullable: true,
|
|
6992
7268
|
type: "boolean"
|
|
6993
7269
|
},
|
|
6994
7270
|
is_managed: { enum: [true], type: "boolean" },
|
|
6995
7271
|
is_multi_phone_sync_credential: {
|
|
6996
|
-
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).",
|
|
6997
7273
|
type: "boolean"
|
|
6998
7274
|
},
|
|
6999
7275
|
is_one_time_use: {
|
|
7000
|
-
description:
|
|
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.",
|
|
7001
7277
|
type: "boolean"
|
|
7002
7278
|
},
|
|
7003
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.",
|
|
7004
7281
|
format: "date-time",
|
|
7005
7282
|
nullable: true,
|
|
7006
7283
|
type: "string"
|
|
7007
7284
|
},
|
|
7008
7285
|
latest_desired_state_synced_with_provider_at: {
|
|
7009
|
-
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.",
|
|
7010
7287
|
format: "date-time",
|
|
7011
7288
|
nullable: true,
|
|
7012
7289
|
type: "string"
|
|
7013
7290
|
},
|
|
7014
7291
|
parent_acs_credential_id: {
|
|
7015
|
-
description: "ID of the parent credential.",
|
|
7292
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7016
7293
|
format: "uuid",
|
|
7017
7294
|
type: "string"
|
|
7018
7295
|
},
|
|
7019
7296
|
starts_at: {
|
|
7020
|
-
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.",
|
|
7021
7298
|
type: "string"
|
|
7022
7299
|
},
|
|
7023
7300
|
visionline_metadata: {
|
|
7024
|
-
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).",
|
|
7025
7302
|
properties: {
|
|
7026
7303
|
auto_join: { type: "boolean" },
|
|
7027
7304
|
card_function_type: {
|
|
@@ -7048,13 +7325,13 @@ var openapi_default = {
|
|
|
7048
7325
|
type: "object"
|
|
7049
7326
|
},
|
|
7050
7327
|
warnings: {
|
|
7051
|
-
description: "Warnings associated with the
|
|
7328
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7052
7329
|
items: {
|
|
7053
|
-
description: "Warning associated with the
|
|
7330
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7054
7331
|
discriminator: { propertyName: "warning_code" },
|
|
7055
7332
|
oneOf: [
|
|
7056
7333
|
{
|
|
7057
|
-
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.",
|
|
7058
7335
|
properties: {
|
|
7059
7336
|
created_at: {
|
|
7060
7337
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7079,7 +7356,7 @@ var openapi_default = {
|
|
|
7079
7356
|
type: "object"
|
|
7080
7357
|
},
|
|
7081
7358
|
{
|
|
7082
|
-
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.",
|
|
7083
7360
|
properties: {
|
|
7084
7361
|
created_at: {
|
|
7085
7362
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7104,7 +7381,7 @@ var openapi_default = {
|
|
|
7104
7381
|
type: "object"
|
|
7105
7382
|
},
|
|
7106
7383
|
{
|
|
7107
|
-
description: "Indicates that the schedule of
|
|
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.",
|
|
7108
7385
|
properties: {
|
|
7109
7386
|
created_at: {
|
|
7110
7387
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7129,7 +7406,7 @@ var openapi_default = {
|
|
|
7129
7406
|
type: "object"
|
|
7130
7407
|
},
|
|
7131
7408
|
{
|
|
7132
|
-
description: "Indicates that
|
|
7409
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
7133
7410
|
properties: {
|
|
7134
7411
|
created_at: {
|
|
7135
7412
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7154,7 +7431,7 @@ var openapi_default = {
|
|
|
7154
7431
|
type: "object"
|
|
7155
7432
|
},
|
|
7156
7433
|
{
|
|
7157
|
-
description: "An unknown issue occurred while syncing the state of
|
|
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.",
|
|
7158
7435
|
properties: {
|
|
7159
7436
|
created_at: {
|
|
7160
7437
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7179,7 +7456,7 @@ var openapi_default = {
|
|
|
7179
7456
|
type: "object"
|
|
7180
7457
|
},
|
|
7181
7458
|
{
|
|
7182
|
-
description: "Access permissions for
|
|
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.",
|
|
7183
7460
|
properties: {
|
|
7184
7461
|
created_at: {
|
|
7185
7462
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7208,7 +7485,7 @@ var openapi_default = {
|
|
|
7208
7485
|
type: "array"
|
|
7209
7486
|
},
|
|
7210
7487
|
workspace_id: {
|
|
7211
|
-
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).",
|
|
7212
7489
|
format: "uuid",
|
|
7213
7490
|
type: "string"
|
|
7214
7491
|
}
|
|
@@ -7228,15 +7505,15 @@ var openapi_default = {
|
|
|
7228
7505
|
"x-route-path": "/acs/credentials"
|
|
7229
7506
|
},
|
|
7230
7507
|
{
|
|
7231
|
-
description: "Means by which
|
|
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.",
|
|
7232
7509
|
properties: {
|
|
7233
7510
|
access_method: {
|
|
7234
|
-
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`.",
|
|
7235
7512
|
enum: ["code", "card", "mobile_key"],
|
|
7236
7513
|
type: "string"
|
|
7237
7514
|
},
|
|
7238
7515
|
acs_credential_id: {
|
|
7239
|
-
description: "ID of the credential.",
|
|
7516
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7240
7517
|
format: "uuid",
|
|
7241
7518
|
type: "string"
|
|
7242
7519
|
},
|
|
@@ -7245,17 +7522,17 @@ var openapi_default = {
|
|
|
7245
7522
|
type: "string"
|
|
7246
7523
|
},
|
|
7247
7524
|
acs_system_id: {
|
|
7248
|
-
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).",
|
|
7249
7526
|
format: "uuid",
|
|
7250
7527
|
type: "string"
|
|
7251
7528
|
},
|
|
7252
7529
|
acs_user_id: {
|
|
7253
|
-
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.",
|
|
7254
7531
|
format: "uuid",
|
|
7255
7532
|
type: "string"
|
|
7256
7533
|
},
|
|
7257
7534
|
assa_abloy_vostio_metadata: {
|
|
7258
|
-
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).",
|
|
7259
7536
|
properties: {
|
|
7260
7537
|
door_names: {
|
|
7261
7538
|
items: { type: "string" },
|
|
@@ -7271,28 +7548,32 @@ var openapi_default = {
|
|
|
7271
7548
|
},
|
|
7272
7549
|
type: "object"
|
|
7273
7550
|
},
|
|
7274
|
-
card_number: {
|
|
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
|
+
},
|
|
7275
7556
|
code: {
|
|
7276
|
-
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).",
|
|
7277
7558
|
nullable: true,
|
|
7278
7559
|
type: "string"
|
|
7279
7560
|
},
|
|
7280
7561
|
created_at: {
|
|
7281
|
-
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.",
|
|
7282
7563
|
format: "date-time",
|
|
7283
7564
|
type: "string"
|
|
7284
7565
|
},
|
|
7285
7566
|
display_name: {
|
|
7286
|
-
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.",
|
|
7287
7568
|
minLength: 1,
|
|
7288
7569
|
type: "string"
|
|
7289
7570
|
},
|
|
7290
7571
|
ends_at: {
|
|
7291
|
-
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`.",
|
|
7292
7573
|
type: "string"
|
|
7293
7574
|
},
|
|
7294
7575
|
errors: {
|
|
7295
|
-
description: "Errors associated with the
|
|
7576
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7296
7577
|
items: {
|
|
7297
7578
|
properties: {
|
|
7298
7579
|
error_code: { type: "string" },
|
|
@@ -7304,7 +7585,7 @@ var openapi_default = {
|
|
|
7304
7585
|
type: "array"
|
|
7305
7586
|
},
|
|
7306
7587
|
external_type: {
|
|
7307
|
-
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`.",
|
|
7308
7589
|
enum: [
|
|
7309
7590
|
"pti_card",
|
|
7310
7591
|
"brivo_credential",
|
|
@@ -7317,46 +7598,50 @@ var openapi_default = {
|
|
|
7317
7598
|
type: "string"
|
|
7318
7599
|
},
|
|
7319
7600
|
external_type_display_name: {
|
|
7320
|
-
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.",
|
|
7321
7602
|
type: "string"
|
|
7322
7603
|
},
|
|
7323
|
-
is_issued: {
|
|
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
|
+
},
|
|
7324
7608
|
is_latest_desired_state_synced_with_provider: {
|
|
7325
|
-
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.",
|
|
7326
7610
|
nullable: true,
|
|
7327
7611
|
type: "boolean"
|
|
7328
7612
|
},
|
|
7329
7613
|
is_managed: { enum: [false], type: "boolean" },
|
|
7330
7614
|
is_multi_phone_sync_credential: {
|
|
7331
|
-
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).",
|
|
7332
7616
|
type: "boolean"
|
|
7333
7617
|
},
|
|
7334
7618
|
is_one_time_use: {
|
|
7335
|
-
description:
|
|
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.",
|
|
7336
7620
|
type: "boolean"
|
|
7337
7621
|
},
|
|
7338
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.",
|
|
7339
7624
|
format: "date-time",
|
|
7340
7625
|
nullable: true,
|
|
7341
7626
|
type: "string"
|
|
7342
7627
|
},
|
|
7343
7628
|
latest_desired_state_synced_with_provider_at: {
|
|
7344
|
-
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.",
|
|
7345
7630
|
format: "date-time",
|
|
7346
7631
|
nullable: true,
|
|
7347
7632
|
type: "string"
|
|
7348
7633
|
},
|
|
7349
7634
|
parent_acs_credential_id: {
|
|
7350
|
-
description: "ID of the parent credential.",
|
|
7635
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7351
7636
|
format: "uuid",
|
|
7352
7637
|
type: "string"
|
|
7353
7638
|
},
|
|
7354
7639
|
starts_at: {
|
|
7355
|
-
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.",
|
|
7356
7641
|
type: "string"
|
|
7357
7642
|
},
|
|
7358
7643
|
visionline_metadata: {
|
|
7359
|
-
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).",
|
|
7360
7645
|
properties: {
|
|
7361
7646
|
auto_join: { type: "boolean" },
|
|
7362
7647
|
card_function_type: {
|
|
@@ -7383,13 +7668,13 @@ var openapi_default = {
|
|
|
7383
7668
|
type: "object"
|
|
7384
7669
|
},
|
|
7385
7670
|
warnings: {
|
|
7386
|
-
description: "Warnings associated with the
|
|
7671
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7387
7672
|
items: {
|
|
7388
|
-
description: "Warning associated with the
|
|
7673
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
7389
7674
|
discriminator: { propertyName: "warning_code" },
|
|
7390
7675
|
oneOf: [
|
|
7391
7676
|
{
|
|
7392
|
-
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.",
|
|
7393
7678
|
properties: {
|
|
7394
7679
|
created_at: {
|
|
7395
7680
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7414,7 +7699,7 @@ var openapi_default = {
|
|
|
7414
7699
|
type: "object"
|
|
7415
7700
|
},
|
|
7416
7701
|
{
|
|
7417
|
-
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.",
|
|
7418
7703
|
properties: {
|
|
7419
7704
|
created_at: {
|
|
7420
7705
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7439,7 +7724,7 @@ var openapi_default = {
|
|
|
7439
7724
|
type: "object"
|
|
7440
7725
|
},
|
|
7441
7726
|
{
|
|
7442
|
-
description: "Indicates that the schedule of
|
|
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.",
|
|
7443
7728
|
properties: {
|
|
7444
7729
|
created_at: {
|
|
7445
7730
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7464,7 +7749,7 @@ var openapi_default = {
|
|
|
7464
7749
|
type: "object"
|
|
7465
7750
|
},
|
|
7466
7751
|
{
|
|
7467
|
-
description: "Indicates that
|
|
7752
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
7468
7753
|
properties: {
|
|
7469
7754
|
created_at: {
|
|
7470
7755
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7489,7 +7774,7 @@ var openapi_default = {
|
|
|
7489
7774
|
type: "object"
|
|
7490
7775
|
},
|
|
7491
7776
|
{
|
|
7492
|
-
description: "An unknown issue occurred while syncing the state of
|
|
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.",
|
|
7493
7778
|
properties: {
|
|
7494
7779
|
created_at: {
|
|
7495
7780
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7514,7 +7799,7 @@ var openapi_default = {
|
|
|
7514
7799
|
type: "object"
|
|
7515
7800
|
},
|
|
7516
7801
|
{
|
|
7517
|
-
description: "Access permissions for
|
|
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.",
|
|
7518
7803
|
properties: {
|
|
7519
7804
|
created_at: {
|
|
7520
7805
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -7543,7 +7828,7 @@ var openapi_default = {
|
|
|
7543
7828
|
type: "array"
|
|
7544
7829
|
},
|
|
7545
7830
|
workspace_id: {
|
|
7546
|
-
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).",
|
|
7547
7832
|
format: "uuid",
|
|
7548
7833
|
type: "string"
|
|
7549
7834
|
}
|
|
@@ -10107,30 +10392,36 @@ var openapi_default = {
|
|
|
10107
10392
|
nullable: true,
|
|
10108
10393
|
properties: {
|
|
10109
10394
|
climate_preset_key: {
|
|
10110
|
-
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).",
|
|
10111
10396
|
type: "string"
|
|
10112
10397
|
},
|
|
10113
10398
|
created_at: {
|
|
10114
|
-
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.",
|
|
10115
10400
|
format: "date-time",
|
|
10116
10401
|
type: "string"
|
|
10117
10402
|
},
|
|
10118
10403
|
device_id: {
|
|
10119
|
-
description: "ID of the desired thermostat device.",
|
|
10404
|
+
description: "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.",
|
|
10120
10405
|
format: "uuid",
|
|
10121
10406
|
type: "string"
|
|
10122
10407
|
},
|
|
10123
10408
|
ends_at: {
|
|
10124
|
-
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.",
|
|
10125
10410
|
format: "date-time",
|
|
10126
10411
|
type: "string"
|
|
10127
10412
|
},
|
|
10128
10413
|
errors: {
|
|
10129
|
-
description: "
|
|
10414
|
+
description: "Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
|
|
10130
10415
|
items: {
|
|
10131
10416
|
properties: {
|
|
10132
|
-
error_code: {
|
|
10133
|
-
|
|
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
|
+
}
|
|
10134
10425
|
},
|
|
10135
10426
|
required: ["error_code", "message"],
|
|
10136
10427
|
type: "object"
|
|
@@ -10138,26 +10429,26 @@ var openapi_default = {
|
|
|
10138
10429
|
type: "array"
|
|
10139
10430
|
},
|
|
10140
10431
|
max_override_period_minutes: {
|
|
10141
|
-
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).",
|
|
10142
10433
|
minimum: 0,
|
|
10143
10434
|
type: "integer"
|
|
10144
10435
|
},
|
|
10145
10436
|
name: {
|
|
10146
|
-
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).",
|
|
10147
10438
|
type: "string"
|
|
10148
10439
|
},
|
|
10149
10440
|
starts_at: {
|
|
10150
|
-
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.",
|
|
10151
10442
|
format: "date-time",
|
|
10152
10443
|
type: "string"
|
|
10153
10444
|
},
|
|
10154
10445
|
thermostat_schedule_id: {
|
|
10155
|
-
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).",
|
|
10156
10447
|
format: "uuid",
|
|
10157
10448
|
type: "string"
|
|
10158
10449
|
},
|
|
10159
10450
|
unstable_is_override_allowed: {
|
|
10160
|
-
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.",
|
|
10161
10452
|
type: "boolean",
|
|
10162
10453
|
"x-undocumented": "Unstable"
|
|
10163
10454
|
}
|
|
@@ -10179,15 +10470,15 @@ var openapi_default = {
|
|
|
10179
10470
|
items: {
|
|
10180
10471
|
properties: {
|
|
10181
10472
|
can_delete: {
|
|
10182
|
-
description: "Indicates whether
|
|
10473
|
+
description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.",
|
|
10183
10474
|
type: "boolean"
|
|
10184
10475
|
},
|
|
10185
10476
|
can_edit: {
|
|
10186
|
-
description: "Indicates whether
|
|
10477
|
+
description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.",
|
|
10187
10478
|
type: "boolean"
|
|
10188
10479
|
},
|
|
10189
10480
|
climate_preset_key: {
|
|
10190
|
-
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).",
|
|
10191
10482
|
type: "string"
|
|
10192
10483
|
},
|
|
10193
10484
|
cooling_set_point_celsius: {
|
|
@@ -10196,26 +10487,26 @@ var openapi_default = {
|
|
|
10196
10487
|
type: "number"
|
|
10197
10488
|
},
|
|
10198
10489
|
cooling_set_point_fahrenheit: {
|
|
10199
|
-
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).",
|
|
10200
10491
|
format: "float",
|
|
10201
10492
|
type: "number"
|
|
10202
10493
|
},
|
|
10203
10494
|
display_name: {
|
|
10204
|
-
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).",
|
|
10205
10496
|
type: "string"
|
|
10206
10497
|
},
|
|
10207
10498
|
fan_mode_setting: {
|
|
10208
|
-
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`.",
|
|
10209
10500
|
enum: ["auto", "on", "circulate"],
|
|
10210
10501
|
type: "string"
|
|
10211
10502
|
},
|
|
10212
10503
|
heating_set_point_celsius: {
|
|
10213
|
-
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).",
|
|
10214
10505
|
format: "float",
|
|
10215
10506
|
type: "number"
|
|
10216
10507
|
},
|
|
10217
10508
|
heating_set_point_fahrenheit: {
|
|
10218
|
-
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).",
|
|
10219
10510
|
format: "float",
|
|
10220
10511
|
type: "number"
|
|
10221
10512
|
},
|
|
@@ -10226,13 +10517,13 @@ var openapi_default = {
|
|
|
10226
10517
|
},
|
|
10227
10518
|
manual_override_allowed: {
|
|
10228
10519
|
deprecated: true,
|
|
10229
|
-
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).",
|
|
10230
10521
|
type: "boolean",
|
|
10231
10522
|
"x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
|
|
10232
10523
|
},
|
|
10233
10524
|
name: {
|
|
10234
10525
|
default: null,
|
|
10235
|
-
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).",
|
|
10236
10527
|
nullable: true,
|
|
10237
10528
|
type: "string"
|
|
10238
10529
|
}
|
|
@@ -10265,15 +10556,15 @@ var openapi_default = {
|
|
|
10265
10556
|
current_climate_setting: {
|
|
10266
10557
|
properties: {
|
|
10267
10558
|
can_delete: {
|
|
10268
|
-
description: "Indicates whether
|
|
10559
|
+
description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.",
|
|
10269
10560
|
type: "boolean"
|
|
10270
10561
|
},
|
|
10271
10562
|
can_edit: {
|
|
10272
|
-
description: "Indicates whether
|
|
10563
|
+
description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.",
|
|
10273
10564
|
type: "boolean"
|
|
10274
10565
|
},
|
|
10275
10566
|
climate_preset_key: {
|
|
10276
|
-
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).",
|
|
10277
10568
|
type: "string"
|
|
10278
10569
|
},
|
|
10279
10570
|
cooling_set_point_celsius: {
|
|
@@ -10282,26 +10573,26 @@ var openapi_default = {
|
|
|
10282
10573
|
type: "number"
|
|
10283
10574
|
},
|
|
10284
10575
|
cooling_set_point_fahrenheit: {
|
|
10285
|
-
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).",
|
|
10286
10577
|
format: "float",
|
|
10287
10578
|
type: "number"
|
|
10288
10579
|
},
|
|
10289
10580
|
display_name: {
|
|
10290
|
-
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).",
|
|
10291
10582
|
type: "string"
|
|
10292
10583
|
},
|
|
10293
10584
|
fan_mode_setting: {
|
|
10294
|
-
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`.",
|
|
10295
10586
|
enum: ["auto", "on", "circulate"],
|
|
10296
10587
|
type: "string"
|
|
10297
10588
|
},
|
|
10298
10589
|
heating_set_point_celsius: {
|
|
10299
|
-
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).",
|
|
10300
10591
|
format: "float",
|
|
10301
10592
|
type: "number"
|
|
10302
10593
|
},
|
|
10303
10594
|
heating_set_point_fahrenheit: {
|
|
10304
|
-
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).",
|
|
10305
10596
|
format: "float",
|
|
10306
10597
|
type: "number"
|
|
10307
10598
|
},
|
|
@@ -10312,13 +10603,13 @@ var openapi_default = {
|
|
|
10312
10603
|
},
|
|
10313
10604
|
manual_override_allowed: {
|
|
10314
10605
|
deprecated: true,
|
|
10315
|
-
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).",
|
|
10316
10607
|
type: "boolean",
|
|
10317
10608
|
"x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
|
|
10318
10609
|
},
|
|
10319
10610
|
name: {
|
|
10320
10611
|
default: null,
|
|
10321
|
-
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).",
|
|
10322
10613
|
nullable: true,
|
|
10323
10614
|
type: "string"
|
|
10324
10615
|
}
|
|
@@ -10329,15 +10620,15 @@ var openapi_default = {
|
|
|
10329
10620
|
deprecated: true,
|
|
10330
10621
|
properties: {
|
|
10331
10622
|
can_delete: {
|
|
10332
|
-
description: "Indicates whether
|
|
10623
|
+
description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.",
|
|
10333
10624
|
type: "boolean"
|
|
10334
10625
|
},
|
|
10335
10626
|
can_edit: {
|
|
10336
|
-
description: "Indicates whether
|
|
10627
|
+
description: "Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.",
|
|
10337
10628
|
type: "boolean"
|
|
10338
10629
|
},
|
|
10339
10630
|
climate_preset_key: {
|
|
10340
|
-
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).",
|
|
10341
10632
|
type: "string"
|
|
10342
10633
|
},
|
|
10343
10634
|
cooling_set_point_celsius: {
|
|
@@ -10346,26 +10637,26 @@ var openapi_default = {
|
|
|
10346
10637
|
type: "number"
|
|
10347
10638
|
},
|
|
10348
10639
|
cooling_set_point_fahrenheit: {
|
|
10349
|
-
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).",
|
|
10350
10641
|
format: "float",
|
|
10351
10642
|
type: "number"
|
|
10352
10643
|
},
|
|
10353
10644
|
display_name: {
|
|
10354
|
-
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).",
|
|
10355
10646
|
type: "string"
|
|
10356
10647
|
},
|
|
10357
10648
|
fan_mode_setting: {
|
|
10358
|
-
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`.",
|
|
10359
10650
|
enum: ["auto", "on", "circulate"],
|
|
10360
10651
|
type: "string"
|
|
10361
10652
|
},
|
|
10362
10653
|
heating_set_point_celsius: {
|
|
10363
|
-
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).",
|
|
10364
10655
|
format: "float",
|
|
10365
10656
|
type: "number"
|
|
10366
10657
|
},
|
|
10367
10658
|
heating_set_point_fahrenheit: {
|
|
10368
|
-
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).",
|
|
10369
10660
|
format: "float",
|
|
10370
10661
|
type: "number"
|
|
10371
10662
|
},
|
|
@@ -10376,13 +10667,13 @@ var openapi_default = {
|
|
|
10376
10667
|
},
|
|
10377
10668
|
manual_override_allowed: {
|
|
10378
10669
|
deprecated: true,
|
|
10379
|
-
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).",
|
|
10380
10671
|
type: "boolean",
|
|
10381
10672
|
"x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
|
|
10382
10673
|
},
|
|
10383
10674
|
name: {
|
|
10384
10675
|
default: null,
|
|
10385
|
-
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).",
|
|
10386
10677
|
nullable: true,
|
|
10387
10678
|
type: "string"
|
|
10388
10679
|
}
|
|
@@ -14429,7 +14720,7 @@ var openapi_default = {
|
|
|
14429
14720
|
type: "number"
|
|
14430
14721
|
},
|
|
14431
14722
|
cooling_set_point_fahrenheit: {
|
|
14432
|
-
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).",
|
|
14433
14724
|
format: "float",
|
|
14434
14725
|
type: "number"
|
|
14435
14726
|
},
|
|
@@ -14453,17 +14744,17 @@ var openapi_default = {
|
|
|
14453
14744
|
type: "string"
|
|
14454
14745
|
},
|
|
14455
14746
|
fan_mode_setting: {
|
|
14456
|
-
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`.",
|
|
14457
14748
|
enum: ["auto", "on", "circulate"],
|
|
14458
14749
|
type: "string"
|
|
14459
14750
|
},
|
|
14460
14751
|
heating_set_point_celsius: {
|
|
14461
|
-
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).",
|
|
14462
14753
|
format: "float",
|
|
14463
14754
|
type: "number"
|
|
14464
14755
|
},
|
|
14465
14756
|
heating_set_point_fahrenheit: {
|
|
14466
|
-
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).",
|
|
14467
14758
|
format: "float",
|
|
14468
14759
|
type: "number"
|
|
14469
14760
|
},
|
|
@@ -15136,30 +15427,36 @@ var openapi_default = {
|
|
|
15136
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.",
|
|
15137
15428
|
properties: {
|
|
15138
15429
|
climate_preset_key: {
|
|
15139
|
-
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).",
|
|
15140
15431
|
type: "string"
|
|
15141
15432
|
},
|
|
15142
15433
|
created_at: {
|
|
15143
|
-
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.",
|
|
15144
15435
|
format: "date-time",
|
|
15145
15436
|
type: "string"
|
|
15146
15437
|
},
|
|
15147
15438
|
device_id: {
|
|
15148
|
-
description: "ID of the desired thermostat device.",
|
|
15439
|
+
description: "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.",
|
|
15149
15440
|
format: "uuid",
|
|
15150
15441
|
type: "string"
|
|
15151
15442
|
},
|
|
15152
15443
|
ends_at: {
|
|
15153
|
-
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.",
|
|
15154
15445
|
format: "date-time",
|
|
15155
15446
|
type: "string"
|
|
15156
15447
|
},
|
|
15157
15448
|
errors: {
|
|
15158
|
-
description: "
|
|
15449
|
+
description: "Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
|
|
15159
15450
|
items: {
|
|
15160
15451
|
properties: {
|
|
15161
|
-
error_code: {
|
|
15162
|
-
|
|
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
|
+
}
|
|
15163
15460
|
},
|
|
15164
15461
|
required: ["error_code", "message"],
|
|
15165
15462
|
type: "object"
|
|
@@ -15167,26 +15464,26 @@ var openapi_default = {
|
|
|
15167
15464
|
type: "array"
|
|
15168
15465
|
},
|
|
15169
15466
|
max_override_period_minutes: {
|
|
15170
|
-
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).",
|
|
15171
15468
|
minimum: 0,
|
|
15172
15469
|
type: "integer"
|
|
15173
15470
|
},
|
|
15174
15471
|
name: {
|
|
15175
|
-
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).",
|
|
15176
15473
|
type: "string"
|
|
15177
15474
|
},
|
|
15178
15475
|
starts_at: {
|
|
15179
|
-
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.",
|
|
15180
15477
|
format: "date-time",
|
|
15181
15478
|
type: "string"
|
|
15182
15479
|
},
|
|
15183
15480
|
thermostat_schedule_id: {
|
|
15184
|
-
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).",
|
|
15185
15482
|
format: "uuid",
|
|
15186
15483
|
type: "string"
|
|
15187
15484
|
},
|
|
15188
15485
|
unstable_is_override_allowed: {
|
|
15189
|
-
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.",
|
|
15190
15487
|
type: "boolean",
|
|
15191
15488
|
"x-undocumented": "Unstable"
|
|
15192
15489
|
}
|
|
@@ -16093,31 +16390,31 @@ var openapi_default = {
|
|
|
16093
16390
|
"x-route-path": "/acs/access_groups/unmanaged"
|
|
16094
16391
|
},
|
|
16095
16392
|
unmanaged_acs_credential: {
|
|
16096
|
-
description: "Means by which
|
|
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.",
|
|
16097
16394
|
properties: {
|
|
16098
16395
|
access_method: {
|
|
16099
|
-
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`.",
|
|
16100
16397
|
enum: ["code", "card", "mobile_key"],
|
|
16101
16398
|
type: "string"
|
|
16102
16399
|
},
|
|
16103
16400
|
acs_credential_id: {
|
|
16104
|
-
description: "ID of the credential.",
|
|
16401
|
+
description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
16105
16402
|
format: "uuid",
|
|
16106
16403
|
type: "string"
|
|
16107
16404
|
},
|
|
16108
16405
|
acs_credential_pool_id: { format: "uuid", type: "string" },
|
|
16109
16406
|
acs_system_id: {
|
|
16110
|
-
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).",
|
|
16111
16408
|
format: "uuid",
|
|
16112
16409
|
type: "string"
|
|
16113
16410
|
},
|
|
16114
16411
|
acs_user_id: {
|
|
16115
|
-
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.",
|
|
16116
16413
|
format: "uuid",
|
|
16117
16414
|
type: "string"
|
|
16118
16415
|
},
|
|
16119
16416
|
assa_abloy_vostio_metadata: {
|
|
16120
|
-
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).",
|
|
16121
16418
|
properties: {
|
|
16122
16419
|
door_names: { items: { type: "string" }, type: "array" },
|
|
16123
16420
|
endpoint_id: { type: "string" },
|
|
@@ -16130,28 +16427,32 @@ var openapi_default = {
|
|
|
16130
16427
|
},
|
|
16131
16428
|
type: "object"
|
|
16132
16429
|
},
|
|
16133
|
-
card_number: {
|
|
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
|
+
},
|
|
16134
16435
|
code: {
|
|
16135
|
-
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).",
|
|
16136
16437
|
nullable: true,
|
|
16137
16438
|
type: "string"
|
|
16138
16439
|
},
|
|
16139
16440
|
created_at: {
|
|
16140
|
-
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.",
|
|
16141
16442
|
format: "date-time",
|
|
16142
16443
|
type: "string"
|
|
16143
16444
|
},
|
|
16144
16445
|
display_name: {
|
|
16145
|
-
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.",
|
|
16146
16447
|
minLength: 1,
|
|
16147
16448
|
type: "string"
|
|
16148
16449
|
},
|
|
16149
16450
|
ends_at: {
|
|
16150
|
-
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`.",
|
|
16151
16452
|
type: "string"
|
|
16152
16453
|
},
|
|
16153
16454
|
errors: {
|
|
16154
|
-
description: "Errors associated with the
|
|
16455
|
+
description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
16155
16456
|
items: {
|
|
16156
16457
|
properties: {
|
|
16157
16458
|
error_code: { type: "string" },
|
|
@@ -16163,7 +16464,7 @@ var openapi_default = {
|
|
|
16163
16464
|
type: "array"
|
|
16164
16465
|
},
|
|
16165
16466
|
external_type: {
|
|
16166
|
-
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`.",
|
|
16167
16468
|
enum: [
|
|
16168
16469
|
"pti_card",
|
|
16169
16470
|
"brivo_credential",
|
|
@@ -16176,42 +16477,50 @@ var openapi_default = {
|
|
|
16176
16477
|
type: "string"
|
|
16177
16478
|
},
|
|
16178
16479
|
external_type_display_name: {
|
|
16179
|
-
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.",
|
|
16180
16481
|
type: "string"
|
|
16181
16482
|
},
|
|
16182
|
-
is_issued: {
|
|
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
|
+
},
|
|
16183
16487
|
is_latest_desired_state_synced_with_provider: {
|
|
16184
|
-
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.",
|
|
16185
16489
|
nullable: true,
|
|
16186
16490
|
type: "boolean"
|
|
16187
16491
|
},
|
|
16188
16492
|
is_managed: { enum: [false], type: "boolean" },
|
|
16189
16493
|
is_multi_phone_sync_credential: {
|
|
16190
|
-
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).",
|
|
16191
16495
|
type: "boolean"
|
|
16192
16496
|
},
|
|
16193
16497
|
is_one_time_use: {
|
|
16194
|
-
description:
|
|
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.",
|
|
16195
16499
|
type: "boolean"
|
|
16196
16500
|
},
|
|
16197
|
-
issued_at: {
|
|
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
|
+
},
|
|
16198
16507
|
latest_desired_state_synced_with_provider_at: {
|
|
16199
|
-
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.",
|
|
16200
16509
|
format: "date-time",
|
|
16201
16510
|
nullable: true,
|
|
16202
16511
|
type: "string"
|
|
16203
16512
|
},
|
|
16204
16513
|
parent_acs_credential_id: {
|
|
16205
|
-
description: "ID of the parent credential.",
|
|
16514
|
+
description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
16206
16515
|
format: "uuid",
|
|
16207
16516
|
type: "string"
|
|
16208
16517
|
},
|
|
16209
16518
|
starts_at: {
|
|
16210
|
-
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.",
|
|
16211
16520
|
type: "string"
|
|
16212
16521
|
},
|
|
16213
16522
|
visionline_metadata: {
|
|
16214
|
-
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).",
|
|
16215
16524
|
properties: {
|
|
16216
16525
|
auto_join: { type: "boolean" },
|
|
16217
16526
|
card_function_type: { enum: ["guest", "staff"], type: "string" },
|
|
@@ -16235,13 +16544,13 @@ var openapi_default = {
|
|
|
16235
16544
|
type: "object"
|
|
16236
16545
|
},
|
|
16237
16546
|
warnings: {
|
|
16238
|
-
description: "Warnings associated with the
|
|
16547
|
+
description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
16239
16548
|
items: {
|
|
16240
|
-
description: "Warning associated with the
|
|
16549
|
+
description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
16241
16550
|
discriminator: { propertyName: "warning_code" },
|
|
16242
16551
|
oneOf: [
|
|
16243
16552
|
{
|
|
16244
|
-
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.",
|
|
16245
16554
|
properties: {
|
|
16246
16555
|
created_at: {
|
|
16247
16556
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -16262,7 +16571,7 @@ var openapi_default = {
|
|
|
16262
16571
|
type: "object"
|
|
16263
16572
|
},
|
|
16264
16573
|
{
|
|
16265
|
-
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.",
|
|
16266
16575
|
properties: {
|
|
16267
16576
|
created_at: {
|
|
16268
16577
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -16283,7 +16592,7 @@ var openapi_default = {
|
|
|
16283
16592
|
type: "object"
|
|
16284
16593
|
},
|
|
16285
16594
|
{
|
|
16286
|
-
description: "Indicates that the schedule of
|
|
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.",
|
|
16287
16596
|
properties: {
|
|
16288
16597
|
created_at: {
|
|
16289
16598
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -16304,7 +16613,7 @@ var openapi_default = {
|
|
|
16304
16613
|
type: "object"
|
|
16305
16614
|
},
|
|
16306
16615
|
{
|
|
16307
|
-
description: "Indicates that
|
|
16616
|
+
description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
|
|
16308
16617
|
properties: {
|
|
16309
16618
|
created_at: {
|
|
16310
16619
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -16325,7 +16634,7 @@ var openapi_default = {
|
|
|
16325
16634
|
type: "object"
|
|
16326
16635
|
},
|
|
16327
16636
|
{
|
|
16328
|
-
description: "An unknown issue occurred while syncing the state of
|
|
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.",
|
|
16329
16638
|
properties: {
|
|
16330
16639
|
created_at: {
|
|
16331
16640
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -16346,7 +16655,7 @@ var openapi_default = {
|
|
|
16346
16655
|
type: "object"
|
|
16347
16656
|
},
|
|
16348
16657
|
{
|
|
16349
|
-
description: "Access permissions for
|
|
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.",
|
|
16350
16659
|
properties: {
|
|
16351
16660
|
created_at: {
|
|
16352
16661
|
description: "Date and time at which Seam created the warning.",
|
|
@@ -16371,7 +16680,7 @@ var openapi_default = {
|
|
|
16371
16680
|
type: "array"
|
|
16372
16681
|
},
|
|
16373
16682
|
workspace_id: {
|
|
16374
|
-
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).",
|
|
16375
16684
|
format: "uuid",
|
|
16376
16685
|
type: "string"
|
|
16377
16686
|
}
|
|
@@ -16394,7 +16703,7 @@ var openapi_default = {
|
|
|
16394
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).",
|
|
16395
16704
|
properties: {
|
|
16396
16705
|
access_schedule: {
|
|
16397
|
-
description: "`starts_at` and `ends_at` timestamps for the
|
|
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.",
|
|
16398
16707
|
properties: {
|
|
16399
16708
|
ends_at: {
|
|
16400
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.",
|
|
@@ -16412,22 +16721,22 @@ var openapi_default = {
|
|
|
16412
16721
|
type: "object"
|
|
16413
16722
|
},
|
|
16414
16723
|
acs_system_id: {
|
|
16415
|
-
description: "ID of the access control system that contains the
|
|
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).",
|
|
16416
16725
|
format: "uuid",
|
|
16417
16726
|
type: "string"
|
|
16418
16727
|
},
|
|
16419
16728
|
acs_user_id: {
|
|
16420
|
-
description: "ID of the
|
|
16729
|
+
description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16421
16730
|
format: "uuid",
|
|
16422
16731
|
type: "string"
|
|
16423
16732
|
},
|
|
16424
16733
|
created_at: {
|
|
16425
|
-
description: "Date and time at which the
|
|
16734
|
+
description: "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.",
|
|
16426
16735
|
format: "date-time",
|
|
16427
16736
|
type: "string"
|
|
16428
16737
|
},
|
|
16429
16738
|
display_name: {
|
|
16430
|
-
description: "Display name for the
|
|
16739
|
+
description: "Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16431
16740
|
type: "string"
|
|
16432
16741
|
},
|
|
16433
16742
|
email: {
|
|
@@ -16437,18 +16746,18 @@ var openapi_default = {
|
|
|
16437
16746
|
"x-deprecated": "use email_address."
|
|
16438
16747
|
},
|
|
16439
16748
|
email_address: {
|
|
16440
|
-
description: "Email address of the
|
|
16749
|
+
description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16441
16750
|
format: "email",
|
|
16442
16751
|
type: "string"
|
|
16443
16752
|
},
|
|
16444
16753
|
errors: {
|
|
16445
|
-
description: "Errors associated with the
|
|
16754
|
+
description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16446
16755
|
items: {
|
|
16447
|
-
description: "
|
|
16756
|
+
description: "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16448
16757
|
discriminator: { propertyName: "error_code" },
|
|
16449
16758
|
oneOf: [
|
|
16450
16759
|
{
|
|
16451
|
-
description: "Indicates that the ACS user was deleted from the
|
|
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.",
|
|
16452
16761
|
properties: {
|
|
16453
16762
|
created_at: {
|
|
16454
16763
|
description: "Date and time at which Seam created the error.",
|
|
@@ -16468,7 +16777,7 @@ var openapi_default = {
|
|
|
16468
16777
|
type: "object"
|
|
16469
16778
|
},
|
|
16470
16779
|
{
|
|
16471
|
-
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.",
|
|
16472
16781
|
properties: {
|
|
16473
16782
|
created_at: {
|
|
16474
16783
|
description: "Date and time at which Seam created the error.",
|
|
@@ -16488,7 +16797,7 @@ var openapi_default = {
|
|
|
16488
16797
|
type: "object"
|
|
16489
16798
|
},
|
|
16490
16799
|
{
|
|
16491
|
-
description: "Indicates that the user was not created on the
|
|
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).",
|
|
16492
16801
|
properties: {
|
|
16493
16802
|
created_at: {
|
|
16494
16803
|
description: "Date and time at which Seam created the error.",
|
|
@@ -16508,7 +16817,7 @@ var openapi_default = {
|
|
|
16508
16817
|
type: "object"
|
|
16509
16818
|
},
|
|
16510
16819
|
{
|
|
16511
|
-
description: "Indicates that the user was not updated on the
|
|
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).",
|
|
16512
16821
|
properties: {
|
|
16513
16822
|
created_at: {
|
|
16514
16823
|
description: "Date and time at which Seam created the error.",
|
|
@@ -16528,7 +16837,7 @@ var openapi_default = {
|
|
|
16528
16837
|
type: "object"
|
|
16529
16838
|
},
|
|
16530
16839
|
{
|
|
16531
|
-
description: "Indicates that the user was not deleted on the
|
|
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).",
|
|
16532
16841
|
properties: {
|
|
16533
16842
|
created_at: {
|
|
16534
16843
|
description: "Date and time at which Seam created the error.",
|
|
@@ -16552,7 +16861,7 @@ var openapi_default = {
|
|
|
16552
16861
|
type: "array"
|
|
16553
16862
|
},
|
|
16554
16863
|
external_type: {
|
|
16555
|
-
description: "Brand-specific terminology for the
|
|
16864
|
+
description: "Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.",
|
|
16556
16865
|
enum: [
|
|
16557
16866
|
"pti_user",
|
|
16558
16867
|
"brivo_user",
|
|
@@ -16565,11 +16874,11 @@ var openapi_default = {
|
|
|
16565
16874
|
type: "string"
|
|
16566
16875
|
},
|
|
16567
16876
|
external_type_display_name: {
|
|
16568
|
-
description: "Display name that corresponds to the brand-specific terminology for the
|
|
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.",
|
|
16569
16878
|
type: "string"
|
|
16570
16879
|
},
|
|
16571
16880
|
full_name: {
|
|
16572
|
-
description: "Full name of the
|
|
16881
|
+
description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16573
16882
|
type: "string"
|
|
16574
16883
|
},
|
|
16575
16884
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
@@ -16580,7 +16889,7 @@ var openapi_default = {
|
|
|
16580
16889
|
},
|
|
16581
16890
|
is_managed: { enum: [false], type: "boolean" },
|
|
16582
16891
|
is_suspended: {
|
|
16583
|
-
description: "Indicates whether the
|
|
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).",
|
|
16584
16893
|
type: "boolean"
|
|
16585
16894
|
},
|
|
16586
16895
|
latest_desired_state_synced_with_provider_at: {
|
|
@@ -16590,49 +16899,63 @@ var openapi_default = {
|
|
|
16590
16899
|
"x-undocumented": "Only used internally."
|
|
16591
16900
|
},
|
|
16592
16901
|
phone_number: {
|
|
16593
|
-
description: "Phone number of the
|
|
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`).",
|
|
16594
16903
|
type: "string"
|
|
16595
16904
|
},
|
|
16596
16905
|
user_identity_email_address: {
|
|
16597
|
-
description: "Email address of the user identity associated with the
|
|
16906
|
+
description: "Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16598
16907
|
nullable: true,
|
|
16599
16908
|
type: "string"
|
|
16600
16909
|
},
|
|
16601
16910
|
user_identity_full_name: {
|
|
16602
|
-
description: "Full name of the user identity associated with the
|
|
16911
|
+
description: "Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16603
16912
|
nullable: true,
|
|
16604
16913
|
type: "string"
|
|
16605
16914
|
},
|
|
16606
16915
|
user_identity_id: {
|
|
16607
|
-
description: "ID of the user identity associated with the
|
|
16916
|
+
description: "ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16608
16917
|
type: "string"
|
|
16609
16918
|
},
|
|
16610
16919
|
user_identity_phone_number: {
|
|
16611
|
-
description: "Phone number of the user identity associated with the
|
|
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`).",
|
|
16612
16921
|
nullable: true,
|
|
16613
16922
|
type: "string"
|
|
16614
16923
|
},
|
|
16615
16924
|
warnings: {
|
|
16616
|
-
description: "Warnings associated with the
|
|
16925
|
+
description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16617
16926
|
items: {
|
|
16618
|
-
description: "
|
|
16927
|
+
description: "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
16619
16928
|
discriminator: { propertyName: "warning_code" },
|
|
16620
16929
|
oneOf: [
|
|
16621
16930
|
{
|
|
16622
|
-
description: "Indicates that the user is being deleted from the
|
|
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.",
|
|
16623
16932
|
properties: {
|
|
16624
|
-
created_at: {
|
|
16625
|
-
|
|
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
|
+
},
|
|
16626
16942
|
warning_code: { enum: ["being_deleted"], type: "string" }
|
|
16627
16943
|
},
|
|
16628
16944
|
required: ["created_at", "message", "warning_code"],
|
|
16629
16945
|
type: "object"
|
|
16630
16946
|
},
|
|
16631
16947
|
{
|
|
16632
|
-
description: "Indicates that the user is not subscribed on
|
|
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.",
|
|
16633
16949
|
properties: {
|
|
16634
|
-
created_at: {
|
|
16635
|
-
|
|
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
|
+
},
|
|
16636
16959
|
warning_code: {
|
|
16637
16960
|
enum: ["salto_ks_user_not_subscribed"],
|
|
16638
16961
|
type: "string"
|
|
@@ -16642,10 +16965,17 @@ var openapi_default = {
|
|
|
16642
16965
|
type: "object"
|
|
16643
16966
|
},
|
|
16644
16967
|
{
|
|
16645
|
-
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.",
|
|
16646
16969
|
properties: {
|
|
16647
|
-
created_at: {
|
|
16648
|
-
|
|
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
|
+
},
|
|
16649
16979
|
warning_code: {
|
|
16650
16980
|
enum: ["unknown_issue_with_acs_user"],
|
|
16651
16981
|
type: "string"
|
|
@@ -16659,7 +16989,7 @@ var openapi_default = {
|
|
|
16659
16989
|
type: "array"
|
|
16660
16990
|
},
|
|
16661
16991
|
workspace_id: {
|
|
16662
|
-
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the
|
|
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).",
|
|
16663
16993
|
format: "uuid",
|
|
16664
16994
|
type: "string"
|
|
16665
16995
|
}
|
|
@@ -21571,7 +21901,7 @@ var openapi_default = {
|
|
|
21571
21901
|
"x-deprecated": "use email_address."
|
|
21572
21902
|
},
|
|
21573
21903
|
email_address: {
|
|
21574
|
-
description: "Email address of the
|
|
21904
|
+
description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
21575
21905
|
format: "email",
|
|
21576
21906
|
type: "string"
|
|
21577
21907
|
},
|
|
@@ -21580,7 +21910,7 @@ var openapi_default = {
|
|
|
21580
21910
|
type: "string"
|
|
21581
21911
|
},
|
|
21582
21912
|
phone_number: {
|
|
21583
|
-
description: "Phone number of the
|
|
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`).",
|
|
21584
21914
|
type: "string"
|
|
21585
21915
|
},
|
|
21586
21916
|
user_identity_id: {
|
|
@@ -22210,7 +22540,7 @@ var openapi_default = {
|
|
|
22210
22540
|
type: "object"
|
|
22211
22541
|
},
|
|
22212
22542
|
acs_user_id: {
|
|
22213
|
-
description: "ID of the
|
|
22543
|
+
description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
22214
22544
|
format: "uuid",
|
|
22215
22545
|
type: "string"
|
|
22216
22546
|
},
|
|
@@ -22221,17 +22551,17 @@ var openapi_default = {
|
|
|
22221
22551
|
"x-deprecated": "use email_address."
|
|
22222
22552
|
},
|
|
22223
22553
|
email_address: {
|
|
22224
|
-
description: "Email address of the
|
|
22554
|
+
description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
22225
22555
|
format: "email",
|
|
22226
22556
|
type: "string"
|
|
22227
22557
|
},
|
|
22228
22558
|
full_name: {
|
|
22229
|
-
description: "Full name of the
|
|
22559
|
+
description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
22230
22560
|
type: "string"
|
|
22231
22561
|
},
|
|
22232
22562
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
22233
22563
|
phone_number: {
|
|
22234
|
-
description: "Phone number of the
|
|
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`).",
|
|
22235
22565
|
type: "string"
|
|
22236
22566
|
}
|
|
22237
22567
|
},
|
|
@@ -22287,7 +22617,7 @@ var openapi_default = {
|
|
|
22287
22617
|
type: "object"
|
|
22288
22618
|
},
|
|
22289
22619
|
acs_user_id: {
|
|
22290
|
-
description: "ID of the
|
|
22620
|
+
description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
22291
22621
|
format: "uuid",
|
|
22292
22622
|
type: "string"
|
|
22293
22623
|
},
|
|
@@ -22298,17 +22628,17 @@ var openapi_default = {
|
|
|
22298
22628
|
"x-deprecated": "use email_address."
|
|
22299
22629
|
},
|
|
22300
22630
|
email_address: {
|
|
22301
|
-
description: "Email address of the
|
|
22631
|
+
description: "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
22302
22632
|
format: "email",
|
|
22303
22633
|
type: "string"
|
|
22304
22634
|
},
|
|
22305
22635
|
full_name: {
|
|
22306
|
-
description: "Full name of the
|
|
22636
|
+
description: "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
22307
22637
|
type: "string"
|
|
22308
22638
|
},
|
|
22309
22639
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
22310
22640
|
phone_number: {
|
|
22311
|
-
description: "Phone number of the
|
|
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`).",
|
|
22312
22642
|
type: "string"
|
|
22313
22643
|
}
|
|
22314
22644
|
},
|
|
@@ -26996,7 +27326,7 @@ var openapi_default = {
|
|
|
26996
27326
|
schema: {
|
|
26997
27327
|
properties: {
|
|
26998
27328
|
climate_preset_key: {
|
|
26999
|
-
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).",
|
|
27000
27330
|
type: "string"
|
|
27001
27331
|
},
|
|
27002
27332
|
cooling_set_point_celsius: {
|
|
@@ -27005,7 +27335,7 @@ var openapi_default = {
|
|
|
27005
27335
|
type: "number"
|
|
27006
27336
|
},
|
|
27007
27337
|
cooling_set_point_fahrenheit: {
|
|
27008
|
-
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).",
|
|
27009
27339
|
format: "float",
|
|
27010
27340
|
type: "number"
|
|
27011
27341
|
},
|
|
@@ -27015,17 +27345,17 @@ var openapi_default = {
|
|
|
27015
27345
|
type: "string"
|
|
27016
27346
|
},
|
|
27017
27347
|
fan_mode_setting: {
|
|
27018
|
-
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`.",
|
|
27019
27349
|
enum: ["auto", "on", "circulate"],
|
|
27020
27350
|
type: "string"
|
|
27021
27351
|
},
|
|
27022
27352
|
heating_set_point_celsius: {
|
|
27023
|
-
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).",
|
|
27024
27354
|
format: "float",
|
|
27025
27355
|
type: "number"
|
|
27026
27356
|
},
|
|
27027
27357
|
heating_set_point_fahrenheit: {
|
|
27028
|
-
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).",
|
|
27029
27359
|
format: "float",
|
|
27030
27360
|
type: "number"
|
|
27031
27361
|
},
|
|
@@ -27043,7 +27373,7 @@ var openapi_default = {
|
|
|
27043
27373
|
},
|
|
27044
27374
|
name: {
|
|
27045
27375
|
default: null,
|
|
27046
|
-
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).",
|
|
27047
27377
|
nullable: true,
|
|
27048
27378
|
type: "string"
|
|
27049
27379
|
}
|
|
@@ -28756,7 +29086,7 @@ var openapi_default = {
|
|
|
28756
29086
|
schema: {
|
|
28757
29087
|
properties: {
|
|
28758
29088
|
climate_preset_key: {
|
|
28759
|
-
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).",
|
|
28760
29090
|
type: "string"
|
|
28761
29091
|
},
|
|
28762
29092
|
cooling_set_point_celsius: {
|
|
@@ -28765,7 +29095,7 @@ var openapi_default = {
|
|
|
28765
29095
|
type: "number"
|
|
28766
29096
|
},
|
|
28767
29097
|
cooling_set_point_fahrenheit: {
|
|
28768
|
-
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).",
|
|
28769
29099
|
format: "float",
|
|
28770
29100
|
type: "number"
|
|
28771
29101
|
},
|
|
@@ -28775,17 +29105,17 @@ var openapi_default = {
|
|
|
28775
29105
|
type: "string"
|
|
28776
29106
|
},
|
|
28777
29107
|
fan_mode_setting: {
|
|
28778
|
-
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`.",
|
|
28779
29109
|
enum: ["auto", "on", "circulate"],
|
|
28780
29110
|
type: "string"
|
|
28781
29111
|
},
|
|
28782
29112
|
heating_set_point_celsius: {
|
|
28783
|
-
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).",
|
|
28784
29114
|
format: "float",
|
|
28785
29115
|
type: "number"
|
|
28786
29116
|
},
|
|
28787
29117
|
heating_set_point_fahrenheit: {
|
|
28788
|
-
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).",
|
|
28789
29119
|
format: "float",
|
|
28790
29120
|
type: "number"
|
|
28791
29121
|
},
|
|
@@ -28796,13 +29126,13 @@ var openapi_default = {
|
|
|
28796
29126
|
},
|
|
28797
29127
|
manual_override_allowed: {
|
|
28798
29128
|
deprecated: true,
|
|
28799
|
-
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).",
|
|
28800
29130
|
type: "boolean",
|
|
28801
29131
|
"x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
|
|
28802
29132
|
},
|
|
28803
29133
|
name: {
|
|
28804
29134
|
default: null,
|
|
28805
|
-
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).",
|
|
28806
29136
|
nullable: true,
|
|
28807
29137
|
type: "string"
|
|
28808
29138
|
}
|
|
@@ -28853,7 +29183,7 @@ var openapi_default = {
|
|
|
28853
29183
|
schema: {
|
|
28854
29184
|
properties: {
|
|
28855
29185
|
climate_preset_key: {
|
|
28856
|
-
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).",
|
|
28857
29187
|
type: "string"
|
|
28858
29188
|
},
|
|
28859
29189
|
cooling_set_point_celsius: {
|
|
@@ -28862,7 +29192,7 @@ var openapi_default = {
|
|
|
28862
29192
|
type: "number"
|
|
28863
29193
|
},
|
|
28864
29194
|
cooling_set_point_fahrenheit: {
|
|
28865
|
-
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).",
|
|
28866
29196
|
format: "float",
|
|
28867
29197
|
type: "number"
|
|
28868
29198
|
},
|
|
@@ -28872,17 +29202,17 @@ var openapi_default = {
|
|
|
28872
29202
|
type: "string"
|
|
28873
29203
|
},
|
|
28874
29204
|
fan_mode_setting: {
|
|
28875
|
-
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`.",
|
|
28876
29206
|
enum: ["auto", "on", "circulate"],
|
|
28877
29207
|
type: "string"
|
|
28878
29208
|
},
|
|
28879
29209
|
heating_set_point_celsius: {
|
|
28880
|
-
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).",
|
|
28881
29211
|
format: "float",
|
|
28882
29212
|
type: "number"
|
|
28883
29213
|
},
|
|
28884
29214
|
heating_set_point_fahrenheit: {
|
|
28885
|
-
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).",
|
|
28886
29216
|
format: "float",
|
|
28887
29217
|
type: "number"
|
|
28888
29218
|
},
|
|
@@ -28893,13 +29223,13 @@ var openapi_default = {
|
|
|
28893
29223
|
},
|
|
28894
29224
|
manual_override_allowed: {
|
|
28895
29225
|
deprecated: true,
|
|
28896
|
-
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).",
|
|
28897
29227
|
type: "boolean",
|
|
28898
29228
|
"x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
|
|
28899
29229
|
},
|
|
28900
29230
|
name: {
|
|
28901
29231
|
default: null,
|
|
28902
|
-
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).",
|
|
28903
29233
|
nullable: true,
|
|
28904
29234
|
type: "string"
|
|
28905
29235
|
}
|