diff --git a/codegen/layouts/api-endpoint.hbs b/codegen/layouts/api-endpoint.hbs index 8fb925032..7d9a80813 100644 --- a/codegen/layouts/api-endpoint.hbs +++ b/codegen/layouts/api-endpoint.hbs @@ -73,7 +73,11 @@ None ## Response -{{#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}} +{% 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}} diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index b92e6bd08..84e24eadb 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -384,7 +384,11 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response -[access\_code](.) +{% hint style="success" %} +Returns: +**[access\_code](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 529924fd3..fd2e9fccb 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -443,7 +443,11 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest ## Response -Array of [access\_codes](.) +{% hint style="success" %} +Returns: +**Array of [access\_codes](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 302a0ec5d..24651b60d 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 -void +{% 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..fe38e678c 100644 --- a/docs/api/access_codes/generate_code.md +++ b/docs/api/access_codes/generate_code.md @@ -150,7 +150,11 @@ ID of the device for which you want to generate a code. ## Response -[access\_code](.) +{% hint style="success" %} +Returns: +**[access\_code](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 2bebe1a33..5a3ac3b9c 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -297,7 +297,11 @@ ID of the device containing the access code that you want to get. You must speci ## Response -[access\_code](.) +{% hint style="success" %} +Returns: +**[access\_code](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 9c7f54538..007f74985 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -332,7 +332,11 @@ Your user ID for the user by which to filter access codes. ## Response -Array of [access\_codes](.) +{% hint style="success" %} +Returns: +**Array of [access\_codes](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 3409cd68f..91b50a505 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -295,7 +295,11 @@ ID of the access code for which you want to pull a backup access code. ## Response -[access\_code](.) +{% hint style="success" %} +Returns: +**[access\_code](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/report_device_constraints.md b/docs/api/access_codes/report_device_constraints.md index 6ab8d5cab..2b695f149 100644 --- a/docs/api/access_codes/report_device_constraints.md +++ b/docs/api/access_codes/report_device_constraints.md @@ -189,7 +189,11 @@ Array of supported code lengths as integers between 4 and 20, inclusive. You can ## Response -void +{% 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..657cd9633 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -255,7 +255,11 @@ Name of the simulated unmanaged access code. ## Response -[unmanaged\_access\_code](./../unmanaged) +{% hint style="success" %} +Returns: +**[unmanaged\_access\_code](./../unmanaged)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 7c2e841b4..0ab93a87c 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 -void +{% 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..50d821bd0 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 -void +{% 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..af394483c 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -245,7 +245,11 @@ ID of the device containing the unmanaged access code that you want to get. You ## Response -[unmanaged\_access\_code](.) +{% hint style="success" %} +Returns: +**[unmanaged\_access\_code](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index ca11a622b..8a7135b38 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -261,7 +261,11 @@ Your user ID for the user by which to filter unmanaged access codes. ## Response -Array of [unmanaged\_access\_codes](.) +{% hint style="success" %} +Returns: +**Array of [unmanaged\_access\_codes](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index 569f776ea..ec4afe867 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index a469d2735..60f218fac 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 -void +{% 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..e0b843192 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/access_grants/create.md b/docs/api/access_grants/create.md index bbc519930..6ef92d157 100644 --- a/docs/api/access_grants/create.md +++ b/docs/api/access_grants/create.md @@ -631,7 +631,11 @@ ID of user identity for whom access is being granted. ## Response -[access\_grant](.) +{% hint style="success" %} +Returns: +**[access\_grant](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_grants/delete.md b/docs/api/access_grants/delete.md index ea5932de6..a254a3c94 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/access_grants/get.md b/docs/api/access_grants/get.md index d4914f26b..81750b163 100644 --- a/docs/api/access_grants/get.md +++ b/docs/api/access_grants/get.md @@ -387,7 +387,11 @@ Unique key of Access Grant to get. ## Response -[access\_grant](.) +{% hint style="success" %} +Returns: +**[access\_grant](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_grants/get_related.md b/docs/api/access_grants/get_related.md index 20888c637..236d18cec 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 -[unknown](./) +{% hint style="success" %} +Returns: +**[unknown](./)** + +{% endhint %} diff --git a/docs/api/access_grants/list.md b/docs/api/access_grants/list.md index 5ad605904..a7310a706 100644 --- a/docs/api/access_grants/list.md +++ b/docs/api/access_grants/list.md @@ -480,7 +480,11 @@ ID of user identity by which you want to filter the list of Access Grants. ## Response -Array of [access\_grants](.) +{% hint style="success" %} +Returns: +**Array of [access\_grants](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_grants/request_access_methods.md b/docs/api/access_grants/request_access_methods.md index 28ea63934..067b0700b 100644 --- a/docs/api/access_grants/request_access_methods.md +++ b/docs/api/access_grants/request_access_methods.md @@ -65,7 +65,11 @@ Enum values: ## Response -[access\_grant](.) +{% hint style="success" %} +Returns: +**[access\_grant](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_grants/unmanaged/get.md b/docs/api/access_grants/unmanaged/get.md index 49acf8398..d40f700ea 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 -[unknown](./) +{% 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..96896504c 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 -Array of [unknowns](./) +{% 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..ec5651307 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/access_grants/update.md b/docs/api/access_grants/update.md index 42c28ce78..8645c4902 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/access_methods/delete.md b/docs/api/access_methods/delete.md index 76b809242..53a92fba0 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/access_methods/encode.md b/docs/api/access_methods/encode.md index c7580676f..9afa15c20 100644 --- a/docs/api/access_methods/encode.md +++ b/docs/api/access_methods/encode.md @@ -37,7 +37,11 @@ ID of the `acs_encoder` to use to encode the `access_method`. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_methods/get.md b/docs/api/access_methods/get.md index eb7a5fe98..d06f75cb1 100644 --- a/docs/api/access_methods/get.md +++ b/docs/api/access_methods/get.md @@ -197,7 +197,11 @@ ID of access method to get. ## Response -[access\_method](.) +{% hint style="success" %} +Returns: +**[access\_method](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_methods/get_related.md b/docs/api/access_methods/get_related.md index 27c69f3e0..2f721f7e4 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 -[unknown](./) +{% hint style="success" %} +Returns: +**[unknown](./)** + +{% endhint %} diff --git a/docs/api/access_methods/list.md b/docs/api/access_methods/list.md index f4877271f..94133e756 100644 --- a/docs/api/access_methods/list.md +++ b/docs/api/access_methods/list.md @@ -324,7 +324,11 @@ ID of the space for which you want to retrieve all access methods. ## Response -Array of [access\_methods](.) +{% hint style="success" %} +Returns: +**Array of [access\_methods](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/access_methods/unmanaged/get.md b/docs/api/access_methods/unmanaged/get.md index e2f91455b..b86e508bb 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 -[unknown](./) +{% 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..5623b9cc6 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 -Array of [unknowns](./) +{% 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..4eb442d81 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -166,7 +166,11 @@ ID of the desired user identity that you want to add to an access group. You can ## Response -void +{% 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..b9b525231 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -230,7 +230,11 @@ ID of the access group that you want to get. ## Response -[acs\_access\_group](.) +{% hint style="success" %} +Returns: +**[acs\_access\_group](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 1bca4e7c9..9fea29738 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -269,7 +269,11 @@ ID of the user identity for which you want to retrieve all access groups. ## Response -Array of [acs\_access\_groups](.) +{% hint style="success" %} +Returns: +**Array of [acs\_access\_groups](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index f71ea1652..a2419eb01 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -265,7 +265,11 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Response -Array of [acs\_entrances](./../entrances) +{% hint style="success" %} +Returns: +**Array of [acs\_entrances](./../entrances)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 54eca3e50..5320302db 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -322,7 +322,11 @@ ID of the access group for which you want to retrieve all access system users. ## Response -Array of [acs\_users](./../users) +{% hint style="success" %} +Returns: +**Array of [acs\_users](./../users)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 1269339f0..59ffd2930 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -166,7 +166,11 @@ ID of the user identity associated with the user that you want to remove from an ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 3c9154d40..f64fb98ef 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -166,7 +166,11 @@ ID of the user identity to whom you want to assign a credential. You can only pr ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index f2087c2d1..5d65f92e3 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -518,7 +518,11 @@ Enum values: ## Response -[acs\_credential](.) +{% hint style="success" %} +Returns: +**[acs\_credential](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 290cb1d4e..717fc079d 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index a59b9e8db..594752c91 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -261,7 +261,11 @@ ID of the credential that you want to get. ## Response -[acs\_credential](.) +{% hint style="success" %} +Returns: +**[acs\_credential](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 43ae5f532..1f8bf4309 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -307,7 +307,11 @@ ID of the user identity for which you want to retrieve all credentials. ## Response -Array of [acs\_credentials](.) +{% hint style="success" %} +Returns: +**Array of [acs\_credentials](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 9a7663147..61ac22e58 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -265,7 +265,11 @@ ID of the credential for which you want to retrieve all entrances to which the c ## Response -Array of [acs\_entrances](./../entrances) +{% hint style="success" %} +Returns: +**Array of [acs\_entrances](./../entrances)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index d203276ab..6811c9c41 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -166,7 +166,11 @@ ID of the user identity from which you want to unassign a credential. You can on ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 19b5f3438..ce4276286 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 -void +{% 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..3ae3b25d6 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -383,7 +383,11 @@ ID of the `acs_credential` to encode onto a card. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/encoders/get.md b/docs/api/acs/encoders/get.md index e9607b55f..7ee23dc80 100644 --- a/docs/api/acs/encoders/get.md +++ b/docs/api/acs/encoders/get.md @@ -194,7 +194,11 @@ ID of the encoder that you want to get. ## Response -[acs\_encoder](.) +{% hint style="success" %} +Returns: +**[acs\_encoder](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index e82de7ffa..7cc1f06f6 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -222,7 +222,11 @@ Identifies the specific page of results to return, obtained from the previous pa ## Response -Array of [acs\_encoders](.) +{% hint style="success" %} +Returns: +**Array of [acs\_encoders](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 9a37fe605..b416ae0ea 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -541,7 +541,11 @@ ID of the encoder to use for the scan. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} 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..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 @@ -165,5 +165,9 @@ Code of the error to simulate. ## Response -void +{% 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..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 @@ -160,5 +160,9 @@ Scenario to simulate. ## Response -void +{% 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..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 @@ -161,5 +161,9 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next ## Response -void +{% 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..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 @@ -170,5 +170,9 @@ Scenario to simulate. ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index bd2b6a08d..2106e1999 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -248,7 +248,11 @@ ID of the entrance that you want to get. ## Response -[acs\_entrance](.) +{% hint style="success" %} +Returns: +**[acs\_entrance](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index b5bef98e9..a285afcb5 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -166,7 +166,11 @@ ID of the user identity to whom you want to grant access to an entrance. You can ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index b9c4cdc77..b9de85e61 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -319,7 +319,11 @@ ID of the space for which you want to list entrances. ## Response -Array of [acs\_entrances](.) +{% hint style="success" %} +Returns: +**Array of [acs\_entrances](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 31b74e069..1c44c6cc4 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -291,7 +291,11 @@ Possible enum values: ## Response -Array of [acs\_credentials](./../credentials) +{% hint style="success" %} +Returns: +**Array of [acs\_credentials](./../credentials)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index c3b476904..c53156b15 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -257,7 +257,11 @@ ID of the access system that you want to get. ## Response -[acs\_system](.) +{% hint style="success" %} +Returns: +**[acs\_system](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index a4b33d475..0fceb1cb2 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -280,7 +280,11 @@ Customer key for which you want to list access systems. ## Response -Array of [acs\_systems](.) +{% hint style="success" %} +Returns: +**Array of [acs\_systems](.)** + +{% endhint %} {% tabs %} 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..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 @@ -252,7 +252,11 @@ ID of the access system for which you want to retrieve all compatible credential ## Response -Array of [acs\_systems](.) +{% hint style="success" %} +Returns: +**Array of [acs\_systems](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/systems/report_devices.md b/docs/api/acs/systems/report_devices.md index e3262f96f..99f0c438c 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 -void +{% 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..5002ddc0c 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 3e1020d1d..91cd6c729 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -424,7 +424,11 @@ ID of the user identity with which you want to associate the new access system u ## Response -[acs\_user](.) +{% hint style="success" %} +Returns: +**[acs\_user](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 20c1d92d4..56b176f26 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -166,7 +166,11 @@ ID of the user identity that you want to delete. You must provide either acs_use ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index a166e8efa..96e7ff4ff 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -330,7 +330,11 @@ ID of the user identity that you want to get. You can only provide acs_user_id o ## Response -[acs\_user](.) +{% hint style="success" %} +Returns: +**[acs\_user](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 07c23ad1c..fe0b0a54b 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -364,7 +364,11 @@ Phone number of the user identity for which you want to retrieve all access syst ## Response -Array of [acs\_users](.) +{% hint style="success" %} +Returns: +**Array of [acs\_users](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 66abe7f20..2179ac8a0 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -284,7 +284,11 @@ ID of the user identity for whom you want to list accessible entrances. You can ## Response -Array of [acs\_entrances](./../entrances) +{% hint style="success" %} +Returns: +**Array of [acs\_entrances](./../entrances)** + +{% endhint %} {% tabs %} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7c4ecf957..b85a9d6b4 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -166,7 +166,11 @@ ID of the user identity that you want to remove from an access group. You can on ## Response -void +{% 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..4b95dead6 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -166,7 +166,11 @@ ID of the user identity for whom you want to revoke access. You can only provide ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 87c70ffc2..901c2209a 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -166,7 +166,11 @@ ID of the user identity that you want to suspend. You can only provide acs_user_ ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 6c44cedbc..0d4171e59 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -166,7 +166,11 @@ ID of the user identity that you want to unsuspend. You can only provide acs_use ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 44d164914..3e77d369b 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -268,7 +268,11 @@ ID of the user identity that you want to update. You can only provide acs_user_i ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} --- diff --git a/docs/api/action_attempts/get.md b/docs/api/action_attempts/get.md index 852f841b0..15c33189a 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 -[action\_attempt](./) +{% 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..748478c28 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 -Array of [action\_attempts](./) +{% 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..3e62fc4ae 100644 --- a/docs/api/client_sessions/create.md +++ b/docs/api/client_sessions/create.md @@ -303,7 +303,11 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response -[client\_session](.) +{% hint style="success" %} +Returns: +**[client\_session](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/client_sessions/delete.md b/docs/api/client_sessions/delete.md index 8f4919bd6..4a38a509c 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/client_sessions/get.md b/docs/api/client_sessions/get.md index df63df7b5..96678e9b7 100644 --- a/docs/api/client_sessions/get.md +++ b/docs/api/client_sessions/get.md @@ -226,7 +226,11 @@ User identifier key associated with the client session that you want to get. ## Response -[client\_session](.) +{% hint style="success" %} +Returns: +**[client\_session](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/client_sessions/get_or_create.md b/docs/api/client_sessions/get_or_create.md index c31f8102e..0fc6b1202 100644 --- a/docs/api/client_sessions/get_or_create.md +++ b/docs/api/client_sessions/get_or_create.md @@ -281,7 +281,11 @@ IDs of the [user identities](../../capability-guides/mobile-access/managing-mobi ## Response -[client\_session](.) +{% hint style="success" %} +Returns: +**[client\_session](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/client_sessions/grant_access.md b/docs/api/client_sessions/grant_access.md index 7ed510f61..da1dddf68 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/client_sessions/list.md b/docs/api/client_sessions/list.md index 8fe6f986c..2f807dc4a 100644 --- a/docs/api/client_sessions/list.md +++ b/docs/api/client_sessions/list.md @@ -255,7 +255,11 @@ Indicates whether to retrieve only client sessions without associated user ident ## Response -Array of [client\_sessions](.) +{% hint style="success" %} +Returns: +**Array of [client\_sessions](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/client_sessions/revoke.md b/docs/api/client_sessions/revoke.md index d5afb9944..aa97acb7a 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/connect_webviews/create.md b/docs/api/connect_webviews/create.md index e3f3e7cc4..19135b743 100644 --- a/docs/api/connect_webviews/create.md +++ b/docs/api/connect_webviews/create.md @@ -639,7 +639,11 @@ Indicates whether Seam should finish syncing all devices in a newly-connected ac ## Response -[connect\_webview](.) +{% hint style="success" %} +Returns: +**[connect\_webview](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/connect_webviews/delete.md b/docs/api/connect_webviews/delete.md index 7124735c2..c2f790e4b 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/connect_webviews/get.md b/docs/api/connect_webviews/get.md index 4a5eae95b..160b538b8 100644 --- a/docs/api/connect_webviews/get.md +++ b/docs/api/connect_webviews/get.md @@ -279,7 +279,11 @@ ID of the Connect Webview that you want to get. ## Response -[connect\_webview](.) +{% hint style="success" %} +Returns: +**[connect\_webview](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/connect_webviews/list.md b/docs/api/connect_webviews/list.md index b0d306fbb..88a769ea6 100644 --- a/docs/api/connect_webviews/list.md +++ b/docs/api/connect_webviews/list.md @@ -309,7 +309,11 @@ Your user ID for the user by which you want to filter Connect Webviews. ## Response -Array of [connect\_webviews](.) +{% hint style="success" %} +Returns: +**Array of [connect\_webviews](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/connected_accounts/delete.md b/docs/api/connected_accounts/delete.md index 774abb8f0..e16331e3c 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/connected_accounts/get.md b/docs/api/connected_accounts/get.md index 8e169b738..e2b684d02 100644 --- a/docs/api/connected_accounts/get.md +++ b/docs/api/connected_accounts/get.md @@ -252,7 +252,11 @@ Email address associated with the connected account that you want to get. ## Response -[connected\_account](.) +{% hint style="success" %} +Returns: +**[connected\_account](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/connected_accounts/list.md b/docs/api/connected_accounts/list.md index d0dc1e183..96e207cc2 100644 --- a/docs/api/connected_accounts/list.md +++ b/docs/api/connected_accounts/list.md @@ -293,7 +293,11 @@ Your user ID for the user by which you want to filter connected accounts. ## Response -Array of [connected\_accounts](.) +{% hint style="success" %} +Returns: +**Array of [connected\_accounts](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/connected_accounts/simulate/disconnect.md b/docs/api/connected_accounts/simulate/disconnect.md index ebbf00fb2..259a8c2fa 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/connected_accounts/sync.md b/docs/api/connected_accounts/sync.md index a2726de49..8b01b2009 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/connected_accounts/update.md b/docs/api/connected_accounts/update.md index 6ad273729..35fa2a4a1 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/customers/create_portal.md b/docs/api/customers/create_portal.md index f28e64f36..370f0218e 100644 --- a/docs/api/customers/create_portal.md +++ b/docs/api/customers/create_portal.md @@ -361,7 +361,11 @@ The locale to use for the portal. ## Response -[magic\_link](./../unstable_partner/building_blocks) +{% hint style="success" %} +Returns: +**[magic\_link](./../unstable_partner/building_blocks)** + +{% endhint %} {% tabs %} diff --git a/docs/api/customers/delete_data.md b/docs/api/customers/delete_data.md index fd2f94bef..59f6648d8 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/customers/push_data.md b/docs/api/customers/push_data.md index ce133c832..e8a1de6ef 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/devices/get.md b/docs/api/devices/get.md index 9907f6eab..7b5aec30d 100644 --- a/docs/api/devices/get.md +++ b/docs/api/devices/get.md @@ -1141,7 +1141,11 @@ Name of the device that you want to get. ## Response -[device](.) +{% hint style="success" %} +Returns: +**[device](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/devices/list.md b/docs/api/devices/list.md index e77260be0..57b4a9a8a 100644 --- a/docs/api/devices/list.md +++ b/docs/api/devices/list.md @@ -1297,7 +1297,11 @@ Your own internal user ID for the user for which you want to list devices. ## Response -Array of [devices](.) +{% hint style="success" %} +Returns: +**Array of [devices](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/devices/list_device_providers.md b/docs/api/devices/list_device_providers.md index c863809c1..9fd7e68b2 100644 --- a/docs/api/devices/list_device_providers.md +++ b/docs/api/devices/list_device_providers.md @@ -199,7 +199,11 @@ Category for which you want to list providers. ## Response -Array of [device\_providers](.) +{% hint style="success" %} +Returns: +**Array of [device\_providers](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/devices/simulate/connect.md b/docs/api/devices/simulate/connect.md index 2c6994a3c..d7a98900f 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 -void +{% 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..50f814801 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/devices/simulate/disconnect.md b/docs/api/devices/simulate/disconnect.md index ce317cede..01e061a69 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 -void +{% 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..ce862f2ef 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 -void +{% 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..f29272c04 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/devices/simulate/remove.md b/docs/api/devices/simulate/remove.md index 4c0d0a4db..280c93f98 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/devices/unmanaged/get.md b/docs/api/devices/unmanaged/get.md index 62c2aa108..37c28c713 100644 --- a/docs/api/devices/unmanaged/get.md +++ b/docs/api/devices/unmanaged/get.md @@ -415,7 +415,11 @@ Name of the unmanaged device that you want to get. ## Response -[unmanaged\_device](.) +{% hint style="success" %} +Returns: +**[unmanaged\_device](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/devices/unmanaged/list.md b/docs/api/devices/unmanaged/list.md index 816fba106..02fda0799 100644 --- a/docs/api/devices/unmanaged/list.md +++ b/docs/api/devices/unmanaged/list.md @@ -564,7 +564,11 @@ Your own internal user ID for the user for which you want to list devices. ## Response -Array of [unmanaged\_devices](.) +{% hint style="success" %} +Returns: +**Array of [unmanaged\_devices](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/devices/unmanaged/update.md b/docs/api/devices/unmanaged/update.md index 09bf0b302..9d2883214 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/devices/update.md b/docs/api/devices/update.md index 92edd400f..8253e86dd 100644 --- a/docs/api/devices/update.md +++ b/docs/api/devices/update.md @@ -201,5 +201,9 @@ Name for the device. ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/events/get.md b/docs/api/events/get.md index dd452ed54..33f16ba31 100644 --- a/docs/api/events/get.md +++ b/docs/api/events/get.md @@ -212,7 +212,11 @@ Type of the event that you want to get. ## Response -[event](.) +{% hint style="success" %} +Returns: +**[event](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/events/list.md b/docs/api/events/list.md index b75f558b1..c005d3ff7 100644 --- a/docs/api/events/list.md +++ b/docs/api/events/list.md @@ -419,7 +419,11 @@ Offset for the events that you want to list. ## Response -Array of [events](.) +{% hint style="success" %} +Returns: +**Array of [events](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/instant_keys/delete.md b/docs/api/instant_keys/delete.md index 1f8da53f4..4884bd34b 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/instant_keys/get.md b/docs/api/instant_keys/get.md index 818c95a11..54d274bae 100644 --- a/docs/api/instant_keys/get.md +++ b/docs/api/instant_keys/get.md @@ -34,7 +34,11 @@ URL of the instant key to get. ## Response -[instant\_key](.) +{% hint style="success" %} +Returns: +**[instant\_key](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/instant_keys/list.md b/docs/api/instant_keys/list.md index d0f5ed58c..eb7e21a83 100644 --- a/docs/api/instant_keys/list.md +++ b/docs/api/instant_keys/list.md @@ -28,7 +28,11 @@ ID of the user identity by which you want to filter the list of Instant Keys. ## Response -Array of [instant\_keys](.) +{% hint style="success" %} +Returns: +**Array of [instant\_keys](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/locks/get.md b/docs/api/locks/get.md index 98577501c..8d224015d 100644 --- a/docs/api/locks/get.md +++ b/docs/api/locks/get.md @@ -35,7 +35,11 @@ Name of the lock that you want to get. ## Response -[device](./../devices) +{% hint style="success" %} +Returns: +**[device](./../devices)** + +{% endhint %} {% tabs %} diff --git a/docs/api/locks/list.md b/docs/api/locks/list.md index 6103c6677..68b4860a9 100644 --- a/docs/api/locks/list.md +++ b/docs/api/locks/list.md @@ -1278,7 +1278,11 @@ Your own internal user ID for the user for which you want to list devices. ## Response -Array of [devices](./../devices) +{% hint style="success" %} +Returns: +**Array of [devices](./../devices)** + +{% endhint %} {% tabs %} diff --git a/docs/api/locks/lock_door.md b/docs/api/locks/lock_door.md index 07cd87fc2..38cf57304 100644 --- a/docs/api/locks/lock_door.md +++ b/docs/api/locks/lock_door.md @@ -182,7 +182,11 @@ ID of the lock that you want to lock. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/locks/simulate/keypad_code_entry.md b/docs/api/locks/simulate/keypad_code_entry.md index ca817d8a4..b2af9be3b 100644 --- a/docs/api/locks/simulate/keypad_code_entry.md +++ b/docs/api/locks/simulate/keypad_code_entry.md @@ -197,7 +197,11 @@ ID of the device for which you want to simulate a keypad code entry. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/locks/simulate/manual_lock_via_keypad.md b/docs/api/locks/simulate/manual_lock_via_keypad.md index 16f118161..333e5db13 100644 --- a/docs/api/locks/simulate/manual_lock_via_keypad.md +++ b/docs/api/locks/simulate/manual_lock_via_keypad.md @@ -185,7 +185,11 @@ ID of the device for which you want to simulate a manual lock action using a key ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/locks/unlock_door.md b/docs/api/locks/unlock_door.md index 8d1ec4dc8..fc1e182da 100644 --- a/docs/api/locks/unlock_door.md +++ b/docs/api/locks/unlock_door.md @@ -182,7 +182,11 @@ ID of the lock that you want to unlock. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/noise_sensors/list.md b/docs/api/noise_sensors/list.md index 3541a22aa..c1fe98b29 100644 --- a/docs/api/noise_sensors/list.md +++ b/docs/api/noise_sensors/list.md @@ -702,7 +702,11 @@ Your own internal user ID for the user for which you want to list devices. ## Response -Array of [devices](./../devices) +{% hint style="success" %} +Returns: +**Array of [devices](./../devices)** + +{% endhint %} {% tabs %} diff --git a/docs/api/noise_sensors/noise_thresholds/create.md b/docs/api/noise_sensors/noise_thresholds/create.md index d590b8511..773c423b5 100644 --- a/docs/api/noise_sensors/noise_thresholds/create.md +++ b/docs/api/noise_sensors/noise_thresholds/create.md @@ -253,7 +253,11 @@ Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. Th ## Response -[noise\_threshold](.) +{% hint style="success" %} +Returns: +**[noise\_threshold](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/noise_sensors/noise_thresholds/delete.md b/docs/api/noise_sensors/noise_thresholds/delete.md index 8d67fd61c..621af5f7b 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 -void +{% 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..04a134f9d 100644 --- a/docs/api/noise_sensors/noise_thresholds/get.md +++ b/docs/api/noise_sensors/noise_thresholds/get.md @@ -196,7 +196,11 @@ ID of the noise threshold that you want to get. ## Response -[noise\_threshold](.) +{% hint style="success" %} +Returns: +**[noise\_threshold](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/noise_sensors/noise_thresholds/list.md b/docs/api/noise_sensors/noise_thresholds/list.md index a02580d4c..1917dda5f 100644 --- a/docs/api/noise_sensors/noise_thresholds/list.md +++ b/docs/api/noise_sensors/noise_thresholds/list.md @@ -209,7 +209,11 @@ ID of the device for which you want to list noise thresholds. ## Response -Array of [noise\_thresholds](.) +{% hint style="success" %} +Returns: +**Array of [noise\_thresholds](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/noise_sensors/noise_thresholds/update.md b/docs/api/noise_sensors/noise_thresholds/update.md index d122824a7..8c675d359 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 -void +{% 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..899727c87 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index aaeef14e3..e54b26942 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 24dbeffc9..b116cabf9 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -265,7 +265,11 @@ Device ID of the phone that you want to get. ## Response -[phone](.) +{% hint style="success" %} +Returns: +**[phone](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 64908d7fd..8266a4f32 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -288,7 +288,11 @@ ID of the user identity that represents the owner by which you want to filter th ## Response -Array of [phones](.) +{% hint style="success" %} +Returns: +**Array of [phones](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 246c299e3..e62e8c076 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -485,7 +485,11 @@ Mobile operating system version that you want to use for the simulated phone. ## Response -[phone](./..) +{% hint style="success" %} +Returns: +**[phone](./..)** + +{% endhint %} {% tabs %} diff --git a/docs/api/spaces/add_acs_entrances.md b/docs/api/spaces/add_acs_entrances.md index 53ae2f051..4ac9b6fba 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/spaces/add_devices.md b/docs/api/spaces/add_devices.md index c9f6d09ad..acdeea8f1 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/spaces/create.md b/docs/api/spaces/create.md index 6d4c19e28..6aac286cc 100644 --- a/docs/api/spaces/create.md +++ b/docs/api/spaces/create.md @@ -228,7 +228,11 @@ Unique key for the space within the workspace. ## Response -[space](.) +{% hint style="success" %} +Returns: +**[space](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/spaces/delete.md b/docs/api/spaces/delete.md index 6373335eb..959839233 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/spaces/get.md b/docs/api/spaces/get.md index 24b669b9b..2d9ec0061 100644 --- a/docs/api/spaces/get.md +++ b/docs/api/spaces/get.md @@ -188,7 +188,11 @@ Unique key of the space that you want to get. ## Response -[space](.) +{% hint style="success" %} +Returns: +**[space](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/spaces/get_related.md b/docs/api/spaces/get_related.md index 8633afea0..c25d4076d 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 -[unknown](./) +{% hint style="success" %} +Returns: +**[unknown](./)** + +{% endhint %} diff --git a/docs/api/spaces/list.md b/docs/api/spaces/list.md index 47259e78f..b0d540dbd 100644 --- a/docs/api/spaces/list.md +++ b/docs/api/spaces/list.md @@ -201,7 +201,11 @@ Filter spaces by space_key. ## Response -Array of [spaces](.) +{% hint style="success" %} +Returns: +**Array of [spaces](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/spaces/remove_acs_entrances.md b/docs/api/spaces/remove_acs_entrances.md index 7dab2bbaf..34f0ac37b 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/spaces/remove_devices.md b/docs/api/spaces/remove_devices.md index c448033d4..4e488f143 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/spaces/update.md b/docs/api/spaces/update.md index 20b417ef8..400d5a56d 100644 --- a/docs/api/spaces/update.md +++ b/docs/api/spaces/update.md @@ -221,7 +221,11 @@ Unique key of the space that you want to update. ## Response -[space](.) +{% hint style="success" %} +Returns: +**[space](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 524b73c67..a961feb6e 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -197,7 +197,11 @@ ID of the thermostat device for which you want to activate a climate preset. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index fada575f3..fd1fbea96 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -204,7 +204,11 @@ ID of the thermostat device that you want to set to cool mode. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index f64d1061f..6c4591742 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 -void +{% 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..fe13b137f 100644 --- a/docs/api/thermostats/daily_programs/create.md +++ b/docs/api/thermostats/daily_programs/create.md @@ -303,7 +303,11 @@ Time at which the thermostat daily program period starts, in [ISO 8601](https:// ## Response -[thermostat\_daily\_program](.) +{% hint style="success" %} +Returns: +**[thermostat\_daily\_program](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/daily_programs/delete.md b/docs/api/thermostats/daily_programs/delete.md index e8212972e..d8ef21b48 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 -void +{% 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..de39f5b3a 100644 --- a/docs/api/thermostats/daily_programs/update.md +++ b/docs/api/thermostats/daily_programs/update.md @@ -268,7 +268,11 @@ ID of the thermostat daily program that you want to update. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index cd39b53b9..34b24a4f3 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index fac252d30..d413f5e2d 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -204,7 +204,11 @@ ID of the thermostat device that you want to set to heat mode. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 259f25913..5a257f4c4 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -222,7 +222,11 @@ ID of the thermostat device that you want to set to heat-cool mode. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 418933553..98b0a9f9a 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -1256,7 +1256,11 @@ Your own internal user ID for the user for which you want to list devices. ## Response -Array of [devices](./../devices) +{% hint style="success" %} +Returns: +**Array of [devices](./../devices)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index f564aceaf..32877b222 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -182,7 +182,11 @@ ID of the thermostat device that you want to set to off mode. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 1162459c1..50fad362d 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -289,7 +289,11 @@ Name of the thermostat schedule. ## Response -[thermostat\_schedule](.) +{% hint style="success" %} +Returns: +**[thermostat\_schedule](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 770cb98f5..483957d0b 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 76362b062..b4430d24a 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -221,7 +221,11 @@ ID of the thermostat schedule that you want to get. ## Response -[thermostat\_schedule](.) +{% hint style="success" %} +Returns: +**[thermostat\_schedule](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index e4c9f1102..0d78b9db1 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -238,7 +238,11 @@ User identifier key by which to filter the list of returned thermostat schedules ## Response -Array of [thermostat\_schedules](.) +{% hint style="success" %} +Returns: +**Array of [thermostat\_schedules](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index b8534f9b3..49b48a214 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 -void +{% 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..1e146db51 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 -void +{% 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..2d05112da 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -206,7 +206,11 @@ ID of the thermostat device for which you want to set the fan mode. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index a306ceeea..4b7d8f5fa 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -231,7 +231,11 @@ ID of the thermostat device for which you want to set the HVAC mode. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 19457c764..0a7333303 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 -void +{% 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..c0249c412 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 -void +{% 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..1f88102b0 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 -void +{% 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..18ba6186c 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 -void +{% 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..9c5540798 100644 --- a/docs/api/thermostats/update_weekly_program.md +++ b/docs/api/thermostats/update_weekly_program.md @@ -265,7 +265,11 @@ ID of the thermostat daily program to run on Wednesdays. ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index afadb0bea..e74b819b6 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 1c127445f..9d809e19b 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -262,7 +262,11 @@ Unique key for the new user identity. ## Response -[user\_identity](.) +{% hint style="success" %} +Returns: +**[user\_identity](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 1be606203..522fee747 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 -void +{% 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..447153af0 100644 --- a/docs/api/user_identities/generate_instant_key.md +++ b/docs/api/user_identities/generate_instant_key.md @@ -212,7 +212,11 @@ Maximum number of times the instant key can be used. Default: 1. ## Response -[instant\_key](./../instant_keys) +{% hint style="success" %} +Returns: +**[instant\_key](./../instant_keys)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 0f9e08d5f..c6b45e577 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -218,7 +218,11 @@ ID of the user identity that you want to get. ## Response -[user\_identity](.) +{% hint style="success" %} +Returns: +**[user\_identity](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index ad5c499d3..11727213e 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 8de2edc33..03b4a44ee 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -241,7 +241,11 @@ String for which to search. Filters returned user identities to include all reco ## Response -Array of [user\_identitys](.) +{% hint style="success" %} +Returns: +**Array of [user\_identitys](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 598ebb4fa..4b5513667 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -1159,7 +1159,11 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Response -Array of [devices](./../devices) +{% hint style="success" %} +Returns: +**Array of [devices](./../devices)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 7b32f41ae..29bc7e70c 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -274,7 +274,11 @@ ID of the user identity for which you want to retrieve all access systems. ## Response -Array of [acs\_systems](./../acs/systems) +{% hint style="success" %} +Returns: +**Array of [acs\_systems](./../acs/systems)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 0110f3a7d..3a015911c 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -322,7 +322,11 @@ ID of the user identity for which you want to retrieve all access system users. ## Response -Array of [acs\_users](./../acs/users) +{% hint style="success" %} +Returns: +**Array of [acs\_users](./../acs/users)** + +{% endhint %} {% tabs %} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e5c515836..6066544ae 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 -void +{% 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..bec2325a0 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 -void +{% 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..168604c3e 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 -[unknown](./) +{% 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..373cc136c 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 -Array of [unknowns](./) +{% 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..3b509dbb4 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index ad1fe61b5..d16e31c73 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/webhooks/create.md b/docs/api/webhooks/create.md index e195874f6..f058a3f0f 100644 --- a/docs/api/webhooks/create.md +++ b/docs/api/webhooks/create.md @@ -193,7 +193,11 @@ Types of events that you want the new webhook to receive. ## Response -[webhook](.) +{% hint style="success" %} +Returns: +**[webhook](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/webhooks/delete.md b/docs/api/webhooks/delete.md index 265c2bc3f..b1d47d85b 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/webhooks/get.md b/docs/api/webhooks/get.md index 1f9390dfa..d82492012 100644 --- a/docs/api/webhooks/get.md +++ b/docs/api/webhooks/get.md @@ -172,7 +172,11 @@ ID of the webhook that you want to get. ## Response -[webhook](.) +{% hint style="success" %} +Returns: +**[webhook](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/webhooks/list.md b/docs/api/webhooks/list.md index 113e36a66..0b942d0f5 100644 --- a/docs/api/webhooks/list.md +++ b/docs/api/webhooks/list.md @@ -175,7 +175,11 @@ None ## Response -Array of [webhooks](.) +{% hint style="success" %} +Returns: +**Array of [webhooks](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/webhooks/update.md b/docs/api/webhooks/update.md index cdb7442e5..5010a10eb 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 -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %} diff --git a/docs/api/workspaces/create.md b/docs/api/workspaces/create.md index cf4a3d100..e951b9cc9 100644 --- a/docs/api/workspaces/create.md +++ b/docs/api/workspaces/create.md @@ -444,7 +444,11 @@ Indicates whether the new workspace is a [sandbox workspace](../../core-concepts ## Response -[workspace](.) +{% hint style="success" %} +Returns: +**[workspace](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/workspaces/get.md b/docs/api/workspaces/get.md index b13c39851..52c6ce258 100644 --- a/docs/api/workspaces/get.md +++ b/docs/api/workspaces/get.md @@ -233,7 +233,11 @@ None ## Response -[workspace](.) +{% hint style="success" %} +Returns: +**[workspace](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/workspaces/list.md b/docs/api/workspaces/list.md index 1aa601288..ba881060f 100644 --- a/docs/api/workspaces/list.md +++ b/docs/api/workspaces/list.md @@ -245,7 +245,11 @@ None ## Response -Array of [workspaces](.) +{% hint style="success" %} +Returns: +**Array of [workspaces](.)** + +{% endhint %} {% tabs %} diff --git a/docs/api/workspaces/reset_sandbox.md b/docs/api/workspaces/reset_sandbox.md index ac10e512b..d18df579f 100644 --- a/docs/api/workspaces/reset_sandbox.md +++ b/docs/api/workspaces/reset_sandbox.md @@ -170,7 +170,11 @@ None ## Response -[action\_attempt](./) +{% hint style="success" %} +Returns: +**[action\_attempt](./)** + +{% endhint %} {% tabs %} diff --git a/docs/api/workspaces/update.md b/docs/api/workspaces/update.md index 434931691..8b4a6e624 100644 --- a/docs/api/workspaces/update.md +++ b/docs/api/workspaces/update.md @@ -271,5 +271,9 @@ Name of the workspace. ## Response -void +{% hint style="success" %} +Returns: +**void** + +{% endhint %}