Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
00d1359
switch child prop to html <ul>
mikewuu Jun 4, 2025
876fb61
ci: Generate docs
seambot Jun 4, 2025
0cef1f4
Merge branch 'main' into child-prop-paragraph
razor-x Jun 4, 2025
7cff73c
Remove example value placeholders (#629)
razor-x Jun 4, 2025
8f3ae59
Update SUMMARY with generate_instant_key (#630)
razor-x Jun 5, 2025
227c56f
GITBOOK-603: No subject
razor-x Jun 5, 2025
e64aa49
Add generation for connected accounts (#631)
DebbieAtSeam Jun 6, 2025
857b45e
GITBOOK-602: Add SmartThings thermostats guides
DebbieAtSeam Jun 6, 2025
bdffe63
Move SmartThings + devices in SUMMARY.md (#632)
DebbieAtSeam Jun 6, 2025
94be859
GITBOOK-606: Add SmartThings links
DebbieAtSeam Jun 6, 2025
e754c98
Move SmartThings topic (#633)
DebbieAtSeam Jun 6, 2025
a216d4d
GITBOOK-605: Change ACS quick starts to use user identities
DebbieAtSeam Jun 6, 2025
a74a0c1
GITBOOK-607: Delete duplicate bullet
DebbieAtSeam Jun 9, 2025
5a22532
remove ul wrap
mikewuu Jun 10, 2025
ffa5d39
ci: Generate docs
seambot Jun 10, 2025
d2f31cb
Merge branch 'main' into child-prop-paragraph
mikewuu Jun 10, 2025
7ebb21e
make it a list
mikewuu Jun 10, 2025
370aae0
ci: Generate docs
seambot Jun 10, 2025
bda6440
nest description
mikewuu Jun 10, 2025
c3b25bf
ci: Generate docs
seambot Jun 10, 2025
8c4e741
only nest list
mikewuu Jun 10, 2025
3f66375
ci: Generate docs
seambot Jun 10, 2025
6a47172
revert nested
mikewuu Jun 10, 2025
b568cf8
Revert "revert nested"
mikewuu Jun 10, 2025
d1587d7
remove islist
mikewuu Jun 10, 2025
726c4d8
ci: Generate docs
seambot Jun 10, 2025
5731680
only nest list
mikewuu Jun 10, 2025
472dce8
ci: Generate docs
seambot Jun 10, 2025
3bbff22
add islist prop
mikewuu Jun 10, 2025
a4dcfba
ci: Generate docs
seambot Jun 10, 2025
859caca
add is list prop to api-resource
mikewuu Jun 10, 2025
85f5c18
ci: Generate docs
seambot Jun 10, 2025
e3019f7
remove extra code block
mikewuu Jun 10, 2025
34f4df5
ci: Generate docs
seambot Jun 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/acs/access_groups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Warnings associated with the `acs_access_group`.
<details>
<summary>Enum values:</summary>

- <code>unknown_issue_with_acs_access_group`</code>
- <code>unknown_issue_with_acs_access_group</code>
</details>
</details>

Expand Down
12 changes: 6 additions & 6 deletions docs/api/acs/credentials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,12 +277,12 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
- <strong><code>auto_join</code></strong> <i>Boolean</i>

- <strong><code>card_function_type</code></strong> <i>Enum</i>
<details>
<summary>Enum values:</summary>

- <code>guest`</code>
- <code>staff`</code>
</details>
<details>
<summary>Enum values:</summary>
- <code>guest</code>
- <code>staff</code>
</details>

- <strong><code>card_id</code></strong> <i>String</i>

Expand Down
2 changes: 1 addition & 1 deletion docs/api/acs/encoders/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
<details>
<summary>Enum values:</summary>

- <code>acs_encoder_removed`</code>
- <code>acs_encoder_removed</code>
</details>

<strong><code>message</code></strong> <i>String</i>
Expand Down
40 changes: 20 additions & 20 deletions docs/api/acs/entrances/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
- <strong><code>door_number</code></strong> <i>Number</i>

- <strong><code>door_type</code></strong> <i>Enum</i>
<details>
<summary>Enum values:</summary>

- <code>CommonDoor`</code>
- <code>EntranceDoor`</code>
- <code>GuestDoor`</code>
- <code>Elevator`</code>
</details>
<details>
<summary>Enum values:</summary>
- <code>CommonDoor</code>
- <code>EntranceDoor</code>
- <code>GuestDoor</code>
- <code>Elevator</code>
</details>

- <strong><code>pms_id</code></strong> <i>String</i>

Expand Down Expand Up @@ -197,15 +197,15 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
<summary>Child Properties</summary>

- <strong><code>door_category</code></strong> <i>Enum</i>
<details>
<summary>Enum values:</summary>

- <code>entrance`</code>
- <code>guest`</code>
- <code>elevator reader`</code>
- <code>common`</code>
- <code>common (PMS)`</code>
</details>
<details>
<summary>Enum values:</summary>
- <code>entrance</code>
- <code>guest</code>
- <code>elevator reader</code>
- <code>common</code>
- <code>common (PMS)</code>
</details>

- <strong><code>door_name</code></strong> <i>String</i>

Expand All @@ -218,9 +218,9 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
<details>
<summary>Enum values:</summary>

- <code>BLE`</code>
- <code>commonDoor`</code>
- <code>touch`</code>
- <code>BLE</code>
- <code>commonDoor</code>
- <code>touch</code>
</details>


Expand Down
16 changes: 8 additions & 8 deletions docs/api/acs/systems/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,8 +422,8 @@ Indicates whether the `acs_system` is a credential manager.
<summary>Child Properties</summary>

- <strong><code>time_zone</code></strong> <i>String</i>

Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.

</details>

Expand Down Expand Up @@ -486,16 +486,16 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
<summary>Child Properties</summary>

- <strong><code>lan_address</code></strong> <i>String</i>

IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.

- <strong><code>mobile_access_uuid</code></strong> <i>String</i>

Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.

- <strong><code>system_id</code></strong> <i>String</i>

Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.

</details>

Expand Down
16 changes: 8 additions & 8 deletions docs/api/acs/users/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ For details about how to configure `acs_user`s in your access control system, se
<summary>Child Properties</summary>

- <strong><code>ends_at</code></strong> <i>Datetime</i>

Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

- <strong><code>starts_at</code></strong> <i>Datetime</i>

Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

</details>

Expand Down Expand Up @@ -611,8 +611,8 @@ Seam is in the process of pushing an access group membership update to the integ
Child Properties

- <strong><code>acs_access_group_id</code></strong> <i>UUID</i>

Old access group ID.
Old access group ID.


---
Expand Down Expand Up @@ -643,8 +643,8 @@ Seam is in the process of pushing an access group membership update to the integ
Child Properties

- <strong><code>acs_access_group_id</code></strong> <i>UUID</i>

New access group ID.
New access group ID.


</details>
Expand Down
28 changes: 14 additions & 14 deletions docs/api/connected_accounts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,8 @@ Indicates that the maximum number of users allowed for the site has been reached
Child Properties

- <strong><code>sites</code></strong> <i>List</i> <i>of Objects</i>

Salto sites associated with the connected account that has an error.
Salto sites associated with the connected account that has an error.

- <strong><code>site_id</code></strong> <i>String</i>

Expand Down Expand Up @@ -317,24 +317,24 @@ User identifier associated with the connected account.
<summary>Child Properties</summary>

- <strong><code>api_url</code></strong> <i>String</i>

API URL for the user identifier associated with the connected account.
API URL for the user identifier associated with the connected account.

- <strong><code>email</code></strong> <i>String</i>

Email address of the user identifier associated with the connected account.
Email address of the user identifier associated with the connected account.

- <strong><code>exclusive</code></strong> <i>Boolean</i>

Indicates whether the user identifier associated with the connected account is exclusive.
Indicates whether the user identifier associated with the connected account is exclusive.

- <strong><code>phone</code></strong> <i>String</i>

Phone number of the user identifier associated with the connected account.
Phone number of the user identifier associated with the connected account.

- <strong><code>username</code></strong> <i>String</i>

Username of the user identifier associated with the connected account.
Username of the user identifier associated with the connected account.

</details>

Expand Down Expand Up @@ -443,8 +443,8 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow
Child Properties

- <strong><code>sites</code></strong> <i>List</i> <i>of Objects</i>

Salto sites associated with the connected account that has a warning.
Salto sites associated with the connected account that has a warning.

- <strong><code>site_id</code></strong> <i>String</i>

Expand Down
18 changes: 9 additions & 9 deletions docs/api/thermostats/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad
<details>
<summary>Enum values:</summary>

- <code>auto`</code>
- <code>on`</code>
- <code>circulate`</code>
- <code>auto</code>
- <code>on</code>
- <code>circulate</code>
</details>

<strong><code>heating_set_point_celsius</code></strong> <i>Number</i>
Expand All @@ -115,10 +115,10 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad
<details>
<summary>Enum values:</summary>

- <code>off`</code>
- <code>heat`</code>
- <code>cool`</code>
- <code>heat_cool`</code>
- <code>off</code>
- <code>heat</code>
- <code>cool</code>
- <code>heat_cool</code>
</details>

<strong><code>method</code></strong> <i>Enum</i>
Expand All @@ -127,8 +127,8 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad
<details>
<summary>Enum values:</summary>

- <code>seam`</code>
- <code>external`</code>
- <code>seam</code>
- <code>external</code>
</details>

<strong><code>occurred_at</code></strong> <i>Datetime</i>
Expand Down
2 changes: 1 addition & 1 deletion src/layouts/partials/api-resource.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ This object has no properties.
<summary>Child Properties</summary>

{{#each objectProperties}}
- {{> property-nested this}}
- {{> property-nested this isList=true}}
{{/each}}
</details>
{{/if}}
Expand Down
2 changes: 1 addition & 1 deletion src/layouts/partials/property-content.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This object has no properties.
Child Properties

{{#each objectProperties}}
- {{> property-nested this}}
- {{> property-nested this isList=true }}
{{/each}}
{{/if}}
{{/unless}}
2 changes: 1 addition & 1 deletion src/layouts/partials/property-nested-internal.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<summary>Enum values:</summary>

{{#each enumValues}}
- <code>{{this}}`</code>
- <code>{{this}}</code>
{{/each}}
</details>
{{/if}}
Expand Down
4 changes: 4 additions & 0 deletions src/layouts/partials/property-nested.hbs
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<strong><code>{{name}}</code></strong> <i>{{format}}</i>{{#if listItemFormat}} <i>of {{listItemFormat}}s</i>{{/if}}
{{#if isList}}
{{> property-nested-internal}}
{{else}}
{{> property-nested-internal}}
{{/if}}
{{#if listProperties}}
{{#each listProperties}}

Expand Down
Loading