Skip to content

Commit 6d58d27

Browse files
committed
ci: Generate docs
1 parent 8625455 commit 6d58d27

12 files changed

Lines changed: 1240 additions & 1240 deletions

File tree

docs/api/access_codes/README.md

Lines changed: 459 additions & 459 deletions
Large diffs are not rendered by default.

docs/api/access_codes/unmanaged/README.md

Lines changed: 455 additions & 455 deletions
Large diffs are not rendered by default.

docs/api/acs/access_groups/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ To learn whether your access control system supports access groups, see the corr
4848

4949
<details>
5050
<summary>Enum values</summary>
51-
- `pti_unit`
52-
- `pti_access_level`
53-
- `salto_ks_access_group`
54-
- `brivo_group`
55-
- `salto_space_group`
56-
- `dormakaba_community_access_group`
51+
- <code>pti_unit</code>
52+
- <code>pti_access_level</code>
53+
- <code>salto_ks_access_group</code>
54+
- <code>brivo_group</code>
55+
- <code>salto_space_group</code>
56+
- <code>dormakaba_community_access_group</code>
5757
</details>
5858

5959

@@ -112,12 +112,12 @@ Brand-specific terminology for the access group type.
112112

113113
<details>
114114
<summary>Enum values</summary>
115-
- `pti_unit`
116-
- `pti_access_level`
117-
- `salto_ks_access_group`
118-
- `brivo_group`
119-
- `salto_space_group`
120-
- `dormakaba_community_access_group`
115+
- <code>pti_unit</code>
116+
- <code>pti_access_level</code>
117+
- <code>salto_ks_access_group</code>
118+
- <code>brivo_group</code>
119+
- <code>salto_space_group</code>
120+
- <code>dormakaba_community_access_group</code>
121121
</details>
122122

123123

@@ -168,7 +168,7 @@ Warnings associated with the `acs_access_group`.
168168
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
169169
<details>
170170
<summary>Enum values:</summary>
171-
- `unknown_issue_with_acs_access_group`
171+
- <code>unknown_issue_with_acs_access_group`</code>
172172
</details>
173173
</details>
174174

docs/api/acs/credentials/README.md

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Access method for the [credential](../../../capability-guides/access-systems/man
6060

6161
<details>
6262
<summary>Enum values</summary>
63-
- `code`
64-
- `card`
65-
- `mobile_key`
63+
- <code>code</code>
64+
- <code>card</code>
65+
- <code>mobile_key</code>
6666
</details>
6767

6868

@@ -193,14 +193,14 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces
193193

194194
<details>
195195
<summary>Enum values</summary>
196-
- `pti_card`
197-
- `brivo_credential`
198-
- `hid_credential`
199-
- `visionline_card`
200-
- `salto_ks_credential`
201-
- `assa_abloy_vostio_key`
202-
- `salto_space_key`
203-
- `latch_access`
196+
- <code>pti_card</code>
197+
- <code>brivo_credential</code>
198+
- <code>hid_credential</code>
199+
- <code>visionline_card</code>
200+
- <code>salto_ks_credential</code>
201+
- <code>assa_abloy_vostio_key</code>
202+
- <code>salto_space_key</code>
203+
- <code>latch_access</code>
204204
</details>
205205

206206

@@ -308,8 +308,8 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
308308
- <strong><code>card_function_type</code></strong> <i>Enum</i>
309309
<details>
310310
<summary>Enum values:</summary>
311-
- `guest`
312-
- `staff`
311+
- <code>guest`</code>
312+
- <code>staff`</code>
313313
</details>
314314

315315
- <strong><code>card_id</code></strong> <i>String</i>
@@ -342,30 +342,30 @@ Variants:
342342
<summary><code>waiting_to_be_issued</code></summary>
343343

344344
Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
345-
**`created_at`**
346-
Format: `Datetime`
345+
346+
**`created_at`** Format: `Datetime`
347347

348348

349349
Date and time at which Seam created the warning.
350350

351351

352352
---
353-
**`message`**
354-
Format: `String`
353+
354+
**`message`** Format: `String`
355355

356356

357357
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
358358

359359

360360
---
361-
**`warning_code`**
362-
Format: `Enum`
361+
362+
**`warning_code`** Format: `Enum`
363363

364364

365365
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
366366
<details>
367367
<summary>Enum values:</summary>
368-
- `waiting_to_be_issued`
368+
- <code>waiting_to_be_issued</code>
369369
</details>
370370

371371

@@ -374,30 +374,30 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi
374374
<summary><code>schedule_externally_modified</code></summary>
375375

376376
Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
377-
**`created_at`**
378-
Format: `Datetime`
377+
378+
**`created_at`** Format: `Datetime`
379379

380380

381381
Date and time at which Seam created the warning.
382382

383383

384384
---
385-
**`message`**
386-
Format: `String`
385+
386+
**`message`** Format: `String`
387387

388388

389389
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
390390

391391

392392
---
393-
**`warning_code`**
394-
Format: `Enum`
393+
394+
**`warning_code`** Format: `Enum`
395395

396396

397397
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
398398
<details>
399399
<summary>Enum values:</summary>
400-
- `schedule_externally_modified`
400+
- <code>schedule_externally_modified</code>
401401
</details>
402402

403403

@@ -406,30 +406,30 @@ Indicates that the schedule of one of the [credential](../../../capability-guide
406406
<summary><code>schedule_modified</code></summary>
407407

408408
Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past.
409-
**`created_at`**
410-
Format: `Datetime`
409+
410+
**`created_at`** Format: `Datetime`
411411

412412

413413
Date and time at which Seam created the warning.
414414

415415

416416
---
417-
**`message`**
418-
Format: `String`
417+
418+
**`message`** Format: `String`
419419

420420

421421
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
422422

423423

424424
---
425-
**`warning_code`**
426-
Format: `Enum`
425+
426+
**`warning_code`** Format: `Enum`
427427

428428

429429
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
430430
<details>
431431
<summary>Enum values:</summary>
432-
- `schedule_modified`
432+
- <code>schedule_modified</code>
433433
</details>
434434

435435

@@ -438,30 +438,30 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces
438438
<summary><code>being_deleted</code></summary>
439439

440440
Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.
441-
**`created_at`**
442-
Format: `Datetime`
441+
442+
**`created_at`** Format: `Datetime`
443443

444444

445445
Date and time at which Seam created the warning.
446446

447447

448448
---
449-
**`message`**
450-
Format: `String`
449+
450+
**`message`** Format: `String`
451451

452452

453453
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
454454

455455

456456
---
457-
**`warning_code`**
458-
Format: `Enum`
457+
458+
**`warning_code`** Format: `Enum`
459459

460460

461461
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
462462
<details>
463463
<summary>Enum values:</summary>
464-
- `being_deleted`
464+
- <code>being_deleted</code>
465465
</details>
466466

467467

@@ -470,30 +470,30 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi
470470
<summary><code>unknown_issue_with_acs_credential</code></summary>
471471

472472
An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential.
473-
**`created_at`**
474-
Format: `Datetime`
473+
474+
**`created_at`** Format: `Datetime`
475475

476476

477477
Date and time at which Seam created the warning.
478478

479479

480480
---
481-
**`message`**
482-
Format: `String`
481+
482+
**`message`** Format: `String`
483483

484484

485485
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
486486

487487

488488
---
489-
**`warning_code`**
490-
Format: `Enum`
489+
490+
**`warning_code`** Format: `Enum`
491491

492492

493493
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
494494
<details>
495495
<summary>Enum values:</summary>
496-
- `unknown_issue_with_acs_credential`
496+
- <code>unknown_issue_with_acs_credential</code>
497497
</details>
498498

499499

@@ -502,30 +502,30 @@ An unknown issue occurred while syncing the state of the [credential](../../../c
502502
<summary><code>needs_to_be_reissued</code></summary>
503503

504504
Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential.
505-
**`created_at`**
506-
Format: `Datetime`
505+
506+
**`created_at`** Format: `Datetime`
507507

508508

509509
Date and time at which Seam created the warning.
510510

511511

512512
---
513-
**`message`**
514-
Format: `String`
513+
514+
**`message`** Format: `String`
515515

516516

517517
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
518518

519519

520520
---
521-
**`warning_code`**
522-
Format: `Enum`
521+
522+
**`warning_code`** Format: `Enum`
523523

524524

525525
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
526526
<details>
527527
<summary>Enum values:</summary>
528-
- `needs_to_be_reissued`
528+
- <code>needs_to_be_reissued</code>
529529
</details>
530530

531531

docs/api/acs/encoders/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
9494
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
9595
<details>
9696
<summary>Enum values:</summary>
97-
- `acs_encoder_removed`
97+
- <code>acs_encoder_removed`</code>
9898
</details>
9999
<strong><code>message</code></strong> <i>String</i>
100100

