Skip to content

Commit d287db2

Browse files
mikewuuseambotrazor-x
authored
feat: add endpoint resource samples (#689)
* set resourceSample in file * render resource sample * ci: Format code * ci: Format code * ci: Generate docs * fix [object, object] * fix merge error * remove json * ci: Generate docs * remove extra action attempt block * ci: Generate docs * Reuse existing resource sample logic * ci: Generate docs --------- Co-authored-by: Seam Bot <[email protected]> Co-authored-by: Evan Sosenko <[email protected]>
1 parent e689b17 commit d287db2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1762
-14
lines changed

‎docs/api/access_codes/create.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,39 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
379379
[access\_code](./)
380380

381381

382+
{% tabs %}
383+
{% tab title="JSON" %}
384+
385+
386+
387+
```json
388+
{
389+
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
390+
"code": "1234",
391+
"common_code_key": null,
392+
"created_at": "2025-06-14T16:54:17.946242Z",
393+
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
394+
"ends_at": "2025-07-04T16:54:17.946049Z",
395+
"errors": [],
396+
"is_backup": false,
397+
"is_backup_access_code_available": false,
398+
"is_external_modification_allowed": false,
399+
"is_managed": true,
400+
"is_offline_access_code": true,
401+
"is_one_time_use": true,
402+
"is_scheduled_on_device": true,
403+
"is_waiting_for_code_assignment": false,
404+
"name": "My Access Code",
405+
"pulled_backup_access_code_id": null,
406+
"starts_at": "2025-07-02T16:54:17.946049Z",
407+
"status": "set",
408+
"type": "time_bound",
409+
"warnings": []
410+
}
411+
```
412+
{% endtab %}
413+
{% endtabs %}
414+
382415
---
383416

384417
## Examples

‎docs/api/access_codes/create_multiple.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,3 +437,36 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
437437

438438
Array of [access\_codes](./)
439439

440+
441+
{% tabs %}
442+
{% tab title="JSON" %}
443+
444+
445+
446+
```json
447+
{
448+
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
449+
"code": "1234",
450+
"common_code_key": null,
451+
"created_at": "2025-06-14T16:54:17.946242Z",
452+
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
453+
"ends_at": "2025-07-04T16:54:17.946049Z",
454+
"errors": [],
455+
"is_backup": false,
456+
"is_backup_access_code_available": false,
457+
"is_external_modification_allowed": false,
458+
"is_managed": true,
459+
"is_offline_access_code": true,
460+
"is_one_time_use": true,
461+
"is_scheduled_on_device": true,
462+
"is_waiting_for_code_assignment": false,
463+
"name": "My Access Code",
464+
"pulled_backup_access_code_id": null,
465+
"starts_at": "2025-07-02T16:54:17.946049Z",
466+
"status": "set",
467+
"type": "time_bound",
468+
"warnings": []
469+
}
470+
```
471+
{% endtab %}
472+
{% endtabs %}

‎docs/api/access_codes/generate_code.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,36 @@ ID of the device for which you want to generate a code.
154154

155155
[access\_code](./)
156156

157+
158+
{% tabs %}
159+
{% tab title="JSON" %}
160+
161+
162+
163+
```json
164+
{
165+
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
166+
"code": "1234",
167+
"common_code_key": null,
168+
"created_at": "2025-06-14T16:54:17.946242Z",
169+
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
170+
"ends_at": "2025-07-04T16:54:17.946049Z",
171+
"errors": [],
172+
"is_backup": false,
173+
"is_backup_access_code_available": false,
174+
"is_external_modification_allowed": false,
175+
"is_managed": true,
176+
"is_offline_access_code": true,
177+
"is_one_time_use": true,
178+
"is_scheduled_on_device": true,
179+
"is_waiting_for_code_assignment": false,
180+
"name": "My Access Code",
181+
"pulled_backup_access_code_id": null,
182+
"starts_at": "2025-07-02T16:54:17.946049Z",
183+
"status": "set",
184+
"type": "time_bound",
185+
"warnings": []
186+
}
187+
```
188+
{% endtab %}
189+
{% endtabs %}

‎docs/api/access_codes/get.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,3 +295,36 @@ ID of the device containing the access code that you want to get. You must speci
295295

296296
[access\_code](./)
297297

298+
299+
{% tabs %}
300+
{% tab title="JSON" %}
301+
302+
303+
304+
```json
305+
{
306+
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
307+
"code": "1234",
308+
"common_code_key": null,
309+
"created_at": "2025-06-14T16:54:17.946242Z",
310+
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
311+
"ends_at": "2025-07-04T16:54:17.946049Z",
312+
"errors": [],
313+
"is_backup": false,
314+
"is_backup_access_code_available": false,
315+
"is_external_modification_allowed": false,
316+
"is_managed": true,
317+
"is_offline_access_code": true,
318+
"is_one_time_use": true,
319+
"is_scheduled_on_device": true,
320+
"is_waiting_for_code_assignment": false,
321+
"name": "My Access Code",
322+
"pulled_backup_access_code_id": null,
323+
"starts_at": "2025-07-02T16:54:17.946049Z",
324+
"status": "set",
325+
"type": "time_bound",
326+
"warnings": []
327+
}
328+
```
329+
{% endtab %}
330+
{% endtabs %}

‎docs/api/access_codes/list.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,3 +328,36 @@ Your user ID for the user by which to filter access codes.
328328

329329
Array of [access\_codes](./)
330330

331+
332+
{% tabs %}
333+
{% tab title="JSON" %}
334+
335+
336+
337+
```json
338+
{
339+
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
340+
"code": "1234",
341+
"common_code_key": null,
342+
"created_at": "2025-06-14T16:54:17.946242Z",
343+
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
344+
"ends_at": "2025-07-04T16:54:17.946049Z",
345+
"errors": [],
346+
"is_backup": false,
347+
"is_backup_access_code_available": false,
348+
"is_external_modification_allowed": false,
349+
"is_managed": true,
350+
"is_offline_access_code": true,
351+
"is_one_time_use": true,
352+
"is_scheduled_on_device": true,
353+
"is_waiting_for_code_assignment": false,
354+
"name": "My Access Code",
355+
"pulled_backup_access_code_id": null,
356+
"starts_at": "2025-07-02T16:54:17.946049Z",
357+
"status": "set",
358+
"type": "time_bound",
359+
"warnings": []
360+
}
361+
```
362+
{% endtab %}
363+
{% endtabs %}

‎docs/api/access_codes/pull_backup_access_code.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,3 +293,36 @@ ID of the access code for which you want to pull a backup access code.
293293

294294
[access\_code](./)
295295

296+
297+
{% tabs %}
298+
{% tab title="JSON" %}
299+
300+
301+
302+
```json
303+
{
304+
"access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
305+
"code": "1234",
306+
"common_code_key": null,
307+
"created_at": "2025-06-14T16:54:17.946242Z",
308+
"device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
309+
"ends_at": "2025-07-04T16:54:17.946049Z",
310+
"errors": [],
311+
"is_backup": false,
312+
"is_backup_access_code_available": false,
313+
"is_external_modification_allowed": false,
314+
"is_managed": true,
315+
"is_offline_access_code": true,
316+
"is_one_time_use": true,
317+
"is_scheduled_on_device": true,
318+
"is_waiting_for_code_assignment": false,
319+
"name": "My Access Code",
320+
"pulled_backup_access_code_id": null,
321+
"starts_at": "2025-07-02T16:54:17.946049Z",
322+
"status": "set",
323+
"type": "time_bound",
324+
"warnings": []
325+
}
326+
```
327+
{% endtab %}
328+
{% endtabs %}

‎docs/api/access_codes/simulate/create_unmanaged_access_code.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,3 +253,27 @@ Name of the simulated unmanaged access code.
253253

254254
[unmanaged\_access\_code](./)
255255

256+
257+
{% tabs %}
258+
{% tab title="JSON" %}
259+
260+
261+
262+
```json
263+
{
264+
"access_code_id": "88fa1812-bef8-4108-9fb4-4855376c3edf",
265+
"code": "1234",
266+
"created_at": "2025-06-16T16:54:17.946283Z",
267+
"device_id": "b3439f17-7273-46f3-9e20-9a283d9cb5b4",
268+
"ends_at": "2025-06-23T16:54:17.946261Z",
269+
"errors": [],
270+
"is_managed": false,
271+
"name": "My Unmanaged Access Code",
272+
"starts_at": "2025-06-21T16:54:17.946261Z",
273+
"status": "set",
274+
"type": "time_bound",
275+
"warnings": []
276+
}
277+
```
278+
{% endtab %}
279+
{% endtabs %}

‎docs/api/access_codes/unmanaged/get.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,3 +243,27 @@ ID of the device containing the unmanaged access code that you want to get. You
243243

244244
[unmanaged\_access\_code](./)
245245

246+
247+
{% tabs %}
248+
{% tab title="JSON" %}
249+
250+
251+
252+
```json
253+
{
254+
"access_code_id": "88fa1812-bef8-4108-9fb4-4855376c3edf",
255+
"code": "1234",
256+
"created_at": "2025-06-16T16:54:17.946283Z",
257+
"device_id": "b3439f17-7273-46f3-9e20-9a283d9cb5b4",
258+
"ends_at": "2025-06-23T16:54:17.946261Z",
259+
"errors": [],
260+
"is_managed": false,
261+
"name": "My Unmanaged Access Code",
262+
"starts_at": "2025-06-21T16:54:17.946261Z",
263+
"status": "set",
264+
"type": "time_bound",
265+
"warnings": []
266+
}
267+
```
268+
{% endtab %}
269+
{% endtabs %}

‎docs/api/access_codes/unmanaged/list.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,3 +247,27 @@ Your user ID for the user by which to filter unmanaged access codes.
247247

248248
Array of [unmanaged\_access\_codes](./)
249249

250+
251+
{% tabs %}
252+
{% tab title="JSON" %}
253+
254+
255+
256+
```json
257+
{
258+
"access_code_id": "88fa1812-bef8-4108-9fb4-4855376c3edf",
259+
"code": "1234",
260+
"created_at": "2025-06-16T16:54:17.946283Z",
261+
"device_id": "b3439f17-7273-46f3-9e20-9a283d9cb5b4",
262+
"ends_at": "2025-06-23T16:54:17.946261Z",
263+
"errors": [],
264+
"is_managed": false,
265+
"name": "My Unmanaged Access Code",
266+
"starts_at": "2025-06-21T16:54:17.946261Z",
267+
"status": "set",
268+
"type": "time_bound",
269+
"warnings": []
270+
}
271+
```
272+
{% endtab %}
273+
{% endtabs %}

‎docs/api/access_grants/create.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,56 @@ ID of user identity for whom access is being granted.
556556
[access\_grant](./)
557557

558558

559+
{% tabs %}
560+
{% tab title="JSON" %}
561+
562+
563+
564+
```json
565+
{
566+
"access_grant_id": "ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b",
567+
"access_method_ids": [
568+
"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d",
569+
"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
570+
"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
571+
],
572+
"created_at": "2025-06-16T16:54:17.946606Z",
573+
"display_name": "My Access Grant",
574+
"location_ids": [
575+
"9e8d7c6b-5a4b-3c2d-1e0f-9a8b7c6d5e4f",
576+
"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f"
577+
],
578+
"requested_access_methods": [
579+
{
580+
"display_name": "PIN Code Credential",
581+
"mode": "code",
582+
"created_at": "2025-06-16T16:54:17.946606Z",
583+
"created_access_method_ids": ["a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"]
584+
},
585+
{
586+
"display_name": "Card Credential",
587+
"mode": "card",
588+
"created_at": "2025-06-16T16:54:19.946606Z",
589+
"created_access_method_ids": ["5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f"]
590+
},
591+
{
592+
"display_name": "Mobile Key Credential",
593+
"mode": "mobile_key",
594+
"created_at": "2025-06-16T16:54:21.946606Z",
595+
"created_access_method_ids": ["c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f"]
596+
}
597+
],
598+
"space_ids": [
599+
"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
600+
"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a"
601+
],
602+
"user_identity_id": "e3d736c1-540d-4d10-83e5-9a4e135453b4",
603+
"workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
604+
}
605+
```
606+
{% endtab %}
607+
{% endtabs %}
608+
559609
---
560610

561611
## Examples

0 commit comments

Comments
 (0)