@seamapi/http 2.1.0 → 2.2.0

package/lib/seam/connect/routes/seam-http-endpoints.js

@@ -124,6 +124,9 @@ export class SeamHttpEndpoints {
         const clientSessions = SeamHttpClientSessions.fromClient(this.client);
         await clientSessions.get();
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesCreate(...args) {
@@ -131,6 +134,19 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesCreateMultiple(...args) {
@@ -138,6 +154,9 @@ export class SeamHttpEndpoints {
             return seam.createMultiple(...args);
         };
     }
+    /**
+     * Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+     */
     get '/access_codes/delete'() {
         const { client, defaults } = this;
         return function accessCodesDelete(...args) {
@@ -145,6 +164,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesGenerateCode(...args) {
@@ -152,6 +174,11 @@ export class SeamHttpEndpoints {
             return seam.generateCode(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesGet(...args) {
@@ -159,6 +186,11 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesList(...args) {
@@ -166,6 +198,17 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesPullBackupAccessCode(...args) {
@@ -173,6 +216,11 @@ export class SeamHttpEndpoints {
             return seam.pullBackupAccessCode(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesReportDeviceConstraints(...args) {
@@ -180,6 +228,11 @@ export class SeamHttpEndpoints {
             return seam.reportDeviceConstraints(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesUpdate(...args) {
@@ -187,6 +240,13 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesUpdateMultiple(...args) {
@@ -194,6 +254,9 @@ export class SeamHttpEndpoints {
             return seam.updateMultiple(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesSimulateCreateUnmanagedAccessCode(...args) {
@@ -201,6 +264,13 @@ export class SeamHttpEndpoints {
             return seam.createUnmanagedAccessCode(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesUnmanagedConvertToManaged(...args) {
@@ -208,6 +278,9 @@ export class SeamHttpEndpoints {
             return seam.convertToManaged(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesUnmanagedDelete(...args) {
@@ -215,6 +288,11 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesUnmanagedGet(...args) {
@@ -222,6 +300,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesUnmanagedList(...args) {
@@ -229,6 +310,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessCodesUnmanagedUpdate(...args) {
@@ -236,6 +320,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessGrantsCreate(...args) {
@@ -243,6 +330,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * Delete an Access Grant.
+     */
     get '/access_grants/delete'() {
         const { client, defaults } = this;
         return function accessGrantsDelete(...args) {
@@ -250,6 +340,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Get an Access Grant.
+     */
     get '/access_grants/get'() {
         const { client, defaults } = this;
         return function accessGrantsGet(...args) {
@@ -257,6 +350,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Gets all related resources for one or more Access Grants.
+     */
     get '/access_grants/get_related'() {
         const { client, defaults } = this;
         return function accessGrantsGetRelated(...args) {
@@ -264,6 +360,9 @@ export class SeamHttpEndpoints {
             return seam.getRelated(...args);
         };
     }
+    /**
+     * Gets an Access Grant.
+     */
     get '/access_grants/list'() {
         const { client, defaults } = this;
         return function accessGrantsList(...args) {
@@ -271,6 +370,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Adds additional requested access methods to an existing Access Grant.
+     */
     get '/access_grants/request_access_methods'() {
         const { client, defaults } = this;
         return function accessGrantsRequestAccessMethods(...args) {
@@ -278,6 +380,9 @@ export class SeamHttpEndpoints {
             return seam.requestAccessMethods(...args);
         };
     }
+    /**
+     * Updates an existing Access Grant's time window.
+     */
     get '/access_grants/update'() {
         const { client, defaults } = this;
         return function accessGrantsUpdate(...args) {
@@ -285,6 +390,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * Get an unmanaged Access Grant (where is_managed = false).
+     */
     get '/access_grants/unmanaged/get'() {
         const { client, defaults } = this;
         return function accessGrantsUnmanagedGet(...args) {
@@ -292,6 +400,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Gets unmanaged Access Grants (where is_managed = false).
+     */
     get '/access_grants/unmanaged/list'() {
         const { client, defaults } = this;
         return function accessGrantsUnmanagedList(...args) {
@@ -299,6 +410,13 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessGrantsUnmanagedUpdate(...args) {
@@ -306,6 +424,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessMethodsAssignCard(...args) {
@@ -313,6 +434,9 @@ export class SeamHttpEndpoints {
             return seam.assignCard(...args);
         };
     }
+    /**
+     * Deletes an access method.
+     */
     get '/access_methods/delete'() {
         const { client, defaults } = this;
         return function accessMethodsDelete(...args) {
@@ -320,6 +444,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessMethodsEncode(...args) {
@@ -327,6 +454,9 @@ export class SeamHttpEndpoints {
             return seam.encode(...args);
         };
     }
+    /**
+     * Gets an access method.
+     */
     get '/access_methods/get'() {
         const { client, defaults } = this;
         return function accessMethodsGet(...args) {
@@ -334,6 +464,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Gets all related resources for one or more Access Methods.
+     */
     get '/access_methods/get_related'() {
         const { client, defaults } = this;
         return function accessMethodsGetRelated(...args) {
@@ -341,6 +474,9 @@ export class SeamHttpEndpoints {
             return seam.getRelated(...args);
         };
     }
+    /**
+     * Lists all access methods, usually filtered by Access Grant.
+     */
     get '/access_methods/list'() {
         const { client, defaults } = this;
         return function accessMethodsList(...args) {
@@ -348,6 +484,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function accessMethodsUnlockDoor(...args) {
@@ -355,6 +494,9 @@ export class SeamHttpEndpoints {
             return seam.unlockDoor(...args);
         };
     }
+    /**
+     * Gets an unmanaged access method (where is_managed = false).
+     */
     get '/access_methods/unmanaged/get'() {
         const { client, defaults } = this;
         return function accessMethodsUnmanagedGet(...args) {
@@ -362,6 +504,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.
+     */
     get '/access_methods/unmanaged/list'() {
         const { client, defaults } = this;
         return function accessMethodsUnmanagedList(...args) {
@@ -369,6 +514,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsAccessGroupsAddUser(...args) {
@@ -376,6 +524,9 @@ export class SeamHttpEndpoints {
             return seam.addUser(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsAccessGroupsDelete(...args) {
@@ -383,6 +534,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsAccessGroupsGet(...args) {
@@ -390,6 +544,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsAccessGroupsList(...args) {
@@ -397,6 +554,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsAccessGroupsListAccessibleEntrances(...args) {
@@ -404,6 +564,9 @@ export class SeamHttpEndpoints {
             return seam.listAccessibleEntrances(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsAccessGroupsListUsers(...args) {
@@ -411,6 +574,9 @@ export class SeamHttpEndpoints {
             return seam.listUsers(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsAccessGroupsRemoveUser(...args) {
@@ -418,6 +584,9 @@ export class SeamHttpEndpoints {
             return seam.removeUser(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsCredentialsAssign(...args) {
@@ -425,6 +594,9 @@ export class SeamHttpEndpoints {
             return seam.assign(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsCredentialsCreate(...args) {
@@ -432,6 +604,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/credentials/delete'() {
         const { client, defaults } = this;
         return function acsCredentialsDelete(...args) {
@@ -439,6 +614,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/credentials/get'() {
         const { client, defaults } = this;
         return function acsCredentialsGet(...args) {
@@ -446,6 +624,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     get '/acs/credentials/list'() {
         const { client, defaults } = this;
         return function acsCredentialsList(...args) {
@@ -453,6 +634,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsCredentialsListAccessibleEntrances(...args) {
@@ -460,6 +644,9 @@ export class SeamHttpEndpoints {
             return seam.listAccessibleEntrances(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsCredentialsUnassign(...args) {
@@ -467,6 +654,9 @@ export class SeamHttpEndpoints {
             return seam.unassign(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsCredentialsUpdate(...args) {
@@ -474,6 +664,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersEncodeCredential(...args) {
@@ -481,6 +674,9 @@ export class SeamHttpEndpoints {
             return seam.encodeCredential(...args);
         };
     }
+    /**
+     * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     get '/acs/encoders/get'() {
         const { client, defaults } = this;
         return function acsEncodersGet(...args) {
@@ -488,6 +684,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersList(...args) {
@@ -495,6 +694,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersScanCredential(...args) {
@@ -502,6 +704,9 @@ export class SeamHttpEndpoints {
             return seam.scanCredential(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersScanToAssignCredential(...args) {
@@ -509,6 +714,9 @@ export class SeamHttpEndpoints {
             return seam.scanToAssignCredential(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersSimulateNextCredentialEncodeWillFail(...args) {
@@ -516,6 +724,9 @@ export class SeamHttpEndpoints {
             return seam.nextCredentialEncodeWillFail(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersSimulateNextCredentialEncodeWillSucceed(...args) {
@@ -523,6 +734,9 @@ export class SeamHttpEndpoints {
             return seam.nextCredentialEncodeWillSucceed(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersSimulateNextCredentialScanWillFail(...args) {
@@ -530,6 +744,9 @@ export class SeamHttpEndpoints {
             return seam.nextCredentialScanWillFail(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEncodersSimulateNextCredentialScanWillSucceed(...args) {
@@ -537,6 +754,9 @@ export class SeamHttpEndpoints {
             return seam.nextCredentialScanWillSucceed(...args);
         };
     }
+    /**
+     * Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+     */
     get '/acs/entrances/get'() {
         const { client, defaults } = this;
         return function acsEntrancesGet(...args) {
@@ -544,6 +764,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEntrancesGrantAccess(...args) {
@@ -551,6 +774,9 @@ export class SeamHttpEndpoints {
             return seam.grantAccess(...args);
         };
     }
+    /**
+     * Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+     */
     get '/acs/entrances/list'() {
         const { client, defaults } = this;
         return function acsEntrancesList(...args) {
@@ -558,6 +784,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEntrancesListCredentialsWithAccess(...args) {
@@ -565,6 +794,9 @@ export class SeamHttpEndpoints {
             return seam.listCredentialsWithAccess(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsEntrancesUnlock(...args) {
@@ -572,6 +804,9 @@ export class SeamHttpEndpoints {
             return seam.unlock(...args);
         };
     }
+    /**
+     * Returns a specified [access system](https://docs.seam.co/low-level-apis/access-systems).
+     */
     get '/acs/systems/get'() {
         const { client, defaults } = this;
         return function acsSystemsGet(...args) {
@@ -579,6 +814,11 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsSystemsList(...args) {
@@ -586,6 +826,11 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsSystemsListCompatibleCredentialManagerAcsSystems(...args) {
@@ -593,6 +838,9 @@ export class SeamHttpEndpoints {
             return seam.listCompatibleCredentialManagerAcsSystems(...args);
         };
     }
+    /**
+     * Reports ACS system device status including encoders and entrances.
+     */
     get '/acs/systems/report_devices'() {
         const { client, defaults } = this;
         return function acsSystemsReportDevices(...args) {
@@ -600,6 +848,9 @@ export class SeamHttpEndpoints {
             return seam.reportDevices(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsUsersAddToAccessGroup(...args) {
@@ -607,6 +858,9 @@ export class SeamHttpEndpoints {
             return seam.addToAccessGroup(...args);
         };
     }
+    /**
+     * Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/create'() {
         const { client, defaults } = this;
         return function acsUsersCreate(...args) {
@@ -614,6 +868,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsUsersDelete(...args) {
@@ -621,6 +878,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/get'() {
         const { client, defaults } = this;
         return function acsUsersGet(...args) {
@@ -628,6 +888,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/list'() {
         const { client, defaults } = this;
         return function acsUsersList(...args) {
@@ -635,6 +898,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsUsersListAccessibleEntrances(...args) {
@@ -642,6 +908,9 @@ export class SeamHttpEndpoints {
             return seam.listAccessibleEntrances(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsUsersRemoveFromAccessGroup(...args) {
@@ -649,6 +918,9 @@ export class SeamHttpEndpoints {
             return seam.removeFromAccessGroup(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function acsUsersRevokeAccessToAllEntrances(...args) {
@@ -656,6 +928,9 @@ export class SeamHttpEndpoints {
             return seam.revokeAccessToAllEntrances(...args);
         };
     }
+    /**
+     * [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'() {
         const { client, defaults } = this;
         return function acsUsersSuspend(...args) {
@@ -663,6 +938,9 @@ export class SeamHttpEndpoints {
             return seam.suspend(...args);
         };
     }
+    /**
+     * [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'() {
         const { client, defaults } = this;
         return function acsUsersUnsuspend(...args) {
@@ -670,6 +948,9 @@ export class SeamHttpEndpoints {
             return seam.unsuspend(...args);
         };
     }
+    /**
+     * Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+     */
     get '/acs/users/update'() {
         const { client, defaults } = this;
         return function acsUsersUpdate(...args) {
@@ -677,6 +958,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts).
+     */
     get '/action_attempts/get'() {
         const { client, defaults } = this;
         return function actionAttemptsGet(...args) {
@@ -684,6 +968,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function actionAttemptsList(...args) {
@@ -691,6 +978,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/create'() {
         const { client, defaults } = this;
         return function clientSessionsCreate(...args) {
@@ -698,6 +988,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * Deletes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/delete'() {
         const { client, defaults } = this;
         return function clientSessionsDelete(...args) {
@@ -705,6 +998,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Returns a specified [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/get'() {
         const { client, defaults } = this;
         return function clientSessionsGet(...args) {
@@ -712,6 +1008,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function clientSessionsGetOrCreate(...args) {
@@ -719,6 +1018,9 @@ export class SeamHttpEndpoints {
             return seam.getOrCreate(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function clientSessionsGrantAccess(...args) {
@@ -726,6 +1028,9 @@ export class SeamHttpEndpoints {
             return seam.grantAccess(...args);
         };
     }
+    /**
+     * Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+     */
     get '/client_sessions/list'() {
         const { client, defaults } = this;
         return function clientSessionsList(...args) {
@@ -733,6 +1038,11 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function clientSessionsRevoke(...args) {
@@ -740,6 +1050,15 @@ export class SeamHttpEndpoints {
             return seam.revoke(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function connectWebviewsCreate(...args) {
@@ -747,6 +1066,11 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function connectWebviewsDelete(...args) {
@@ -754,6 +1078,11 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function connectWebviewsGet(...args) {
@@ -761,6 +1090,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews).
+     */
     get '/connect_webviews/list'() {
         const { client, defaults } = this;
         return function connectWebviewsList(...args) {
@@ -768,6 +1100,13 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function connectedAccountsDelete(...args) {
@@ -775,6 +1114,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Returns a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+     */
     get '/connected_accounts/get'() {
         const { client, defaults } = this;
         return function connectedAccountsGet(...args) {
@@ -782,6 +1124,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts).
+     */
     get '/connected_accounts/list'() {
         const { client, defaults } = this;
         return function connectedAccountsList(...args) {
@@ -789,6 +1134,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Request a [connected account](https://docs.seam.co/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
+     */
     get '/connected_accounts/sync'() {
         const { client, defaults } = this;
         return function connectedAccountsSync(...args) {
@@ -796,6 +1144,9 @@ export class SeamHttpEndpoints {
             return seam.sync(...args);
         };
     }
+    /**
+     * Updates a [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+     */
     get '/connected_accounts/update'() {
         const { client, defaults } = this;
         return function connectedAccountsUpdate(...args) {
@@ -803,6 +1154,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function connectedAccountsSimulateDisconnect(...args) {
@@ -810,6 +1164,9 @@ export class SeamHttpEndpoints {
             return seam.disconnect(...args);
         };
     }
+    /**
+     * Creates a new customer portal magic link with configurable features.
+     */
     get '/customers/create_portal'() {
         const { client, defaults } = this;
         return function customersCreatePortal(...args) {
@@ -817,6 +1174,10 @@ export class SeamHttpEndpoints {
             return seam.createPortal(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function customersDeleteData(...args) {
@@ -824,6 +1185,9 @@ export class SeamHttpEndpoints {
             return seam.deleteData(...args);
         };
     }
+    /**
+     * Pushes customer data including resources like spaces, properties, rooms, users, etc.
+     */
     get '/customers/push_data'() {
         const { client, defaults } = this;
         return function customersPushData(...args) {
@@ -831,6 +1195,11 @@ export class SeamHttpEndpoints {
             return seam.pushData(...args);
         };
     }
+    /**
+     * Returns a specified [device](https://docs.seam.co/core-concepts/devices).
+     *
+     * You must specify either `device_id` or `name`.
+     */
     get '/devices/get'() {
         const { client, defaults } = this;
         return function devicesGet(...args) {
@@ -838,6 +1207,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices).
+     */
     get '/devices/list'() {
         const { client, defaults } = this;
         return function devicesList(...args) {
@@ -845,6 +1217,13 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesListDeviceProviders(...args) {
@@ -852,6 +1231,9 @@ export class SeamHttpEndpoints {
             return seam.listDeviceProviders(...args);
         };
     }
+    /**
+     * Updates provider-specific metadata for devices.
+     */
     get '/devices/report_provider_metadata'() {
         const { client, defaults } = this;
         return function devicesReportProviderMetadata(...args) {
@@ -859,6 +1241,11 @@ export class SeamHttpEndpoints {
             return seam.reportProviderMetadata(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesUpdate(...args) {
@@ -866,6 +1253,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesSimulateConnect(...args) {
@@ -873,6 +1263,12 @@ export class SeamHttpEndpoints {
             return seam.connect(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesSimulateConnectToHub(...args) {
@@ -880,6 +1276,9 @@ export class SeamHttpEndpoints {
             return seam.connectToHub(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesSimulateDisconnect(...args) {
@@ -887,6 +1286,13 @@ export class SeamHttpEndpoints {
             return seam.disconnect(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesSimulateDisconnectFromHub(...args) {
@@ -894,6 +1300,11 @@ export class SeamHttpEndpoints {
             return seam.disconnectFromHub(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesSimulatePaidSubscription(...args) {
@@ -901,6 +1312,9 @@ export class SeamHttpEndpoints {
             return seam.paidSubscription(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesSimulateRemove(...args) {
@@ -908,6 +1322,13 @@ export class SeamHttpEndpoints {
             return seam.remove(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesUnmanagedGet(...args) {
@@ -915,6 +1336,11 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesUnmanagedList(...args) {
@@ -922,6 +1348,11 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function devicesUnmanagedUpdate(...args) {
@@ -929,6 +1360,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function eventsGet(...args) {
@@ -936,6 +1370,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function eventsList(...args) {
@@ -943,6 +1380,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Deletes a specified [Instant Key](https://docs.seam.co/capability-guides/instant-keys).
+     */
     get '/instant_keys/delete'() {
         const { client, defaults } = this;
         return function instantKeysDelete(...args) {
@@ -950,6 +1390,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Gets an [instant key](https://docs.seam.co/capability-guides/instant-keys).
+     */
     get '/instant_keys/get'() {
         const { client, defaults } = this;
         return function instantKeysGet(...args) {
@@ -957,6 +1400,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [instant keys](https://docs.seam.co/capability-guides/instant-keys).
+     */
     get '/instant_keys/list'() {
         const { client, defaults } = this;
         return function instantKeysList(...args) {
@@ -964,6 +1410,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+     */
     get '/locks/configure_auto_lock'() {
         const { client, defaults } = this;
         return function locksConfigureAutoLock(...args) {
@@ -971,6 +1420,10 @@ export class SeamHttpEndpoints {
             return seam.configureAutoLock(...args);
         };
     }
+    /**
+     * Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+     * @deprecated Use `/devices/get` instead.
+     */
     get '/locks/get'() {
         const { client, defaults } = this;
         return function locksGet(...args) {
@@ -978,6 +1431,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks).
+     */
     get '/locks/list'() {
         const { client, defaults } = this;
         return function locksList(...args) {
@@ -985,6 +1441,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function locksLockDoor(...args) {
@@ -992,6 +1451,9 @@ export class SeamHttpEndpoints {
             return seam.lockDoor(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function locksUnlockDoor(...args) {
@@ -999,6 +1461,9 @@ export class SeamHttpEndpoints {
             return seam.unlockDoor(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function locksSimulateKeypadCodeEntry(...args) {
@@ -1006,6 +1471,9 @@ export class SeamHttpEndpoints {
             return seam.keypadCodeEntry(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function locksSimulateManualLockViaKeypad(...args) {
@@ -1013,6 +1481,9 @@ export class SeamHttpEndpoints {
             return seam.manualLockViaKeypad(...args);
         };
     }
+    /**
+     * Returns a list of all [noise sensors](https://docs.seam.co/capability-guides/noise-sensors).
+     */
     get '/noise_sensors/list'() {
         const { client, defaults } = this;
         return function noiseSensorsList(...args) {
@@ -1020,6 +1491,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function noiseSensorsNoiseThresholdsCreate(...args) {
@@ -1027,6 +1501,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function noiseSensorsNoiseThresholdsDelete(...args) {
@@ -1034,6 +1511,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function noiseSensorsNoiseThresholdsGet(...args) {
@@ -1041,6 +1521,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function noiseSensorsNoiseThresholdsList(...args) {
@@ -1048,6 +1531,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function noiseSensorsNoiseThresholdsUpdate(...args) {
@@ -1055,6 +1541,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function noiseSensorsSimulateTriggerNoiseThreshold(...args) {
@@ -1062,6 +1551,9 @@ export class SeamHttpEndpoints {
             return seam.triggerNoiseThreshold(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function phonesDeactivate(...args) {
@@ -1069,6 +1561,9 @@ export class SeamHttpEndpoints {
             return seam.deactivate(...args);
         };
     }
+    /**
+     * Returns a specified [phone](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity).
+     */
     get '/phones/get'() {
         const { client, defaults } = this;
         return function phonesGet(...args) {
@@ -1076,6 +1571,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function phonesList(...args) {
@@ -1083,6 +1581,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function phonesSimulateCreateSandboxPhone(...args) {
@@ -1090,6 +1591,9 @@ export class SeamHttpEndpoints {
             return seam.createSandboxPhone(...args);
         };
     }
+    /**
+     * Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
+     */
     get '/spaces/add_acs_entrances'() {
         const { client, defaults } = this;
         return function spacesAddAcsEntrances(...args) {
@@ -1097,6 +1601,9 @@ export class SeamHttpEndpoints {
             return seam.addAcsEntrances(...args);
         };
     }
+    /**
+     * Adds a [connected account](https://docs.seam.co/core-concepts/connected-accounts) to a specific space.
+     */
     get '/spaces/add_connected_account'() {
         const { client, defaults } = this;
         return function spacesAddConnectedAccount(...args) {
@@ -1104,6 +1611,9 @@ export class SeamHttpEndpoints {
             return seam.addConnectedAccount(...args);
         };
     }
+    /**
+     * Adds devices to a specific space.
+     */
     get '/spaces/add_devices'() {
         const { client, defaults } = this;
         return function spacesAddDevices(...args) {
@@ -1111,6 +1621,9 @@ export class SeamHttpEndpoints {
             return seam.addDevices(...args);
         };
     }
+    /**
+     * Creates a new space.
+     */
     get '/spaces/create'() {
         const { client, defaults } = this;
         return function spacesCreate(...args) {
@@ -1118,6 +1631,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * Deletes a space.
+     */
     get '/spaces/delete'() {
         const { client, defaults } = this;
         return function spacesDelete(...args) {
@@ -1125,6 +1641,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Gets a space.
+     */
     get '/spaces/get'() {
         const { client, defaults } = this;
         return function spacesGet(...args) {
@@ -1132,6 +1651,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Gets all related resources for one or more Spaces.
+     */
     get '/spaces/get_related'() {
         const { client, defaults } = this;
         return function spacesGetRelated(...args) {
@@ -1139,6 +1661,9 @@ export class SeamHttpEndpoints {
             return seam.getRelated(...args);
         };
     }
+    /**
+     * Returns a list of all spaces.
+     */
     get '/spaces/list'() {
         const { client, defaults } = this;
         return function spacesList(...args) {
@@ -1146,6 +1671,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Removes [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
+     */
     get '/spaces/remove_acs_entrances'() {
         const { client, defaults } = this;
         return function spacesRemoveAcsEntrances(...args) {
@@ -1153,6 +1681,9 @@ export class SeamHttpEndpoints {
             return seam.removeAcsEntrances(...args);
         };
     }
+    /**
+     * Removes a [connected account](https://docs.seam.co/core-concepts/connected-accounts) from a specific space.
+     */
     get '/spaces/remove_connected_account'() {
         const { client, defaults } = this;
         return function spacesRemoveConnectedAccount(...args) {
@@ -1160,6 +1691,9 @@ export class SeamHttpEndpoints {
             return seam.removeConnectedAccount(...args);
         };
     }
+    /**
+     * Removes devices from a specific space.
+     */
     get '/spaces/remove_devices'() {
         const { client, defaults } = this;
         return function spacesRemoveDevices(...args) {
@@ -1167,6 +1701,9 @@ export class SeamHttpEndpoints {
             return seam.removeDevices(...args);
         };
     }
+    /**
+     * Updates an existing space.
+     */
     get '/spaces/update'() {
         const { client, defaults } = this;
         return function spacesUpdate(...args) {
@@ -1174,6 +1711,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsActivateClimatePreset(...args) {
@@ -1181,6 +1721,9 @@ export class SeamHttpEndpoints {
             return seam.activateClimatePreset(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsCool(...args) {
@@ -1188,6 +1731,9 @@ export class SeamHttpEndpoints {
             return seam.cool(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsCreateClimatePreset(...args) {
@@ -1195,6 +1741,9 @@ export class SeamHttpEndpoints {
             return seam.createClimatePreset(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsDeleteClimatePreset(...args) {
@@ -1202,6 +1751,9 @@ export class SeamHttpEndpoints {
             return seam.deleteClimatePreset(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsHeat(...args) {
@@ -1209,6 +1761,9 @@ export class SeamHttpEndpoints {
             return seam.heat(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsHeatCool(...args) {
@@ -1216,6 +1771,9 @@ export class SeamHttpEndpoints {
             return seam.heatCool(...args);
         };
     }
+    /**
+     * Returns a list of all [thermostats](https://docs.seam.co/capability-guides/thermostats).
+     */
     get '/thermostats/list'() {
         const { client, defaults } = this;
         return function thermostatsList(...args) {
@@ -1223,6 +1781,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsOff(...args) {
@@ -1230,6 +1791,9 @@ export class SeamHttpEndpoints {
             return seam.off(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSetFallbackClimatePreset(...args) {
@@ -1237,6 +1801,9 @@ export class SeamHttpEndpoints {
             return seam.setFallbackClimatePreset(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSetFanMode(...args) {
@@ -1244,6 +1811,9 @@ export class SeamHttpEndpoints {
             return seam.setFanMode(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSetHvacMode(...args) {
@@ -1251,6 +1821,9 @@ export class SeamHttpEndpoints {
             return seam.setHvacMode(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSetTemperatureThreshold(...args) {
@@ -1258,6 +1831,9 @@ export class SeamHttpEndpoints {
             return seam.setTemperatureThreshold(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsUpdateClimatePreset(...args) {
@@ -1265,6 +1841,9 @@ export class SeamHttpEndpoints {
             return seam.updateClimatePreset(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsUpdateWeeklyProgram(...args) {
@@ -1272,6 +1851,9 @@ export class SeamHttpEndpoints {
             return seam.updateWeeklyProgram(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsDailyProgramsCreate(...args) {
@@ -1279,6 +1861,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * Deletes a thermostat daily program.
+     */
     get '/thermostats/daily_programs/delete'() {
         const { client, defaults } = this;
         return function thermostatsDailyProgramsDelete(...args) {
@@ -1286,6 +1871,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.
+     */
     get '/thermostats/daily_programs/update'() {
         const { client, defaults } = this;
         return function thermostatsDailyProgramsUpdate(...args) {
@@ -1293,6 +1881,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSchedulesCreate(...args) {
@@ -1300,6 +1891,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSchedulesDelete(...args) {
@@ -1307,6 +1901,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+     */
     get '/thermostats/schedules/get'() {
         const { client, defaults } = this;
         return function thermostatsSchedulesGet(...args) {
@@ -1314,6 +1911,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSchedulesList(...args) {
@@ -1321,6 +1921,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+     */
     get '/thermostats/schedules/update'() {
         const { client, defaults } = this;
         return function thermostatsSchedulesUpdate(...args) {
@@ -1328,6 +1931,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSimulateHvacModeAdjusted(...args) {
@@ -1335,6 +1941,9 @@ export class SeamHttpEndpoints {
             return seam.hvacModeAdjusted(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function thermostatsSimulateTemperatureReached(...args) {
@@ -1342,6 +1951,13 @@ export class SeamHttpEndpoints {
             return seam.temperatureReached(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesAddAcsUser(...args) {
@@ -1349,6 +1965,9 @@ export class SeamHttpEndpoints {
             return seam.addAcsUser(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesCreate(...args) {
@@ -1356,6 +1975,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesDelete(...args) {
@@ -1363,6 +1985,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesGenerateInstantKey(...args) {
@@ -1370,6 +1995,9 @@ export class SeamHttpEndpoints {
             return seam.generateInstantKey(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesGet(...args) {
@@ -1377,6 +2005,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesGrantAccessToDevice(...args) {
@@ -1384,6 +2015,9 @@ export class SeamHttpEndpoints {
             return seam.grantAccessToDevice(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesList(...args) {
@@ -1391,6 +2025,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesListAccessibleDevices(...args) {
@@ -1398,6 +2035,9 @@ export class SeamHttpEndpoints {
             return seam.listAccessibleDevices(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesListAccessibleEntrances(...args) {
@@ -1405,6 +2045,9 @@ export class SeamHttpEndpoints {
             return seam.listAccessibleEntrances(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesListAcsSystems(...args) {
@@ -1412,6 +2055,9 @@ export class SeamHttpEndpoints {
             return seam.listAcsSystems(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesListAcsUsers(...args) {
@@ -1419,6 +2065,9 @@ export class SeamHttpEndpoints {
             return seam.listAcsUsers(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesRemoveAcsUser(...args) {
@@ -1426,6 +2075,9 @@ export class SeamHttpEndpoints {
             return seam.removeAcsUser(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesRevokeAccessToDevice(...args) {
@@ -1433,6 +2085,9 @@ export class SeamHttpEndpoints {
             return seam.revokeAccessToDevice(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesUpdate(...args) {
@@ -1440,6 +2095,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesUnmanagedGet(...args) {
@@ -1447,6 +2105,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesUnmanagedList(...args) {
@@ -1454,6 +2115,11 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function userIdentitiesUnmanagedUpdate(...args) {
@@ -1461,6 +2127,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/create'() {
         const { client, defaults } = this;
         return function webhooksCreate(...args) {
@@ -1468,6 +2137,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/delete'() {
         const { client, defaults } = this;
         return function webhooksDelete(...args) {
@@ -1475,6 +2147,9 @@ export class SeamHttpEndpoints {
             return seam.delete(...args);
         };
     }
+    /**
+     * Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/get'() {
         const { client, defaults } = this;
         return function webhooksGet(...args) {
@@ -1482,6 +2157,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of all [webhooks](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/list'() {
         const { client, defaults } = this;
         return function webhooksList(...args) {
@@ -1489,6 +2167,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+     */
     get '/webhooks/update'() {
         const { client, defaults } = this;
         return function webhooksUpdate(...args) {
@@ -1496,6 +2177,9 @@ export class SeamHttpEndpoints {
             return seam.update(...args);
         };
     }
+    /**
+     * Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces).
+     */
     get '/workspaces/create'() {
         const { client, defaults } = this;
         return function workspacesCreate(...args) {
@@ -1503,6 +2187,9 @@ export class SeamHttpEndpoints {
             return seam.create(...args);
         };
     }
+    /**
+     * Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+     */
     get '/workspaces/get'() {
         const { client, defaults } = this;
         return function workspacesGet(...args) {
@@ -1510,6 +2197,9 @@ export class SeamHttpEndpoints {
             return seam.get(...args);
         };
     }
+    /**
+     * Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+     */
     get '/workspaces/list'() {
         const { client, defaults } = this;
         return function workspacesList(...args) {
@@ -1517,6 +2207,9 @@ export class SeamHttpEndpoints {
             return seam.list(...args);
         };
     }
+    /**
+     * 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'() {
         const { client, defaults } = this;
         return function workspacesResetSandbox(...args) {
@@ -1524,6 +2217,9 @@ export class SeamHttpEndpoints {
             return seam.resetSandbox(...args);
         };
     }
+    /**
+     * Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+     */
     get '/workspaces/update'() {
         const { client, defaults } = this;
         return function workspacesUpdate(...args) {