diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index f06374ac3..944e3e840 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -88,7 +88,7 @@ }, { "name": "device_id", - "description": "ID of the device for which to create the new access code.", + "description": "ID of the device for which you want to create the new access code.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -215,7 +215,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -427,7 +427,7 @@ }, { "name": "device_ids", - "description": "IDs of the devices for which to create the new access codes.", + "description": "IDs of the devices for which you want to create the new access codes.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -555,7 +555,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -667,7 +667,7 @@ "parameters": [ { "name": "access_code_id", - "description": "ID of the access code to delete.", + "description": "ID of the access code that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -681,7 +681,7 @@ }, { "name": "device_id", - "description": "ID of the device for which to delete the access code.", + "description": "ID of the device for which you want to delete the access code.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -720,10 +720,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Generate a Code", "name": "generate_code", "path": "/access_codes/generate_code", - "description": "", + "description": "Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -743,7 +743,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device for which you want to generate a code.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -946,7 +946,7 @@ "title": "Pull a Backup Access Code", "name": "pull_backup_access_code", "path": "/access_codes/pull_backup_access_code", - "description": "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.", + "description": "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -993,7 +993,7 @@ "title": "Report Device Access Code Constraints", "name": "report_device_constraints", "path": "/access_codes/report_device_constraints", - "description": "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.", + "description": "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.\n\nSpecify either `supported_code_lengths` or `min_code_length`/`max_code_length`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -1008,7 +1008,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the device for which to report constraints.", + "description": "ID of the device for which you want to report constraints.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -1291,7 +1291,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1482,7 +1482,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1649,7 +1649,7 @@ }, { "name": "allow_external_modification", - "description": "Indicates whether external modification of the access code is allowed.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1677,7 +1677,7 @@ }, { "name": "is_external_modification_allowed", - "description": "Indicates whether external modification of the access code is allowed.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1734,7 +1734,7 @@ "parameters": [ { "name": "access_code_id", - "description": "ID of the unmanaged access code to delete.", + "description": "ID of the unmanaged access code that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2026,7 +2026,7 @@ "title": "Add an ACS User to an Access Group", "name": "add_user", "path": "/acs/access_groups/add_user", - "description": "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -2041,7 +2041,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the desired access group.", + "description": "ID of the access group to which you want to add an access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2055,7 +2055,7 @@ }, { "name": "acs_user_id", - "description": "ID of the desired user.", + "description": "ID of the access system user that you want to add to an access group.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2140,6 +2140,13 @@ "response": "{}", "request_syntax": "csharp", "response_syntax": "json" + }, + "curl": { + "title": "cURL", + "request": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/add_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < + +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). + + +## Request Parameters + +**`device_id`** (Required) + +ID of the device for which you want to generate a code. + +--- + + +## Response + +[access\_code](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 7cf759208..0cae6fde1 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -6,9 +6,9 @@ Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). -A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. +A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access. -If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access. +You can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends. You can only pull backup access codes for time-bound access codes. diff --git a/docs/api/access_codes/report_device_constraints.md b/docs/api/access_codes/report_device_constraints.md index 85e9fa6f8..fc758cce3 100644 --- a/docs/api/access_codes/report_device_constraints.md +++ b/docs/api/access_codes/report_device_constraints.md @@ -6,6 +6,8 @@ Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices. +Specify either `supported_code_lengths` or `min_code_length`/`max_code_length`. + {% tabs %} {% tab title="Signature" %} ``` @@ -30,7 +32,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the device for which to report constraints. +ID of the device for which you want to report constraints. --- diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index c79f090ac..c59c504ef 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -17,6 +17,10 @@ When you create an access code on a device in Seam, it is created as a managed a Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. +Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes: + +- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) + {% tabs %} {% tab title="JSON" %} ```json @@ -1690,6 +1694,12 @@ Indicates that Seam does not manage the access code. **`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 2314f72ea..f85d28c5c 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -40,7 +40,7 @@ ID of the unmanaged access code that you want to convert to a managed access cod **`allow_external_modification`** -Indicates whether external modification of the access code is allowed. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. --- @@ -52,7 +52,7 @@ Indicates whether to force the access code conversion. To switch management of a **`is_external_modification_allowed`** -Indicates whether external modification of the access code is allowed. +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 a638874c7..511d89024 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`access_code_id`** (Required) -ID of the unmanaged access code to delete. +ID of the unmanaged access code that you want to delete. --- diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index e6fe40a91..1846c0c54 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -96,7 +96,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https **`name`** -Name of the new access code. +Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). --- diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 1f4f7fabc..d7c79722c 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -46,7 +46,13 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h **`name`** -Name of the new access code. +Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). --- diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index b6ca6cb2e..c0a3cfe1b 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -243,7 +243,7 @@ An ACS access group was deleted. [**`/acs/access_groups/add_user`**](./add_user.md) -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). [**`/acs/access_groups/get`**](./get.md) @@ -263,11 +263,11 @@ Returns a list of all accessible entrances for a specified [access group](https: [**`/acs/access_groups/list_users`**](./list_users.md) -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). [**`/acs/access_groups/remove_user`**](./remove_user.md) -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index a66854f77..772e9f611 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} {% tab title="Signature" %} @@ -29,13 +29,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_access_group_id`** (Required) -ID of the desired access group. +ID of the access group to which you want to add an access system user. --- **`acs_user_id`** (Required) -ID of the desired user. +ID of the access system user that you want to add to an access group. --- @@ -163,6 +163,27 @@ nil ``` {% endtab %} +{% tab title="cURL" %} +#### Code + +```curl +curl --include --request POST "https://connect.getseam.com/acs/access_groups/add_user" \ + --header "Authorization: Bearer $SEAM_API_KEY" \ + --json @- < Enum values @@ -288,6 +292,51 @@ func main() { ``` {% endtab %} +{% tab title="cURL" %} +#### Code + +```curl +curl --include --request POST "https://connect.getseam.com/acs/entrances/list_credentials_with_access" \ + --header "Authorization: Bearer $SEAM_API_KEY" \ + --json @- < Enum values @@ -83,6 +87,7 @@ Possible enum values: - honeywell_resideo_thermostat - tado_thermostat - sensi_thermostat +- smartthings_thermostat --- @@ -95,7 +100,7 @@ Numerical limit on the number of devices to return. **`manufacturer`** -Manufacturer by which to filter devices. +Manufacturer by which to filter thermostat devices. --- @@ -107,7 +112,7 @@ Identifies the specific page of results to return, obtained from the previous pa **`user_identifier_key`** -Your own internal user ID for the user by which to filter devices. +Your own internal user ID for the user for which you want to list devices. --- @@ -344,6 +349,46 @@ func main() { ``` {% endtab %} +{% tab title="cURL" %} +#### Code + +```curl +curl --include --request POST "https://connect.getseam.com/thermostats/list" \ + --header "Authorization: Bearer $SEAM_API_KEY" +``` + +#### Output + +```curl +{ + "devices": [ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } + ] +} +``` +{% endtab %} + {% endtabs %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 71faea834..50b298e9b 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device that you want to set to off mode. --- @@ -182,6 +182,32 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu ``` {% endtab %} +{% tab title="cURL" %} +#### Code + +```curl +curl --include --request POST "https://connect.getseam.com/thermostats/off" \ + --header "Authorization: Bearer $SEAM_API_KEY" \ + --json @- < + +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). + + +## Request Parameters + +**`device_id`** (Required) + +ID of the thermostat device for which you want to update the weekly program. + +--- + +**`friday_program_id`** + +ID of the thermostat daily program to run on Fridays. + +--- + +**`monday_program_id`** + +ID of the thermostat daily program to run on Mondays. + +--- + +**`saturday_program_id`** + +ID of the thermostat daily program to run on Saturdays. + +--- + +**`sunday_program_id`** + +ID of the thermostat daily program to run on Sundays. + +--- + +**`thursday_program_id`** + +ID of the thermostat daily program to run on Thursdays. + +--- + +**`tuesday_program_id`** + +ID of the thermostat daily program to run on Tuesdays. + +--- + +**`wednesday_program_id`** + +ID of the thermostat daily program to run on Wednesdays. + +--- + + +## Response + +[action\_attempt](./) + +**`PUSH_THERMOSTAT_PROGRAMS`** +{% tabs %} +{% tab title="JSON" %} +```json +{ + action_attempt_id: [example value], + action_type: [example value], + error: [example value], + result: [example value], + status: [example value] +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 4995daccc..35af09e84 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -9,7 +9,7 @@ - [Endpoints](./#endpoints) -Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. +Represents a [user identity](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) associated with an application user account. {% tabs %} {% tab title="JSON" %} @@ -116,7 +116,7 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobi [**`/user_identities/delete`**](./delete.md) -Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. +Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. [**`/user_identities/generate_instant_key`**](./generate_instant_key.md) diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 22cf82108..a25b85f80 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -162,6 +162,27 @@ nil ``` {% endtab %} +{% tab title="cURL" %} +#### Code + +```curl +curl --include --request POST "https://connect.getseam.com/user_identities/add_acs_user" \ + --header "Authorization: Bearer $SEAM_API_KEY" \ + --json @- <=18.12.0", diff --git a/package.json b/package.json index 27bedd577..0233f8e91 100644 --- a/package.json +++ b/package.json @@ -33,8 +33,8 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.42.0", - "@seamapi/types": "1.395.1", + "@seamapi/blueprint": "^0.43.1", + "@seamapi/types": "1.399.1", "change-case": "^5.4.4", "command-exists": "^1.2.9", "del": "^8.0.0", diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index 5d32f965d..8047f58e8 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -21,6 +21,7 @@ const supportedSdks: SdkName[] = [ 'ruby', 'go', 'seam_cli', + 'curl', ] export interface ApiEndpointLayoutContext {