Skip to content

Commit 6fc1e6e

Browse files
andrii-balitskyiseambot
andrii-balitskyi
and
seambot
authored
Add missing action attempt error and result documentation (#571)
* Bump blueprint to 0.40.1 * ci: Generate docs --------- Co-authored-by: Seam Bot <seambot@getseam.com>
1 parent 3ed44ee commit 6fc1e6e

File tree

11 files changed

+851
-5
lines changed

11 files changed

+851
-5
lines changed

‎docs/api/acs/encoders/encode_credential.md‎

Lines changed: 280 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,286 @@ Value: `ENCODE_CREDENTIAL`
5858

5959
---
6060

61+
#### `error`
62+
63+
Format: `Object`
64+
65+
<details>
66+
67+
<summary><code>message</code> Format: <code>String</code></summary>
68+
</details>
69+
<details>
70+
71+
<summary><code>type</code> Format: <code>Enum</code></summary>
72+
73+
Possible enum values:
74+
- `uncategorized_error`
75+
- `action_attempt_expired`
76+
- `no_credential_on_encoder`
77+
- `incompatible_card_format`
78+
- `credential_cannot_be_reissued`
79+
</details>
80+
---
81+
82+
#### `result`
83+
84+
Format: `Object`
85+
86+
If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card.
87+
88+
<details>
89+
90+
<summary><code>access_method</code> Format: <code>Enum</code></summary>
91+
92+
Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
93+
94+
Possible enum values:
95+
- `code`
96+
- `card`
97+
- `mobile_key`
98+
</details>
99+
<details>
100+
101+
<summary><code>acs_credential_id</code> Format: <code>UUID</code></summary>
102+
103+
ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
104+
</details>
105+
<details>
106+
107+
<summary><code>acs_credential_pool_id</code> Format: <code>UUID</code></summary>
108+
</details>
109+
<details>
110+
111+
<summary><code>acs_system_id</code> Format: <code>UUID</code></summary>
112+
113+
ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
114+
</details>
115+
<details>
116+
117+
<summary><code>acs_user_id</code> Format: <code>UUID</code></summary>
118+
119+
ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
120+
</details>
121+
<details>
122+
123+
<summary><code>assa_abloy_vostio_metadata</code> Format: <code>Object</code></summary>
124+
125+
Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
126+
</details>
127+
<details>
128+
129+
<summary><code>assa_abloy_vostio_metadata.door_names</code> Format: <code>List</code> Item format: <code>String</code></summary>
130+
</details>
131+
<details>
132+
133+
<summary><code>assa_abloy_vostio_metadata.endpoint_id</code> Format: <code>String</code></summary>
134+
</details>
135+
<details>
136+
137+
<summary><code>assa_abloy_vostio_metadata.key_id</code> Format: <code>String</code></summary>
138+
</details>
139+
<details>
140+
141+
<summary><code>assa_abloy_vostio_metadata.key_issuing_request_id</code> Format: <code>String</code></summary>
142+
</details>
143+
<details>
144+
145+
<summary><code>assa_abloy_vostio_metadata.override_guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>String</code></summary>
146+
</details>
147+
<details>
148+
149+
<summary><code>card_number</code> Format: <code>String</code></summary>
150+
151+
Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
152+
</details>
153+
<details>
154+
155+
<summary><code>code</code> Format: <code>String</code></summary>
156+
157+
Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
158+
</details>
159+
<details>
160+
161+
<summary><code>created_at</code> Format: <code>Datetime</code></summary>
162+
163+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
164+
</details>
165+
<details>
166+
167+
<summary><code>display_name</code> Format: <code>String</code></summary>
168+
169+
Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
170+
</details>
171+
<details>
172+
173+
<summary><code>ends_at</code> Format: <code>String</code></summary>
174+
175+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
176+
</details>
177+
<details>
178+
179+
<summary><code>errors</code> Format: <code>List</code> Item format: <code>Object</code></summary>
180+
181+
Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
182+
183+
- <code>error_code</code> Format: <code>String</code>
184+
185+
186+
- <code>message</code> Format: <code>String</code>
187+
188+
</details>
189+
<details>
190+
191+
<summary><code>external_type</code> Format: <code>Enum</code></summary>
192+
193+
Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
194+
195+
Possible enum values:
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+
</details>
204+
<details>
205+
206+
<summary><code>external_type_display_name</code> Format: <code>String</code></summary>
207+
208+
Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
209+
</details>
210+
<details>
211+
212+
<summary><code>is_issued</code> Format: <code>Boolean</code></summary>
213+
214+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
215+
</details>
216+
<details>
217+
218+
<summary><code>is_latest_desired_state_synced_with_provider</code> Format: <code>Boolean</code></summary>
219+
220+
Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
221+
</details>
222+
<details>
223+
224+
<summary><code>is_managed</code> Format: <code>Boolean</code></summary>
225+
</details>
226+
<details>
227+
228+
<summary><code>is_multi_phone_sync_credential</code> Format: <code>Boolean</code></summary>
229+
230+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
231+
</details>
232+
<details>
233+
234+
<summary><code>is_one_time_use</code> Format: <code>Boolean</code></summary>
235+
236+
Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
237+
</details>
238+
<details>
239+
240+
<summary><code>issued_at</code> Format: <code>Datetime</code></summary>
241+
242+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
243+
</details>
244+
<details>
245+
246+
<summary><code>latest_desired_state_synced_with_provider_at</code> Format: <code>Datetime</code></summary>
247+
248+
Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
249+
</details>
250+
<details>
251+
252+
<summary><code>parent_acs_credential_id</code> Format: <code>UUID</code></summary>
253+
254+
ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
255+
</details>
256+
<details>
257+
258+
<summary><code>starts_at</code> Format: <code>String</code></summary>
259+
260+
Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
261+
</details>
262+
<details>
263+
264+
<summary><code>visionline_metadata</code> Format: <code>Object</code></summary>
265+
266+
Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
267+
</details>
268+
<details>
269+
270+
<summary><code>visionline_metadata.auto_join</code> Format: <code>Boolean</code></summary>
271+
</details>
272+
<details>
273+
274+
<summary><code>visionline_metadata.card_function_type</code> Format: <code>Enum</code></summary>
275+
276+
Possible enum values:
277+
- `guest`
278+
- `staff`
279+
</details>
280+
<details>
281+
282+
<summary><code>visionline_metadata.card_id</code> Format: <code>String</code></summary>
283+
</details>
284+
<details>
285+
286+
<summary><code>visionline_metadata.common_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
287+
</details>
288+
<details>
289+
290+
<summary><code>visionline_metadata.credential_id</code> Format: <code>String</code></summary>
291+
</details>
292+
<details>
293+
294+
<summary><code>visionline_metadata.guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
295+
</details>
296+
<details>
297+
298+
<summary><code>visionline_metadata.is_valid</code> Format: <code>Boolean</code></summary>
299+
</details>
300+
<details>
301+
302+
<summary><code>visionline_metadata.joiner_acs_credential_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
303+
</details>
304+
<details>
305+
306+
<summary><code>warnings</code> Format: <code>List</code> Item format: <code>Object</code></summary>
307+
308+
Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
309+
310+
- <code>created_at</code> Format: <code>Datetime</code>
311+
312+
Date and time at which Seam created the warning.
313+
314+
315+
- <code>message</code> Format: <code>String</code>
316+
317+
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
318+
319+
320+
- <code>warning_code</code> Format: <code>Enum</code>
321+
322+
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
323+
324+
Possible enum values:
325+
- `waiting_to_be_issued`
326+
- `schedule_externally_modified`
327+
- `schedule_modified`
328+
- `being_deleted`
329+
- `unknown_issue_with_acs_credential`
330+
- `needs_to_be_reissued`
331+
332+
</details>
333+
<details>
334+
335+
<summary><code>workspace_id</code> Format: <code>UUID</code></summary>
336+
337+
ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
338+
</details>
339+
---
340+
61341
#### `status`
62342

63343
Format: `Enum`

0 commit comments

Comments
 (0)