Skip to content

Commit 370aae0

Browse files
seambotseambot
committed
ci: Generate docs
1 parent 7ebb21e commit 370aae0

5 files changed

Lines changed: 156 additions & 107 deletions

File tree

‎docs/api/acs/credentials/README.md‎

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,18 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
7878
<details>
7979
<summary>Child Properties</summary>
8080

81-
<strong><code>auto_join</code></strong> <i>Boolean</i>
82-
<strong><code>door_names</code></strong> <i>List</i> <i>of Strings</i>
83-
<strong><code>endpoint_id</code></strong> <i>String</i>
84-
<strong><code>key_id</code></strong> <i>String</i>
85-
<strong><code>key_issuing_request_id</code></strong> <i>String</i>
86-
<strong><code>override_guest_acs_entrance_ids</code></strong> <i>List</i> <i>of Strings</i>
81+
- <strong><code>auto_join</code></strong> <i>Boolean</i>
82+
83+
- <strong><code>door_names</code></strong> <i>List</i> <i>of Strings</i>
84+
85+
- <strong><code>endpoint_id</code></strong> <i>String</i>
86+
87+
- <strong><code>key_id</code></strong> <i>String</i>
88+
89+
- <strong><code>key_issuing_request_id</code></strong> <i>String</i>
90+
91+
- <strong><code>override_guest_acs_entrance_ids</code></strong> <i>List</i> <i>of Strings</i>
92+
8793
</details>
8894

8995
---
@@ -268,20 +274,28 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
268274
<details>
269275
<summary>Child Properties</summary>
270276

271-
<strong><code>auto_join</code></strong> <i>Boolean</i>
272-
<strong><code>card_function_type</code></strong> <i>Enum</i>
273-
<details>
274-
<summary>Enum values:</summary>
275-
276-
- <code>guest`</code>
277-
- <code>staff`</code>
278-
</details>
279-
<strong><code>card_id</code></strong> <i>String</i>
280-
<strong><code>common_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
281-
<strong><code>credential_id</code></strong> <i>String</i>
282-
<strong><code>guest_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
283-
<strong><code>is_valid</code></strong> <i>Boolean</i>
284-
<strong><code>joiner_acs_credential_ids</code></strong> <i>List</i> <i>of UUIDs</i>
277+
- <strong><code>auto_join</code></strong> <i>Boolean</i>
278+
279+
- <strong><code>card_function_type</code></strong> <i>Enum</i>
280+
<details>
281+
<summary>Enum values:</summary>
282+
283+
- <code>guest`</code>
284+
- <code>staff`</code>
285+
</details>
286+
287+
- <strong><code>card_id</code></strong> <i>String</i>
288+
289+
- <strong><code>common_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
290+
291+
- <strong><code>credential_id</code></strong> <i>String</i>
292+
293+
- <strong><code>guest_acs_entrance_ids</code></strong> <i>List</i> <i>of UUIDs</i>
294+
295+
- <strong><code>is_valid</code></strong> <i>Boolean</i>
296+
297+
- <strong><code>joiner_acs_credential_ids</code></strong> <i>List</i> <i>of UUIDs</i>
298+
285299
</details>
286300

287301
---

‎docs/api/acs/entrances/README.md‎

Lines changed: 78 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,24 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
4343
<details>
4444
<summary>Child Properties</summary>
4545

46-
<strong><code>door_name</code></strong> <i>String</i>
47-
<strong><code>door_number</code></strong> <i>Number</i>
48-
<strong><code>door_type</code></strong> <i>Enum</i>
49-
<details>
50-
<summary>Enum values:</summary>
51-
52-
- <code>CommonDoor`</code>
53-
- <code>EntranceDoor`</code>
54-
- <code>GuestDoor`</code>
55-
- <code>Elevator`</code>
56-
</details>
57-
<strong><code>pms_id</code></strong> <i>String</i>
58-
<strong><code>stand_open</code></strong> <i>Boolean</i>
46+
- <strong><code>door_name</code></strong> <i>String</i>
47+
48+
- <strong><code>door_number</code></strong> <i>Number</i>
49+
50+
- <strong><code>door_type</code></strong> <i>Enum</i>
51+
<details>
52+
<summary>Enum values:</summary>
53+
54+
- <code>CommonDoor`</code>
55+
- <code>EntranceDoor`</code>
56+
- <code>GuestDoor`</code>
57+
- <code>Elevator`</code>
58+
</details>
59+
60+
- <strong><code>pms_id</code></strong> <i>String</i>
61+
62+
- <strong><code>stand_open</code></strong> <i>Boolean</i>
63+
5964
</details>
6065

