From 45127f350102a7e61dc1cfec5fcd967a63390ef4 Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Wed, 12 Nov 2025 12:24:16 -0800 Subject: [PATCH 1/4] Render response type in success hint --- codegen/layouts/api-endpoint.hbs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/codegen/layouts/api-endpoint.hbs b/codegen/layouts/api-endpoint.hbs index 8fb925032..0810ba2e9 100644 --- a/codegen/layouts/api-endpoint.hbs +++ b/codegen/layouts/api-endpoint.hbs @@ -73,8 +73,12 @@ None ## Response +{% hint style="success" %} +**Returns:** {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{else}}[{{response.escapedResourceType}}]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{/if}}{{else}}void{{/if}} +{% endhint %} + {{#if resourceSamples.length}} {{> resource-samples resourceSamples }} From c5a114d0796ef9cafcdef26bba997144ae868359 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 12 Nov 2025 20:26:07 +0000 Subject: [PATCH 2/4] ci: Generate docs --- docs/api/access_codes/create.md | 4 ++++ docs/api/access_codes/create_multiple.md | 4 ++++ docs/api/access_codes/delete.md | 4 ++++ docs/api/access_codes/generate_code.md | 4 ++++ docs/api/access_codes/get.md | 4 ++++ docs/api/access_codes/list.md | 4 ++++ docs/api/access_codes/pull_backup_access_code.md | 4 ++++ docs/api/access_codes/report_device_constraints.md | 4 ++++ .../api/access_codes/simulate/create_unmanaged_access_code.md | 4 ++++ docs/api/access_codes/unmanaged/convert_to_managed.md | 4 ++++ docs/api/access_codes/unmanaged/delete.md | 4 ++++ docs/api/access_codes/unmanaged/get.md | 4 ++++ docs/api/access_codes/unmanaged/list.md | 4 ++++ docs/api/access_codes/unmanaged/update.md | 4 ++++ docs/api/access_codes/update.md | 4 ++++ docs/api/access_codes/update_multiple.md | 4 ++++ docs/api/access_grants/create.md | 4 ++++ docs/api/access_grants/delete.md | 4 ++++ docs/api/access_grants/get.md | 4 ++++ docs/api/access_grants/get_related.md | 4 ++++ docs/api/access_grants/list.md | 4 ++++ docs/api/access_grants/request_access_methods.md | 4 ++++ docs/api/access_grants/unmanaged/get.md | 4 ++++ docs/api/access_grants/unmanaged/list.md | 4 ++++ docs/api/access_grants/unmanaged/update.md | 4 ++++ docs/api/access_grants/update.md | 4 ++++ docs/api/access_methods/delete.md | 4 ++++ docs/api/access_methods/encode.md | 4 ++++ docs/api/access_methods/get.md | 4 ++++ docs/api/access_methods/get_related.md | 4 ++++ docs/api/access_methods/list.md | 4 ++++ docs/api/access_methods/unmanaged/get.md | 4 ++++ docs/api/access_methods/unmanaged/list.md | 4 ++++ docs/api/acs/access_groups/add_user.md | 4 ++++ docs/api/acs/access_groups/get.md | 4 ++++ docs/api/acs/access_groups/list.md | 4 ++++ docs/api/acs/access_groups/list_accessible_entrances.md | 4 ++++ docs/api/acs/access_groups/list_users.md | 4 ++++ docs/api/acs/access_groups/remove_user.md | 4 ++++ docs/api/acs/credentials/assign.md | 4 ++++ docs/api/acs/credentials/create.md | 4 ++++ docs/api/acs/credentials/delete.md | 4 ++++ docs/api/acs/credentials/get.md | 4 ++++ docs/api/acs/credentials/list.md | 4 ++++ docs/api/acs/credentials/list_accessible_entrances.md | 4 ++++ docs/api/acs/credentials/unassign.md | 4 ++++ docs/api/acs/credentials/update.md | 4 ++++ docs/api/acs/encoders/encode_credential.md | 4 ++++ docs/api/acs/encoders/get.md | 4 ++++ docs/api/acs/encoders/list.md | 4 ++++ docs/api/acs/encoders/scan_credential.md | 4 ++++ .../acs/encoders/simulate/next_credential_encode_will_fail.md | 4 ++++ .../encoders/simulate/next_credential_encode_will_succeed.md | 4 ++++ .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 ++++ .../encoders/simulate/next_credential_scan_will_succeed.md | 4 ++++ docs/api/acs/entrances/get.md | 4 ++++ docs/api/acs/entrances/grant_access.md | 4 ++++ docs/api/acs/entrances/list.md | 4 ++++ docs/api/acs/entrances/list_credentials_with_access.md | 4 ++++ docs/api/acs/systems/get.md | 4 ++++ docs/api/acs/systems/list.md | 4 ++++ .../systems/list_compatible_credential_manager_acs_systems.md | 4 ++++ docs/api/acs/systems/report_devices.md | 4 ++++ docs/api/acs/users/add_to_access_group.md | 4 ++++ docs/api/acs/users/create.md | 4 ++++ docs/api/acs/users/delete.md | 4 ++++ docs/api/acs/users/get.md | 4 ++++ docs/api/acs/users/list.md | 4 ++++ docs/api/acs/users/list_accessible_entrances.md | 4 ++++ docs/api/acs/users/remove_from_access_group.md | 4 ++++ docs/api/acs/users/revoke_access_to_all_entrances.md | 4 ++++ docs/api/acs/users/suspend.md | 4 ++++ docs/api/acs/users/unsuspend.md | 4 ++++ docs/api/acs/users/update.md | 4 ++++ docs/api/action_attempts/get.md | 4 ++++ docs/api/action_attempts/list.md | 4 ++++ docs/api/client_sessions/create.md | 4 ++++ docs/api/client_sessions/delete.md | 4 ++++ docs/api/client_sessions/get.md | 4 ++++ docs/api/client_sessions/get_or_create.md | 4 ++++ docs/api/client_sessions/grant_access.md | 4 ++++ docs/api/client_sessions/list.md | 4 ++++ docs/api/client_sessions/revoke.md | 4 ++++ docs/api/connect_webviews/create.md | 4 ++++ docs/api/connect_webviews/delete.md | 4 ++++ docs/api/connect_webviews/get.md | 4 ++++ docs/api/connect_webviews/list.md | 4 ++++ docs/api/connected_accounts/delete.md | 4 ++++ docs/api/connected_accounts/get.md | 4 ++++ docs/api/connected_accounts/list.md | 4 ++++ docs/api/connected_accounts/simulate/disconnect.md | 4 ++++ docs/api/connected_accounts/sync.md | 4 ++++ docs/api/connected_accounts/update.md | 4 ++++ docs/api/customers/create_portal.md | 4 ++++ docs/api/customers/delete_data.md | 4 ++++ docs/api/customers/push_data.md | 4 ++++ docs/api/devices/get.md | 4 ++++ docs/api/devices/list.md | 4 ++++ docs/api/devices/list_device_providers.md | 4 ++++ docs/api/devices/simulate/connect.md | 4 ++++ docs/api/devices/simulate/connect_to_hub.md | 4 ++++ docs/api/devices/simulate/disconnect.md | 4 ++++ docs/api/devices/simulate/disconnect_from_hub.md | 4 ++++ docs/api/devices/simulate/paid_subscription.md | 4 ++++ docs/api/devices/simulate/remove.md | 4 ++++ docs/api/devices/unmanaged/get.md | 4 ++++ docs/api/devices/unmanaged/list.md | 4 ++++ docs/api/devices/unmanaged/update.md | 4 ++++ docs/api/devices/update.md | 4 ++++ docs/api/events/get.md | 4 ++++ docs/api/events/list.md | 4 ++++ docs/api/instant_keys/delete.md | 4 ++++ docs/api/instant_keys/get.md | 4 ++++ docs/api/instant_keys/list.md | 4 ++++ docs/api/locks/get.md | 4 ++++ docs/api/locks/list.md | 4 ++++ docs/api/locks/lock_door.md | 4 ++++ docs/api/locks/simulate/keypad_code_entry.md | 4 ++++ docs/api/locks/simulate/manual_lock_via_keypad.md | 4 ++++ docs/api/locks/unlock_door.md | 4 ++++ docs/api/noise_sensors/list.md | 4 ++++ docs/api/noise_sensors/noise_thresholds/create.md | 4 ++++ docs/api/noise_sensors/noise_thresholds/delete.md | 4 ++++ docs/api/noise_sensors/noise_thresholds/get.md | 4 ++++ docs/api/noise_sensors/noise_thresholds/list.md | 4 ++++ docs/api/noise_sensors/noise_thresholds/update.md | 4 ++++ docs/api/noise_sensors/simulate/trigger_noise_threshold.md | 4 ++++ docs/api/phones/deactivate.md | 4 ++++ docs/api/phones/get.md | 4 ++++ docs/api/phones/list.md | 4 ++++ docs/api/phones/simulate/create_sandbox_phone.md | 4 ++++ docs/api/spaces/add_acs_entrances.md | 4 ++++ docs/api/spaces/add_devices.md | 4 ++++ docs/api/spaces/create.md | 4 ++++ docs/api/spaces/delete.md | 4 ++++ docs/api/spaces/get.md | 4 ++++ docs/api/spaces/get_related.md | 4 ++++ docs/api/spaces/list.md | 4 ++++ docs/api/spaces/remove_acs_entrances.md | 4 ++++ docs/api/spaces/remove_devices.md | 4 ++++ docs/api/spaces/update.md | 4 ++++ docs/api/thermostats/activate_climate_preset.md | 4 ++++ docs/api/thermostats/cool.md | 4 ++++ docs/api/thermostats/create_climate_preset.md | 4 ++++ docs/api/thermostats/daily_programs/create.md | 4 ++++ docs/api/thermostats/daily_programs/delete.md | 4 ++++ docs/api/thermostats/daily_programs/update.md | 4 ++++ docs/api/thermostats/delete_climate_preset.md | 4 ++++ docs/api/thermostats/heat.md | 4 ++++ docs/api/thermostats/heat_cool.md | 4 ++++ docs/api/thermostats/list.md | 4 ++++ docs/api/thermostats/off.md | 4 ++++ docs/api/thermostats/schedules/create.md | 4 ++++ docs/api/thermostats/schedules/delete.md | 4 ++++ docs/api/thermostats/schedules/get.md | 4 ++++ docs/api/thermostats/schedules/list.md | 4 ++++ docs/api/thermostats/schedules/update.md | 4 ++++ docs/api/thermostats/set_fallback_climate_preset.md | 4 ++++ docs/api/thermostats/set_fan_mode.md | 4 ++++ docs/api/thermostats/set_hvac_mode.md | 4 ++++ docs/api/thermostats/set_temperature_threshold.md | 4 ++++ docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 ++++ docs/api/thermostats/simulate/temperature_reached.md | 4 ++++ docs/api/thermostats/update_climate_preset.md | 4 ++++ docs/api/thermostats/update_weekly_program.md | 4 ++++ docs/api/user_identities/add_acs_user.md | 4 ++++ docs/api/user_identities/create.md | 4 ++++ docs/api/user_identities/delete.md | 4 ++++ docs/api/user_identities/generate_instant_key.md | 4 ++++ docs/api/user_identities/get.md | 4 ++++ docs/api/user_identities/grant_access_to_device.md | 4 ++++ docs/api/user_identities/list.md | 4 ++++ docs/api/user_identities/list_accessible_devices.md | 4 ++++ docs/api/user_identities/list_acs_systems.md | 4 ++++ docs/api/user_identities/list_acs_users.md | 4 ++++ docs/api/user_identities/remove_acs_user.md | 4 ++++ docs/api/user_identities/revoke_access_to_device.md | 4 ++++ docs/api/user_identities/unmanaged/get.md | 4 ++++ docs/api/user_identities/unmanaged/list.md | 4 ++++ docs/api/user_identities/unmanaged/update.md | 4 ++++ docs/api/user_identities/update.md | 4 ++++ docs/api/webhooks/create.md | 4 ++++ docs/api/webhooks/delete.md | 4 ++++ docs/api/webhooks/get.md | 4 ++++ docs/api/webhooks/list.md | 4 ++++ docs/api/webhooks/update.md | 4 ++++ docs/api/workspaces/create.md | 4 ++++ docs/api/workspaces/get.md | 4 ++++ docs/api/workspaces/list.md | 4 ++++ docs/api/workspaces/reset_sandbox.md | 4 ++++ docs/api/workspaces/update.md | 4 ++++ 191 files changed, 764 insertions(+) diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index b92e6bd08..b03bfb608 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -384,8 +384,12 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response +{% hint style="success" %} +**Returns:** [access\_code](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 529924fd3..d4d694644 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -443,8 +443,12 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response +{% hint style="success" %} +**Returns:** Array of [access\_codes](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 302a0ec5d..cb0af0b5f 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -160,5 +160,9 @@ ID of the device for which you want to delete the access code. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_codes/generate_code.md b/docs/api/access_codes/generate_code.md index 956561af1..2eb9eda03 100644 --- a/docs/api/access_codes/generate_code.md +++ b/docs/api/access_codes/generate_code.md @@ -150,8 +150,12 @@ ID of the device for which you want to generate a code. ## Response +{% hint style="success" %} +**Returns:** [access\_code](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 2bebe1a33..c2f49365c 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -297,8 +297,12 @@ ID of the device containing the access code that you want to get. You must speci ## Response +{% hint style="success" %} +**Returns:** [access\_code](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 9c7f54538..22c41fe03 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -332,8 +332,12 @@ Your user ID for the user by which to filter access codes. ## Response +{% hint style="success" %} +**Returns:** Array of [access\_codes](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 3409cd68f..b889593a9 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -295,8 +295,12 @@ ID of the access code for which you want to pull a backup access code. ## Response +{% hint style="success" %} +**Returns:** [access\_code](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/report_device_constraints.md b/docs/api/access_codes/report_device_constraints.md index 6ab8d5cab..a37a4574f 100644 --- a/docs/api/access_codes/report_device_constraints.md +++ b/docs/api/access_codes/report_device_constraints.md @@ -189,8 +189,12 @@ Array of supported code lengths as integers between 4 and 20, inclusive. You can ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index c541c7693..ecb88e286 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -255,8 +255,12 @@ Name of the simulated unmanaged access code. ## Response +{% hint style="success" %} +**Returns:** [unmanaged\_access\_code](./../unmanaged) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 7c2e841b4..58fd69621 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -181,5 +181,9 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 01c559374..6ad35d9f1 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -147,5 +147,9 @@ ID of the unmanaged access code that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 44a1cbec3..457b17a3d 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -245,8 +245,12 @@ ID of the device containing the unmanaged access code that you want to get. You ## Response +{% hint style="success" %} +**Returns:** [unmanaged\_access\_code](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index ca11a622b..fb3667c57 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -261,8 +261,12 @@ Your user ID for the user by which to filter unmanaged access codes. ## Response +{% hint style="success" %} +**Returns:** Array of [unmanaged\_access\_codes](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index 569f776ea..5bfbc9f21 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -186,5 +186,9 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index a469d2735..d8397b1ab 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -279,5 +279,9 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index a63464542..7c4ded4bb 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -193,5 +193,9 @@ Date and time at which the validity of the new access code starts, in [ISO 8601] ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_grants/create.md b/docs/api/access_grants/create.md index bbc519930..dcb4a1345 100644 --- a/docs/api/access_grants/create.md +++ b/docs/api/access_grants/create.md @@ -631,8 +631,12 @@ ID of user identity for whom access is being granted. ## Response +{% hint style="success" %} +**Returns:** [access\_grant](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_grants/delete.md b/docs/api/access_grants/delete.md index ea5932de6..9f5ad6214 100644 --- a/docs/api/access_grants/delete.md +++ b/docs/api/access_grants/delete.md @@ -148,5 +148,9 @@ ID of Access Grant to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_grants/get.md b/docs/api/access_grants/get.md index d4914f26b..9425187f2 100644 --- a/docs/api/access_grants/get.md +++ b/docs/api/access_grants/get.md @@ -387,8 +387,12 @@ Unique key of Access Grant to get. ## Response +{% hint style="success" %} +**Returns:** [access\_grant](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_grants/get_related.md b/docs/api/access_grants/get_related.md index 20888c637..1aae2c58f 100644 --- a/docs/api/access_grants/get_related.md +++ b/docs/api/access_grants/get_related.md @@ -65,5 +65,9 @@ Possible enum values: ## Response +{% hint style="success" %} +**Returns:** [unknown](./) +{% endhint %} + diff --git a/docs/api/access_grants/list.md b/docs/api/access_grants/list.md index 5ad605904..2eba75049 100644 --- a/docs/api/access_grants/list.md +++ b/docs/api/access_grants/list.md @@ -480,8 +480,12 @@ ID of user identity by which you want to filter the list of Access Grants. ## Response +{% hint style="success" %} +**Returns:** Array of [access\_grants](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_grants/request_access_methods.md b/docs/api/access_grants/request_access_methods.md index 28ea63934..eb69e7112 100644 --- a/docs/api/access_grants/request_access_methods.md +++ b/docs/api/access_grants/request_access_methods.md @@ -65,8 +65,12 @@ Enum values: ## Response +{% hint style="success" %} +**Returns:** [access\_grant](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_grants/unmanaged/get.md b/docs/api/access_grants/unmanaged/get.md index 49acf8398..3cfff850e 100644 --- a/docs/api/access_grants/unmanaged/get.md +++ b/docs/api/access_grants/unmanaged/get.md @@ -29,5 +29,9 @@ ID of unmanaged Access Grant to get. ## Response +{% hint style="success" %} +**Returns:** [unknown](./) +{% endhint %} + diff --git a/docs/api/access_grants/unmanaged/list.md b/docs/api/access_grants/unmanaged/list.md index 01b89cc97..90397a96d 100644 --- a/docs/api/access_grants/unmanaged/list.md +++ b/docs/api/access_grants/unmanaged/list.md @@ -47,5 +47,9 @@ ID of user identity by which you want to filter the list of unmanaged Access Gra ## Response +{% hint style="success" %} +**Returns:** Array of [unknowns](./) +{% endhint %} + diff --git a/docs/api/access_grants/unmanaged/update.md b/docs/api/access_grants/unmanaged/update.md index 6a2bc00d5..fb50a7bee 100644 --- a/docs/api/access_grants/unmanaged/update.md +++ b/docs/api/access_grants/unmanaged/update.md @@ -45,5 +45,9 @@ Unique key for the access grant. If not provided, the existing key will be prese ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_grants/update.md b/docs/api/access_grants/update.md index 42c28ce78..a76d2516f 100644 --- a/docs/api/access_grants/update.md +++ b/docs/api/access_grants/update.md @@ -180,5 +180,9 @@ Date and time at which the validity of the grant starts, in [ISO 8601](https://w ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_methods/delete.md b/docs/api/access_methods/delete.md index 76b809242..e7b9c3396 100644 --- a/docs/api/access_methods/delete.md +++ b/docs/api/access_methods/delete.md @@ -147,5 +147,9 @@ ID of access method to get. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/access_methods/encode.md b/docs/api/access_methods/encode.md index c7580676f..a82a12b2b 100644 --- a/docs/api/access_methods/encode.md +++ b/docs/api/access_methods/encode.md @@ -37,8 +37,12 @@ ID of the `acs_encoder` to use to encode the `access_method`. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_methods/get.md b/docs/api/access_methods/get.md index eb7a5fe98..2da9c4c61 100644 --- a/docs/api/access_methods/get.md +++ b/docs/api/access_methods/get.md @@ -197,8 +197,12 @@ ID of access method to get. ## Response +{% hint style="success" %} +**Returns:** [access\_method](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_methods/get_related.md b/docs/api/access_methods/get_related.md index 27c69f3e0..bc8777948 100644 --- a/docs/api/access_methods/get_related.md +++ b/docs/api/access_methods/get_related.md @@ -68,5 +68,9 @@ Possible enum values: ## Response +{% hint style="success" %} +**Returns:** [unknown](./) +{% endhint %} + diff --git a/docs/api/access_methods/list.md b/docs/api/access_methods/list.md index f4877271f..a72802632 100644 --- a/docs/api/access_methods/list.md +++ b/docs/api/access_methods/list.md @@ -324,8 +324,12 @@ ID of the space for which you want to retrieve all access methods. ## Response +{% hint style="success" %} +**Returns:** Array of [access\_methods](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/access_methods/unmanaged/get.md b/docs/api/access_methods/unmanaged/get.md index e2f91455b..6f2175cc1 100644 --- a/docs/api/access_methods/unmanaged/get.md +++ b/docs/api/access_methods/unmanaged/get.md @@ -28,5 +28,9 @@ ID of unmanaged access method to get. ## Response +{% hint style="success" %} +**Returns:** [unknown](./) +{% endhint %} + diff --git a/docs/api/access_methods/unmanaged/list.md b/docs/api/access_methods/unmanaged/list.md index 213af2ac1..cba8961d3 100644 --- a/docs/api/access_methods/unmanaged/list.md +++ b/docs/api/access_methods/unmanaged/list.md @@ -46,5 +46,9 @@ ID of the space for which you want to retrieve all unmanaged access methods. ## Response +{% hint style="success" %} +**Returns:** Array of [unknowns](./) +{% endhint %} + diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index eb1b3fa58..2c71eb115 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -166,8 +166,12 @@ ID of the desired user identity that you want to add to an access group. You can ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 314b64643..8e0f072cb 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -230,8 +230,12 @@ ID of the access group that you want to get. ## Response +{% hint style="success" %} +**Returns:** [acs\_access\_group](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 1bca4e7c9..b230ee6f1 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -269,8 +269,12 @@ ID of the user identity for which you want to retrieve all access groups. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_access\_groups](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index f71ea1652..ac6741027 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -265,8 +265,12 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_entrances](./../entrances) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 54eca3e50..2547de0cc 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -322,8 +322,12 @@ ID of the access group for which you want to retrieve all access system users. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_users](./../users) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 1269339f0..fa9db67a0 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -166,8 +166,12 @@ ID of the user identity associated with the user that you want to remove from an ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 3c9154d40..abfbb4249 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -166,8 +166,12 @@ ID of the user identity to whom you want to assign a credential. You can only pr ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index f2087c2d1..54a8b0167 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -518,8 +518,12 @@ Enum values: ## Response +{% hint style="success" %} +**Returns:** [acs\_credential](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 290cb1d4e..c89d95d48 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -144,5 +144,9 @@ ID of the credential that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index a59b9e8db..f0d142c5e 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -261,8 +261,12 @@ ID of the credential that you want to get. ## Response +{% hint style="success" %} +**Returns:** [acs\_credential](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 43ae5f532..c2eeaaf2f 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -307,8 +307,12 @@ ID of the user identity for which you want to retrieve all credentials. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_credentials](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 9a7663147..61b251025 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -265,8 +265,12 @@ ID of the credential for which you want to retrieve all entrances to which the c ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_entrances](./../entrances) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index d203276ab..5d82e5343 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -166,8 +166,12 @@ ID of the user identity from which you want to unassign a credential. You can on ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 19b5f3438..37d0ad184 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -170,5 +170,9 @@ Replacement date and time at which the validity of the credential ends, in [ISO ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index a31214f72..8cc70e7ab 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -383,8 +383,12 @@ ID of the `acs_credential` to encode onto a card. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/encoders/get.md b/docs/api/acs/encoders/get.md index e9607b55f..8321644c5 100644 --- a/docs/api/acs/encoders/get.md +++ b/docs/api/acs/encoders/get.md @@ -194,8 +194,12 @@ ID of the encoder that you want to get. ## Response +{% hint style="success" %} +**Returns:** [acs\_encoder](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index e82de7ffa..9be8aa97c 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -222,8 +222,12 @@ Identifies the specific page of results to return, obtained from the previous pa ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_encoders](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 9a37fe605..9da840c2f 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -541,8 +541,12 @@ ID of the encoder to use for the scan. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 1d522e511..b17701c18 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -165,5 +165,9 @@ Code of the error to simulate. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index dc381dc74..d77f1db0d 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -160,5 +160,9 @@ Scenario to simulate. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 725e30c69..59ec370bc 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -161,5 +161,9 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 9a67618b4..447d21e79 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -170,5 +170,9 @@ Scenario to simulate. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index bd2b6a08d..bc821ab5a 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -248,8 +248,12 @@ ID of the entrance that you want to get. ## Response +{% hint style="success" %} +**Returns:** [acs\_entrance](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index b5bef98e9..d80faa67d 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -166,8 +166,12 @@ ID of the user identity to whom you want to grant access to an entrance. You can ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index b9c4cdc77..43f142820 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -319,8 +319,12 @@ ID of the space for which you want to list entrances. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_entrances](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 31b74e069..659c047f1 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -291,8 +291,12 @@ Possible enum values: ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_credentials](./../credentials) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index c3b476904..f5d13ba10 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -257,8 +257,12 @@ ID of the access system that you want to get. ## Response +{% hint style="success" %} +**Returns:** [acs\_system](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index a4b33d475..41847cf08 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -280,8 +280,12 @@ Customer key for which you want to list access systems. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_systems](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index fcdb198bf..a33b5fed6 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -252,8 +252,12 @@ ID of the access system for which you want to retrieve all compatible credential ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_systems](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/systems/report_devices.md b/docs/api/acs/systems/report_devices.md index e3262f96f..737aef8f3 100644 --- a/docs/api/acs/systems/report_devices.md +++ b/docs/api/acs/systems/report_devices.md @@ -323,5 +323,9 @@ Whether the entrance is removed ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 72d95fa38..276938025 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -159,5 +159,9 @@ ID of the access system user that you want to add to an access group. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 3e1020d1d..7b8c074f6 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -424,8 +424,12 @@ ID of the user identity with which you want to associate the new access system u ## Response +{% hint style="success" %} +**Returns:** [acs\_user](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 20c1d92d4..4c25bfc8d 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -166,8 +166,12 @@ ID of the user identity that you want to delete. You must provide either acs_use ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index a166e8efa..39362a799 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -330,8 +330,12 @@ ID of the user identity that you want to get. You can only provide acs_user_id o ## Response +{% hint style="success" %} +**Returns:** [acs\_user](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 07c23ad1c..dc67b5d8e 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -364,8 +364,12 @@ Phone number of the user identity for which you want to retrieve all access syst ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_users](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 66abe7f20..1c5e82cfb 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -284,8 +284,12 @@ ID of the user identity for whom you want to list accessible entrances. You can ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_entrances](./../entrances) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7c4ecf957..ebfd97373 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -166,8 +166,12 @@ ID of the user identity that you want to remove from an access group. You can on ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 7526b63fd..a245a9c1e 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -166,8 +166,12 @@ ID of the user identity for whom you want to revoke access. You can only provide ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 87c70ffc2..5948b21ae 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -166,8 +166,12 @@ ID of the user identity that you want to suspend. You can only provide acs_user_ ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 6c44cedbc..7cc2ed301 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -166,8 +166,12 @@ ID of the user identity that you want to unsuspend. You can only provide acs_use ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 44d164914..1e4af9678 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -268,8 +268,12 @@ ID of the user identity that you want to update. You can only provide acs_user_i ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + --- diff --git a/docs/api/action_attempts/get.md b/docs/api/action_attempts/get.md index 852f841b0..28fc465e7 100644 --- a/docs/api/action_attempts/get.md +++ b/docs/api/action_attempts/get.md @@ -184,5 +184,9 @@ ID of the action attempt that you want to get. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + diff --git a/docs/api/action_attempts/list.md b/docs/api/action_attempts/list.md index d6e0f77c8..b39c76620 100644 --- a/docs/api/action_attempts/list.md +++ b/docs/api/action_attempts/list.md @@ -254,5 +254,9 @@ IDs of the action attempts that you want to retrieve. ## Response +{% hint style="success" %} +**Returns:** Array of [action\_attempts](./) +{% endhint %} + diff --git a/docs/api/client_sessions/create.md b/docs/api/client_sessions/create.md index b0d7a8dca..e57c14fea 100644 --- a/docs/api/client_sessions/create.md +++ b/docs/api/client_sessions/create.md @@ -303,8 +303,12 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response +{% hint style="success" %} +**Returns:** [client\_session](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/client_sessions/delete.md b/docs/api/client_sessions/delete.md index 8f4919bd6..9f1d50847 100644 --- a/docs/api/client_sessions/delete.md +++ b/docs/api/client_sessions/delete.md @@ -144,5 +144,9 @@ ID of the client session that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/client_sessions/get.md b/docs/api/client_sessions/get.md index df63df7b5..33542e590 100644 --- a/docs/api/client_sessions/get.md +++ b/docs/api/client_sessions/get.md @@ -226,8 +226,12 @@ User identifier key associated with the client session that you want to get. ## Response +{% hint style="success" %} +**Returns:** [client\_session](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/client_sessions/get_or_create.md b/docs/api/client_sessions/get_or_create.md index c31f8102e..3556c17b0 100644 --- a/docs/api/client_sessions/get_or_create.md +++ b/docs/api/client_sessions/get_or_create.md @@ -281,8 +281,12 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response +{% hint style="success" %} +**Returns:** [client\_session](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/client_sessions/grant_access.md b/docs/api/client_sessions/grant_access.md index 7ed510f61..4f21a2860 100644 --- a/docs/api/client_sessions/grant_access.md +++ b/docs/api/client_sessions/grant_access.md @@ -206,5 +206,9 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/client_sessions/list.md b/docs/api/client_sessions/list.md index 8fe6f986c..d22ea236e 100644 --- a/docs/api/client_sessions/list.md +++ b/docs/api/client_sessions/list.md @@ -255,8 +255,12 @@ Indicates whether to retrieve only client sessions without associated user ident ## Response +{% hint style="success" %} +**Returns:** Array of [client\_sessions](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/client_sessions/revoke.md b/docs/api/client_sessions/revoke.md index d5afb9944..d52178411 100644 --- a/docs/api/client_sessions/revoke.md +++ b/docs/api/client_sessions/revoke.md @@ -146,5 +146,9 @@ ID of the client session that you want to revoke. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/connect_webviews/create.md b/docs/api/connect_webviews/create.md index e3f3e7cc4..8f6009d90 100644 --- a/docs/api/connect_webviews/create.md +++ b/docs/api/connect_webviews/create.md @@ -639,8 +639,12 @@ Indicates whether Seam should finish syncing all devices in a newly-connected ac ## Response +{% hint style="success" %} +**Returns:** [connect\_webview](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/connect_webviews/delete.md b/docs/api/connect_webviews/delete.md index 7124735c2..494341d67 100644 --- a/docs/api/connect_webviews/delete.md +++ b/docs/api/connect_webviews/delete.md @@ -146,5 +146,9 @@ ID of the Connect Webview that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/connect_webviews/get.md b/docs/api/connect_webviews/get.md index 4a5eae95b..d5ff2ada6 100644 --- a/docs/api/connect_webviews/get.md +++ b/docs/api/connect_webviews/get.md @@ -279,8 +279,12 @@ ID of the Connect Webview that you want to get. ## Response +{% hint style="success" %} +**Returns:** [connect\_webview](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/connect_webviews/list.md b/docs/api/connect_webviews/list.md index b0d306fbb..e52f3a45c 100644 --- a/docs/api/connect_webviews/list.md +++ b/docs/api/connect_webviews/list.md @@ -309,8 +309,12 @@ Your user ID for the user by which you want to filter Connect Webviews. ## Response +{% hint style="success" %} +**Returns:** Array of [connect\_webviews](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/connected_accounts/delete.md b/docs/api/connected_accounts/delete.md index 774abb8f0..a20a99977 100644 --- a/docs/api/connected_accounts/delete.md +++ b/docs/api/connected_accounts/delete.md @@ -151,5 +151,9 @@ ID of the connected account that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/connected_accounts/get.md b/docs/api/connected_accounts/get.md index 8e169b738..03d6a63e8 100644 --- a/docs/api/connected_accounts/get.md +++ b/docs/api/connected_accounts/get.md @@ -252,8 +252,12 @@ Email address associated with the connected account that you want to get. ## Response +{% hint style="success" %} +**Returns:** [connected\_account](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/connected_accounts/list.md b/docs/api/connected_accounts/list.md index d0dc1e183..9c88d1713 100644 --- a/docs/api/connected_accounts/list.md +++ b/docs/api/connected_accounts/list.md @@ -293,8 +293,12 @@ Your user ID for the user by which you want to filter connected accounts. ## Response +{% hint style="success" %} +**Returns:** Array of [connected\_accounts](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/connected_accounts/simulate/disconnect.md b/docs/api/connected_accounts/simulate/disconnect.md index ebbf00fb2..f853e867b 100644 --- a/docs/api/connected_accounts/simulate/disconnect.md +++ b/docs/api/connected_accounts/simulate/disconnect.md @@ -26,5 +26,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/connected_accounts/sync.md b/docs/api/connected_accounts/sync.md index a2726de49..2e6e27ee8 100644 --- a/docs/api/connected_accounts/sync.md +++ b/docs/api/connected_accounts/sync.md @@ -146,5 +146,9 @@ ID of the connected account that you want to sync. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/connected_accounts/update.md b/docs/api/connected_accounts/update.md index 6ad273729..fa931c3c3 100644 --- a/docs/api/connected_accounts/update.md +++ b/docs/api/connected_accounts/update.md @@ -196,5 +196,9 @@ The customer key to associate with this connected account. If provided, the conn ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index f28e64f36..28d2e0c8c 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -361,8 +361,12 @@ The locale to use for the portal. ## Response +{% hint style="success" %} +**Returns:** [magic\_link](./../unstable_partner/building_blocks) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/customers/delete_data.md b/docs/api/customers/delete_data.md index fd2f94bef..bcc6e4569 100644 --- a/docs/api/customers/delete_data.md +++ b/docs/api/customers/delete_data.md @@ -140,5 +140,9 @@ List of user keys to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/customers/push_data.md b/docs/api/customers/push_data.md index ce133c832..322a4088b 100644 --- a/docs/api/customers/push_data.md +++ b/docs/api/customers/push_data.md @@ -1420,5 +1420,9 @@ Your unique identifier for the user. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/get.md b/docs/api/devices/get.md index 9907f6eab..aadcf4218 100644 --- a/docs/api/devices/get.md +++ b/docs/api/devices/get.md @@ -1141,8 +1141,12 @@ Name of the device that you want to get. ## Response +{% hint style="success" %} +**Returns:** [device](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/devices/list.md b/docs/api/devices/list.md index e77260be0..cc58f6ada 100644 --- a/docs/api/devices/list.md +++ b/docs/api/devices/list.md @@ -1297,8 +1297,12 @@ Your own internal user ID for the user for which you want to list devices. ## Response +{% hint style="success" %} +**Returns:** Array of [devices](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/devices/list_device_providers.md b/docs/api/devices/list_device_providers.md index c863809c1..4b77d6347 100644 --- a/docs/api/devices/list_device_providers.md +++ b/docs/api/devices/list_device_providers.md @@ -199,8 +199,12 @@ Category for which you want to list providers. ## Response +{% hint style="success" %} +**Returns:** Array of [device\_providers](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/devices/simulate/connect.md b/docs/api/devices/simulate/connect.md index 2c6994a3c..e647f598b 100644 --- a/docs/api/devices/simulate/connect.md +++ b/docs/api/devices/simulate/connect.md @@ -145,5 +145,9 @@ ID of the device that you want to simulate connecting to Seam. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/simulate/connect_to_hub.md b/docs/api/devices/simulate/connect_to_hub.md index 4b397492a..bd89a2818 100644 --- a/docs/api/devices/simulate/connect_to_hub.md +++ b/docs/api/devices/simulate/connect_to_hub.md @@ -149,5 +149,9 @@ ID of the device whose hub you want to reconnect. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/simulate/disconnect.md b/docs/api/devices/simulate/disconnect.md index ce317cede..a82b559fa 100644 --- a/docs/api/devices/simulate/disconnect.md +++ b/docs/api/devices/simulate/disconnect.md @@ -145,5 +145,9 @@ ID of the device that you want to simulate disconnecting from Seam. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/simulate/disconnect_from_hub.md b/docs/api/devices/simulate/disconnect_from_hub.md index 35d849115..2e21f19fe 100644 --- a/docs/api/devices/simulate/disconnect_from_hub.md +++ b/docs/api/devices/simulate/disconnect_from_hub.md @@ -152,5 +152,9 @@ ID of the device whose hub you want to disconnect. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/simulate/paid_subscription.md b/docs/api/devices/simulate/paid_subscription.md index cb93a4d01..1389278b0 100644 --- a/docs/api/devices/simulate/paid_subscription.md +++ b/docs/api/devices/simulate/paid_subscription.md @@ -33,5 +33,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/simulate/remove.md b/docs/api/devices/simulate/remove.md index 4c0d0a4db..65f4815dc 100644 --- a/docs/api/devices/simulate/remove.md +++ b/docs/api/devices/simulate/remove.md @@ -145,5 +145,9 @@ ID of the device that you want to simulate removing from Seam. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/unmanaged/get.md b/docs/api/devices/unmanaged/get.md index 62c2aa108..34eac06f5 100644 --- a/docs/api/devices/unmanaged/get.md +++ b/docs/api/devices/unmanaged/get.md @@ -415,8 +415,12 @@ Name of the unmanaged device that you want to get. ## Response +{% hint style="success" %} +**Returns:** [unmanaged\_device](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/devices/unmanaged/list.md b/docs/api/devices/unmanaged/list.md index 816fba106..5b97ca2f5 100644 --- a/docs/api/devices/unmanaged/list.md +++ b/docs/api/devices/unmanaged/list.md @@ -564,8 +564,12 @@ Your own internal user ID for the user for which you want to list devices. ## Response +{% hint style="success" %} +**Returns:** Array of [unmanaged\_devices](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/devices/unmanaged/update.md b/docs/api/devices/unmanaged/update.md index 09bf0b302..1f5adf3f0 100644 --- a/docs/api/devices/unmanaged/update.md +++ b/docs/api/devices/unmanaged/update.md @@ -163,5 +163,9 @@ Indicates whether the device is managed. Set this parameter to `true` to convert ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/devices/update.md b/docs/api/devices/update.md index 92edd400f..240318754 100644 --- a/docs/api/devices/update.md +++ b/docs/api/devices/update.md @@ -201,5 +201,9 @@ Name for the device. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/events/get.md b/docs/api/events/get.md index dd452ed54..4bf3aa71c 100644 --- a/docs/api/events/get.md +++ b/docs/api/events/get.md @@ -212,8 +212,12 @@ Type of the event that you want to get. ## Response +{% hint style="success" %} +**Returns:** [event](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/events/list.md b/docs/api/events/list.md index b75f558b1..02948862b 100644 --- a/docs/api/events/list.md +++ b/docs/api/events/list.md @@ -419,8 +419,12 @@ Offset for the events that you want to list. ## Response +{% hint style="success" %} +**Returns:** Array of [events](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/instant_keys/delete.md b/docs/api/instant_keys/delete.md index 1f8da53f4..0911ff9ae 100644 --- a/docs/api/instant_keys/delete.md +++ b/docs/api/instant_keys/delete.md @@ -28,5 +28,9 @@ ID of the Instant Key that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/instant_keys/get.md b/docs/api/instant_keys/get.md index 818c95a11..5723f572b 100644 --- a/docs/api/instant_keys/get.md +++ b/docs/api/instant_keys/get.md @@ -34,8 +34,12 @@ URL of the instant key to get. ## Response +{% hint style="success" %} +**Returns:** [instant\_key](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/instant_keys/list.md b/docs/api/instant_keys/list.md index d0f5ed58c..328bc1316 100644 --- a/docs/api/instant_keys/list.md +++ b/docs/api/instant_keys/list.md @@ -28,8 +28,12 @@ ID of the user identity by which you want to filter the list of Instant Keys. ## Response +{% hint style="success" %} +**Returns:** Array of [instant\_keys](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/locks/get.md b/docs/api/locks/get.md index 98577501c..cc47d7e12 100644 --- a/docs/api/locks/get.md +++ b/docs/api/locks/get.md @@ -35,8 +35,12 @@ Name of the lock that you want to get. ## Response +{% hint style="success" %} +**Returns:** [device](./../devices) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/locks/list.md b/docs/api/locks/list.md index 6103c6677..ee14bfaf7 100644 --- a/docs/api/locks/list.md +++ b/docs/api/locks/list.md @@ -1278,8 +1278,12 @@ Your own internal user ID for the user for which you want to list devices. ## Response +{% hint style="success" %} +**Returns:** Array of [devices](./../devices) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/locks/lock_door.md b/docs/api/locks/lock_door.md index 07cd87fc2..203f69473 100644 --- a/docs/api/locks/lock_door.md +++ b/docs/api/locks/lock_door.md @@ -182,8 +182,12 @@ ID of the lock that you want to lock. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/locks/simulate/keypad_code_entry.md b/docs/api/locks/simulate/keypad_code_entry.md index ca817d8a4..5bc7d0463 100644 --- a/docs/api/locks/simulate/keypad_code_entry.md +++ b/docs/api/locks/simulate/keypad_code_entry.md @@ -197,8 +197,12 @@ ID of the device for which you want to simulate a keypad code entry. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/locks/simulate/manual_lock_via_keypad.md b/docs/api/locks/simulate/manual_lock_via_keypad.md index 16f118161..242c671a9 100644 --- a/docs/api/locks/simulate/manual_lock_via_keypad.md +++ b/docs/api/locks/simulate/manual_lock_via_keypad.md @@ -185,8 +185,12 @@ ID of the device for which you want to simulate a manual lock action using a key ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/locks/unlock_door.md b/docs/api/locks/unlock_door.md index 8d1ec4dc8..61a06b5cb 100644 --- a/docs/api/locks/unlock_door.md +++ b/docs/api/locks/unlock_door.md @@ -182,8 +182,12 @@ ID of the lock that you want to unlock. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/noise_sensors/list.md b/docs/api/noise_sensors/list.md index 3541a22aa..0c9073059 100644 --- a/docs/api/noise_sensors/list.md +++ b/docs/api/noise_sensors/list.md @@ -702,8 +702,12 @@ Your own internal user ID for the user for which you want to list devices. ## Response +{% hint style="success" %} +**Returns:** Array of [devices](./../devices) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/noise_sensors/noise_thresholds/create.md b/docs/api/noise_sensors/noise_thresholds/create.md index d590b8511..77669cc01 100644 --- a/docs/api/noise_sensors/noise_thresholds/create.md +++ b/docs/api/noise_sensors/noise_thresholds/create.md @@ -253,8 +253,12 @@ Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. Th ## Response +{% hint style="success" %} +**Returns:** [noise\_threshold](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/noise_sensors/noise_thresholds/delete.md b/docs/api/noise_sensors/noise_thresholds/delete.md index 8d67fd61c..a89942c0a 100644 --- a/docs/api/noise_sensors/noise_thresholds/delete.md +++ b/docs/api/noise_sensors/noise_thresholds/delete.md @@ -159,5 +159,9 @@ ID of the noise threshold that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/noise_sensors/noise_thresholds/get.md b/docs/api/noise_sensors/noise_thresholds/get.md index ca4528f86..74f83ebb7 100644 --- a/docs/api/noise_sensors/noise_thresholds/get.md +++ b/docs/api/noise_sensors/noise_thresholds/get.md @@ -196,8 +196,12 @@ ID of the noise threshold that you want to get. ## Response +{% hint style="success" %} +**Returns:** [noise\_threshold](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/noise_sensors/noise_thresholds/list.md b/docs/api/noise_sensors/noise_thresholds/list.md index a02580d4c..b62d2a68f 100644 --- a/docs/api/noise_sensors/noise_thresholds/list.md +++ b/docs/api/noise_sensors/noise_thresholds/list.md @@ -209,8 +209,12 @@ ID of the device for which you want to list noise thresholds. ## Response +{% hint style="success" %} +**Returns:** Array of [noise\_thresholds](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/noise_sensors/noise_thresholds/update.md b/docs/api/noise_sensors/noise_thresholds/update.md index d122824a7..8700f58c8 100644 --- a/docs/api/noise_sensors/noise_thresholds/update.md +++ b/docs/api/noise_sensors/noise_thresholds/update.md @@ -214,5 +214,9 @@ Time at which the noise threshold should become active daily. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/noise_sensors/simulate/trigger_noise_threshold.md b/docs/api/noise_sensors/simulate/trigger_noise_threshold.md index 12e0f52b5..244e1d232 100644 --- a/docs/api/noise_sensors/simulate/trigger_noise_threshold.md +++ b/docs/api/noise_sensors/simulate/trigger_noise_threshold.md @@ -148,5 +148,9 @@ ID of the device for which you want to simulate the triggering of a noise thresh ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index aaeef14e3..4f2c5161d 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -143,5 +143,9 @@ Device ID of the phone that you want to deactivate. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 24dbeffc9..79f2a36e1 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -265,8 +265,12 @@ Device ID of the phone that you want to get. ## Response +{% hint style="success" %} +**Returns:** [phone](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 64908d7fd..305739438 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -288,8 +288,12 @@ ID of the user identity that represents the owner by which you want to filter th ## Response +{% hint style="success" %} +**Returns:** Array of [phones](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 246c299e3..34caaef10 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -485,8 +485,12 @@ Mobile operating system version that you want to use for the simulated phone. ## Response +{% hint style="success" %} +**Returns:** [phone](./..) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/spaces/add_acs_entrances.md b/docs/api/spaces/add_acs_entrances.md index 53ae2f051..32214bc3d 100644 --- a/docs/api/spaces/add_acs_entrances.md +++ b/docs/api/spaces/add_acs_entrances.md @@ -165,5 +165,9 @@ ID of the space to which you want to add entrances. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/spaces/add_devices.md b/docs/api/spaces/add_devices.md index c9f6d09ad..931a5a1a1 100644 --- a/docs/api/spaces/add_devices.md +++ b/docs/api/spaces/add_devices.md @@ -165,5 +165,9 @@ ID of the space to which you want to add devices. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/spaces/create.md b/docs/api/spaces/create.md index 6d4c19e28..0b243f007 100644 --- a/docs/api/spaces/create.md +++ b/docs/api/spaces/create.md @@ -228,8 +228,12 @@ Unique key for the space within the workspace. ## Response +{% hint style="success" %} +**Returns:** [space](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/spaces/delete.md b/docs/api/spaces/delete.md index 6373335eb..2c74b73de 100644 --- a/docs/api/spaces/delete.md +++ b/docs/api/spaces/delete.md @@ -144,5 +144,9 @@ ID of the space that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/spaces/get.md b/docs/api/spaces/get.md index 24b669b9b..9ae327ea9 100644 --- a/docs/api/spaces/get.md +++ b/docs/api/spaces/get.md @@ -188,8 +188,12 @@ Unique key of the space that you want to get. ## Response +{% hint style="success" %} +**Returns:** [space](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/spaces/get_related.md b/docs/api/spaces/get_related.md index 8633afea0..4192d5eb7 100644 --- a/docs/api/spaces/get_related.md +++ b/docs/api/spaces/get_related.md @@ -68,5 +68,9 @@ Keys of the spaces that you want to get along with their related resources. ## Response +{% hint style="success" %} +**Returns:** [unknown](./) +{% endhint %} + diff --git a/docs/api/spaces/list.md b/docs/api/spaces/list.md index 47259e78f..1164b011f 100644 --- a/docs/api/spaces/list.md +++ b/docs/api/spaces/list.md @@ -201,8 +201,12 @@ Filter spaces by space_key. ## Response +{% hint style="success" %} +**Returns:** Array of [spaces](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/spaces/remove_acs_entrances.md b/docs/api/spaces/remove_acs_entrances.md index 7dab2bbaf..04dcfee9a 100644 --- a/docs/api/spaces/remove_acs_entrances.md +++ b/docs/api/spaces/remove_acs_entrances.md @@ -165,5 +165,9 @@ ID of the space from which you want to remove entrances. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/spaces/remove_devices.md b/docs/api/spaces/remove_devices.md index c448033d4..30141c367 100644 --- a/docs/api/spaces/remove_devices.md +++ b/docs/api/spaces/remove_devices.md @@ -165,5 +165,9 @@ ID of the space from which you want to remove devices. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/spaces/update.md b/docs/api/spaces/update.md index 20b417ef8..8bcfff2d8 100644 --- a/docs/api/spaces/update.md +++ b/docs/api/spaces/update.md @@ -221,8 +221,12 @@ Unique key of the space that you want to update. ## Response +{% hint style="success" %} +**Returns:** [space](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 524b73c67..c7f695139 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -197,8 +197,12 @@ ID of the thermostat device for which you want to activate a climate preset. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index fada575f3..2c1ef9328 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -204,8 +204,12 @@ ID of the thermostat device that you want to set to cool mode. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index f64d1061f..c392b5467 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -292,5 +292,9 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/daily_programs/create.md b/docs/api/thermostats/daily_programs/create.md index d14ed6bbd..8e8abac45 100644 --- a/docs/api/thermostats/daily_programs/create.md +++ b/docs/api/thermostats/daily_programs/create.md @@ -303,8 +303,12 @@ Time at which the thermostat daily program period starts, in [ISO 8601](https:// ## Response +{% hint style="success" %} +**Returns:** [thermostat\_daily\_program](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/daily_programs/delete.md b/docs/api/thermostats/daily_programs/delete.md index e8212972e..968a4c52f 100644 --- a/docs/api/thermostats/daily_programs/delete.md +++ b/docs/api/thermostats/daily_programs/delete.md @@ -149,5 +149,9 @@ ID of the thermostat daily program that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/daily_programs/update.md b/docs/api/thermostats/daily_programs/update.md index b71801e56..201a26907 100644 --- a/docs/api/thermostats/daily_programs/update.md +++ b/docs/api/thermostats/daily_programs/update.md @@ -268,8 +268,12 @@ ID of the thermostat daily program that you want to update. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index cd39b53b9..b77a96a3a 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -159,5 +159,9 @@ ID of the thermostat device for which you want to delete a climate preset. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index fac252d30..0673c6bc1 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -204,8 +204,12 @@ ID of the thermostat device that you want to set to heat mode. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 259f25913..6849cebd2 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -222,8 +222,12 @@ ID of the thermostat device that you want to set to heat-cool mode. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 418933553..e16e8a482 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -1256,8 +1256,12 @@ Your own internal user ID for the user for which you want to list devices. ## Response +{% hint style="success" %} +**Returns:** Array of [devices](./../devices) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index f564aceaf..5c9cca34b 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -182,8 +182,12 @@ ID of the thermostat device that you want to set to off mode. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 1162459c1..06824c337 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -289,8 +289,12 @@ Name of the thermostat schedule. ## Response +{% hint style="success" %} +**Returns:** [thermostat\_schedule](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 770cb98f5..8fb477331 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -147,5 +147,9 @@ ID of the thermostat schedule that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 76362b062..1d9b290cf 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -221,8 +221,12 @@ ID of the thermostat schedule that you want to get. ## Response +{% hint style="success" %} +**Returns:** [thermostat\_schedule](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index e4c9f1102..52a7d0e51 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -238,8 +238,12 @@ User identifier key by which to filter the list of returned thermostat schedules ## Response +{% hint style="success" %} +**Returns:** Array of [thermostat\_schedules](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index b8534f9b3..ba94fc3c8 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -215,5 +215,9 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index fb14957d9..f57e30111 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -158,5 +158,9 @@ ID of the thermostat device for which you want to set the fallback climate prese ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 377d6371a..431ae9e89 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -206,8 +206,12 @@ ID of the thermostat device for which you want to set the fan mode. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index a306ceeea..4eccbe1e6 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -231,8 +231,12 @@ ID of the thermostat device for which you want to set the HVAC mode. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 19457c764..0e6fd9ddb 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -182,5 +182,9 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index ec8738422..853a9b7f7 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -188,5 +188,9 @@ Heating [set point](../../../capability-guides/thermostats/understanding-thermos ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index cc05fe361..604a022aa 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -164,5 +164,9 @@ Temperature in °F that you want simulate the thermostat reaching. You must set ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 75ad78ab5..df8b22086 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -292,5 +292,9 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/thermostats/update_weekly_program.md b/docs/api/thermostats/update_weekly_program.md index e148d4e1c..3439f25ff 100644 --- a/docs/api/thermostats/update_weekly_program.md +++ b/docs/api/thermostats/update_weekly_program.md @@ -265,8 +265,12 @@ ID of the thermostat daily program to run on Wednesdays. ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index afadb0bea..4aae262fd 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -169,5 +169,9 @@ Key of the user identity to which you want to add an access system user. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 1c127445f..bc0270392 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -262,8 +262,12 @@ Unique key for the new user identity. ## Response +{% hint style="success" %} +**Returns:** [user\_identity](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 1be606203..7e4615ed7 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -144,5 +144,9 @@ ID of the user identity that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/user_identities/generate_instant_key.md b/docs/api/user_identities/generate_instant_key.md index 4224cbad4..2068571b1 100644 --- a/docs/api/user_identities/generate_instant_key.md +++ b/docs/api/user_identities/generate_instant_key.md @@ -212,8 +212,12 @@ Maximum number of times the instant key can be used. Default: 1. ## Response +{% hint style="success" %} +**Returns:** [instant\_key](./../instant_keys) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 0f9e08d5f..af4221534 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -218,8 +218,12 @@ ID of the user identity that you want to get. ## Response +{% hint style="success" %} +**Returns:** [user\_identity](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index ad5c499d3..c01f8a014 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -159,5 +159,9 @@ ID of the user identity that you want to grant access to a device. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 8de2edc33..fa9f0faf5 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -241,8 +241,12 @@ String for which to search. Filters returned user identities to include all reco ## Response +{% hint style="success" %} +**Returns:** Array of [user\_identitys](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 598ebb4fa..22cbc6e49 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -1159,8 +1159,12 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Response +{% hint style="success" %} +**Returns:** Array of [devices](./../devices) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 7b32f41ae..6217658fa 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -274,8 +274,12 @@ ID of the user identity for which you want to retrieve all access systems. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_systems](./../acs/systems) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 0110f3a7d..13b4f5537 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -322,8 +322,12 @@ ID of the user identity for which you want to retrieve all access system users. ## Response +{% hint style="success" %} +**Returns:** Array of [acs\_users](./../acs/users) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e5c515836..da61d7ca5 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -159,5 +159,9 @@ ID of the user identity from which you want to remove an access system user. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index b1d53053c..6bc997096 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -159,5 +159,9 @@ ID of the user identity from which you want to revoke access to a device. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/user_identities/unmanaged/get.md b/docs/api/user_identities/unmanaged/get.md index a6fa74442..63ceac59f 100644 --- a/docs/api/user_identities/unmanaged/get.md +++ b/docs/api/user_identities/unmanaged/get.md @@ -28,5 +28,9 @@ ID of the unmanaged user identity that you want to get. ## Response +{% hint style="success" %} +**Returns:** [unknown](./) +{% endhint %} + diff --git a/docs/api/user_identities/unmanaged/list.md b/docs/api/user_identities/unmanaged/list.md index 4aaf684dc..c86293f8d 100644 --- a/docs/api/user_identities/unmanaged/list.md +++ b/docs/api/user_identities/unmanaged/list.md @@ -47,5 +47,9 @@ String for which to search. Filters returned unmanaged user identities to includ ## Response +{% hint style="success" %} +**Returns:** Array of [unknowns](./) +{% endhint %} + diff --git a/docs/api/user_identities/unmanaged/update.md b/docs/api/user_identities/unmanaged/update.md index d32b983a3..c7f8c8779 100644 --- a/docs/api/user_identities/unmanaged/update.md +++ b/docs/api/user_identities/unmanaged/update.md @@ -43,5 +43,9 @@ Unique key for the user identity. If not provided, the existing key will be pres ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index ad1fe61b5..8e635e7a6 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -192,5 +192,9 @@ Unique key for the user identity. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/webhooks/create.md b/docs/api/webhooks/create.md index e195874f6..7dc299119 100644 --- a/docs/api/webhooks/create.md +++ b/docs/api/webhooks/create.md @@ -193,8 +193,12 @@ Types of events that you want the new webhook to receive. ## Response +{% hint style="success" %} +**Returns:** [webhook](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/webhooks/delete.md b/docs/api/webhooks/delete.md index 265c2bc3f..ab50596d7 100644 --- a/docs/api/webhooks/delete.md +++ b/docs/api/webhooks/delete.md @@ -142,5 +142,9 @@ ID of the webhook that you want to delete. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/webhooks/get.md b/docs/api/webhooks/get.md index 1f9390dfa..8ec2301ad 100644 --- a/docs/api/webhooks/get.md +++ b/docs/api/webhooks/get.md @@ -172,8 +172,12 @@ ID of the webhook that you want to get. ## Response +{% hint style="success" %} +**Returns:** [webhook](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/webhooks/list.md b/docs/api/webhooks/list.md index 113e36a66..2122808a2 100644 --- a/docs/api/webhooks/list.md +++ b/docs/api/webhooks/list.md @@ -175,8 +175,12 @@ None ## Response +{% hint style="success" %} +**Returns:** Array of [webhooks](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/webhooks/update.md b/docs/api/webhooks/update.md index cdb7442e5..ca60a7d0e 100644 --- a/docs/api/webhooks/update.md +++ b/docs/api/webhooks/update.md @@ -175,5 +175,9 @@ ID of the webhook that you want to update. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + diff --git a/docs/api/workspaces/create.md b/docs/api/workspaces/create.md index cf4a3d100..8f780bed1 100644 --- a/docs/api/workspaces/create.md +++ b/docs/api/workspaces/create.md @@ -444,8 +444,12 @@ Indicates whether the new workspace is a [sandbox workspace](../../core-concepts ## Response +{% hint style="success" %} +**Returns:** [workspace](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/workspaces/get.md b/docs/api/workspaces/get.md index b13c39851..299307d66 100644 --- a/docs/api/workspaces/get.md +++ b/docs/api/workspaces/get.md @@ -233,8 +233,12 @@ None ## Response +{% hint style="success" %} +**Returns:** [workspace](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/workspaces/list.md b/docs/api/workspaces/list.md index 1aa601288..9cea8a76d 100644 --- a/docs/api/workspaces/list.md +++ b/docs/api/workspaces/list.md @@ -245,8 +245,12 @@ None ## Response +{% hint style="success" %} +**Returns:** Array of [workspaces](.) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/workspaces/reset_sandbox.md b/docs/api/workspaces/reset_sandbox.md index ac10e512b..2d8bf9bcd 100644 --- a/docs/api/workspaces/reset_sandbox.md +++ b/docs/api/workspaces/reset_sandbox.md @@ -170,8 +170,12 @@ None ## Response +{% hint style="success" %} +**Returns:** [action\_attempt](./) +{% endhint %} + {% tabs %} {% tab title="JSON" %} diff --git a/docs/api/workspaces/update.md b/docs/api/workspaces/update.md index 434931691..9c963676f 100644 --- a/docs/api/workspaces/update.md +++ b/docs/api/workspaces/update.md @@ -271,5 +271,9 @@ Name of the workspace. ## Response +{% hint style="success" %} +**Returns:** void +{% endhint %} + From 6a33a23c34331c63dacb03e3b7b81d611a310c58 Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Wed, 12 Nov 2025 12:38:01 -0800 Subject: [PATCH 3/4] Fix formatting for response returns in api-endpoint.hbs --- codegen/layouts/api-endpoint.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/codegen/layouts/api-endpoint.hbs b/codegen/layouts/api-endpoint.hbs index 0810ba2e9..7d9a80813 100644 --- a/codegen/layouts/api-endpoint.hbs +++ b/codegen/layouts/api-endpoint.hbs @@ -74,8 +74,8 @@ None ## Response {% hint style="success" %} -**Returns:** -{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{else}}[{{response.escapedResourceType}}]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{/if}}{{else}}void{{/if}} +Returns: +**{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{else}}[{{response.escapedResourceType}}]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{/if}}{{else}}void{{/if}}** {% endhint %} From 53014c0772e0d27078a0dab73f5f8b1e71f12cb8 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 12 Nov 2025 20:39:52 +0000 Subject: [PATCH 4/4] ci: Generate docs --- docs/api/access_codes/create.md | 4 ++-- docs/api/access_codes/create_multiple.md | 4 ++-- docs/api/access_codes/delete.md | 4 ++-- docs/api/access_codes/generate_code.md | 4 ++-- docs/api/access_codes/get.md | 4 ++-- docs/api/access_codes/list.md | 4 ++-- docs/api/access_codes/pull_backup_access_code.md | 4 ++-- docs/api/access_codes/report_device_constraints.md | 4 ++-- .../api/access_codes/simulate/create_unmanaged_access_code.md | 4 ++-- docs/api/access_codes/unmanaged/convert_to_managed.md | 4 ++-- docs/api/access_codes/unmanaged/delete.md | 4 ++-- docs/api/access_codes/unmanaged/get.md | 4 ++-- docs/api/access_codes/unmanaged/list.md | 4 ++-- docs/api/access_codes/unmanaged/update.md | 4 ++-- docs/api/access_codes/update.md | 4 ++-- docs/api/access_codes/update_multiple.md | 4 ++-- docs/api/access_grants/create.md | 4 ++-- docs/api/access_grants/delete.md | 4 ++-- docs/api/access_grants/get.md | 4 ++-- docs/api/access_grants/get_related.md | 4 ++-- docs/api/access_grants/list.md | 4 ++-- docs/api/access_grants/request_access_methods.md | 4 ++-- docs/api/access_grants/unmanaged/get.md | 4 ++-- docs/api/access_grants/unmanaged/list.md | 4 ++-- docs/api/access_grants/unmanaged/update.md | 4 ++-- docs/api/access_grants/update.md | 4 ++-- docs/api/access_methods/delete.md | 4 ++-- docs/api/access_methods/encode.md | 4 ++-- docs/api/access_methods/get.md | 4 ++-- docs/api/access_methods/get_related.md | 4 ++-- docs/api/access_methods/list.md | 4 ++-- docs/api/access_methods/unmanaged/get.md | 4 ++-- docs/api/access_methods/unmanaged/list.md | 4 ++-- docs/api/acs/access_groups/add_user.md | 4 ++-- docs/api/acs/access_groups/get.md | 4 ++-- docs/api/acs/access_groups/list.md | 4 ++-- docs/api/acs/access_groups/list_accessible_entrances.md | 4 ++-- docs/api/acs/access_groups/list_users.md | 4 ++-- docs/api/acs/access_groups/remove_user.md | 4 ++-- docs/api/acs/credentials/assign.md | 4 ++-- docs/api/acs/credentials/create.md | 4 ++-- docs/api/acs/credentials/delete.md | 4 ++-- docs/api/acs/credentials/get.md | 4 ++-- docs/api/acs/credentials/list.md | 4 ++-- docs/api/acs/credentials/list_accessible_entrances.md | 4 ++-- docs/api/acs/credentials/unassign.md | 4 ++-- docs/api/acs/credentials/update.md | 4 ++-- docs/api/acs/encoders/encode_credential.md | 4 ++-- docs/api/acs/encoders/get.md | 4 ++-- docs/api/acs/encoders/list.md | 4 ++-- docs/api/acs/encoders/scan_credential.md | 4 ++-- .../acs/encoders/simulate/next_credential_encode_will_fail.md | 4 ++-- .../encoders/simulate/next_credential_encode_will_succeed.md | 4 ++-- .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 ++-- .../encoders/simulate/next_credential_scan_will_succeed.md | 4 ++-- docs/api/acs/entrances/get.md | 4 ++-- docs/api/acs/entrances/grant_access.md | 4 ++-- docs/api/acs/entrances/list.md | 4 ++-- docs/api/acs/entrances/list_credentials_with_access.md | 4 ++-- docs/api/acs/systems/get.md | 4 ++-- docs/api/acs/systems/list.md | 4 ++-- .../systems/list_compatible_credential_manager_acs_systems.md | 4 ++-- docs/api/acs/systems/report_devices.md | 4 ++-- docs/api/acs/users/add_to_access_group.md | 4 ++-- docs/api/acs/users/create.md | 4 ++-- docs/api/acs/users/delete.md | 4 ++-- docs/api/acs/users/get.md | 4 ++-- docs/api/acs/users/list.md | 4 ++-- docs/api/acs/users/list_accessible_entrances.md | 4 ++-- docs/api/acs/users/remove_from_access_group.md | 4 ++-- docs/api/acs/users/revoke_access_to_all_entrances.md | 4 ++-- docs/api/acs/users/suspend.md | 4 ++-- docs/api/acs/users/unsuspend.md | 4 ++-- docs/api/acs/users/update.md | 4 ++-- docs/api/action_attempts/get.md | 4 ++-- docs/api/action_attempts/list.md | 4 ++-- docs/api/client_sessions/create.md | 4 ++-- docs/api/client_sessions/delete.md | 4 ++-- docs/api/client_sessions/get.md | 4 ++-- docs/api/client_sessions/get_or_create.md | 4 ++-- docs/api/client_sessions/grant_access.md | 4 ++-- docs/api/client_sessions/list.md | 4 ++-- docs/api/client_sessions/revoke.md | 4 ++-- docs/api/connect_webviews/create.md | 4 ++-- docs/api/connect_webviews/delete.md | 4 ++-- docs/api/connect_webviews/get.md | 4 ++-- docs/api/connect_webviews/list.md | 4 ++-- docs/api/connected_accounts/delete.md | 4 ++-- docs/api/connected_accounts/get.md | 4 ++-- docs/api/connected_accounts/list.md | 4 ++-- docs/api/connected_accounts/simulate/disconnect.md | 4 ++-- docs/api/connected_accounts/sync.md | 4 ++-- docs/api/connected_accounts/update.md | 4 ++-- docs/api/customers/create_portal.md | 4 ++-- docs/api/customers/delete_data.md | 4 ++-- docs/api/customers/push_data.md | 4 ++-- docs/api/devices/get.md | 4 ++-- docs/api/devices/list.md | 4 ++-- docs/api/devices/list_device_providers.md | 4 ++-- docs/api/devices/simulate/connect.md | 4 ++-- docs/api/devices/simulate/connect_to_hub.md | 4 ++-- docs/api/devices/simulate/disconnect.md | 4 ++-- docs/api/devices/simulate/disconnect_from_hub.md | 4 ++-- docs/api/devices/simulate/paid_subscription.md | 4 ++-- docs/api/devices/simulate/remove.md | 4 ++-- docs/api/devices/unmanaged/get.md | 4 ++-- docs/api/devices/unmanaged/list.md | 4 ++-- docs/api/devices/unmanaged/update.md | 4 ++-- docs/api/devices/update.md | 4 ++-- docs/api/events/get.md | 4 ++-- docs/api/events/list.md | 4 ++-- docs/api/instant_keys/delete.md | 4 ++-- docs/api/instant_keys/get.md | 4 ++-- docs/api/instant_keys/list.md | 4 ++-- docs/api/locks/get.md | 4 ++-- docs/api/locks/list.md | 4 ++-- docs/api/locks/lock_door.md | 4 ++-- docs/api/locks/simulate/keypad_code_entry.md | 4 ++-- docs/api/locks/simulate/manual_lock_via_keypad.md | 4 ++-- docs/api/locks/unlock_door.md | 4 ++-- docs/api/noise_sensors/list.md | 4 ++-- docs/api/noise_sensors/noise_thresholds/create.md | 4 ++-- docs/api/noise_sensors/noise_thresholds/delete.md | 4 ++-- docs/api/noise_sensors/noise_thresholds/get.md | 4 ++-- docs/api/noise_sensors/noise_thresholds/list.md | 4 ++-- docs/api/noise_sensors/noise_thresholds/update.md | 4 ++-- docs/api/noise_sensors/simulate/trigger_noise_threshold.md | 4 ++-- docs/api/phones/deactivate.md | 4 ++-- docs/api/phones/get.md | 4 ++-- docs/api/phones/list.md | 4 ++-- docs/api/phones/simulate/create_sandbox_phone.md | 4 ++-- docs/api/spaces/add_acs_entrances.md | 4 ++-- docs/api/spaces/add_devices.md | 4 ++-- docs/api/spaces/create.md | 4 ++-- docs/api/spaces/delete.md | 4 ++-- docs/api/spaces/get.md | 4 ++-- docs/api/spaces/get_related.md | 4 ++-- docs/api/spaces/list.md | 4 ++-- docs/api/spaces/remove_acs_entrances.md | 4 ++-- docs/api/spaces/remove_devices.md | 4 ++-- docs/api/spaces/update.md | 4 ++-- docs/api/thermostats/activate_climate_preset.md | 4 ++-- docs/api/thermostats/cool.md | 4 ++-- docs/api/thermostats/create_climate_preset.md | 4 ++-- docs/api/thermostats/daily_programs/create.md | 4 ++-- docs/api/thermostats/daily_programs/delete.md | 4 ++-- docs/api/thermostats/daily_programs/update.md | 4 ++-- docs/api/thermostats/delete_climate_preset.md | 4 ++-- docs/api/thermostats/heat.md | 4 ++-- docs/api/thermostats/heat_cool.md | 4 ++-- docs/api/thermostats/list.md | 4 ++-- docs/api/thermostats/off.md | 4 ++-- docs/api/thermostats/schedules/create.md | 4 ++-- docs/api/thermostats/schedules/delete.md | 4 ++-- docs/api/thermostats/schedules/get.md | 4 ++-- docs/api/thermostats/schedules/list.md | 4 ++-- docs/api/thermostats/schedules/update.md | 4 ++-- docs/api/thermostats/set_fallback_climate_preset.md | 4 ++-- docs/api/thermostats/set_fan_mode.md | 4 ++-- docs/api/thermostats/set_hvac_mode.md | 4 ++-- docs/api/thermostats/set_temperature_threshold.md | 4 ++-- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 ++-- docs/api/thermostats/simulate/temperature_reached.md | 4 ++-- docs/api/thermostats/update_climate_preset.md | 4 ++-- docs/api/thermostats/update_weekly_program.md | 4 ++-- docs/api/user_identities/add_acs_user.md | 4 ++-- docs/api/user_identities/create.md | 4 ++-- docs/api/user_identities/delete.md | 4 ++-- docs/api/user_identities/generate_instant_key.md | 4 ++-- docs/api/user_identities/get.md | 4 ++-- docs/api/user_identities/grant_access_to_device.md | 4 ++-- docs/api/user_identities/list.md | 4 ++-- docs/api/user_identities/list_accessible_devices.md | 4 ++-- docs/api/user_identities/list_acs_systems.md | 4 ++-- docs/api/user_identities/list_acs_users.md | 4 ++-- docs/api/user_identities/remove_acs_user.md | 4 ++-- docs/api/user_identities/revoke_access_to_device.md | 4 ++-- docs/api/user_identities/unmanaged/get.md | 4 ++-- docs/api/user_identities/unmanaged/list.md | 4 ++-- docs/api/user_identities/unmanaged/update.md | 4 ++-- docs/api/user_identities/update.md | 4 ++-- docs/api/webhooks/create.md | 4 ++-- docs/api/webhooks/delete.md | 4 ++-- docs/api/webhooks/get.md | 4 ++-- docs/api/webhooks/list.md | 4 ++-- docs/api/webhooks/update.md | 4 ++-- docs/api/workspaces/create.md | 4 ++-- docs/api/workspaces/get.md | 4 ++-- docs/api/workspaces/list.md | 4 ++-- docs/api/workspaces/reset_sandbox.md | 4 ++-- docs/api/workspaces/update.md | 4 ++-- 191 files changed, 382 insertions(+), 382 deletions(-) diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index b03bfb608..84e24eadb 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -385,8 +385,8 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response {% hint style="success" %} -**Returns:** -[access\_code](.) +Returns: +**[access\_code](.)** {% endhint %} diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index d4d694644..fd2e9fccb 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -444,8 +444,8 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response {% hint style="success" %} -**Returns:** -Array of [access\_codes](.) +Returns: +**Array of [access\_codes](.)** {% endhint %} diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index cb0af0b5f..24651b60d 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -161,8 +161,8 @@ ID of the device for which you want to delete the access code. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_codes/generate_code.md b/docs/api/access_codes/generate_code.md index 2eb9eda03..fe38e678c 100644 --- a/docs/api/access_codes/generate_code.md +++ b/docs/api/access_codes/generate_code.md @@ -151,8 +151,8 @@ ID of the device for which you want to generate a code. ## Response {% hint style="success" %} -**Returns:** -[access\_code](.) +Returns: +**[access\_code](.)** {% endhint %} diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index c2f49365c..5a3ac3b9c 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -298,8 +298,8 @@ ID of the device containing the access code that you want to get. You must speci ## Response {% hint style="success" %} -**Returns:** -[access\_code](.) +Returns: +**[access\_code](.)** {% endhint %} diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 22c41fe03..007f74985 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -333,8 +333,8 @@ Your user ID for the user by which to filter access codes. ## Response {% hint style="success" %} -**Returns:** -Array of [access\_codes](.) +Returns: +**Array of [access\_codes](.)** {% endhint %} diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index b889593a9..91b50a505 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -296,8 +296,8 @@ ID of the access code for which you want to pull a backup access code. ## Response {% hint style="success" %} -**Returns:** -[access\_code](.) +Returns: +**[access\_code](.)** {% endhint %} diff --git a/docs/api/access_codes/report_device_constraints.md b/docs/api/access_codes/report_device_constraints.md index a37a4574f..2b695f149 100644 --- a/docs/api/access_codes/report_device_constraints.md +++ b/docs/api/access_codes/report_device_constraints.md @@ -190,8 +190,8 @@ Array of supported code lengths as integers between 4 and 20, inclusive. You can ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index ecb88e286..657cd9633 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -256,8 +256,8 @@ Name of the simulated unmanaged access code. ## Response {% hint style="success" %} -**Returns:** -[unmanaged\_access\_code](./../unmanaged) +Returns: +**[unmanaged\_access\_code](./../unmanaged)** {% endhint %} diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 58fd69621..0ab93a87c 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -182,8 +182,8 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 6ad35d9f1..50d821bd0 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -148,8 +148,8 @@ ID of the unmanaged access code that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 457b17a3d..af394483c 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -246,8 +246,8 @@ ID of the device containing the unmanaged access code that you want to get. You ## Response {% hint style="success" %} -**Returns:** -[unmanaged\_access\_code](.) +Returns: +**[unmanaged\_access\_code](.)** {% endhint %} diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index fb3667c57..8a7135b38 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -262,8 +262,8 @@ Your user ID for the user by which to filter unmanaged access codes. ## Response {% hint style="success" %} -**Returns:** -Array of [unmanaged\_access\_codes](.) +Returns: +**Array of [unmanaged\_access\_codes](.)** {% endhint %} diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index 5bfbc9f21..ec4afe867 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -187,8 +187,8 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index d8397b1ab..60f218fac 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -280,8 +280,8 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 7c4ded4bb..e0b843192 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -194,8 +194,8 @@ Date and time at which the validity of the new access code starts, in [ISO 8601] ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_grants/create.md b/docs/api/access_grants/create.md index dcb4a1345..6ef92d157 100644 --- a/docs/api/access_grants/create.md +++ b/docs/api/access_grants/create.md @@ -632,8 +632,8 @@ ID of user identity for whom access is being granted. ## Response {% hint style="success" %} -**Returns:** -[access\_grant](.) +Returns: +**[access\_grant](.)** {% endhint %} diff --git a/docs/api/access_grants/delete.md b/docs/api/access_grants/delete.md index 9f5ad6214..a254a3c94 100644 --- a/docs/api/access_grants/delete.md +++ b/docs/api/access_grants/delete.md @@ -149,8 +149,8 @@ ID of Access Grant to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_grants/get.md b/docs/api/access_grants/get.md index 9425187f2..81750b163 100644 --- a/docs/api/access_grants/get.md +++ b/docs/api/access_grants/get.md @@ -388,8 +388,8 @@ Unique key of Access Grant to get. ## Response {% hint style="success" %} -**Returns:** -[access\_grant](.) +Returns: +**[access\_grant](.)** {% endhint %} diff --git a/docs/api/access_grants/get_related.md b/docs/api/access_grants/get_related.md index 1aae2c58f..236d18cec 100644 --- a/docs/api/access_grants/get_related.md +++ b/docs/api/access_grants/get_related.md @@ -66,8 +66,8 @@ Possible enum values: ## Response {% hint style="success" %} -**Returns:** -[unknown](./) +Returns: +**[unknown](./)** {% endhint %} diff --git a/docs/api/access_grants/list.md b/docs/api/access_grants/list.md index 2eba75049..a7310a706 100644 --- a/docs/api/access_grants/list.md +++ b/docs/api/access_grants/list.md @@ -481,8 +481,8 @@ ID of user identity by which you want to filter the list of Access Grants. ## Response {% hint style="success" %} -**Returns:** -Array of [access\_grants](.) +Returns: +**Array of [access\_grants](.)** {% endhint %} diff --git a/docs/api/access_grants/request_access_methods.md b/docs/api/access_grants/request_access_methods.md index eb69e7112..067b0700b 100644 --- a/docs/api/access_grants/request_access_methods.md +++ b/docs/api/access_grants/request_access_methods.md @@ -66,8 +66,8 @@ Enum values: ## Response {% hint style="success" %} -**Returns:** -[access\_grant](.) +Returns: +**[access\_grant](.)** {% endhint %} diff --git a/docs/api/access_grants/unmanaged/get.md b/docs/api/access_grants/unmanaged/get.md index 3cfff850e..d40f700ea 100644 --- a/docs/api/access_grants/unmanaged/get.md +++ b/docs/api/access_grants/unmanaged/get.md @@ -30,8 +30,8 @@ ID of unmanaged Access Grant to get. ## Response {% hint style="success" %} -**Returns:** -[unknown](./) +Returns: +**[unknown](./)** {% endhint %} diff --git a/docs/api/access_grants/unmanaged/list.md b/docs/api/access_grants/unmanaged/list.md index 90397a96d..96896504c 100644 --- a/docs/api/access_grants/unmanaged/list.md +++ b/docs/api/access_grants/unmanaged/list.md @@ -48,8 +48,8 @@ ID of user identity by which you want to filter the list of unmanaged Access Gra ## Response {% hint style="success" %} -**Returns:** -Array of [unknowns](./) +Returns: +**Array of [unknowns](./)** {% endhint %} diff --git a/docs/api/access_grants/unmanaged/update.md b/docs/api/access_grants/unmanaged/update.md index fb50a7bee..ec5651307 100644 --- a/docs/api/access_grants/unmanaged/update.md +++ b/docs/api/access_grants/unmanaged/update.md @@ -46,8 +46,8 @@ Unique key for the access grant. If not provided, the existing key will be prese ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_grants/update.md b/docs/api/access_grants/update.md index a76d2516f..8645c4902 100644 --- a/docs/api/access_grants/update.md +++ b/docs/api/access_grants/update.md @@ -181,8 +181,8 @@ Date and time at which the validity of the grant starts, in [ISO 8601](https://w ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_methods/delete.md b/docs/api/access_methods/delete.md index e7b9c3396..53a92fba0 100644 --- a/docs/api/access_methods/delete.md +++ b/docs/api/access_methods/delete.md @@ -148,8 +148,8 @@ ID of access method to get. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/access_methods/encode.md b/docs/api/access_methods/encode.md index a82a12b2b..9afa15c20 100644 --- a/docs/api/access_methods/encode.md +++ b/docs/api/access_methods/encode.md @@ -38,8 +38,8 @@ ID of the `acs_encoder` to use to encode the `access_method`. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/access_methods/get.md b/docs/api/access_methods/get.md index 2da9c4c61..d06f75cb1 100644 --- a/docs/api/access_methods/get.md +++ b/docs/api/access_methods/get.md @@ -198,8 +198,8 @@ ID of access method to get. ## Response {% hint style="success" %} -**Returns:** -[access\_method](.) +Returns: +**[access\_method](.)** {% endhint %} diff --git a/docs/api/access_methods/get_related.md b/docs/api/access_methods/get_related.md index bc8777948..2f721f7e4 100644 --- a/docs/api/access_methods/get_related.md +++ b/docs/api/access_methods/get_related.md @@ -69,8 +69,8 @@ Possible enum values: ## Response {% hint style="success" %} -**Returns:** -[unknown](./) +Returns: +**[unknown](./)** {% endhint %} diff --git a/docs/api/access_methods/list.md b/docs/api/access_methods/list.md index a72802632..94133e756 100644 --- a/docs/api/access_methods/list.md +++ b/docs/api/access_methods/list.md @@ -325,8 +325,8 @@ ID of the space for which you want to retrieve all access methods. ## Response {% hint style="success" %} -**Returns:** -Array of [access\_methods](.) +Returns: +**Array of [access\_methods](.)** {% endhint %} diff --git a/docs/api/access_methods/unmanaged/get.md b/docs/api/access_methods/unmanaged/get.md index 6f2175cc1..b86e508bb 100644 --- a/docs/api/access_methods/unmanaged/get.md +++ b/docs/api/access_methods/unmanaged/get.md @@ -29,8 +29,8 @@ ID of unmanaged access method to get. ## Response {% hint style="success" %} -**Returns:** -[unknown](./) +Returns: +**[unknown](./)** {% endhint %} diff --git a/docs/api/access_methods/unmanaged/list.md b/docs/api/access_methods/unmanaged/list.md index cba8961d3..5623b9cc6 100644 --- a/docs/api/access_methods/unmanaged/list.md +++ b/docs/api/access_methods/unmanaged/list.md @@ -47,8 +47,8 @@ ID of the space for which you want to retrieve all unmanaged access methods. ## Response {% hint style="success" %} -**Returns:** -Array of [unknowns](./) +Returns: +**Array of [unknowns](./)** {% endhint %} diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 2c71eb115..4eb442d81 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -167,8 +167,8 @@ ID of the desired user identity that you want to add to an access group. You can ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 8e0f072cb..b9b525231 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -231,8 +231,8 @@ ID of the access group that you want to get. ## Response {% hint style="success" %} -**Returns:** -[acs\_access\_group](.) +Returns: +**[acs\_access\_group](.)** {% endhint %} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index b230ee6f1..9fea29738 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -270,8 +270,8 @@ ID of the user identity for which you want to retrieve all access groups. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_access\_groups](.) +Returns: +**Array of [acs\_access\_groups](.)** {% endhint %} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index ac6741027..a2419eb01 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -266,8 +266,8 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_entrances](./../entrances) +Returns: +**Array of [acs\_entrances](./../entrances)** {% endhint %} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 2547de0cc..5320302db 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -323,8 +323,8 @@ ID of the access group for which you want to retrieve all access system users. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_users](./../users) +Returns: +**Array of [acs\_users](./../users)** {% endhint %} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index fa9db67a0..59ffd2930 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -167,8 +167,8 @@ ID of the user identity associated with the user that you want to remove from an ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index abfbb4249..f64fb98ef 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -167,8 +167,8 @@ ID of the user identity to whom you want to assign a credential. You can only pr ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 54a8b0167..5d65f92e3 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -519,8 +519,8 @@ Enum values: ## Response {% hint style="success" %} -**Returns:** -[acs\_credential](.) +Returns: +**[acs\_credential](.)** {% endhint %} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index c89d95d48..717fc079d 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -145,8 +145,8 @@ ID of the credential that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index f0d142c5e..594752c91 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -262,8 +262,8 @@ ID of the credential that you want to get. ## Response {% hint style="success" %} -**Returns:** -[acs\_credential](.) +Returns: +**[acs\_credential](.)** {% endhint %} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index c2eeaaf2f..1f8bf4309 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -308,8 +308,8 @@ ID of the user identity for which you want to retrieve all credentials. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_credentials](.) +Returns: +**Array of [acs\_credentials](.)** {% endhint %} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 61b251025..61ac22e58 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -266,8 +266,8 @@ ID of the credential for which you want to retrieve all entrances to which the c ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_entrances](./../entrances) +Returns: +**Array of [acs\_entrances](./../entrances)** {% endhint %} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 5d82e5343..6811c9c41 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -167,8 +167,8 @@ ID of the user identity from which you want to unassign a credential. You can on ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 37d0ad184..ce4276286 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -171,8 +171,8 @@ Replacement date and time at which the validity of the credential ends, in [ISO ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 8cc70e7ab..3ae3b25d6 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -384,8 +384,8 @@ ID of the `acs_credential` to encode onto a card. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/acs/encoders/get.md b/docs/api/acs/encoders/get.md index 8321644c5..7ee23dc80 100644 --- a/docs/api/acs/encoders/get.md +++ b/docs/api/acs/encoders/get.md @@ -195,8 +195,8 @@ ID of the encoder that you want to get. ## Response {% hint style="success" %} -**Returns:** -[acs\_encoder](.) +Returns: +**[acs\_encoder](.)** {% endhint %} diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 9be8aa97c..7cc1f06f6 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -223,8 +223,8 @@ Identifies the specific page of results to return, obtained from the previous pa ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_encoders](.) +Returns: +**Array of [acs\_encoders](.)** {% endhint %} diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 9da840c2f..b416ae0ea 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -542,8 +542,8 @@ ID of the encoder to use for the scan. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index b17701c18..cb1ee7a4d 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -166,8 +166,8 @@ Code of the error to simulate. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index d77f1db0d..6190a991a 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -161,8 +161,8 @@ Scenario to simulate. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 59ec370bc..d364fdd55 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -162,8 +162,8 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 447d21e79..8182bc2e4 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -171,8 +171,8 @@ Scenario to simulate. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index bc821ab5a..2106e1999 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -249,8 +249,8 @@ ID of the entrance that you want to get. ## Response {% hint style="success" %} -**Returns:** -[acs\_entrance](.) +Returns: +**[acs\_entrance](.)** {% endhint %} diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index d80faa67d..a285afcb5 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -167,8 +167,8 @@ ID of the user identity to whom you want to grant access to an entrance. You can ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 43f142820..b9de85e61 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -320,8 +320,8 @@ ID of the space for which you want to list entrances. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_entrances](.) +Returns: +**Array of [acs\_entrances](.)** {% endhint %} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 659c047f1..1c44c6cc4 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -292,8 +292,8 @@ Possible enum values: ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_credentials](./../credentials) +Returns: +**Array of [acs\_credentials](./../credentials)** {% endhint %} diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index f5d13ba10..c53156b15 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -258,8 +258,8 @@ ID of the access system that you want to get. ## Response {% hint style="success" %} -**Returns:** -[acs\_system](.) +Returns: +**[acs\_system](.)** {% endhint %} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 41847cf08..0fceb1cb2 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -281,8 +281,8 @@ Customer key for which you want to list access systems. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_systems](.) +Returns: +**Array of [acs\_systems](.)** {% endhint %} diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index a33b5fed6..655123a44 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -253,8 +253,8 @@ ID of the access system for which you want to retrieve all compatible credential ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_systems](.) +Returns: +**Array of [acs\_systems](.)** {% endhint %} diff --git a/docs/api/acs/systems/report_devices.md b/docs/api/acs/systems/report_devices.md index 737aef8f3..99f0c438c 100644 --- a/docs/api/acs/systems/report_devices.md +++ b/docs/api/acs/systems/report_devices.md @@ -324,8 +324,8 @@ Whether the entrance is removed ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 276938025..5002ddc0c 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -160,8 +160,8 @@ ID of the access system user that you want to add to an access group. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 7b8c074f6..91cd6c729 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -425,8 +425,8 @@ ID of the user identity with which you want to associate the new access system u ## Response {% hint style="success" %} -**Returns:** -[acs\_user](.) +Returns: +**[acs\_user](.)** {% endhint %} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 4c25bfc8d..56b176f26 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -167,8 +167,8 @@ ID of the user identity that you want to delete. You must provide either acs_use ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 39362a799..96e7ff4ff 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -331,8 +331,8 @@ ID of the user identity that you want to get. You can only provide acs_user_id o ## Response {% hint style="success" %} -**Returns:** -[acs\_user](.) +Returns: +**[acs\_user](.)** {% endhint %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index dc67b5d8e..fe0b0a54b 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -365,8 +365,8 @@ Phone number of the user identity for which you want to retrieve all access syst ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_users](.) +Returns: +**Array of [acs\_users](.)** {% endhint %} diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 1c5e82cfb..2179ac8a0 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -285,8 +285,8 @@ ID of the user identity for whom you want to list accessible entrances. You can ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_entrances](./../entrances) +Returns: +**Array of [acs\_entrances](./../entrances)** {% endhint %} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index ebfd97373..b85a9d6b4 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -167,8 +167,8 @@ ID of the user identity that you want to remove from an access group. You can on ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index a245a9c1e..4b95dead6 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -167,8 +167,8 @@ ID of the user identity for whom you want to revoke access. You can only provide ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 5948b21ae..901c2209a 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -167,8 +167,8 @@ ID of the user identity that you want to suspend. You can only provide acs_user_ ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 7cc2ed301..0d4171e59 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -167,8 +167,8 @@ ID of the user identity that you want to unsuspend. You can only provide acs_use ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 1e4af9678..3e77d369b 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -269,8 +269,8 @@ ID of the user identity that you want to update. You can only provide acs_user_i ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/action_attempts/get.md b/docs/api/action_attempts/get.md index 28fc465e7..15c33189a 100644 --- a/docs/api/action_attempts/get.md +++ b/docs/api/action_attempts/get.md @@ -185,8 +185,8 @@ ID of the action attempt that you want to get. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/action_attempts/list.md b/docs/api/action_attempts/list.md index b39c76620..748478c28 100644 --- a/docs/api/action_attempts/list.md +++ b/docs/api/action_attempts/list.md @@ -255,8 +255,8 @@ IDs of the action attempts that you want to retrieve. ## Response {% hint style="success" %} -**Returns:** -Array of [action\_attempts](./) +Returns: +**Array of [action\_attempts](./)** {% endhint %} diff --git a/docs/api/client_sessions/create.md b/docs/api/client_sessions/create.md index e57c14fea..3e62fc4ae 100644 --- a/docs/api/client_sessions/create.md +++ b/docs/api/client_sessions/create.md @@ -304,8 +304,8 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response {% hint style="success" %} -**Returns:** -[client\_session](.) +Returns: +**[client\_session](.)** {% endhint %} diff --git a/docs/api/client_sessions/delete.md b/docs/api/client_sessions/delete.md index 9f1d50847..4a38a509c 100644 --- a/docs/api/client_sessions/delete.md +++ b/docs/api/client_sessions/delete.md @@ -145,8 +145,8 @@ ID of the client session that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/client_sessions/get.md b/docs/api/client_sessions/get.md index 33542e590..96678e9b7 100644 --- a/docs/api/client_sessions/get.md +++ b/docs/api/client_sessions/get.md @@ -227,8 +227,8 @@ User identifier key associated with the client session that you want to get. ## Response {% hint style="success" %} -**Returns:** -[client\_session](.) +Returns: +**[client\_session](.)** {% endhint %} diff --git a/docs/api/client_sessions/get_or_create.md b/docs/api/client_sessions/get_or_create.md index 3556c17b0..0fc6b1202 100644 --- a/docs/api/client_sessions/get_or_create.md +++ b/docs/api/client_sessions/get_or_create.md @@ -282,8 +282,8 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response {% hint style="success" %} -**Returns:** -[client\_session](.) +Returns: +**[client\_session](.)** {% endhint %} diff --git a/docs/api/client_sessions/grant_access.md b/docs/api/client_sessions/grant_access.md index 4f21a2860..da1dddf68 100644 --- a/docs/api/client_sessions/grant_access.md +++ b/docs/api/client_sessions/grant_access.md @@ -207,8 +207,8 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/client_sessions/list.md b/docs/api/client_sessions/list.md index d22ea236e..2f807dc4a 100644 --- a/docs/api/client_sessions/list.md +++ b/docs/api/client_sessions/list.md @@ -256,8 +256,8 @@ Indicates whether to retrieve only client sessions without associated user ident ## Response {% hint style="success" %} -**Returns:** -Array of [client\_sessions](.) +Returns: +**Array of [client\_sessions](.)** {% endhint %} diff --git a/docs/api/client_sessions/revoke.md b/docs/api/client_sessions/revoke.md index d52178411..aa97acb7a 100644 --- a/docs/api/client_sessions/revoke.md +++ b/docs/api/client_sessions/revoke.md @@ -147,8 +147,8 @@ ID of the client session that you want to revoke. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/connect_webviews/create.md b/docs/api/connect_webviews/create.md index 8f6009d90..19135b743 100644 --- a/docs/api/connect_webviews/create.md +++ b/docs/api/connect_webviews/create.md @@ -640,8 +640,8 @@ Indicates whether Seam should finish syncing all devices in a newly-connected ac ## Response {% hint style="success" %} -**Returns:** -[connect\_webview](.) +Returns: +**[connect\_webview](.)** {% endhint %} diff --git a/docs/api/connect_webviews/delete.md b/docs/api/connect_webviews/delete.md index 494341d67..c2f790e4b 100644 --- a/docs/api/connect_webviews/delete.md +++ b/docs/api/connect_webviews/delete.md @@ -147,8 +147,8 @@ ID of the Connect Webview that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/connect_webviews/get.md b/docs/api/connect_webviews/get.md index d5ff2ada6..160b538b8 100644 --- a/docs/api/connect_webviews/get.md +++ b/docs/api/connect_webviews/get.md @@ -280,8 +280,8 @@ ID of the Connect Webview that you want to get. ## Response {% hint style="success" %} -**Returns:** -[connect\_webview](.) +Returns: +**[connect\_webview](.)** {% endhint %} diff --git a/docs/api/connect_webviews/list.md b/docs/api/connect_webviews/list.md index e52f3a45c..88a769ea6 100644 --- a/docs/api/connect_webviews/list.md +++ b/docs/api/connect_webviews/list.md @@ -310,8 +310,8 @@ Your user ID for the user by which you want to filter Connect Webviews. ## Response {% hint style="success" %} -**Returns:** -Array of [connect\_webviews](.) +Returns: +**Array of [connect\_webviews](.)** {% endhint %} diff --git a/docs/api/connected_accounts/delete.md b/docs/api/connected_accounts/delete.md index a20a99977..e16331e3c 100644 --- a/docs/api/connected_accounts/delete.md +++ b/docs/api/connected_accounts/delete.md @@ -152,8 +152,8 @@ ID of the connected account that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/connected_accounts/get.md b/docs/api/connected_accounts/get.md index 03d6a63e8..e2b684d02 100644 --- a/docs/api/connected_accounts/get.md +++ b/docs/api/connected_accounts/get.md @@ -253,8 +253,8 @@ Email address associated with the connected account that you want to get. ## Response {% hint style="success" %} -**Returns:** -[connected\_account](.) +Returns: +**[connected\_account](.)** {% endhint %} diff --git a/docs/api/connected_accounts/list.md b/docs/api/connected_accounts/list.md index 9c88d1713..96e207cc2 100644 --- a/docs/api/connected_accounts/list.md +++ b/docs/api/connected_accounts/list.md @@ -294,8 +294,8 @@ Your user ID for the user by which you want to filter connected accounts. ## Response {% hint style="success" %} -**Returns:** -Array of [connected\_accounts](.) +Returns: +**Array of [connected\_accounts](.)** {% endhint %} diff --git a/docs/api/connected_accounts/simulate/disconnect.md b/docs/api/connected_accounts/simulate/disconnect.md index f853e867b..259a8c2fa 100644 --- a/docs/api/connected_accounts/simulate/disconnect.md +++ b/docs/api/connected_accounts/simulate/disconnect.md @@ -27,8 +27,8 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/connected_accounts/sync.md b/docs/api/connected_accounts/sync.md index 2e6e27ee8..8b01b2009 100644 --- a/docs/api/connected_accounts/sync.md +++ b/docs/api/connected_accounts/sync.md @@ -147,8 +147,8 @@ ID of the connected account that you want to sync. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/connected_accounts/update.md b/docs/api/connected_accounts/update.md index fa931c3c3..35fa2a4a1 100644 --- a/docs/api/connected_accounts/update.md +++ b/docs/api/connected_accounts/update.md @@ -197,8 +197,8 @@ The customer key to associate with this connected account. If provided, the conn ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index 28d2e0c8c..370f0218e 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -362,8 +362,8 @@ The locale to use for the portal. ## Response {% hint style="success" %} -**Returns:** -[magic\_link](./../unstable_partner/building_blocks) +Returns: +**[magic\_link](./../unstable_partner/building_blocks)** {% endhint %} diff --git a/docs/api/customers/delete_data.md b/docs/api/customers/delete_data.md index bcc6e4569..59f6648d8 100644 --- a/docs/api/customers/delete_data.md +++ b/docs/api/customers/delete_data.md @@ -141,8 +141,8 @@ List of user keys to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/customers/push_data.md b/docs/api/customers/push_data.md index 322a4088b..e8a1de6ef 100644 --- a/docs/api/customers/push_data.md +++ b/docs/api/customers/push_data.md @@ -1421,8 +1421,8 @@ Your unique identifier for the user. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/get.md b/docs/api/devices/get.md index aadcf4218..7b5aec30d 100644 --- a/docs/api/devices/get.md +++ b/docs/api/devices/get.md @@ -1142,8 +1142,8 @@ Name of the device that you want to get. ## Response {% hint style="success" %} -**Returns:** -[device](.) +Returns: +**[device](.)** {% endhint %} diff --git a/docs/api/devices/list.md b/docs/api/devices/list.md index cc58f6ada..57b4a9a8a 100644 --- a/docs/api/devices/list.md +++ b/docs/api/devices/list.md @@ -1298,8 +1298,8 @@ Your own internal user ID for the user for which you want to list devices. ## Response {% hint style="success" %} -**Returns:** -Array of [devices](.) +Returns: +**Array of [devices](.)** {% endhint %} diff --git a/docs/api/devices/list_device_providers.md b/docs/api/devices/list_device_providers.md index 4b77d6347..9fd7e68b2 100644 --- a/docs/api/devices/list_device_providers.md +++ b/docs/api/devices/list_device_providers.md @@ -200,8 +200,8 @@ Category for which you want to list providers. ## Response {% hint style="success" %} -**Returns:** -Array of [device\_providers](.) +Returns: +**Array of [device\_providers](.)** {% endhint %} diff --git a/docs/api/devices/simulate/connect.md b/docs/api/devices/simulate/connect.md index e647f598b..d7a98900f 100644 --- a/docs/api/devices/simulate/connect.md +++ b/docs/api/devices/simulate/connect.md @@ -146,8 +146,8 @@ ID of the device that you want to simulate connecting to Seam. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/simulate/connect_to_hub.md b/docs/api/devices/simulate/connect_to_hub.md index bd89a2818..50f814801 100644 --- a/docs/api/devices/simulate/connect_to_hub.md +++ b/docs/api/devices/simulate/connect_to_hub.md @@ -150,8 +150,8 @@ ID of the device whose hub you want to reconnect. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/simulate/disconnect.md b/docs/api/devices/simulate/disconnect.md index a82b559fa..01e061a69 100644 --- a/docs/api/devices/simulate/disconnect.md +++ b/docs/api/devices/simulate/disconnect.md @@ -146,8 +146,8 @@ ID of the device that you want to simulate disconnecting from Seam. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/simulate/disconnect_from_hub.md b/docs/api/devices/simulate/disconnect_from_hub.md index 2e21f19fe..ce862f2ef 100644 --- a/docs/api/devices/simulate/disconnect_from_hub.md +++ b/docs/api/devices/simulate/disconnect_from_hub.md @@ -153,8 +153,8 @@ ID of the device whose hub you want to disconnect. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/simulate/paid_subscription.md b/docs/api/devices/simulate/paid_subscription.md index 1389278b0..f29272c04 100644 --- a/docs/api/devices/simulate/paid_subscription.md +++ b/docs/api/devices/simulate/paid_subscription.md @@ -34,8 +34,8 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/simulate/remove.md b/docs/api/devices/simulate/remove.md index 65f4815dc..280c93f98 100644 --- a/docs/api/devices/simulate/remove.md +++ b/docs/api/devices/simulate/remove.md @@ -146,8 +146,8 @@ ID of the device that you want to simulate removing from Seam. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/unmanaged/get.md b/docs/api/devices/unmanaged/get.md index 34eac06f5..37c28c713 100644 --- a/docs/api/devices/unmanaged/get.md +++ b/docs/api/devices/unmanaged/get.md @@ -416,8 +416,8 @@ Name of the unmanaged device that you want to get. ## Response {% hint style="success" %} -**Returns:** -[unmanaged\_device](.) +Returns: +**[unmanaged\_device](.)** {% endhint %} diff --git a/docs/api/devices/unmanaged/list.md b/docs/api/devices/unmanaged/list.md index 5b97ca2f5..02fda0799 100644 --- a/docs/api/devices/unmanaged/list.md +++ b/docs/api/devices/unmanaged/list.md @@ -565,8 +565,8 @@ Your own internal user ID for the user for which you want to list devices. ## Response {% hint style="success" %} -**Returns:** -Array of [unmanaged\_devices](.) +Returns: +**Array of [unmanaged\_devices](.)** {% endhint %} diff --git a/docs/api/devices/unmanaged/update.md b/docs/api/devices/unmanaged/update.md index 1f5adf3f0..9d2883214 100644 --- a/docs/api/devices/unmanaged/update.md +++ b/docs/api/devices/unmanaged/update.md @@ -164,8 +164,8 @@ Indicates whether the device is managed. Set this parameter to `true` to convert ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/devices/update.md b/docs/api/devices/update.md index 240318754..8253e86dd 100644 --- a/docs/api/devices/update.md +++ b/docs/api/devices/update.md @@ -202,8 +202,8 @@ Name for the device. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/events/get.md b/docs/api/events/get.md index 4bf3aa71c..33f16ba31 100644 --- a/docs/api/events/get.md +++ b/docs/api/events/get.md @@ -213,8 +213,8 @@ Type of the event that you want to get. ## Response {% hint style="success" %} -**Returns:** -[event](.) +Returns: +**[event](.)** {% endhint %} diff --git a/docs/api/events/list.md b/docs/api/events/list.md index 02948862b..c005d3ff7 100644 --- a/docs/api/events/list.md +++ b/docs/api/events/list.md @@ -420,8 +420,8 @@ Offset for the events that you want to list. ## Response {% hint style="success" %} -**Returns:** -Array of [events](.) +Returns: +**Array of [events](.)** {% endhint %} diff --git a/docs/api/instant_keys/delete.md b/docs/api/instant_keys/delete.md index 0911ff9ae..4884bd34b 100644 --- a/docs/api/instant_keys/delete.md +++ b/docs/api/instant_keys/delete.md @@ -29,8 +29,8 @@ ID of the Instant Key that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/instant_keys/get.md b/docs/api/instant_keys/get.md index 5723f572b..54d274bae 100644 --- a/docs/api/instant_keys/get.md +++ b/docs/api/instant_keys/get.md @@ -35,8 +35,8 @@ URL of the instant key to get. ## Response {% hint style="success" %} -**Returns:** -[instant\_key](.) +Returns: +**[instant\_key](.)** {% endhint %} diff --git a/docs/api/instant_keys/list.md b/docs/api/instant_keys/list.md index 328bc1316..eb7e21a83 100644 --- a/docs/api/instant_keys/list.md +++ b/docs/api/instant_keys/list.md @@ -29,8 +29,8 @@ ID of the user identity by which you want to filter the list of Instant Keys. ## Response {% hint style="success" %} -**Returns:** -Array of [instant\_keys](.) +Returns: +**Array of [instant\_keys](.)** {% endhint %} diff --git a/docs/api/locks/get.md b/docs/api/locks/get.md index cc47d7e12..8d224015d 100644 --- a/docs/api/locks/get.md +++ b/docs/api/locks/get.md @@ -36,8 +36,8 @@ Name of the lock that you want to get. ## Response {% hint style="success" %} -**Returns:** -[device](./../devices) +Returns: +**[device](./../devices)** {% endhint %} diff --git a/docs/api/locks/list.md b/docs/api/locks/list.md index ee14bfaf7..68b4860a9 100644 --- a/docs/api/locks/list.md +++ b/docs/api/locks/list.md @@ -1279,8 +1279,8 @@ Your own internal user ID for the user for which you want to list devices. ## Response {% hint style="success" %} -**Returns:** -Array of [devices](./../devices) +Returns: +**Array of [devices](./../devices)** {% endhint %} diff --git a/docs/api/locks/lock_door.md b/docs/api/locks/lock_door.md index 203f69473..38cf57304 100644 --- a/docs/api/locks/lock_door.md +++ b/docs/api/locks/lock_door.md @@ -183,8 +183,8 @@ ID of the lock that you want to lock. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/locks/simulate/keypad_code_entry.md b/docs/api/locks/simulate/keypad_code_entry.md index 5bc7d0463..b2af9be3b 100644 --- a/docs/api/locks/simulate/keypad_code_entry.md +++ b/docs/api/locks/simulate/keypad_code_entry.md @@ -198,8 +198,8 @@ ID of the device for which you want to simulate a keypad code entry. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/locks/simulate/manual_lock_via_keypad.md b/docs/api/locks/simulate/manual_lock_via_keypad.md index 242c671a9..333e5db13 100644 --- a/docs/api/locks/simulate/manual_lock_via_keypad.md +++ b/docs/api/locks/simulate/manual_lock_via_keypad.md @@ -186,8 +186,8 @@ ID of the device for which you want to simulate a manual lock action using a key ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/locks/unlock_door.md b/docs/api/locks/unlock_door.md index 61a06b5cb..fc1e182da 100644 --- a/docs/api/locks/unlock_door.md +++ b/docs/api/locks/unlock_door.md @@ -183,8 +183,8 @@ ID of the lock that you want to unlock. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/noise_sensors/list.md b/docs/api/noise_sensors/list.md index 0c9073059..c1fe98b29 100644 --- a/docs/api/noise_sensors/list.md +++ b/docs/api/noise_sensors/list.md @@ -703,8 +703,8 @@ Your own internal user ID for the user for which you want to list devices. ## Response {% hint style="success" %} -**Returns:** -Array of [devices](./../devices) +Returns: +**Array of [devices](./../devices)** {% endhint %} diff --git a/docs/api/noise_sensors/noise_thresholds/create.md b/docs/api/noise_sensors/noise_thresholds/create.md index 77669cc01..773c423b5 100644 --- a/docs/api/noise_sensors/noise_thresholds/create.md +++ b/docs/api/noise_sensors/noise_thresholds/create.md @@ -254,8 +254,8 @@ Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. Th ## Response {% hint style="success" %} -**Returns:** -[noise\_threshold](.) +Returns: +**[noise\_threshold](.)** {% endhint %} diff --git a/docs/api/noise_sensors/noise_thresholds/delete.md b/docs/api/noise_sensors/noise_thresholds/delete.md index a89942c0a..621af5f7b 100644 --- a/docs/api/noise_sensors/noise_thresholds/delete.md +++ b/docs/api/noise_sensors/noise_thresholds/delete.md @@ -160,8 +160,8 @@ ID of the noise threshold that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/noise_sensors/noise_thresholds/get.md b/docs/api/noise_sensors/noise_thresholds/get.md index 74f83ebb7..04a134f9d 100644 --- a/docs/api/noise_sensors/noise_thresholds/get.md +++ b/docs/api/noise_sensors/noise_thresholds/get.md @@ -197,8 +197,8 @@ ID of the noise threshold that you want to get. ## Response {% hint style="success" %} -**Returns:** -[noise\_threshold](.) +Returns: +**[noise\_threshold](.)** {% endhint %} diff --git a/docs/api/noise_sensors/noise_thresholds/list.md b/docs/api/noise_sensors/noise_thresholds/list.md index b62d2a68f..1917dda5f 100644 --- a/docs/api/noise_sensors/noise_thresholds/list.md +++ b/docs/api/noise_sensors/noise_thresholds/list.md @@ -210,8 +210,8 @@ ID of the device for which you want to list noise thresholds. ## Response {% hint style="success" %} -**Returns:** -Array of [noise\_thresholds](.) +Returns: +**Array of [noise\_thresholds](.)** {% endhint %} diff --git a/docs/api/noise_sensors/noise_thresholds/update.md b/docs/api/noise_sensors/noise_thresholds/update.md index 8700f58c8..8c675d359 100644 --- a/docs/api/noise_sensors/noise_thresholds/update.md +++ b/docs/api/noise_sensors/noise_thresholds/update.md @@ -215,8 +215,8 @@ Time at which the noise threshold should become active daily. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/noise_sensors/simulate/trigger_noise_threshold.md b/docs/api/noise_sensors/simulate/trigger_noise_threshold.md index 244e1d232..899727c87 100644 --- a/docs/api/noise_sensors/simulate/trigger_noise_threshold.md +++ b/docs/api/noise_sensors/simulate/trigger_noise_threshold.md @@ -149,8 +149,8 @@ ID of the device for which you want to simulate the triggering of a noise thresh ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 4f2c5161d..e54b26942 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -144,8 +144,8 @@ Device ID of the phone that you want to deactivate. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 79f2a36e1..b116cabf9 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -266,8 +266,8 @@ Device ID of the phone that you want to get. ## Response {% hint style="success" %} -**Returns:** -[phone](.) +Returns: +**[phone](.)** {% endhint %} diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 305739438..8266a4f32 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -289,8 +289,8 @@ ID of the user identity that represents the owner by which you want to filter th ## Response {% hint style="success" %} -**Returns:** -Array of [phones](.) +Returns: +**Array of [phones](.)** {% endhint %} diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 34caaef10..e62e8c076 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -486,8 +486,8 @@ Mobile operating system version that you want to use for the simulated phone. ## Response {% hint style="success" %} -**Returns:** -[phone](./..) +Returns: +**[phone](./..)** {% endhint %} diff --git a/docs/api/spaces/add_acs_entrances.md b/docs/api/spaces/add_acs_entrances.md index 32214bc3d..4ac9b6fba 100644 --- a/docs/api/spaces/add_acs_entrances.md +++ b/docs/api/spaces/add_acs_entrances.md @@ -166,8 +166,8 @@ ID of the space to which you want to add entrances. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/spaces/add_devices.md b/docs/api/spaces/add_devices.md index 931a5a1a1..acdeea8f1 100644 --- a/docs/api/spaces/add_devices.md +++ b/docs/api/spaces/add_devices.md @@ -166,8 +166,8 @@ ID of the space to which you want to add devices. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/spaces/create.md b/docs/api/spaces/create.md index 0b243f007..6aac286cc 100644 --- a/docs/api/spaces/create.md +++ b/docs/api/spaces/create.md @@ -229,8 +229,8 @@ Unique key for the space within the workspace. ## Response {% hint style="success" %} -**Returns:** -[space](.) +Returns: +**[space](.)** {% endhint %} diff --git a/docs/api/spaces/delete.md b/docs/api/spaces/delete.md index 2c74b73de..959839233 100644 --- a/docs/api/spaces/delete.md +++ b/docs/api/spaces/delete.md @@ -145,8 +145,8 @@ ID of the space that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/spaces/get.md b/docs/api/spaces/get.md index 9ae327ea9..2d9ec0061 100644 --- a/docs/api/spaces/get.md +++ b/docs/api/spaces/get.md @@ -189,8 +189,8 @@ Unique key of the space that you want to get. ## Response {% hint style="success" %} -**Returns:** -[space](.) +Returns: +**[space](.)** {% endhint %} diff --git a/docs/api/spaces/get_related.md b/docs/api/spaces/get_related.md index 4192d5eb7..c25d4076d 100644 --- a/docs/api/spaces/get_related.md +++ b/docs/api/spaces/get_related.md @@ -69,8 +69,8 @@ Keys of the spaces that you want to get along with their related resources. ## Response {% hint style="success" %} -**Returns:** -[unknown](./) +Returns: +**[unknown](./)** {% endhint %} diff --git a/docs/api/spaces/list.md b/docs/api/spaces/list.md index 1164b011f..b0d540dbd 100644 --- a/docs/api/spaces/list.md +++ b/docs/api/spaces/list.md @@ -202,8 +202,8 @@ Filter spaces by space_key. ## Response {% hint style="success" %} -**Returns:** -Array of [spaces](.) +Returns: +**Array of [spaces](.)** {% endhint %} diff --git a/docs/api/spaces/remove_acs_entrances.md b/docs/api/spaces/remove_acs_entrances.md index 04dcfee9a..34f0ac37b 100644 --- a/docs/api/spaces/remove_acs_entrances.md +++ b/docs/api/spaces/remove_acs_entrances.md @@ -166,8 +166,8 @@ ID of the space from which you want to remove entrances. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/spaces/remove_devices.md b/docs/api/spaces/remove_devices.md index 30141c367..4e488f143 100644 --- a/docs/api/spaces/remove_devices.md +++ b/docs/api/spaces/remove_devices.md @@ -166,8 +166,8 @@ ID of the space from which you want to remove devices. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/spaces/update.md b/docs/api/spaces/update.md index 8bcfff2d8..400d5a56d 100644 --- a/docs/api/spaces/update.md +++ b/docs/api/spaces/update.md @@ -222,8 +222,8 @@ Unique key of the space that you want to update. ## Response {% hint style="success" %} -**Returns:** -[space](.) +Returns: +**[space](.)** {% endhint %} diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index c7f695139..a961feb6e 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -198,8 +198,8 @@ ID of the thermostat device for which you want to activate a climate preset. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 2c1ef9328..fd1fbea96 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -205,8 +205,8 @@ ID of the thermostat device that you want to set to cool mode. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index c392b5467..6c4591742 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -293,8 +293,8 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/daily_programs/create.md b/docs/api/thermostats/daily_programs/create.md index 8e8abac45..fe13b137f 100644 --- a/docs/api/thermostats/daily_programs/create.md +++ b/docs/api/thermostats/daily_programs/create.md @@ -304,8 +304,8 @@ Time at which the thermostat daily program period starts, in [ISO 8601](https:// ## Response {% hint style="success" %} -**Returns:** -[thermostat\_daily\_program](.) +Returns: +**[thermostat\_daily\_program](.)** {% endhint %} diff --git a/docs/api/thermostats/daily_programs/delete.md b/docs/api/thermostats/daily_programs/delete.md index 968a4c52f..d8ef21b48 100644 --- a/docs/api/thermostats/daily_programs/delete.md +++ b/docs/api/thermostats/daily_programs/delete.md @@ -150,8 +150,8 @@ ID of the thermostat daily program that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/daily_programs/update.md b/docs/api/thermostats/daily_programs/update.md index 201a26907..de39f5b3a 100644 --- a/docs/api/thermostats/daily_programs/update.md +++ b/docs/api/thermostats/daily_programs/update.md @@ -269,8 +269,8 @@ ID of the thermostat daily program that you want to update. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index b77a96a3a..34b24a4f3 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -160,8 +160,8 @@ ID of the thermostat device for which you want to delete a climate preset. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 0673c6bc1..d413f5e2d 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -205,8 +205,8 @@ ID of the thermostat device that you want to set to heat mode. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6849cebd2..5a257f4c4 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -223,8 +223,8 @@ ID of the thermostat device that you want to set to heat-cool mode. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index e16e8a482..98b0a9f9a 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -1257,8 +1257,8 @@ Your own internal user ID for the user for which you want to list devices. ## Response {% hint style="success" %} -**Returns:** -Array of [devices](./../devices) +Returns: +**Array of [devices](./../devices)** {% endhint %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 5c9cca34b..32877b222 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -183,8 +183,8 @@ ID of the thermostat device that you want to set to off mode. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 06824c337..50fad362d 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -290,8 +290,8 @@ Name of the thermostat schedule. ## Response {% hint style="success" %} -**Returns:** -[thermostat\_schedule](.) +Returns: +**[thermostat\_schedule](.)** {% endhint %} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 8fb477331..483957d0b 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -148,8 +148,8 @@ ID of the thermostat schedule that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1d9b290cf..b4430d24a 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -222,8 +222,8 @@ ID of the thermostat schedule that you want to get. ## Response {% hint style="success" %} -**Returns:** -[thermostat\_schedule](.) +Returns: +**[thermostat\_schedule](.)** {% endhint %} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 52a7d0e51..0d78b9db1 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -239,8 +239,8 @@ User identifier key by which to filter the list of returned thermostat schedules ## Response {% hint style="success" %} -**Returns:** -Array of [thermostat\_schedules](.) +Returns: +**Array of [thermostat\_schedules](.)** {% endhint %} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index ba94fc3c8..49b48a214 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -216,8 +216,8 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index f57e30111..1e146db51 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -159,8 +159,8 @@ ID of the thermostat device for which you want to set the fallback climate prese ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 431ae9e89..2d05112da 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -207,8 +207,8 @@ ID of the thermostat device for which you want to set the fan mode. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 4eccbe1e6..4b7d8f5fa 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -232,8 +232,8 @@ ID of the thermostat device for which you want to set the HVAC mode. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 0e6fd9ddb..0a7333303 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -183,8 +183,8 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 853a9b7f7..c0249c412 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -189,8 +189,8 @@ Heating [set point](../../../capability-guides/thermostats/understanding-thermos ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 604a022aa..1f88102b0 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -165,8 +165,8 @@ Temperature in °F that you want simulate the thermostat reaching. You must set ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index df8b22086..18ba6186c 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -293,8 +293,8 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/thermostats/update_weekly_program.md b/docs/api/thermostats/update_weekly_program.md index 3439f25ff..9c5540798 100644 --- a/docs/api/thermostats/update_weekly_program.md +++ b/docs/api/thermostats/update_weekly_program.md @@ -266,8 +266,8 @@ ID of the thermostat daily program to run on Wednesdays. ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 4aae262fd..e74b819b6 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -170,8 +170,8 @@ Key of the user identity to which you want to add an access system user. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index bc0270392..9d809e19b 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -263,8 +263,8 @@ Unique key for the new user identity. ## Response {% hint style="success" %} -**Returns:** -[user\_identity](.) +Returns: +**[user\_identity](.)** {% endhint %} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 7e4615ed7..522fee747 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -145,8 +145,8 @@ ID of the user identity that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/user_identities/generate_instant_key.md b/docs/api/user_identities/generate_instant_key.md index 2068571b1..447153af0 100644 --- a/docs/api/user_identities/generate_instant_key.md +++ b/docs/api/user_identities/generate_instant_key.md @@ -213,8 +213,8 @@ Maximum number of times the instant key can be used. Default: 1. ## Response {% hint style="success" %} -**Returns:** -[instant\_key](./../instant_keys) +Returns: +**[instant\_key](./../instant_keys)** {% endhint %} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index af4221534..c6b45e577 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -219,8 +219,8 @@ ID of the user identity that you want to get. ## Response {% hint style="success" %} -**Returns:** -[user\_identity](.) +Returns: +**[user\_identity](.)** {% endhint %} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index c01f8a014..11727213e 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -160,8 +160,8 @@ ID of the user identity that you want to grant access to a device. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index fa9f0faf5..03b4a44ee 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -242,8 +242,8 @@ String for which to search. Filters returned user identities to include all reco ## Response {% hint style="success" %} -**Returns:** -Array of [user\_identitys](.) +Returns: +**Array of [user\_identitys](.)** {% endhint %} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 22cbc6e49..4b5513667 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -1160,8 +1160,8 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Response {% hint style="success" %} -**Returns:** -Array of [devices](./../devices) +Returns: +**Array of [devices](./../devices)** {% endhint %} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 6217658fa..29bc7e70c 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -275,8 +275,8 @@ ID of the user identity for which you want to retrieve all access systems. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_systems](./../acs/systems) +Returns: +**Array of [acs\_systems](./../acs/systems)** {% endhint %} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 13b4f5537..3a015911c 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -323,8 +323,8 @@ ID of the user identity for which you want to retrieve all access system users. ## Response {% hint style="success" %} -**Returns:** -Array of [acs\_users](./../acs/users) +Returns: +**Array of [acs\_users](./../acs/users)** {% endhint %} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index da61d7ca5..6066544ae 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -160,8 +160,8 @@ ID of the user identity from which you want to remove an access system user. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 6bc997096..bec2325a0 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -160,8 +160,8 @@ ID of the user identity from which you want to revoke access to a device. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/user_identities/unmanaged/get.md b/docs/api/user_identities/unmanaged/get.md index 63ceac59f..168604c3e 100644 --- a/docs/api/user_identities/unmanaged/get.md +++ b/docs/api/user_identities/unmanaged/get.md @@ -29,8 +29,8 @@ ID of the unmanaged user identity that you want to get. ## Response {% hint style="success" %} -**Returns:** -[unknown](./) +Returns: +**[unknown](./)** {% endhint %} diff --git a/docs/api/user_identities/unmanaged/list.md b/docs/api/user_identities/unmanaged/list.md index c86293f8d..373cc136c 100644 --- a/docs/api/user_identities/unmanaged/list.md +++ b/docs/api/user_identities/unmanaged/list.md @@ -48,8 +48,8 @@ String for which to search. Filters returned unmanaged user identities to includ ## Response {% hint style="success" %} -**Returns:** -Array of [unknowns](./) +Returns: +**Array of [unknowns](./)** {% endhint %} diff --git a/docs/api/user_identities/unmanaged/update.md b/docs/api/user_identities/unmanaged/update.md index c7f8c8779..3b509dbb4 100644 --- a/docs/api/user_identities/unmanaged/update.md +++ b/docs/api/user_identities/unmanaged/update.md @@ -44,8 +44,8 @@ Unique key for the user identity. If not provided, the existing key will be pres ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 8e635e7a6..d16e31c73 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -193,8 +193,8 @@ Unique key for the user identity. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/webhooks/create.md b/docs/api/webhooks/create.md index 7dc299119..f058a3f0f 100644 --- a/docs/api/webhooks/create.md +++ b/docs/api/webhooks/create.md @@ -194,8 +194,8 @@ Types of events that you want the new webhook to receive. ## Response {% hint style="success" %} -**Returns:** -[webhook](.) +Returns: +**[webhook](.)** {% endhint %} diff --git a/docs/api/webhooks/delete.md b/docs/api/webhooks/delete.md index ab50596d7..b1d47d85b 100644 --- a/docs/api/webhooks/delete.md +++ b/docs/api/webhooks/delete.md @@ -143,8 +143,8 @@ ID of the webhook that you want to delete. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/webhooks/get.md b/docs/api/webhooks/get.md index 8ec2301ad..d82492012 100644 --- a/docs/api/webhooks/get.md +++ b/docs/api/webhooks/get.md @@ -173,8 +173,8 @@ ID of the webhook that you want to get. ## Response {% hint style="success" %} -**Returns:** -[webhook](.) +Returns: +**[webhook](.)** {% endhint %} diff --git a/docs/api/webhooks/list.md b/docs/api/webhooks/list.md index 2122808a2..0b942d0f5 100644 --- a/docs/api/webhooks/list.md +++ b/docs/api/webhooks/list.md @@ -176,8 +176,8 @@ None ## Response {% hint style="success" %} -**Returns:** -Array of [webhooks](.) +Returns: +**Array of [webhooks](.)** {% endhint %} diff --git a/docs/api/webhooks/update.md b/docs/api/webhooks/update.md index ca60a7d0e..5010a10eb 100644 --- a/docs/api/webhooks/update.md +++ b/docs/api/webhooks/update.md @@ -176,8 +176,8 @@ ID of the webhook that you want to update. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %} diff --git a/docs/api/workspaces/create.md b/docs/api/workspaces/create.md index 8f780bed1..e951b9cc9 100644 --- a/docs/api/workspaces/create.md +++ b/docs/api/workspaces/create.md @@ -445,8 +445,8 @@ Indicates whether the new workspace is a [sandbox workspace](../../core-concepts ## Response {% hint style="success" %} -**Returns:** -[workspace](.) +Returns: +**[workspace](.)** {% endhint %} diff --git a/docs/api/workspaces/get.md b/docs/api/workspaces/get.md index 299307d66..52c6ce258 100644 --- a/docs/api/workspaces/get.md +++ b/docs/api/workspaces/get.md @@ -234,8 +234,8 @@ None ## Response {% hint style="success" %} -**Returns:** -[workspace](.) +Returns: +**[workspace](.)** {% endhint %} diff --git a/docs/api/workspaces/list.md b/docs/api/workspaces/list.md index 9cea8a76d..ba881060f 100644 --- a/docs/api/workspaces/list.md +++ b/docs/api/workspaces/list.md @@ -246,8 +246,8 @@ None ## Response {% hint style="success" %} -**Returns:** -Array of [workspaces](.) +Returns: +**Array of [workspaces](.)** {% endhint %} diff --git a/docs/api/workspaces/reset_sandbox.md b/docs/api/workspaces/reset_sandbox.md index 2d8bf9bcd..d18df579f 100644 --- a/docs/api/workspaces/reset_sandbox.md +++ b/docs/api/workspaces/reset_sandbox.md @@ -171,8 +171,8 @@ None ## Response {% hint style="success" %} -**Returns:** -[action\_attempt](./) +Returns: +**[action\_attempt](./)** {% endhint %} diff --git a/docs/api/workspaces/update.md b/docs/api/workspaces/update.md index 9c963676f..8b4a6e624 100644 --- a/docs/api/workspaces/update.md +++ b/docs/api/workspaces/update.md @@ -272,8 +272,8 @@ Name of the workspace. ## Response {% hint style="success" %} -**Returns:** -void +Returns: +**void** {% endhint %}