Skip to content

Commit 4426556

Browse files
committed
ci: Generate docs
1 parent 7e56ac3 commit 4426556

File tree

4 files changed

+137
-0
lines changed

4 files changed

+137
-0
lines changed

docs/api/acs/encoders/encode_credential.md

+44
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,18 @@ Date and time at which the [credential](../../../capability-guides/access-system
212212

213213
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
214214

215+
216+
<details>
217+
218+
<summary><code>error_code</code> Format: <code>String</code></summary>
219+
220+
</details>
221+
222+
<details>
223+
224+
<summary><code>message</code> Format: <code>String</code></summary>
225+
226+
</details>
215227
</details>
216228

217229
<details>
@@ -375,6 +387,38 @@ Possible enum values:
375387

376388
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
377389

390+
391+
<details>
392+
393+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
394+
395+
Date and time at which Seam created the warning.
396+
397+
</details>
398+
399+
<details>
400+
401+
<summary><code>message</code> Format: <code>String</code></summary>
402+
403+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
404+
405+
</details>
406+
407+
<details>
408+
409+
<summary><code>warning_code</code> Format: <code>Enum</code></summary>
410+
411+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
412+
413+
Possible enum values:
414+
- `waiting_to_be_issued`
415+
- `schedule_externally_modified`
416+
- `schedule_modified`
417+
- `being_deleted`
418+
- `unknown_issue_with_acs_credential`
419+
- `needs_to_be_reissued`
420+
421+
</details>
378422
</details>
379423

380424
<details>

docs/api/acs/encoders/scan_credential.md

+60
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,18 @@ Date and time at which the [credential](../../../capability-guides/access-system
361361

362362
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
363363

364+
365+
<details>
366+
367+
<summary><code>error_code</code> Format: <code>String</code></summary>
368+
369+
</details>
370+
371+
<details>
372+
373+
<summary><code>message</code> Format: <code>String</code></summary>
374+
375+
</details>
364376
</details>
365377

366378
<details>
@@ -524,6 +536,38 @@ Possible enum values:
524536

525537
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
526538

539+
540+
<details>
541+
542+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
543+
544+
Date and time at which Seam created the warning.
545+
546+
</details>
547+
548+
<details>
549+
550+
<summary><code>message</code> Format: <code>String</code></summary>
551+
552+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
553+
554+
</details>
555+
556+
<details>
557+
558+
<summary><code>warning_code</code> Format: <code>Enum</code></summary>
559+
560+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
561+
562+
Possible enum values:
563+
- `waiting_to_be_issued`
564+
- `schedule_externally_modified`
565+
- `schedule_modified`
566+
- `being_deleted`
567+
- `unknown_issue_with_acs_credential`
568+
- `needs_to_be_reissued`
569+
570+
</details>
527571
</details>
528572

529573
<details>
@@ -538,6 +582,22 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains
538582

539583
<summary><code>warnings</code> Format: <code>List</code> Item format: <code>Object</code></summary>
540584

585+
586+
<details>
587+
588+
<summary><code>warning_code</code> Format: <code>Enum</code></summary>
589+
590+
Possible enum values:
591+
- `acs_credential_on_encoder_out_of_sync`
592+
- `acs_credential_on_seam_not_found`
593+
594+
</details>
595+
596+
<details>
597+
598+
<summary><code>warning_message</code> Format: <code>String</code></summary>
599+
600+
</details>
541601
</details>
542602

543603
---

docs/api/acs/entrances/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,23 @@ Possible enum values:
263263

264264
<summary><code>profiles</code> Format: <code>List</code> Item format: <code>Object</code></summary>
265265

266+
267+
<details>
268+
269+
<summary><code>visionline_door_profile_id</code> Format: <code>String</code></summary>
270+
271+
</details>
272+
273+
<details>
274+
275+
<summary><code>visionline_door_profile_type</code> Format: <code>Enum</code></summary>
276+
277+
Possible enum values:
278+
- `BLE`
279+
- `commonDoor`
280+
- `touch`
281+
282+
</details>
266283
</details>
267284

268285
---

docs/api/phones/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,22 @@ ASSA ABLOY Credential Service metadata for the phone.
9898

9999
Endpoints associated with the phone.
100100

101+
102+
<details>
103+
104+
<summary><code>endpoint_id</code> Format: <code>String</code></summary>
105+
106+
ID of the associated endpoint.
107+
108+
</details>
109+
110+
<details>
111+
112+
<summary><code>is_active</code> Format: <code>Boolean</code></summary>
113+
114+
Indicated whether the endpoint is active.
115+
116+
</details>
101117
</details>
102118

103119
<details>

0 commit comments

Comments
 (0)