6166
---
@@ -87,7 +92,8 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
8792
<details>
8893
<summary>Child Properties</summary>
8994

90-
<strong><code>access_point_name</code></strong> <i>String</i>
95+
- <strong><code>access_point_name</code></strong> <i>String</i>
96+
9197
</details>
9298

9399
---
@@ -121,10 +127,14 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
121127
<details>
122128
<summary>Child Properties</summary>
123129

124-
<strong><code>accessibility_type</code></strong> <i>String</i>
125-
<strong><code>door_name</code></strong> <i>String</i>
126-
<strong><code>door_type</code></strong> <i>String</i>
127-
<strong><code>is_connected</code></strong> <i>Boolean</i>
130+
- <strong><code>accessibility_type</code></strong> <i>String</i>
131+
132+
- <strong><code>door_name</code></strong> <i>String</i>
133+
134+
- <strong><code>door_type</code></strong> <i>String</i>
135+
136+
- <strong><code>is_connected</code></strong> <i>Boolean</i>
137+
128138
</details>
129139

130140
---
@@ -138,14 +148,22 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
138148
<details>
139149
<summary>Child Properties</summary>
140150

141-
<strong><code>battery_level</code></strong> <i>String</i>
142-
<strong><code>door_name</code></strong> <i>String</i>
143-
<strong><code>intrusion_alarm</code></strong> <i>Boolean</i>
144-
<strong><code>left_open_alarm</code></strong> <i>Boolean</i>
145-
<strong><code>lock_type</code></strong> <i>String</i>
146-
<strong><code>locked_state</code></strong> <i>String</i>
147-
<strong><code>online</code></strong> <i>Boolean</i>
148-
<strong><code>privacy_mode</code></strong> <i>Boolean</i>
151+
- <strong><code>battery_level</code></strong> <i>String</i>
152+
153+
- <strong><code>door_name</code></strong> <i>String</i>
154+
155+
- <strong><code>intrusion_alarm</code></strong> <i>Boolean</i>
156+
157+
- <strong><code>left_open_alarm</code></strong> <i>Boolean</i>
158+
159+
- <strong><code>lock_type</code></strong> <i>String</i>
160+
161+
- <strong><code>locked_state</code></strong> <i>String</i>
162+
163+
- <strong><code>online</code></strong> <i>Boolean</i>
164+
165+
- <strong><code>privacy_mode</code></strong> <i>Boolean</i>
166+
149167
</details>
150168

151169
---
@@ -159,9 +177,12 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
159177
<details>
160178
<summary>Child Properties</summary>
161179

162-
<strong><code>door_description</code></strong> <i>String</i>
163-
<strong><code>door_name</code></strong> <i>String</i>
164-
<strong><code>ext_door_id</code></strong> <i>String</i>
180+
- <strong><code>door_description</code></strong> <i>String</i>
181+
182+
- <strong><code>door_name</code></strong> <i>String</i>
183+
184+
- <strong><code>ext_door_id</code></strong> <i>String</i>
185+
165186
</details>
166187

167188
---
@@ -175,31 +196,34 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
175196
<details>
176197
<summary>Child Properties</summary>
177198

