Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c4affc9
Add a new line after property-collapsible in api-resource partial
andrii-balitskyi May 6, 2025
0cb71db
Render array props of discriminated objects
andrii-balitskyi May 6, 2025
311391c
ci: Generate docs
seambot May 6, 2025
9518d7d
Simplify layout
andrii-balitskyi May 6, 2025
fb37153
Remove Variant Properties text
andrii-balitskyi May 6, 2025
2f3ba2d
List all discriminator values
andrii-balitskyi May 6, 2025
7bdf182
Fix template syntax
andrii-balitskyi May 6, 2025
755fe22
ci: Generate docs
seambot May 6, 2025
55ee11c
Bump blueprint to 0.40.2
andrii-balitskyi May 7, 2025
75ac4eb
ci: Generate docs
seambot May 7, 2025
e9029f0
Make it more concise without the list of discriminator values, simpli…
andrii-balitskyi May 7, 2025
f7b3a0d
ci: Generate docs
seambot May 7, 2025
158a532
Bump seam types to 1.386.2
andrii-balitskyi May 7, 2025
a063772
ci: Generate docs
seambot May 7, 2025
a5e8dcd
Use expandable block
andrii-balitskyi May 7, 2025
876ee35
ci: Generate docs
seambot May 7, 2025
2a6e76b
Use property-non-collapsible
andrii-balitskyi May 7, 2025
4f6991d
ci: Generate docs
seambot May 7, 2025
64b2606
REmove horizontal rule after last prop
andrii-balitskyi May 7, 2025
8a4fde9
ci: Generate docs
seambot May 7, 2025
6996b39
Merge branch 'main' of github.com:seamapi/docs into andrii/cx-298-doc…
andrii-balitskyi May 7, 2025
d6859fb
Improve getOpenapiResponseProperties
andrii-balitskyi May 7, 2025
e87a366
Eslint fix
andrii-balitskyi May 8, 2025
221c162
Merge branch 'main' of github.com:seamapi/docs into andrii/cx-298-doc…
andrii-balitskyi May 8, 2025
cedcdf1
ci: Generate docs
seambot May 8, 2025
8b3b456
Simplify getOpenapiResponseProperties
andrii-balitskyi May 8, 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
3 changes: 3 additions & 0 deletions docs/api/acs/access_groups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,14 @@ Warnings associated with the `acs_access_group`.

Date and time at which Seam created the warning.
</details>

<details>

<summary><code>message</code> Format: <code>String</code></summary>

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
</details>

<details>

<summary><code>warning_code</code> Format: <code>Enum</code></summary>
Expand All @@ -133,6 +135,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori
Possible enum values:
- `unknown_issue_with_acs_access_group`
</details>

---

### `workspace_id`
Expand Down
205 changes: 205 additions & 0 deletions docs/api/acs/credentials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,22 +61,27 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-

<summary><code>door_names</code> Format: <code>List</code> Item format: <code>String</code></summary>
</details>

<details>

<summary><code>endpoint_id</code> Format: <code>String</code></summary>
</details>

<details>

<summary><code>key_id</code> Format: <code>String</code></summary>
</details>

<details>

<summary><code>key_issuing_request_id</code> Format: <code>String</code></summary>
</details>

<details>

<summary><code>override_guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>String</code></summary>
</details>

---

### `card_number`
Expand Down Expand Up @@ -131,10 +136,12 @@ Errors associated with the [credential](../../../capability-guides/access-system

<summary><code>error_code</code> Format: <code>String</code></summary>
</details>

<details>

<summary><code>message</code> Format: <code>String</code></summary>
</details>

---

### `external_type`
Expand Down Expand Up @@ -243,6 +250,7 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc

<summary><code>auto_join</code> Format: <code>Boolean</code></summary>
</details>

<details>

<summary><code>card_function_type</code> Format: <code>Enum</code></summary>
Expand All @@ -251,30 +259,37 @@ Possible enum values:
- `guest`
- `staff`
</details>

<details>

<summary><code>card_id</code> Format: <code>String</code></summary>
</details>

<details>

<summary><code>common_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
</details>

<details>

<summary><code>credential_id</code> Format: <code>String</code></summary>
</details>

<details>

<summary><code>guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
</details>

<details>

<summary><code>is_valid</code> Format: <code>Boolean</code></summary>
</details>

<details>

<summary><code>joiner_acs_credential_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
</details>

---

### [`warnings`](./#warnings-1)
Expand All @@ -285,6 +300,196 @@ Item format: `Object`

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

The specific structure of each object in this list depends on the value of its `warning_code` field.

Variants:
<details>
<summary><code>waiting_to_be_issued</code></summary>

Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.

**`created_at`**
Format: `Datetime`


Date and time at which Seam created the warning.

---

**`message`**
Format: `String`


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

---

**`warning_code`**
Format: `Enum`


Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Possible enum values:
- `waiting_to_be_issued`

</details>
<details>
<summary><code>schedule_externally_modified</code></summary>

Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.

**`created_at`**
Format: `Datetime`


Date and time at which Seam created the warning.

---

**`message`**
Format: `String`


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

---

**`warning_code`**
Format: `Enum`


Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Possible enum values:
- `schedule_externally_modified`

</details>
<details>
<summary><code>schedule_modified</code></summary>

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.

**`created_at`**
Format: `Datetime`


Date and time at which Seam created the warning.

---

**`message`**
Format: `String`


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

---

**`warning_code`**
Format: `Enum`


Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Possible enum values:
- `schedule_modified`

</details>
<details>
<summary><code>being_deleted</code></summary>

Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.

**`created_at`**
Format: `Datetime`


Date and time at which Seam created the warning.

---

**`message`**
Format: `String`


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

---

**`warning_code`**
Format: `Enum`


Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Possible enum values:
- `being_deleted`

</details>
<details>
<summary><code>unknown_issue_with_acs_credential</code></summary>

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.

**`created_at`**
Format: `Datetime`


Date and time at which Seam created the warning.

---

**`message`**
Format: `String`


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

---

**`warning_code`**
Format: `Enum`


Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Possible enum values:
- `unknown_issue_with_acs_credential`

</details>
<details>
<summary><code>needs_to_be_reissued</code></summary>

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.

**`created_at`**
Format: `Datetime`


Date and time at which Seam created the warning.

---

**`message`**
Format: `String`


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

---

**`warning_code`**
Format: `Enum`


Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Possible enum values:
- `needs_to_be_reissued`

</details>

---

### `workspace_id`
Expand Down
3 changes: 3 additions & 0 deletions docs/api/acs/encoders/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w

Date and time at which Seam created the error.
</details>

<details>

<summary><code>error_code</code> Format: <code>Enum</code></summary>
Expand All @@ -72,12 +73,14 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
Possible enum values:
- `acs_encoder_removed`
</details>

<details>

<summary><code>message</code> Format: <code>String</code></summary>

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
</details>

---

### `workspace_id`
Expand Down
Loading
Loading