From d6954710250807b4694c0875c05b2b6bfd9171e0 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sat, 4 Jan 2025 00:05:54 +0000 Subject: [PATCH] ci: Generate docs --- docs/api/acs/credentials/create.md | 9 ++++++ docs/api/thermostats/schedules/README.md | 9 ++++++ docs/api/user_identities/update.md | 39 +++++++++++++++--------- 3 files changed, 42 insertions(+), 15 deletions(-) diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index a34432db..c71a4493 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -286,6 +286,15 @@ Indicates whether the new credential is a [multi-phone sync credential](https:// *** +### `salto_space_metadata` + +Type: `object` +Required: No + +Salto Space-specific metadata for the new credential. + +*** + ### `starts_at` Type: `string` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 8bcf1ce2..7cc23a00 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -38,6 +38,15 @@ Format: `Datetime` Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. +--- + +### `errors` + +Format: `List` + +Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. + + --- ### `max_override_period_minutes` diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 588635af..3b563826 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -4,51 +4,60 @@ PATCH /user_identities/update ⇒ void ``` -### Authentication Methods -* API key -* Personal access token -### Request Parameters +## Authentication Methods -#### `email_address` +- API key +- Personal access token -Type: `string` Required: No +## Request Parameters + +### `email_address` + +Type: `string` +Required: No Unique email address for the user identity. *** -#### `full_name` +### `full_name` + +Type: `string` +Required: No + -Type: `string` Required: No *** -#### `phone_number` +### `phone_number` -Type: `string` Required: No +Type: `string` +Required: No 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_id` +### `user_identity_id` -Type: `string` Required: Yes +Type: `string` +Required: Yes ID of the user identity. *** -#### `user_identity_key` +### `user_identity_key` -Type: `string` Required: No +Type: `string` +Required: No Unique key for the user identity. *** -### Return Type +## Return Type void