Skip to content

Commit 7638f30

Browse files
Render discriminated object arrays in props (#572)
Co-authored-by: Seam Bot <seambot@getseam.com>
1 parent 2384ef6 commit 7638f30

24 files changed

Lines changed: 1266 additions & 9 deletions

docs/api/acs/access_groups/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,14 @@ Warnings associated with the `acs_access_group`.
118118

119119
Date and time at which Seam created the warning.
120120
</details>
121+
121122
<details>
122123

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

125126
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
126127
</details>
128+
127129
<details>
128130

129131
<summary><code>warning_code</code> Format: <code>Enum</code></summary>
@@ -133,6 +135,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori
133135
Possible enum values:
134136
- `unknown_issue_with_acs_access_group`
135137
</details>
138+
136139
---
137140

138141
### `workspace_id`

docs/api/acs/credentials/README.md

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,22 +61,27 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
6161

6262
<summary><code>door_names</code> Format: <code>List</code> Item format: <code>String</code></summary>
6363
</details>
64+
6465
<details>
6566

6667
<summary><code>endpoint_id</code> Format: <code>String</code></summary>
6768
</details>
69+
6870
<details>
6971

7072
<summary><code>key_id</code> Format: <code>String</code></summary>
7173
</details>
74+
7275
<details>
7376

7477
<summary><code>key_issuing_request_id</code> Format: <code>String</code></summary>
7578
</details>
79+
7680
<details>
7781

7882
<summary><code>override_guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>String</code></summary>
7983
</details>
84+
8085
---
8186

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

132137
<summary><code>error_code</code> Format: <code>String</code></summary>
133138
</details>
139+
134140
<details>
135141

136142
<summary><code>message</code> Format: <code>String</code></summary>
137143
</details>
144+
138145
---
139146

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

244251
<summary><code>auto_join</code> Format: <code>Boolean</code></summary>
245252
</details>
253+
246254
<details>
247255

248256
<summary><code>card_function_type</code> Format: <code>Enum</code></summary>
@@ -251,30 +259,37 @@ Possible enum values:
251259
- `guest`
252260
- `staff`
253261
</details>
262+
254263
<details>
255264

256265
<summary><code>card_id</code> Format: <code>String</code></summary>
257266
</details>
267+
258268
<details>
259269

260270
<summary><code>common_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
261271
</details>
272+
262273
<details>
263274

264275
<summary><code>credential_id</code> Format: <code>String</code></summary>
265276
</details>
277+
266278
<details>
267279

268280
<summary><code>guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
269281
</details>
282+
270283
<details>
271284

272285
<summary><code>is_valid</code> Format: <code>Boolean</code></summary>
273286
</details>
287+
274288
<details>
275289

276290
<summary><code>joiner_acs_credential_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
277291
</details>
292+
278293
---
279294

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

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

303+
The specific structure of each object in this list depends on the value of its `warning_code` field.
304+
305+
Variants:
306+
<details>
307+
<summary><code>waiting_to_be_issued</code></summary>
308+
309+
Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
310+
311+
**`created_at`**
312+
Format: `Datetime`
313+
314+
315+
Date and time at which Seam created the warning.
316+
317+
---
318+
319+
**`message`**
320+
Format: `String`
321+
322+
323+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
324+
325+
---
326+
327+
**`warning_code`**
328+
Format: `Enum`
329+
330+
331+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
332+
333+
Possible enum values:
334+
- `waiting_to_be_issued`
335+
336+
</details>
337+
<details>
338+
<summary><code>schedule_externally_modified</code></summary>
339+
340+
Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
341+
342+
**`created_at`**
343+
Format: `Datetime`
344+
345+
346+
Date and time at which Seam created the warning.
347+
348+
---
349+
350+
**`message`**
351+
Format: `String`
352+
353+
354+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
355+
356+
---
357+
358+
**`warning_code`**
359+
Format: `Enum`
360+
361+
362+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
363+
364+
Possible enum values:
365+
- `schedule_externally_modified`
366+
367+
</details>
368+
<details>
369+
<summary><code>schedule_modified</code></summary>
370+
371+
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.
372+
373+
**`created_at`**
374+
Format: `Datetime`
375+
376+
377+
Date and time at which Seam created the warning.
378+
379+
---
380+
381+
**`message`**
382+
Format: `String`
383+
384+
385+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
386+
387+
---
388+
389+
**`warning_code`**
390+
Format: `Enum`
391+
392+
393+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
394+
395+
Possible enum values:
396+
- `schedule_modified`
397+
398+
</details>
399+
<details>
400+
<summary><code>being_deleted</code></summary>
401+
402+
Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.
403+
404+
**`created_at`**
405+
Format: `Datetime`
406+
407+
408+
Date and time at which Seam created the warning.
409+
410+
---
411+
412+
**`message`**
413+
Format: `String`
414+
415+
416+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
417+
418+
---
419+
420+
**`warning_code`**
421+
Format: `Enum`
422+
423+
424+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
425+
426+
Possible enum values:
427+
- `being_deleted`
428+
429+
</details>
430+
<details>
431+
<summary><code>unknown_issue_with_acs_credential</code></summary>
432+
433+
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.
434+
435+
**`created_at`**
436+
Format: `Datetime`
437+
438+
439+
Date and time at which Seam created the warning.
440+
441+
---
442+
443+
**`message`**
444+
Format: `String`
445+
446+
447+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
448+
449+
---
450+
451+
**`warning_code`**
452+
Format: `Enum`
453+
454+
455+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
456+
457+
Possible enum values:
458+
- `unknown_issue_with_acs_credential`
459+
460+
</details>
461+
<details>
462+
<summary><code>needs_to_be_reissued</code></summary>
463+
464+
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.
465+
466+
**`created_at`**
467+
Format: `Datetime`
468+
469+
470+
Date and time at which Seam created the warning.
471+
472+
---
473+
474+
**`message`**
475+
Format: `String`
476+
477+
478+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
479+
480+
---
481+
482+
**`warning_code`**
483+
Format: `Enum`
484+
485+
486+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
487+
488+
Possible enum values:
489+
- `needs_to_be_reissued`
490+
491+
</details>
492+
288493
---
289494

290495
### `workspace_id`

docs/api/acs/encoders/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
6363

6464
Date and time at which Seam created the error.
6565
</details>
66+
6667
<details>
6768

6869
<summary><code>error_code</code> Format: <code>Enum</code></summary>
@@ -72,12 +73,14 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
7273
Possible enum values:
7374
- `acs_encoder_removed`
7475
</details>
76+
7577
<details>
7678

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

7981
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
8082
</details>
83+
8184
---
8285

8386
### `workspace_id`

0 commit comments

Comments
 (0)