@seamapi/http 2.1.0 → 2.2.0

package/lib/seam/connect/routes/seam-http-endpoints.d.ts

@@ -57,206 +57,902 @@ export declare class SeamHttpEndpoints {
     static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpEndpoints;
     createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamHttpRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
     updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
+    /**
+     * Creates a new [access code](https://docs.seam.co/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
+     */
     get '/access_codes/create'(): (parameters: AccessCodesCreateParameters, options?: AccessCodesCreateOptions) => AccessCodesCreateRequest;
+    /**
+     * Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
+     *
+     * Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
+     *
+     * If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.
+     *
+     * If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
+     *
+     * See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
+     *
+     * For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
+     */
     get '/access_codes/create_multiple'(): (parameters: AccessCodesCreateMultipleParameters, options?: AccessCodesCreateMultipleOptions) => AccessCodesCreateMultipleRequest;
+    /**
+     * Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+     */
     get '/access_codes/delete'(): (parameters: AccessCodesDeleteParameters, options?: AccessCodesDeleteOptions) => AccessCodesDeleteRequest;
+    /**
+     * Generates a code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), given a device ID.
+     */
     get '/access_codes/generate_code'(): (parameters: AccessCodesGenerateCodeParameters, options?: AccessCodesGenerateCodeOptions) => AccessCodesGenerateCodeRequest;
+    /**
+     * Returns a specified [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+     *
+     * You must specify either `access_code_id` or both `device_id` and `code`.
+     */
     get '/access_codes/get'(): (parameters?: AccessCodesGetParameters, options?: AccessCodesGetOptions) => AccessCodesGetRequest;
+    /**
+     * Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+     *
+     * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+     */
     get '/access_codes/list'(): (parameters?: AccessCodesListParameters, options?: AccessCodesListOptions) => AccessCodesListRequest;
+    /**
+     * Retrieves a backup access code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes).
+     *
+     * A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
+     *
+     * You can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.
+     *
+     * You can only pull backup access codes for time-bound access codes.
+     *
+     * Before pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.
+     */
     get '/access_codes/pull_backup_access_code'(): (parameters: AccessCodesPullBackupAccessCodeParameters, options?: AccessCodesPullBackupAccessCodeOptions) => AccessCodesPullBackupAccessCodeRequest;
+    /**
+     * Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
+     *
+     * Specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
+     */
     get '/access_codes/report_device_constraints'(): (parameters: AccessCodesReportDeviceConstraintsParameters, options?: AccessCodesReportDeviceConstraintsOptions) => AccessCodesReportDeviceConstraintsRequest;
+    /**
+     * Updates a specified active or upcoming [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+     *
+     * See also [Modifying Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes).
+     */
     get '/access_codes/update'(): (parameters: AccessCodesUpdateParameters, options?: AccessCodesUpdateOptions) => AccessCodesUpdateRequest;
+    /**
+     * Updates [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
+     *
+     * Specify the `common_code_key` to identify the set of access codes that you want to update.
+     *
+     * See also [Update Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
+     */
     get '/access_codes/update_multiple'(): (parameters: AccessCodesUpdateMultipleParameters, options?: AccessCodesUpdateMultipleOptions) => AccessCodesUpdateMultipleRequest;
+    /**
+     * Simulates the creation of an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/access_codes/simulate/create_unmanaged_access_code'(): (parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters, options?: AccessCodesSimulateCreateUnmanagedAccessCodeOptions) => AccessCodesSimulateCreateUnmanagedAccessCodeRequest;
+    /**
+     * Converts an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+     *
+     * An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
+     *
+     * Note that not all device providers support converting an unmanaged access code to a managed access code.
+     */
     get '/access_codes/unmanaged/convert_to_managed'(): (parameters: AccessCodesUnmanagedConvertToManagedParameters, options?: AccessCodesUnmanagedConvertToManagedOptions) => AccessCodesUnmanagedConvertToManagedRequest;
+    /**
+     * Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
     get '/access_codes/unmanaged/delete'(): (parameters: AccessCodesUnmanagedDeleteParameters, options?: AccessCodesUnmanagedDeleteOptions) => AccessCodesUnmanagedDeleteRequest;
+    /**
+     * Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     *
+     * You must specify either `access_code_id` or both `device_id` and `code`.
+     */
     get '/access_codes/unmanaged/get'(): (parameters?: AccessCodesUnmanagedGetParameters, options?: AccessCodesUnmanagedGetOptions) => AccessCodesUnmanagedGetRequest;
+    /**
+     * Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
     get '/access_codes/unmanaged/list'(): (parameters: AccessCodesUnmanagedListParameters, options?: AccessCodesUnmanagedListOptions) => AccessCodesUnmanagedListRequest;
+    /**
+     * Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+     */
     get '/access_codes/unmanaged/update'(): (parameters: AccessCodesUnmanagedUpdateParameters, options?: AccessCodesUnmanagedUpdateOptions) => AccessCodesUnmanagedUpdateRequest;
+    /**
+     * Creates a new [Access Grant](https://docs.seam.co/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
+     */
     get '/access_grants/create'(): (parameters: AccessGrantsCreateParameters, options?: AccessGrantsCreateOptions) => AccessGrantsCreateRequest;
+    /**
+     * Delete an Access Grant.
+     */
     get '/access_grants/delete'(): (parameters: AccessGrantsDeleteParameters, options?: AccessGrantsDeleteOptions) => AccessGrantsDeleteRequest;
+    /**
+     * Get an Access Grant.
+     */
     get '/access_grants/get'(): (parameters?: AccessGrantsGetParameters, options?: AccessGrantsGetOptions) => AccessGrantsGetRequest;
+    /**
+     * Gets all related resources for one or more Access Grants.
+     */
     get '/access_grants/get_related'(): (parameters?: AccessGrantsGetRelatedParameters, options?: AccessGrantsGetRelatedOptions) => AccessGrantsGetRelatedRequest;
+    /**
+     * Gets an Access Grant.
+     */
     get '/access_grants/list'(): (parameters?: AccessGrantsListParameters, options?: AccessGrantsListOptions) => AccessGrantsListRequest;
+    /**
+     * Adds additional requested access methods to an existing Access Grant.
+     */
     get '/access_grants/request_access_methods'(): (parameters: AccessGrantsRequestAccessMethodsParameters, options?: AccessGrantsRequestAccessMethodsOptions) => AccessGrantsRequestAccessMethodsRequest;
+    /**
+     * Updates an existing Access Grant's time window.
+     */
     get '/access_grants/update'(): (parameters?: AccessGrantsUpdateParameters, options?: AccessGrantsUpdateOptions) => AccessGrantsUpdateRequest;
+    /**
+     * Get an unmanaged Access Grant (where is_managed = false).
+     */
     get '/access_grants/unmanaged/get'(): (parameters: AccessGrantsUnmanagedGetParameters, options?: AccessGrantsUnmanagedGetOptions) => AccessGrantsUnmanagedGetRequest;
+    /**
+     * Gets unmanaged Access Grants (where is_managed = false).
+     */
     get '/access_grants/unmanaged/list'(): (parameters?: AccessGrantsUnmanagedListParameters, options?: AccessGrantsUnmanagedListOptions) => AccessGrantsUnmanagedListRequest;
+    /**
+     * Updates an unmanaged Access Grant to make it managed.
+     *
+     * This endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.
+     *
+     * When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.
+     */
     get '/access_grants/unmanaged/update'(): (parameters: AccessGrantsUnmanagedUpdateParameters, options?: AccessGrantsUnmanagedUpdateOptions) => AccessGrantsUnmanagedUpdateRequest;
+    /**
+     * Assigns a pre-registered card credential, identified by `card_number`, to a card-mode access method. Use this endpoint for access systems that use pre-registered cards, where a physical card must be associated with an access method before it can be used for access. Assigning a card credential also triggers issuance of the access method.
+     */
     get '/access_methods/assign_card'(): (parameters: AccessMethodsAssignCardParameters, options?: AccessMethodsAssignCardOptions) => AccessMethodsAssignCardRequest;
+    /**
+     * Deletes an access method.
+     */
     get '/access_methods/delete'(): (parameters?: AccessMethodsDeleteParameters, options?: AccessMethodsDeleteOptions) => AccessMethodsDeleteRequest;
+    /**
+     * Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     get '/access_methods/encode'(): (parameters: AccessMethodsEncodeParameters, options?: AccessMethodsEncodeOptions) => AccessMethodsEncodeRequest;
+    /**
+     * Gets an access method.
+     */
     get '/access_methods/get'(): (parameters: AccessMethodsGetParameters, options?: AccessMethodsGetOptions) => AccessMethodsGetRequest;
+    /**
+     * Gets all related resources for one or more Access Methods.
+     */
     get '/access_methods/get_related'(): (parameters: AccessMethodsGetRelatedParameters, options?: AccessMethodsGetRelatedOptions) => AccessMethodsGetRelatedRequest;
+    /**
+     * Lists all access methods, usually filtered by Access Grant.
+     */
     get '/access_methods/list'(): (parameters?: AccessMethodsListParameters, options?: AccessMethodsListOptions) => AccessMethodsListRequest;
+    /**
+     * Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.
+     */
     get '/access_methods/unlock_door'(): (parameters: AccessMethodsUnlockDoorParameters, options?: AccessMethodsUnlockDoorOptions) => AccessMethodsUnlockDoorRequest;
+    /**
+     * Gets an unmanaged access method (where is_managed = false).
+     */
     get '/access_methods/unmanaged/get'(): (parameters: AccessMethodsUnmanagedGetParameters, options?: AccessMethodsUnmanagedGetOptions) => AccessMethodsUnmanagedGetRequest;
+    /**
+     * Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.
+     */
     get '/access_methods/unmanaged/list'(): (parameters: AccessMethodsUnmanagedListParameters, options?: AccessMethodsUnmanagedListOptions) => AccessMethodsUnmanagedListRequest;
+    /**
+     * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/access_groups/add_user'(): (parameters: AcsAccessGroupsAddUserParameters, options?: AcsAccessGroupsAddUserOptions) => AcsAccessGroupsAddUserRequest;
+    /**
+     * Deletes a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/access_groups/delete'(): (parameters: AcsAccessGroupsDeleteParameters, options?: AcsAccessGroupsDeleteOptions) => AcsAccessGroupsDeleteRequest;
+    /**
+     * Returns a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/access_groups/get'(): (parameters: AcsAccessGroupsGetParameters, options?: AcsAccessGroupsGetOptions) => AcsAccessGroupsGetRequest;
+    /**
+     * Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/access_groups/list'(): (parameters?: AcsAccessGroupsListParameters, options?: AcsAccessGroupsListOptions) => AcsAccessGroupsListRequest;
+    /**
+     * Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/access_groups/list_accessible_entrances'(): (parameters: AcsAccessGroupsListAccessibleEntrancesParameters, options?: AcsAccessGroupsListAccessibleEntrancesOptions) => AcsAccessGroupsListAccessibleEntrancesRequest;
+    /**
+     * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/access_groups/list_users'(): (parameters: AcsAccessGroupsListUsersParameters, options?: AcsAccessGroupsListUsersOptions) => AcsAccessGroupsListUsersRequest;
+    /**
+     * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/access_groups/remove_user'(): (parameters: AcsAccessGroupsRemoveUserParameters, options?: AcsAccessGroupsRemoveUserOptions) => AcsAccessGroupsRemoveUserRequest;
+    /**
+     * Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/credentials/assign'(): (parameters: AcsCredentialsAssignParameters, options?: AcsCredentialsAssignOptions) => AcsCredentialsAssignRequest;
+    /**
+     * Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
+     */
     get '/acs/credentials/create'(): (parameters: AcsCredentialsCreateParameters, options?: AcsCredentialsCreateOptions) => AcsCredentialsCreateRequest;
+    /**
+     * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/credentials/delete'(): (parameters: AcsCredentialsDeleteParameters, options?: AcsCredentialsDeleteOptions) => AcsCredentialsDeleteRequest;
+    /**
+     * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/credentials/get'(): (parameters: AcsCredentialsGetParameters, options?: AcsCredentialsGetOptions) => AcsCredentialsGetRequest;
+    /**
+     * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/credentials/list'(): (parameters?: AcsCredentialsListParameters, options?: AcsCredentialsListOptions) => AcsCredentialsListRequest;
+    /**
+     * Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access.
+     */
     get '/acs/credentials/list_accessible_entrances'(): (parameters: AcsCredentialsListAccessibleEntrancesParameters, options?: AcsCredentialsListAccessibleEntrancesOptions) => AcsCredentialsListAccessibleEntrancesRequest;
+    /**
+     * Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/credentials/unassign'(): (parameters: AcsCredentialsUnassignParameters, options?: AcsCredentialsUnassignOptions) => AcsCredentialsUnassignRequest;
+    /**
+     * Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/credentials/update'(): (parameters: AcsCredentialsUpdateParameters, options?: AcsCredentialsUpdateOptions) => AcsCredentialsUpdateRequest;
+    /**
+     * Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
+     */
     get '/acs/encoders/encode_credential'(): (parameters: AcsEncodersEncodeCredentialParameters, options?: AcsEncodersEncodeCredentialOptions) => AcsEncodersEncodeCredentialRequest;
+    /**
+     * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     get '/acs/encoders/get'(): (parameters: AcsEncodersGetParameters, options?: AcsEncodersGetOptions) => AcsEncodersGetRequest;
+    /**
+     * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     get '/acs/encoders/list'(): (parameters?: AcsEncodersListParameters, options?: AcsEncodersListOptions) => AcsEncodersListRequest;
+    /**
+     * Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     get '/acs/encoders/scan_credential'(): (parameters: AcsEncodersScanCredentialParameters, options?: AcsEncodersScanCredentialOptions) => AcsEncodersScanCredentialRequest;
+    /**
+     * Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
+     */
     get '/acs/encoders/scan_to_assign_credential'(): (parameters: AcsEncodersScanToAssignCredentialParameters, options?: AcsEncodersScanToAssignCredentialOptions) => AcsEncodersScanToAssignCredentialRequest;
+    /**
+     * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/acs/encoders/simulate/next_credential_encode_will_fail'(): (parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions) => AcsEncodersSimulateNextCredentialEncodeWillFailRequest;
+    /**
+     * Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/acs/encoders/simulate/next_credential_encode_will_succeed'(): (parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions) => AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest;
+    /**
+     * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/acs/encoders/simulate/next_credential_scan_will_fail'(): (parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters, options?: AcsEncodersSimulateNextCredentialScanWillFailOptions) => AcsEncodersSimulateNextCredentialScanWillFailRequest;
+    /**
+     * Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/acs/encoders/simulate/next_credential_scan_will_succeed'(): (parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions) => AcsEncodersSimulateNextCredentialScanWillSucceedRequest;
+    /**
+     * Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+     */
     get '/acs/entrances/get'(): (parameters: AcsEntrancesGetParameters, options?: AcsEntrancesGetOptions) => AcsEntrancesGetRequest;
+    /**
+     * Grants a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+     */
     get '/acs/entrances/grant_access'(): (parameters: AcsEntrancesGrantAccessParameters, options?: AcsEntrancesGrantAccessOptions) => AcsEntrancesGrantAccessRequest;
+    /**
+     * Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+     */
     get '/acs/entrances/list'(): (parameters?: AcsEntrancesListParameters, options?: AcsEntrancesListOptions) => AcsEntrancesListRequest;
+    /**
+     * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+     */
     get '/acs/entrances/list_credentials_with_access'(): (parameters: AcsEntrancesListCredentialsWithAccessParameters, options?: AcsEntrancesListCredentialsWithAccessOptions) => AcsEntrancesListCredentialsWithAccessRequest;
+    /**
+     * Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
+     */
     get '/acs/entrances/unlock'(): (parameters: AcsEntrancesUnlockParameters, options?: AcsEntrancesUnlockOptions) => AcsEntrancesUnlockRequest;
+    /**
+     * Returns a specified [access system](https://docs.seam.co/low-level-apis/access-systems).
+     */
     get '/acs/systems/get'(): (parameters: AcsSystemsGetParameters, options?: AcsSystemsGetOptions) => AcsSystemsGetRequest;
+    /**
+     * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems).
+     *
+     * To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.
+     */
     get '/acs/systems/list'(): (parameters?: AcsSystemsListParameters, options?: AcsSystemsListOptions) => AcsSystemsListRequest;
+    /**
+     * Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/low-level-apis/access-systems).
+     *
+     * Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.
+     */
     get '/acs/systems/list_compatible_credential_manager_acs_systems'(): (parameters: AcsSystemsListCompatibleCredentialManagerAcsSystemsParameters, options?: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions) => AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest;
+    /**
+     * Reports ACS system device status including encoders and entrances.
+     */
     get '/acs/systems/report_devices'(): (parameters: AcsSystemsReportDevicesParameters, options?: AcsSystemsReportDevicesOptions) => AcsSystemsReportDevicesRequest;
+    /**
+     * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/users/add_to_access_group'(): (parameters: AcsUsersAddToAccessGroupParameters, options?: AcsUsersAddToAccessGroupOptions) => AcsUsersAddToAccessGroupRequest;
+    /**
+     * Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/create'(): (parameters: AcsUsersCreateParameters, options?: AcsUsersCreateOptions) => AcsUsersCreateRequest;
+    /**
+     * Deletes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/users/delete'(): (parameters?: AcsUsersDeleteParameters, options?: AcsUsersDeleteOptions) => AcsUsersDeleteRequest;
+    /**
+     * Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/get'(): (parameters?: AcsUsersGetParameters, options?: AcsUsersGetOptions) => AcsUsersGetRequest;
+    /**
+     * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/list'(): (parameters?: AcsUsersListParameters, options?: AcsUsersListOptions) => AcsUsersListRequest;
+    /**
+     * Lists the [entrances](https://docs.seam.co/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) has access.
+     */
     get '/acs/users/list_accessible_entrances'(): (parameters?: AcsUsersListAccessibleEntrancesParameters, options?: AcsUsersListAccessibleEntrancesOptions) => AcsUsersListAccessibleEntrancesRequest;
+    /**
+     * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+     */
     get '/acs/users/remove_from_access_group'(): (parameters: AcsUsersRemoveFromAccessGroupParameters, options?: AcsUsersRemoveFromAccessGroupOptions) => AcsUsersRemoveFromAccessGroupRequest;
+    /**
+     * Revokes access to all [entrances](https://docs.seam.co/api/acs/entrances) for a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/revoke_access_to_all_entrances'(): (parameters?: AcsUsersRevokeAccessToAllEntrancesParameters, options?: AcsUsersRevokeAccessToAllEntrancesOptions) => AcsUsersRevokeAccessToAllEntrancesRequest;
+    /**
+     * [Suspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/api/acs/users/unsuspend) them.
+     */
     get '/acs/users/suspend'(): (parameters?: AcsUsersSuspendParameters, options?: AcsUsersSuspendOptions) => AcsUsersSuspendRequest;
+    /**
+     * [Unsuspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.
+     */
     get '/acs/users/unsuspend'(): (parameters?: AcsUsersUnsuspendParameters, options?: AcsUsersUnsuspendOptions) => AcsUsersUnsuspendRequest;
+    /**
+     * Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/update'(): (parameters?: AcsUsersUpdateParameters, options?: AcsUsersUpdateOptions) => AcsUsersUpdateRequest;
+    /**
+     * Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts).
+     */
     get '/action_attempts/get'(): (parameters: ActionAttemptsGetParameters, options?: ActionAttemptsGetOptions) => ActionAttemptsGetRequest;
+    /**
+     * Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.
+     */
     get '/action_attempts/list'(): (parameters?: ActionAttemptsListParameters, options?: ActionAttemptsListOptions) => ActionAttemptsListRequest;
+    /**
+     * Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/create'(): (parameters?: ClientSessionsCreateParameters, options?: ClientSessionsCreateOptions) => ClientSessionsCreateRequest;
+    /**
+     * Deletes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/delete'(): (parameters: ClientSessionsDeleteParameters, options?: ClientSessionsDeleteOptions) => ClientSessionsDeleteRequest;
+    /**
+     * Returns a specified [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/get'(): (parameters?: ClientSessionsGetParameters, options?: ClientSessionsGetOptions) => ClientSessionsGetRequest;
+    /**
+     * Returns a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.
+     */
     get '/client_sessions/get_or_create'(): (parameters?: ClientSessionsGetOrCreateParameters, options?: ClientSessionsGetOrCreateOptions) => ClientSessionsGetOrCreateRequest;
+    /**
+     * Grants a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews), [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.
+     */
     get '/client_sessions/grant_access'(): (parameters?: ClientSessionsGrantAccessParameters, options?: ClientSessionsGrantAccessOptions) => ClientSessionsGrantAccessRequest;
+    /**
+     * Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/list'(): (parameters?: ClientSessionsListParameters, options?: ClientSessionsListOptions) => ClientSessionsListRequest;
+    /**
+     * Revokes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     *
+     * Note that [deleting a client session](https://docs.seam.co/api/client_sessions/delete) is a separate action.
+     */
     get '/client_sessions/revoke'(): (parameters: ClientSessionsRevokeParameters, options?: ClientSessionsRevokeOptions) => ClientSessionsRevokeRequest;
+    /**
+     * Creates a new [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+     *
+     * To enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.
+     *
+     * You should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.
+     *
+     * See also: [Connect Webview Process](https://docs.seam.co/core-concepts/connect-webviews/connect-webview-process).
+     */
     get '/connect_webviews/create'(): (parameters?: ConnectWebviewsCreateParameters, options?: ConnectWebviewsCreateOptions) => ConnectWebviewsCreateRequest;
+    /**
+     * Deletes a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+     *
+     * You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
+     */
     get '/connect_webviews/delete'(): (parameters: ConnectWebviewsDeleteParameters, options?: ConnectWebviewsDeleteOptions) => ConnectWebviewsDeleteRequest;
+    /**
+     * Returns a specified [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+     *
+     * Unless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.
+     */
     get '/connect_webviews/get'(): (parameters: ConnectWebviewsGetParameters, options?: ConnectWebviewsGetOptions) => ConnectWebviewsGetRequest;
+    /**
+     * Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews).
+     */
     get '/connect_webviews/list'(): (parameters?: ConnectWebviewsListParameters, options?: ConnectWebviewsListOptions) => ConnectWebviewsListRequest;
+    /**
+     * Deletes a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+     *
+     * Deleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.
+     *
+     * For example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.
+     */
     get '/connected_accounts/delete'(): (parameters: ConnectedAccountsDeleteParameters, options?: ConnectedAccountsDeleteOptions) => ConnectedAccountsDeleteRequest;
+    /**
+     * Returns a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+     */
     get '/connected_accounts/get'(): (parameters?: ConnectedAccountsGetParameters, options?: ConnectedAccountsGetOptions) => ConnectedAccountsGetRequest;
+    /**
+     * Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts).
+     */
     get '/connected_accounts/list'(): (parameters?: ConnectedAccountsListParameters, options?: ConnectedAccountsListOptions) => ConnectedAccountsListRequest;
+    /**
+     * Request a [connected account](https://docs.seam.co/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
+     */
     get '/connected_accounts/sync'(): (parameters: ConnectedAccountsSyncParameters, options?: ConnectedAccountsSyncOptions) => ConnectedAccountsSyncRequest;
+    /**
+     * Updates a [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+     */
     get '/connected_accounts/update'(): (parameters: ConnectedAccountsUpdateParameters, options?: ConnectedAccountsUpdateOptions) => ConnectedAccountsUpdateRequest;
+    /**
+     * Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/connected_accounts/simulate/disconnect'(): (parameters: ConnectedAccountsSimulateDisconnectParameters, options?: ConnectedAccountsSimulateDisconnectOptions) => ConnectedAccountsSimulateDisconnectRequest;
+    /**
+     * Creates a new customer portal magic link with configurable features.
+     */
     get '/customers/create_portal'(): (parameters?: CustomersCreatePortalParameters, options?: CustomersCreatePortalOptions) => CustomersCreatePortalRequest;
+    /**
+     * Deletes customer data including resources like spaces, properties, rooms, users, etc.
+     * This will delete the partner resources and any related Seam resources (user identities, access grants, spaces).
+     */
     get '/customers/delete_data'(): (parameters?: CustomersDeleteDataParameters, options?: CustomersDeleteDataOptions) => CustomersDeleteDataRequest;
+    /**
+     * Pushes customer data including resources like spaces, properties, rooms, users, etc.
+     */
     get '/customers/push_data'(): (parameters: CustomersPushDataParameters, options?: CustomersPushDataOptions) => CustomersPushDataRequest;
+    /**
+     * Returns a specified [device](https://docs.seam.co/core-concepts/devices).
+     *
+     * You must specify either `device_id` or `name`.
+     */
     get '/devices/get'(): (parameters?: DevicesGetParameters, options?: DevicesGetOptions) => DevicesGetRequest;
+    /**
+     * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices).
+     */
     get '/devices/list'(): (parameters?: DevicesListParameters, options?: DevicesListOptions) => DevicesListRequest;
+    /**
+     * Returns a list of all device providers.
+     *
+     * The information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.
+     *
+     * When you create a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
+     */
     get '/devices/list_device_providers'(): (parameters?: DevicesListDeviceProvidersParameters, options?: DevicesListDeviceProvidersOptions) => DevicesListDeviceProvidersRequest;
+    /**
+     * Updates provider-specific metadata for devices.
+     */
     get '/devices/report_provider_metadata'(): (parameters: DevicesReportProviderMetadataParameters, options?: DevicesReportProviderMetadataOptions) => DevicesReportProviderMetadataRequest;
+    /**
+     * Updates a specified [device](https://docs.seam.co/core-concepts/devices).
+     *
+     * You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+     */
     get '/devices/update'(): (parameters: DevicesUpdateParameters, options?: DevicesUpdateOptions) => DevicesUpdateRequest;
+    /**
+     * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
+     */
     get '/devices/simulate/connect'(): (parameters: DevicesSimulateConnectParameters, options?: DevicesSimulateConnectOptions) => DevicesSimulateConnectRequest;
+    /**
+     * Simulates bringing the Wi‑Fi hub (bridge) back online for a device.
+     * Only applicable for sandbox workspaces and currently
+     * implemented for August and TTLock locks.
+     * This will clear the `hub_disconnected` error on the device.
+     */
     get '/devices/simulate/connect_to_hub'(): (parameters: DevicesSimulateConnectToHubParameters, options?: DevicesSimulateConnectToHubOptions) => DevicesSimulateConnectToHubRequest;
+    /**
+     * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
+     */
     get '/devices/simulate/disconnect'(): (parameters: DevicesSimulateDisconnectParameters, options?: DevicesSimulateDisconnectOptions) => DevicesSimulateDisconnectRequest;
+    /**
+     * Simulates taking the Wi‑Fi hub (bridge) offline for a device.
+     * Only applicable for sandbox workspaces and currently
+     * implemented for August, TTLock, and IglooHome devices.
+     * This will set the `hub_disconnected` error on the device, or mark the
+     * IglooHome bridge offline in sandbox.
+     */
     get '/devices/simulate/disconnect_from_hub'(): (parameters: DevicesSimulateDisconnectFromHubParameters, options?: DevicesSimulateDisconnectFromHubOptions) => DevicesSimulateDisconnectFromHubRequest;
+    /**
+     * Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only).
+     * Send `is_expired: true` to simulate an expired subscription, or `false` to simulate an active subscription.
+     * The actual device error is created/cleared by the poller after this state change.
+     */
     get '/devices/simulate/paid_subscription'(): (parameters: DevicesSimulatePaidSubscriptionParameters, options?: DevicesSimulatePaidSubscriptionOptions) => DevicesSimulatePaidSubscriptionRequest;
+    /**
+     * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
+     */
     get '/devices/simulate/remove'(): (parameters: DevicesSimulateRemoveParameters, options?: DevicesSimulateRemoveOptions) => DevicesSimulateRemoveRequest;
+    /**
+     * Returns a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+     *
+     * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+     *
+     * You must specify either `device_id` or `name`.
+     */
     get '/devices/unmanaged/get'(): (parameters?: DevicesUnmanagedGetParameters, options?: DevicesUnmanagedGetOptions) => DevicesUnmanagedGetRequest;
+    /**
+     * Returns a list of all [unmanaged devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+     *
+     * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+     */
     get '/devices/unmanaged/list'(): (parameters?: DevicesUnmanagedListParameters, options?: DevicesUnmanagedListOptions) => DevicesUnmanagedListRequest;
+    /**
+     * Updates a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.
+     *
+     * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+     */
     get '/devices/unmanaged/update'(): (parameters: DevicesUnmanagedUpdateParameters, options?: DevicesUnmanagedUpdateOptions) => DevicesUnmanagedUpdateRequest;
+    /**
+     * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
+     */
     get '/events/get'(): (parameters?: EventsGetParameters, options?: EventsGetOptions) => EventsGetRequest;
+    /**
+     * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to filter or see events that already took place.
+     */
     get '/events/list'(): (parameters?: EventsListParameters, options?: EventsListOptions) => EventsListRequest;
+    /**
+     * Deletes a specified [Instant Key](https://docs.seam.co/capability-guides/instant-keys).
+     */
     get '/instant_keys/delete'(): (parameters: InstantKeysDeleteParameters, options?: InstantKeysDeleteOptions) => InstantKeysDeleteRequest;
+    /**
+     * Gets an [instant key](https://docs.seam.co/capability-guides/instant-keys).
+     */
     get '/instant_keys/get'(): (parameters?: InstantKeysGetParameters, options?: InstantKeysGetOptions) => InstantKeysGetRequest;
+    /**
+     * Returns a list of all [instant keys](https://docs.seam.co/capability-guides/instant-keys).
+     */
     get '/instant_keys/list'(): (parameters?: InstantKeysListParameters, options?: InstantKeysListOptions) => InstantKeysListRequest;
+    /**
+     * Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+     */
     get '/locks/configure_auto_lock'(): (parameters: LocksConfigureAutoLockParameters, options?: LocksConfigureAutoLockOptions) => LocksConfigureAutoLockRequest;
+    /**
+     * Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+     * @deprecated Use `/devices/get` instead.
+     */
     get '/locks/get'(): (parameters?: LocksGetParameters, options?: LocksGetOptions) => LocksGetRequest;
+    /**
+     * Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks).
+     */
     get '/locks/list'(): (parameters?: LocksListParameters, options?: LocksListOptions) => LocksListRequest;
+    /**
+     * Locks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock).
+     */
     get '/locks/lock_door'(): (parameters: LocksLockDoorParameters, options?: LocksLockDoorOptions) => LocksLockDoorRequest;
+    /**
+     * Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock).
+     */
     get '/locks/unlock_door'(): (parameters: LocksUnlockDoorParameters, options?: LocksUnlockDoorOptions) => LocksUnlockDoorRequest;
+    /**
+     * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/locks/simulate/keypad_code_entry'(): (parameters: LocksSimulateKeypadCodeEntryParameters, options?: LocksSimulateKeypadCodeEntryOptions) => LocksSimulateKeypadCodeEntryRequest;
+    /**
+     * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/locks/simulate/manual_lock_via_keypad'(): (parameters: LocksSimulateManualLockViaKeypadParameters, options?: LocksSimulateManualLockViaKeypadOptions) => LocksSimulateManualLockViaKeypadRequest;
+    /**
+     * Returns a list of all [noise sensors](https://docs.seam.co/capability-guides/noise-sensors).
+     */
     get '/noise_sensors/list'(): (parameters?: NoiseSensorsListParameters, options?: NoiseSensorsListOptions) => NoiseSensorsListRequest;
+    /**
+     * Creates a new [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
+     */
     get '/noise_sensors/noise_thresholds/create'(): (parameters: NoiseSensorsNoiseThresholdsCreateParameters, options?: NoiseSensorsNoiseThresholdsCreateOptions) => NoiseSensorsNoiseThresholdsCreateRequest;
+    /**
+     * Deletes a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+     */
     get '/noise_sensors/noise_thresholds/delete'(): (parameters: NoiseSensorsNoiseThresholdsDeleteParameters, options?: NoiseSensorsNoiseThresholdsDeleteOptions) => NoiseSensorsNoiseThresholdsDeleteRequest;
+    /**
+     * Returns a specified [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+     */
     get '/noise_sensors/noise_thresholds/get'(): (parameters: NoiseSensorsNoiseThresholdsGetParameters, options?: NoiseSensorsNoiseThresholdsGetOptions) => NoiseSensorsNoiseThresholdsGetRequest;
+    /**
+     * Returns a list of all [noise thresholds](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+     */
     get '/noise_sensors/noise_thresholds/list'(): (parameters: NoiseSensorsNoiseThresholdsListParameters, options?: NoiseSensorsNoiseThresholdsListOptions) => NoiseSensorsNoiseThresholdsListRequest;
+    /**
+     * Updates a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+     */
     get '/noise_sensors/noise_thresholds/update'(): (parameters: NoiseSensorsNoiseThresholdsUpdateParameters, options?: NoiseSensorsNoiseThresholdsUpdateOptions) => NoiseSensorsNoiseThresholdsUpdateRequest;
+    /**
+     * Simulates the triggering of a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+     */
     get '/noise_sensors/simulate/trigger_noise_threshold'(): (parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters, options?: NoiseSensorsSimulateTriggerNoiseThresholdOptions) => NoiseSensorsSimulateTriggerNoiseThresholdRequest;
+    /**
+     * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).
+     */
     get '/phones/deactivate'(): (parameters: PhonesDeactivateParameters, options?: PhonesDeactivateOptions) => PhonesDeactivateRequest;
+    /**
+     * Returns a specified [phone](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity).
+     */
     get '/phones/get'(): (parameters: PhonesGetParameters, options?: PhonesGetOptions) => PhonesGetRequest;
+    /**
+     * Returns a list of all [phones](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+     */
     get '/phones/list'(): (parameters?: PhonesListParameters, options?: PhonesListOptions) => PhonesListRequest;
+    /**
+     * Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).
+     */
     get '/phones/simulate/create_sandbox_phone'(): (parameters: PhonesSimulateCreateSandboxPhoneParameters, options?: PhonesSimulateCreateSandboxPhoneOptions) => PhonesSimulateCreateSandboxPhoneRequest;
+    /**
+     * Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
+     */
     get '/spaces/add_acs_entrances'(): (parameters: SpacesAddAcsEntrancesParameters, options?: SpacesAddAcsEntrancesOptions) => SpacesAddAcsEntrancesRequest;
+    /**
+     * Adds a [connected account](https://docs.seam.co/core-concepts/connected-accounts) to a specific space.
+     */
     get '/spaces/add_connected_account'(): (parameters: SpacesAddConnectedAccountParameters, options?: SpacesAddConnectedAccountOptions) => SpacesAddConnectedAccountRequest;
+    /**
+     * Adds devices to a specific space.
+     */
     get '/spaces/add_devices'(): (parameters: SpacesAddDevicesParameters, options?: SpacesAddDevicesOptions) => SpacesAddDevicesRequest;
+    /**
+     * Creates a new space.
+     */
     get '/spaces/create'(): (parameters: SpacesCreateParameters, options?: SpacesCreateOptions) => SpacesCreateRequest;
+    /**
+     * Deletes a space.
+     */
     get '/spaces/delete'(): (parameters: SpacesDeleteParameters, options?: SpacesDeleteOptions) => SpacesDeleteRequest;
+    /**
+     * Gets a space.
+     */
     get '/spaces/get'(): (parameters?: SpacesGetParameters, options?: SpacesGetOptions) => SpacesGetRequest;
+    /**
+     * Gets all related resources for one or more Spaces.
+     */
     get '/spaces/get_related'(): (parameters?: SpacesGetRelatedParameters, options?: SpacesGetRelatedOptions) => SpacesGetRelatedRequest;
+    /**
+     * Returns a list of all spaces.
+     */
     get '/spaces/list'(): (parameters?: SpacesListParameters, options?: SpacesListOptions) => SpacesListRequest;
+    /**
+     * Removes [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
+     */
     get '/spaces/remove_acs_entrances'(): (parameters: SpacesRemoveAcsEntrancesParameters, options?: SpacesRemoveAcsEntrancesOptions) => SpacesRemoveAcsEntrancesRequest;
+    /**
+     * Removes a [connected account](https://docs.seam.co/core-concepts/connected-accounts) from a specific space.
+     */
     get '/spaces/remove_connected_account'(): (parameters: SpacesRemoveConnectedAccountParameters, options?: SpacesRemoveConnectedAccountOptions) => SpacesRemoveConnectedAccountRequest;
+    /**
+     * Removes devices from a specific space.
+     */
     get '/spaces/remove_devices'(): (parameters: SpacesRemoveDevicesParameters, options?: SpacesRemoveDevicesOptions) => SpacesRemoveDevicesRequest;
+    /**
+     * Updates an existing space.
+     */
     get '/spaces/update'(): (parameters?: SpacesUpdateParameters, options?: SpacesUpdateOptions) => SpacesUpdateRequest;
+    /**
+     * Activates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/activate_climate_preset'(): (parameters: ThermostatsActivateClimatePresetParameters, options?: ThermostatsActivateClimatePresetOptions) => ThermostatsActivateClimatePresetRequest;
+    /**
+     * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [cool mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+     */
     get '/thermostats/cool'(): (parameters: ThermostatsCoolParameters, options?: ThermostatsCoolOptions) => ThermostatsCoolRequest;
+    /**
+     * Creates a [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/create_climate_preset'(): (parameters: ThermostatsCreateClimatePresetParameters, options?: ThermostatsCreateClimatePresetOptions) => ThermostatsCreateClimatePresetRequest;
+    /**
+     * Deletes a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/delete_climate_preset'(): (parameters: ThermostatsDeleteClimatePresetParameters, options?: ThermostatsDeleteClimatePresetOptions) => ThermostatsDeleteClimatePresetRequest;
+    /**
+     * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+     */
     get '/thermostats/heat'(): (parameters: ThermostatsHeatParameters, options?: ThermostatsHeatOptions) => ThermostatsHeatRequest;
+    /**
+     * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+     */
     get '/thermostats/heat_cool'(): (parameters: ThermostatsHeatCoolParameters, options?: ThermostatsHeatCoolOptions) => ThermostatsHeatCoolRequest;
+    /**
+     * Returns a list of all [thermostats](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/list'(): (parameters?: ThermostatsListParameters, options?: ThermostatsListOptions) => ThermostatsListRequest;
+    /**
+     * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+     */
     get '/thermostats/off'(): (parameters: ThermostatsOffParameters, options?: ThermostatsOffOptions) => ThermostatsOffRequest;
+    /**
+     * Sets a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/set_fallback_climate_preset'(): (parameters: ThermostatsSetFallbackClimatePresetParameters, options?: ThermostatsSetFallbackClimatePresetOptions) => ThermostatsSetFallbackClimatePresetRequest;
+    /**
+     * Sets the [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/set_fan_mode'(): (parameters: ThermostatsSetFanModeParameters, options?: ThermostatsSetFanModeOptions) => ThermostatsSetFanModeRequest;
+    /**
+     * Sets the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/set_hvac_mode'(): (parameters: ThermostatsSetHvacModeParameters, options?: ThermostatsSetHvacModeOptions) => ThermostatsSetHvacModeRequest;
+    /**
+     * Sets a [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
+     */
     get '/thermostats/set_temperature_threshold'(): (parameters: ThermostatsSetTemperatureThresholdParameters, options?: ThermostatsSetTemperatureThresholdOptions) => ThermostatsSetTemperatureThresholdRequest;
+    /**
+     * Updates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/update_climate_preset'(): (parameters: ThermostatsUpdateClimatePresetParameters, options?: ThermostatsUpdateClimatePresetOptions) => ThermostatsUpdateClimatePresetRequest;
+    /**
+     * Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.
+     */
     get '/thermostats/update_weekly_program'(): (parameters: ThermostatsUpdateWeeklyProgramParameters, options?: ThermostatsUpdateWeeklyProgramOptions) => ThermostatsUpdateWeeklyProgramRequest;
+    /**
+     * Creates a new thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.
+     */
     get '/thermostats/daily_programs/create'(): (parameters: ThermostatsDailyProgramsCreateParameters, options?: ThermostatsDailyProgramsCreateOptions) => ThermostatsDailyProgramsCreateRequest;
+    /**
+     * Deletes a thermostat daily program.
+     */
     get '/thermostats/daily_programs/delete'(): (parameters: ThermostatsDailyProgramsDeleteParameters, options?: ThermostatsDailyProgramsDeleteOptions) => ThermostatsDailyProgramsDeleteRequest;
+    /**
+     * Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.
+     */
     get '/thermostats/daily_programs/update'(): (parameters: ThermostatsDailyProgramsUpdateParameters, options?: ThermostatsDailyProgramsUpdateOptions) => ThermostatsDailyProgramsUpdateRequest;
+    /**
+     * Creates a new [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/schedules/create'(): (parameters: ThermostatsSchedulesCreateParameters, options?: ThermostatsSchedulesCreateOptions) => ThermostatsSchedulesCreateRequest;
+    /**
+     * Deletes a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/schedules/delete'(): (parameters: ThermostatsSchedulesDeleteParameters, options?: ThermostatsSchedulesDeleteOptions) => ThermostatsSchedulesDeleteRequest;
+    /**
+     * Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+     */
     get '/thermostats/schedules/get'(): (parameters: ThermostatsSchedulesGetParameters, options?: ThermostatsSchedulesGetOptions) => ThermostatsSchedulesGetRequest;
+    /**
+     * Returns a list of all [thermostat schedules](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/schedules/list'(): (parameters: ThermostatsSchedulesListParameters, options?: ThermostatsSchedulesListOptions) => ThermostatsSchedulesListRequest;
+    /**
+     * Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+     */
     get '/thermostats/schedules/update'(): (parameters: ThermostatsSchedulesUpdateParameters, options?: ThermostatsSchedulesUpdateOptions) => ThermostatsSchedulesUpdateRequest;
+    /**
+     * Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+     */
     get '/thermostats/simulate/hvac_mode_adjusted'(): (parameters: ThermostatsSimulateHvacModeAdjustedParameters, options?: ThermostatsSimulateHvacModeAdjustedOptions) => ThermostatsSimulateHvacModeAdjustedRequest;
+    /**
+     * Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+     */
     get '/thermostats/simulate/temperature_reached'(): (parameters: ThermostatsSimulateTemperatureReachedParameters, options?: ThermostatsSimulateTemperatureReachedOptions) => ThermostatsSimulateTemperatureReachedRequest;
+    /**
+     * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     *
+     * You must specify either `user_identity_id` or `user_identity_key` to identify the user identity.
+     *
+     * If `user_identity_key` is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.
+     */
     get '/user_identities/add_acs_user'(): (parameters: UserIdentitiesAddAcsUserParameters, options?: UserIdentitiesAddAcsUserOptions) => UserIdentitiesAddAcsUserRequest;
+    /**
+     * Creates a new [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/create'(): (parameters?: UserIdentitiesCreateParameters, options?: UserIdentitiesCreateOptions) => UserIdentitiesCreateRequest;
+    /**
+     * Deletes a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/api/acs/credentials), [acs users](https://docs.seam.co/api/acs/users) and [client sessions](https://docs.seam.co/api/client_sessions).
+     */
     get '/user_identities/delete'(): (parameters: UserIdentitiesDeleteParameters, options?: UserIdentitiesDeleteOptions) => UserIdentitiesDeleteRequest;
+    /**
+     * Generates a new [instant key](https://docs.seam.co/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/generate_instant_key'(): (parameters: UserIdentitiesGenerateInstantKeyParameters, options?: UserIdentitiesGenerateInstantKeyOptions) => UserIdentitiesGenerateInstantKeyRequest;
+    /**
+     * Returns a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/get'(): (parameters?: UserIdentitiesGetParameters, options?: UserIdentitiesGetOptions) => UserIdentitiesGetRequest;
+    /**
+     * Grants a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/core-concepts/devices/).
+     */
     get '/user_identities/grant_access_to_device'(): (parameters: UserIdentitiesGrantAccessToDeviceParameters, options?: UserIdentitiesGrantAccessToDeviceOptions) => UserIdentitiesGrantAccessToDeviceRequest;
+    /**
+     * Returns a list of all [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/list'(): (parameters?: UserIdentitiesListParameters, options?: UserIdentitiesListOptions) => UserIdentitiesListRequest;
+    /**
+     * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.
+     */
     get '/user_identities/list_accessible_devices'(): (parameters: UserIdentitiesListAccessibleDevicesParameters, options?: UserIdentitiesListAccessibleDevicesOptions) => UserIdentitiesListAccessibleDevicesRequest;
+    /**
+     * Returns a list of all [ACS entrances](https://docs.seam.co/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.
+     */
     get '/user_identities/list_accessible_entrances'(): (parameters: UserIdentitiesListAccessibleEntrancesParameters, options?: UserIdentitiesListAccessibleEntrancesOptions) => UserIdentitiesListAccessibleEntrancesRequest;
+    /**
+     * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/list_acs_systems'(): (parameters: UserIdentitiesListAcsSystemsParameters, options?: UserIdentitiesListAcsSystemsOptions) => UserIdentitiesListAcsSystemsRequest;
+    /**
+     * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/list_acs_users'(): (parameters: UserIdentitiesListAcsUsersParameters, options?: UserIdentitiesListAcsUsersOptions) => UserIdentitiesListAcsUsersRequest;
+    /**
+     * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/remove_acs_user'(): (parameters: UserIdentitiesRemoveAcsUserParameters, options?: UserIdentitiesRemoveAcsUserOptions) => UserIdentitiesRemoveAcsUserRequest;
+    /**
+     * Revokes access to a specified [device](https://docs.seam.co/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/revoke_access_to_device'(): (parameters: UserIdentitiesRevokeAccessToDeviceParameters, options?: UserIdentitiesRevokeAccessToDeviceOptions) => UserIdentitiesRevokeAccessToDeviceRequest;
+    /**
+     * Updates a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+     */
     get '/user_identities/update'(): (parameters: UserIdentitiesUpdateParameters, options?: UserIdentitiesUpdateOptions) => UserIdentitiesUpdateRequest;
+    /**
+     * Returns a specified unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
+     */
     get '/user_identities/unmanaged/get'(): (parameters: UserIdentitiesUnmanagedGetParameters, options?: UserIdentitiesUnmanagedGetOptions) => UserIdentitiesUnmanagedGetRequest;
+    /**
+     * Returns a list of all unmanaged [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
+     */
     get '/user_identities/unmanaged/list'(): (parameters?: UserIdentitiesUnmanagedListParameters, options?: UserIdentitiesUnmanagedListOptions) => UserIdentitiesUnmanagedListRequest;
+    /**
+     * Updates an unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.
+     *
+     * This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.
+     */
     get '/user_identities/unmanaged/update'(): (parameters: UserIdentitiesUnmanagedUpdateParameters, options?: UserIdentitiesUnmanagedUpdateOptions) => UserIdentitiesUnmanagedUpdateRequest;
+    /**
+     * Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/create'(): (parameters: WebhooksCreateParameters, options?: WebhooksCreateOptions) => WebhooksCreateRequest;
+    /**
+     * Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/delete'(): (parameters: WebhooksDeleteParameters, options?: WebhooksDeleteOptions) => WebhooksDeleteRequest;
+    /**
+     * Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/get'(): (parameters: WebhooksGetParameters, options?: WebhooksGetOptions) => WebhooksGetRequest;
+    /**
+     * Returns a list of all [webhooks](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/list'(): (parameters?: WebhooksListParameters, options?: WebhooksListOptions) => WebhooksListRequest;
+    /**
+     * Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/update'(): (parameters: WebhooksUpdateParameters, options?: WebhooksUpdateOptions) => WebhooksUpdateRequest;
+    /**
+     * Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces).
+     */
     get '/workspaces/create'(): (parameters: WorkspacesCreateParameters, options?: WorkspacesCreateOptions) => WorkspacesCreateRequest;
+    /**
+     * Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+     */
     get '/workspaces/get'(): (parameters?: WorkspacesGetParameters, options?: WorkspacesGetOptions) => WorkspacesGetRequest;
+    /**
+     * Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+     */
     get '/workspaces/list'(): (parameters?: WorkspacesListParameters, options?: WorkspacesListOptions) => WorkspacesListRequest;
+    /**
+     * Resets the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.
+     */
     get '/workspaces/reset_sandbox'(): (parameters?: WorkspacesResetSandboxParameters, options?: WorkspacesResetSandboxOptions) => WorkspacesResetSandboxRequest;
+    /**
+     * Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+     */
     get '/workspaces/update'(): (parameters?: WorkspacesUpdateParameters, options?: WorkspacesUpdateOptions) => WorkspacesUpdateRequest;
 }
 export type SeamHttpEndpointQueryPaths = '/access_codes/generate_code' | '/access_codes/get' | '/access_codes/list' | '/access_codes/unmanaged/get' | '/access_codes/unmanaged/list' | '/access_grants/get' | '/access_grants/get_related' | '/access_grants/list' | '/access_grants/unmanaged/get' | '/access_grants/unmanaged/list' | '/access_methods/get' | '/access_methods/get_related' | '/access_methods/list' | '/access_methods/unmanaged/get' | '/access_methods/unmanaged/list' | '/acs/access_groups/get' | '/acs/access_groups/list' | '/acs/access_groups/list_accessible_entrances' | '/acs/access_groups/list_users' | '/acs/credentials/get' | '/acs/credentials/list' | '/acs/credentials/list_accessible_entrances' | '/acs/encoders/get' | '/acs/encoders/list' | '/acs/entrances/get' | '/acs/entrances/list' | '/acs/entrances/list_credentials_with_access' | '/acs/systems/get' | '/acs/systems/list' | '/acs/systems/list_compatible_credential_manager_acs_systems' | '/acs/users/get' | '/acs/users/list' | '/acs/users/list_accessible_entrances' | '/action_attempts/get' | '/action_attempts/list' | '/client_sessions/get' | '/client_sessions/list' | '/connect_webviews/get' | '/connect_webviews/list' | '/connected_accounts/get' | '/connected_accounts/list' | '/devices/get' | '/devices/list' | '/devices/list_device_providers' | '/devices/unmanaged/get' | '/devices/unmanaged/list' | '/events/get' | '/events/list' | '/instant_keys/get' | '/instant_keys/list' | '/locks/get' | '/locks/list' | '/noise_sensors/list' | '/noise_sensors/noise_thresholds/get' | '/noise_sensors/noise_thresholds/list' | '/phones/get' | '/phones/list' | '/spaces/get' | '/spaces/get_related' | '/spaces/list' | '/thermostats/list' | '/thermostats/schedules/get' | '/thermostats/schedules/list' | '/user_identities/get' | '/user_identities/list' | '/user_identities/list_accessible_devices' | '/user_identities/list_accessible_entrances' | '/user_identities/list_acs_systems' | '/user_identities/list_acs_users' | '/user_identities/unmanaged/get' | '/user_identities/unmanaged/list' | '/webhooks/get' | '/webhooks/list' | '/workspaces/get' | '/workspaces/list';