docs/api/acs/entrances/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
6969
- <strong><code>door_type</code></strong> <i>Enum</i>
7070
<details>
7171
<summary>Enum values:</summary>
72-
- `CommonDoor`
73-
- `EntranceDoor`
74-
- `GuestDoor`
75-
- `Elevator`
72+
- <code>CommonDoor`</code>
73+
- <code>EntranceDoor`</code>
74+
- <code>GuestDoor`</code>
75+
- <code>Elevator`</code>
7676
</details>
7777

7878
- <strong><code>pms_id</code></strong> <i>String</i>
@@ -210,11 +210,11 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
210210
- <strong><code>door_category</code></strong> <i>Enum</i>
211211
<details>
212212
<summary>Enum values:</summary>
213-
- `entrance`
214-
- `guest`
215-
- `elevator reader`
216-
- `common`
217-
- `common (PMS)`
213+
- <code>entrance`</code>
214+
- <code>guest`</code>
215+
- <code>elevator reader`</code>
216+
- <code>common`</code>
217+
- <code>common (PMS)`</code>
218218
</details>
219219

220220
- <strong><code>door_name</code></strong> <i>String</i>
@@ -227,9 +227,9 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
227227
- <strong><code>visionline_door_profile_type</code></strong> <i>Enum</i>
228228
<details>
229229
<summary>Enum values:</summary>
230-
- `BLE`
231-
- `commonDoor`
232-
- `touch`
230+
- <code>BLE`</code>
231+
- <code>commonDoor`</code>
232+
- <code>touch`</code>
233233
</details>
234234

235235

docs/api/acs/entrances/list_credentials_with_access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
3838
<summary>Enum values</summary>
3939

4040
Possible enum values:
41-
- `visionline_metadata.is_valid`
41+
- <code>visionline_metadata.is_valid</code>
4242
</details>
4343

4444
---

0 commit comments

Comments
 (0)