Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
408 changes: 204 additions & 204 deletions docs/api/_blueprint.json

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/api/access_codes/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Creates a new ongoing online access code.
$seam->access_codes->create(
device_id: "a5036385-adcb-41b5-88c2-dd8a702a0730",
name: "My Ongoing Online Access Code",
code: "1234"
code: "1234",
);
```

Expand Down Expand Up @@ -637,7 +637,7 @@ $seam->access_codes->create(
name: "My Time-Bound Online Access Code",
starts_at: "2025-06-20T06:49:21.000Z",
ends_at: "2025-06-22T12:08:26.000Z",
code: "1234"
code: "1234",
);
```

Expand Down Expand Up @@ -943,7 +943,7 @@ $seam->access_codes->create(
preferred_code_length: 4,
use_offline_access_code: true,
is_offline_access_code: true,
max_time_rounding: "1h"
max_time_rounding: "1h",
);
```

Expand Down Expand Up @@ -1249,7 +1249,7 @@ $seam->access_codes->create(
preferred_code_length: 4,
use_offline_access_code: true,
is_offline_access_code: true,
is_one_time_use: true
is_one_time_use: true,
);
```

Expand Down Expand Up @@ -1540,7 +1540,7 @@ $seam->access_codes->create(
starts_at: "2025-06-20T06:49:21.000Z",
ends_at: "2025-06-22T12:08:26.000Z",
code: "1234",
use_backup_access_code_pool: true
use_backup_access_code_pool: true,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/create_multiple.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ $seam->access_codes->create_multiple(
preferred_code_length: 4,
name: "My Linked Access Code",
starts_at: "2025-06-19T01:41:56.000Z",
ends_at: "2025-06-22T16:40:40.000Z"
ends_at: "2025-06-22T16:40:40.000Z",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Deletes an access code.
```php
$seam->access_codes->delete(
device_id: "d33f4cc7-2b6a-41a4-ad30-c372ee493589",
access_code_id: "275b40a3-6b0b-4c51-8fd2-aafd3de2195c"
access_code_id: "275b40a3-6b0b-4c51-8fd2-aafd3de2195c",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/generate_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Generates a code for an access code, given a device ID.

```php
$seam->access_codes->generate_code(
device_id: "02cd5099-d9f8-45a1-a9c0-f2ecbd334792"
device_id: "02cd5099-d9f8-45a1-a9c0-f2ecbd334792",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Returns a specified access code.

```php
$seam->access_codes->get(
access_code_id: "90a114dc-48b5-4b8b-a3d3-972344594401"
access_code_id: "90a114dc-48b5-4b8b-a3d3-972344594401",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Returns a list of all access codes.
```php
$seam->access_codes->list(
device_id: "f5197f50-839b-4a8e-82f3-e9ef06af93ae",
limit: 10
limit: 10,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/pull_backup_access_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Retrieves a backup access code for an access code.

```php
$seam->access_codes->pull_backup_access_code(
access_code_id: "8e525b87-5e4b-48a5-a322-5d45262a735f"
access_code_id: "8e525b87-5e4b-48a5-a322-5d45262a735f",
);
```

Expand Down
4 changes: 2 additions & 2 deletions docs/api/access_codes/report_device_constraints.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ $seam->access_codes->report_device_constraints(
device_id: "cd17e797-e952-47a1-ba47-46bf72934181",
supported_code_lengths: [4, 5, 6],
min_code_length: 42,
max_code_length: 42
max_code_length: 42,
);
```

Expand Down Expand Up @@ -304,7 +304,7 @@ nil
$seam->access_codes->report_device_constraints(
device_id: "cd17e797-e952-47a1-ba47-46bf72934181",
min_code_length: 4,
max_code_length: 6
max_code_length: 6,
);
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Simulates the creation of an unmanaged access code in a sandbox workspace.
$seam->access_codes->simulate->create_unmanaged_access_code(
device_id: "5db6ef75-2e0d-4491-bf7e-c3eb01d5c963",
name: "My Access Code",
code: "1234"
code: "1234",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/unmanaged/convert_to_managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Converts an unmanaged access code to an access code managed through Seam.
$seam->access_codes->unmanaged->convert_to_managed(
access_code_id: "9ef2af02-e335-4b49-bd51-00e851a83ef6",
is_external_modification_allowed: true,
force: true
force: true,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/unmanaged/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Deletes an unmanaged access code.

```php
$seam->access_codes->unmanaged->delete(
access_code_id: "95d54d42-477b-49d6-bd3a-5e8a40a5a78f"
access_code_id: "95d54d42-477b-49d6-bd3a-5e8a40a5a78f",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/unmanaged/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Returns a specified unmanaged access code.

```php
$seam->access_codes->unmanaged->get(
access_code_id: "41b984ec-1b74-48cd-ba68-16660cd792b6"
access_code_id: "41b984ec-1b74-48cd-ba68-16660cd792b6",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/unmanaged/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Returns a list of all unmanaged access codes.

```php
$seam->access_codes->unmanaged->list(
device_id: "d885a24c-5741-49b1-85dc-ff6d5cf2f1b1"
device_id: "d885a24c-5741-49b1-85dc-ff6d5cf2f1b1",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/unmanaged/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ $seam->access_codes->unmanaged->update(
access_code_id: "ebd8e488-db1b-4f4b-9d02-489fbfa6829a",
is_managed: true,
is_external_modification_allowed: true,
force: true
force: true,
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ $seam->access_codes->update(
name: "My Updated Access Code",
starts_at: "2025-06-19T08:26:41.000Z",
ends_at: "2025-06-21T17:38:07.000Z",
code: "4444"
code: "4444",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_codes/update_multiple.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ $seam->access_codes->update_multiple(
ends_at: "2025-06-22T05:05:47.000Z",
starts_at: "2025-06-18T19:14:13.000Z",
name: "My Updated Linked Access Code",
common_code_key: "auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000"
common_code_key: "auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000",
);
```

Expand Down
6 changes: 3 additions & 3 deletions docs/api/access_grants/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ $seam->access_grants->create(
["mode" => "mobile_key"],
],
starts_at: "2025-06-16T16:54:17.946606Z",
ends_at: "2025-06-18T16:54:17.946606Z"
ends_at: "2025-06-18T16:54:17.946606Z",
);
```

Expand Down Expand Up @@ -886,7 +886,7 @@ $seam->access_grants->create(
["mode" => "mobile_key"],
],
starts_at: "2025-06-16T16:54:17.946606Z",
ends_at: "2025-06-18T16:54:17.946606Z"
ends_at: "2025-06-18T16:54:17.946606Z",
);
```

Expand Down Expand Up @@ -1251,7 +1251,7 @@ $seam->access_grants->create(
["mode" => "mobile_key"],
],
starts_at: "2025-06-16T16:54:17.946606Z",
ends_at: "2025-06-18T16:54:17.946606Z"
ends_at: "2025-06-18T16:54:17.946606Z",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_grants/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Deletes an Access Grant.

```php
$seam->access_grants->delete(
access_grant_id: "403ea27b-af76-4a48-ace9-8f9498f4c25c"
access_grant_id: "403ea27b-af76-4a48-ace9-8f9498f4c25c",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_grants/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Returns a specified Access Grant.

```php
$seam->access_grants->get(
access_grant_id: "704eadf0-a0a2-4715-b0e1-2f002dc1b6e0"
access_grant_id: "704eadf0-a0a2-4715-b0e1-2f002dc1b6e0",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_grants/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ $seam->access_grants->list(
user_identity_id: "f7620fcf-d92f-471e-b97e-3806daeebd40",
acs_system_id: "9f169742-048a-4105-84e3-bd1e0f9dc790",
acs_entrance_id: "2673b363-4748-4a64-8075-f669c862ec74",
space_id: "1d20c47d-3cc0-41ca-9917-bc798d071543"
space_id: "1d20c47d-3cc0-41ca-9917-bc798d071543",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_grants/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Updates an existing Access Grant's time window.
$seam->access_grants->update(
access_grant_id: "4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1",
starts_at: "2025-06-19T18:01:32.000Z",
ends_at: "2025-06-22T13:24:50.000Z"
ends_at: "2025-06-22T13:24:50.000Z",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_methods/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Deletes an access method.

```php
$seam->access_methods->delete(
access_method_id: "3f10d86c-526b-4b85-8788-cc1a74411b71"
access_method_id: "3f10d86c-526b-4b85-8788-cc1a74411b71",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_methods/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Returns a specified access method.

```php
$seam->access_methods->get(
access_method_id: "7410aea4-6bed-490c-a602-dd417d9cd075"
access_method_id: "7410aea4-6bed-490c-a602-dd417d9cd075",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/access_methods/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Returns a list of all access methods, filtered by Access Grant.

```php
$seam->access_methods->list(
access_grant_id: "9072ebcd-95f3-4e4b-8f2f-10053911533b"
access_grant_id: "9072ebcd-95f3-4e4b-8f2f-10053911533b",
);
```

Expand Down
4 changes: 2 additions & 2 deletions docs/api/acs/access_groups/add_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Adds a specified access system user to a specified access group.
```php
$seam->acs->access_groups->add_user(
acs_access_group_id: "55efa954-2b84-42af-8d05-fc1f892df51c",
acs_user_id: "ebf54c67-746c-471f-a03f-86665148a84c"
acs_user_id: "ebf54c67-746c-471f-a03f-86665148a84c",
);
```

Expand Down Expand Up @@ -276,7 +276,7 @@ nil
```php
$seam->acs->access_groups->add_user(
acs_access_group_id: "55efa954-2b84-42af-8d05-fc1f892df51c",
user_identity_id: "522d1368-973f-430f-92df-4ff3583ebccf"
user_identity_id: "522d1368-973f-430f-92df-4ff3583ebccf",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/acs/access_groups/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Returns a specified access group.

```php
$seam->acs->access_groups->get(
acs_access_group_id: "09eb5265-6e3b-4e6d-bf96-736171c547ae"
acs_access_group_id: "09eb5265-6e3b-4e6d-bf96-736171c547ae",
);
```

Expand Down
4 changes: 2 additions & 2 deletions docs/api/acs/access_groups/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Returns a list of all access groups, filtered by user identity.
$seam->acs->access_groups->list(
acs_system_id: "1b529056-1b04-450b-b3da-016b65a5017f",
acs_user_id: "ebe506e1-33ba-44e8-892b-2d12c1709cd8",
user_identity_id: "9b1deda4-07e2-4e90-acde-5724b6ab7305"
user_identity_id: "9b1deda4-07e2-4e90-acde-5724b6ab7305",
);
```

Expand Down Expand Up @@ -470,7 +470,7 @@ seam.acs.access_groups.list(
```php
$seam->acs->access_groups->list(
acs_system_id: "1b529056-1b04-450b-b3da-016b65a5017f",
acs_user_id: "ebe506e1-33ba-44e8-892b-2d12c1709cd8"
acs_user_id: "ebe506e1-33ba-44e8-892b-2d12c1709cd8",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/acs/access_groups/list_accessible_entrances.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Returns a list of all accessible entrances for a specified access group.

```php
$seam->acs->access_groups->list_accessible_entrances(
acs_access_group_id: "1b02a29f-effd-4ce6-8a58-16ec09fd9b50"
acs_access_group_id: "1b02a29f-effd-4ce6-8a58-16ec09fd9b50",
);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/api/acs/access_groups/list_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ Returns a list of all access system users in an access group.

```php
$seam->acs->access_groups->list_users(
acs_access_group_id: "da76b0a9-97c5-4d7c-8db2-91d13094a940"
acs_access_group_id: "da76b0a9-97c5-4d7c-8db2-91d13094a940",
);
```

Expand Down
4 changes: 2 additions & 2 deletions docs/api/acs/access_groups/remove_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Removes a specified access system user from a specified access group, using the
```php
$seam->acs->access_groups->remove_user(
acs_access_group_id: "e320069d-59ba-4adb-a465-f4f01a833e07",
user_identity_id: "3d662a00-5d7c-41b4-aee7-16c385964149"
user_identity_id: "3d662a00-5d7c-41b4-aee7-16c385964149",
);
```

Expand Down Expand Up @@ -276,7 +276,7 @@ nil
```php
$seam->acs->access_groups->remove_user(
acs_access_group_id: "e320069d-59ba-4adb-a465-f4f01a833e07",
acs_user_id: "64cfac1f-61c0-4c76-8fa2-3e9ab680edc8"
acs_user_id: "64cfac1f-61c0-4c76-8fa2-3e9ab680edc8",
);
```

Expand Down
4 changes: 2 additions & 2 deletions docs/api/acs/credentials/assign.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Assigns a specified credential to a specified access system user, using the asso
```php
$seam->acs->credentials->assign(
user_identity_id: "1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01",
acs_credential_id: "59c9af06-7881-46d2-8d9b-3eda964c058b"
acs_credential_id: "59c9af06-7881-46d2-8d9b-3eda964c058b",
);
```

Expand Down Expand Up @@ -276,7 +276,7 @@ nil
```php
$seam->acs->credentials->assign(
acs_user_id: "143f083a-d61c-4d85-923f-d5483fb5a7d4",
acs_credential_id: "59c9af06-7881-46d2-8d9b-3eda964c058b"
acs_credential_id: "59c9af06-7881-46d2-8d9b-3eda964c058b",
);
```

Expand Down
Loading
Loading