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 1, 2024
1 parent 0ca1215 commit 467d4b0
Show file tree
Hide file tree
Showing 5 changed files with 0 additions and 888 deletions.
2 changes: 0 additions & 2 deletions docs/api/access-control-systems/README.md

This file was deleted.

350 changes: 0 additions & 350 deletions docs/api/acs/access_groups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,356 +119,6 @@ Format: `ID`
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group.


---

## `acs_entrance`

### Properties

#### `acs_entrance_id`

Format: `ID`

ID of the entrance.


---

#### `acs_system_id`

Format: `ID`

ID of the access control system that contains the entrance.


---

#### `assa_abloy_vostio_metadata`

Format: `Object`

<details>
<summary>door_name <code>string</code></summary>
</details>
<details>
<summary>door_number <code>number</code></summary>
</details>
<details>
<summary>door_type <code>enum</code></summary>
</details>
<details>
<summary>pms_id <code>string</code></summary>
</details>
<details>
<summary>stand_open <code>boolean</code></summary>
</details>

---

#### `created_at`

Format: `Datetime`

Date and time at which the entrance was created.


---

#### `display_name`

Format: `String`

Display name for the entrance.


---

#### `dormakaba_community_metadata`

Format: `Object`

<details>
<summary>access_point_name <code>string</code></summary>
</details>

---

#### `errors`

Format: `List`


---

#### `latch_metadata`

Format: `Object`

<details>
<summary>accessibility_type <code>string</code></summary>
</details>
<details>
<summary>door_name <code>string</code></summary>
</details>
<details>
<summary>door_type <code>string</code></summary>
</details>
<details>
<summary>is_connected <code>boolean</code></summary>
</details>

---

#### `salto_ks_metadata`

Format: `Object`

<details>
<summary>battery_level <code>string</code></summary>
</details>
<details>
<summary>door_name <code>string</code></summary>
</details>
<details>
<summary>intrusion_alarm <code>boolean</code></summary>
</details>
<details>
<summary>left_open_alarm <code>boolean</code></summary>
</details>
<details>
<summary>lock_type <code>string</code></summary>
</details>
<details>
<summary>locked_state <code>string</code></summary>
</details>
<details>
<summary>online <code>boolean</code></summary>
</details>
<details>
<summary>privacy_mode <code>boolean</code></summary>
</details>

---

#### `visionline_metadata`

Format: `Object`

<details>
<summary>door_category <code>enum</code></summary>
</details>
<details>
<summary>door_name <code>string</code></summary>
</details>
<details>
<summary>profiles <code>list</code></summary>
</details>

---

## `acs_user`

### Properties

#### `access_schedule`

Format: `Object`

`starts_at` and `ends_at` timestamps for the `acs_user`'s access.

<details>
<summary>ends_at <code>datetime</code></summary>
</details>
<details>
<summary>starts_at <code>datetime</code></summary>
</details>

---

#### `acs_system_id`

Format: `ID`

ID of the access control system that contains the `acs_user`.


---

#### `acs_user_id`

Format: `ID`

ID of the `acs_user`.


---

#### `created_at`

Format: `Datetime`

Date and time at which the `acs_user` was created.


---

#### `display_name`

Format: `String`

Display name for the `acs_user`.


---

#### `email`

{% hint style="warning" %}
**Deprecated**. use email_address.
{% endhint %}

Format: `String`


---

#### `email_address`

Format: `String`

Email address of the `acs_user`.


---

#### `errors`

Format: `List`

Errors associated with the `acs_user`.


---

#### `external_type`

Format: `Enum`

Brand-specific terminology for the `acs_user` type.

Possible enum values:
- `pti_user`
- `brivo_user`
- `hid_credential_manager_user`
- `salto_site_user`
- `latch_user`
- `dormakaba_community_user`


---

#### `external_type_display_name`

Format: `String`

Display name that corresponds to the brand-specific terminology for the `acs_user` type.


---

#### `full_name`

Format: `String`

Full name of the `acs_user`.


---

#### `hid_acs_system_id`

Format: `ID`


---

#### `is_managed`

Format: `Boolean`


---

#### `is_suspended`

Format: `Boolean`

Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).


---

#### `phone_number`

Format: `String`

Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).


---

#### `user_identity_email_address`

Format: `String`

Email address of the user identity associated with the `acs_user`.


---

#### `user_identity_full_name`

Format: `String`

Full name of the user identity associated with the `acs_user`.


---

#### `user_identity_id`

Format: `String`

ID of the user identity associated with the `acs_user`.


---

#### `user_identity_phone_number`

Format: `String`

Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).


---

#### `warnings`

Format: `List`

Warnings associated with the `acs_user`.


---

#### `workspace_id`

Format: `ID`

ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the `acs_user`.


---

## Endpoints
Expand Down
Loading

0 comments on commit 467d4b0

Please sign in to comment.