Skip to content

Commit

Permalink
ci: Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seambot committed Nov 19, 2024
1 parent 6c9be2e commit 1a1e172
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 32 deletions.
4 changes: 1 addition & 3 deletions docs/api/acs/entrances/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).

### Properties

#### `acs_entrance_id`
### `acs_entrance_id`

Format: `ID`

Expand Down
4 changes: 2 additions & 2 deletions docs/api/acs/systems/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Indicates if the `acs_system` is a credential manager.

---

#### `location`
### `location`

Format: `Object`

Expand All @@ -155,7 +155,7 @@ Time zone in which the `acs_system` is located.

---

#### `name`
### `name`

Format: `String`

Expand Down
18 changes: 8 additions & 10 deletions docs/api/thermostats/schedules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.

### Properties

#### `climate_preset_key`
### `climate_preset_key`

Format: `String`

Expand All @@ -15,7 +13,7 @@ Key of the [climate preset](../../../capability-guides/thermostats/creating-and-

---

#### `created_at`
### `created_at`

Format: `Datetime`

Expand All @@ -24,7 +22,7 @@ Date and time at which the thermostat schedule was created.

---

#### `device_id`
### `device_id`

Format: `ID`

Expand All @@ -33,7 +31,7 @@ ID of the desired thermostat device.

---

#### `ends_at`
### `ends_at`

Format: `Datetime`

Expand All @@ -42,7 +40,7 @@ Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.i

---

#### `max_override_period_minutes`
### `max_override_period_minutes`

Format: `Number`

Expand All @@ -51,7 +49,7 @@ Number of minutes for which a person at the thermostat can change the thermostat

---

#### `name`
### `name`

Format: `String`

Expand All @@ -60,7 +58,7 @@ User-friendly name to identify the thermostat schedule.

---

#### `starts_at`
### `starts_at`

Format: `Datetime`

Expand All @@ -69,7 +67,7 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www

---

#### `thermostat_schedule_id`
### `thermostat_schedule_id`

Format: `ID`

Expand Down
18 changes: 8 additions & 10 deletions docs/api/user_identities/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

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.

### Properties

#### `created_at`
### `created_at`

Format: `Datetime`

Expand All @@ -15,14 +13,14 @@ Date and time at which the user identity was created.

---

#### `display_name`
### `display_name`

Format: `String`


---

#### `email_address`
### `email_address`

Format: `String`

Expand All @@ -31,14 +29,14 @@ Unique email address for the user identity.

---

#### `full_name`
### `full_name`

Format: `String`


---

#### `phone_number`
### `phone_number`

Format: `String`

Expand All @@ -47,7 +45,7 @@ Unique phone number for the user identity in [E.164 format](https://www.itu.int/

---

#### `user_identity_id`
### `user_identity_id`

Format: `ID`

Expand All @@ -56,7 +54,7 @@ ID of the user identity.

---

#### `user_identity_key`
### `user_identity_key`

Format: `String`

Expand All @@ -65,7 +63,7 @@ Unique key for the user identity.

---

#### `workspace_id`
### `workspace_id`

Format: `ID`

Expand Down
12 changes: 5 additions & 7 deletions docs/api/user_identities/enrollment_automations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).

### Properties

#### `created_at`
### `created_at`

Format: `Datetime`

Expand All @@ -15,7 +13,7 @@ Date and time at which the enrollment automation was created.

---

#### `credential_manager_acs_system_id`
### `credential_manager_acs_system_id`

Format: `ID`

Expand All @@ -24,7 +22,7 @@ ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/

---

#### `enrollment_automation_id`
### `enrollment_automation_id`

Format: `ID`

Expand All @@ -33,7 +31,7 @@ ID of the enrollment automation.

---

#### `user_identity_id`
### `user_identity_id`

Format: `ID`

Expand All @@ -42,7 +40,7 @@ ID of the associated [user identity](https://docs.seam.co/latest/capability-guid

---

#### `workspace_id`
### `workspace_id`

Format: `ID`

Expand Down

0 comments on commit 1a1e172

Please sign in to comment.