178-
<strong><code>door_category</code></strong> <i>Enum</i>
179-
<details>
180-
<summary>Enum values:</summary>
181-
182-
- <code>entrance`</code>
183-
- <code>guest`</code>
184-
- <code>elevator reader`</code>
185-
- <code>common`</code>
186-
- <code>common (PMS)`</code>
187-
</details>
188-
<strong><code>door_name</code></strong> <i>String</i>
189-
<strong><code>profiles</code></strong> <i>List</i> <i>of Objects</i>
190-
191-
- <strong><code>visionline_door_profile_id</code></strong> <i>String</i>
192-
193-
194-
- <strong><code>visionline_door_profile_type</code></strong> <i>Enum</i>
195-
<details>
196-
<summary>Enum values:</summary>
197-
198-
- <code>BLE`</code>
199-
- <code>commonDoor`</code>
200-
- <code>touch`</code>
201-
</details>
202-
199+
- <strong><code>door_category</code></strong> <i>Enum</i>
200+
<details>
201+
<summary>Enum values:</summary>
202+
203+
- <code>entrance`</code>
204+
- <code>guest`</code>
205+
- <code>elevator reader`</code>
206+
- <code>common`</code>
207+
- <code>common (PMS)`</code>
208+
</details>
209+
210+
- <strong><code>door_name</code></strong> <i>String</i>
211+
212+
- <strong><code>profiles</code></strong> <i>List</i> <i>of Objects</i>
213+
214+
- <strong><code>visionline_door_profile_id</code></strong> <i>String</i>
215+
216+
217+
- <strong><code>visionline_door_profile_type</code></strong> <i>Enum</i>
218+
<details>
219+
<summary>Enum values:</summary>
220+
221+
- <code>BLE`</code>
222+
- <code>commonDoor`</code>
223+
- <code>touch`</code>
224+
</details>
225+
226+
203227
</details>
204228

205229
---

‎docs/api/acs/systems/README.md‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -421,9 +421,10 @@ Indicates whether the `acs_system` is a credential manager.
421421
<details>
422422
<summary>Child Properties</summary>
423423

424-
<strong><code>time_zone</code></strong> <i>String</i>
425-
426-
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
424+
- <strong><code>time_zone</code></strong> <i>String</i>
425+
426+
Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
427+
427428
</details>
428429

429430
---
@@ -484,15 +485,18 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
484485
<details>
485486
<summary>Child Properties</summary>
486487

487-
<strong><code>lan_address</code></strong> <i>String</i>
488-
489-
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
490-
<strong><code>mobile_access_uuid</code></strong> <i>String</i>
491-
492-
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
493-
<strong><code>system_id</code></strong> <i>String</i>
494-
495-
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
488+
- <strong><code>lan_address</code></strong> <i>String</i>
489+
490+
IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
491+
492+
- <strong><code>mobile_access_uuid</code></strong> <i>String</i>
493+
494+
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
495+
496+
- <strong><code>system_id</code></strong> <i>String</i>
497+
498+
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
499+
496500
</details>
497501

498502
---

‎docs/api/acs/users/README.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,14 @@ For details about how to configure `acs_user`s in your access control system, se
2727
<details>
2828
<summary>Child Properties</summary>
2929

30-
<strong><code>ends_at</code></strong> <i>Datetime</i>
31-
32-
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.
33-
<strong><code>starts_at</code></strong> <i>Datetime</i>
34-
35-
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.
30+
- <strong><code>ends_at</code></strong> <i>Datetime</i>
31+
32+
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.
33+
34+
- <strong><code>starts_at</code></strong> <i>Datetime</i>
35+
36+
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.
37+
3638
</details>
3739

3840
---

‎docs/api/connected_accounts/README.md‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -316,21 +316,26 @@ User identifier associated with the connected account.
316316
<details>
317317
<summary>Child Properties</summary>
318318

319-
<strong><code>api_url</code></strong> <i>String</i>
320-
321-
API URL for the user identifier associated with the connected account.
322-
<strong><code>email</code></strong> <i>String</i>
323-
324-
Email address of the user identifier associated with the connected account.
325-
<strong><code>exclusive</code></strong> <i>Boolean</i>
326-
327-
Indicates whether the user identifier associated with the connected account is exclusive.
328-
<strong><code>phone</code></strong> <i>String</i>
329-
330-
Phone number of the user identifier associated with the connected account.
331-
<strong><code>username</code></strong> <i>String</i>
332-
333-
Username of the user identifier associated with the connected account.
319+
- <strong><code>api_url</code></strong> <i>String</i>
320+
321+
API URL for the user identifier associated with the connected account.
322+
323+
- <strong><code>email</code></strong> <i>String</i>
324+
325+
Email address of the user identifier associated with the connected account.
326+
327+
- <strong><code>exclusive</code></strong> <i>Boolean</i>
328+
329+
Indicates whether the user identifier associated with the connected account is exclusive.
330+
331+
- <strong><code>phone</code></strong> <i>String</i>
332+
333+
Phone number of the user identifier associated with the connected account.
334+
335+
- <strong><code>username</code></strong> <i>String</i>
336+
337+
Username of the user identifier associated with the connected account.
338+
334339
</details>
335340

336341
---

0 commit comments

Comments
 (0)