Skip to content

Commit

Permalink
ci: Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seambot committed Jan 4, 2025
1 parent bc2bc47 commit d695471
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 15 deletions.
9 changes: 9 additions & 0 deletions docs/api/acs/credentials/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
9 changes: 9 additions & 0 deletions docs/api/thermostats/schedules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
39 changes: 24 additions & 15 deletions docs/api/user_identities/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit d695471

Please sign in to comment.