diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 71fda133d..5581db7d2 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -28,65 +28,65 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the device for which you want to create the new access code. --- -**`allow_external_modification`** +**`allow_external_modification`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- -**`attempt_for_offline_device`** +**`attempt_for_offline_device`** *Boolean* --- -**`code`** +**`code`** *String* Code to be used for access. --- -**`common_code_key`** +**`common_code_key`** *String* Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md). --- -**`ends_at`** +**`ends_at`** *String* Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -**`is_external_modification_allowed`** +**`is_external_modification_allowed`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- -**`is_offline_access_code`** +**`is_offline_access_code`** *Boolean* Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). --- -**`is_one_time_use`** +**`is_one_time_use`** *Boolean* Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. --- -**`max_time_rounding`** +**`max_time_rounding`** *String* Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. --- -**`name`** +**`name`** *String* Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. @@ -98,31 +98,31 @@ Name of the new access code. Enables administrators and users to identify the ac --- -**`prefer_native_scheduling`** +**`prefer_native_scheduling`** *Boolean* Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. --- -**`preferred_code_length`** +**`preferred_code_length`** *Number* Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. --- -**`starts_at`** +**`starts_at`** *String* Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`use_backup_access_code_pool`** +**`use_backup_access_code_pool`** *Boolean* Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). --- -**`use_offline_access_code`** +**`use_offline_access_code`** *Boolean* --- diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index b96b1a766..c4a5a5f04 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -36,65 +36,65 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_ids`** *of UUIDs* (Required) +**`device_ids`** *Array* *of UUIDs* (Required) IDs of the devices for which you want to create the new access codes. --- -**`allow_external_modification`** +**`allow_external_modification`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- -**`attempt_for_offline_device`** +**`attempt_for_offline_device`** *Boolean* --- -**`behavior_when_code_cannot_be_shared`** +**`behavior_when_code_cannot_be_shared`** *String* Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. --- -**`code`** +**`code`** *String* Code to be used for access. --- -**`ends_at`** +**`ends_at`** *String* Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -**`is_external_modification_allowed`** +**`is_external_modification_allowed`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- -**`is_offline_access_code`** +**`is_offline_access_code`** *Boolean* Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). --- -**`is_one_time_use`** +**`is_one_time_use`** *Boolean* Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. --- -**`max_time_rounding`** +**`max_time_rounding`** *String* Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. --- -**`name`** +**`name`** *String* Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. @@ -106,31 +106,31 @@ Name of the new access code. Enables administrators and users to identify the ac --- -**`prefer_native_scheduling`** +**`prefer_native_scheduling`** *Boolean* Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. --- -**`preferred_code_length`** +**`preferred_code_length`** *Number* Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. --- -**`starts_at`** +**`starts_at`** *String* Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`use_backup_access_code_pool`** +**`use_backup_access_code_pool`** *Boolean* Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). --- -**`use_offline_access_code`** +**`use_offline_access_code`** *Boolean* --- diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 0c2a78e1e..b78771906 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -28,13 +28,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** (Required) +**`access_code_id`** *String* (Required) ID of the access code that you want to delete. --- -**`device_id`** +**`device_id`** *String* ID of the device for which you want to delete the access code. diff --git a/docs/api/access_codes/generate_code.md b/docs/api/access_codes/generate_code.md index f2761a806..0aef4cdcd 100644 --- a/docs/api/access_codes/generate_code.md +++ b/docs/api/access_codes/generate_code.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the device for which you want to generate a code. diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 819f0c606..878e2dd04 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -28,19 +28,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** +**`access_code_id`** *String* ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- -**`code`** +**`code`** *String* Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- -**`device_id`** +**`device_id`** *String* ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index c6b599210..f2dbf7c53 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -30,31 +30,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_ids`** *of UUIDs* +**`access_code_ids`** *Array* *of UUIDs* IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. --- -**`device_id`** +**`device_id`** *String* ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. --- -**`limit`** +**`limit`** *Number* Numerical limit on the number of access codes to return. --- -**`page_cursor`** +**`page_cursor`** *String* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- -**`user_identifier_key`** +**`user_identifier_key`** *String* Your user ID for the user by which to filter access codes. diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 0cae6fde1..81bc029e3 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -36,7 +36,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** (Required) +**`access_code_id`** *String* (Required) ID of the access code for which you want to pull a backup access code. diff --git a/docs/api/access_codes/report_device_constraints.md b/docs/api/access_codes/report_device_constraints.md index fc758cce3..56cb7cf9f 100644 --- a/docs/api/access_codes/report_device_constraints.md +++ b/docs/api/access_codes/report_device_constraints.md @@ -30,25 +30,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the device for which you want to report constraints. --- -**`max_code_length`** +**`max_code_length`** *Number* Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`. --- -**`min_code_length`** +**`min_code_length`** *Number* Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`. --- -**`supported_code_lengths`** *of Numbers* +**`supported_code_lengths`** *Array* *of Numbers* Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`. diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index e86e44d1f..9dea2b849 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -28,19 +28,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`code`** (Required) +**`code`** *String* (Required) Code of the simulated unmanaged access code. --- -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the device for which you want to simulate the creation of an unmanaged access code. --- -**`name`** (Required) +**`name`** *String* (Required) Name of the simulated unmanaged access code. diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index f85d28c5c..86c0696c5 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -32,25 +32,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** (Required) +**`access_code_id`** *String* (Required) ID of the unmanaged access code that you want to convert to a managed access code. --- -**`allow_external_modification`** +**`allow_external_modification`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. --- -**`force`** +**`force`** *Boolean* Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. --- -**`is_external_modification_allowed`** +**`is_external_modification_allowed`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 511d89024..f85bd9d98 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** (Required) +**`access_code_id`** *String* (Required) ID of the unmanaged access code that you want to delete. diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index a5dcf9cec..53035d0fd 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -30,19 +30,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** +**`access_code_id`** *String* ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- -**`code`** +**`code`** *String* Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- -**`device_id`** +**`device_id`** *String* ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index f8c505965..439b309ea 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -28,13 +28,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the device for which you want to list unmanaged access codes. --- -**`user_identifier_key`** +**`user_identifier_key`** *String* Your user ID for the user by which to filter unmanaged access codes. diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index bc624f0de..a7fd10c5c 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -28,29 +28,29 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** (Required) +**`access_code_id`** *String* (Required) ID of the unmanaged access code that you want to update. --- -**`is_managed`** (Required) +**`is_managed`** *Boolean* (Required) --- -**`allow_external_modification`** +**`allow_external_modification`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. --- -**`force`** +**`force`** *Boolean* Indicates whether to force the unmanaged access code update. --- -**`is_external_modification_allowed`** +**`is_external_modification_allowed`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 1846c0c54..1d4ddea23 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -30,71 +30,71 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** (Required) +**`access_code_id`** *String* (Required) ID of the access code that you want to update. --- -**`allow_external_modification`** +**`allow_external_modification`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- -**`attempt_for_offline_device`** +**`attempt_for_offline_device`** *Boolean* --- -**`code`** +**`code`** *String* Code to be used for access. --- -**`device_id`** +**`device_id`** *String* ID of the device containing the access code that you want to update. --- -**`ends_at`** +**`ends_at`** *String* Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -**`is_external_modification_allowed`** +**`is_external_modification_allowed`** *Boolean* Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- -**`is_managed`** +**`is_managed`** *Boolean* Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`. --- -**`is_offline_access_code`** +**`is_offline_access_code`** *Boolean* Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). --- -**`is_one_time_use`** +**`is_one_time_use`** *Boolean* Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. --- -**`max_time_rounding`** +**`max_time_rounding`** *String* Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. --- -**`name`** +**`name`** *String* Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. @@ -106,37 +106,37 @@ Name of the new access code. Enables administrators and users to identify the ac --- -**`prefer_native_scheduling`** +**`prefer_native_scheduling`** *Boolean* Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. --- -**`preferred_code_length`** +**`preferred_code_length`** *Number* Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. --- -**`starts_at`** +**`starts_at`** *String* Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`type`** +**`type`** *String* Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). --- -**`use_backup_access_code_pool`** +**`use_backup_access_code_pool`** *Boolean* Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). --- -**`use_offline_access_code`** +**`use_offline_access_code`** *Boolean* --- diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index d7c79722c..7ad1a1f2d 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -32,19 +32,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`common_code_key`** (Required) +**`common_code_key`** *String* (Required) Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. --- -**`ends_at`** +**`ends_at`** *String* Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -**`name`** +**`name`** *String* Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. @@ -56,7 +56,7 @@ Name of the new access code. Enables administrators and users to identify the ac --- -**`starts_at`** +**`starts_at`** *String* Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 704126c90..aeab1a57c 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group to which you want to add an access system user. --- -**`acs_user_id`** +**`acs_user_id`** *String* ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 1d8dda27c..70bdf3212 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group that you want to get. diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 6a7462c02..1987e68ba 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** +**`acs_system_id`** *String* ID of the access system for which you want to retrieve all access groups. --- -**`acs_user_id`** +**`acs_user_id`** *String* ID of the access system user for which you want to retrieve all access groups. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity for which you want to retrieve all access groups. diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 8b2dc7373..0b04a394d 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group for which you want to retrieve all accessible entrances. diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d317a3e9f..593e0f951 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group for which you want to retrieve all access system users. diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index a9c556881..b46e7f9a6 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group from which you want to remove an access system user. --- -**`acs_user_id`** +**`acs_user_id`** *String* ID of the access system user that you want to remove from an access group. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity associated with the user that you want to remove from an access group. diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 1ae0ec110..06b324dc8 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** (Required) +**`acs_credential_id`** *String* (Required) ID of the credential that you want to assign to an access system user. --- -**`acs_user_id`** +**`acs_user_id`** *String* ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index ed038bd84..3baafa9d9 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -27,79 +27,79 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_method`** (Required) +**`access_method`** *String* (Required) Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. --- -**`acs_system_id`** +**`acs_system_id`** *String* ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. --- -**`acs_user_id`** +**`acs_user_id`** *String* ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. --- -**`allowed_acs_entrance_ids`** *of UUIDs* +**`allowed_acs_entrance_ids`** *Array* *of UUIDs* Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. --- -**`assa_abloy_vostio_metadata`** +**`assa_abloy_vostio_metadata`** *Object* Vostio-specific metadata for the new credential. --- -**`code`** +**`code`** *String* Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). --- -**`credential_manager_acs_system_id`** +**`credential_manager_acs_system_id`** *String* ACS system ID of the credential manager for the new credential. --- -**`ends_at`** +**`ends_at`** *String* Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -**`is_multi_phone_sync_credential`** +**`is_multi_phone_sync_credential`** *Boolean* Indicates whether the new 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). --- -**`salto_space_metadata`** +**`salto_space_metadata`** *Object* Salto Space-specific metadata for the new credential. --- -**`starts_at`** +**`starts_at`** *String* Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created. --- -**`visionline_metadata`** +**`visionline_metadata`** *Object* Visionline-specific metadata for the new credential. diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index f3254858f..4c0c3333e 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** (Required) +**`acs_credential_id`** *String* (Required) ID of the credential that you want to delete. diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 64c1c9def..83389d529 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** (Required) +**`acs_credential_id`** *String* (Required) ID of the credential that you want to get. diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 5d2e56b42..7a4f258ab 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -28,37 +28,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** +**`acs_system_id`** *String* ID of the access system for which you want to retrieve all credentials. --- -**`acs_user_id`** +**`acs_user_id`** *String* ID of the access system user for which you want to retrieve all credentials. --- -**`created_before`** +**`created_before`** *String* Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. --- -**`is_multi_phone_sync_credential`** +**`is_multi_phone_sync_credential`** *Boolean* Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. --- -**`limit`** +**`limit`** *Number* Number of credentials to return. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity for which you want to retrieve all credentials. diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3fbc3a9c2..3b7b3b3ee 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** (Required) +**`acs_credential_id`** *String* (Required) ID of the credential for which you want to retrieve all entrances to which the credential grants access. diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index bdbf2a8f6..9a37d15f4 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** (Required) +**`acs_credential_id`** *String* (Required) ID of the credential that you want to unassign from an access system user. --- -**`acs_user_id`** +**`acs_user_id`** *String* ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id. diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index bf5a45005..815f0e8ad 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** (Required) +**`acs_credential_id`** *String* (Required) ID of the credential that you want to update. --- -**`code`** +**`code`** *String* Replacement access (PIN) code for the credential that you want to update. --- -**`ends_at`** +**`ends_at`** *String* Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. diff --git a/docs/api/acs/encoders/encode_access_method.md b/docs/api/acs/encoders/encode_access_method.md index aac1fcdad..a1ff13a0e 100644 --- a/docs/api/acs/encoders/encode_access_method.md +++ b/docs/api/acs/encoders/encode_access_method.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_method_id`** (Required) +**`access_method_id`** *String* (Required) ID of the `access_method` to encode onto a card. --- -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` to use to encode the `access_method`. diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 7647dde82..f98fad2bf 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** (Required) +**`acs_credential_id`** *String* (Required) ID of the `acs_credential` to encode onto a card. --- -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` to use to encode the `acs_credential`. diff --git a/docs/api/acs/encoders/get.md b/docs/api/acs/encoders/get.md index 323e8b2cb..6459d5d23 100644 --- a/docs/api/acs/encoders/get.md +++ b/docs/api/acs/encoders/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the encoder that you want to get. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index da1426c23..655ffd786 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -27,25 +27,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_ids`** *of UUIDs* +**`acs_encoder_ids`** *Array* *of UUIDs* IDs of the encoders that you want to retrieve. --- -**`acs_system_id`** +**`acs_system_id`** *String* ID of the access system for which you want to retrieve all encoders. --- -**`acs_system_ids`** *of UUIDs* +**`acs_system_ids`** *Array* *of UUIDs* IDs of the access systems for which you want to retrieve all encoders. --- -**`limit`** +**`limit`** *Number* Number of encoders to return. diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 49da33d96..10a859f48 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the encoder to use for the scan. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index bee0557f6..b14437d20 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -**`acs_credential_id`** +**`acs_credential_id`** *String* ID of the `acs_credential` that will fail to be encoded onto a card in the next request. --- -**`error_code`** +**`error_code`** *String* Code of the error to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 8591ccc6f..cf65a0918 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -**`scenario`** +**`scenario`** *String* Scenario to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 9e0a64da5..308d70237 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -27,17 +27,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. --- -**`acs_credential_id_on_seam`** +**`acs_credential_id_on_seam`** *String* --- -**`error_code`** +**`error_code`** *String* --- diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 678a57eba..f3802da18 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. --- -**`acs_credential_id_on_seam`** +**`acs_credential_id_on_seam`** *String* ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. --- -**`scenario`** +**`scenario`** *String* Scenario to simulate. diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 402c13ad0..80e5dff2b 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -26,7 +26,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_entrance_id`** (Required) +**`acs_entrance_id`** *String* (Required) ID of the entrance that you want to get. diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 0dd4d842f..69de48616 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_entrance_id`** (Required) +**`acs_entrance_id`** *String* (Required) ID of the entrance to which you want to grant an access system user access. --- -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user to whom you want to grant access to an entrance. diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 6dac2f970..cd7af01b1 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -28,13 +28,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** +**`acs_credential_id`** *String* ID of the credential for which you want to retrieve all entrances. --- -**`acs_system_id`** +**`acs_system_id`** *String* ID of the access system for which you want to retrieve all entrances. diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 955e8b6e9..6c84f1868 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -28,13 +28,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_entrance_id`** (Required) +**`acs_entrance_id`** *String* (Required) ID of the entrance for which you want to list all credentials that grant access. --- -**`include_if`** *of Enums* +**`include_if`** *Array* *of Enums* Conditions that credentials must meet to be included in the returned list.
diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 00148a560..172a4f0f7 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** (Required) +**`acs_system_id`** *String* (Required) ID of the access system that you want to get. diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 29f5f93d9..7e59ac5de 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`connected_account_id`** +**`connected_account_id`** *String* ID of the connected account by which you want to filter the list of access systems. diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 38a8ce08f..69abecf1e 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** (Required) +**`acs_system_id`** *String* (Required) ID of the access system for which you want to retrieve all compatible credential manager systems. diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 7f74f6795..6fc724f4e 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group to which you want to add an access system user. --- -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user that you want to add to an access group. diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 871c3baf0..f8e407b4a 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -27,47 +27,47 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** (Required) +**`acs_system_id`** *String* (Required) ID of the access system to which you want to add the new access system user. --- -**`full_name`** (Required) +**`full_name`** *String* (Required) Full name of the new access system user. --- -**`access_schedule`** +**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. --- -**`acs_access_group_ids`** *of UUIDs* +**`acs_access_group_ids`** *Array* *of UUIDs* Array of access group IDs to indicate the access groups to which you want to add the new access system user. --- -**`email`** +**`email`** *String* --- -**`email_address`** +**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`phone_number`** +**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity with which you want to associate the new access system user. diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 0a920ecd8..8c966e274 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user that you want to delete. diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 219cb4f4c..7367d5d32 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user that you want to get. diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index d1bb6dba9..017e13dab 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -28,49 +28,49 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** +**`acs_system_id`** *String* ID of the `acs_system` for which you want to retrieve all access system users. --- -**`created_before`** +**`created_before`** *String* Timestamp by which to limit returned access system users. Returns users created before this timestamp. --- -**`limit`** +**`limit`** *Number* Maximum number of records to return per page. --- -**`page_cursor`** +**`page_cursor`** *String* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- -**`search`** +**`search`** *String* String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. --- -**`user_identity_email_address`** +**`user_identity_email_address`** *String* Email address of the user identity for which you want to retrieve all access system users. --- -**`user_identity_id`** +**`user_identity_id`** *String* ID of the user identity for which you want to retrieve all access system users. --- -**`user_identity_phone_number`** +**`user_identity_phone_number`** *String* Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 9a87fe071..cefb818a0 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user for whom you want to list accessible entrances. diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index c8ad30033..7e8ffc4a9 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group from which you want to remove an access system user. --- -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user that you want to remove from an access group. diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 819255bea..380a1f839 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user for whom you want to revoke access. diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 3f1fd46ee..dd6f96dc4 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user that you want to suspend. diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 6d0dc91b8..244cf6433 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the access system user that you want to unsuspend. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 006be36e4..1c2627692 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -27,39 +27,39 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`access_schedule`** +**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. --- -**`email`** +**`email`** *String* --- -**`email_address`** +**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`full_name`** +**`full_name`** *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`hid_acs_system_id`** +**`hid_acs_system_id`** *String* --- -**`phone_number`** +**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 3d4f122a3..8fc235f83 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) Device ID of the desired phone. diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index facf02c0f..41d463f9a 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) Device ID of the desired phone. diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 8c5028946..3a029a3c8 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** +**`acs_credential_id`** *String* ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. --- -**`owner_user_identity_id`** +**`owner_user_identity_id`** *String* ID of the user identity that represents the owner by which to filter the list of returned phones. diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 2153e42c7..6d0b53df0 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -27,25 +27,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the user identity to associate with the simulated phone. --- -**`assa_abloy_metadata`** +**`assa_abloy_metadata`** *Object* ASSA ABLOY metadata to associate with the simulated phone. --- -**`custom_sdk_installation_id`** +**`custom_sdk_installation_id`** *String* ID of the custom SDK installation to use for the simulated phone. --- -**`phone_metadata`** +**`phone_metadata`** *Object* Metadata to associate with the simulated phone. diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 4b4319fc1..68682475b 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** (Required) +**`climate_preset_key`** *String* (Required) Climate preset key of the climate preset that you want to activate. --- -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to activate a climate preset. diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index b0c1806fb..12b4b8dd1 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -28,19 +28,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device that you want to set to cool mode. --- -**`cooling_set_point_celsius`** +**`cooling_set_point_celsius`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** +**`cooling_set_point_fahrenheit`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index d9064da0e..da7c86091 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -28,61 +28,61 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** (Required) +**`climate_preset_key`** *String* (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want create a climate preset. --- -**`cooling_set_point_celsius`** +**`cooling_set_point_celsius`** *Number* Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`cooling_set_point_fahrenheit`** +**`cooling_set_point_fahrenheit`** *Number* Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`fan_mode_setting`** +**`fan_mode_setting`** *String* 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`. --- -**`heating_set_point_celsius`** +**`heating_set_point_celsius`** *Number* Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`heating_set_point_fahrenheit`** +**`heating_set_point_fahrenheit`** *Number* Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`hvac_mode_setting`** +**`hvac_mode_setting`** *String* Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -**`manual_override_allowed`** +**`manual_override_allowed`** *Boolean* Indicates whether a person at the thermostat or using the API can change the thermostat's settings. --- -**`name`** +**`name`** *String* User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 3a8a8e209..c18150ec9 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -28,13 +28,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** (Required) +**`climate_preset_key`** *String* (Required) Climate preset key of the climate preset that you want to delete. --- -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to delete a climate preset. diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index ea2060d4b..2f4b751a8 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -28,19 +28,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device that you want to set to heat mode. --- -**`heating_set_point_celsius`** +**`heating_set_point_celsius`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** +**`heating_set_point_fahrenheit`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 755e7d8fa..869f4518f 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -28,31 +28,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device that you want to set to heat-cool mode. --- -**`cooling_set_point_celsius`** +**`cooling_set_point_celsius`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** +**`cooling_set_point_fahrenheit`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -**`heating_set_point_celsius`** +**`heating_set_point_celsius`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** +**`heating_set_point_fahrenheit`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 9fb567e07..8c4904d63 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -28,53 +28,53 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`connect_webview_id`** +**`connect_webview_id`** *String* ID of the Connect Webview for which you want to list devices. --- -**`connected_account_id`** +**`connected_account_id`** *String* ID of the connected account for which you want to list devices. --- -**`connected_account_ids`** *of UUIDs* +**`connected_account_ids`** *Array* *of UUIDs* Array of IDs of the connected accounts for which you want to list devices. --- -**`created_before`** +**`created_before`** *String* Timestamp by which to limit returned devices. Returns devices created before this timestamp. --- -**`custom_metadata_has`** +**`custom_metadata_has`** *Object* Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs for which you want to list devices. --- -**`customer_ids`** *of UUIDs* +**`customer_ids`** *Array* *of UUIDs* --- -**`device_ids`** *of UUIDs* +**`device_ids`** *Array* *of UUIDs* Array of device IDs for which you want to list devices. --- -**`device_type`** +**`device_type`** *String* Device type by which to filter thermostat devices. --- -**`device_types`** *of Enums* +**`device_types`** *Array* *of Enums* Array of device types by which to filter thermostat devices.
@@ -92,25 +92,25 @@ Possible enum values: --- -**`limit`** +**`limit`** *Number* Numerical limit on the number of devices to return. --- -**`manufacturer`** +**`manufacturer`** *String* Manufacturer by which to filter thermostat devices. --- -**`page_cursor`** +**`page_cursor`** *String* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- -**`user_identifier_key`** +**`user_identifier_key`** *String* Your own internal user ID for the user for which you want to list devices. diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 50b298e9b..008902269 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device that you want to set to off mode. diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 3d5d9f910..f6188f824 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -28,43 +28,43 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** (Required) +**`climate_preset_key`** *String* (Required) Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`ends_at`** (Required) +**`ends_at`** *String* (Required) Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`starts_at`** (Required) +**`starts_at`** *String* (Required) Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`is_override_allowed`** +**`is_override_allowed`** *Boolean* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`max_override_period_minutes`** +**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** +**`name`** *String* User-friendly name to identify the thermostat schedule. diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 8a139ebe4..801ec5a1a 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`thermostat_schedule_id`** (Required) +**`thermostat_schedule_id`** *String* (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index ad95eefa8..14c29e0df 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`thermostat_schedule_id`** (Required) +**`thermostat_schedule_id`** *String* (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 737fa14bb..1aaa957e6 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -28,13 +28,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`user_identifier_key`** +**`user_identifier_key`** *String* User identifier key by which to filter the list of returned thermostat schedules. diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 522b80012..dca7f61f9 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -28,43 +28,43 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`thermostat_schedule_id`** (Required) +**`thermostat_schedule_id`** *String* (Required) ID of the desired thermostat schedule. --- -**`climate_preset_key`** +**`climate_preset_key`** *String* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -**`ends_at`** +**`ends_at`** *String* Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`is_override_allowed`** +**`is_override_allowed`** *Boolean* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`max_override_period_minutes`** +**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** +**`name`** *String* User-friendly name to identify the thermostat schedule. --- -**`starts_at`** +**`starts_at`** *String* Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index f7b2b775b..b31e9ed23 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** (Required) +**`climate_preset_key`** *String* (Required) Climate preset key of the climate preset that you want to set as the fallback climate preset. --- -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to set the fallback climate preset. diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 3429fac0e..7fcfb1f03 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -28,17 +28,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to set the fan mode. --- -**`fan_mode`** +**`fan_mode`** *String* --- -**`fan_mode_setting`** +**`fan_mode_setting`** *String* Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 7da5ec25d..bccb5a09a 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -28,35 +28,35 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to set the HVAC mode. --- -**`hvac_mode_setting`** (Required) +**`hvac_mode_setting`** *String* (Required) --- -**`cooling_set_point_celsius`** +**`cooling_set_point_celsius`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** +**`cooling_set_point_fahrenheit`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -**`heating_set_point_celsius`** +**`heating_set_point_celsius`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** +**`heating_set_point_fahrenheit`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 5493d1396..d039772c8 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -27,31 +27,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to set a temperature threshold. --- -**`lower_limit_celsius`** +**`lower_limit_celsius`** *Number* Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -**`lower_limit_fahrenheit`** +**`lower_limit_fahrenheit`** *Number* Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -**`upper_limit_celsius`** +**`upper_limit_celsius`** *Number* Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- -**`upper_limit_fahrenheit`** +**`upper_limit_fahrenheit`** *Number* Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index a73c7938e..e8c78fb7e 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -27,37 +27,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`hvac_mode`** (Required) +**`hvac_mode`** *String* (Required) Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. --- -**`cooling_set_point_celsius`** +**`cooling_set_point_celsius`** *Number* Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. --- -**`cooling_set_point_fahrenheit`** +**`cooling_set_point_fahrenheit`** *Number* Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. --- -**`heating_set_point_celsius`** +**`heating_set_point_celsius`** *Number* Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. --- -**`heating_set_point_fahrenheit`** +**`heating_set_point_fahrenheit`** *Number* Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 2b5f8d6a7..b099bb241 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -27,19 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`temperature_celsius`** +**`temperature_celsius`** *Number* Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. --- -**`temperature_fahrenheit`** +**`temperature_fahrenheit`** *Number* Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 13d76fd33..f13f65823 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -28,61 +28,61 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** (Required) +**`climate_preset_key`** *String* (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to update a climate preset. --- -**`manual_override_allowed`** (Required) +**`manual_override_allowed`** *Boolean* (Required) Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`cooling_set_point_celsius`** +**`cooling_set_point_celsius`** *Number* Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`cooling_set_point_fahrenheit`** +**`cooling_set_point_fahrenheit`** *Number* Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`fan_mode_setting`** +**`fan_mode_setting`** *String* 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`. --- -**`heating_set_point_celsius`** +**`heating_set_point_celsius`** *Number* Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`heating_set_point_fahrenheit`** +**`heating_set_point_fahrenheit`** *Number* Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`hvac_mode_setting`** +**`hvac_mode_setting`** *String* Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -**`name`** +**`name`** *String* User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/thermostats/update_weekly_program.md b/docs/api/thermostats/update_weekly_program.md index 387f47cd1..a6c6146ed 100644 --- a/docs/api/thermostats/update_weekly_program.md +++ b/docs/api/thermostats/update_weekly_program.md @@ -28,49 +28,49 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the thermostat device for which you want to update the weekly program. --- -**`friday_program_id`** +**`friday_program_id`** *String* ID of the thermostat daily program to run on Fridays. --- -**`monday_program_id`** +**`monday_program_id`** *String* ID of the thermostat daily program to run on Mondays. --- -**`saturday_program_id`** +**`saturday_program_id`** *String* ID of the thermostat daily program to run on Saturdays. --- -**`sunday_program_id`** +**`sunday_program_id`** *String* ID of the thermostat daily program to run on Sundays. --- -**`thursday_program_id`** +**`thursday_program_id`** *String* ID of the thermostat daily program to run on Thursdays. --- -**`tuesday_program_id`** +**`tuesday_program_id`** *String* ID of the thermostat daily program to run on Tuesdays. --- -**`wednesday_program_id`** +**`wednesday_program_id`** *String* ID of the thermostat daily program to run on Wednesdays. diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index a25b85f80..1b432e59e 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the desired ACS user. --- -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 7ed9833f9..602a7ec96 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -27,31 +27,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_ids`** *of UUIDs* +**`acs_system_ids`** *Array* *of UUIDs* List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity. --- -**`email_address`** +**`email_address`** *String* Unique email address for the user identity. --- -**`full_name`** +**`full_name`** *String* Full name of the user associated with the user identity. --- -**`phone_number`** +**`phone_number`** *String* Unique phone number for the user identity in E.164 format (for example, +15555550100). --- -**`user_identity_key`** +**`user_identity_key`** *String* Unique key for the user identity. diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 152debf66..f012ef9a9 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 05ee61c81..ca1bdac57 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`enrollment_automation_id`** (Required) +**`enrollment_automation_id`** *String* (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index a075e29bc..7801f8dfb 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`enrollment_automation_id`** (Required) +**`enrollment_automation_id`** *String* (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 9148ef74b..20197235b 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -27,31 +27,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`credential_manager_acs_system_id`** (Required) +**`credential_manager_acs_system_id`** *String* (Required) ID of the desired ACS system that serves as the credential manager. --- -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. --- -**`acs_credential_pool_id`** +**`acs_credential_pool_id`** *String* ID of the ACS credential pool from which to obtain credentials for the user identity. --- -**`create_credential_manager_user`** +**`create_credential_manager_user`** *Boolean* Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. --- -**`credential_manager_acs_user_id`** +**`credential_manager_acs_user_id`** *String* ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 9630af2bb..653db0549 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all enrollment automations. diff --git a/docs/api/user_identities/generate_instant_key.md b/docs/api/user_identities/generate_instant_key.md index 2d4b1956c..793b675ca 100644 --- a/docs/api/user_identities/generate_instant_key.md +++ b/docs/api/user_identities/generate_instant_key.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to generate an instant key. --- -**`max_use_count`** +**`max_use_count`** *Number* The maximum number of times the instant key can be used. Defaults to 1. diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index a861be202..a491f28f7 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** +**`user_identity_id`** *String* ID of the desired user identity. --- -**`user_identity_key`** +**`user_identity_key`** *String* --- diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index c68689412..cfd2d5ac3 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the desired managed device. --- -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 2802d138d..6dc344066 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`credential_manager_acs_system_id`** +**`credential_manager_acs_system_id`** *String* --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 5b7445f25..9b7120df5 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all accessible devices. diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 194a30b6d..c2a8ade79 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all access control systems. diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 0e0f77cfc..f094b51a2 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all ACS users. diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 60a5da39b..357b9a444 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** (Required) +**`acs_user_id`** *String* (Required) ID of the ACS user. --- -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index b8dd893aa..ca4cd28ef 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -27,13 +27,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** (Required) +**`device_id`** *String* (Required) ID of the desired managed device. --- -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 71ac692cd..d30753698 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -27,29 +27,29 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** (Required) +**`user_identity_id`** *String* (Required) ID of the user identity. --- -**`email_address`** +**`email_address`** *String* Unique email address for the user identity. --- -**`full_name`** +**`full_name`** *String* --- -**`phone_number`** +**`phone_number`** *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -**`user_identity_key`** +**`user_identity_key`** *String* Unique key for the user identity. diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index 5f2791613..f2a9c903f 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -7,6 +7,7 @@ import type { SeamAuthMethod, SeamWorkspaceScope, } from '@seamapi/blueprint' +import { capitalCase } from 'change-case' import { type ApiRouteResource, @@ -63,6 +64,7 @@ interface ApiEndpointParameter { itemFormat?: string itemEnumValues?: string[] objectParameters?: ApiEndpointParameter[] + jsonType: string } interface CodeSampleContext { @@ -175,6 +177,7 @@ const mapBlueprintParamToEndpointParam = ( format: normalizePropertyFormatForDocs(param.format), isDeprecated: param.isDeprecated, deprecationMessage: param.deprecationMessage, + jsonType: capitalCase(param.jsonType), ...(param.format === 'enum' && { enumValues: param.values.map(({ name }) => name),