| Component | API Object | Description |
|---|---|---|
| System | acs_system | An ACS itself. You create users, access groups, and credentials in the context of an acs_system. |
| User | acs_user | A user to whom to grant access to specific physical spaces. |
| Entrance | acs_entrance | A secured door, gate, service, or other method of entry. |
| Access group | acs_access_group | A group that defines the entrances to which a set of users has access, as well as the access schedule for these entrances and users. |
| Credential | acs_credential | A means by which a user gains access at an entrance, such as access codes, key cards, and mobile passes. |
| Component | API Object | Description |
|---|---|---|
| System | acs_system | An access control system itself. You create users, access groups, and credentials in the context of an acs_system. |
| User | acs_user | A user to whom to grant access to specific physical spaces. |
| Entrance | acs_entrance | A secured door, gate, service, or other method of entry. |
| Access group | acs_access_group | A group that defines the entrances to which a set of users has access, as well as the access schedule for these entrances and users. |
| Credential | acs_credential | A means by which a user gains access at an entrance, such as access codes, key cards, and mobile passes. |
| Property | Type | Description |
|---|---|---|
acs_access_group_id | String (UUID) Required | ID of the access group |
acs_system_id | String (UUID) Required | ID of the access control system that contains the access group |
workspace_id | String (UUID) Required | ID of the workspace that contains the access group |
name | String Required | Name of the access group |
external_type | String Required | Brand-specific terminology for the access group type |
external_type_display_name | String Required | Display name that corresponds to the brand-specific terminology for the access group type |
created_at | String Required | Date and time at which the access group was created |
| Parameter | Type | Description |
|---|---|---|
acs_access_group_id | String (UUID) Required | ID of the desired access group |
acs_user_id | String (UUID) Required | ID of the desired user |
| Parameter | Type | Description |
|---|---|---|
acs_access_group_id | String (UUID) Required | ID of the desired access group |
| Property | Description |
|---|---|
acs_access_group_id | ID of the access group |
name | Name of the access group |
display_name | Display name for the access group |
external_type | Brand-specific terminology for the access group type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the access group type |
acs_system_id | ID of the access control system that contains the access group |
workspace_id | ID of the workspace that contains the access group |
created_at | Date and time at which the access group was created |
| Parameter | Type | Description |
|---|---|---|
acs_system_id | String (UUID) Optional | ID of the access control system for which you want to retrieve all access groups |
acs_user_id | String (UUID) Optional | ID of the user for which you want to retrieve all access groups |
| Property | Description |
|---|---|
acs_access_group_id | ID of the access group |
name | Name of the access group |
display_name | Display name for the access group |
external_type | Brand-specific terminology for the access group type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the access group type |
acs_system_id | ID of the access control system that contains the access group |
workspace_id | ID of the workspace that contains the access group |
created_at | Date and time at which the access group was created |
| Parameter | Type | Description |
|---|---|---|
acs_access_group_id | String (UUID) Required | ID of the access group for which you want to retrieve all users |
| Property | Description |
|---|---|
acs_user_id | ID of the ACS user |
display_name | Display name for the ACS user |
full_name | Full name of the ACS user |
email | Email address of the ACS user (for backward compatibility) |
email_address | Email address of the ACS user |
phone_number | Phone number of the ACS user in E.164 format (for example, +15555550100) |
acs_system_id | ID of the access control system that contains the ACS user |
workspace_id | ID of the workspace that contains the ACS user |
created_at | Date and time at which the ACS user was created |
is_suspended | Indicates whether the ACS user is currently suspended |
access_schedule | starts_at and ends_at dates/times for the ACS user's access |
user_identity_id | ID of the user identity associated with the ACS user |
user_identity_full_name | Full name of the user identity associated with the ACS user |
user_identity_email_address | Email address of the user identity associated with the ACS user |
user_identity_phone_number | Phone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100) |
| Parameter | Type | Description |
|---|---|---|
acs_access_group_id | String (UUID) Required | ID of the desired access group |
acs_user_id | String (UUID) Required | ID of the desired user |
| Property | Type | Description |
|---|---|---|
acs_credential_id | String (UUID) Required | ID of the credential |
acs_user_id | String (UUID) Optional | ID of the user to whom the credential belongs |
acs_system_id | String (UUID) Required | ID of the access control system that contains the credential |
parent_acs_credential_id | String (UUID) Optional | ID of the parent credential |
display_name | String Optional | Display name that corresponds to the credential type |
code | String Optional | Access (PIN) code for the credential |
access_method | Enum (string) Required | Access method for the credential. Supported values: code, card, mobile_key |
external_type | Enum (string) Optional | Brand-specific terminology for the credential type Supported values: pti_card, brivo_credential, hid_credential, visionline_card |
external_type_display_name | String Optional | Display name that corresponds to the brand-specific terminology for the credential type |
created_at | String Required | Date and time at which the credential was created |
workspace_id | String (UUID) Required | ID of the workspace that contains the credential |
starts_at | String (datetime) Optional | Date and time at which the credential validity starts, in ISO 8601 format |
ends_at | String (datetime) Optional | Date and time at which the credential validity ends, in ISO 8601 format Must be a time in the future and after starts_at. |
is_multi_phone_sync_credential | Boolean Optional | Indicates whether the credential is a multi-phone sync credential |
XXX_metadata | Object Optional | ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired user |
acs_credential_id | String (UUID) Required | ID of the desired credential |
| Property | Description |
|---|---|
acs_credential_id | ID of the credential |
acs_user_id | ID of the user to whom the credential belongs |
display_name | Display name that corresponds to the credential type |
code | Access (PIN) code for the credential |
acs_system_id | ID of the access control system that contains the credential |
access_method | Access method for the credential. Supported values: code, card, mobile_key |
external_type | Brand-specific terminology for the credential type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the credential type |
workspace_id | ID of the workspace that contains the credential |
created_at | Date and time at which the credential was created |
is_multi_phone_sync_credential | Indicates whether the credential is a multi-phone sync credential |
starts_at | Date and time at which the credential validity starts, in ISO 8601 format |
ends_at | Date and time at which the credential validity ends, in ISO 8601 format |
XXX_metadata | ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the user to whom the new credential belongs |
access_method | Enum (string) Required | Access method for the new credential. Supported values: code, card, mobile_key |
code | String Optional | Access (PIN) code for the new credential There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide. |
is_multi_phone_sync_credential | Boolean Optional | Indicates whether the new credential is a multi-phone sync credential |
allowed_acs_entrance_ids | Array of strings (UUIDs) Optional | Set of IDs of the entrances for which the new credential grants access |
credential_manager_acs_system_id | Enum (string) Optional | ACS system ID of the credential manager for the new user |
XXX_metadata | Object Optional | ACS manufacturer-specific metadata for the new credential, where XXX is the manufacturer |
starts_at | Datetime Optional | Date and time at which the validity of the new credential starts, in ISO 8601 format. |
ends_at | Datetime Optional | Date and time at which the validity of the new credential ends, in ISO 8601 format. Must be a time in the future and after starts_at. |
| Property | Description |
|---|---|
acs_credential_id | ID of the credential |
acs_user_id | ID of the user to whom the credential belongs |
display_name | Display name that corresponds to the credential type |
code | Access (PIN) code for the credential |
acs_system_id | ID of the access control system that contains the credential |
access_method | Access method for the credential. Supported values: code, card, mobile_key |
external_type | Brand-specific terminology for the credential type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the credential type |
workspace_id | ID of the workspace that contains the credential |
created_at | Date and time at which the credential was created |
is_multi_phone_sync_credential | Indicates whether the credential is a multi-phone sync credential |
starts_at | Date and time at which the credential validity starts, in ISO 8601 format |
ends_at | Date and time at which the credential validity ends, in ISO 8601 format |
XXX_metadata | ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer |
| Parameter | Type | Description |
|---|---|---|
acs_credential_id | String (UUID) Required | ID of the desired credential |
| Parameter | Type | Description |
|---|---|---|
acs_credential_id | String (UUID) Required | ID of the desired credential |
| Property | Description |
|---|---|
acs_credential_id | ID of the credential |
acs_user_id | ID of the user to whom the credential belongs |
display_name | Display name that corresponds to the credential type |
code | Access (PIN) code for the credential |
acs_system_id | ID of the access control system that contains the credential |
access_method | Access method for the credential. Supported values: code, card, mobile_key |
external_type | Brand-specific terminology for the credential type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the credential type |
workspace_id | ID of the workspace that contains the credential |
created_at | Date and time at which the credential was created |
is_multi_phone_sync_credential | Indicates whether the credential is a multi-phone sync credential |
starts_at | Date and time at which the credential validity starts, in ISO 8601 format |
ends_at | Date and time at which the credential validity ends, in ISO 8601 format |
XXX_metadata | ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Optional | ID of the user for which you want to retrieve all credentials |
acs_system_id | String (UUID) Optional | ID of the access control system for which you want to retrieve all credentials |
user_identity_id | String (UUID) Optional | ID of the user identity for which you want to retrieve all credentials |
is_multi_phone_sync_credential | Boolean Optional | Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials |
| Property | Description |
|---|---|
acs_credential_id | ID of the credential |
acs_user_id | ID of the user to whom the credential belongs |
display_name | Display name that corresponds to the credential type |
code | Access (PIN) code for the credential |
acs_system_id | ID of the access control system that contains the credential |
access_method | Access method for the credential. Supported values: code, card, mobile_key |
external_type | Brand-specific terminology for the credential type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the credential type |
workspace_id | ID of the workspace that contains the credential |
created_at | Date and time at which the credential was created |
is_multi_phone_sync_credential | Indicates whether the credential is a multi-phone sync credential |
starts_at | Date and time at which the credential validity starts, in ISO 8601 format |
ends_at | Date and time at which the credential validity ends, in ISO 8601 format |
XXX_metadata | ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer |
[
- AcsCredential(
- acs_credential_id='99999999-9999-9999-9999-999999999999',
- acs_user_id='33333333-3333-3333-3333-333333333333',
- display_name='Multi Phone Sync Credential',
- code=null,
- acs_system_id='11111111-1111-1111-1111-111111111111',
- access_method='mobile_key',
- workspace_id='00000000-0000-0000-0000-000000000000',
- created_at='2024-04-12T03:56:22.396Z',
- is_multi_phone_sync_credential=True,
- # manufacturer-specific metadata
- ),
- ...
-]
-| Parameter | Type | Description |
|---|---|---|
acs_credential_id | String (UUID) Required | ID of the credential for which you want to retrieve all entrances to which this credential grants access |
| Property | Description |
|---|---|
acs_entrance_id | ID of the entrance |
acs_system_id | ID of the access control system that contains the entrance |
workspace_id | ID of the workspace that contains the user |
display_name | Display name for the entrance |
XXX_metadata | ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer |
created_at | Date and time at which the entrance was created |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired user |
acs_credential_id | String (UUID) Required | ID of the desired credential |
| Property | Description |
|---|---|
acs_credential_id | ID of the credential |
acs_user_id | ID of the user to whom the credential belongs |
display_name | Display name that corresponds to the credential type |
code | Access (PIN) code for the credential |
acs_system_id | ID of the access control system that contains the credential |
access_method | Access method for the credential. Supported values: code, card, mobile_key |
external_type | Brand-specific terminology for the credential type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the credential type |
workspace_id | ID of the workspace that contains the credential |
created_at | Date and time at which the credential was created |
is_multi_phone_sync_credential | Indicates whether the credential is a multi-phone sync credential |
starts_at | Date and time at which the credential validity starts, in ISO 8601 format |
ends_at | Date and time at which the credential validity ends, in ISO 8601 format |
XXX_metadata | ACS manufacturer-specific metadata for the credential, where XXX is the manufacturer |
| Parameter | Type | Description |
|---|---|---|
acs_credential_id | String (UUID) Required | ID of the desired credential. |
code | String Optional | Replacement access (PIN) code for the credential. |
ends_at | Datetime Optional | Replacement date and time at which the validity of the credential ends, in ISO 8601 format. Must be a time in the future and after the starts_at value that you set when creating the credential. |
| Property | Type | Description |
|---|---|---|
acs_entrance_id | String (UUID) Required | ID of the entrance |
display_name | String Required | Display name for the entrance |
acs_system_id | String (UUID) Required | ID of the access control system that contains the entrance |
created_at | String Required | Date and time at which the entrance was created |
workspace_id | String (UUID) Required | ID of the workspace that contains the entrance |
XXX_metadata | Object Optional | ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer |
| Parameter | Type | Description |
|---|---|---|
acs_entrance_id | String (UUID) Required | ID of the desired entrance |
| Property | Description |
|---|---|
acs_entrance_id | ID of the entrance |
acs_system_id | ID of the access control system that contains the entrance |
workspace_id | ID of the workspace that contains the user |
display_name | Display name for the entrance |
XXX_metadata | ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer |
created_at | Date and time at which the entrance was created |
| Parameter | Type | Description |
|---|---|---|
acs_system_id | String (UUID) Optional | ID of the access control system for which you want to retrieve all entrances |
| Property | Description |
|---|---|
acs_entrance_id | ID of the entrance |
acs_system_id | ID of the access control system that contains the entrance |
workspace_id | ID of the workspace that contains the user |
display_name | Display name for the entrance |
XXX_metadata | ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer |
created_at | Date and time at which the entrance was created |
| Parameter | Type | Description |
|---|---|---|
acs_entrance_id | String (UUID) Required | ID of the entrance for which you want to retrieve all credentials with access |
| Property | Description |
|---|---|
acs_credential_id | ID of the credential |
acs_user_id | ID of the user to whom the credential belongs |
parent_acs_credential_id | ID of the parent ACS credential |
display_name | Display name that corresponds to the credential type |
code | Access (PIN) code for the credential |
acs_system_id | ID of the access control system that contains the credential |
access_method | Access method for the credential. Supported values: code, card, mobile_key |
external_type | Brand-specific terminology for the credential type Supported values: pti_card, brivo_credential, hid_credential, visionline_card |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the credential type |
workspace_id | ID of the workspace that contains the credential |
created_at | Date and time at which the credential was created |
starts_at | Date and time at which the credential validity starts, in ISO 8601 format |
ends_at | Date and time at which the credential validity ends, in ISO 8601 format |
is_multi_phone_sync_credential | Indicates whether the credential is a multi-phone sync credential |
XXX_metadata | ACS manufacturer-specific metadata for the entrance, where XXX is the manufacturer |
| Property | Type | Description |
|---|---|---|
acs_system_id | String (UUID) Required | ID of the access control system |
external_type | Enum (string) Required | Brand-specific terminology for the access control system type |
external_type_display_name | String Optional | Display name that corresponds to the brand-specific terminology for the access control system type |
name | String Required | Name of the access control system |
created_at | String Required | Date and time at which the access control system was created |
workspace_id | String (UUID) Required | ID of the workspace that contains the access control system |
connected_account_ids | Array of strings (UUIDs) Required | Array of connected account IDs associated with the access control system |
image_url | String Required | URL for the image that represents the access control system |
image_alt_text | String Required | Alternative text for the access control system image |
| Parameter | Type | Description |
|---|---|---|
acs_system_id | String (UUID) Required | ID of the desired access control system |
| Property | Description |
|---|---|
acs_system_id | ID of the access control system |
name | Name of the access control system |
workspace_id | ID of the workspace that contains the access control system |
created_at | Date and time at which the access control system was created |
external_type | Brand-specific terminology for the access control system type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the access control system type |
connected_account_ids | Array of connected account IDs associated with the access control system |
image_url | URL for the image that represents the access control system |
image_alt_text | Alternative text for the access control system image |
| Parameter | Type | Description |
|---|---|---|
connected_account_id | String (UUID) Optional | ID of the connected account |
| Property | Description |
|---|---|
acs_system_id | ID of the access control system |
name | Name of the access control system |
workspace_id | ID of the workspace that contains the access control system |
created_at | Date and time at which the access control system was created |
external_type | Brand-specific terminology for the access control system type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the access control system type |
connected_account_ids | Array of connected account IDs associated with the access control system |
image_url | URL for the image that represents the access control system |
image_alt_text | Alternative text for the access control system image |
| Parameter | Type | Description |
|---|---|---|
acs_system_id | String (UUID) Required | ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems |
| Property | Description |
|---|---|
acs_system_id | ID of the credential manager |
name | Name of the credential manager |
workspace_id | ID of the workspace that contains the credential manager |
created_at | Date and time at which the credential manager was created |
external_type | Brand-specific terminology for the credential manager type |
external_type_display_name | Display name that corresponds to the brand-specific terminology for the credential manager type |
connected_account_ids | Array of connected account IDs associated with the credential manager |
image_url | URL for the image that represents the credential manager |
image_alt_text | Alternative text for the credential manager image |
| Property | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the user |
acs_system_id | String (UUID) Required | ID of the access control system that contains the user |
workspace_id | String (UUID) Required | ID of the workspace that contains the user |
created_at | String Required | Date and time at which the user was created |
display_name | String Required | Display name for the user |
external_type | String Optional | Brand-specific terminology for the user type |
external_type_display_name | String Optional | Display name that corresponds to the brand-specific terminology for the user type |
is_suspended | Boolean Required | Indicates whether the user is currently suspended |
access_schedule | Object Optional | starts_at and ends_at dates/times for the user's access |
user_identity_id | String (UUID) Optional | ID of the user identity associated with the user |
user_identity_email_address | String Optional | Email address of the user identity associated with the user |
user_identity_phone_number | String Optional | Phone number of the user identity associated with the user in E.164 format (for example, +15555550100) |
full_name | String Optional | Full name of the user |
email_address | String Optional | Email address of the user |
phone_number | String Optional | Phone number of the user in E.164 format (for example, +15555550100) |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired ACS user |
acs_access_group_id | String (UUID) Required | ID of the desired access group |
| Parameter | Type | Description |
|---|---|---|
acs_system_id | String (UUID) Required | ID of the access control system to which to add the new ACS user. |
acs_access_group_ids | Array of strings (UUIDs) Optional | Array of access group IDs to indicate the access groups to which to add the new ACS user. |
user_identity_id | String (UUID) Optional | ID of the user identity with which to associate the new ACS user. |
full_name | String Optional | Full name of the new ACS user. |
email_address | String Optional | Email address of the new ACS user. |
phone_number | String Optional | Phone number of the new ACS user in E.164 format (for example, +15555550100). |
access_schedule | Object Optional | starts_at and ends_at timestamps for the new ACS user's access.If you specify an access_schedule, you must include both starts_at and ends_at. ends_at must be a time in the future and after starts_at.Only applicable to Salto KS access control systems. |
| Property | Description |
|---|---|
acs_user_id | ID of the ACS user |
display_name | Display name for the ACS user |
full_name | Full name of the ACS user |
email | Email address of the ACS user (for backward compatibility) |
email_address | Email address of the ACS user |
phone_number | Phone number of the ACS user in E.164 format (for example, +15555550100) |
acs_system_id | ID of the access control system that contains the ACS user |
workspace_id | ID of the workspace that contains the ACS user |
created_at | Date and time at which the ACS user was created |
is_suspended | Indicates whether the ACS user is currently suspended |
access_schedule | starts_at and ends_at timestamps for the ACS user's access |
user_identity_id | ID of the user identity associated with the ACS user |
user_identity_email_address | Email address of the user identity associated with the ACS user |
user_identity_phone_number | Phone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100) |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired ACS user |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired ACS user |
| Property | Description |
|---|---|
acs_user_id | ID of the ACS user |
display_name | Display name for the ACS user |
full_name | Full name of the ACS user |
email | Email address of the ACS user (for backward compatibility) |
email_address | Email address of the ACS user |
phone_number | Phone number of the ACS user in E.164 format (for example, +15555550100) |
acs_system_id | ID of the access control system that contains the ACS user |
workspace_id | ID of the workspace that contains the ACS user |
created_at | Date and time at which the ACS user was created |
is_suspended | Indicates whether the ACS user is currently suspended |
access_schedule | starts_at and ends_at dates/times for the ACS user's access |
user_identity_id | ID of the user identity associated with the ACS user |
user_identity_email_address | Email address of the user identity associated with the ACS user |
user_identity_phone_number | Phone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100) |
| Parameter | Type | Description |
|---|---|---|
user_identity_id | String (UUID) Optional | ID of the user identity for which you want to retrieve all ACS users |
user_identity_phone_number | String Optional | Phone number of the user identity for which you want to retrieve all ACS users, in E.164 format (for example, +15555550100) |
user_identity_email_address | String Optional | Email address of the user identity for which you want to retrieve all ACS users |
acs_system_id | String (UUID) Optional | ID of the access control system for which you want to retrieve all ACS users |
| Property | Description |
|---|---|
acs_user_id | ID of the ACS user |
display_name | Display name for the ACS user |
full_name | Full name of the ACS user |
email | Email address of the ACS user (for backward compatibility) |
email_address | Email address of the ACS user |
phone_number | Phone number of the ACS user in E.164 format (for example, +15555550100) |
acs_system_id | ID of the access control system that contains the ACS user |
workspace_id | ID of the workspace that contains the ACS user |
created_at | Date and time at which the ACS user was created |
is_suspended | Indicates whether the ACS user is currently suspended |
access_schedule | starts_at and ends_at dates/times for the ACS user's access |
user_identity_id | ID of the user identity associated with the ACS user |
user_identity_full_name | Full name of the user identity associated with the ACS user |
user_identity_email_address | Email address of the user identity associated with the ACS user |
user_identity_phone_number | Phone number of the user identity associated with the ACS user in E.164 format (for example, +15555550100) |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired ACS user |
acs_access_group_id | String (UUID) Required | ID of the desired access group |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired ACS user |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired ACS user |
| Parameter | Type | Description |
|---|---|---|
acs_user_id | String (UUID) Required | ID of the desired ACS user. |
full_name | String Optional | Replacement full name for the ACS user. |
email_address | String Optional | Replacement email address for the ACS user. |
phone_number | String Optional | Replacement phone number for the ACS user in E.164 format (for example, +15555550100). |
access_schedule | Object Optional | Replacement starts_at and ends_at dates/times for the ACS user's access.If you specify an access_schedule, you must include both starts_at and ends_at. ends_at must be a time in the future and after starts_at.Only applicable to Salto KS access control systems. |
| Parameter | Type | Description |
|---|---|---|
user_identifier_key | String Optional | Your own internal user ID for the user to associate with the client session (or that is already associated with the existing client session) |
connect_webview_ids | Array of strings Optional | Array of IDs of the Connect Webviews to associate with the client session (or that are already associated with the existing client session) |
connected_account_ids | Array of strings Optional | Array of IDs of the connected accounts to associate with the client session (or that are already associated with the existing client session) |
user_identity_ids | Array of strings Optional | Array of IDs of the user identities to associate with the client session (or that are already associated with the existing client session) |
expires_at | String Optional | Date and time at which the client session should expire (or at which the existing client session expires) |
| Parameter | Type | Description |
|---|---|---|
user_identifier_key | String Optional | Your own internal user ID for the user to associate with the client session (or that is already associated with the existing client session) |
connect_webview_ids | Array of strings Optional | Array of IDs of the Connect Webviews to associate with the client session (or that are already associated with the existing client session) |
connected_account_ids | Array of strings Optional | Array of IDs of the connected accounts to associate with the client session (or that are already associated with the existing client session) |
user_identity_ids | Array of strings Optional | Array of IDs of the user identities to associate with the client session (or that are already associated with the existing client session) |
expires_at | String Optional | Date and time at which the client session should expire (or at which the existing client session expires) |
| Parameter | Type | Description |
|---|---|---|
client_session_id | String Optional | ID of the desired client session |
user_identifier_key | String Optional | Your own internal user ID for the user to associate with the client session |
connected_account_ids | Array of strings Optional | Array of IDs of the connected accounts to associate with the client session |
connect_webview_ids | Array of strings Optional | Array of IDs of the Connect Webviews to associate with the client session |
user_identity_ids | Array of strings Optional | Array of IDs of the user identities to associate with the client session |
| Parameter | Type | Description |
|---|---|---|
client_session_id | String Optional | ID of the desired client session |
user_identifier_key | String Optional | Your own internal user ID for the user to associate with the client session |
connected_account_ids | Array of strings Optional | Array of IDs of the connected accounts to associate with the client session |
connect_webview_ids | Array of strings Optional | Array of IDs of the Connect Webviews to associate with the client session |
user_identity_ids | Array of strings Optional | Array of IDs of the user identities to associate with the client session |
JSON object
Optional
|A set of up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters
For more information, see Attaching Custom Data to the Connect Webview.
String
Optional
| If set, the Connect Webview redirects to this URL when the user successfully pairs a device or, if the `custom_redirect_failure_url` is not set, when an unexpected error occurs | | **`custom_redirect_failure_url`** |String
Optional
| If set, the Connect Webview redirects to this URL when an unexpected error occurs | | **`status`** | String | `pending` or `authorized` | @@ -57,6 +57,7 @@ To list all provider keys, use the [List Device Providers](../devices/list_devic | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | | [2N](../../device-guides/2n-intercom-systems.md) | `my_2n` | | [4SUITES](../../device-and-system-integration-guides/4suites-locks/) | `four_suites` | +| [Akiles](../../device-and-system-integration-guides/akiles-locks/) | `akiles` | | [Akuvox](https://akuvox.com/) | `akuvox` | | [ASSA ABLOY Credential Service](../../device-guides/assa-abloy-credential-services-credential-manager-in-development.md) | `assa_abloy_credential_service` | | [ASSA ABLOY Visionline Access Control System](../../device-guides/assa-abloy-visionline-access-control-system-in-development/) | `visionline` | @@ -79,7 +80,8 @@ To list all provider keys, use the [List Device Providers](../devices/list_devic | [NoiseAware](../../device-guides/noiseaware-sensors.md) | `noiseaware` | | [Nuki](../../device-guides/nuki-locks.md) | `nuki` | | [PTI Storlogix Cloud](../../device-guides/pti-storlogix-cloud.md) | `pti` | -| [Salto](../../device-guides/salto-locks.md) | `salto` | +| [Salto KS ACS](../../device-and-system-integration-guides/salto-ks-access-control-system/) | `salto_ks` | +| [Salto KS Locks](../../device-guides/salto-locks.md) | `salto` | | [Schlage](https://www.schlage.com/en/home/products/products-smart-locks.html) | `schlage` | | [SmartThings](https://www.smartthings.com/) | `smartthings` | | [Tedee](../../device-and-system-integration-guides/tedee-locks/) | `tedee` | diff --git a/docs/api-clients/connect_webviews/get.md b/docs/api-clients/connect_webviews/get.md index 1ca73fd0..ec6c84db 100644 --- a/docs/api-clients/connect_webviews/get.md +++ b/docs/api-clients/connect_webviews/get.md @@ -55,7 +55,7 @@ await seam.connectWebviews.get( {% tab title="Ruby" %} ```ruby -seam.connect_webviews.get("123e4567-e89b-12d3-a456-426614174000") +seam.connect_webviews.get(connect_webview_id: "123e4567-e89b-12d3-a456-426614174000") #device_idRequired
device_typeRequired
display_nameRequired
capabilities_supportedRequired
See
capabilities_supported Values.Important: Superseded by capability flags.
propertiesObject
Required
See
device.properties Properties.locationOptional
See
location Properties.connected_account_idRequired
workspace_idRequired
errorsRequired
Array of errors associated with the device.
Each error object within the array contains two fields: error_code and message.
error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue.
message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
See Device Error Types.
warningsRequired
Array of warnings associated with the device.
Each warning object within the array contains two fields: warning_code and message.
warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue.
message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
See Device Warning Types.
created_atRequired
is_managedRequired
custom_metadataOptional
Set of custom_metadata for the device.
Specify up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters.
can_remotely_unlockOptional
can_remotely_lockOptional
can_program_online_access_codesOptional
can_program_offline_access_codesOptional
can_hvac_heatOptional
can_hvac_coolOptional
can_hvac_heat_coolOptional
can_turn_off_hvacOptional
| Property | Type | Description |
|---|---|---|
device_id | String (UUID) Required | Unique identifier for the device. |
device_type | String Required | Type of the device. |
display_name | String Required | Display name for the device. |
capabilities_supported | Array of strings Required | Collection of capabilities that the device supports when connected to Seam. See capabilities_supported Values.Important: Superseded by capability flags. |
properties | Object Required | Properties of the device. See device.properties Properties. |
location | Object Optional | Read-only location information for the device. See location Properties. |
connected_account_id | String (UUID) Required | ID of the connected account associated with the device. |
workspace_id | String (UUID) Required | ID of the workspace that contains the device. |
errors | Array of objects Required | Array of errors associated with the device. Each error object within the array contains two fields:
|
warnings | Array of objects Required | Array of warnings associated with the device. Each warning object within the array contains two fields:
|
created_at | String (datetime) Required | Date and time at which the device object was created. |
is_managed | Boolean Required | Indicates whether Seam manages the device. |
custom_metadata | JSON object Optional | Set of Specify up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters. |
can_remotely_unlock | Boolean Optional | Indicates whether the device can perform a remote unlock operation. See Capability Flags. |
can_remotely_lock | Boolean Optional | Indicates whether the device can perform a remote lock operation. See Capability Flags. |
can_program_online_access_codes | Boolean Optional | Indicates whether the device can program online access codes. See Capability Flags. |
can_program_offline_access_codes | Boolean Optional | Indicates whether the device can program offline access codes. See Capability Flags. |
can_hvac_heat | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode. See Capability Flags. |
can_hvac_cool | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode. See Capability Flags. |
can_hvac_heat_cool | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode. See Capability Flags. |
can_turn_off_hvac | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode. See Capability Flags. |
can_simulate_removal | Boolean Optional | Indicates whether you can simulate removal of the sandbox device. See Testing Your App Against Device Disconnection and Removal. |
can_simulate_connection | Boolean Optional | Indicates whether you can simulate connection (or reconnection) of the sandbox device. See Testing Your App Against Device Disconnection and Removal. |
can_simulate_disconnection | Boolean Optional | Indicates whether you can simulate disconnection of the sandbox device. See Testing Your App Against Device Disconnection and Removal. |
| Capability | Description |
|---|---|
access_code | If present, you can set access codes on the device. |
battery | If present, you can look at the device.properties.battery.level of the device. |
health | If present, you can introspect some parameters related to the health of the device. |
lock | If present, you can lock and unlock the device. |
noise_sensor | If present, the device can issue noise alerts when noise thresholds are exceeded. |
thermostat | If present, the device can regulate the temperature of a system so that the temperature of the system is maintained near a desired set point temperature. |
| Capability | Description |
|---|---|
access_code | If present, the device can manage and utilize digital PIN codes for secure access. |
lock | If present, the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points. |
noise_detection | If present, the device supports monitoring and responding to ambient noise levels. |
thermostat | If present, the device can regulate and adjust indoor temperatures. |
battery | If present, the device can manage battery life and health. |
phone | If present, the device is a mobile phone. |
| Property | Type | Description |
|---|---|---|
online | Boolean Required | Indicates whether the device is online. |
accessory_keypad | Object Optional | Accessory keypad state. See accessory_keypad Properties. |
appearance | Object Required | Appearance-related properties, including the read-only name of the device, as seen from the provider API and application. |
model | Object Required | Device model properties. See model Properties. |
has_direct_power | Boolean Optional | Indicates whether the device has direct power. |
battery_level | Number Required | Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. If the device is offline, Seam does not return this property. Deprecated. Use device.properties.battery.level instead. |
battery | Object Optional | Device battery properties. If the device is offline, Seam does not return this property. |
manufacturer | String Optional | Manufacturer of the device. See Device Manufacturers. |
image_url | String (URL) Optional | Image URL for the device or placeholder image URL if a device-specific image is unavailable. |
image_alt_text | String Optional | Alternative text for the device image. |
serial_number | String Optional | Serial number of the device. |
online_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use online access codes for the device. Superseded by the device.properties.can_program_online_access_codes capability flag. |
offline_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use offline access codes for the device. Superseded by the device.properties.can_program_offline_access_codes capability flag. |
locked | Boolean Optional | Indicates whether the device is locked. Applicable to locks. |
keypad_battery | Object Optional | Keypad battery properties. Applicable to locks. |
door_open | Boolean Optional | Indicates whether the door is open. Applicable to locks. |
code_constraints | Array of objects Optional | Constraints on access codes that can be set on the device. Applicable to devices that support access codes. |
supported_code_lengths | Array of numbers Optional | Supported code lengths for the device. For example, |
max_active_codes_supported | Number Optional | Maximum number of codes that can exist on the device at one time. Applicable to devices that support access codes. |
supports_backup_access_code_pool | Boolean Optional | Indicates whether the device supports backup access code pools. Applicable to devices that support access codes. |
temperature_fahrenheit | Number Required | Temperature, measured in Fahrenheit. Applicable to thermostats. |
temperature_celsius | Number Required | Temperature, measured in Celsius. Applicable to thermostats. |
relative_humidity | Number Required | Relative humidity, the amount of moisture in the air compared to the maximum amount of moisture the air can hold at a given temperature. It is a percentage expressed as a number between 0 and 1, inclusive.Applicable to thermostats. |
available_hvac_mode_settings | Array of enums (strings) | List of the available HVAC modes for the thermostat.
Applicable to thermostats. |
is_heating | Boolean Required | Indicates whether the heating system is currently heating. Applicable to thermostats. |
is_cooling | Boolean Required | Indicates whether the cooling system is currently cooling. Applicable to thermostats. |
is_fan_running | Boolean Required | Indicates whether the fan is currently running. Applicable to thermostats. |
fan_mode_setting | Enum (string) Required | Fan mode of the thermostat.
Applicable to thermostats. |
is_temporary_manual_override_active | Boolean Required | Indicates whether the current thermostat settings differ from the configured current_climate_setting.Applicable to thermostats. |
current_climate_setting | Object Required | Current climate setting for the thermostat. Can only be overridden manually if device.properties.current_climate_setting.manual_override_allowed is true.Applicable to thermostats. See Thermostat climate_setting Properties. |
min_cooling_set_point_celsius | Number Required | Minimum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_cooling_set_point_fahrenheit | Number Required | Minimum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_cooling_set_point_celsius | Number Required | Maximum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_cooling_set_point_fahrenheit | Number Required | Maximum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_set_point_celsius | Number Required | Minimum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_heating_set_point_fahrenheit | Number Required | Minimum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_heating_set_point_celsius | Number Required | Maximum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_heating_set_point_fahrenheit | Number Required | Maximum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_cooling_delta_celsius | Number Required | Minimum temperature difference—that is, delta—in degrees Celsius between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
min_heating_cooling_delta_fahrenheit | Number Required | Minimum temperature difference—that is, delta—in degrees Fahrenheit between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
XXX_metadata | Object | Manufacturer-specific metadata for the device, where XXX is the manufacturer. |
| Property | Type | Description |
|---|---|---|
online | Boolean Required | Indicates whether the device is online. |
accessory_keypad | Object Optional | Accessory keypad state. See accessory_keypad Properties. |
appearance | Object Required | Appearance-related properties, including the read-only name of the device, as seen from the provider API and application. |
model | Object Required | Device model properties. See model Properties. |
has_direct_power | Boolean Optional | Indicates whether the device has direct power. |
battery_level | Number Required | Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.If the device is offline, Seam does not return this property. Deprecated. Use device.properties.battery.level instead. |
battery | Object Optional | Device battery properties. If the device is offline, Seam does not return this property. |
manufacturer | String Optional | Manufacturer of the device. See Device Manufacturers. |
image_url | String (URL) Optional | Image URL for the device or placeholder image URL if a device-specific image is unavailable. |
image_alt_text | String Optional | Alternative text for the device image. |
serial_number | String Optional | Serial number of the device. |
online_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use online access codes for the device. Superseded by the device.properties.can_program_online_access_codes capability flag. |
offline_access_codes_enabled | Boolean Optional | Indicates whether it is currently possible to use offline access codes for the device. Superseded by the device.properties.can_program_offline_access_codes capability flag. |
noise_level_decibels | Number Optional | Current noise level in decibels, if the device supports noise detection. |
currently_triggering_noise_threshold_ids | Array of strings Optional | Array of noise threshold IDs that are currently triggering. |
code_constraints | Array of objects Optional | Constraints on access codes that can be set on the device. Applicable to devices that support access codes. |
supported_code_lengths | Array of numbers Optional | Supported code lengths for the device. For example, |
max_active_codes_supported | Number Optional | Maximum number of codes that can exist on the device at one time. Applicable to devices that support access codes. |
supports_backup_access_code_pool | Boolean Optional | Indicates whether the device supports backup access code pools. Applicable to devices that support access codes. |
has_native_entry_events | Boolean Optional | Indicates whether Seam receives lock and unlock events from the device provider. |
locked | Boolean Optional | Indicates whether the device is locked. Applicable to locks. |
keypad_battery | Object Optional | Keypad battery properties. Applicable to locks. |
door_open | Boolean Optional | Indicates whether the door is open. Applicable to locks. |
temperature_fahrenheit | Number Required | Temperature, measured in Fahrenheit. Applicable to thermostats. |
temperature_celsius | Number Required | Temperature, measured in Celsius. Applicable to thermostats. |
relative_humidity | Number Required | Relative humidity, the amount of moisture in the air compared to the maximum amount of moisture the air can hold at a given temperature. It is a percentage expressed as a number between 0 and 1, inclusive.Applicable to thermostats. |
available_hvac_mode_settings | Array of enums (strings) | List of the available HVAC mode settings for the thermostat.
Applicable to thermostats. |
available_fan_mode_settings | Array of enums (strings) | List of the available fan mode settings for the thermostat.
Applicable to thermostats. |
is_heating | Boolean Required | Indicates whether the heating system is currently heating. Applicable to thermostats. |
is_cooling | Boolean Required | Indicates whether the cooling system is currently cooling. Applicable to thermostats. |
is_fan_running | Boolean Required | Indicates whether the fan is currently running. Applicable to thermostats. |
fan_mode_setting | Enum (string) Required | Fan mode setting of the thermostat. Deprecated. Use Applicable to thermostats. |
is_temporary_manual_override_active | Boolean Required | Indicates whether the current thermostat settings differ from the configured current_climate_setting.Applicable to thermostats. |
current_climate_setting | Object Required | Current climate setting for the thermostat. Applicable to thermostats. See current_climate_setting Properties. |
default_climate_setting | Object Required | Deprecated. Use fallback_climate_preset_key to specify a fallback climate preset instead. |
available_climate_presets | Array of objects Required | Set of climate presets that are available for the thermostat device. See available_climate_presets Properties. |
fallback_climate_preset_key | String Optional | Key that identifies the current fallback climate preset. |
active_thermostat_schedule | Object Optional | Currently active thermostat schedule. See active_thermostat_schedule Properties. |
min_cooling_set_point_celsius | Number Required | Minimum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_cooling_set_point_fahrenheit | Number Required | Minimum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_cooling_set_point_celsius | Number Required | Maximum cooling set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_cooling_set_point_fahrenheit | Number Required | Maximum cooling set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_set_point_celsius | Number Required | Minimum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
min_heating_set_point_fahrenheit | Number Required | Minimum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
max_heating_set_point_celsius | Number Required | Maximum heating set point that this thermostat supports, measured in Celsius. Applicable to thermostats. |
max_heating_set_point_fahrenheit | Number Required | Maximum heating set point that this thermostat supports, measured in Fahrenheit. Applicable to thermostats. |
min_heating_cooling_delta_celsius | Number Required | Minimum temperature difference—that is, delta—in degrees Celsius between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
min_heating_cooling_delta_fahrenheit | Number Required | Minimum temperature difference—that is, delta—in degrees Fahrenheit between the cooling and heating set points when in heat-cool (auto) mode. Applicable to thermostats. |
temperature_threshold | Object Optional | Acceptable temperature bounds consisting of a temperature range or single upper or lower temperature. Seam emits a thermostat.temperature_threshold_exceeded event if the thermostat reports a temperature outside the specified threshold.See temperature_threshold Properties. |
XXX_metadata | Object | Manufacturer-specific metadata for the device, where XXX is the manufacturer. |
| Property | Type | Description |
|---|---|---|
level | Number Required | Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. |
status | Enum (string) Required | Represents the current status of the battery charge level. Values are:
|
| Property | Type | Description |
|---|---|---|
hvac_mode_setting | Enum (string) Required | HVAC mode to which the thermostat is set. Possible values:
|
cooling_set_point_celsius | Number Optional | The cooling set point, measured in Celsius, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on. |
heating_set_point_celsius | Number Optional | The heating set point, measured in Celsius, if heating is turned on. When the ambient temperature drops below this set point, heating turns on. |
cooling_set_point_fahrenheit | Number Optional | The cooling set point, measured in Fahrenheit, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on. |
heating_set_point_fahrenheit | Number Optional | The heating set point, measured in Fahrenheit, if heating is turned on. When the ambient temperature drops below this set point, heating turns on. |
manual_override_allowed | Boolean Required | Indicates whether another user can use the thermostat or API to override this climate setting. |
| Property | Type | Description |
|---|---|---|
climate_preset_key | String Required | Unique key to identify the current climate preset. |
can_edit | Boolean Required | Indicates whether the current climate preset can be edited. |
can_delete | Boolean Required | Indicates whether the current climate preset can be deleted. |
name | String Optional | User-friendly name to identify the current climate preset. |
display_name | String Required | Display name for the current climate preset. |
fan_mode_setting | Enum (string) Required | Current desired fan mode setting. Possible values:
|
hvac_mode_setting | Enum (string) Required | Current desired HVAC mode setting. Possible values:
|
cooling_set_point_celsius | Number Optional | Temperature to which the thermostat should currently cool (in °C). See also Set Points. |
heating_set_point_celsius | Number Optional | Temperature to which the thermostat should currently heat (in °C). |
cooling_set_point_fahrenheit | Number Optional | Temperature to which the thermostat should currently cool (in °F). |
heating_set_point_fahrenheit | Number Optional | Temperature to which the thermostat should currently heat (in °F). |
manual_override_allowed | Boolean Required | Indicates whether another user can use the thermostat or API to override this climate setting. Deprecated. Use thermostat_schedule.is_override_allowed instead. |
| Property | Type | Description |
|---|---|---|
climate_preset_key | String Required | Unique key to identify the climate preset. |
can_edit | Boolean Required | Indicates whether the climate preset can be edited. |
can_delete | Boolean Required | Indicates whether the climate preset can be deleted. |
name | String Optional | User-friendly name to identify the climate preset. |
display_name | String Required | Display name for the climate preset. |
fan_mode_setting | Enum (string) Required | Desired fan mode setting. Possible values:
|
hvac_mode_setting | Enum (string) Required | Desired HVAC mode setting. Possible values:
|
cooling_set_point_celsius | Number Optional | Temperature to which the thermostat should cool (in °C). See also Set Points. |
heating_set_point_celsius | Number Optional | Temperature to which the thermostat should heat (in °C). |
cooling_set_point_fahrenheit | Number Optional | Temperature to which the thermostat should cool (in °F). |
heating_set_point_fahrenheit | Number Optional | Temperature to which the thermostat should heat (in °F). |
manual_override_allowed | Boolean Required | Indicates whether another user can use the thermostat or API to override this climate setting. Deprecated. Use thermostat_schedule.is_override_allowed instead. |
| Property | Type | Description |
|---|---|---|
thermostat_schedule_id | String (UUID) Required | ID of the active thermostat schedule. |
device_id | String (UUID) Required | ID of the thermostat device. |
name | String Optional | User-friendly name to identify the thermostat schedule. |
climate_preset_key | String Required | Key of the climate preset to use for the thermostat schedule. |
max_override_period_minutes | Integer Required | Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also Specifying Manual Override Permissions. |
starts_at | String (Datetime) Required | Date and time at which the thermostat schedule starts, in ISO 8601 format. |
is_override_allowed | Boolean Optional | Indicates whether a person at the thermostat or using the API can change the thermostat's settings. |
ends_at | String (Datetime) Required | Date and time at which the thermostat schedule ends, in ISO 8601 format. |
created_at | String (Datetime) Required | Date and time at which the thermostat schedule was created. |
errors | Array of objects Optional | Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. |
| Property | Type | Description |
|---|---|---|
lower_limit_celsius | Number Optional | Lower acceptable temperature bound in degrees Celsius. |
lower_limit_fahrenheit | Number Optional | Lower acceptable temperature bound in degrees Fahrenheit. |
upper_limit_celsius | Number Optional | Upper acceptable temperature bound in degrees Celsius. |
upper_limit_fahrenheit | Number Optional | Upper acceptable temperature bound in degrees Fahrenheit. |
| Constraint Type | Description |
|---|---|
no_zeros | 0s cannot be used as digits in the PIN code. |
cannot_start_with_12 | The PIN code cannot start with the sequence of digits 12. |
no_triple_consecutive_ints | No more than three digits in a row can be consecutive or the same in the PIN code. |
cannot_specify_pin_code | You cannot specify a PIN code. You must leave the code empty, and the lock provider generates a PIN code. |
pin_code_matches_existing_set | If you specify a PIN code, it must match an existing set of PIN codes used in the account. For example, the PIN code could match the code assigned to a user in the system. |
start_date_in_future | For time-bound codes, the start date must be in the future. |
no_ascending_or_descending_sequence | The PIN code cannot consist of a sequence of consecutive digits. |
at_least_three_unique_digits | The PIN must contain at least three unique digits. |
cannot_contain_089 | The PIN code cannot contain the digits For example, this restriction could apply to a cylinder lock that only includes the digits |
name_length | The name of the code has some restrictions on length. When the |
name_must_be_unique | The name of the code must be unique within the device. |
| Constraint Type | Description |
|---|---|
no_zeros | 0s cannot be used as digits in the PIN code. |
cannot_start_with_12 | The PIN code cannot start with the sequence of digits 12. |
no_triple_consecutive_ints | No more than three digits in a row can be consecutive or the same in the PIN code. |
cannot_specify_pin_code | You cannot specify a PIN code. You must leave the code empty, and the lock provider generates a PIN code. |
pin_code_matches_existing_set | If you specify a PIN code, it must match an existing set of PIN codes used in the account. For example, the PIN code could match the code assigned to a user in the system. |
start_date_in_future | For time-bound codes, the start date must be in the future. |
no_ascending_or_descending_sequence | The PIN code cannot consist of a sequence of consecutive digits. |
at_least_three_unique_digits | The PIN must contain at least three unique digits. |
cannot_contain_089 | The PIN code cannot contain the digits For example, this restriction could apply to a cylinder lock that only includes the digits |
cannot_contain_0789 | The PIN code cannot contain the digits For example, this restriction could apply to a cylinder lock that only includes the digits |
name_length | The name of the code has some restrictions on length. When the |
name_must_be_unique | The name of the code must be unique within the device. |
Present on lock.locked and lock.unlocked events. Specifies the method used to perform the lock or unlock action.
Supported values:
keycode
manual
unknown
seamapi
automatic(for Kwiksetlock.lockedevents only)
Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information.
For a list of device manufacturers that send the access_code_id in lock events, see Linking Unlock Events and Access Codes.
Present on lock.locked and lock.unlocked events. Specifies the method used to perform the lock or unlock action.
Supported values for lock.unlocked:
keycodemanualunknownseamapi
Supported values for lock.locked:
Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information.
For a list of device manufacturers that send the access_code_id in lock events, see Linking Unlock Events and Access Codes.
| Lock a Lock | Lock a Lock |
| Unlock a Lock | Unlock a Lock |
| List Locks | List Locks |
+
+
+
+Present on `lock.locked` and `lock.unlocked` events. Specifies the method used to perform the [lock](../../products/smart-locks/lock-and-unlock.md#locking-a-door) or [unlock](../../products/smart-locks/lock-and-unlock.md#unlocking-a-door) action.
+
+Supported values for `lock.unlocked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+
+Supported values for `lock.locked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+* `automatic` (for [Kwikset](../../device-guides/kwikset-locks.md) and [igloohome](../../device-guides/igloohome-locks.md) only)
+
+
+
+method enum
+
+Present on `lock.locked` and `lock.unlocked` events. Specifies the method used to perform the [lock](../../products/smart-locks/lock-and-unlock.md#locking-a-door) or [unlock](../../products/smart-locks/lock-and-unlock.md#unlocking-a-door) action.
+
+Supported values for `lock.unlocked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+
+Supported values for `lock.locked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+* `automatic` (for [Kwikset](../../device-guides/kwikset-locks.md) and [igloohome](../../device-guides/igloohome-locks.md) only)
+
+
+
+
+
+Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the `access_code_id` in lock events, see [Linking Unlock Events and Access Codes](../../products/smart-locks/access-codes.md#linking-unlock-events-and-access-codes).
+
+
+
+#### `lock.unlocked`
+
+A door lock has been unlocked.
+
+access_code_id string
+
+Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the `access_code_id` in lock events, see [Linking Unlock Events and Access Codes](../../products/smart-locks/access-codes.md#linking-unlock-events-and-access-codes).
+
+
+
+
+
+Present on `lock.locked` and `lock.unlocked` events. Specifies the method used to perform the [lock](../../products/smart-locks/lock-and-unlock.md#locking-a-door) or [unlock](../../products/smart-locks/lock-and-unlock.md#unlocking-a-door) action.
+
+Supported values for `lock.unlocked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+
+Supported values for `lock.locked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+* `automatic` (for [Kwikset](../../device-guides/kwikset-locks.md) and [igloohome](../../device-guides/igloohome-locks.md) only)
+
+
+
+method enum
+
+Present on `lock.locked` and `lock.unlocked` events. Specifies the method used to perform the [lock](../../products/smart-locks/lock-and-unlock.md#locking-a-door) or [unlock](../../products/smart-locks/lock-and-unlock.md#unlocking-a-door) action.
+
+Supported values for `lock.unlocked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+
+Supported values for `lock.locked`:
+
+* `keycode`
+* `manual`
+* `unknown`
+* `seamapi`
+* `automatic` (for [Kwikset](../../device-guides/kwikset-locks.md) and [igloohome](../../device-guides/igloohome-locks.md) only)
+
+
+
+
+
+Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the `access_code_id` in lock events, see [Linking Unlock Events and Access Codes](../../products/smart-locks/access-codes.md#linking-unlock-events-and-access-codes).
+
+
+
+#### `lock.access_denied`
+
+An incorrect access code was entered one or more times in a row on a device ([Kwikset](../../device-guides/kwikset-locks.d) and [igloohome](../../device-guides/igloohome-locks.md) only).
+
+access_code_id string
+
+Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the `access_code_id` in lock events, see [Linking Unlock Events and Access Codes](../../products/smart-locks/access-codes.md#linking-unlock-events-and-access-codes).
+
+
+
+
+
+Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the `access_code_id` in lock events, see [Linking Unlock Events and Access Codes](../../products/smart-locks/access-codes.md#linking-unlock-events-and-access-codes).
+
+
diff --git a/docs/api-clients/locks/get.md b/docs/api-clients/locks/get.md
index 633c6ecb..aa5241b5 100644
--- a/docs/api-clients/locks/get.md
+++ b/docs/api-clients/locks/get.md
@@ -179,12 +179,12 @@ console.log(device)
{% tab title="Ruby" %}
```ruby
-require "seamapi"
+require "seam"
-seam = Seam::Client.new(api_key: "MY_API_KEY")
+seam = Seam.new(api_key: "MY_API_KEY")
device_id = "123e4567-e89b-12d3-a456-426614174000"
-device = seam.locks.get(device_id)
+device = seam.locks.get(device_id: device_id)
puts device
# access_code_id string
+
+Specifies the unique identifier of the access code used to trigger this event. Seam includes this ID in the event if the affected device returns this information. For a list of device manufacturers that send the `access_code_id` in lock events, see [Linking Unlock Events and Access Codes](../../products/smart-locks/access-codes.md#linking-unlock-events-and-access-codes).
+
+noise_threshold_id string
+
+
+
+Name of the [noise threshold](../../products/noise-sensors/#what-is-a-threshold) that was triggered, for example, `builtin_first_disturbance`.
+
+
+
## Next Steps
-For more details on each endpoint, see our API References:
+For more details on each endpoint, see our API references:
-| [List Noise Thresholds](./noise_thresholds/list.md) |
-| --------------------------------------------------- |
-| [Create Noise Threshold](./noise_thresholds/create.md) |
-| [Update Noise Threshold](./noise_thresholds/update.md) |
-| [Delete Noise Threshold](./noise_thresholds/delete.md) |
+| [List Noise Thresholds](noise_thresholds/list.md) |
+| ---------------------------------------------------- |
+| [Create Noise Threshold](noise_thresholds/create.md) |
+| [Update Noise Threshold](noise_thresholds/update.md) |
+| [Delete Noise Threshold](noise_thresholds/delete.md) |
diff --git a/docs/api-clients/thermostats/cool.md b/docs/api-clients/thermostats/cool.md
index aca19d58..50dba4da 100644
--- a/docs/api-clients/thermostats/cool.md
+++ b/docs/api-clients/thermostats/cool.md
@@ -14,7 +14,7 @@ layout:
# Set to Cool Mode
-Set a thermostat to cooling mode. To do so, you must include a cooling set point in the payload, either in Celsius or Fahrenheit. For information about verifying the cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](../../products/thermostats/hvac-mode.md#hvac-mode-constraints) and [Set Point Constraints](../../products/thermostats/set-points.md#set-point-constraints).
+Set a thermostat to cooling mode. To do so, you must include a cooling set point in the payload, either in Celsius or Fahrenheit. For information about verifying the cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md#hvac-mode-constraints) and [Set Point Constraints](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#set-point-constraints).
{% swagger src="https://connect.getseam.com/openapi.json" path="/thermostats/cool" method="post" %}
[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json)
diff --git a/docs/api-clients/thermostats/heat.md b/docs/api-clients/thermostats/heat.md
index a7609102..ca8b6ec6 100644
--- a/docs/api-clients/thermostats/heat.md
+++ b/docs/api-clients/thermostats/heat.md
@@ -14,7 +14,7 @@ layout:
# Set to Heat Mode
-Set a thermostat to heating mode. To do so, you must include a heating set point in the payload, either in Celsius or Fahrenheit. For information about verifying the heating availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](../../products/thermostats/hvac-mode.md#hvac-mode-constraints) and [Set Point Constraints](../../products/thermostats/set-points.md#set-point-constraints).
+Set a thermostat to heating mode. To do so, you must include a heating set point in the payload, either in Celsius or Fahrenheit. For information about verifying the heating availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md#hvac-mode-constraints) and [Set Point Constraints](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#set-point-constraints).
{% swagger src="https://connect.getseam.com/openapi.json" path="/thermostats/heat" method="post" %}
[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json)
diff --git a/docs/api-clients/thermostats/heat_cool.md b/docs/api-clients/thermostats/heat_cool.md
index c4b6ffde..8eb2d104 100644
--- a/docs/api-clients/thermostats/heat_cool.md
+++ b/docs/api-clients/thermostats/heat_cool.md
@@ -14,7 +14,7 @@ layout:
# Set to Heat-Cool (Auto) Mode
-Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](../../products/thermostats/hvac-mode.md#hvac-mode-constraints) and [Set Point Constraints](../../products/thermostats/set-points.md#set-point-constraints).
+Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md#hvac-mode-constraints) and [Set Point Constraints](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#set-point-constraints).
{% swagger src="https://connect.getseam.com/openapi.json" path="/thermostats/heat_cool" method="post" %}
[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json)
diff --git a/docs/api-clients/user_identities/delete.md b/docs/api-clients/user_identities/delete.md
index 65d9c5fe..7ff8a2f7 100644
--- a/docs/api-clients/user_identities/delete.md
+++ b/docs/api-clients/user_identities/delete.md
@@ -4,7 +4,7 @@ description: Delete a specified user identity
# Delete a User Identity
-Deletes a specified [user identity](../../products/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](../acs/credentials/delete.md) and [enrollment automations](enrollment_automations/delete.md) associated with the user identity. You must also deactivate any associated phones.
+Deletes a specified [user identity](../../products/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](../../api/acs/credentials/) and [enrollment automations](enrollment\_automations/delete.md) associated with the user identity. You must also deactivate any associated phones.
{% swagger src="https://connect.getseam.com/openapi.json" path="/user_identities/delete" method="post" %}
[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json)
diff --git a/docs/api/_report.md b/docs/api/_report.md
new file mode 100644
index 00000000..d42f7513
--- /dev/null
+++ b/docs/api/_report.md
@@ -0,0 +1,927 @@
+# Documentation Report
+
+## Untitled
+
+### Routes
+
+- `/access_codes`
+- `/access_codes/simulate`
+- `/access_codes/unmanaged`
+- `/action_attempts`
+- `/client_sessions`
+- `/connect_webviews`
+- `/connected_accounts`
+- `/devices`
+- `/devices/simulate`
+- `/devices/unmanaged`
+- `/events`
+- `/locks`
+- `/networks`
+- `/noise_sensors`
+- `/noise_sensors/noise_thresholds`
+- `/noise_sensors/simulate`
+- `/phones`
+- `/phones/simulate`
+- `/webhooks`
+- `/workspaces`
+
+### Endpoints
+
+- `/access_codes/create`
+- `/access_codes/create_multiple`
+- `/access_codes/delete`
+- `/access_codes/generate_code`
+- `/access_codes/get`
+- `/access_codes/list`
+- `/access_codes/pull_backup_access_code`
+- `/access_codes/update`
+- `/access_codes/update_multiple`
+- `/access_codes/simulate/create_unmanaged_access_code`
+- `/access_codes/unmanaged/convert_to_managed`
+- `/access_codes/unmanaged/delete`
+- `/access_codes/unmanaged/get`
+- `/access_codes/unmanaged/list`
+- `/access_codes/unmanaged/update`
+- `/action_attempts/get`
+- `/action_attempts/list`
+- `/client_sessions/create`
+- `/client_sessions/delete`
+- `/client_sessions/get`
+- `/client_sessions/get_or_create`
+- `/client_sessions/grant_access`
+- `/client_sessions/list`
+- `/client_sessions/revoke`
+- `/connect_webviews/create`
+- `/connect_webviews/delete`
+- `/connect_webviews/get`
+- `/connect_webviews/list`
+- `/connected_accounts/delete`
+- `/connected_accounts/get`
+- `/connected_accounts/list`
+- `/connected_accounts/update`
+- `/devices/get`
+- `/devices/list_device_providers`
+- `/devices/update`
+- `/devices/simulate/connect`
+- `/devices/simulate/disconnect`
+- `/devices/simulate/remove`
+- `/devices/unmanaged/get`
+- `/devices/unmanaged/list`
+- `/devices/unmanaged/update`
+- `/events/get`
+- `/events/list`
+- `/locks/get`
+- `/locks/list`
+- `/locks/lock_door`
+- `/locks/unlock_door`
+- `/networks/get`
+- `/networks/list`
+- `/noise_sensors/list`
+- `/noise_sensors/noise_thresholds/create`
+- `/noise_sensors/noise_thresholds/delete`
+- `/noise_sensors/noise_thresholds/get`
+- `/noise_sensors/noise_thresholds/list`
+- `/noise_sensors/noise_thresholds/update`
+- `/noise_sensors/simulate/trigger_noise_threshold`
+- `/phones/deactivate`
+- `/phones/list`
+- `/phones/simulate/create_sandbox_phone`
+- `/webhooks/create`
+- `/webhooks/delete`
+- `/webhooks/get`
+- `/webhooks/list`
+- `/webhooks/update`
+- `/workspaces/create`
+- `/workspaces/get`
+- `/workspaces/list`
+- `/workspaces/reset_sandbox`
+
+## Undocumented
+
+These items are intentionally undocumented.
+
+### Routes
+
+- `/acs/access_groups/unmanaged`: No undocumented message provided
+- `/acs/credential_pools`: No undocumented message provided
+- `/acs/credential_provisioning_automations`: No undocumented message provided
+- `/acs/credentials/unmanaged`: No undocumented message provided
+- `/acs/encoders`: No undocumented message provided
+- `/acs/encoders/simulate`: No undocumented message provided
+- `/acs/users/unmanaged`: No undocumented message provided
+
+### Resource properties
+
+- `acs_user.is_latest_desired_state_synced_with_provider`: Only used internally.
+- `acs_user.latest_desired_state_synced_with_provider_at`: Only used internally.
+- `thermostat_schedule.unstable_is_override_allowed`: Unstable
+
+### Endpoints
+
+- `/acs/access_groups/unmanaged/get`: No unmanaged access groups are currently implemented.
+- `/acs/access_groups/unmanaged/list`: No unmanaged access groups are currently implemented.
+- `/acs/credential_pools/list`: Replaced by enrollment automations.
+- `/acs/credential_provisioning_automations/launch`: Replaced by enrollment automations.
+- `/acs/credentials/create_offline_code`: Unreleased.
+- `/acs/credentials/unmanaged/get`: No unmanaged credentials are currently implemented.
+- `/acs/credentials/unmanaged/list`: No unmanaged credentials are currently implemented.
+- `/acs/encoders/encode_credential`: Encoders are in alpha.
+- `/acs/encoders/list`: Encoders are in alpha.
+- `/acs/encoders/scan_credential`: Encoders are in alpha.
+- `/acs/encoders/simulate/next_credential_encode_will_fail`: Encoder simulations are in alpha.
+- `/acs/encoders/simulate/next_credential_encode_will_succeed`: Encoder simulations are in alpha.
+- `/acs/encoders/simulate/next_credential_scan_will_fail`: Encoder simulations are in alpha.
+- `/acs/encoders/simulate/next_credential_scan_will_succeed`: Encoder simulations are in alpha.
+- `/acs/users/unmanaged/get`: No unmanaged users are currently implemented.
+- `/acs/users/unmanaged/list`: No unmanaged users are currently implemented.
+- `/devices/delete`: Deleting a device is no longer supported and will be removed.
+- `/thermostats/get`: Will be removed.
+
+### Endpoint parameters
+
+- `/devices/list`
+ - `exclude_if`: Only used internally.
+ - `include_if`: Only used internally.
+- `/devices/unmanaged/list`
+ - `exclude_if`: Only used internally.
+ - `include_if`: Only used internally.
+- `/locks/list`
+ - `exclude_if`: Only used internally.
+ - `include_if`: Only used internally.
+- `/noise_sensors/list`
+ - `exclude_if`: Only used internally.
+ - `include_if`: Only used internally.
+- `/thermostats/cool`
+ - `sync`: Only used internally.
+- `/thermostats/heat`
+ - `sync`: Only used internally.
+- `/thermostats/heat_cool`
+ - `sync`: Only used internally.
+- `/thermostats/list`
+ - `exclude_if`: Only used internally.
+ - `include_if`: Only used internally.
+- `/thermostats/off`
+ - `sync`: Only used internally.
+- `/thermostats/set_fan_mode`
+ - `sync`: Only used internally.
+
+## No Description
+
+These items have an empty description.
+Items that are intentionally undocumented are not included in this section.
+
+### Resources
+
+- `access_code`
+- `acs_credential_pool`
+- `acs_credential_provisioning_automation`
+- `client_session`
+- `connect_webview`
+- `connected_account`
+- `device`
+- `device_provider`
+- `network`
+- `noise_threshold`
+- `phone`
+- `service_health`
+- `unmanaged_access_code`
+- `unmanaged_device`
+- `webhook`
+- `workspace`
+
+### Resource properties
+
+- `acs_access_group.access_group_type`
+- `acs_access_group.access_group_type_display_name`
+- `acs_access_group.display_name`
+- `acs_access_group.is_managed`
+- `acs_credential.acs_credential_pool_id`
+- `acs_credential.card_number`
+- `acs_credential.is_issued`
+- `acs_credential.is_managed`
+- `acs_credential.issued_at`
+- `acs_credential_pool.acs_credential_pool_id`
+- `acs_credential_pool.acs_system_id`
+- `acs_credential_pool.created_at`
+- `acs_credential_pool.display_name`
+- `acs_credential_pool.external_type`
+- `acs_credential_pool.external_type_display_name`
+- `acs_credential_pool.workspace_id`
+- `acs_credential_provisioning_automation.acs_credential_provisioning_automation_id`
+- `acs_credential_provisioning_automation.created_at`
+- `acs_credential_provisioning_automation.credential_manager_acs_system_id`
+- `acs_credential_provisioning_automation.user_identity_id`
+- `acs_credential_provisioning_automation.workspace_id`
+- `acs_entrance.assa_abloy_vostio_metadata`
+- `acs_entrance.dormakaba_community_metadata`
+- `acs_entrance.errors`
+- `acs_entrance.latch_metadata`
+- `acs_entrance.salto_ks_metadata`
+- `acs_entrance.salto_space_metadata`
+- `acs_entrance.visionline_metadata`
+- `acs_system.location`
+- `acs_system.system_type`
+- `acs_system.system_type_display_name`
+- `acs_system.visionline_metadata`
+- `acs_user.email`
+- `acs_user.hid_acs_system_id`
+- `acs_user.is_latest_desired_state_synced_with_provider`
+- `acs_user.is_managed`
+- `acs_user.latest_desired_state_synced_with_provider_at`
+- `client_session.client_session_id`
+- `client_session.connect_webview_ids`
+- `client_session.connected_account_ids`
+- `client_session.created_at`
+- `client_session.device_count`
+- `client_session.expires_at`
+- `client_session.token`
+- `client_session.user_identifier_key`
+- `client_session.user_identity_ids`
+- `client_session.workspace_id`
+- `connect_webview.accepted_devices`
+- `connect_webview.accepted_providers`
+- `connect_webview.any_device_allowed`
+- `connect_webview.any_provider_allowed`
+- `connect_webview.authorized_at`
+- `connect_webview.automatically_manage_new_devices`
+- `connect_webview.connect_webview_id`
+- `connect_webview.connected_account_id`
+- `connect_webview.created_at`
+- `connect_webview.custom_metadata`
+- `connect_webview.custom_redirect_failure_url`
+- `connect_webview.custom_redirect_url`
+- `connect_webview.device_selection_mode`
+- `connect_webview.login_successful`
+- `connect_webview.selected_provider`
+- `connect_webview.status`
+- `connect_webview.url`
+- `connect_webview.wait_for_device_creation`
+- `connect_webview.workspace_id`
+- `connected_account.account_type`
+- `connected_account.account_type_display_name`
+- `connected_account.automatically_manage_new_devices`
+- `connected_account.connected_account_id`
+- `connected_account.created_at`
+- `connected_account.custom_metadata`
+- `connected_account.errors`
+- `connected_account.user_identifier`
+- `connected_account.warnings`
+- `device.can_hvac_cool`
+- `device.can_hvac_heat`
+- `device.can_hvac_heat_cool`
+- `device.can_program_offline_access_codes`
+- `device.can_program_online_access_codes`
+- `device.can_remotely_lock`
+- `device.can_remotely_unlock`
+- `device.can_simulate_connection`
+- `device.can_simulate_disconnection`
+- `device.can_simulate_removal`
+- `device.can_turn_off_hvac`
+- `device.custom_metadata`
+- `device_provider.can_hvac_cool`
+- `device_provider.can_hvac_heat`
+- `device_provider.can_hvac_heat_cool`
+- `device_provider.can_program_offline_access_codes`
+- `device_provider.can_program_online_access_codes`
+- `device_provider.can_remotely_lock`
+- `device_provider.can_remotely_unlock`
+- `device_provider.can_simulate_connection`
+- `device_provider.can_simulate_disconnection`
+- `device_provider.can_simulate_removal`
+- `device_provider.can_turn_off_hvac`
+- `device_provider.device_provider_name`
+- `device_provider.display_name`
+- `device_provider.image_url`
+- `device_provider.provider_categories`
+- `network.created_at`
+- `network.display_name`
+- `network.network_id`
+- `network.workspace_id`
+- `noise_threshold.device_id`
+- `noise_threshold.ends_daily_at`
+- `noise_threshold.name`
+- `noise_threshold.noise_threshold_decibels`
+- `noise_threshold.noise_threshold_id`
+- `noise_threshold.noise_threshold_nrs`
+- `noise_threshold.starts_daily_at`
+- `phone.can_hvac_cool`
+- `phone.can_hvac_heat`
+- `phone.can_hvac_heat_cool`
+- `phone.can_program_offline_access_codes`
+- `phone.can_program_online_access_codes`
+- `phone.can_remotely_lock`
+- `phone.can_remotely_unlock`
+- `phone.can_simulate_connection`
+- `phone.can_simulate_disconnection`
+- `phone.can_simulate_removal`
+- `phone.can_turn_off_hvac`
+- `phone.custom_metadata`
+- `phone.device_type`
+- `phone.properties`
+- `service_health.description`
+- `service_health.service`
+- `service_health.status`
+- `unmanaged_access_code.is_managed`
+- `unmanaged_access_code.status`
+- `unmanaged_device.can_hvac_cool`
+- `unmanaged_device.can_hvac_heat`
+- `unmanaged_device.can_hvac_heat_cool`
+- `unmanaged_device.can_program_offline_access_codes`
+- `unmanaged_device.can_program_online_access_codes`
+- `unmanaged_device.can_remotely_lock`
+- `unmanaged_device.can_remotely_unlock`
+- `unmanaged_device.can_simulate_connection`
+- `unmanaged_device.can_simulate_disconnection`
+- `unmanaged_device.can_simulate_removal`
+- `unmanaged_device.can_turn_off_hvac`
+- `unmanaged_device.is_managed`
+- `unmanaged_device.properties`
+- `user_identity.display_name`
+- `user_identity.full_name`
+- `webhook.event_types`
+- `webhook.secret`
+- `webhook.url`
+- `webhook.webhook_id`
+- `workspace.company_name`
+- `workspace.connect_partner_name`
+- `workspace.is_sandbox`
+- `workspace.name`
+- `workspace.workspace_id`
+
+### Endpoints
+
+- `/access_codes/create`
+- `/access_codes/create_multiple`
+- `/access_codes/delete`
+- `/access_codes/generate_code`
+- `/access_codes/get`
+- `/access_codes/list`
+- `/access_codes/update`
+- `/access_codes/update_multiple`
+- `/access_codes/simulate/create_unmanaged_access_code`
+- `/access_codes/unmanaged/convert_to_managed`
+- `/access_codes/unmanaged/delete`
+- `/access_codes/unmanaged/get`
+- `/access_codes/unmanaged/list`
+- `/access_codes/unmanaged/update`
+- `/acs/credential_pools/list`
+- `/acs/credential_provisioning_automations/launch`
+- `/acs/encoders/encode_credential`
+- `/acs/encoders/list`
+- `/acs/encoders/scan_credential`
+- `/acs/encoders/simulate/next_credential_encode_will_fail`
+- `/acs/encoders/simulate/next_credential_encode_will_succeed`
+- `/acs/encoders/simulate/next_credential_scan_will_fail`
+- `/acs/encoders/simulate/next_credential_scan_will_succeed`
+- `/acs/entrances/grant_access`
+- `/acs/users/unmanaged/get`
+- `/acs/users/unmanaged/list`
+- `/action_attempts/get`
+- `/action_attempts/list`
+- `/client_sessions/create`
+- `/client_sessions/delete`
+- `/client_sessions/get`
+- `/client_sessions/get_or_create`
+- `/client_sessions/grant_access`
+- `/client_sessions/list`
+- `/client_sessions/revoke`
+- `/connect_webviews/create`
+- `/connect_webviews/delete`
+- `/connect_webviews/get`
+- `/connect_webviews/list`
+- `/connected_accounts/delete`
+- `/connected_accounts/get`
+- `/connected_accounts/list`
+- `/connected_accounts/update`
+- `/devices/delete`
+- `/devices/get`
+- `/devices/list_device_providers`
+- `/devices/update`
+- `/devices/simulate/connect`
+- `/devices/simulate/disconnect`
+- `/devices/simulate/remove`
+- `/devices/unmanaged/get`
+- `/devices/unmanaged/list`
+- `/devices/unmanaged/update`
+- `/events/get`
+- `/events/list`
+- `/locks/get`
+- `/locks/list`
+- `/locks/lock_door`
+- `/locks/unlock_door`
+- `/networks/get`
+- `/networks/list`
+- `/noise_sensors/list`
+- `/noise_sensors/noise_thresholds/create`
+- `/noise_sensors/noise_thresholds/delete`
+- `/noise_sensors/noise_thresholds/get`
+- `/noise_sensors/noise_thresholds/list`
+- `/noise_sensors/noise_thresholds/update`
+- `/noise_sensors/simulate/trigger_noise_threshold`
+- `/phones/deactivate`
+- `/phones/list`
+- `/phones/simulate/create_sandbox_phone`
+- `/user_identities/update`
+- `/webhooks/create`
+- `/webhooks/delete`
+- `/webhooks/get`
+- `/webhooks/list`
+- `/webhooks/update`
+- `/workspaces/create`
+- `/workspaces/get`
+- `/workspaces/list`
+- `/workspaces/reset_sandbox`
+
+### Endpoint parameters
+
+- `/access_codes/create`
+ - `allow_external_modification`
+ - `attempt_for_offline_device`
+ - `code`
+ - `common_code_key`
+ - `device_id`
+ - `ends_at`
+ - `is_external_modification_allowed`
+ - `is_offline_access_code`
+ - `is_one_time_use`
+ - `max_time_rounding`
+ - `name`
+ - `prefer_native_scheduling`
+ - `preferred_code_length`
+ - `starts_at`
+ - `sync`
+ - `use_backup_access_code_pool`
+ - `use_offline_access_code`
+- `/access_codes/create_multiple`
+ - `allow_external_modification`
+ - `attempt_for_offline_device`
+ - `behavior_when_code_cannot_be_shared`
+ - `code`
+ - `device_ids`
+ - `ends_at`
+ - `is_external_modification_allowed`
+ - `is_offline_access_code`
+ - `is_one_time_use`
+ - `max_time_rounding`
+ - `name`
+ - `prefer_native_scheduling`
+ - `preferred_code_length`
+ - `starts_at`
+ - `use_backup_access_code_pool`
+ - `use_offline_access_code`
+- `/access_codes/delete`
+ - `access_code_id`
+ - `device_id`
+ - `sync`
+- `/access_codes/generate_code`
+ - `device_id`
+- `/access_codes/get`
+ - `access_code_id`
+ - `code`
+ - `device_id`
+- `/access_codes/list`
+ - `access_code_ids`
+ - `device_id`
+ - `user_identifier_key`
+- `/access_codes/pull_backup_access_code`
+ - `access_code_id`
+- `/access_codes/update`
+ - `access_code_id`
+ - `allow_external_modification`
+ - `attempt_for_offline_device`
+ - `code`
+ - `device_id`
+ - `ends_at`
+ - `is_external_modification_allowed`
+ - `is_managed`
+ - `is_offline_access_code`
+ - `is_one_time_use`
+ - `max_time_rounding`
+ - `name`
+ - `prefer_native_scheduling`
+ - `preferred_code_length`
+ - `starts_at`
+ - `sync`
+ - `type`
+ - `use_backup_access_code_pool`
+ - `use_offline_access_code`
+- `/access_codes/update_multiple`
+ - `common_code_key`
+ - `ends_at`
+ - `name`
+ - `starts_at`
+- `/access_codes/simulate/create_unmanaged_access_code`
+ - `code`
+ - `device_id`
+ - `name`
+- `/access_codes/unmanaged/convert_to_managed`
+ - `access_code_id`
+ - `allow_external_modification`
+ - `force`
+ - `is_external_modification_allowed`
+ - `sync`
+- `/access_codes/unmanaged/delete`
+ - `access_code_id`
+ - `sync`
+- `/access_codes/unmanaged/get`
+ - `access_code_id`
+ - `code`
+ - `device_id`
+- `/access_codes/unmanaged/list`
+ - `device_id`
+ - `user_identifier_key`
+- `/access_codes/unmanaged/update`
+ - `access_code_id`
+ - `allow_external_modification`
+ - `force`
+ - `is_external_modification_allowed`
+ - `is_managed`
+- `/acs/credential_pools/list`
+ - `acs_system_id`
+- `/acs/credential_provisioning_automations/launch`
+ - `acs_credential_pool_id`
+ - `create_credential_manager_user`
+ - `credential_manager_acs_system_id`
+ - `credential_manager_acs_user_id`
+ - `user_identity_id`
+- `/acs/encoders/simulate/next_credential_encode_will_succeed`
+ - `acs_encoder_id`
+ - `scenario`
+- `/acs/entrances/get`
+ - `acs_entrance_id`
+- `/acs/entrances/grant_access`
+ - `acs_entrance_id`
+ - `acs_user_id`
+- `/acs/entrances/list`
+ - `acs_credential_id`
+ - `acs_system_id`
+- `/acs/entrances/list_credentials_with_access`
+ - `acs_entrance_id`
+ - `include_if`
+- `/acs/users/create`
+ - `email`
+- `/acs/users/list`
+ - `created_before`
+ - `limit`
+- `/acs/users/update`
+ - `email`
+ - `hid_acs_system_id`
+- `/acs/users/unmanaged/get`
+ - `acs_user_id`
+- `/acs/users/unmanaged/list`
+ - `acs_system_id`
+ - `limit`
+ - `user_identity_email_address`
+ - `user_identity_id`
+ - `user_identity_phone_number`
+- `/action_attempts/get`
+ - `action_attempt_id`
+- `/action_attempts/list`
+ - `action_attempt_ids`
+- `/client_sessions/create`
+ - `connect_webview_ids`
+ - `connected_account_ids`
+ - `expires_at`
+ - `user_identifier_key`
+ - `user_identity_ids`
+- `/client_sessions/delete`
+ - `client_session_id`
+- `/client_sessions/get`
+ - `client_session_id`
+ - `user_identifier_key`
+- `/client_sessions/get_or_create`
+ - `connect_webview_ids`
+ - `connected_account_ids`
+ - `expires_at`
+ - `user_identifier_key`
+ - `user_identity_ids`
+- `/client_sessions/grant_access`
+ - `client_session_id`
+ - `connect_webview_ids`
+ - `connected_account_ids`
+ - `user_identifier_key`
+ - `user_identity_ids`
+- `/client_sessions/list`
+ - `client_session_id`
+ - `connect_webview_id`
+ - `user_identifier_key`
+ - `user_identity_id`
+ - `without_user_identifier_key`
+- `/client_sessions/revoke`
+ - `client_session_id`
+- `/connect_webviews/create`
+ - `accepted_providers`
+ - `automatically_manage_new_devices`
+ - `custom_metadata`
+ - `custom_redirect_failure_url`
+ - `custom_redirect_url`
+ - `device_selection_mode`
+ - `provider_category`
+ - `wait_for_device_creation`
+- `/connect_webviews/delete`
+ - `connect_webview_id`
+- `/connect_webviews/get`
+ - `connect_webview_id`
+- `/connect_webviews/list`
+ - `limit`
+- `/connected_accounts/delete`
+ - `connected_account_id`
+ - `sync`
+- `/connected_accounts/update`
+ - `automatically_manage_new_devices`
+ - `connected_account_id`
+ - `custom_metadata`
+- `/devices/delete`
+ - `device_id`
+- `/devices/get`
+ - `device_id`
+ - `name`
+- `/devices/list`
+ - `exclude_if`
+ - `include_if`
+- `/devices/list_device_providers`
+ - `provider_category`
+- `/devices/update`
+ - `custom_metadata`
+ - `device_id`
+ - `is_managed`
+ - `name`
+ - `properties`
+- `/devices/simulate/connect`
+ - `device_id`
+- `/devices/simulate/disconnect`
+ - `device_id`
+- `/devices/simulate/remove`
+ - `device_id`
+- `/devices/unmanaged/get`
+ - `device_id`
+ - `name`
+- `/devices/unmanaged/list`
+ - `exclude_if`
+ - `include_if`
+- `/devices/unmanaged/update`
+ - `device_id`
+ - `is_managed`
+- `/events/get`
+ - `device_id`
+ - `event_id`
+ - `event_type`
+- `/events/list`
+ - `access_code_id`
+ - `access_code_ids`
+ - `acs_system_id`
+ - `acs_system_ids`
+ - `between`
+ - `connect_webview_id`
+ - `connected_account_id`
+ - `device_id`
+ - `device_ids`
+ - `event_type`
+ - `event_types`
+ - `limit`
+ - `since`
+ - `unstable_offset`
+- `/locks/get`
+ - `device_id`
+ - `name`
+- `/locks/list`
+ - `exclude_if`
+ - `include_if`
+- `/locks/lock_door`
+ - `device_id`
+ - `sync`
+- `/locks/unlock_door`
+ - `device_id`
+ - `sync`
+- `/networks/get`
+ - `network_id`
+- `/noise_sensors/list`
+ - `exclude_if`
+ - `include_if`
+- `/noise_sensors/noise_thresholds/create`
+ - `device_id`
+ - `ends_daily_at`
+ - `name`
+ - `noise_threshold_decibels`
+ - `noise_threshold_nrs`
+ - `starts_daily_at`
+ - `sync`
+- `/noise_sensors/noise_thresholds/delete`
+ - `device_id`
+ - `noise_threshold_id`
+ - `sync`
+- `/noise_sensors/noise_thresholds/get`
+ - `noise_threshold_id`
+- `/noise_sensors/noise_thresholds/list`
+ - `device_id`
+ - `is_programmed`
+- `/noise_sensors/noise_thresholds/update`
+ - `device_id`
+ - `ends_daily_at`
+ - `name`
+ - `noise_threshold_decibels`
+ - `noise_threshold_id`
+ - `noise_threshold_nrs`
+ - `starts_daily_at`
+ - `sync`
+- `/noise_sensors/simulate/trigger_noise_threshold`
+ - `device_id`
+- `/phones/deactivate`
+ - `device_id`
+- `/phones/list`
+ - `acs_credential_id`
+ - `owner_user_identity_id`
+- `/phones/simulate/create_sandbox_phone`
+ - `assa_abloy_metadata`
+ - `custom_sdk_installation_id`
+ - `phone_metadata`
+ - `user_identity_id`
+- `/thermostats/cool`
+ - `sync`
+- `/thermostats/heat`
+ - `sync`
+- `/thermostats/heat_cool`
+ - `sync`
+- `/thermostats/list`
+ - `exclude_if`
+ - `include_if`
+- `/thermostats/off`
+ - `sync`
+- `/thermostats/set_fan_mode`
+ - `device_id`
+ - `fan_mode`
+ - `sync`
+- `/user_identities/list`
+ - `credential_manager_acs_system_id`
+- `/user_identities/update`
+ - `full_name`
+- `/webhooks/create`
+ - `event_types`
+ - `url`
+- `/webhooks/delete`
+ - `webhook_id`
+- `/webhooks/get`
+ - `webhook_id`
+- `/webhooks/update`
+ - `event_types`
+ - `webhook_id`
+- `/workspaces/create`
+ - `company_name`
+ - `connect_partner_name`
+ - `is_sandbox`
+ - `name`
+ - `webview_logo_shape`
+ - `webview_primary_button_color`
+ - `webview_primary_button_text_color`
+
+## Draft
+
+These items have been marked as draft.
+
+### Resource properties
+
+- `acs_system.default_credential_manager_acs_system_id`: Needs review
+
+## Deprecated
+
+These items are deprecated.
+
+### Resource properties
+
+- `acs_access_group.access_group_type`: Use `external_type`.
+- `acs_access_group.access_group_type_display_name`: Use `external_type_display_name`.
+- `acs_system.connected_account_ids`: Use `connected_account_id`.
+- `acs_system.system_type`: Use `external_type`.
+- `acs_system.system_type_display_name`: Use `external_type_display_name`.
+- `acs_user.email`: use email_address.
+- `connect_webview.accepted_devices`: Unused. Will be removed.
+- `connect_webview.any_device_allowed`: Unused. Will be removed.
+- `workspace.connect_partner_name`: use company_name
+
+### Endpoint parameters
+
+- `/acs/users/create`
+ - `email`: use email_address.
+- `/acs/users/update`
+ - `email`: use email_address.
+- `/thermostats/create_climate_preset`
+ - `manual_override_allowed`: Use 'thermostat_schedule.is_override_allowed'
+- `/thermostats/set_fan_mode`
+ - `fan_mode`: Use `fan_mode_setting` instead.
+- `/thermostats/update_climate_preset`
+ - `manual_override_allowed`: Use 'thermostat_schedule.is_override_allowed'
+- `/workspaces/create`
+ - `connect_partner_name`: use company_name
+
+### Extra response keys
+
+- `/access_codes/create`
+ - `action_attempt`
+- `/access_codes/pull_backup_access_code`
+ - `backup_access_code`
+- `/events/get`
+ - `message`
+- `/locks/get`
+ - `lock`
+- `/locks/list`
+ - `locks`
+- `/noise_sensors/list`
+ - `noise_sensors`
+- `/noise_sensors/noise_thresholds/create`
+ - `action_attempt`
+- `/thermostats/list`
+ - `thermostats`
+- `/user_identities/list_accessible_devices`
+ - `accessible_devices`
+
+### Endpoints without code samples
+
+- `/access_codes/create`
+- `/access_codes/create_multiple`
+- `/access_codes/delete`
+- `/access_codes/generate_code`
+- `/access_codes/get`
+- `/access_codes/list`
+- `/access_codes/pull_backup_access_code`
+- `/access_codes/update`
+- `/access_codes/update_multiple`
+- `/access_codes/simulate/create_unmanaged_access_code`
+- `/access_codes/unmanaged/convert_to_managed`
+- `/access_codes/unmanaged/delete`
+- `/access_codes/unmanaged/get`
+- `/access_codes/unmanaged/list`
+- `/access_codes/unmanaged/update`
+- `/acs/credential_pools/list`
+- `/acs/credential_provisioning_automations/launch`
+- `/acs/credentials/create_offline_code`
+- `/acs/credentials/unmanaged/get`
+- `/acs/credentials/unmanaged/list`
+- `/acs/encoders/encode_credential`
+- `/acs/encoders/list`
+- `/acs/encoders/scan_credential`
+- `/acs/encoders/simulate/next_credential_encode_will_fail`
+- `/acs/encoders/simulate/next_credential_encode_will_succeed`
+- `/acs/encoders/simulate/next_credential_scan_will_fail`
+- `/acs/encoders/simulate/next_credential_scan_will_succeed`
+- `/acs/entrances/grant_access`
+- `/acs/users/list_accessible_entrances`
+- `/acs/users/revoke_access_to_all_entrances`
+- `/acs/users/unmanaged/get`
+- `/acs/users/unmanaged/list`
+- `/action_attempts/get`
+- `/action_attempts/list`
+- `/client_sessions/create`
+- `/client_sessions/delete`
+- `/client_sessions/get`
+- `/client_sessions/get_or_create`
+- `/client_sessions/grant_access`
+- `/client_sessions/list`
+- `/client_sessions/revoke`
+- `/connect_webviews/create`
+- `/connect_webviews/delete`
+- `/connect_webviews/get`
+- `/connect_webviews/list`
+- `/connected_accounts/delete`
+- `/connected_accounts/get`
+- `/connected_accounts/list`
+- `/connected_accounts/update`
+- `/devices/delete`
+- `/devices/get`
+- `/devices/list`
+- `/devices/list_device_providers`
+- `/devices/update`
+- `/devices/simulate/connect`
+- `/devices/simulate/disconnect`
+- `/devices/simulate/remove`
+- `/devices/unmanaged/get`
+- `/devices/unmanaged/list`
+- `/devices/unmanaged/update`
+- `/events/get`
+- `/events/list`
+- `/locks/get`
+- `/locks/list`
+- `/locks/lock_door`
+- `/locks/unlock_door`
+- `/networks/get`
+- `/networks/list`
+- `/noise_sensors/list`
+- `/noise_sensors/noise_thresholds/create`
+- `/noise_sensors/noise_thresholds/delete`
+- `/noise_sensors/noise_thresholds/get`
+- `/noise_sensors/noise_thresholds/list`
+- `/noise_sensors/noise_thresholds/update`
+- `/noise_sensors/simulate/trigger_noise_threshold`
+- `/phones/deactivate`
+- `/phones/list`
+- `/phones/simulate/create_sandbox_phone`
+- `/thermostats/get`
+- `/user_identities/update`
+- `/webhooks/create`
+- `/webhooks/delete`
+- `/webhooks/get`
+- `/webhooks/list`
+- `/webhooks/update`
+- `/workspaces/create`
+- `/workspaces/get`
+- `/workspaces/list`
+- `/workspaces/reset_sandbox`
diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md
new file mode 100644
index 00000000..46ca0b28
--- /dev/null
+++ b/docs/api/acs/README.md
@@ -0,0 +1,25 @@
+---
+description: Systems for managing and monitoring access to physical spaces
+---
+
+# Access Control Systems
+
+## Resources
+
+### [`acs_system`](./systems/README.md#acs_system)
+Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+### [`acs_user`](./users/README.md#acs_user)
+Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+### [`acs_entrance`](./entrances/README.md#acs_entrance)
+Represents an [entrance](../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+### [`acs_access_group`](./access_groups/README.md#acs_access_group)
+Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+### [`acs_credential`](./credentials/README.md#acs_credential)
+Means by which a user gains access at an entrance.
+The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
+
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
new file mode 100644
index 00000000..c89a930a
--- /dev/null
+++ b/docs/api/acs/access_groups/README.md
@@ -0,0 +1,151 @@
+# Access Groups
+
+## `acs_access_group`
+
+Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+### `access_group_type`
+
+{% hint style="warning" %}
+**Deprecated**. Use `external_type`.
+{% endhint %}
+
+Format: `Enum`
+
+Possible enum values:
+- `pti_unit`
+- `pti_access_level`
+- `salto_ks_access_group`
+- `brivo_group`
+- `salto_space_group`
+- `dormakaba_community_access_group`
+
+
+---
+
+### `access_group_type_display_name`
+
+{% hint style="warning" %}
+**Deprecated**. Use `external_type_display_name`.
+{% endhint %}
+
+Format: `String`
+
+
+---
+
+### `acs_access_group_id`
+
+Format: `ID`
+
+ID of the access group.
+
+
+---
+
+### `acs_system_id`
+
+Format: `ID`
+
+ID of the access control system that contains the access group.
+
+
+---
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the access group was created.
+
+
+---
+
+### `display_name`
+
+Format: `String`
+
+
+---
+
+### `external_type`
+
+Format: `Enum`
+
+Brand-specific terminology for the access group type.
+
+Possible enum values:
+- `pti_unit`
+- `pti_access_level`
+- `salto_ks_access_group`
+- `brivo_group`
+- `salto_space_group`
+- `dormakaba_community_access_group`
+
+
+---
+
+### `external_type_display_name`
+
+Format: `String`
+
+Display name that corresponds to the brand-specific terminology for the access group type.
+
+
+---
+
+### `is_managed`
+
+Format: `Boolean`
+
+
+---
+
+### `name`
+
+Format: `String`
+
+Name of the access group.
+
+
+---
+
+### `warnings`
+
+Format: `List`
+
+Warnings associated with the `acs_access_group`.
+
+
+---
+
+### `workspace_id`
+
+Format: `ID`
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group.
+
+
+---
+
+## Endpoints
+
+### [`/acs/access_groups/add_user`](./add_user.md)
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+### [`/acs/access_groups/get`](./get.md)
+
+Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+### [`/acs/access_groups/list`](./list.md)
+
+Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+### [`/acs/access_groups/list_accessible_entrances`](./list_accessible_entrances.md)
+
+Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+### [`/acs/access_groups/list_users`](./list_users.md)
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+### [`/acs/access_groups/remove_user`](./remove_user.md)
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md
new file mode 100644
index 00000000..f099cc1e
--- /dev/null
+++ b/docs/api/acs/access_groups/add_user.md
@@ -0,0 +1,149 @@
+# Add an ACS User to an Access Group
+
+```
+PUT /acs/access_groups/add_user ⇒ void
+```
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.accessGroups.addUser({
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.access_groups.add_user(
+ acs_access_group_id="44444444-4444-4444-4444-444444444444",
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.access_groups.add_user(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->access_groups->add_user(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+ acs_user_id: "33333333-3333-3333-3333-333333333333"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import accessgroups "github.com/seamapi/go/accessgroups"
+
+func main() {
+ client.Acs.AccessGroups.AddUser(
+ context.Background(),
+ accessgroups.AccessGroupsAddUserRequest{
+ AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
+ AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_access_group_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired access group.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md
new file mode 100644
index 00000000..18115e05
--- /dev/null
+++ b/docs/api/acs/access_groups/get.md
@@ -0,0 +1,187 @@
+# Get an Access Group
+
+```
+POST /acs/access_groups/get ⇒ { acs_access_group }
+```
+
+Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.accessGroups.get({
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
+ "name": "Lobby Access",
+ "display_name": "Lobby Access",
+ "access_group_type_display_name": "PTI access level",
+ "access_group_type": "pti_access_level",
+ "external_type": "pti_access_level",
+ "external_type_display_name": "PTI access level",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2023-11-30T06:27:15.437Z"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444")
+```
+
+#### Response
+
+```python
+AcsAccessGroup(
+ acs_access_group_id="44444444-4444-4444-4444-444444444444",
+ name="Lobby Access",
+ display_name="Lobby Access",
+ access_group_type_display_name="PTI access level",
+ access_group_type="pti_access_level",
+ external_type="pti_access_level",
+ external_type_display_name="PTI access level",
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ created_at="2023-11-30T06:27:15.437Z",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444")
+```
+
+#### Response
+
+```ruby
+{
+ "acs_access_group_id" => "44444444-4444-4444-4444-444444444444",
+ "name" => "Lobby Access",
+ "display_name" => "Lobby Access",
+ "access_group_type_display_name" => "PTI access level",
+ "access_group_type" => "pti_access_level",
+ "external_type" => "pti_access_level",
+ "external_type_display_name" => "PTI access level",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2023-11-30T06:27:15.437Z",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->access_groups->get(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444"
+);
+```
+
+#### Response
+
+```php
+ "44444444-4444-4444-4444-444444444444",
+ "name" => "Lobby Access",
+ "display_name" => "Lobby Access",
+ "access_group_type_display_name" => "PTI access level",
+ "access_group_type" => "pti_access_level",
+ "external_type" => "pti_access_level",
+ "external_type_display_name" => "PTI access level",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2023-11-30T06:27:15.437Z",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444"
+```
+
+#### Response
+
+```seam_cli
+{
+ "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
+ "name": "Lobby Access",
+ "display_name": "Lobby Access",
+ "access_group_type_display_name": "PTI access level",
+ "access_group_type": "pti_access_level",
+ "external_type": "pti_access_level",
+ "external_type_display_name": "PTI access level",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2023-11-30T06:27:15.437Z"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import accessgroups "github.com/seamapi/go/accessgroups"
+
+func main() {
+ client.Acs.AccessGroups.Get(
+ context.Background(),
+ accessgroups.AccessGroupsGetRequest{
+ AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_access_group_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired access group.
+
+***
+
+## Return Type
+
+[acs\_access\_group](./)
diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md
new file mode 100644
index 00000000..615e721a
--- /dev/null
+++ b/docs/api/acs/access_groups/list.md
@@ -0,0 +1,215 @@
+# List Access Groups
+
+```
+POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] }
+```
+
+Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.accessGroups.list({
+ acs_system_id: "11111111-1111-1111-1111-111111111111",
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
+ "name": "Lobby Access",
+ "display_name": "Lobby Access",
+ "access_group_type_display_name": "PTI access level",
+ "access_group_type": "pti_access_level",
+ "external_type": "pti_access_level",
+ "external_type_display_name": "PTI access level",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2023-11-30T06:27:15.437Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.access_groups.list(
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+)
+```
+
+#### Response
+
+```python
+[
+ AcsAccessGroup(
+ acs_access_group_id="44444444-4444-4444-4444-444444444444",
+ name="Lobby Access",
+ display_name="Lobby Access",
+ access_group_type_display_name="PTI access level",
+ access_group_type="pti_access_level",
+ external_type="pti_access_level",
+ external_type_display_name="PTI access level",
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ created_at="2023-11-30T06:27:15.437Z",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.access_groups.list(
+ acs_system_id: "11111111-1111-1111-1111-111111111111",
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+)
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_access_group_id" => "44444444-4444-4444-4444-444444444444",
+ "name" => "Lobby Access",
+ "display_name" => "Lobby Access",
+ "access_group_type_display_name" => "PTI access level",
+ "access_group_type" => "pti_access_level",
+ "external_type" => "pti_access_level",
+ "external_type_display_name" => "PTI access level",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2023-11-30T06:27:15.437Z",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->access_groups->list(
+ acs_system_id: "11111111-1111-1111-1111-111111111111",
+ acs_user_id: "33333333-3333-3333-3333-333333333333"
+);
+```
+
+#### Response
+
+```php
+ "44444444-4444-4444-4444-444444444444",
+ "name" => "Lobby Access",
+ "display_name" => "Lobby Access",
+ "access_group_type_display_name" => "PTI access level",
+ "access_group_type" => "pti_access_level",
+ "external_type" => "pti_access_level",
+ "external_type_display_name" => "PTI access level",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2023-11-30T06:27:15.437Z",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
+ "name": "Lobby Access",
+ "display_name": "Lobby Access",
+ "access_group_type_display_name": "PTI access level",
+ "access_group_type": "pti_access_level",
+ "external_type": "pti_access_level",
+ "external_type_display_name": "PTI access level",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2023-11-30T06:27:15.437Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import accessgroups "github.com/seamapi/go/accessgroups"
+
+func main() {
+ client.Acs.AccessGroups.List(
+ context.Background(),
+ accessgroups.AccessGroupsListRequest{
+ AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
+ AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_system_id`
+
+Type: `string`
+Required: No
+
+ID of the access control system for which you want to retrieve all access groups.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: No
+
+ID of the user for which you want to retrieve all access groups.
+
+***
+
+## Return Type
+
+Array<[acs\_access\_group](./)>
diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md
new file mode 100644
index 00000000..f50ebf67
--- /dev/null
+++ b/docs/api/acs/access_groups/list_accessible_entrances.md
@@ -0,0 +1,181 @@
+# List Entrances Accessible to an Access Group
+
+```
+POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] }
+```
+
+Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.accessGroups.listAccessibleEntrances({
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_entrance_id": "66666666-6666-6666-6666-666666666666",
+ "name": "Main Entrance",
+ "display_name": "Main Entrance",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-10-15T12:00:00.000Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.access_groups.list_accessible_entrances(
+ acs_access_group_id="44444444-4444-4444-4444-444444444444"
+)
+```
+
+#### Response
+
+```python
+[
+ AcsEntrance(
+ acs_entrance_id="66666666-6666-6666-6666-666666666666",
+ name="Main Entrance",
+ display_name="Main Entrance",
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ created_at="2024-10-15T12:00:00.000Z",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.access_groups.list_accessible_entrances(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+)
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_entrance_id" => "66666666-6666-6666-6666-666666666666",
+ "name" => "Main Entrance",
+ "display_name" => "Main Entrance",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-10-15T12:00:00.000Z",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->access_groups->list_accessible_entrances(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444"
+);
+```
+
+#### Response
+
+```php
+ "66666666-6666-6666-6666-666666666666",
+ "name" => "Main Entrance",
+ "display_name" => "Main Entrance",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-10-15T12:00:00.000Z",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_entrance_id": "66666666-6666-6666-6666-666666666666",
+ "name": "Main Entrance",
+ "display_name": "Main Entrance",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-10-15T12:00:00.000Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import accessgroups "github.com/seamapi/go/accessgroups"
+
+func main() {
+ client.Acs.AccessGroups.ListAccessibleEntrances(
+ context.Background(),
+ accessgroups.AccessGroupsListAccessibleEntrancesRequest{
+ AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_access_group_id`
+
+Type: `string`
+Required: Yes
+
+ID of the access group for which you want to retrieve all accessible entrances.
+
+***
+
+## Return Type
+
+Array<[acs\_entrance](./)>
diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md
new file mode 100644
index 00000000..36c393e2
--- /dev/null
+++ b/docs/api/acs/access_groups/list_users.md
@@ -0,0 +1,239 @@
+# List ACS Users in an Access Group
+
+```
+POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }
+```
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.accessGroups.listUsers({
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email": "jane@example.com",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-05T07:14:28.531Z",
+ "is_suspended": false,
+ "access_schedule": {
+ "starts_at": "2024-03-01T10:40:00.000Z",
+ "ends_at": "2024-03-04T10:40:00.000Z"
+ },
+ "user_identity_id": "22222222-2222-2222-2222-222222222222",
+ "user_identity_full_name": "Jane Doe",
+ "user_identity_email_address": "jane@example.com",
+ "user_identity_phone_number": "+15555550100"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.access_groups.list_users(
+ acs_access_group_id="44444444-4444-4444-4444-444444444444"
+)
+```
+
+#### Response
+
+```python
+[
+ AcsUser(
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ display_name="Jane Doe",
+ full_name="Jane Doe",
+ email="jane@example.com",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ created_at="2024-04-05T07:14:28.531Z",
+ is_suspended=false,
+ access_schedule={
+ "starts_at": "2024-03-01T10:40:00.000Z",
+ "ends_at": "2024-03-04T10:40:00.000Z",
+ },
+ user_identity_id="22222222-2222-2222-2222-222222222222",
+ user_identity_full_name="Jane Doe",
+ user_identity_email_address="jane@example.com",
+ user_identity_phone_number="+15555550100",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444")
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email" => "jane@example.com",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-05T07:14:28.531Z",
+ "is_suspended" => false,
+ "access_schedule" => {
+ starts_at: "2024-03-01T10:40:00.000Z",
+ ends_at: "2024-03-04T10:40:00.000Z",
+ },
+ "user_identity_id" => "22222222-2222-2222-2222-222222222222",
+ "user_identity_full_name" => "Jane Doe",
+ "user_identity_email_address" => "jane@example.com",
+ "user_identity_phone_number" => "+15555550100",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->access_groups->list_users(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444"
+);
+```
+
+#### Response
+
+```php
+ "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email" => "jane@example.com",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-05T07:14:28.531Z",
+ "is_suspended" => false,
+ "access_schedule" => [
+ "starts_at" => "2024-03-01T10:40:00.000Z",
+ "ends_at" => "2024-03-04T10:40:00.000Z",
+ ],
+ "user_identity_id" => "22222222-2222-2222-2222-222222222222",
+ "user_identity_full_name" => "Jane Doe",
+ "user_identity_email_address" => "jane@example.com",
+ "user_identity_phone_number" => "+15555550100",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email": "jane@example.com",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-05T07:14:28.531Z",
+ "is_suspended": false,
+ "access_schedule": {
+ "starts_at": "2024-03-01T10:40:00.000Z",
+ "ends_at": "2024-03-04T10:40:00.000Z"
+ },
+ "user_identity_id": "22222222-2222-2222-2222-222222222222",
+ "user_identity_full_name": "Jane Doe",
+ "user_identity_email_address": "jane@example.com",
+ "user_identity_phone_number": "+15555550100"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import accessgroups "github.com/seamapi/go/accessgroups"
+
+func main() {
+ client.Acs.AccessGroups.ListUsers(
+ context.Background(),
+ accessgroups.AccessGroupsListUsersRequest{
+ AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_access_group_id`
+
+Type: `string`
+Required: Yes
+
+ID of the access group for which you want to retrieve all users.
+
+***
+
+## Return Type
+
+Array<[acs\_user](./)>
diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md
new file mode 100644
index 00000000..5995686f
--- /dev/null
+++ b/docs/api/acs/access_groups/remove_user.md
@@ -0,0 +1,149 @@
+# Remove an ACS User from an Access Group
+
+```
+POST /acs/access_groups/remove_user ⇒ void
+```
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.accessGroups.removeUser({
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.access_groups.remove_user(
+ acs_access_group_id="44444444-4444-4444-4444-444444444444",
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.access_groups.remove_user(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->access_groups->remove_user(
+ acs_access_group_id: "44444444-4444-4444-4444-444444444444",
+ acs_user_id: "33333333-3333-3333-3333-333333333333"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import accessgroups "github.com/seamapi/go/accessgroups"
+
+func main() {
+ client.Acs.AccessGroups.RemoveUser(
+ context.Background(),
+ accessgroups.AccessGroupsRemoveUserRequest{
+ AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
+ AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_access_group_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired access group.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
new file mode 100644
index 00000000..09f904af
--- /dev/null
+++ b/docs/api/acs/credentials/README.md
@@ -0,0 +1,316 @@
+# Credentials
+
+## `acs_credential`
+
+Means by which a user gains access at an entrance.
+The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.
+
+### `access_method`
+
+Format: `Enum`
+
+Access method for the credential. Supported values: `code`, `card`, `mobile_key`.
+
+Possible enum values:
+- `code`
+- `card`
+- `mobile_key`
+
+
+---
+
+### `acs_credential_id`
+
+Format: `ID`
+
+ID of the credential.
+
+
+---
+
+### `acs_credential_pool_id`
+
+Format: `ID`
+
+
+---
+
+### `acs_system_id`
+
+Format: `ID`
+
+ID of the access control system that contains the credential.
+
+
+---
+
+### `acs_user_id`
+
+Format: `ID`
+
+ID of the ACS user to whom the credential belongs.
+
+
+---
+
+### `card_number`
+
+Format: `String`
+
+
+---
+
+### `code`
+
+Format: `String`
+
+Access (PIN) code for the credential.
+
+
+---
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the credential was created.
+
+
+---
+
+### `display_name`
+
+Format: `String`
+
+Display name that corresponds to the credential type.
+
+
+---
+
+### `ends_at`
+
+Format: `String`
+
+Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
+
+---
+
+### `errors`
+
+Format: `List`
+
+Errors associated with the `acs_credential`.
+
+
+---
+
+### `external_type`
+
+Format: `Enum`
+
+Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
+
+Possible enum values:
+- `pti_card`
+- `brivo_credential`
+- `hid_credential`
+- `visionline_card`
+- `salto_ks_credential`
+
+
+---
+
+### `external_type_display_name`
+
+Format: `String`
+
+Display name that corresponds to the brand-specific terminology for the credential type.
+
+
+---
+
+### `is_issued`
+
+Format: `Boolean`
+
+
+---
+
+### `is_latest_desired_state_synced_with_provider`
+
+Format: `Boolean`
+
+Indicates whether the latest state of the credential has been synced from Seam to the provider.
+
+
+---
+
+### `is_managed`
+
+Format: `Boolean`
+
+
+---
+
+### `is_multi_phone_sync_credential`
+
+Format: `Boolean`
+
+Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
+
+---
+
+### `is_one_time_use`
+
+Format: `Boolean`
+
+Indicates whether the credential can only be used once. If "true," the code becomes invalid after the first use.
+
+
+---
+
+### `issued_at`
+
+Format: `Datetime`
+
+
+---
+
+### `latest_desired_state_synced_with_provider_at`
+
+Format: `Datetime`
+
+Date and time at which the state of the credential was most recently synced from Seam to the provider.
+
+
+---
+
+### `parent_acs_credential_id`
+
+Format: `ID`
+
+ID of the parent credential.
+
+
+---
+
+### `starts_at`
+
+Format: `String`
+
+Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+---
+
+### `visionline_metadata`
+
+Format: `Object`
+
+Visionline-specific metadata for the credential.
+
+noise_threshold_name string
+
+Name of the [noise threshold](../../products/noise-sensors/#what-is-a-threshold) that was triggered, for example, `builtin_first_disturbance`.
+
+
+
+
+
+
+
+
+auto_join Format: boolean
+
+
+
+
+
+
+
+
+
+card_function_type Format: enum
+
+
+
+
+
+
+
+
+
+card_id Format: string
+
+
+
+
+
+
+
+
+
+common_acs_entrance_ids Format: list
+
+
+
+
+
+
+
+
+
+credential_id Format: string
+
+
+
+
+
+
+
+
+
+guest_acs_entrance_ids Format: list
+
+
+
+
+
+
+
+
+
+is_valid Format: boolean
+
+
+
+
+
+
+
+
+
+
+---
+
+### `warnings`
+
+Format: `List`
+
+Warnings associated with the `acs_credential`.
+
+
+---
+
+### `workspace_id`
+
+Format: `ID`
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the credential.
+
+
+---
+
+## Endpoints
+
+### [`/acs/credentials/assign`](./assign.md)
+
+Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+### [`/acs/credentials/create`](./create.md)
+
+Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+### [`/acs/credentials/delete`](./delete.md)
+
+Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+### [`/acs/credentials/get`](./get.md)
+
+Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+### [`/acs/credentials/list`](./list.md)
+
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md).
+### [`/acs/credentials/list_accessible_entrances`](./list_accessible_entrances.md)
+
+Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.
+### [`/acs/credentials/unassign`](./unassign.md)
+
+Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+### [`/acs/credentials/update`](./update.md)
+
+Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md
new file mode 100644
index 00000000..5e6cdda6
--- /dev/null
+++ b/docs/api/acs/credentials/assign.md
@@ -0,0 +1,149 @@
+# Assign a Credential to an ACS User
+
+```
+PATCH /acs/credentials/assign ⇒ void
+```
+
+Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.assign({
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.assign(
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ acs_credential_id="66666666-6666-6666-6666-666666666666",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.assign(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->assign(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_credential_id: "66666666-6666-6666-6666-666666666666"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.Assign(
+ context.Background(),
+ credentials.CredentialsAssignRequest{
+ AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
+ AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired credential.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md
new file mode 100644
index 00000000..a34432db
--- /dev/null
+++ b/docs/api/acs/credentials/create.md
@@ -0,0 +1,309 @@
+# Create a Credential for an ACS User
+
+```
+POST /acs/credentials/create ⇒ { acs_credential }
+```
+
+Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.create({
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ access_method: "mobile_key",
+ allowed_acs_entrance_ids: [
+ "55555555-5555-5555-5555-555555555555",
+ "55555555-5555-5555-5555-000000000000",
+ ],
+ credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888",
+ is_multi_phone_sync_credential: true,
+ starts_at: "2024-03-01T10:40:00Z",
+ ends_at: "2024-03-04T10:40:00Z",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "acs_credential_id": "99999999-9999-9999-9999-999999999999",
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Multi Phone Sync Credential",
+ "code": null,
+ "acs_system_id": "88888888-8888-8888-8888-888888888888",
+ "access_method": "mobile_key",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential": true
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.create(
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ access_method="mobile_key",
+ allowed_acs_entrance_ids=[
+ "55555555-5555-5555-5555-555555555555",
+ "55555555-5555-5555-5555-000000000000",
+ ],
+ credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888",
+ is_multi_phone_sync_credential=true,
+ starts_at="2024-03-01T10:40:00Z",
+ ends_at="2024-03-04T10:40:00Z",
+)
+```
+
+#### Response
+
+```python
+AcsCredential(
+ acs_credential_id="99999999-9999-9999-9999-999999999999",
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ display_name="Multi Phone Sync Credential",
+ code=None,
+ acs_system_id="88888888-8888-8888-8888-888888888888",
+ access_method="mobile_key",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ created_at="2024-04-12T03:56:22.396Z",
+ is_multi_phone_sync_credential=true,
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.create(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ access_method: "mobile_key",
+ allowed_acs_entrance_ids: %w[
+ 55555555-5555-5555-5555-555555555555
+ 55555555-5555-5555-5555-000000000000
+ ],
+ credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888",
+ is_multi_phone_sync_credential: true,
+ starts_at: "2024-03-01T10:40:00Z",
+ ends_at: "2024-03-04T10:40:00Z",
+)
+```
+
+#### Response
+
+```ruby
+{
+ "acs_credential_id" => "99999999-9999-9999-9999-999999999999",
+ "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Multi Phone Sync Credential",
+ "code" => nil,
+ "acs_system_id" => "88888888-8888-8888-8888-888888888888",
+ "access_method" => "mobile_key",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential" => true,
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->create(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ access_method: "mobile_key",
+ allowed_acs_entrance_ids: [
+ "55555555-5555-5555-5555-555555555555",
+ "55555555-5555-5555-5555-000000000000",
+ ],
+ credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888",
+ is_multi_phone_sync_credential: true,
+ starts_at: "2024-03-01T10:40:00Z",
+ ends_at: "2024-03-04T10:40:00Z"
+);
+```
+
+#### Response
+
+```php
+ "99999999-9999-9999-9999-999999999999",
+ "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Multi Phone Sync Credential",
+ "code" => null,
+ "acs_system_id" => "88888888-8888-8888-8888-888888888888",
+ "access_method" => "mobile_key",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential" => true,
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z"
+```
+
+#### Response
+
+```seam_cli
+{
+ "acs_credential_id": "99999999-9999-9999-9999-999999999999",
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Multi Phone Sync Credential",
+ "code": null,
+ "acs_system_id": "88888888-8888-8888-8888-888888888888",
+ "access_method": "mobile_key",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential": true
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.Create(
+ context.Background(),
+ credentials.CredentialsCreateRequest{
+ AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
+ AccessMethod: api.String("mobile_key"),
+ AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")},
+ CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"),
+ IsMultiPhoneSyncCredential: api.Bool(true),
+ StartsAt: api.String("2024-03-01T10:40:00Z"),
+ EndsAt: api.String("2024-03-04T10:40:00Z"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `access_method`
+
+Type: `string`
+Required: Yes
+
+Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the ACS user to whom the new credential belongs.
+
+***
+
+### `allowed_acs_entrance_ids`
+
+Type: `array`
+Required: No
+
+Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access.
+
+***
+
+### `assa_abloy_vostio_metadata`
+
+Type: `object`
+Required: No
+
+Vostio-specific metadata for the new credential.
+
+***
+
+### `code`
+
+Type: `string`
+Required: No
+
+Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md).
+
+***
+
+### `credential_manager_acs_system_id`
+
+Type: `string`
+Required: No
+
+ACS system ID of the credential manager for the new credential.
+
+***
+
+### `ends_at`
+
+Type: `string`
+Required: No
+
+Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+
+***
+
+### `is_multi_phone_sync_credential`
+
+Type: `boolean`
+Required: No
+
+Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+
+***
+
+### `starts_at`
+
+Type: `string`
+Required: No
+
+Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+***
+
+### `visionline_metadata`
+
+Type: `object`
+Required: No
+
+Visionline-specific metadata for the new credential.
+
+***
+
+## Return Type
+
+[acs\_credential](./)
diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md
new file mode 100644
index 00000000..2ff52117
--- /dev/null
+++ b/docs/api/acs/credentials/delete.md
@@ -0,0 +1,131 @@
+# Delete a Credential
+
+```
+POST /acs/credentials/delete ⇒ void
+```
+
+Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.delete({
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666")
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666")
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->delete(
+ acs_credential_id: "66666666-6666-6666-6666-666666666666"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.Delete(
+ context.Background(),
+ credentials.CredentialsDeleteRequest{
+ AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired credential.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md
new file mode 100644
index 00000000..b726f644
--- /dev/null
+++ b/docs/api/acs/credentials/get.md
@@ -0,0 +1,182 @@
+# Get a Credential
+
+```
+POST /acs/credentials/get ⇒ { acs_credential }
+```
+
+Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.get({
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "acs_credential_id": "99999999-9999-9999-9999-999999999999",
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Multi Phone Sync Credential",
+ "code": null,
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "access_method": "mobile_key",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential": true
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666")
+```
+
+#### Response
+
+```python
+AcsCredential(
+ acs_credential_id="99999999-9999-9999-9999-999999999999",
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ display_name="Multi Phone Sync Credential",
+ code=None,
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ access_method="mobile_key",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ created_at="2024-04-12T03:56:22.396Z",
+ is_multi_phone_sync_credential=true,
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666")
+```
+
+#### Response
+
+```ruby
+{
+ "acs_credential_id" => "99999999-9999-9999-9999-999999999999",
+ "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Multi Phone Sync Credential",
+ "code" => nil,
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "access_method" => "mobile_key",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential" => true,
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->get(
+ acs_credential_id: "66666666-6666-6666-6666-666666666666"
+);
+```
+
+#### Response
+
+```php
+ "99999999-9999-9999-9999-999999999999",
+ "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Multi Phone Sync Credential",
+ "code" => null,
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "access_method" => "mobile_key",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential" => true,
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666"
+```
+
+#### Response
+
+```seam_cli
+{
+ "acs_credential_id": "99999999-9999-9999-9999-999999999999",
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Multi Phone Sync Credential",
+ "code": null,
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "access_method": "mobile_key",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential": true
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.Get(
+ context.Background(),
+ credentials.CredentialsGetRequest{
+ AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired credential.
+
+***
+
+## Return Type
+
+[acs\_credential](./)
diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md
new file mode 100644
index 00000000..96f6110c
--- /dev/null
+++ b/docs/api/acs/credentials/list.md
@@ -0,0 +1,203 @@
+# List Credentials
+
+```
+POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] }
+```
+
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.list({
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_system_id: "11111111-1111-1111-1111-111111111111",
+ user_identity_id: "22222222-2222-2222-2222-222222222222",
+ is_multi_phone_sync_credential: true,
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_credential_id": "99999999-9999-9999-9999-999999999999",
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Multi Phone Sync Credential",
+ "code": null,
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "access_method": "mobile_key",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential": true
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.list(
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ user_identity_id="22222222-2222-2222-2222-222222222222",
+ is_multi_phone_sync_credential=true,
+)
+```
+
+#### Response
+
+```python
+[
+ AcsCredential(
+ acs_credential_id="99999999-9999-9999-9999-999999999999",
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ display_name="Multi Phone Sync Credential",
+ code=None,
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ access_method="mobile_key",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ created_at="2024-04-12T03:56:22.396Z",
+ is_multi_phone_sync_credential=true,
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.list(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_system_id: "11111111-1111-1111-1111-111111111111",
+ user_identity_id: "22222222-2222-2222-2222-222222222222",
+ is_multi_phone_sync_credential: true,
+)
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_credential_id" => "99999999-9999-9999-9999-999999999999",
+ "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Multi Phone Sync Credential",
+ "code" => nil,
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "access_method" => "mobile_key",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential" => true,
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->list(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_system_id: "11111111-1111-1111-1111-111111111111",
+ user_identity_id: "22222222-2222-2222-2222-222222222222",
+ is_multi_phone_sync_credential: true
+);
+```
+
+#### Response
+
+```php
+ "99999999-9999-9999-9999-999999999999",
+ "acs_user_id" => "33333333-3333-3333-3333-333333333333",
+ "display_name" => "Multi Phone Sync Credential",
+ "code" => null,
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "access_method" => "mobile_key",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "created_at" => "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential" => true,
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_credential_id": "99999999-9999-9999-9999-999999999999",
+ "acs_user_id": "33333333-3333-3333-3333-333333333333",
+ "display_name": "Multi Phone Sync Credential",
+ "code": null,
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "access_method": "mobile_key",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "created_at": "2024-04-12T03:56:22.396Z",
+ "is_multi_phone_sync_credential": true
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.List(
+ context.Background(),
+ credentials.CredentialsListRequest{
+ AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
+ AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
+ UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"),
+ IsMultiPhoneSyncCredential: api.Bool(true),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+## Return Type
+
+Array<[acs\_credential](./)>
diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md
new file mode 100644
index 00000000..3a2de649
--- /dev/null
+++ b/docs/api/acs/credentials/list_accessible_entrances.md
@@ -0,0 +1,226 @@
+# List Accessible Entrances
+
+```
+POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] }
+```
+
+Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.listAccessibleEntrances({
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "visionline_metadata": {
+ "profiles": [
+ {
+ "visionline_door_profile_id": "Guest Door",
+ "visionline_door_profile_type": "BLE"
+ }
+ ],
+ "door_name": "Guest Lock 2",
+ "door_category": "guest"
+ },
+ "latch_metadata": null,
+ "display_name": "Guest Lock 2",
+ "created_at": "2024-03-26T14:31:18.979Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.list_accessible_entrances(
+ acs_credential_id="66666666-6666-6666-6666-666666666666"
+)
+```
+
+#### Response
+
+```python
+[
+ AcsEntrance(
+ acs_entrance_id="55555555-5555-5555-5555-555555555555",
+ acs_system_id="11111111-1111-1111-1111-111111111111",
+ workspace_id="00000000-0000-0000-0000-000000000000",
+ visionline_metadata={
+ "profiles": [
+ {
+ "visionline_door_profile_id": "Guest Door",
+ "visionline_door_profile_type": "BLE",
+ }
+ ],
+ "door_name": "Guest Lock 2",
+ "door_category": "guest",
+ },
+ latch_metadata=None,
+ display_name="Guest Lock 2",
+ created_at="2024-03-26T14:31:18.979Z",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.list_accessible_entrances(
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+)
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_entrance_id" => "55555555-5555-5555-5555-555555555555",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "visionline_metadata" => {
+ profiles: [{ visionline_door_profile_id: "Guest Door", visionline_door_profile_type: "BLE" }],
+ door_name: "Guest Lock 2",
+ door_category: "guest",
+ },
+ "latch_metadata" => nil,
+ "display_name" => "Guest Lock 2",
+ "created_at" => "2024-03-26T14:31:18.979Z",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->list_accessible_entrances(
+ acs_credential_id: "66666666-6666-6666-6666-666666666666"
+);
+```
+
+#### Response
+
+```php
+ "55555555-5555-5555-5555-555555555555",
+ "acs_system_id" => "11111111-1111-1111-1111-111111111111",
+ "workspace_id" => "00000000-0000-0000-0000-000000000000",
+ "visionline_metadata" => [
+ "profiles" => [
+ [
+ "visionline_door_profile_id" => "Guest Door",
+ "visionline_door_profile_type" => "BLE",
+ ],
+ ],
+ "door_name" => "Guest Lock 2",
+ "door_category" => "guest",
+ ],
+ "latch_metadata" => null,
+ "display_name" => "Guest Lock 2",
+ "created_at" => "2024-03-26T14:31:18.979Z",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
+ "acs_system_id": "11111111-1111-1111-1111-111111111111",
+ "workspace_id": "00000000-0000-0000-0000-000000000000",
+ "visionline_metadata": {
+ "profiles": [
+ {
+ "visionline_door_profile_id": "Guest Door",
+ "visionline_door_profile_type": "BLE"
+ }
+ ],
+ "door_name": "Guest Lock 2",
+ "door_category": "guest"
+ },
+ "latch_metadata": null,
+ "display_name": "Guest Lock 2",
+ "created_at": "2024-03-26T14:31:18.979Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.ListAccessibleEntrances(
+ context.Background(),
+ credentials.CredentialsListAccessibleEntrancesRequest{
+ AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_id`
+
+Type: `string`
+Required: Yes
+
+ID of the credential for which you want to retrieve all entrances to which this credential grants access.
+
+***
+
+## Return Type
+
+Array<[acs\_entrance](./)>
diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md
new file mode 100644
index 00000000..2123ca63
--- /dev/null
+++ b/docs/api/acs/credentials/unassign.md
@@ -0,0 +1,149 @@
+# Unassign a Credential from an ACS User
+
+```
+PATCH /acs/credentials/unassign ⇒ void
+```
+
+Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.unassign({
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.unassign(
+ acs_user_id="33333333-3333-3333-3333-333333333333",
+ acs_credential_id="66666666-6666-6666-6666-666666666666",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.unassign(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->unassign(
+ acs_user_id: "33333333-3333-3333-3333-333333333333",
+ acs_credential_id: "66666666-6666-6666-6666-666666666666"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.Unassign(
+ context.Background(),
+ credentials.CredentialsUnassignRequest{
+ AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
+ AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired credential.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md
new file mode 100644
index 00000000..254aa8ef
--- /dev/null
+++ b/docs/api/acs/credentials/update.md
@@ -0,0 +1,154 @@
+# Update a Credential
+
+```
+PATCH /acs/credentials/update ⇒ void
+```
+
+Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.credentials.update({
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+ code: "7890",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.credentials.update(
+ acs_credential_id="66666666-6666-6666-6666-666666666666", code="7890"
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890")
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->credentials->update(
+ acs_credential_id: "66666666-6666-6666-6666-666666666666",
+ code: "7890"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import credentials "github.com/seamapi/go/credentials"
+
+func main() {
+ client.Acs.Credentials.Update(
+ context.Background(),
+ credentials.CredentialsUpdateRequest{
+ AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"),
+ Code: api.String("7890"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired credential.
+
+***
+
+### `code`
+
+Type: `string`
+Required: No
+
+Replacement access (PIN) code for the credential.
+
+***
+
+### `ends_at`
+
+Type: `string`
+Required: No
+
+Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md
new file mode 100644
index 00000000..272a263a
--- /dev/null
+++ b/docs/api/acs/entrances/README.md
@@ -0,0 +1,280 @@
+# Entrances
+
+## `acs_entrance`
+
+Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+### `acs_entrance_id`
+
+Format: `ID`
+
+ID of the entrance.
+
+
+---
+
+### `acs_system_id`
+
+Format: `ID`
+
+ID of the access control system that contains the entrance.
+
+
+---
+
+### `assa_abloy_vostio_metadata`
+
+Format: `Object`
+
+joiner_acs_credential_ids Format: list
+
+
+
+
+
+
+
+
+
+door_name Format: string
+
+
+
+
+
+
+
+
+
+door_number Format: number
+
+
+
+
+
+
+
+
+
+door_type Format: enum
+
+
+
+
+
+
+
+
+
+pms_id Format: string
+
+
+
+
+
+
+
+
+
+
+---
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the entrance was created.
+
+
+---
+
+### `display_name`
+
+Format: `String`
+
+Display name for the entrance.
+
+
+---
+
+### `dormakaba_community_metadata`
+
+Format: `Object`
+
+stand_open Format: boolean
+
+
+
+
+
+
+
+
+
+access_point_name Format: string
+
+
+
+
+
+
+
+
+
+
+---
+
+### `errors`
+
+Format: `List`
+
+
+---
+
+### `latch_metadata`
+
+Format: `Object`
+
+common_area_number Format: number
+
+
+
+
+
+
+
+
+
+accessibility_type Format: string
+
+
+
+
+
+
+
+
+
+door_name Format: string
+
+
+
+
+
+
+
+
+
+door_type Format: string
+
+
+
+
+
+
+
+
+
+
+---
+
+### `salto_ks_metadata`
+
+Format: `Object`
+
+is_connected Format: boolean
+
+
+
+
+
+
+
+
+
+battery_level Format: string
+
+
+
+
+
+
+
+
+
+door_name Format: string
+
+
+
+
+
+
+
+
+
+intrusion_alarm Format: boolean
+
+
+
+
+
+
+
+
+
+left_open_alarm Format: boolean
+
+
+
+
+
+
+
+
+
+lock_type Format: string
+
+
+
+
+
+
+
+
+
+locked_state Format: string
+
+
+
+
+
+
+
+
+
+online Format: boolean
+
+
+
+
+
+
+
+
+
+
+---
+
+### `salto_space_metadata`
+
+Format: `Object`
+
+privacy_mode Format: boolean
+
+
+
+
+
+
+
+
+
+door_description Format: string
+
+
+
+
+
+
+
+
+
+door_name Format: string
+
+
+
+
+
+
+
+
+
+
+---
+
+### `visionline_metadata`
+
+Format: `Object`
+
+ext_door_id Format: string
+
+
+
+
+
+
+
+
+
+door_category Format: enum
+
+
+
+
+
+
+
+
+
+door_name Format: string
+
+
+
+
+
+
+
+
+
+
+---
+
+## Endpoints
+
+### [`/acs/entrances/get`](./get.md)
+
+Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+### [`/acs/entrances/grant_access`](./grant_access.md)
+
+
+### [`/acs/entrances/list`](./list.md)
+
+Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+### [`/acs/entrances/list_credentials_with_access`](./list_credentials_with_access.md)
+
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md
new file mode 100644
index 00000000..b4bbbbdf
--- /dev/null
+++ b/docs/api/acs/entrances/get.md
@@ -0,0 +1,157 @@
+# Get an Entrance
+
+```
+POST /acs/entrances/get ⇒ { acs_entrance }
+```
+
+Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.entrances.get({
+ acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "text"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000")
+```
+
+#### Response
+
+```python
+AcsEntrance(
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_entrance_id="123e4567-e89b-12d3-a456-426614174000",
+ created_at="2024-04-05T07:57:05.323Z",
+ display_name="text",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000")
+```
+
+#### Response
+
+```ruby
+{
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "text",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->entrances->get(
+ acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000"
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "text",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000"
+```
+
+#### Response
+
+```seam_cli
+{
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "text"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import entrances "github.com/seamapi/go/entrances"
+
+func main() {
+ client.Acs.Entrances.Get(
+ context.Background(),
+ entrances.EntrancesGetRequest{
+ AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+
+## Request Parameters
+
+### `acs_entrance_id`
+
+Type: `string`
+Required: Yes
+
+
+
+***
+
+## Return Type
+
+[acs\_entrance](./)
diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md
new file mode 100644
index 00000000..56c2c448
--- /dev/null
+++ b/docs/api/acs/entrances/grant_access.md
@@ -0,0 +1,36 @@
+# Grant an ACS User Access to an Entrance
+
+```
+POST /acs/entrances/grant_access ⇒ void
+```
+
+
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_entrance_id`
+
+Type: `string`
+Required: Yes
+
+
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md
new file mode 100644
index 00000000..7a29fc8b
--- /dev/null
+++ b/docs/api/acs/entrances/list.md
@@ -0,0 +1,165 @@
+# List Entrances
+
+```
+POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }
+```
+
+Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.entrances.list();
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "text"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.entrances.list()
+```
+
+#### Response
+
+```python
+[
+ AcsEntrance(
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_entrance_id="123e4567-e89b-12d3-a456-426614174000",
+ created_at="2024-04-05T07:57:05.323Z",
+ display_name="text",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.entrances.list()
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "text",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->entrances->list();
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "text",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs entrances list
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "text"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+func main() {
+ client.Acs.Entrances.List(context.Background())
+}
+```
+
+#### Response
+
+```go
+[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_id`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+### `acs_system_id`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+## Return Type
+
+Array<[acs\_entrance](./)>
diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md
new file mode 100644
index 00000000..231dd2bb
--- /dev/null
+++ b/docs/api/acs/entrances/list_credentials_with_access.md
@@ -0,0 +1,262 @@
+# List Credentials with Access to an Entrance
+
+```
+POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] }
+```
+
+Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.entrances.listCredentialsWithAccess({
+ acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
+ "display_name": "text",
+ "code": "text",
+ "card_number": "text",
+ "is_issued": false,
+ "issued_at": "2024-10-15T12:54:04.155Z",
+ "access_method": "code",
+ "external_type": "pti_card",
+ "external_type_display_name": "text",
+ "created_at": "2024-10-15T12:54:04.155Z",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "starts_at": "text",
+ "ends_at": "text",
+ "is_multi_phone_sync_credential": false,
+ "is_latest_desired_state_synced_with_provider": false,
+ "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.entrances.list_credentials_with_access(
+ acs_entrance_id="123e4567-e89b-12d3-a456-426614174000"
+)
+```
+
+#### Response
+
+```python
+[
+ AcsCredential(
+ acs_credential_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_user_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000",
+ display_name="text",
+ code="text",
+ card_number="text",
+ is_issued=false,
+ issued_at="2024-10-15T12:54:04.155Z",
+ access_method="code",
+ external_type="pti_card",
+ external_type_display_name="text",
+ created_at="2024-10-15T12:54:04.155Z",
+ workspace_id="123e4567-e89b-12d3-a456-426614174000",
+ starts_at="text",
+ ends_at="text",
+ is_multi_phone_sync_credential=false,
+ is_latest_desired_state_synced_with_provider=false,
+ latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.entrances.list_credentials_with_access(
+ acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000",
+)
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "display_name" => "text",
+ "code" => "text",
+ "card_number" => "text",
+ "is_issued" => false,
+ "issued_at" => "2024-10-15T12:54:04.155Z",
+ "access_method" => "code",
+ "external_type" => "pti_card",
+ "external_type_display_name" => "text",
+ "created_at" => "2024-10-15T12:54:04.155Z",
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "starts_at" => "text",
+ "ends_at" => "text",
+ "is_multi_phone_sync_credential" => false,
+ "is_latest_desired_state_synced_with_provider" => false,
+ "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->entrances->list_credentials_with_access(
+ acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000"
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "display_name" => "text",
+ "code" => "text",
+ "card_number" => "text",
+ "is_issued" => false,
+ "issued_at" => "2024-10-15T12:54:04.155Z",
+ "access_method" => "code",
+ "external_type" => "pti_card",
+ "external_type_display_name" => "text",
+ "created_at" => "2024-10-15T12:54:04.155Z",
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "starts_at" => "text",
+ "ends_at" => "text",
+ "is_multi_phone_sync_credential" => false,
+ "is_latest_desired_state_synced_with_provider" => false,
+ "latest_desired_state_synced_with_provider_at" =>
+ "2024-10-15T12:54:04.155Z",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000",
+ "display_name": "text",
+ "code": "text",
+ "card_number": "text",
+ "is_issued": false,
+ "issued_at": "2024-10-15T12:54:04.155Z",
+ "access_method": "code",
+ "external_type": "pti_card",
+ "external_type_display_name": "text",
+ "created_at": "2024-10-15T12:54:04.155Z",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "starts_at": "text",
+ "ends_at": "text",
+ "is_multi_phone_sync_credential": false,
+ "is_latest_desired_state_synced_with_provider": false,
+ "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import entrances "github.com/seamapi/go/entrances"
+
+func main() {
+ client.Acs.Entrances.ListCredentialsWithAccess(
+ context.Background(),
+ entrances.EntrancesListCredentialsWithAccessRequest{
+ AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `acs_entrance_id`
+
+Type: `string`
+Required: Yes
+
+
+
+***
+
+### `include_if`
+
+Type: `array`
+Required: No
+
+
+
+***
+
+## Return Type
+
+Array<[acs\_credential](./)>
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index 3fc2f792..fe0af97f 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -1,8 +1,8 @@
-# `acs_system`
+# Systems
-Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+## `acs_system`
-## Properties
+Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
### `acs_system_id`
@@ -47,10 +47,23 @@ Format: `Boolean`
Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences.md#access-group-based-access-control-systems).
+---
+
+### `connected_account_id`
+
+Format: `ID`
+
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the `acs_system`.
+
+
---
### `connected_account_ids`
+{% hint style="warning" %}
+**Deprecated**. Use `connected_account_id`.
+{% endhint %}
+
Format: `List`
IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the `acs_system`.
@@ -65,6 +78,15 @@ Format: `Datetime`
Date and time at which the `acs_system` was created.
+---
+
+### `default_credential_manager_acs_system_id`
+
+Format: `ID`
+
+ID of the default credential manager acs_system for this access control system.
+
+
---
### `errors`
@@ -85,12 +107,17 @@ Brand-specific terminology for the `acs_system` type.
Possible enum values:
- `pti_site`
- `alta_org`
-- `salto_site`
+- `salto_ks_site`
+- `salto_space_system`
- `brivo_account`
- `hid_credential_manager_organization`
- `visionline_system`
- `assa_abloy_credential_service`
- `latch_building`
+- `dormakaba_community_site`
+- `legic_connect_credential_service`
+- `assa_abloy_vostio`
+- `assa_abloy_vostio_credential_service`
---
@@ -120,6 +147,30 @@ Format: `String`
URL for the image that represents the `acs_system`.
+---
+
+### `is_credential_manager`
+
+Format: `Boolean`
+
+Indicates if the `acs_system` is a credential manager.
+
+
+---
+
+### `location`
+
+Format: `Object`
+
+profiles Format: list
+
+
+
+
+
+
+Time zone in which the `acs_system` is located.
+
+
+
+
---
### `name`
@@ -142,12 +193,17 @@ Format: `Enum`
Possible enum values:
- `pti_site`
- `alta_org`
-- `salto_site`
+- `salto_ks_site`
+- `salto_space_system`
- `brivo_account`
- `hid_credential_manager_organization`
- `visionline_system`
- `assa_abloy_credential_service`
- `latch_building`
+- `dormakaba_community_site`
+- `legic_connect_credential_service`
+- `assa_abloy_vostio`
+- `assa_abloy_vostio_credential_service`
---
@@ -168,18 +224,30 @@ Format: `String`
Format: `Object`
time_zone Format: string
+
+Time zone in which the `acs_system` is located.
+
+
-lan_address
+
+
+
IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.
+
+
lan_address string
+
+lan_address Format: string
+
IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network.
+
-mobile_access_uuid
+
+
+
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
+
+
mobile_access_uuid string
+
+mobile_access_uuid Format: string
+
Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
+
-system_id
+
+
+
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+
+
---
### `warnings`
@@ -200,15 +268,15 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains
---
-# Endpoints
+## Endpoints
-## [`/acs/systems/get`](./get.md)
+### [`/acs/systems/get`](./get.md)
Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-## [`/acs/systems/list`](./list.md)
+### [`/acs/systems/list`](./list.md)
Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
-## [`/acs/systems/list_compatible_credential_manager_acs_systems`](./list_compatible_credential_manager_acs_systems.md)
+### [`/acs/systems/list_compatible_credential_manager_acs_systems`](./list_compatible_credential_manager_acs_systems.md)
-Returns a list of all credential manager ACS systems that are compatible with a specified
+Returns a list of all credential manager ACS systems that are compatible with a specified
[access control system](https://docs.seam.co/latest/capability-guides/access-systems).
diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md
index 5134aee5..4abe0d5d 100644
--- a/docs/api/acs/systems/get.md
+++ b/docs/api/acs/systems/get.md
@@ -49,7 +49,7 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
#### Response
```ruby
-[{"acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}]
+[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
```
{% endtab %}
@@ -64,7 +64,8 @@ $seam->acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
#### Response
```php
-[["acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]
+ "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]];
```
{% endtab %}
@@ -82,13 +83,44 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
```
{% endtab %}
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import systems "github.com/seamapi/go/systems"
+
+func main() {
+ client.Acs.Systems.Get(
+ context.Background(),
+ systems.SystemsGetRequest{
+ AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}}
+```
+{% endtab %}
+
{% endtabs %}
+## Authentication Methods
+
+- API key
+- Personal access token
+
## Request Parameters
### `acs_system_id`
-Type: `string`\
+Type: `string`
Required: Yes
ID of the desired access control system.
diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md
index 77adad3c..385c3087 100644
--- a/docs/api/acs/systems/list.md
+++ b/docs/api/acs/systems/list.md
@@ -6,8 +6,8 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
-To filter the list of returned access control 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
+To filter the list of returned access control 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 control systems connected to your workspace.
{% tabs %}
@@ -51,7 +51,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400
#### Response
```ruby
-[{"acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}]
+[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }]
```
{% endtab %}
@@ -68,7 +68,8 @@ $seam->acs->systems->list(
#### Response
```php
-[["acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]
+ "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]];
```
{% endtab %}
@@ -86,13 +87,45 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740
```
{% endtab %}
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import systems "github.com/seamapi/go/systems"
+
+func main() {
+ client.Acs.Systems.List(
+ context.Background(),
+ systems.SystemsListRequest{
+ ConnectedAccountId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}}
+```
+{% endtab %}
+
{% endtabs %}
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
## Request Parameters
### `connected_account_id`
-Type: `string`\
+Type: `string`
Required: No
ID of the connected account by which to filter the list of returned access control systems.
diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
index d5711dc3..70ccf581 100644
--- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
+++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
@@ -4,10 +4,10 @@
POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] }
```
-Returns a list of all credential manager ACS systems that are compatible with a specified
+Returns a list of all credential manager ACS systems that are compatible with a specified
[access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-Specify the ACS system for which you want to retrieve all compatible credential manager ACS
+Specify the ACS system for which you want to retrieve all compatible credential manager ACS
systems by including the corresponding `acs_system_id` in the request body.
{% tabs %}
@@ -47,13 +47,15 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems(
#### Request
```ruby
-seam.acs.systems.list_compatible_credential_manager_acs_systems(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+seam.acs.systems.list_compatible_credential_manager_acs_systems(
+ acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+)
```
#### Response
```ruby
-[{"acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}]
+[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }]
```
{% endtab %}
@@ -70,7 +72,8 @@ $seam->acs->systems->list_compatible_credential_manager_acs_systems(
#### Response
```php
-[["acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]]
+ "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]];
```
{% endtab %}
@@ -88,13 +91,44 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id
```
{% endtab %}
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import systems "github.com/seamapi/go/systems"
+
+func main() {
+ client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems(
+ context.Background(),
+ systems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{
+ AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}}
+```
+{% endtab %}
+
{% endtabs %}
+## Authentication Methods
+
+- API key
+- Personal access token
+
## Request Parameters
### `acs_system_id`
-Type: `string`\
+Type: `string`
Required: Yes
ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
new file mode 100644
index 00000000..390a84da
--- /dev/null
+++ b/docs/api/acs/users/README.md
@@ -0,0 +1,252 @@
+# ACS Users
+
+## `acs_user`
+
+Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+### `access_schedule`
+
+Format: `Object`
+
+`starts_at` and `ends_at` timestamps for the `acs_user`'s access.
+
+system_id string
+
+system_id Format: string
+
Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+
+
+
+
+Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+
+ends_at Format: datetime
+
+Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+
+
+
+Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+
+
+---
+
+### `acs_system_id`
+
+Format: `ID`
+
+ID of the access control system that contains the `acs_user`.
+
+
+---
+
+### `acs_user_id`
+
+Format: `ID`
+
+ID of the `acs_user`.
+
+
+---
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the `acs_user` was created.
+
+
+---
+
+### `display_name`
+
+Format: `String`
+
+Display name for the `acs_user`.
+
+
+---
+
+### `email`
+
+{% hint style="warning" %}
+**Deprecated**. use email_address.
+{% endhint %}
+
+Format: `String`
+
+
+---
+
+### `email_address`
+
+Format: `String`
+
+Email address of the `acs_user`.
+
+
+---
+
+### `errors`
+
+Format: `List`
+
+Errors associated with the `acs_user`.
+
+
+---
+
+### `external_type`
+
+Format: `Enum`
+
+Brand-specific terminology for the `acs_user` type.
+
+Possible enum values:
+- `pti_user`
+- `brivo_user`
+- `hid_credential_manager_user`
+- `salto_site_user`
+- `latch_user`
+- `dormakaba_community_user`
+
+
+---
+
+### `external_type_display_name`
+
+Format: `String`
+
+Display name that corresponds to the brand-specific terminology for the `acs_user` type.
+
+
+---
+
+### `full_name`
+
+Format: `String`
+
+Full name of the `acs_user`.
+
+
+---
+
+### `hid_acs_system_id`
+
+Format: `ID`
+
+
+---
+
+### `is_managed`
+
+Format: `Boolean`
+
+
+---
+
+### `is_suspended`
+
+Format: `Boolean`
+
+Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).
+
+
+---
+
+### `phone_number`
+
+Format: `String`
+
+Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).
+
+
+---
+
+### `user_identity_email_address`
+
+Format: `String`
+
+Email address of the user identity associated with the `acs_user`.
+
+
+---
+
+### `user_identity_full_name`
+
+Format: `String`
+
+Full name of the user identity associated with the `acs_user`.
+
+
+---
+
+### `user_identity_id`
+
+Format: `String`
+
+ID of the user identity associated with the `acs_user`.
+
+
+---
+
+### `user_identity_phone_number`
+
+Format: `String`
+
+Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).
+
+
+---
+
+### `warnings`
+
+Format: `List`
+
+Warnings associated with the `acs_user`.
+
+
+---
+
+### `workspace_id`
+
+Format: `ID`
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the `acs_user`.
+
+
+---
+
+## Endpoints
+
+### [`/acs/users/add_to_access_group`](./add_to_access_group.md)
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+### [`/acs/users/create`](./create.md)
+
+Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+### [`/acs/users/delete`](./delete.md)
+
+Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md).
+### [`/acs/users/get`](./get.md)
+
+Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+### [`/acs/users/list`](./list.md)
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+### [`/acs/users/list_accessible_entrances`](./list_accessible_entrances.md)
+
+Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.
+### [`/acs/users/remove_from_access_group`](./remove_from_access_group.md)
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+### [`/acs/users/revoke_access_to_all_entrances`](./revoke_access_to_all_entrances.md)
+
+Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+### [`/acs/users/suspend`](./suspend.md)
+
+[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.
+### [`/acs/users/unsuspend`](./unsuspend.md)
+
+[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.
+### [`/acs/users/update`](./update.md)
+
+Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md
new file mode 100644
index 00000000..23cbb040
--- /dev/null
+++ b/docs/api/acs/users/add_to_access_group.md
@@ -0,0 +1,149 @@
+# Add an ACS User to an Access Group
+
+```
+PUT /acs/users/add_to_access_group ⇒ void
+```
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.addToAccessGroup({
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.add_to_access_group(
+ acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id="123e4567-e89b-12d3-a456-426614174000",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.add_to_access_group(
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->add_to_access_group(
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.AddToAccessGroup(
+ context.Background(),
+ users.UsersAddToAccessGroupRequest{
+ AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_access_group_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired access group.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md
new file mode 100644
index 00000000..39762776
--- /dev/null
+++ b/docs/api/acs/users/create.md
@@ -0,0 +1,269 @@
+# Create an ACS User
+
+```
+POST /acs/users/create ⇒ { acs_user }
+```
+
+Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.create({
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
+});
+```
+
+#### Response
+
+```javascript
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids": ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.create(
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+ acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
+)
+```
+
+#### Response
+
+```python
+AcsUser(
+ acs_user_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
+ workspace_id="123e4567-e89b-12d3-a456-426614174000",
+ created_at="2024-04-05T07:57:05.323Z",
+ display_name="Jane Doe",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.create(
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
+)
+```
+
+#### Response
+
+```ruby
+{
+ "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids" => ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->create(
+ acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
+ full_name: "Jane Doe",
+ email_address: "jane@example.com",
+ phone_number: "+15555550100",
+ acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"]
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids" => ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"]
+```
+
+#### Response
+
+```seam_cli
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids": ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Create(
+ context.Background(),
+ users.UsersCreateRequest{
+ AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ FullName: api.String("Jane Doe"),
+ EmailAddress: api.String("jane@example.com"),
+ PhoneNumber: api.String("+15555550100"),
+ AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")},
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsAccessGroupIds: []string{"123e4567-e89b-12d3-a456-426614174000"}, WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `access_schedule`
+
+Type: `object`
+Required: No
+
+`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`.
+
+***
+
+### `acs_access_group_ids`
+
+Type: `array`
+Required: No
+
+Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.
+
+***
+
+### `acs_system_id`
+
+Type: `string`
+Required: Yes
+
+ID of the `acs_system` to which to add the new `acs_user`.
+
+***
+
+### `email`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+### `email_address`
+
+Type: `string`
+Required: No
+
+Email address of the `acs_user`.
+
+***
+
+### `full_name`
+
+Type: `string`
+Required: Yes
+
+Full name of the new `acs_user`.
+
+***
+
+### `phone_number`
+
+Type: `string`
+Required: No
+
+Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: No
+
+ID of the user identity with which to associate the new `acs_user`.
+
+***
+
+## Return Type
+
+[acs\_user](./)
diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md
new file mode 100644
index 00000000..a317a842
--- /dev/null
+++ b/docs/api/acs/users/delete.md
@@ -0,0 +1,129 @@
+# Delete an ACS User
+
+```
+POST /acs/users/delete ⇒ void
+```
+
+Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.delete({
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Delete(
+ context.Background(),
+ users.UsersDeleteRequest{
+ AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md
new file mode 100644
index 00000000..c698bc7b
--- /dev/null
+++ b/docs/api/acs/users/get.md
@@ -0,0 +1,180 @@
+# Get an ACS User
+
+```
+POST /acs/users/get ⇒ { acs_user }
+```
+
+Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.get({
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids": ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```python
+AcsUser(
+ acs_user_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
+ workspace_id="123e4567-e89b-12d3-a456-426614174000",
+ created_at="2024-04-05T07:57:05.323Z",
+ display_name="Jane Doe",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```ruby
+{
+ "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids" => ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids" => ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
+```
+
+#### Response
+
+```seam_cli
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids": ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Get(
+ context.Background(),
+ users.UsersGetRequest{
+ AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsAccessGroupIds: []string{"123e4567-e89b-12d3-a456-426614174000"}, WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+[acs\_user](./)
diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md
new file mode 100644
index 00000000..62d39922
--- /dev/null
+++ b/docs/api/acs/users/list.md
@@ -0,0 +1,216 @@
+# List ACS Users
+
+```
+POST /acs/users/list ⇒ { acs_users: [acs_user, …] }
+```
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.list();
+```
+
+#### Response
+
+```javascript
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids": ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.list()
+```
+
+#### Response
+
+```python
+AcsUser(
+ acs_user_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_system_id="123e4567-e89b-12d3-a456-426614174000",
+ acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
+ workspace_id="123e4567-e89b-12d3-a456-426614174000",
+ created_at="2024-04-05T07:57:05.323Z",
+ display_name="Jane Doe",
+ full_name="Jane Doe",
+ email_address="jane@example.com",
+ phone_number="+15555550100",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.list()
+```
+
+#### Response
+
+```ruby
+{
+ "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids" => ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->list();
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids" => ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ "display_name" => "Jane Doe",
+ "full_name" => "Jane Doe",
+ "email_address" => "jane@example.com",
+ "phone_number" => "+15555550100",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users list
+```
+
+#### Response
+
+```seam_cli
+{
+ "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
+ "acs_access_group_ids": ["123e4567-e89b-12d3-a456-426614174000"],
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ "display_name": "Jane Doe",
+ "full_name": "Jane Doe",
+ "email_address": "jane@example.com",
+ "phone_number": "+15555550100"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+func main() {
+ client.Acs.Users.List(context.Background())
+}
+```
+
+#### Response
+
+```go
+api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsAccessGroupIds: []string{"123e4567-e89b-12d3-a456-426614174000"}, WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `acs_system_id`
+
+Type: `string`
+Required: No
+
+ID of the `acs_system` for which you want to retrieve all `acs_user`s.
+
+***
+
+### `created_before`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+### `limit`
+
+Type: `number`
+Required: No
+
+
+
+***
+
+### `user_identity_email_address`
+
+Type: `string`
+Required: No
+
+Email address of the user identity for which you want to retrieve all `acs_user`s.
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: No
+
+ID of the user identity for which you want to retrieve all `acs_user`s.
+
+***
+
+### `user_identity_phone_number`
+
+Type: `string`
+Required: No
+
+Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).
+
+***
+
+## Return Type
+
+Array<[acs\_user](./)>
diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md
new file mode 100644
index 00000000..71937db7
--- /dev/null
+++ b/docs/api/acs/users/list_accessible_entrances.md
@@ -0,0 +1,28 @@
+# List ACS User-Accessible Entrances
+
+```
+POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] }
+```
+
+Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+Array<[acs\_entrance](./)>
diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md
new file mode 100644
index 00000000..97d9c9ac
--- /dev/null
+++ b/docs/api/acs/users/remove_from_access_group.md
@@ -0,0 +1,149 @@
+# Remove an ACS User from an Access Group
+
+```
+POST /acs/users/remove_from_access_group ⇒ void
+```
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.removeFromAccessGroup({
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.remove_from_access_group(
+ acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id="123e4567-e89b-12d3-a456-426614174000",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.remove_from_access_group(
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->remove_from_access_group(
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.RemoveFromAccessGroup(
+ context.Background(),
+ users.UsersRemoveFromAccessGroupRequest{
+ AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_access_group_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired access group.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md
new file mode 100644
index 00000000..f355e7c4
--- /dev/null
+++ b/docs/api/acs/users/revoke_access_to_all_entrances.md
@@ -0,0 +1,27 @@
+# Revoke ACS User Access to All Entrances
+
+```
+POST /acs/users/revoke_access_to_all_entrances ⇒ void
+```
+
+Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md
new file mode 100644
index 00000000..cbbb09b3
--- /dev/null
+++ b/docs/api/acs/users/suspend.md
@@ -0,0 +1,129 @@
+# Suspend an ACS User
+
+```
+POST /acs/users/suspend ⇒ void
+```
+
+[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.suspend({
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33");
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Suspend(
+ context.Background(),
+ users.UsersSuspendRequest{
+ AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md
new file mode 100644
index 00000000..88a38975
--- /dev/null
+++ b/docs/api/acs/users/unsuspend.md
@@ -0,0 +1,131 @@
+# Unsuspend an ACS User
+
+```
+POST /acs/users/unsuspend ⇒ void
+```
+
+[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.unsuspend({
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->unsuspend(
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Unsuspend(
+ context.Background(),
+ users.UsersUnsuspendRequest{
+ AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired `acs_user`.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md
new file mode 100644
index 00000000..8e5f6aed
--- /dev/null
+++ b/docs/api/acs/users/update.md
@@ -0,0 +1,193 @@
+# Update an ACS User
+
+```
+PATCH /acs/users/update ⇒ void
+```
+
+Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.acs.users.update({
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ phone_number: "+15555550222",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.acs.users.update(
+ acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="+15555550222"
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.acs.users.update(
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ phone_number: "+15555550222",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+acs->users->update(
+ acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33",
+ phone_number: "+15555550222"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import users "github.com/seamapi/go/users"
+
+func main() {
+ client.Acs.Users.Update(
+ context.Background(),
+ users.UsersUpdateRequest{
+ AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"),
+ PhoneNumber: api.String("+15555550222"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `access_schedule`
+
+Type: `object`
+Required: No
+
+`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.
+
+***
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the `acs_user`.
+
+***
+
+### `email`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+### `email_address`
+
+Type: `string`
+Required: No
+
+Email address of the `acs_user`.
+
+***
+
+### `full_name`
+
+Type: `string`
+Required: No
+
+Full name of the `acs_user`.
+
+***
+
+### `hid_acs_system_id`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+### `phone_number`
+
+Type: `string`
+Required: No
+
+Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md
new file mode 100644
index 00000000..66d5e32c
--- /dev/null
+++ b/docs/api/thermostats/README.md
@@ -0,0 +1,43 @@
+# Thermostats
+
+## Endpoints
+
+### [`/thermostats/activate_climate_preset`](./activate_climate_preset.md)
+
+Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/cool`](./cool.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+### [`/thermostats/create_climate_preset`](./create_climate_preset.md)
+
+Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/delete_climate_preset`](./delete_climate_preset.md)
+
+Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/heat`](./heat.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+### [`/thermostats/heat_cool`](./heat_cool.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+### [`/thermostats/list`](./list.md)
+
+Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/off`](./off.md)
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+### [`/thermostats/set_fallback_climate_preset`](./set_fallback_climate_preset.md)
+
+Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/set_fan_mode`](./set_fan_mode.md)
+
+Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/set_hvac_mode`](./set_hvac_mode.md)
+
+Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/set_temperature_threshold`](./set_temperature_threshold.md)
+
+Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) 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.
+### [`/thermostats/update_climate_preset`](./update_climate_preset.md)
+
+Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
new file mode 100644
index 00000000..e236ce00
--- /dev/null
+++ b/docs/api/thermostats/activate_climate_preset.md
@@ -0,0 +1,168 @@
+# Activate a Climate Preset
+
+```
+POST /thermostats/activate_climate_preset ⇒ { action_attempt }
+```
+
+Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.activateClimatePreset({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20",
+ "status": "pending",
+ "action_type": "ACTIVATE_CLIMATE_PRESET"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.activate_climate_preset(
+ device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied"
+)
+```
+
+#### Response
+
+```python
+ActionAttempt(
+ action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20",
+ status="pending",
+ action_type="ACTIVATE_CLIMATE_PRESET",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.activate_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+)
+```
+
+#### Response
+
+```ruby
+{
+ "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20",
+ "status" => "pending",
+ "action_type" => "ACTIVATE_CLIMATE_PRESET",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->activate_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied"
+);
+```
+
+#### Response
+
+```php
+ "05de2295-d1dc-4748-aae3-9931658bde20",
+ "status" => "pending",
+ "action_type" => "ACTIVATE_CLIMATE_PRESET",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied"
+```
+
+#### Response
+
+```seam_cli
+{
+ "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20",
+ "status": "pending",
+ "action_type": "ACTIVATE_CLIMATE_PRESET"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.ActivateClimatePreset(
+ context.Background(),
+ api.ThermostatsActivateClimatePresetRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ ClimatePresetKey: api.String("occupied"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `climate_preset_key`
+
+Type: `string`
+Required: Yes
+
+Climate preset key of the desired climate preset.
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+## Return Type
+
+[action\_attempt](./)
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
new file mode 100644
index 00000000..b4a507f0
--- /dev/null
+++ b/docs/api/thermostats/cool.md
@@ -0,0 +1,178 @@
+# Set to Cool Mode
+
+```
+POST /thermostats/cool ⇒ { action_attempt }
+```
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.cool({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ cooling_set_point_celsius: 25,
+});
+```
+
+#### Response
+
+```javascript
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_COOL"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.cool(
+ device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25
+)
+```
+
+#### Response
+
+```python
+ActionAttempt(
+ action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
+ status="pending",
+ action_type="SET_COOL",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.cool(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ cooling_set_point_celsius: 25,
+)
+```
+
+#### Response
+
+```ruby
+{
+ "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_COOL",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->cool(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ cooling_set_point_celsius: 25
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_COOL",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25
+```
+
+#### Response
+
+```seam_cli
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_COOL"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.Cool(
+ context.Background(),
+ api.ThermostatsCoolRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ CoolingSetPointCelsius: api.Float64(25),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `cooling_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
+
+***
+
+### `cooling_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+## Return Type
+
+[action\_attempt](./)
diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md
new file mode 100644
index 00000000..36f83d5c
--- /dev/null
+++ b/docs/api/thermostats/create_climate_preset.md
@@ -0,0 +1,250 @@
+# Create a Climate Preset
+
+```
+POST /thermostats/create_climate_preset ⇒ void
+```
+
+Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.createClimatePreset({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+ name: "Occupied",
+ fan_mode_setting: "auto",
+ hvac_mode_setting: "heat_cool",
+ cooling_set_point_celsius: 25,
+ heating_set_point_celsius: 20,
+ manual_override_allowed: true,
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.create_climate_preset(
+ device_id="123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key="occupied",
+ name="Occupied",
+ fan_mode_setting="auto",
+ hvac_mode_setting="heat_cool",
+ cooling_set_point_celsius=25,
+ heating_set_point_celsius=20,
+ manual_override_allowed=true,
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.create_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+ name: "Occupied",
+ fan_mode_setting: "auto",
+ hvac_mode_setting: "heat_cool",
+ cooling_set_point_celsius: 25,
+ heating_set_point_celsius: 20,
+ manual_override_allowed: true,
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->create_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+ name: "Occupied",
+ fan_mode_setting: "auto",
+ hvac_mode_setting: "heat_cool",
+ cooling_set_point_celsius: 25,
+ heating_set_point_celsius: 20,
+ manual_override_allowed: true
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.CreateClimatePreset(
+ context.Background(),
+ api.ThermostatsCreateClimatePresetRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ ClimatePresetKey: api.String("occupied"),
+ Name: api.String("Occupied"),
+ FanModeSetting: api.String("auto"),
+ HvacModeSetting: api.String("heat_cool"),
+ CoolingSetPointCelsius: api.Float64(25),
+ HeatingSetPointCelsius: api.Float64(20),
+ ManualOverrideAllowed: api.Bool(true),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `climate_preset_key`
+
+Type: `string`
+Required: Yes
+
+Unique key to identify the climate preset.
+
+***
+
+### `cooling_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+***
+
+### `cooling_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should cool (in °F).
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+### `fan_mode_setting`
+
+Type: `string`
+Required: No
+
+Desired fan mode setting, such as `on`, `auto`, or `circulate`.
+
+***
+
+### `heating_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should heat (in °C).
+
+***
+
+### `heating_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should heat (in °F).
+
+***
+
+### `hvac_mode_setting`
+
+Type: `string`
+Required: No
+
+Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+
+***
+
+### `manual_override_allowed`
+
+Type: `boolean`
+Required: No
+
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
+
+***
+
+### `name`
+
+Type: `string`
+Required: No
+
+User-friendly name to identify the climate preset.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md
new file mode 100644
index 00000000..06b8c357
--- /dev/null
+++ b/docs/api/thermostats/delete_climate_preset.md
@@ -0,0 +1,147 @@
+# Delete a Climate Preset
+
+```
+POST /thermostats/delete_climate_preset ⇒ void
+```
+
+Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.deleteClimatePreset({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.delete_climate_preset(
+ device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied"
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.delete_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->delete_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.DeleteClimatePreset(
+ context.Background(),
+ api.ThermostatsDeleteClimatePresetRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ ClimatePresetKey: api.String("occupied"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `climate_preset_key`
+
+Type: `string`
+Required: Yes
+
+Climate preset key of the desired climate preset.
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
new file mode 100644
index 00000000..8dbed036
--- /dev/null
+++ b/docs/api/thermostats/heat.md
@@ -0,0 +1,178 @@
+# Set to Heat Mode
+
+```
+POST /thermostats/heat ⇒ { action_attempt }
+```
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.heat({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ heating_set_point_celsius: 20,
+});
+```
+
+#### Response
+
+```javascript
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_HEAT"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.heat(
+ device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20
+)
+```
+
+#### Response
+
+```python
+ActionAttempt(
+ action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
+ status="pending",
+ action_type="SET_HEAT",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.heat(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ heating_set_point_celsius: 20,
+)
+```
+
+#### Response
+
+```ruby
+{
+ "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_HEAT",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->heat(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ heating_set_point_celsius: 20
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_HEAT",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20
+```
+
+#### Response
+
+```seam_cli
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_HEAT"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.Heat(
+ context.Background(),
+ api.ThermostatsHeatRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ HeatingSetPointCelsius: api.Float64(20),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+### `heating_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
+
+***
+
+### `heating_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
+
+***
+
+## Return Type
+
+[action\_attempt](./)
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
new file mode 100644
index 00000000..fb3c43ea
--- /dev/null
+++ b/docs/api/thermostats/heat_cool.md
@@ -0,0 +1,202 @@
+# Set to Heat-Cool (Auto) Mode
+
+```
+POST /thermostats/heat_cool ⇒ { action_attempt }
+```
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.heatCool({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ cooling_set_point_celsius: 25,
+ heating_set_point_celsius: 20,
+});
+```
+
+#### Response
+
+```javascript
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_HEAT_COOL"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.heat_cool(
+ device_id="123e4567-e89b-12d3-a456-426614174000",
+ cooling_set_point_celsius=25,
+ heating_set_point_celsius=20,
+)
+```
+
+#### Response
+
+```python
+ActionAttempt(
+ action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
+ status="pending",
+ action_type="SET_HEAT_COOL",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.heat_cool(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ cooling_set_point_celsius: 25,
+ heating_set_point_celsius: 20,
+)
+```
+
+#### Response
+
+```ruby
+{
+ "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_HEAT_COOL",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->heat_cool(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ cooling_set_point_celsius: 25,
+ heating_set_point_celsius: 20
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_HEAT_COOL",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20
+```
+
+#### Response
+
+```seam_cli
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_HEAT_COOL"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.HeatCool(
+ context.Background(),
+ api.ThermostatsHeatCoolRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ CoolingSetPointCelsius: api.Float64(25),
+ HeatingSetPointCelsius: api.Float64(20),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `cooling_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
+
+***
+
+### `cooling_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+### `heating_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
+
+***
+
+### `heating_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
+
+***
+
+## Return Type
+
+[action\_attempt](./)
diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md
new file mode 100644
index 00000000..a48160e5
--- /dev/null
+++ b/docs/api/thermostats/list.md
@@ -0,0 +1,322 @@
+# List Thermostats
+
+```
+POST /thermostats/list ⇒ { devices: [device, …] }
+```
+
+Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.list();
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "device_id": "123e4567-e89b-12d3-a456-426614174000",
+ "device_type": "ecobee_thermostat",
+ "capabilities_supported": ["thermostat"],
+ "properties": {
+ "name": "Entryway",
+ "online": "true,",
+ "relative_humidity": 0.36,
+ "temperature_farenheit": 70,
+ "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"],
+ "current_climate_setting": {
+ "hvac_mode_setting": "heat_cool",
+ "cooling_set_point_farenheit": 75,
+ "heating_set_point_farenheit": 65,
+ "manual_override_allowed": false
+ },
+ "location": null,
+ "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z"
+ }
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.list()
+```
+
+#### Response
+
+```python
+[
+ Device(
+ device_id="123e4567-e89b-12d3-a456-426614174000",
+ device_type="ecobee_thermostat",
+ capabilities_supported=["thermostat"],
+ properties={
+ "name": "Entryway",
+ "online": "true,",
+ "relative_humidity": 0.36,
+ "temperature_farenheit": 70,
+ "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"],
+ "current_climate_setting": {
+ "hvac_mode_setting": "heat_cool",
+ "cooling_set_point_farenheit": 75,
+ "heating_set_point_farenheit": 65,
+ "manual_override_allowed": false,
+ },
+ "location": null,
+ "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z",
+ },
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.list()
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "device_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "device_type" => "ecobee_thermostat",
+ "capabilities_supported" => ["thermostat"],
+ "properties" => {
+ name: "Entryway",
+ online: "true,",
+ relative_humidity: 0.36,
+ temperature_farenheit: 70,
+ available_hvac_mode_settings: %w[cool heat heat_cool off],
+ current_climate_setting: {
+ hvac_mode_setting: "heat_cool",
+ cooling_set_point_farenheit: 75,
+ heating_set_point_farenheit: 65,
+ manual_override_allowed: false,
+ },
+ location: null,
+ connected_account_id: "123e4567-e89b-12d3-a456-426614174000",
+ workspace_id: "123e4567-e89b-12d3-a456-426614174000",
+ created_at: "2024-04-05T07:57:05.323Z",
+ },
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->list();
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "device_type" => "ecobee_thermostat",
+ "capabilities_supported" => ["thermostat"],
+ "properties" => [
+ "name" => "Entryway",
+ "online" => "true,",
+ "relative_humidity" => 0.36,
+ "temperature_farenheit" => 70,
+ "available_hvac_mode_settings" => [
+ "cool",
+ "heat",
+ "heat_cool",
+ "off",
+ ],
+ "current_climate_setting" => [
+ "hvac_mode_setting" => "heat_cool",
+ "cooling_set_point_farenheit" => 75,
+ "heating_set_point_farenheit" => 65,
+ "manual_override_allowed" => false,
+ ],
+ "location" => null,
+ "connected_account_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "created_at" => "2024-04-05T07:57:05.323Z",
+ ],
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats list
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "device_id": "123e4567-e89b-12d3-a456-426614174000",
+ "device_type": "ecobee_thermostat",
+ "capabilities_supported": ["thermostat"],
+ "properties": {
+ "name": "Entryway",
+ "online": "true,",
+ "relative_humidity": 0.36,
+ "temperature_farenheit": 70,
+ "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"],
+ "current_climate_setting": {
+ "hvac_mode_setting": "heat_cool",
+ "cooling_set_point_farenheit": 75,
+ "heating_set_point_farenheit": 65,
+ "manual_override_allowed": false
+ },
+ "location": null,
+ "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
+ "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
+ "created_at": "2024-04-05T07:57:05.323Z"
+ }
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+func main() {
+ client.Thermostats.List(context.Background())
+}
+```
+
+#### Response
+
+```go
+[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `connect_webview_id`
+
+Type: `string`
+Required: No
+
+ID of the Connect Webview by which to filter devices.
+
+***
+
+### `connected_account_id`
+
+Type: `string`
+Required: No
+
+ID of the connected account by which to filter.
+
+***
+
+### `connected_account_ids`
+
+Type: `array`
+Required: No
+
+Array of IDs of the connected accounts by which to filter devices.
+
+***
+
+### `created_before`
+
+Type: `string`
+Required: No
+
+Date threshold for devices to return. If specified, returns only devices created before the specified date.
+
+***
+
+### `custom_metadata_has`
+
+Type: `object`
+Required: No
+
+Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.
+
+***
+
+### `device_ids`
+
+Type: `array`
+Required: No
+
+Array of device IDs by which to filter devices.
+
+***
+
+### `device_types`
+
+Type: `array`
+Required: No
+
+Array of device types by which to filter devices.
+
+***
+
+### `limit`
+
+Type: `number`
+Required: No
+
+Numerical limit on the number of devices to return.
+
+***
+
+### `manufacturer`
+
+Type: `string`
+Required: No
+
+Manufacturer by which to filter devices.
+
+***
+
+### `user_identifier_key`
+
+Type: `string`
+Required: No
+
+Your own internal user ID for the user by which to filter devices.
+
+***
+
+## Return Type
+
+Array<[device](./)>
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
new file mode 100644
index 00000000..0f4cb88b
--- /dev/null
+++ b/docs/api/thermostats/off.md
@@ -0,0 +1,150 @@
+# Set to Off Mode
+
+```
+POST /thermostats/off ⇒ { action_attempt }
+```
+
+Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.off({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_THERMOSTAT_OFF"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000")
+```
+
+#### Response
+
+```python
+ActionAttempt(
+ action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
+ status="pending",
+ action_type="SET_THERMOSTAT_OFF",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000")
+```
+
+#### Response
+
+```ruby
+{
+ "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_THERMOSTAT_OFF",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000");
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_THERMOSTAT_OFF",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000"
+```
+
+#### Response
+
+```seam_cli
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_THERMOSTAT_OFF"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.Off(
+ context.Background(),
+ api.ThermostatsOffRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+## Return Type
+
+[action\_attempt](./)
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md
new file mode 100644
index 00000000..8bcf1ce2
--- /dev/null
+++ b/docs/api/thermostats/schedules/README.md
@@ -0,0 +1,95 @@
+# Thermostat Schedules
+
+## `thermostat_schedule`
+
+Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
+
+### `climate_preset_key`
+
+Format: `String`
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
+
+
+---
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the thermostat schedule was created.
+
+
+---
+
+### `device_id`
+
+Format: `ID`
+
+ID of the desired thermostat device.
+
+
+---
+
+### `ends_at`
+
+Format: `Datetime`
+
+Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+---
+
+### `max_override_period_minutes`
+
+Format: `Number`
+
+Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+
+---
+
+### `name`
+
+Format: `String`
+
+User-friendly name to identify the thermostat schedule.
+
+
+---
+
+### `starts_at`
+
+Format: `Datetime`
+
+Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
+---
+
+### `thermostat_schedule_id`
+
+Format: `ID`
+
+ID of the thermostat schedule.
+
+
+---
+
+## Endpoints
+
+### [`/thermostats/schedules/create`](./create.md)
+
+Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/schedules/delete`](./delete.md)
+
+Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/schedules/get`](./get.md)
+
+Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+### [`/thermostats/schedules/list`](./list.md)
+
+Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+### [`/thermostats/schedules/update`](./update.md)
+
+Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md
new file mode 100644
index 00000000..d0e42ea4
--- /dev/null
+++ b/docs/api/thermostats/schedules/create.md
@@ -0,0 +1,256 @@
+# Create a Thermostat Schedule
+
+```
+POST /thermostats/schedules/create ⇒ { thermostat_schedule }
+```
+
+Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.schedules.create({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ name: "Reservation 1",
+ climate_preset_key: "occupied",
+ starts_at: "2024-11-01T15:00:00Z",
+ ends_at: "2024-11-05T12:00:00Z",
+ max_override_period_minutes: 90,
+});
+```
+
+#### Response
+
+```javascript
+{
+ "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a",
+ "name": "Reservation 1",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-01T15:00:00.000Z",
+ "ends_at": "2024-11-05T12:00:00.000Z",
+ "max_override_period_minutes": 90
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.schedules.create(
+ device_id="123e4567-e89b-12d3-a456-426614174000",
+ name="Reservation 1",
+ climate_preset_key="occupied",
+ starts_at="2024-11-01T15:00:00Z",
+ ends_at="2024-11-05T12:00:00Z",
+ max_override_period_minutes=90,
+)
+```
+
+#### Response
+
+```python
+ThermostatSchedule(
+ thermostat_schedule_id="56d29fcf-0674-4db5-8e03-b2370a77460a",
+ name="Reservation 1",
+ device_id="2d488679-6f07-4810-aed2-e726872c1dd5",
+ climate_preset_key="occupied",
+ starts_at="2024-11-01T15:00:00.000Z",
+ ends_at="2024-11-05T12:00:00.000Z",
+ max_override_period_minutes=90,
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.schedules.create(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ name: "Reservation 1",
+ climate_preset_key: "occupied",
+ starts_at: "2024-11-01T15:00:00Z",
+ ends_at: "2024-11-05T12:00:00Z",
+ max_override_period_minutes: 90,
+)
+```
+
+#### Response
+
+```ruby
+{
+ "thermostat_schedule_id" => "56d29fcf-0674-4db5-8e03-b2370a77460a",
+ "name" => "Reservation 1",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-01T15:00:00.000Z",
+ "ends_at" => "2024-11-05T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->schedules->create(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ name: "Reservation 1",
+ climate_preset_key: "occupied",
+ starts_at: "2024-11-01T15:00:00Z",
+ ends_at: "2024-11-05T12:00:00Z",
+ max_override_period_minutes: 90
+);
+```
+
+#### Response
+
+```php
+ "56d29fcf-0674-4db5-8e03-b2370a77460a",
+ "name" => "Reservation 1",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-01T15:00:00.000Z",
+ "ends_at" => "2024-11-05T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90
+```
+
+#### Response
+
+```seam_cli
+{
+ "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a",
+ "name": "Reservation 1",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-01T15:00:00.000Z",
+ "ends_at": "2024-11-05T12:00:00.000Z",
+ "max_override_period_minutes": 90
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import schedules "github.com/seamapi/go/schedules"
+
+func main() {
+ client.Thermostats.Schedules.Create(
+ context.Background(),
+ schedules.SchedulesCreateRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ Name: api.String("Reservation 1"),
+ ClimatePresetKey: api.String("occupied"),
+ StartsAt: api.String("2024-11-01T15:00:00Z"),
+ EndsAt: api.String("2024-11-05T12:00:00Z"),
+ MaxOverridePeriodMinutes: api.Float64(90),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `climate_preset_key`
+
+Type: `string`
+Required: Yes
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+### `ends_at`
+
+Type: `string`
+Required: Yes
+
+Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+***
+
+### `is_override_allowed`
+
+Type: `boolean`
+Required: No
+
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+***
+
+### `max_override_period_minutes`
+
+Type: `number`
+Required: No
+
+Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+***
+
+### `name`
+
+Type: `string`
+Required: No
+
+User-friendly name to identify the thermostat schedule.
+
+***
+
+### `starts_at`
+
+Type: `string`
+Required: Yes
+
+Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+***
+
+## Return Type
+
+[thermostat\_schedule](./)
diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md
new file mode 100644
index 00000000..6dac5a6f
--- /dev/null
+++ b/docs/api/thermostats/schedules/delete.md
@@ -0,0 +1,134 @@
+# Delete a Thermostat Schedule
+
+```
+POST /thermostats/schedules/delete ⇒ void
+```
+
+Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.schedules.delete({
+ thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.schedules.delete(
+ thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4"
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4")
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->schedules->delete(
+ thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import schedules "github.com/seamapi/go/schedules"
+
+func main() {
+ client.Thermostats.Schedules.Delete(
+ context.Background(),
+ schedules.SchedulesDeleteRequest{
+ ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `thermostat_schedule_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat schedule.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md
new file mode 100644
index 00000000..c6fef40a
--- /dev/null
+++ b/docs/api/thermostats/schedules/get.md
@@ -0,0 +1,175 @@
+# Get a Thermostat Schedule
+
+```
+POST /thermostats/schedules/get ⇒ { thermostat_schedule }
+```
+
+Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.schedules.get({
+ thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name": "Reservation 2",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-10T15:00:00.000Z",
+ "ends_at": "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes": 90
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.schedules.get(
+ thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4"
+)
+```
+
+#### Response
+
+```python
+ThermostatSchedule(
+ thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ name="Reservation 2",
+ device_id="2d488679-6f07-4810-aed2-e726872c1dd5",
+ climate_preset_key="occupied",
+ starts_at="2024-11-10T15:00:00.000Z",
+ ends_at="2024-11-15T12:00:00.000Z",
+ max_override_period_minutes=90,
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4")
+```
+
+#### Response
+
+```ruby
+{
+ "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name" => "Reservation 2",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-10T15:00:00.000Z",
+ "ends_at" => "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->schedules->get(
+ thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4"
+);
+```
+
+#### Response
+
+```php
+ "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name" => "Reservation 2",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-10T15:00:00.000Z",
+ "ends_at" => "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4"
+```
+
+#### Response
+
+```seam_cli
+{
+ "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name": "Reservation 2",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-10T15:00:00.000Z",
+ "ends_at": "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes": 90
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import schedules "github.com/seamapi/go/schedules"
+
+func main() {
+ client.Thermostats.Schedules.Get(
+ context.Background(),
+ schedules.SchedulesGetRequest{
+ ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `thermostat_schedule_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat schedule.
+
+***
+
+## Return Type
+
+[thermostat\_schedule](./)
diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md
new file mode 100644
index 00000000..c9724b2d
--- /dev/null
+++ b/docs/api/thermostats/schedules/list.md
@@ -0,0 +1,237 @@
+# List Thermostat Schedules
+
+```
+POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] }
+```
+
+Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.schedules.list({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name": "Reservation 2",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-10T15:00:00.000Z",
+ "ends_at": "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes": 90
+ },
+ {
+ "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959",
+ "name": "Reservation 3",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-16T15:00:00.000Z",
+ "ends_at": "2024-11-18T12:00:00.000Z",
+ "max_override_period_minutes": 90
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000")
+```
+
+#### Response
+
+```python
+[
+ ThermostatSchedule(
+ thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ name="Reservation 2",
+ device_id="2d488679-6f07-4810-aed2-e726872c1dd5",
+ climate_preset_key="occupied",
+ starts_at="2024-11-10T15:00:00.000Z",
+ ends_at="2024-11-15T12:00:00.000Z",
+ max_override_period_minutes=90,
+ ),
+ ThermostatSchedule(
+ thermostat_schedule_id="665553d1-94f9-4e92-9739-06ac6362c959",
+ name="Reservation 3",
+ device_id="2d488679-6f07-4810-aed2-e726872c1dd5",
+ climate_preset_key="occupied",
+ starts_at="2024-11-16T15:00:00.000Z",
+ ends_at="2024-11-18T12:00:00.000Z",
+ max_override_period_minutes=90,
+ ),
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000")
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name" => "Reservation 2",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-10T15:00:00.000Z",
+ "ends_at" => "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+ },
+ {
+ "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959",
+ "name" => "Reservation 3",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-16T15:00:00.000Z",
+ "ends_at" => "2024-11-18T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->schedules->list(
+ device_id: "123e4567-e89b-12d3-a456-426614174000"
+);
+```
+
+#### Response
+
+```php
+ "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name" => "Reservation 2",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-10T15:00:00.000Z",
+ "ends_at" => "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+ ],
+ [
+ "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959",
+ "name" => "Reservation 3",
+ "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key" => "occupied",
+ "starts_at" => "2024-11-16T15:00:00.000Z",
+ "ends_at" => "2024-11-18T12:00:00.000Z",
+ "max_override_period_minutes" => 90,
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ "name": "Reservation 2",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-10T15:00:00.000Z",
+ "ends_at": "2024-11-15T12:00:00.000Z",
+ "max_override_period_minutes": 90
+ },
+ {
+ "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959",
+ "name": "Reservation 3",
+ "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
+ "climate_preset_key": "occupied",
+ "starts_at": "2024-11-16T15:00:00.000Z",
+ "ends_at": "2024-11-18T12:00:00.000Z",
+ "max_override_period_minutes": 90
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import schedules "github.com/seamapi/go/schedules"
+
+func main() {
+ client.Thermostats.Schedules.List(
+ context.Background(),
+ schedules.SchedulesListRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+### `user_identifier_key`
+
+Type: `string`
+Required: No
+
+User identifier key by which to filter the list of returned thermostat schedules.
+
+***
+
+## Return Type
+
+Array<[thermostat\_schedule](./)>
diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md
new file mode 100644
index 00000000..16c003d7
--- /dev/null
+++ b/docs/api/thermostats/schedules/update.md
@@ -0,0 +1,195 @@
+# Update a Thermostat Schedule
+
+```
+PATCH /thermostats/schedules/update ⇒ void
+```
+
+Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.schedules.update({
+ thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ ends_at: "2024-11-15T15:00:00Z",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.schedules.update(
+ thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ ends_at="2024-11-15T15:00:00Z",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.schedules.update(
+ thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ ends_at: "2024-11-15T15:00:00Z",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->schedules->update(
+ thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
+ ends_at: "2024-11-15T15:00:00Z"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import schedules "github.com/seamapi/go/schedules"
+
+func main() {
+ client.Thermostats.Schedules.Update(
+ context.Background(),
+ schedules.SchedulesUpdateRequest{
+ ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"),
+ EndsAt: api.String("2024-11-15T15:00:00Z"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `climate_preset_key`
+
+Type: `string`
+Required: No
+
+Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.
+
+***
+
+### `ends_at`
+
+Type: `string`
+Required: No
+
+Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+***
+
+### `is_override_allowed`
+
+Type: `boolean`
+Required: No
+
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+***
+
+### `max_override_period_minutes`
+
+Type: `number`
+Required: No
+
+Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+
+***
+
+### `name`
+
+Type: `string`
+Required: No
+
+User-friendly name to identify the thermostat schedule.
+
+***
+
+### `starts_at`
+
+Type: `string`
+Required: No
+
+Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+***
+
+### `thermostat_schedule_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat schedule.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md
new file mode 100644
index 00000000..2b9eab2b
--- /dev/null
+++ b/docs/api/thermostats/set_fallback_climate_preset.md
@@ -0,0 +1,147 @@
+# Set the Fallback Climate Preset
+
+```
+POST /thermostats/set_fallback_climate_preset ⇒ void
+```
+
+Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.setFallbackClimatePreset({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "eco",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.set_fallback_climate_preset(
+ device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="eco"
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.set_fallback_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "eco",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->set_fallback_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "eco"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.SetFallbackClimatePreset(
+ context.Background(),
+ api.ThermostatsSetFallbackClimatePresetRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ ClimatePresetKey: api.String("eco"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `climate_preset_key`
+
+Type: `string`
+Required: Yes
+
+Climate preset key of the desired climate preset.
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
new file mode 100644
index 00000000..3121da5d
--- /dev/null
+++ b/docs/api/thermostats/set_fan_mode.md
@@ -0,0 +1,178 @@
+# Set the Fan Mode Setting
+
+```
+POST /thermostats/set_fan_mode ⇒ { action_attempt }
+```
+
+Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.setFanMode({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ fan_mode_setting: "auto",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_FAN_MODE"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.set_fan_mode(
+ device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto"
+)
+```
+
+#### Response
+
+```python
+ActionAttempt(
+ action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
+ status="pending",
+ action_type="SET_FAN_MODE",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.set_fan_mode(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ fan_mode_setting: "auto",
+)
+```
+
+#### Response
+
+```ruby
+{
+ "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_FAN_MODE",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->set_fan_mode(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ fan_mode_setting: "auto"
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "pending",
+ "action_type" => "SET_FAN_MODE",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto"
+```
+
+#### Response
+
+```seam_cli
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "pending",
+ "action_type": "SET_FAN_MODE"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.SetFanMode(
+ context.Background(),
+ api.ThermostatsSetFanModeRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ FanModeSetting: api.String("auto"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+
+
+***
+
+### `fan_mode`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+### `fan_mode_setting`
+
+Type: `string`
+Required: No
+
+Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.
+
+***
+
+## Return Type
+
+[action\_attempt](./)
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
new file mode 100644
index 00000000..6d5f0d71
--- /dev/null
+++ b/docs/api/thermostats/set_hvac_mode.md
@@ -0,0 +1,162 @@
+# Set the HVAC Mode
+
+```
+POST /thermostats/set_hvac_mode ⇒ { action_attempt }
+```
+
+Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.setHvacMode({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ hvac_mode_setting: "heat_cool",
+ heating_set_point_celsius: 20,
+ cooling_set_point_celsius: 25,
+});
+```
+
+#### Response
+
+```javascript
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "success",
+ "action_type": "SET_HVAC_MODE"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.set_hvac_mode(
+ device_id="123e4567-e89b-12d3-a456-426614174000",
+ hvac_mode_setting="heat_cool",
+ heating_set_point_celsius=20,
+ cooling_set_point_celsius=25,
+)
+```
+
+#### Response
+
+```python
+ActionAttempt(
+ action_attempt_id="123e4567-e89b-12d3-a456-426614174000",
+ status="success",
+ action_type="SET_HVAC_MODE",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.set_hvac_mode(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ hvac_mode_setting: "heat_cool",
+ heating_set_point_celsius: 20,
+ cooling_set_point_celsius: 25,
+)
+```
+
+#### Response
+
+```ruby
+{
+ "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "success",
+ "action_type" => "SET_HVAC_MODE",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->set_hvac_mode(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ hvac_mode_setting: "heat_cool",
+ heating_set_point_celsius: 20,
+ cooling_set_point_celsius: 25
+);
+```
+
+#### Response
+
+```php
+ "123e4567-e89b-12d3-a456-426614174000",
+ "status" => "success",
+ "action_type" => "SET_HVAC_MODE",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25
+```
+
+#### Response
+
+```seam_cli
+{
+ "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000",
+ "status": "success",
+ "action_type": "SET_HVAC_MODE"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.SetHvacMode(
+ context.Background(),
+ api.ThermostatsSetHvacModeRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ HvacModeSetting: api.String("heat_cool"),
+ HeatingSetPointCelsius: api.Float64(20),
+ CoolingSetPointCelsius: api.Float64(25),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+## Return Type
+
+[action\_attempt](./)
diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md
new file mode 100644
index 00000000..fbc68384
--- /dev/null
+++ b/docs/api/thermostats/set_temperature_threshold.md
@@ -0,0 +1,180 @@
+# Set a Temperature Threshold
+
+```
+PATCH /thermostats/set_temperature_threshold ⇒ void
+```
+
+Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) 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.
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.setTemperatureThreshold({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ lower_limit_celsius: 4,
+ upper_limit_celsius: 30,
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.set_temperature_threshold(
+ device_id="123e4567-e89b-12d3-a456-426614174000",
+ lower_limit_celsius=4,
+ upper_limit_celsius=30,
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.set_temperature_threshold(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ lower_limit_celsius: 4,
+ upper_limit_celsius: 30,
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->set_temperature_threshold(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ lower_limit_celsius: 4,
+ upper_limit_celsius: 30
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.SetTemperatureThreshold(
+ context.Background(),
+ api.ThermostatsSetTemperatureThresholdRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ LowerLimitCelsius: api.Float64(4),
+ UpperLimitCelsius: api.Float64(30),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+### `lower_limit_celsius`
+
+Type: `number`
+Required: No
+
+Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
+
+***
+
+### `lower_limit_fahrenheit`
+
+Type: `number`
+Required: No
+
+Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
+
+***
+
+### `upper_limit_celsius`
+
+Type: `number`
+Required: No
+
+Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
+
+***
+
+### `upper_limit_fahrenheit`
+
+Type: `number`
+Required: No
+
+Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md
new file mode 100644
index 00000000..c69a3c06
--- /dev/null
+++ b/docs/api/thermostats/update_climate_preset.md
@@ -0,0 +1,230 @@
+# Update a Climate Preset
+
+```
+PATCH /thermostats/update_climate_preset ⇒ void
+```
+
+Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.thermostats.updateClimatePreset({
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+ cooling_set_point_celsius: 24,
+ manual_override_allowed: true,
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.thermostats.update_climate_preset(
+ device_id="123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key="occupied",
+ cooling_set_point_celsius=24,
+ manual_override_allowed=true,
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.thermostats.update_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+ cooling_set_point_celsius: 24,
+ manual_override_allowed: true,
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+thermostats->update_climate_preset(
+ device_id: "123e4567-e89b-12d3-a456-426614174000",
+ climate_preset_key: "occupied",
+ cooling_set_point_celsius: 24,
+ manual_override_allowed: true
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.Thermostats.UpdateClimatePreset(
+ context.Background(),
+ api.ThermostatsUpdateClimatePresetRequest{
+ DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"),
+ ClimatePresetKey: api.String("occupied"),
+ CoolingSetPointCelsius: api.Float64(24),
+ ManualOverrideAllowed: api.Bool(true),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `climate_preset_key`
+
+Type: `string`
+Required: Yes
+
+Unique key to identify the climate preset.
+
+***
+
+### `cooling_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
+
+***
+
+### `cooling_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should cool (in °F).
+
+***
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired thermostat device.
+
+***
+
+### `fan_mode_setting`
+
+Type: `string`
+Required: No
+
+Desired fan mode setting, such as `on`, `auto`, or `circulate`.
+
+***
+
+### `heating_set_point_celsius`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should heat (in °C).
+
+***
+
+### `heating_set_point_fahrenheit`
+
+Type: `number`
+Required: No
+
+Temperature to which the thermostat should heat (in °F).
+
+***
+
+### `hvac_mode_setting`
+
+Type: `string`
+Required: No
+
+Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+
+***
+
+### `manual_override_allowed`
+
+Type: `boolean`
+Required: Yes
+
+Indicates whether a person at the thermostat can change the thermostat's settings.
+
+***
+
+### `name`
+
+Type: `string`
+Required: No
+
+User-friendly name to identify the climate preset.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md
new file mode 100644
index 00000000..2197df78
--- /dev/null
+++ b/docs/api/user_identities/README.md
@@ -0,0 +1,112 @@
+# User Identities
+
+## `user_identity`
+
+Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the user identity was created.
+
+
+---
+
+### `display_name`
+
+Format: `String`
+
+
+---
+
+### `email_address`
+
+Format: `String`
+
+Unique email address for the user identity.
+
+
+---
+
+### `full_name`
+
+Format: `String`
+
+
+---
+
+### `phone_number`
+
+Format: `String`
+
+Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+
+
+---
+
+### `user_identity_id`
+
+Format: `ID`
+
+ID of the user identity.
+
+
+---
+
+### `user_identity_key`
+
+Format: `String`
+
+Unique key for the user identity.
+
+
+---
+
+### `workspace_id`
+
+Format: `ID`
+
+ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity.
+
+
+---
+
+## Endpoints
+
+### [`/user_identities/add_acs_user`](./add_acs_user.md)
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/create`](./create.md)
+
+Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/delete`](./delete.md)
+
+Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
+### [`/user_identities/get`](./get.md)
+
+Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/grant_access_to_device`](./grant_access_to_device.md)
+
+Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md).
+### [`/user_identities/list`](./list.md)
+
+Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/list_accessible_devices`](./list_accessible_devices.md)
+
+Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/list_acs_systems`](./list_acs_systems.md)
+
+Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/list_acs_users`](./list_acs_users.md)
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/remove_acs_user`](./remove_acs_user.md)
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/revoke_access_to_device`](./revoke_access_to_device.md)
+
+Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+### [`/user_identities/update`](./update.md)
+
+
diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md
new file mode 100644
index 00000000..88519418
--- /dev/null
+++ b/docs/api/user_identities/add_acs_user.md
@@ -0,0 +1,148 @@
+# Add an ACS User to a User Identity
+
+```
+PUT /user_identities/add_acs_user ⇒ void
+```
+
+Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.addAcsUser({
+ user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.add_acs_user(
+ user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.add_acs_user(
+ user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->add_acs_user(
+ user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.AddAcsUser(
+ context.Background(),
+ api.UserIdentitiesAddAcsUserRequest{
+ UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"),
+ AcsUserId: api.String("4d223973-0874-4831-8630-bfcb29e6bce0"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired ACS user.
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user identity.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md
new file mode 100644
index 00000000..5bc9667d
--- /dev/null
+++ b/docs/api/user_identities/create.md
@@ -0,0 +1,222 @@
+# Create a User Identity
+
+```
+POST /user_identities/create ⇒ { user_identity }
+```
+
+Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.create({
+ user_identity_key: "jean_doe",
+ email_address: "jean@example.com",
+ phone_number: "+15555550110",
+ full_name: "Jean Doe",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key": "jean_doe",
+ "email_address": "jean@example.com",
+ "phone_number": "+15555550110",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "created_at": "2024-01-11T05:37:50.264Z",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.create(
+ user_identity_key="jean_doe",
+ email_address="jean@example.com",
+ phone_number="+15555550110",
+ full_name="Jean Doe",
+)
+```
+
+#### Response
+
+```python
+UserIdentity(
+ user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ user_identity_key="jean_doe",
+ email_address="jean@example.com",
+ phone_number="+15555550110",
+ display_name="Jean Doe",
+ full_name="Jean Doe",
+ created_at="2024-01-11T05:37:50.264Z",
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.create(
+ user_identity_key: "jean_doe",
+ email_address: "jean@example.com",
+ phone_number: "+15555550110",
+ full_name: "Jean Doe",
+)
+```
+
+#### Response
+
+```ruby
+{
+ "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key" => "jean_doe",
+ "email_address" => "jean@example.com",
+ "phone_number" => "+15555550110",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "created_at" => "2024-01-11T05:37:50.264Z",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->create(
+ user_identity_key: "jean_doe",
+ email_address: "jean@example.com",
+ phone_number: "+15555550110",
+ full_name: "Jean Doe"
+);
+```
+
+#### Response
+
+```php
+ "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key" => "jean_doe",
+ "email_address" => "jean@example.com",
+ "phone_number" => "+15555550110",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "created_at" => "2024-01-11T05:37:50.264Z",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe"
+```
+
+#### Response
+
+```seam_cli
+{
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key": "jean_doe",
+ "email_address": "jean@example.com",
+ "phone_number": "+15555550110",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "created_at": "2024-01-11T05:37:50.264Z",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.Create(
+ context.Background(),
+ api.UserIdentitiesCreateRequest{
+ UserIdentityKey: api.String("jean_doe"),
+ EmailAddress: api.String("jean@example.com"),
+ PhoneNumber: api.String("+15555550110"),
+ FullName: api.String("Jean Doe"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `email_address`
+
+Type: `string`
+Required: No
+
+Unique email address for the user identity.
+
+***
+
+### `full_name`
+
+Type: `string`
+Required: No
+
+Full name of the user associated with the user identity.
+
+***
+
+### `phone_number`
+
+Type: `string`
+Required: No
+
+Unique phone number for the user identity in E.164 format (for example, +15555550100).
+
+***
+
+### `user_identity_key`
+
+Type: `string`
+Required: No
+
+Unique key for the user identity.
+
+***
+
+## Return Type
+
+[user\_identity](./)
diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md
new file mode 100644
index 00000000..7638681e
--- /dev/null
+++ b/docs/api/user_identities/delete.md
@@ -0,0 +1,130 @@
+# Delete a User Identity
+
+```
+POST /user_identities/delete ⇒ void
+```
+
+Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.delete({
+ user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135")
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135")
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->delete(
+ user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.Delete(
+ context.Background(),
+ api.UserIdentitiesDeleteRequest{
+ UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user identity.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md
new file mode 100644
index 00000000..6c5873eb
--- /dev/null
+++ b/docs/api/user_identities/enrollment_automations/README.md
@@ -0,0 +1,65 @@
+# Enrollment Automations
+
+## `enrollment_automation`
+
+Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the enrollment automation was created.
+
+
+---
+
+### `credential_manager_acs_system_id`
+
+Format: `ID`
+
+ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.
+
+
+---
+
+### `enrollment_automation_id`
+
+Format: `ID`
+
+ID of the enrollment automation.
+
+
+---
+
+### `user_identity_id`
+
+Format: `ID`
+
+ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+
+---
+
+### `workspace_id`
+
+Format: `ID`
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation.
+
+
+---
+
+## Endpoints
+
+### [`/user_identities/enrollment_automations/delete`](./delete.md)
+
+Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).
+### [`/user_identities/enrollment_automations/get`](./get.md)
+
+Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+### [`/user_identities/enrollment_automations/launch`](./launch.md)
+
+Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+### [`/user_identities/enrollment_automations/list`](./list.md)
+
+Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md
new file mode 100644
index 00000000..6660c338
--- /dev/null
+++ b/docs/api/user_identities/enrollment_automations/delete.md
@@ -0,0 +1,135 @@
+# Delete an Enrollment Automation
+
+```
+POST /user_identities/enrollment_automations/delete ⇒ void
+```
+
+Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.enrollmentAutomations.delete({
+ enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.enrollment_automations.delete(
+ enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895"
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.enrollment_automations.delete(
+ enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->enrollment_automations->delete(
+ enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import enrollmentautomations "github.com/seamapi/go/enrollmentautomations"
+
+func main() {
+ client.UserIdentities.EnrollmentAutomations.Delete(
+ context.Background(),
+ enrollmentautomations.EnrollmentAutomationsDeleteRequest{
+ EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `enrollment_automation_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired enrollment automation.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md
new file mode 100644
index 00000000..b32beb3e
--- /dev/null
+++ b/docs/api/user_identities/enrollment_automations/get.md
@@ -0,0 +1,179 @@
+# Get an Enrollment Automation
+
+```
+POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
+```
+
+Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.enrollmentAutomations.get({
+ enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running": true,
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-09T05:45:33.068Z"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.enrollment_automations.get(
+ enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895"
+)
+```
+
+#### Response
+
+```python
+EnrollmentAutomation(
+ user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895",
+ acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895",
+ credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172",
+ is_running=true,
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ created_at="2024-01-09T05:45:33.068Z",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.enrollment_automations.get(
+ enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895",
+)
+```
+
+#### Response
+
+```ruby
+{
+ "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running" => true,
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-09T05:45:33.068Z",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->enrollment_automations->get(
+ enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895"
+);
+```
+
+#### Response
+
+```php
+ "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id" =>
+ "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id" =>
+ "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running" => true,
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-09T05:45:33.068Z",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895"
+```
+
+#### Response
+
+```seam_cli
+{
+ "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running": true,
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-09T05:45:33.068Z"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import enrollmentautomations "github.com/seamapi/go/enrollmentautomations"
+
+func main() {
+ client.UserIdentities.EnrollmentAutomations.Get(
+ context.Background(),
+ enrollmentautomations.EnrollmentAutomationsGetRequest{
+ EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `enrollment_automation_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired enrollment automation.
+
+***
+
+## Return Type
+
+[enrollment\_automation](./)
diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md
new file mode 100644
index 00000000..e93b4703
--- /dev/null
+++ b/docs/api/user_identities/enrollment_automations/launch.md
@@ -0,0 +1,229 @@
+# Launch an Enrollment Automation
+
+```
+POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation }
+```
+
+Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.enrollmentAutomations.launch({
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172",
+ acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+ create_credential_manager_user: true,
+});
+```
+
+#### Response
+
+```javascript
+{
+ "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running": true,
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-09T05:45:33.068Z"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.enrollment_automations.launch(
+ user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172",
+ acs_credential_pool_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
+ create_credential_manager_user=true,
+)
+```
+
+#### Response
+
+```python
+Unknown(
+ user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895",
+ acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895",
+ credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172",
+ is_running=true,
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ created_at="2024-01-09T05:45:33.068Z",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.enrollment_automations.launch(
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172",
+ acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+ create_credential_manager_user: true,
+)
+```
+
+#### Response
+
+```ruby
+{
+ "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running" => true,
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-09T05:45:33.068Z",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->enrollment_automations->launch(
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172",
+ acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+ create_credential_manager_user: true
+);
+```
+
+#### Response
+
+```php
+ "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id" =>
+ "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id" =>
+ "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running" => true,
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-09T05:45:33.068Z",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true
+```
+
+#### Response
+
+```seam_cli
+{
+ "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running": true,
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-09T05:45:33.068Z"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import enrollmentautomations "github.com/seamapi/go/enrollmentautomations"
+
+func main() {
+ client.UserIdentities.EnrollmentAutomations.Launch(
+ context.Background(),
+ enrollmentautomations.EnrollmentAutomationsLaunchRequest{
+ UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"),
+ CredentialManagerAcsSystemId: api.String("6737e186-8d54-48ce-a7da-a0be4d252172"),
+ AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"),
+ CreateCredentialManagerUser: api.Bool(true),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_credential_pool_id`
+
+Type: `string`
+Required: No
+
+ID of the ACS credential pool from which to obtain credentials for the user identity.
+
+***
+
+### `create_credential_manager_user`
+
+Type: `boolean`
+Required: No
+
+Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`.
+
+***
+
+### `credential_manager_acs_system_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired ACS system that serves as the credential manager.
+
+***
+
+### `credential_manager_acs_user_id`
+
+Type: `string`
+Required: No
+
+ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user identity.
+
+***
+
+## Return Type
+
+[unknown](./)
diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md
new file mode 100644
index 00000000..0045dc72
--- /dev/null
+++ b/docs/api/user_identities/enrollment_automations/list.md
@@ -0,0 +1,189 @@
+# List Enrollment Automations
+
+```
+POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] }
+```
+
+Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.enrollmentAutomations.list({
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running": true,
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-09T05:45:33.068Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.enrollment_automations.list(
+ user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+)
+```
+
+#### Response
+
+```python
+[
+ EnrollmentAutomation(
+ user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895",
+ acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895",
+ credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172",
+ is_running=true,
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ created_at="2024-01-09T05:45:33.068Z",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.enrollment_automations.list(
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+)
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running" => true,
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-09T05:45:33.068Z",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->enrollment_automations->list(
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+);
+```
+
+#### Response
+
+```php
+ "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id" =>
+ "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id" =>
+ "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running" => true,
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-09T05:45:33.068Z",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895",
+ "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "is_running": true,
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-09T05:45:33.068Z"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+import enrollmentautomations "github.com/seamapi/go/enrollmentautomations"
+
+func main() {
+ client.UserIdentities.EnrollmentAutomations.List(
+ context.Background(),
+ enrollmentautomations.EnrollmentAutomationsListRequest{
+ UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the user identity for which you want to retrieve all enrollment automations.
+
+***
+
+## Return Type
+
+Array<[enrollment\_automation](./)>
diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md
new file mode 100644
index 00000000..33a8cede
--- /dev/null
+++ b/docs/api/user_identities/get.md
@@ -0,0 +1,167 @@
+# Get a User Identity
+
+```
+POST /user_identities/get ⇒ { user_identity }
+```
+
+Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.get({
+ user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+});
+```
+
+#### Response
+
+```javascript
+{
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key": "jean_doe",
+ "email_address": "jean@example.com",
+ "phone_number": "+15555550110",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "created_at": "2024-01-11T05:37:50.264Z",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
+}
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")
+```
+
+#### Response
+
+```python
+UserIdentity(
+ user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ user_identity_key="jean_doe",
+ email_address="jean@example.com",
+ phone_number="+15555550110",
+ display_name="Jean Doe",
+ full_name="Jean Doe",
+ created_at="2024-01-11T05:37:50.264Z",
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+)
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")
+```
+
+#### Response
+
+```ruby
+{
+ "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key" => "jean_doe",
+ "email_address" => "jean@example.com",
+ "phone_number" => "+15555550110",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "created_at" => "2024-01-11T05:37:50.264Z",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+}
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->get(
+ user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
+);
+```
+
+#### Response
+
+```php
+ "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key" => "jean_doe",
+ "email_address" => "jean@example.com",
+ "phone_number" => "+15555550110",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "created_at" => "2024-01-11T05:37:50.264Z",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
+```
+
+#### Response
+
+```seam_cli
+{
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key": "jean_doe",
+ "email_address": "jean@example.com",
+ "phone_number": "+15555550110",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "created_at": "2024-01-11T05:37:50.264Z",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
+}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.Get(
+ context.Background(),
+ api.UserIdentitiesGetRequest{
+ UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+## Return Type
+
+[user\_identity](./)
diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md
new file mode 100644
index 00000000..84d474c8
--- /dev/null
+++ b/docs/api/user_identities/grant_access_to_device.md
@@ -0,0 +1,148 @@
+# Grant a User Identity Access to a Device
+
+```
+PUT /user_identities/grant_access_to_device ⇒ void
+```
+
+Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.grantAccessToDevice({
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id: "054765c8-a2fc-4599-b486-14c19f462c45",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.grant_access_to_device(
+ user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id="054765c8-a2fc-4599-b486-14c19f462c45",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.grant_access_to_device(
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id: "054765c8-a2fc-4599-b486-14c19f462c45",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->grant_access_to_device(
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id: "054765c8-a2fc-4599-b486-14c19f462c45"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.GrantAccessToDevice(
+ context.Background(),
+ api.UserIdentitiesGrantAccessToDeviceRequest{
+ UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"),
+ DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired managed device.
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user identity.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md
new file mode 100644
index 00000000..cfbb3bbf
--- /dev/null
+++ b/docs/api/user_identities/list.md
@@ -0,0 +1,176 @@
+# List User Identities
+
+```
+POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
+```
+
+Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.list();
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key": "jean_doe",
+ "email_address": "jean@example.com",
+ "phone_number": "+15555550110",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "created_at": "2024-01-11T05:37:50.264Z",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.list()
+```
+
+#### Response
+
+```python
+[
+ UserIdentity(
+ user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ user_identity_key="jean_doe",
+ email_address="jean@example.com",
+ phone_number="+15555550110",
+ display_name="Jean Doe",
+ full_name="Jean Doe",
+ created_at="2024-01-11T05:37:50.264Z",
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.list()
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key" => "jean_doe",
+ "email_address" => "jean@example.com",
+ "phone_number" => "+15555550110",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "created_at" => "2024-01-11T05:37:50.264Z",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->list();
+```
+
+#### Response
+
+```php
+ "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key" => "jean_doe",
+ "email_address" => "jean@example.com",
+ "phone_number" => "+15555550110",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "created_at" => "2024-01-11T05:37:50.264Z",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities list
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_key": "jean_doe",
+ "email_address": "jean@example.com",
+ "phone_number": "+15555550110",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "created_at": "2024-01-11T05:37:50.264Z",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+func main() {
+ client.UserIdentities.List(context.Background())
+}
+```
+
+#### Response
+
+```go
+[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `credential_manager_acs_system_id`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+## Return Type
+
+Array<[user\_identity](./)>
diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md
new file mode 100644
index 00000000..092e9c7a
--- /dev/null
+++ b/docs/api/user_identities/list_accessible_devices.md
@@ -0,0 +1,406 @@
+# List Accessible Devices for a User Identity
+
+```
+POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] }
+```
+
+Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.listAccessibleDevices({
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "device_id": "054765c8-a2fc-4599-b486-14c19f462c45",
+ "nickname": "",
+ "display_name": "Seam Thermostat",
+ "device_type": "nest_thermostat",
+ "capabilities_supported": ["thermostat"],
+ "properties": {
+ "online": true,
+ "is_cooling": false,
+ "is_heating": false,
+ "manufacturer": "nest",
+ "nest_metadata": {
+ "custom_name": "",
+ "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g",
+ "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a"
+ },
+ "is_fan_running": false,
+ "has_direct_power": true,
+ "relative_humidity": 0.46,
+ "temperature_celsius": 24.64,
+ "temperature_fahrenheit": 76.352,
+ "current_climate_setting": {
+ "hvac_mode_setting": "heat_cool",
+ "manual_override_allowed": true,
+ "cooling_set_point_celsius": 21.5,
+ "heating_set_point_celsius": 20,
+ "cooling_set_point_fahrenheit": 70.7,
+ "heating_set_point_fahrenheit": 68
+ },
+ "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"],
+ "is_temporary_manual_override_active": false,
+ "name": "",
+ "appearance": { "name": "" },
+ "model": {
+ "display_name": "Thermostat",
+ "manufacturer_display_name": "Nest",
+ "accessory_keypad_supported": false
+ },
+ "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png",
+ "image_alt_text": "Placeholder Lock Image",
+ "is_climate_setting_schedule_active": false
+ },
+ "location": null,
+ "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-02-29T21:57:33.397Z",
+ "errors": [],
+ "warnings": [],
+ "is_managed": true,
+ "custom_metadata": {}
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.list_accessible_devices(
+ user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf"
+)
+```
+
+#### Response
+
+```python
+[
+ Device(
+ device_id="054765c8-a2fc-4599-b486-14c19f462c45",
+ nickname="",
+ display_name="Seam Thermostat",
+ device_type="nest_thermostat",
+ capabilities_supported=["thermostat"],
+ properties={
+ "online": true,
+ "is_cooling": false,
+ "is_heating": false,
+ "manufacturer": "nest",
+ "nest_metadata": {
+ "custom_name": "",
+ "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g",
+ "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a",
+ },
+ "is_fan_running": false,
+ "has_direct_power": true,
+ "relative_humidity": 0.46,
+ "temperature_celsius": 24.64,
+ "temperature_fahrenheit": 76.352,
+ "current_climate_setting": {
+ "hvac_mode_setting": "heat_cool",
+ "manual_override_allowed": true,
+ "cooling_set_point_celsius": 21.5,
+ "heating_set_point_celsius": 20,
+ "cooling_set_point_fahrenheit": 70.7,
+ "heating_set_point_fahrenheit": 68,
+ },
+ "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"],
+ "is_temporary_manual_override_active": false,
+ "name": "",
+ "appearance": {"name": ""},
+ "model": {
+ "display_name": "Thermostat",
+ "manufacturer_display_name": "Nest",
+ "accessory_keypad_supported": false,
+ },
+ "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png",
+ "image_alt_text": "Placeholder Lock Image",
+ "is_climate_setting_schedule_active": false,
+ },
+ location=None,
+ connected_account_id="44284499-a50b-4947-86c1-58264f014be5",
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ created_at="2024-02-29T21:57:33.397Z",
+ errors=[],
+ warnings=[],
+ is_managed=true,
+ custom_metadata={},
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.list_accessible_devices(
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+)
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "device_id" => "054765c8-a2fc-4599-b486-14c19f462c45",
+ "nickname" => "",
+ "display_name" => "Seam Thermostat",
+ "device_type" => "nest_thermostat",
+ "capabilities_supported" => ["thermostat"],
+ "properties" => {
+ online: true,
+ is_cooling: false,
+ is_heating: false,
+ manufacturer: "nest",
+ nest_metadata: {
+ custom_name: "",
+ device_name:
+ "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g",
+ nest_device_id: "bcca8c5f-1854-4906-9911-c877d513e00a",
+ },
+ is_fan_running: false,
+ has_direct_power: true,
+ relative_humidity: 0.46,
+ temperature_celsius: 24.64,
+ temperature_fahrenheit: 76.352,
+ current_climate_setting: {
+ hvac_mode_setting: "heat_cool",
+ manual_override_allowed: true,
+ cooling_set_point_celsius: 21.5,
+ heating_set_point_celsius: 20,
+ cooling_set_point_fahrenheit: 70.7,
+ heating_set_point_fahrenheit: 68,
+ },
+ available_hvac_mode_settings: %w[heat cool heat_cool off],
+ is_temporary_manual_override_active: false,
+ name: "",
+ appearance: {
+ name: "",
+ },
+ model: {
+ display_name: "Thermostat",
+ manufacturer_display_name: "Nest",
+ accessory_keypad_supported: false,
+ },
+ image_url: "https://connect.getseam.com/assets/images/devices/unknown-lock.png",
+ image_alt_text: "Placeholder Lock Image",
+ is_climate_setting_schedule_active: false,
+ },
+ "location" => nil,
+ "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-02-29T21:57:33.397Z",
+ "errors" => [],
+ "warnings" => [],
+ "is_managed" => true,
+ "custom_metadata" => {
+ },
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->list_accessible_devices(
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf"
+);
+```
+
+#### Response
+
+```php
+ "054765c8-a2fc-4599-b486-14c19f462c45",
+ "nickname" => "",
+ "display_name" => "Seam Thermostat",
+ "device_type" => "nest_thermostat",
+ "capabilities_supported" => ["thermostat"],
+ "properties" => [
+ "online" => true,
+ "is_cooling" => false,
+ "is_heating" => false,
+ "manufacturer" => "nest",
+ "nest_metadata" => [
+ "custom_name" => "",
+ "device_name" =>
+ "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g",
+ "nest_device_id" => "bcca8c5f-1854-4906-9911-c877d513e00a",
+ ],
+ "is_fan_running" => false,
+ "has_direct_power" => true,
+ "relative_humidity" => 0.46,
+ "temperature_celsius" => 24.64,
+ "temperature_fahrenheit" => 76.352,
+ "current_climate_setting" => [
+ "hvac_mode_setting" => "heat_cool",
+ "manual_override_allowed" => true,
+ "cooling_set_point_celsius" => 21.5,
+ "heating_set_point_celsius" => 20,
+ "cooling_set_point_fahrenheit" => 70.7,
+ "heating_set_point_fahrenheit" => 68,
+ ],
+ "available_hvac_mode_settings" => [
+ "heat",
+ "cool",
+ "heat_cool",
+ "off",
+ ],
+ "is_temporary_manual_override_active" => false,
+ "name" => "",
+ "appearance" => ["name" => ""],
+ "model" => [
+ "display_name" => "Thermostat",
+ "manufacturer_display_name" => "Nest",
+ "accessory_keypad_supported" => false,
+ ],
+ "image_url" =>
+ "https://connect.getseam.com/assets/images/devices/unknown-lock.png",
+ "image_alt_text" => "Placeholder Lock Image",
+ "is_climate_setting_schedule_active" => false,
+ ],
+ "location" => null,
+ "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-02-29T21:57:33.397Z",
+ "errors" => [],
+ "warnings" => [],
+ "is_managed" => true,
+ "custom_metadata" => [],
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "device_id": "054765c8-a2fc-4599-b486-14c19f462c45",
+ "nickname": "",
+ "display_name": "Seam Thermostat",
+ "device_type": "nest_thermostat",
+ "capabilities_supported": ["thermostat"],
+ "properties": {
+ "online": true,
+ "is_cooling": false,
+ "is_heating": false,
+ "manufacturer": "nest",
+ "nest_metadata": {
+ "custom_name": "",
+ "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g",
+ "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a"
+ },
+ "is_fan_running": false,
+ "has_direct_power": true,
+ "relative_humidity": 0.46,
+ "temperature_celsius": 24.64,
+ "temperature_fahrenheit": 76.352,
+ "current_climate_setting": {
+ "hvac_mode_setting": "heat_cool",
+ "manual_override_allowed": true,
+ "cooling_set_point_celsius": 21.5,
+ "heating_set_point_celsius": 20,
+ "cooling_set_point_fahrenheit": 70.7,
+ "heating_set_point_fahrenheit": 68
+ },
+ "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"],
+ "is_temporary_manual_override_active": false,
+ "name": "",
+ "appearance": { "name": "" },
+ "model": {
+ "display_name": "Thermostat",
+ "manufacturer_display_name": "Nest",
+ "accessory_keypad_supported": false
+ },
+ "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png",
+ "image_alt_text": "Placeholder Lock Image",
+ "is_climate_setting_schedule_active": false
+ },
+ "location": null,
+ "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-02-29T21:57:33.397Z",
+ "errors": [],
+ "warnings": [],
+ "is_managed": true,
+ "custom_metadata": {}
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.ListAccessibleDevices(
+ context.Background(),
+ api.UserIdentitiesListAccessibleDevicesRequest{
+ UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the user identity for which you want to retrieve all accessible devices.
+
+***
+
+## Return Type
+
+Array<[device](./)>
diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md
new file mode 100644
index 00000000..9adb0ee3
--- /dev/null
+++ b/docs/api/user_identities/list_acs_systems.md
@@ -0,0 +1,194 @@
+# List ACS Systems Associated with a User Identity
+
+```
+POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
+```
+
+Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.listAcsSystems({
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "name": "Assa Abloy Credential Service",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-05T07:16:51.971Z",
+ "system_type": "assa_abloy_credential_service",
+ "system_type_display_name": "Assa Abloy Credential Service",
+ "external_type": "assa_abloy_credential_service",
+ "external_type_display_name": "Assa Abloy Credential Service",
+ "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"]
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.list_acs_systems(
+ user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+)
+```
+
+#### Response
+
+```python
+[
+ AcsSystem(
+ acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172",
+ name="Assa Abloy Credential Service",
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ created_at="2024-01-05T07:16:51.971Z",
+ system_type="assa_abloy_credential_service",
+ system_type_display_name="Assa Abloy Credential Service",
+ external_type="assa_abloy_credential_service",
+ external_type_display_name="Assa Abloy Credential Service",
+ connected_account_ids=["dc08066f-d9b8-42f0-9c4b-c781cd900153"],
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f")
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "name" => "Assa Abloy Credential Service",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-05T07:16:51.971Z",
+ "system_type" => "assa_abloy_credential_service",
+ "system_type_display_name" => "Assa Abloy Credential Service",
+ "external_type" => "assa_abloy_credential_service",
+ "external_type_display_name" => "Assa Abloy Credential Service",
+ "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"],
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->list_acs_systems(
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+);
+```
+
+#### Response
+
+```php
+ "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "name" => "Assa Abloy Credential Service",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-05T07:16:51.971Z",
+ "system_type" => "assa_abloy_credential_service",
+ "system_type_display_name" => "Assa Abloy Credential Service",
+ "external_type" => "assa_abloy_credential_service",
+ "external_type_display_name" => "Assa Abloy Credential Service",
+ "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"],
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172",
+ "name": "Assa Abloy Credential Service",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-05T07:16:51.971Z",
+ "system_type": "assa_abloy_credential_service",
+ "system_type_display_name": "Assa Abloy Credential Service",
+ "external_type": "assa_abloy_credential_service",
+ "external_type_display_name": "Assa Abloy Credential Service",
+ "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"]
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.ListAcsSystems(
+ context.Background(),
+ api.UserIdentitiesListAcsSystemsRequest{
+ UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Client session token
+- Personal access token
+
+## Request Parameters
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the user identity for which you want to retrieve all access control systems.
+
+***
+
+## Return Type
+
+Array<[acs\_system](./)>
diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md
new file mode 100644
index 00000000..be8d25b6
--- /dev/null
+++ b/docs/api/user_identities/list_acs_users.md
@@ -0,0 +1,203 @@
+# List ACS Users Associated with a User Identity
+
+```
+POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] }
+```
+
+Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.listAcsUsers({
+ user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+});
+```
+
+#### Response
+
+```javascript
+[
+ {
+ "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "email_address": "jean@example.com",
+ "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-11T05:45:41.349Z",
+ "is_suspended": false,
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_email_address": "jean@example.com",
+ "user_identity_phone_number": "+15555550110"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.list_acs_users(
+ user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
+)
+```
+
+#### Response
+
+```python
+[
+ AcsUser(
+ acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0",
+ display_name="Jean Doe",
+ full_name="Jean Doe",
+ email_address="jean@example.com",
+ acs_system_id="8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4",
+ workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ created_at="2024-01-11T05:45:41.349Z",
+ is_suspended=false,
+ user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ user_identity_email_address="jean@example.com",
+ user_identity_phone_number="+15555550110",
+ )
+]
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a")
+```
+
+#### Response
+
+```ruby
+[
+ {
+ "acs_user_id" => "4d223973-0874-4831-8630-bfcb29e6bce0",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "email_address" => "jean@example.com",
+ "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-11T05:45:41.349Z",
+ "is_suspended" => false,
+ "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_email_address" => "jean@example.com",
+ "user_identity_phone_number" => "+15555550110",
+ },
+]
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->list_acs_users(
+ user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
+);
+```
+
+#### Response
+
+```php
+ "4d223973-0874-4831-8630-bfcb29e6bce0",
+ "display_name" => "Jean Doe",
+ "full_name" => "Jean Doe",
+ "email_address" => "jean@example.com",
+ "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4",
+ "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at" => "2024-01-11T05:45:41.349Z",
+ "is_suspended" => false,
+ "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_email_address" => "jean@example.com",
+ "user_identity_phone_number" => "+15555550110",
+ ],
+];
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
+```
+
+#### Response
+
+```seam_cli
+[
+ {
+ "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0",
+ "display_name": "Jean Doe",
+ "full_name": "Jean Doe",
+ "email_address": "jean@example.com",
+ "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4",
+ "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
+ "created_at": "2024-01-11T05:45:41.349Z",
+ "is_suspended": false,
+ "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
+ "user_identity_email_address": "jean@example.com",
+ "user_identity_phone_number": "+15555550110"
+ }
+]
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.ListAcsUsers(
+ context.Background(),
+ api.UserIdentitiesListAcsUsersRequest{
+ UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}}
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the user identity for which you want to retrieve all ACS users.
+
+***
+
+## Return Type
+
+Array<[acs\_user](./)>
diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md
new file mode 100644
index 00000000..9072d65a
--- /dev/null
+++ b/docs/api/user_identities/remove_acs_user.md
@@ -0,0 +1,148 @@
+# Remove an ACS User from a User Identity
+
+```
+POST /user_identities/remove_acs_user ⇒ void
+```
+
+Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.removeAcsUser({
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.remove_acs_user(
+ user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ acs_user_id="c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.remove_acs_user(
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->remove_acs_user(
+ user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
+ acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.RemoveAcsUser(
+ context.Background(),
+ api.UserIdentitiesRemoveAcsUserRequest{
+ UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"),
+ AcsUserId: api.String("c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `acs_user_id`
+
+Type: `string`
+Required: Yes
+
+ID of the ACS user.
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user identity.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md
new file mode 100644
index 00000000..96e56f57
--- /dev/null
+++ b/docs/api/user_identities/revoke_access_to_device.md
@@ -0,0 +1,148 @@
+# Revoke Access to a Device from a User Identity
+
+```
+POST /user_identities/revoke_access_to_device ⇒ void
+```
+
+Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+
+{% tabs %}
+{% tab title="JavaScript" %}
+#### Request
+
+```javascript
+await seam.userIdentities.revokeAccessToDevice({
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id: "054765c8-a2fc-4599-b486-14c19f462c45",
+});
+```
+
+#### Response
+
+```javascript
+// void
+```
+{% endtab %}
+
+{% tab title="Python" %}
+#### Request
+
+```python
+seam.user_identities.revoke_access_to_device(
+ user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id="054765c8-a2fc-4599-b486-14c19f462c45",
+)
+```
+
+#### Response
+
+```python
+None
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+#### Request
+
+```ruby
+seam.user_identities.revoke_access_to_device(
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id: "054765c8-a2fc-4599-b486-14c19f462c45",
+)
+```
+
+#### Response
+
+```ruby
+nil
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+#### Request
+
+```php
+user_identities->revoke_access_to_device(
+ user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
+ device_id: "054765c8-a2fc-4599-b486-14c19f462c45"
+);
+```
+
+#### Response
+
+```php
+null
+```
+{% endtab %}
+
+{% tab title="Seam CLI" %}
+#### Request
+
+```seam_cli
+seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45"
+```
+
+#### Response
+
+```seam_cli
+{}
+```
+{% endtab %}
+
+{% tab title="Go" %}
+#### Request
+
+```go
+package main
+
+import api "github.com/seamapi/go"
+
+func main() {
+ client.UserIdentities.RevokeAccessToDevice(
+ context.Background(),
+ api.UserIdentitiesRevokeAccessToDeviceRequest{
+ UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"),
+ DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"),
+ },
+ )
+}
+```
+
+#### Response
+
+```go
+nil
+```
+{% endtab %}
+
+{% endtabs %}
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `device_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired managed device.
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the desired user identity.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/api/user_identities/update-a-user-identity.md b/docs/api/user_identities/update-a-user-identity.md
new file mode 100644
index 00000000..50d02a02
--- /dev/null
+++ b/docs/api/user_identities/update-a-user-identity.md
@@ -0,0 +1,2 @@
+# Update a User Identity
+
diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md
new file mode 100644
index 00000000..3b563826
--- /dev/null
+++ b/docs/api/user_identities/update.md
@@ -0,0 +1,63 @@
+# Update a User Identity
+
+```
+PATCH /user_identities/update ⇒ void
+```
+
+
+
+## Authentication Methods
+
+- API key
+- Personal access token
+
+## Request Parameters
+
+### `email_address`
+
+Type: `string`
+Required: No
+
+Unique email address for the user identity.
+
+***
+
+### `full_name`
+
+Type: `string`
+Required: No
+
+
+
+***
+
+### `phone_number`
+
+Type: `string`
+Required: No
+
+Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+
+***
+
+### `user_identity_id`
+
+Type: `string`
+Required: Yes
+
+ID of the user identity.
+
+***
+
+### `user_identity_key`
+
+Type: `string`
+Required: No
+
+Unique key for the user identity.
+
+***
+
+## Return Type
+
+void
diff --git a/docs/capability-guides/access-systems/assigning-credentials-to-users.md b/docs/capability-guides/access-systems/assigning-credentials-to-users.md
index 53fd3db1..e1735d50 100644
--- a/docs/capability-guides/access-systems/assigning-credentials-to-users.md
+++ b/docs/capability-guides/access-systems/assigning-credentials-to-users.md
@@ -12,7 +12,7 @@ This guide explains how to assign existing [credentials](managing-credentials.md
## Assign a Credential to an ACS User
-To [assign a credential to an ACS user](../../api-clients/acs/credentials/assign.md), provide both the `acs_user_id` and the `acs_credential_id`.
+To [assign a credential to an ACS user](../../api/acs/credentials/assign.md), provide both the `acs_user_id` and the `acs_credential_id`.
{% tabs %}
{% tab title="Python" %}
@@ -252,7 +252,7 @@ This response contains manufacturer-specific metadata that may vary by [manufact
## Unassign a Credential from an ACS User
-To [unassign a credential from an ACS user](../../api-clients/acs/credentials/unassign.md), provide both the `acs_user_id` and the `acs_credential_id`.
+To [unassign a credential from an ACS user](../../api/acs/credentials/unassign.md), provide both the `acs_user_id` and the `acs_credential_id`.
{% tabs %}
{% tab title="Python" %}
diff --git a/docs/capability-guides/access-systems/managing-credentials.md b/docs/capability-guides/access-systems/managing-credentials.md
index 67dfb20f..e9fa2e9b 100644
--- a/docs/capability-guides/access-systems/managing-credentials.md
+++ b/docs/capability-guides/access-systems/managing-credentials.md
@@ -4,7 +4,7 @@ description: Learn how to manage credentials and assign them to users.
# Managing Credentials
-An ACS generally uses digital means of access to authorize an [ACS user](../../products/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include RFID cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
+An ACS generally uses digital means of access to authorize an [ACS user](../../products/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
starts_at Format: datetime
+
+Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
+
Examples of ACS user credentials
Seam resource relationships for a credential-based ACS
| Creating and Encoding Card-based Credentials | creating-and-encoding-card-based-credentials.md | encode-card.png | ||
| Scanning Encoded Cards | scan-card.png |
| Error | Description |
|---|---|
no_card_on_encoder | No card was placed on the encoder. |
incompatible_card_format | A card with an incompatible card format was placed on the encoder. |
uncategorized_error | Any other encoding error. |
| Error | Description |
|---|---|
no_card_on_encoder | No card was placed on the encoder. |
uncategorized_error | Any other encoding error. |
| Property | Type | Description |
|---|---|---|
device.can_remotely_unlock | Boolean Optional | Indicates whether the device can perform a remote unlock operation. |
device.can_remotely_lock | Boolean Optional | Indicates whether the device can perform a remote lock operation. |
device.can_program_online_access_codes | Boolean Optional | Indicates whether the device can program online access codes. If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online. |
device.can_program_offline_access_codes | Boolean Optional | Indicates whether the device can program offline access codes. When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device. |
device.can_hvac_heat | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode. When this flag is true, you can set the thermostat to heat mode. |
device.can_hvac_cool | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode. When this flag is true, you can set the thermostat to cool mode. |
device.can_hvac_heat_cool | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode. When this flag is true, you can set the thermostat to heat-cool mode. |
device.can_turn_off_hvac | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode. When this flag is true, you can set the thermostat to "off" mode, which turns off both the heating and cooling systems for the space. |
| Property | Type | Description |
|---|---|---|
device.can_remotely_unlock | Boolean Optional | Indicates whether the device can perform a remote unlock operation. |
device.can_remotely_lock | Boolean Optional | Indicates whether the device can perform a remote lock operation. |
device.can_program_online_access_codes | Boolean Optional | Indicates whether the device can program online access codes. If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online. |
device.can_program_offline_access_codes | Boolean Optional | Indicates whether the device can program offline access codes. When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device. |
device.can_hvac_heat | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode. When this flag is true, you can set the thermostat to heat mode. |
device.can_hvac_cool | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode. When this flag is true, you can set the thermostat to cool mode. |
device.can_hvac_heat_cool | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode. When this flag is true, you can set the thermostat to heat-cool mode. |
device.can_turn_off_hvac | Boolean Optional | Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode. When this flag is true, you can set the thermostat to "off" mode, which turns off both the heating and cooling systems for the space. |
Type a unique Seam Bridge name and the pairing code from the Seam application installation.
Type a unique Seam Bridge name and the pairing code from the Seam Bridge application installation.
| Device Guides | Get started → | overview.md | image (9).png |
| Property | Description |
|---|---|
climate_preset_key | (Required) Key to identify the climate preset. |
name | (Optional) User-friendly name to identify the climate preset. |
fan_mode_setting | Desired fan mode setting, such as on, auto, or circulate. |
hvac_mode_setting | Desired HVAC mode setting, such as heat, cool, heat_cool, or off. |
cooling_set_point_celsius | Temperature to which the thermostat should cool (in °C). See also Set Points. |
cooling_set_point_fahrenheit | Temperature to which the thermostat should cool (in °F). |
heating_set_point_celsius | Temperature to which the thermostat should heat (in °C). |
heating_set_point_fahrenheit | Temperature to which the thermostat should heat (in °F). |
manual_override_allowed | (Optional) Indicates whether a person at the thermostat or using the API can change the thermostat's settings. Deprecated. Use thermostat_schedule.is_override_allowed instead. |
| Property | Description |
|---|---|
name | (Optional) User-friendly name to identify the thermostat schedule. |
climate_preset_key | (Required) Key of the climate preset to use for the thermostat schedule. |
max_override_period_minutes | Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. Default: 0See also Specifying Manual Override Permissions. |
starts_at | (Required) Date and time at which the thermostat schedule starts, in ISO 8601 format. |
ends_at | (Required) Date and time at which the thermostat schedule ends, in ISO 8601 format. |
Seam handles a fallback climate preset, along with multiple thermostat schedules.
| Parameter | Type | Description |
|---|---|---|
device_id | String (UUID) | ID of the device for which you want to retrieve device.connected or device.disconnected events |
event_type | String | Event type that you want to retrieve, that is, device.connected or device.disconnected |
since | String | Desired starting event generation date and time You must include since or between. |
between | Set of two strings | Desired starting and ending event generation dates and times For example: ["2024-01-01T00:00:00Z", "2024-02-01T00:00:00Z"]You must include between or since. |
| Parameter | Type | Description |
|---|---|---|
device_id | String (UUID) | ID of the device for which you want to retrieve device.connected or device.disconnected events |
event_type | String | Event type that you want to retrieve, that is, device.connected or device.disconnected |
since | String | Desired starting event generation date and time You must include since or between. |
between | Set of two strings | Desired starting and ending event generation dates and times For example: ["2024-01-01T00:00:00Z", "2024-02-01T00:00:00Z"]You must include between or since. |
| Command Stub | Description |
|---|---|
seam | Access all Seam CLI commands in an interactive manner. |
seam access-codes | Manage access codes. |
seam acs | Manage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials. |
seam action-attempts | List and get action attempts to poll the status of attempted actions, such as unlock and create access code. |
seam client-sessions | Manage client sessions that enable you to restrict users' interactions to include only the devices that they own. |
seam connect-webviews | Manage Connect Webviews that enable users to connect their devices to Seam. |
seam connected-accounts | Manage connected accounts that represent external, third-party accounts to which users have authorized Seam to access. |
seam devices | Manage devices, including both "managed" and "unmanaged" devices. |
seam events | Retrieve events. |
seam locks | Retrieve, lock, and unlock smart locks. |
seam login | Log back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token. |
seam logout | Log out of the Seam CLI. |
seam noise-sensors | Manage noise thresholds for noise sensors and simulate triggering noise threshold alerts. |
seam select | Select the desired workspace or server. |
seam thermostats | Manage thermostats, including current climate settings. |
seam user-identities | Manage user identities that enable you to issue and manage mobile credentials and access permissions for users. |
seam webhooks | Manage webhook endpoints that enable you to receive notifications of Seam-related events. |
seam workspaces | Manage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces. |
| Command Stub | Description |
|---|---|
seam | Access all Seam CLI commands in an interactive manner. |
seam access-codes | Manage access codes. |
seam acs | Manage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials. |
seam action-attempts | List and get action attempts to poll the status of attempted actions, such as unlock and create access code. |
seam client-sessions | Manage client sessions that enable you to restrict users' interactions to include only the devices that they own. |
seam connect-webviews | Manage Connect Webviews that enable users to connect their devices to Seam. |
seam connected-accounts | Manage connected accounts that represent external, third-party accounts to which users have authorized Seam to access. |
seam devices | Manage devices, including both "managed" and "unmanaged" devices. |
seam events | Retrieve events. |
seam locks | Retrieve, lock, and unlock smart locks. |
seam login | Log back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token. |
seam logout | Log out of the Seam CLI. |
seam noise-sensors | Manage noise thresholds for noise sensors and simulate triggering noise threshold alerts. |
seam select | Select the desired workspace or server. |
seam thermostats | Manage thermostats, including current climate settings. |
seam user-identities | Manage user identities that enable you to issue and manage mobile credentials and access permissions for users. |
seam webhooks | Manage webhook endpoints that enable you to receive notifications of Seam-related events. |
seam workspaces | Manage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces. |
Connect and control any 33 Locks device using the Seam API.
| 33 Lock Contact Page | https://www.33lock.com/contact | 33-lock-logo.png |
33 Lock smart locks
+{% endhint %}
+
+### Create a Connect Webview
+
+Create a `connect_webview` object and then note the returned URL.
+
+{% tabs %}
+{% tab title="Python" %}
+**Code:**
+
+```python
+from seam import Seam
+
+seam = Seam() # Seam automatically uses your exported SEAM_API_KEY.
+
+connect_webview = seam.connect_webviews.create(accepted_providers=["ttlock"])
+
+assert connect_webview.login_successful is False
+
+# Use the returned Connect Webview URL to display
+# the Connect Webview authorization flow to your user.
+print(connect_webview.url)
+```
+
+**Output:**
+
+```
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="cURL (bash)" %}
+**Code:**
+
+```bash
+curl -X 'POST' \
+ 'https://connect.getseam.com/connect_webviews/create' \
+ -H 'accept: application/json' \
+ -H "Authorization: Bearer ${SEAM_API_KEY}" \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "accepted_providers": ["ttlock"]
+}' | jq -r '"Login Successful (false): " + (.connect_webview.login_successful | tostring),
+ "URL: " + .connect_webview.url'
+ # Use the returned Connect Webview URL to display
+ # the Connect Webview authorization flow to your user.
+```
+
+**Output:**
+
+```
+Login Successful (false): false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="JavaScript" %}
+**Code:**
+
+```javascript
+import { Seam } from "seam";
+
+const seam = new Seam(); // Seam automatically uses your exported SEAM_API_KEY.
+
+const connectWebview = await seam.connectWebviews.create({
+ accepted_providers: ['ttlock']
+});
+
+console.log(connectWebview.login_successful); // false
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+console.log(connectWebview.url);
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+**Code:**
+
+```ruby
+require "seam"
+
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
+
+connect_webview = seam.connect_webviews.create(
+ accepted_providers: ["ttlock"]
+)
+
+puts connect_webview.login_successful # false
+
+# Use the returned Connect Webview URL to display
+# the Connect Webview authorization flow to your user.
+puts connect_webview.url
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+**Code:**
+
+```php
+connect_webviews->create(
+ accepted_providers: ["ttlock"]
+);
+
+echo $connect_webview->login_successful ? 'true' : 'false', "\n"; // false
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+echo $connect_webview->url;
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="C#" %}
+**Code:**
+
+```csharp
+using Seam.Client;
+
+var seam = new SeamClient(apiToken: SEAM_API_KEY);
+
+var connectWebview = seam.ConnectWebviews.Create(
+ acceptedProviders: new() {Seam.Api.ConnectWebviews.CreateRequest.AcceptedProvidersEnum.Ttlock}
+);
+
+Console.WriteLine(connectWebview.LoginSuccessful); // False
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+Console.WriteLine(connectWebview.Url);
+```
+
+**Output:**
+
+```
+False
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Java" %}
+**Code:**
+
+```java
+import java.io.Console;
+import java.util.*;
+import com.fasterxml.jackson.annotation.*;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.seam.api.Seam;
+import com.seam.api.core.ObjectMappers;
+import com.seam.api.types.ConnectWebview;
+import com.seam.api.types.Device;
+import com.seam.api.types.Manufacturer;
+import com.seam.api.types.ActionAttempt;
+import com.seam.api.types.AccessCode;
+import com.seam.api.resources.connectwebviews.requests.ConnectWebviewsCreateRequest;
+import com.seam.api.resources.connectwebviews.requests.ConnectWebviewsGetRequest;
+import com.seam.api.resources.devices.requests.DevicesListRequest;
+import com.seam.api.resources.devices.requests.DevicesGetRequest;
+import com.seam.api.resources.locks.requests.LocksUnlockDoorRequest;
+import com.seam.api.resources.accesscodes.requests.AccessCodesCreateRequest;
+import com.seam.api.resources.accesscodes.requests.AccessCodesListRequest;
+
+public class Main {
+
+ public static void main(String[] args) {
+
+ Seam seam = Seam.builder()
+ .apiKey(SEAM_API_KEY)
+ .build();
+
+ ConnectWebview connectWebview = seam.connectWebviews().create(ConnectWebviewsCreateRequest.builder()
+ .acceptedProviders(List.of(AcceptedProvider.TTLOCK))
+ .build());
+
+ System.out.println(connectWebview.getLoginSuccessful()); // false
+
+ // Use the returned Connect Webview URL to display
+ // the Connect Webview authorization flow to your user.
+ System.out.println(connectWebview.getUrl());
+
+ }
+}
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Go" %}
+**Code:**
+
+```go
+package main
+
+import (
+ "context"
+ "fmt"
+ "os"
+
+ api "github.com/seamapi/go"
+ seam "github.com/seamapi/go/client"
+)
+
+func main() {
+ if err := run(); err != nil {
+ _, _ = fmt.Fprintln(os.Stderr, err.Error())
+ os.Exit(1)
+ }
+}
+
+func run() error {
+ client := seam.NewClient(
+ seam.WithApiKey(SEAM_API_KEY),
+ )
+
+ connectWebview, err := client.ConnectWebviews.Create(
+ context.Background(),
+ &api.ConnectWebviewsCreateRequest{
+ AcceptedProviders: []api.AcceptedProvider{
+ api.AcceptedProviderTtlock,
+ },
+ },
+ )
+
+ if err != nil {
+ return err
+ }
+
+ fmt.Println(connectWebview.LoginSuccessful) // false
+
+ // Use the returned Connect Webview URL to display
+ // the Connect Webview authorization flow to your user.
+ fmt.Println(connectWebview.Url)
+
+ return nil
+}
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+{% endtabs %}
+
+***
+
+### Authorize your workspace
+
+In a web browser, go to the URL that the Connect Webview object returned.
+
+For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../seam-components/react-components/connect-account-button.md) within our suite of [Seam Components](../../seam-components/overview/) that help you build your device management flow.
+
+{% hint style="success" %}
+Because you're using a sandbox workspace, you can connect Seam's test TTLock account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices.
+{% endhint %}
+
+Complete the Connect Webview authorization flow by entering the following [TTLock sandbox account](../../device-guides/sandbox-and-sample-data/ttlock-sample-data.md) credentials:
+
+* **Email:** jane@example.com
+* **Password:** 1234
+
+
Use the Seam Connect Webview authorization flow to connect a TTLock account with Seam. This flow varies slightly based on the device manufacturer and region.
Seam Components make it easy to develop your application!
| Get an API Key (free) | Sign up for the Seam Console and get your API keys. → | seam-api-key.png | https://console.seam.co/ | |
| Contact Sales | Got a project or a specific question? Contact our team to get answers. → | seam-contact-us-light.png | https://www.seam.co/contact-us |
| 4SUITES Contact Us Form | https://www.4suiteshq.com/contact-us/ | 4suites-logo.png |
Connect and control any Akiles device using the Seam API.
| Capability | Required Accessories |
|---|---|
| Remote unlock |
|
| Access codes |
|
| Akiles Contact Page | https://akiles.app/en/contact | akiles-logo.png |
Akiles smart locks
+{% endhint %}
+
+### Create a Connect Webview
+
+Create a `connect_webview` object and then note the returned URL.
+
+{% tabs %}
+{% tab title="Python" %}
+**Code:**
+
+```python
+from seam import Seam
+
+seam = Seam() # Seam automatically uses your exported SEAM_API_KEY.
+
+connect_webview = seam.connect_webviews.create(accepted_providers=["akiles"])
+
+assert connect_webview.login_successful is False
+
+# Use the returned Connect Webview URL to display
+# the Connect Webview authorization flow to your user.
+print(connect_webview.url)
+```
+
+**Output:**
+
+```
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="cURL (bash)" %}
+**Code:**
+
+```bash
+curl -X 'POST' \
+ 'https://connect.getseam.com/connect_webviews/create' \
+ -H 'accept: application/json' \
+ -H "Authorization: Bearer ${SEAM_API_KEY}" \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "accepted_providers": ["akiles"]
+}' | jq -r '"Login Successful (false): " + (.connect_webview.login_successful | tostring),
+ "URL: " + .connect_webview.url'
+ # Use the returned Connect Webview URL to display
+ # the Connect Webview authorization flow to your user.
+```
+
+**Output:**
+
+```
+Login Successful (false): false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="JavaScript" %}
+**Code:**
+
+```javascript
+import { Seam } from "seam";
+
+const seam = new Seam(); // Seam automatically uses your exported SEAM_API_KEY.
+
+const connectWebview = await seam.connectWebviews.create({
+ accepted_providers: ['akiles']
+});
+
+console.log(connectWebview.login_successful); // false
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+console.log(connectWebview.url);
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Ruby" %}
+**Code:**
+
+```ruby
+require "seam"
+
+seam = Seam.new() # Seam automatically uses your exported SEAM_API_KEY.
+
+connect_webview = seam.connect_webviews.create(
+ accepted_providers: ["akiles"]
+)
+
+puts connect_webview.login_successful # false
+
+# Use the returned Connect Webview URL to display
+# the Connect Webview authorization flow to your user.
+puts connect_webview.url
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="PHP" %}
+**Code:**
+
+```php
+connect_webviews->create(
+ accepted_providers: ["akiles"]
+);
+
+echo $connect_webview->login_successful ? 'true' : 'false', "\n"; // false
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+echo $connect_webview->url;
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="C#" %}
+**Code:**
+
+```csharp
+using Seam.Client;
+
+var seam = new SeamClient(apiToken: SEAM_API_KEY);
+
+var connectWebview = seam.ConnectWebviews.Create(
+ acceptedProviders: new() {Seam.Api.ConnectWebviews.CreateRequest.AcceptedProvidersEnum.Akiles}
+);
+
+Console.WriteLine(connectWebview.LoginSuccessful); // False
+
+// Use the returned Connect Webview URL to display
+// the Connect Webview authorization flow to your user.
+Console.WriteLine(connectWebview.Url);
+```
+
+**Output:**
+
+```
+False
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Java" %}
+**Code:**
+
+```java
+import java.io.Console;
+import java.util.*;
+import com.fasterxml.jackson.annotation.*;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.seam.api.Seam;
+import com.seam.api.core.ObjectMappers;
+import com.seam.api.types.ConnectWebview;
+import com.seam.api.types.Device;
+import com.seam.api.types.Manufacturer;
+import com.seam.api.types.ActionAttempt;
+import com.seam.api.types.AccessCode;
+import com.seam.api.resources.connectwebviews.requests.ConnectWebviewsCreateRequest;
+import com.seam.api.resources.connectwebviews.requests.ConnectWebviewsGetRequest;
+import com.seam.api.resources.devices.requests.DevicesListRequest;
+import com.seam.api.resources.devices.requests.DevicesGetRequest;
+import com.seam.api.resources.locks.requests.LocksUnlockDoorRequest;
+import com.seam.api.resources.accesscodes.requests.AccessCodesCreateRequest;
+import com.seam.api.resources.accesscodes.requests.AccessCodesListRequest;
+
+public class Main {
+
+ public static void main(String[] args) {
+
+ Seam seam = Seam.builder()
+ .apiKey(SEAM_API_KEY)
+ .build();
+
+ ConnectWebview connectWebview = seam.connectWebviews().create(ConnectWebviewsCreateRequest.builder()
+ .acceptedProviders(List.of(AcceptedProvider.AKILES))
+ .build());
+
+ System.out.println(connectWebview.getLoginSuccessful()); // false
+
+ // Use the returned Connect Webview URL to display
+ // the Connect Webview authorization flow to your user.
+ System.out.println(connectWebview.getUrl());
+
+ }
+}
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+
+{% tab title="Go" %}
+**Code:**
+
+```go
+package main
+
+import (
+ "context"
+ "fmt"
+ "os"
+
+ api "github.com/seamapi/go"
+ seam "github.com/seamapi/go/client"
+)
+
+func main() {
+ if err := run(); err != nil {
+ _, _ = fmt.Fprintln(os.Stderr, err.Error())
+ os.Exit(1)
+ }
+}
+
+func run() error {
+ client := seam.NewClient(
+ seam.WithApiKey(SEAM_API_KEY),
+ )
+
+ connectWebview, err := client.ConnectWebviews.Create(
+ context.Background(),
+ &api.ConnectWebviewsCreateRequest{
+ AcceptedProviders: []api.AcceptedProvider{
+ api.AcceptedProviderAkiles,
+ },
+ },
+ )
+
+ if err != nil {
+ return err
+ }
+
+ fmt.Println(connectWebview.LoginSuccessful) // false
+
+ // Use the returned Connect Webview URL to display
+ // the Connect Webview authorization flow to your user.
+ fmt.Println(connectWebview.Url)
+
+ return nil
+}
+```
+
+**Output:**
+
+```
+false
+https://connect.getseam.com/connect_webviews/view?connect_webview_id=12345678-1234-1234-1234-123456789012&auth_token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+{% endtab %}
+{% endtabs %}
+
+***
+
+### Authorize your workspace
+
+In a web browser, go to the URL that the Connect Webview object returned.
+
+For application developers, you can redirect your user to this Connect Webview URL so that they can authorize your app to control their devices using Seam. We even provide a prebuilt [Connect Account Button](../../seam-components/react-components/connect-account-button.md) within our suite of [Seam Components](../../seam-components/overview/) that help you build your device management flow.
+
+{% hint style="success" %}
+Because you're using a sandbox workspace, you can connect Seam's test Akiles account. We provide [virtual devices](../../device-guides/sandbox-and-sample-data/) for each of the brands that we support. These sandbox devices and systems enable you to test your app with devices from multiple brands without the need to own all the corresponding physical devices.
+{% endhint %}
+
+Complete the Connect Webview authorization flow by entering the following [Akiles sandbox account](../../developer-tools/sandbox-and-sample-data/sandbox-akiles-locks.md) credentials:
+
+* **Email:** jane@example.com
+* **Password:** 1234
+
+
Use the Seam Connect Webview authorization flow to connect an Akiles account with Seam. This flow varies slightly based on the device manufacturer.
// Get the device by ID.
+const updatedFrontDoor = await seam.devices.get({device_id: frontDoor.device_id});
+
+// Inspect the locked property to confirm
+// that the unlock operation was successful.
+console.log(updatedFrontDoor.properties.locked) // false
+Seam Components make it easy to develop your application!
| Get an API Key (free) | Sign up for the Seam Console and get your API keys. → | seam-api-key.png | https://console.seam.co/ | |
| Contact Sales | Got a project or a specific question? Contact our team to get answers. → | seam-contact-us-light.png | https://www.seam.co/contact-us |
| Property | Type | Description |
|---|---|---|
is_multi_phone_sync_credential | Boolean Optional | Indicates whether the credential is a multi-phone sync credential. When creating a Seam mobile key for a Visionline ACS, you must set this property to true. |
allowed_acs_entrance_ids | Array of strings Optional | List of ACS entrance IDs to which you want to grant the specified ACS user access. |
starts_at | ISO 8601 format Optional | Starting timestamp for credential activation. |
ends_at | ISO 8601 format Optional | Ending timestamp for credential expiration. |
| Property | Type | Description |
|---|---|---|
is_multi_phone_sync_credential | Boolean Optional | Indicates whether the credential is a multi-phone sync credential. When creating a Seam mobile key for a Visionline ACS, you must set this property to true. |
allowed_acs_entrance_ids | Array of strings Optional | List of ACS entrance IDs to which you want to grant the specified ACS user access. |
starts_at | ISO 8601 format Optional | Starting timestamp for credential activation. |
ends_at | ISO 8601 format Optional | Ending timestamp for credential expiration. |
| Seam Resource | Description |
|---|---|
| Individual who has been granted access to specific entrance within a building. A user could be a resident or temporary guest. |
| Physical points of entry within a property that are secured with Latch's smart access devices. |
| PIN codes or mobile keys. You can only assign one entrance to a key code-based credential. You can assign multiple entrances to mobile keys. |
| Seam Resource | Description |
|---|---|
| Individual who has been granted access to specific entrances within a building. A user could be a resident or temporary guest. |
| Physical points of entry within a property that are secured with Latch's smart access devices. |
| PIN codes or mobile keys. You can only assign one entrance to a key code-based credential. You can assign multiple entrances to mobile keys. |
| Lockly | https://lockly.com/collections/door-lock | lockly-logo.png |
| 2N Intercom Systems | 2n-logo.png | 2n-intercom-systems.md | ||
| 4SUITES Locks | 4suites-logo.png | 4suites-locks | ||
| August Locks | august-logo.png | august-locks.md | ||
| dormakaba Oracode Locks | dormakaba-logo.png | dormakaba-oracode-locks.md | ||
| iglooHome Locks | igloohome-logo.png | igloohome-locks.md | ||
| Kwikset Locks | kwikset-logo.png | kwikset-locks.md | ||
| Lockly Locks | lockly-logo.png | lockly-locks | ||
| Nuki Locks | nuki-logo.png | nuki-locks.md | ||
| Salto Locks | salto-logo.png | salto-locks.md | ||
| Schlage Locks | schlage-logo.png | get-started-with-schlage-locks.md | ||
| SmartThings Hubs + Smart Locks | smartthings-logo.png | get-started-with-smartthings-hubs-+-smart-locks.md | ||
| Tedee Locks | tedee-logo.png | tedee-locks | ||
| TTLock Locks | ttlock-logo.png | ttlock-locks.md | ||
| Wyze Locks | wyze-logo.png | wyze-locks.md | ||
| Yale Locks | yale-logo.png | yale-locks.md |
| 2N Intercom Systems | 2n-logo.png | 2n-intercom-systems.md | ||
| 4SUITES Locks | 4suites-logo.png | 4suites-locks | ||
| Akiles Locks | akiles-logo.png | akiles-locks | ||
| August Locks | august-logo.png | august-locks.md | ||
| dormakaba Oracode Locks | dormakaba-logo.png | dormakaba-oracode-locks.md | ||
| iglooHome Locks | igloohome-logo.png | igloohome-locks.md | ||
| Kwikset Locks | kwikset-logo.png | kwikset-locks.md | ||
| Lockly Locks | lockly-logo.png | lockly-locks | ||
| Nuki Locks | nuki-logo.png | nuki-locks.md | ||
| Salto Locks | salto-logo.png | salto-locks.md | ||
| Schlage Locks | schlage-logo.png | get-started-with-schlage-locks.md | ||
| SmartThings Hubs + Smart Locks | smartthings-logo.png | get-started-with-smartthings-hubs-+-smart-locks.md | ||
| Tedee Locks | tedee-logo.png | tedee-locks | ||
| TTLock Locks | ttlock-logo.png | ttlock-locks.md | ||
| Wyze Locks | wyze-logo.png | wyze-locks.md | ||
| Yale Locks | yale-logo.png | yale-locks.md |
| ASSA ABLOY Credential Services | assa-abloy-logo.png | assa-abloy-credential-services-credential-manager-in-development.md | ||
| ASSA ABLOY Visionline Access Control System | assa-abloy-logo.png | assa-abloy-visionline-access-control-system-in-development | ||
| Avigilon Alta Access System | avigilon-alta-logo.png | avigilon-alta-access-system.md | ||
| Brivo Access | brivo-logo.png | brivo-access.md | ||
| PTI Storlogix Cloud | pti-logo.png | pti-storlogix-cloud.md |
| ASSA ABLOY Credential Services | assa-abloy-logo.png | assa-abloy-credential-services-credential-manager-in-development.md | ||
| ASSA ABLOY Visionline Access Control System | assa-abloy-logo.png | assa-abloy-visionline-access-control-system-in-development | ||
| Avigilon Alta Access System | avigilon-alta-logo.png | avigilon-alta-access-system.md | ||
| Brivo Access | brivo-logo.png | brivo-access.md | ||
| PTI Storlogix Cloud | pti-logo.png | pti-storlogix-cloud.md | ||
| Salto KS | salto-logo.png | salto-ks-access-control-system |
Connect and control your Salto KS ACS using the Seam API.
Seam resources enable you to manage your Salto KS ACS intuitively.
| Seam Resource | Description |
|---|---|
| Individual who has been granted access to specific entrances within a property. ACS users could include employees, residents, and temporary guests. You can configure access schedules for users, if desired. You assign a unique credential to each user. |
| Collection of users with shared access permissions. Instead of assigning permissions individually, users are grouped based on their access needs. Access groups streamline the management of access rights and ensure consistency. |
| Timeframe during which access is permitted. By associating schedules with ACS users and then assigning users to access groups, property managers can control when users can enter specific areas, enhancing security and operational efficiency. If you set an access schedule for a Salto KS ACS user, the user appears as "unsubscribed" in the ACS until the starts_at time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access. |
| Physical points of entry within a property that are secured with Salto KS smart access devices. Access permissions are assigned to these entrances through access groups and access schedules. |
| PINs, key cards or tags, or mobile keys.
|
| Salto KS Sales Contact Page | https://saltosystems.com/en/contact/ | salto-logo.png |
| Product Models | Compatibility |
|---|---|
| Schlage Encode and Encode Plus Smart Wi-Fi Deadbolt | Compatible only with the Schlage Home App. |
| Schlage Connect Smart Deadbolt | Compatible only with a compatible Z-Wave hub. Seam supports integration with the SmartThings hub. |
| Schlage Connected Keypad | Compatible only with a compatible Z-Wave hub. Seam supports integration with the SmartThings hub. |
| Schlage Sense lock | Contact Seam Support. |
| Schlage | https://www.schlage.com/en/home/products/smart-deadbolts-levers.html | schlage-logo.png | ||
| Schlage Products on Amazon | https://amzn.to/3ZlSDWS | schlage-on-amazon.png |
| Capability | Required Accessories |
|---|---|
| Remote lock/unlock |
|
| Access codes |
|
| Tedee Online Store | https://tedee.com/shop/ | tedee-logo.png |
| Product Models | Compatibility | Accessories |
|---|---|---|
| Wi-Fi Smart Lock | Compatible |
|
| Smart Lock Pro | Compatible only with Connect Wi-Fi Bridge |
|
| Smart Lock | Compatible only with Connect Wi-Fi Bridge |
|
| August | https://august.com/ | august-logo.png | ||
| August Products on Amazon | https://amzn.to/3sVFNTl | august-on-amazon.png |
| Avigilon Quote Request | https://www.avigilon.com/quote | avigilon-alta-logo.png |
| Lock Brand | Integration Description |
|---|---|
| Allegion | Brivo partners with Allegion to provide AD Series, LE, NDE, and Control® wireless locks for multifamily and commercial real estate uses. |
| ASSA ABLOY Aperio™ | Brivo provides a variety of ASSA ABLOY Aperio locks for small, medium, and enterprise uses. |
| Z-Wave | Brivo provides a variety of Z-Wave-supported locks for multifamily residential doors connected to the Brivo Smart Home. |
| Salto | Brivo supports various Salto wireless locks. |
| Brivo Contact Us Page | https://www.brivo.com/about/contact-us/ | brivo-logo.png |
| ecobee Online Store | https://www.ecobee.com/en-us/smart-thermostats/ | ecobee-logo.png |
Salto Locks
Seam Connect Webview flow to connect Salto account with Seam
Seam Connect Webview flow to connect your Salto KS account with Seam
| igloohome | https://store-us.igloohome.co/ | igloohome-logo.png |
Disable 2-Step Verification before connecting your Kwikset account to Seam.
| Minut Online Store | https://store.minut.com/ | minut-logo.png |
| NoiseAware Online Store | https://noiseaware.com/cart/ | noiseaware-logo.png |
| Product Models | Compatibility | Accessories |
|---|---|---|
| Smart Lock | Compatible only with Nuki Bridge |
|
| Smart Lock Pro | Compatible |
|
| Opener | Compatible only with Nuki Bridge |
|
| Nuki Online Store | https://shop.nuki.io/en/ | nuki-logo.png |
| PTI Security Systems Sales Contact Us Page | https://ptisecurity.com/contact-us-sales/ | contact-pti-sales.png |
| Salto Systems Sales Contact | https://saltosystems.com/en-us/offices/ | Broken file |
| Salto Systems Sales Contact | https://saltosystems.com/en-us/offices/ | salto-logo.png |
Smart Gateway G2 | This gateway uses a Wifi connection to connect the door locks to the internet. | G2-TT-Lock-App-Gateway-Bluetooth-Smart-Electronic-Door-Lock-Wifi-Adapter-2 copy (1).png | https://amzn.to/3qBcG6H | |
Wired gateway G3/G3P (PoE power supply) | This gateway uses a wired Power-over-ethernet connection to bridge the locks to the internet. | TTLock-APP-Device-G3-Gateway-Bluetooth-compatible-To-RJ45-Ethernet-Bridge-For-Remote-Control-Lock.jpg_ copy (1).png | https://www.aliexpress.us/item/2255800336116314.html?spm=a2g0o.productlist.main.1.9cbd43b3ctHfxZ&algo_pvid=32dab18b-38f8-4119-8e58-24e42b4bc733&aem_p4p_detail=2023081416370273984849672280003173903&algo_exp_id=32dab18b-38f8-4119-8e58-24e42b4bc733-0&pdp_npi=4%40dis%21USD%2125.88%2122.0%21%21%2125.88%21%21%40210321c616920562226965846e9d3e%2112000031234243953%21sea%21US%210%21A&curPageLogUid=gVdrDzS7hmgF&search_p4p_id=2023081416370273984849672280003173903_1 |
| Wyze Online Store | https://www.wyze.com/products/wyze-lock | wyze-logo.png |
| ACS Resource | Description |
|---|---|
| The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS. For more information, see Retrieving ACS System Details. |
| The set of users who access the entrances. For more information, see Managing ACS Users. |
| Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users. For more information, see Assigning ACS Users to Access Groups. |
| A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes. For more information, see Managing Credentials. |
| The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object. For more information, see Retrieving Entrance Details. |
| ACS Resource | Description |
|---|---|
| The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS. For more information, see Retrieving ACS System Details. |
| The set of users who access the entrances. For more information, see Managing ACS Users. |
| Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users. For more information, see Assigning ACS Users to Access Groups. |
| A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes. For more information, see Managing Credentials. |
| The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object. For more information, see Retrieving Entrance Details. |
.png){kind=link}
.png){kind=link}
.png){kind=link}
| ecobee Thermostats | ecobee-thermostats.md | ecobee-logo.png | |||
| Google Nest Thermostats | google-nest-thermostats | nest-logo.png | |||
| Honeywell Resideo Thermostats | honeywell-thermostats | honeywell_logo.png |
| Fan mode | Description |
|---|---|
on | The fan runs all the time, regardless of whether the HVAC system is cooling or heating. |
auto | The fan runs whenever the HVAC system is cooling or heating but does not run at other times. |
circulate | The fan runs for a specific number of minutes each hour, regardless of whether the HVAC system is cooling or heating. This setting is only supported on certain Honeywell thermostats. |
| Climate Setting Request | Description |
|---|---|
| Heat | Set the thermostat to heat mode. |
| Cool | Set the thermostat to cool mode. |
| Heat-Cool | Set the thermostat to dual heat-cool (auto) mode. |
| Off | Turn off the thermostat. |
| Fan Mode | Set the fan mode to on or off. |
| Category | Details |
|---|---|
| Current conditions | Current temperature in Fahrenheit and Celsius, current relative humidity, and so on. |
| Current operational status | Whether the associated HVAC system is currently heating or cooling, whether the fan is currently running. |
| Available HVAC modes for the thermostat | heat, cool, heat_cool, and off. |
| Available fan modes for the thermostat | on, auto, and circulate. |
| Thermostat capability flags | Capabilities of the thermostat—at a granular level. These capability flags include the following:
|
| Available climate presets | Climate presets that you can activate and schedule on the thermostat. |
| Climate preset constraints | Constraints related to climate presets for the specific thermostat brand or model. For example, a thermostat might have a minimum or maximum cooling or heating set point or a minimum delta between the cooling and heating set points. |
[Device(
- device_id='518f692b-f865-4590-8c3e-3849e9984c75',
- device_type='ecobee_thermostat',
- location=None,
+```
+[
+ Device(
+ can_hvac_cool=True,
+ can_hvac_heat=True,
+ can_hvac_heat_cool=True,
+ can_turn_off_hvac=True,
+ device_id='a4b775e3-feb2-4c6b-8e78-a73ec2d70b61',
+ device_type='nest_thermostat',
properties={
- 'available_hvac_mode_settings': ['off', 'cool', 'heat', 'heat_cool'],
- 'current_climate_setting': {
- 'cooling_set_point_celsius': 25,
- 'cooling_set_point_fahrenheit': 77,
- 'heating_set_point_celsius': 20,
- 'heating_set_point_fahrenheit': 68,
- 'hvac_mode_setting': 'heat_cool',
- 'manual_override_allowed': True
- },
- 'ecobee_metadata': {
- 'device_name': 'Thermostat 1',
- 'ecobee_device_id': 'a64074f3-a0aa-4dbb-bbd3-f17f61701602'
- },
- 'fan_mode_setting': 'auto',
- 'has_direct_power': True,
- 'image_alt_text': 'Ecobee 3 Lite Thermostat',
- 'image_url': 'https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png',
- 'is_cooling': False,
- 'is_fan_running': False,
- 'is_heating': False,
- 'is_temporary_manual_override_active': False,
- 'manufacturer': 'ecobee',
- 'max_cooling_set_point_celsius': 33.333333333333336,
- 'max_cooling_set_point_fahrenheit': 92,
- 'max_heating_set_point_celsius': 26.11111111111111,
- 'max_heating_set_point_fahrenheit': 79,
- 'min_cooling_set_point_celsius': 18.333333333333336,
- 'min_cooling_set_point_fahrenheit': 65,
- 'min_heating_cooling_delta_celsius': 2.7777777777777777,
- 'min_heating_cooling_delta_fahrenheit': 5,
- 'min_heating_set_point_celsius': 7.222222222222222,
- 'min_heating_set_point_fahrenheit': 45,
- 'model': {
- 'accessory_keypad_supported': False,
- 'display_name': 'Thermostat',
- 'manufacturer_display_name': 'Ecobee',
- 'offline_access_codes_supported': False,
- 'online_access_codes_supported': True
- },
- 'name': 'Thermostat 1',
- 'online': True,
- 'relative_humidity': 0.36,
- 'temperature_celsius': 21.11111111111111,
- 'temperature_fahrenheit': 70
+ 'available_hvac_mode_settings': [
+ 'heat',
+ 'cool',
+ 'heat_cool',
+ 'off'
+ ],
+ 'current_climate_setting': {
+ 'display_name': 'eco',
+ 'cooling_set_point_celsius': 25,
+ 'cooling_set_point_fahrenheit': 77,
+ 'heating_set_point_celsius': 20,
+ 'heating_set_point_fahrenheit': 68,
+ 'hvac_mode_setting': 'heat_cool',
+ 'manual_override_allowed': True
+ },
+ 'is_cooling': False,
+ 'is_fan_running': False,
+ 'is_heating': False,
+ 'manufacturer': 'nest',
+ 'online': True,
+ 'relative_humidity': 0.46,
+ 'temperature_celsius': 24.64,
+ 'temperature_fahrenheit': 76.352,
+ ...
},
- capabilities_supported=['thermostat'],
- errors=[],
- warnings=[],
- connected_account_id='2c00bc71-bca5-42c2-a1c5-74fd93ffcba1',
- workspace_id='398d80b7-3f96-47c2-b85a-6f8ba21d07be',
- created_at='2023-10-30T10:36:18.387Z',
- is_managed=True
-)]
-| Name | Type | Description |
|---|---|---|
disableFilter | boolean Optional | Hide the controls to filter the table. Default: false |
manufacturers | array Optional | Only show devices from specified manufacturers. |
excludedManufacturers | array Optional | Hide devices from specified manufacturers. |
className | string Optional | Class name to add to the containing element of the rendered component. |
-{{this.name}}
+
+
+
{{#if this.description}}
{{this.description}}
{{/if}}
+
+
{{/each}}
{{/if}}
@@ -44,18 +48,18 @@ Possible enum values:
{{/each}}
{{/each}}
-# Endpoints
+## Endpoints
{{#each endpoints}}
-## [`{{path}}`](./{{name}}.md)
+### [`{{path}}`](./{{name}}.md)
{{description}}
{{/each}}
{{#if events.length}}
-# Events
+## Events
{{~#each events}}
-## `{{name}}`
+### `{{name}}`
{{description}}
diff --git a/src/layouts/report.hbs b/src/layouts/report.hbs
new file mode 100644
index 00000000..fe94181f
--- /dev/null
+++ b/src/layouts/report.hbs
@@ -0,0 +1,277 @@
+# Documentation Report
+{{#if (or noTitle.routes.length noTitle.endpoints.length noTitle.namespaces.length )}}
+
+## Untitled
+{{#if noTitle.namespaces.length }}
+
+### Namespaces
+
+{{#each noTitle.namespaces}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{#if noTitle.routes.length }}
+
+### Routes
+
+{{#each noTitle.routes}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{#if noTitle.endpoints.length }}
+
+### Endpoints
+
+{{#each noTitle.endpoints}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{/if}}
+{{#if (or undocumented.routes.length undocumented.resources.length undocumented.resourceProperties.length undocumented.namespaces.length undocumented.endpoints.length undocumented.parameters.length)}}
+
+## Undocumented
+
+These items are intentionally undocumented.
+{{#if undocumented.routes.length }}
+
+### Routes
+
+{{#each undocumented.routes}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if undocumented.resources.length }}
+
+### Resources
+
+{{#each undocumented.resources}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if undocumented.resourceProperties.length }}
+
+### Resource properties
+
+{{#each undocumented.resourceProperties}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if undocumented.namespaces.length }}
+
+### Namespaces
+
+{{#each undocumented.namespaces}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if undocumented.endpoints.length }}
+
+### Endpoints
+
+{{#each undocumented.endpoints}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if undocumented.parameters.length }}
+
+### Endpoint parameters
+
+{{#each undocumented.parameters}}
+- `{{path}}`
+ {{#each params}}
+ - `{{name}}`: {{reason}}
+ {{/each}}
+{{/each}}
+{{/if}}
+{{/if}}
+{{#if (or noDescription.routes.length noDescription.resources.length noDescription.resourceProperties.length noDescription.namespaces.length noDescription.endpoints.length noDescription.parameters.length)}}
+
+## No Description
+
+These items have an empty description.
+Items that are intentionally undocumented are not included in this section.
+{{#if noDescription.routes.length }}
+
+### Routes
+
+{{#each noDescription.routes}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{#if noDescription.resources.length }}
+
+### Resources
+
+{{#each noDescription.resources}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{#if noDescription.resourceProperties.length }}
+
+### Resource properties
+
+{{#each noDescription.resourceProperties}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{#if noDescription.namespaces.length }}
+
+### Namespaces
+
+{{#each noDescription.namespaces}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{#if noDescription.endpoints.length }}
+
+### Endpoints
+
+{{#each noDescription.endpoints}}
+- `{{name}}`
+{{/each}}
+{{/if}}
+{{#if noDescription.parameters.length }}
+
+### Endpoint parameters
+
+{{#each noDescription.parameters}}
+- `{{path}}`
+ {{#each params}}
+ - `{{name}}`
+ {{/each}}
+{{/each}}
+{{/if}}
+{{/if}}
+{{#if (or draft.routes.length draft.resources.length draft.resourceProperties.length draft.namespaces.length draft.endpoints.length draft.parameters.length)}}
+
+## Draft
+
+These items have been marked as draft.
+{{#if draft.routes.length }}
+
+### Routes
+
+{{#each draft.routes}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if draft.resources.length }}
+
+### Resources
+
+{{#each draft.resources}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if draft.resourceProperties.length }}
+
+### Resource properties
+
+{{#each draft.resourceProperties}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if draft.namespaces.length }}
+
+### Namespaces
+
+{{#each draft.namespaces}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if draft.endpoints.length }}
+
+### Endpoints
+
+{{#each draft.endpoints}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if draft.parameters.length }}
+
+### Endpoint parameters
+
+{{#each draft.parameters}}
+- `{{path}}`
+ {{#each params}}
+ - `{{name}}`: {{reason}}
+ {{/each}}
+{{/each}}
+{{/if}}
+{{/if}}
+{{#if (or deprecated.routes.length deprecated.resources.length deprecated.resourceProperties.length deprecated.namespaces.length deprecated.endpoints.length deprecated.parameters.length)}}
+
+## Deprecated
+
+These items are deprecated.
+{{#if deprecated.routes.length }}
+
+### Routes
+
+{{#each deprecated.routes}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if deprecated.resources.length }}
+
+### Resources
+
+{{#each deprecated.resources}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if deprecated.resourceProperties.length }}
+
+### Resource properties
+
+{{#each deprecated.resourceProperties}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if deprecated.namespaces.length }}
+
+### Namespaces
+
+{{#each deprecated.namespaces}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if deprecated.endpoints.length }}
+
+### Endpoints
+
+{{#each deprecated.endpoints}}
+- `{{name}}`: {{reason}}
+{{/each}}
+{{/if}}
+{{#if deprecated.parameters.length }}
+
+### Endpoint parameters
+
+{{#each deprecated.parameters}}
+- `{{path}}`
+ {{#each params}}
+ - `{{name}}`: {{reason}}
+ {{/each}}
+{{/each}}
+{{/if}}
+{{/if}}
+{{#if extraResponseKeys.length }}
+
+### Extra response keys
+
+{{#each extraResponseKeys}}
+- `{{path}}`
+ {{#each keys}}
+ - `{{this}}`
+ {{/each}}
+{{/each}}
+{{/if}}
+{{#if endpointsWithoutCodeSamples.length }}
+
+### Endpoints without code samples
+
+{{#each endpointsWithoutCodeSamples}}
+- `{{this}}`
+{{/each}}
+{{/if}}
diff --git a/src/lib.d.ts b/src/lib.d.ts
index 4751c32d..f7ed087e 100644
--- a/src/lib.d.ts
+++ b/src/lib.d.ts
@@ -1 +1,6 @@
declare module '@prettier/plugin-php/standalone'
+declare module '@prettier/plugin-ruby' {
+ import type { Plugin } from 'prettier'
+ const plugin: Plugin
+ export default plugin
+}
diff --git a/src/lib/format-code.ts b/src/lib/format-code.ts
index 65e66cc1..4a0d86d6 100644
--- a/src/lib/format-code.ts
+++ b/src/lib/format-code.ts
@@ -1,4 +1,5 @@
import * as prettierPluginPhp from '@prettier/plugin-php/standalone'
+import * as prettierPluginRuby from '@prettier/plugin-ruby'
import type { CodeSampleSyntax } from '@seamapi/blueprint'
import commandExists from 'command-exists'
import { execa } from 'execa'
@@ -25,6 +26,8 @@ export const formatCodeForSyntax = async (
return await formatRuby(content)
case 'php':
return await formatPhp(content)
+ case 'go':
+ return await formatGo(content)
case 'bash':
return await formatBash(content)
case 'json':
@@ -51,15 +54,24 @@ const formatPython = async (content: string): Promise