seam 2.132.0 → 2.133.0

data/lib/seam/routes/access_methods_unmanaged.rb

@@ -8,12 +8,21 @@ module Seam
         @defaults = defaults
       end
 
+      # Gets an unmanaged access method (where is_managed = false).
+      # @param access_method_id ID of unmanaged access method to get.
+      # @return [Seam::Resources::UnmanagedAccessMethod] OK
       def get(access_method_id:)
         res = @client.post("/access_methods/unmanaged/get", {access_method_id: access_method_id}.compact)
 
         Seam::Resources::UnmanagedAccessMethod.load_from_response(res.body["access_method"])
       end
 
+      # Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.
+      # @param access_grant_id ID of Access Grant to list unmanaged access methods for.
+      # @param acs_entrance_id ID of the entrance for which you want to retrieve all unmanaged access methods.
+      # @param device_id ID of the device for which you want to retrieve all unmanaged access methods.
+      # @param space_id ID of the space for which you want to retrieve all unmanaged access methods.
+      # @return [Seam::Resources::UnmanagedAccessMethod] OK
       def list(access_grant_id:, acs_entrance_id: nil, device_id: nil, space_id: nil)
         res = @client.post("/access_methods/unmanaged/list", {access_grant_id: access_grant_id, acs_entrance_id: acs_entrance_id, device_id: device_id, space_id: space_id}.compact)
 

data/lib/seam/routes/acs_access_groups.rb

@@ -8,42 +8,70 @@ module Seam
         @defaults = defaults
       end
 
+      # Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group to which you want to add an access system user.
+      # @param acs_user_id ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+      # @return [nil] OK
       def add_user(acs_access_group_id:, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/access_groups/add_user", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Deletes a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group that you want to delete.
+      # @return [nil] OK
       def delete(acs_access_group_id:)
         @client.post("/acs/access_groups/delete", {acs_access_group_id: acs_access_group_id}.compact)
 
         nil
       end
 
+      # Returns a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group that you want to get.
+      # @return [Seam::Resources::AcsAccessGroup] OK
       def get(acs_access_group_id:)
         res = @client.post("/acs/access_groups/get", {acs_access_group_id: acs_access_group_id}.compact)
 
         Seam::Resources::AcsAccessGroup.load_from_response(res.body["acs_access_group"])
       end
 
+      # Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_system_id ID of the access system for which you want to retrieve all access groups.
+      # @param acs_user_id ID of the access system user for which you want to retrieve all access groups.
+      # @param search String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`.
+      # @param user_identity_id ID of the user identity for which you want to retrieve all access groups.
+      # @return [Seam::Resources::AcsAccessGroup] OK
       def list(acs_system_id: nil, acs_user_id: nil, search: nil, user_identity_id: nil)
         res = @client.post("/acs/access_groups/list", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, search: search, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsAccessGroup.load_from_response(res.body["acs_access_groups"])
       end
 
+      # Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group for which you want to retrieve all accessible entrances.
+      # @return [Seam::Resources::AcsEntrance] OK
       def list_accessible_entrances(acs_access_group_id:)
         res = @client.post("/acs/access_groups/list_accessible_entrances", {acs_access_group_id: acs_access_group_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
       end
 
+      # Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group for which you want to retrieve all access system users.
+      # @return [Seam::Resources::AcsUser] OK
       def list_users(acs_access_group_id:)
         res = @client.post("/acs/access_groups/list_users", {acs_access_group_id: acs_access_group_id}.compact)
 
         Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
       end
 
+      # Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group from which you want to remove an access system user.
+      # @param acs_user_id ID of the access system user that you want to remove from an access group.
+      # @param user_identity_id ID of the user identity associated with the user that you want to remove from an access group.
+      # @return [nil] OK
       def remove_user(acs_access_group_id:, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/access_groups/remove_user", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 

data/lib/seam/routes/acs_credentials.rb

@@ -8,48 +8,97 @@ module Seam
         @defaults = defaults
       end
 
+      # Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_credential_id ID of the credential that you want to assign to an access system user.
+      # @param acs_user_id ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+      # @return [nil] OK
       def assign(acs_credential_id:, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/credentials/assign", {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
+      # @param access_method Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+      # @param acs_system_id ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+      # @param acs_user_id ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
+      # @param allowed_acs_entrance_ids Set of IDs of the [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
+      # @param assa_abloy_vostio_metadata Vostio-specific metadata for the new credential.
+      # @param code Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/device-and-system-integration-guides).
+      # @param credential_manager_acs_system_id ACS system ID of the credential manager for the new credential.
+      # @param ends_at 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`.
+      # @param is_multi_phone_sync_credential Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+      # @param salto_space_metadata Salto Space-specific metadata for the new credential.
+      # @param starts_at 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.
+      # @param user_identity_id ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.
+      # @param visionline_metadata Visionline-specific metadata for the new credential.
+      # @return [Seam::Resources::AcsCredential] OK
       def create(access_method:, acs_system_id: nil, acs_user_id: nil, allowed_acs_entrance_ids: nil, assa_abloy_vostio_metadata: nil, code: nil, credential_manager_acs_system_id: nil, ends_at: nil, is_multi_phone_sync_credential: nil, salto_space_metadata: nil, starts_at: nil, user_identity_id: nil, visionline_metadata: nil)
         res = @client.post("/acs/credentials/create", {access_method: access_method, acs_system_id: acs_system_id, acs_user_id: acs_user_id, allowed_acs_entrance_ids: allowed_acs_entrance_ids, assa_abloy_vostio_metadata: assa_abloy_vostio_metadata, code: code, credential_manager_acs_system_id: credential_manager_acs_system_id, ends_at: ends_at, is_multi_phone_sync_credential: is_multi_phone_sync_credential, salto_space_metadata: salto_space_metadata, starts_at: starts_at, user_identity_id: user_identity_id, visionline_metadata: visionline_metadata}.compact)
 
         Seam::Resources::AcsCredential.load_from_response(res.body["acs_credential"])
       end
 
+      # Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @param acs_credential_id ID of the credential that you want to delete.
+      # @return [nil] OK
       def delete(acs_credential_id:)
         @client.post("/acs/credentials/delete", {acs_credential_id: acs_credential_id}.compact)
 
         nil
       end
 
+      # Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @param acs_credential_id ID of the credential that you want to get.
+      # @return [Seam::Resources::AcsCredential] OK
       def get(acs_credential_id:)
         res = @client.post("/acs/credentials/get", {acs_credential_id: acs_credential_id}.compact)
 
         Seam::Resources::AcsCredential.load_from_response(res.body["acs_credential"])
       end
 
+      # Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @param acs_user_id ID of the access system user for which you want to retrieve all credentials.
+      # @param acs_system_id ID of the access system for which you want to retrieve all credentials.
+      # @param user_identity_id ID of the user identity for which you want to retrieve all credentials.
+      # @param created_before Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
+      # @param is_multi_phone_sync_credential Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
+      # @param limit Number of credentials to return.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
+      # @return [Seam::Resources::AcsCredential] OK
       def list(acs_user_id: nil, acs_system_id: nil, user_identity_id: nil, created_before: nil, is_multi_phone_sync_credential: nil, limit: nil, page_cursor: nil, search: nil)
         res = @client.post("/acs/credentials/list", {acs_user_id: acs_user_id, acs_system_id: acs_system_id, user_identity_id: user_identity_id, created_before: created_before, is_multi_phone_sync_credential: is_multi_phone_sync_credential, limit: limit, page_cursor: page_cursor, search: search}.compact)
 
         Seam::Resources::AcsCredential.load_from_response(res.body["acs_credentials"])
       end
 
+      # Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access.
+      # @param acs_credential_id ID of the credential for which you want to retrieve all entrances to which the credential grants access.
+      # @return [Seam::Resources::AcsEntrance] OK
       def list_accessible_entrances(acs_credential_id:)
         res = @client.post("/acs/credentials/list_accessible_entrances", {acs_credential_id: acs_credential_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
       end
 
+      # Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_credential_id ID of the credential that you want to unassign from an access system user.
+      # @param acs_user_id ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
+      # @return [nil] OK
       def unassign(acs_credential_id:, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/credentials/unassign", {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @param acs_credential_id ID of the credential that you want to update.
+      # @param code Replacement access (PIN) code for the credential that you want to update.
+      # @param ends_at 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 [nil] OK
       def update(acs_credential_id:, code: nil, ends_at: nil)
         @client.post("/acs/credentials/update", {acs_credential_id: acs_credential_id, code: code, ends_at: ends_at}.compact)
 

data/lib/seam/routes/acs_encoders.rb

@@ -14,6 +14,11 @@ module Seam
         @simulate ||= Seam::Clients::AcsEncodersSimulate.new(client: @client, defaults: @defaults)
       end
 
+      # Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
+      # @param acs_encoder_id ID of the `acs_encoder` to use to encode the `acs_credential`.
+      # @param access_method_id ID of the `access_method` to encode onto a card.
+      # @param acs_credential_id ID of the `acs_credential` to encode onto a card.
+      # @return [Seam::Resources::ActionAttempt] OK
       def encode_credential(acs_encoder_id:, access_method_id: nil, acs_credential_id: nil, wait_for_action_attempt: nil)
         res = @client.post("/acs/encoders/encode_credential", {acs_encoder_id: acs_encoder_id, access_method_id: access_method_id, acs_credential_id: acs_credential_id}.compact)
 
@@ -22,18 +27,32 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      # @param acs_encoder_id ID of the encoder that you want to get.
+      # @return [Seam::Resources::AcsEncoder] OK
       def get(acs_encoder_id:)
         res = @client.post("/acs/encoders/get", {acs_encoder_id: acs_encoder_id}.compact)
 
         Seam::Resources::AcsEncoder.load_from_response(res.body["acs_encoder"])
       end
 
+      # Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      # @param acs_system_id ID of the access system for which you want to retrieve all encoders.
+      # @param acs_system_ids IDs of the access systems for which you want to retrieve all encoders.
+      # @param acs_encoder_ids IDs of the encoders that you want to retrieve.
+      # @param limit Number of encoders to return.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @return [Seam::Resources::AcsEncoder] OK
       def list(acs_system_id: nil, acs_system_ids: nil, acs_encoder_ids: nil, limit: nil, page_cursor: nil)
         res = @client.post("/acs/encoders/list", {acs_system_id: acs_system_id, acs_system_ids: acs_system_ids, acs_encoder_ids: acs_encoder_ids, limit: limit, page_cursor: page_cursor}.compact)
 
         Seam::Resources::AcsEncoder.load_from_response(res.body["acs_encoders"])
       end
 
+      # Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      # @param acs_encoder_id ID of the encoder to use for the scan.
+      # @param salto_ks_metadata Salto KS-specific metadata for the scan action.
+      # @return [Seam::Resources::ActionAttempt] OK
       def scan_credential(acs_encoder_id:, salto_ks_metadata: nil, wait_for_action_attempt: nil)
         res = @client.post("/acs/encoders/scan_credential", {acs_encoder_id: acs_encoder_id, salto_ks_metadata: salto_ks_metadata}.compact)
 
@@ -42,6 +61,12 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
+      # @param acs_encoder_id ID of the `acs_encoder` to use to scan the credential.
+      # @param acs_user_id ID of the `acs_user` to assign the scanned credential to.
+      # @param salto_ks_metadata Salto KS-specific metadata for the scan action.
+      # @param user_identity_id ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.
+      # @return [Seam::Resources::ActionAttempt] OK
       def scan_to_assign_credential(acs_encoder_id:, acs_user_id: nil, salto_ks_metadata: nil, user_identity_id: nil, wait_for_action_attempt: nil)
         res = @client.post("/acs/encoders/scan_to_assign_credential", {acs_encoder_id: acs_encoder_id, acs_user_id: acs_user_id, salto_ks_metadata: salto_ks_metadata, user_identity_id: user_identity_id}.compact)
 

data/lib/seam/routes/acs_encoders_simulate.rb

@@ -8,24 +8,43 @@ module Seam
         @defaults = defaults
       end
 
+      # Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param acs_encoder_id ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+      # @param error_code Code of the error to simulate.
+      # @param acs_credential_id ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
+      # @return [nil] OK
       def next_credential_encode_will_fail(acs_encoder_id:, error_code: nil, acs_credential_id: nil)
         @client.post("/acs/encoders/simulate/next_credential_encode_will_fail", {acs_encoder_id: acs_encoder_id, error_code: error_code, acs_credential_id: acs_credential_id}.compact)
 
         nil
       end
 
+      # Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param acs_encoder_id ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
+      # @param scenario Scenario to simulate.
+      # @return [nil] OK
       def next_credential_encode_will_succeed(acs_encoder_id:, scenario: nil)
         @client.post("/acs/encoders/simulate/next_credential_encode_will_succeed", {acs_encoder_id: acs_encoder_id, scenario: scenario}.compact)
 
         nil
       end
 
+      # Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param acs_encoder_id ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
+      # @param error_code
+      # @param acs_credential_id_on_seam
+      # @return [nil] OK
       def next_credential_scan_will_fail(acs_encoder_id:, error_code: nil, acs_credential_id_on_seam: nil)
         @client.post("/acs/encoders/simulate/next_credential_scan_will_fail", {acs_encoder_id: acs_encoder_id, error_code: error_code, acs_credential_id_on_seam: acs_credential_id_on_seam}.compact)
 
         nil
       end
 
+      # Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param acs_encoder_id ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.
+      # @param acs_credential_id_on_seam ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.
+      # @param scenario Scenario to simulate.
+      # @return [nil] OK
       def next_credential_scan_will_succeed(acs_encoder_id:, acs_credential_id_on_seam: nil, scenario: nil)
         @client.post("/acs/encoders/simulate/next_credential_scan_will_succeed", {acs_encoder_id: acs_encoder_id, acs_credential_id_on_seam: acs_credential_id_on_seam, scenario: scenario}.compact)
 

data/lib/seam/routes/acs_entrances.rb

@@ -10,30 +10,60 @@ module Seam
         @defaults = defaults
       end
 
+      # Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @param acs_entrance_id ID of the entrance that you want to get.
+      # @return [Seam::Resources::AcsEntrance] OK
       def get(acs_entrance_id:)
         res = @client.post("/acs/entrances/get", {acs_entrance_id: acs_entrance_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrance"])
       end
 
+      # Grants a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @param acs_entrance_id ID of the entrance to which you want to grant an access system user access.
+      # @param acs_user_id ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
+      # @return [nil] OK
       def grant_access(acs_entrance_id:, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/entrances/grant_access", {acs_entrance_id: acs_entrance_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @param access_method_id ID of the access method for which you want to retrieve all entrances to which it grants access.
+      # @param acs_credential_id ID of the credential for which you want to retrieve all entrances.
+      # @param acs_entrance_ids IDs of the entrances for which you want to retrieve all entrances.
+      # @param acs_system_id ID of the access system for which you want to retrieve all entrances.
+      # @param connected_account_id ID of the connected account for which you want to retrieve all entrances.
+      # @param customer_key Customer key for which you want to list entrances.
+      # @param limit Maximum number of records to return per page.
+      # @param location_id
+      # @deprecated location_id: Use `space_id`.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`.
+      # @param space_id ID of the space for which you want to list entrances.
+      # @return [Seam::Resources::AcsEntrance] OK
       def list(access_method_id: nil, acs_credential_id: nil, acs_entrance_ids: nil, acs_system_id: nil, connected_account_id: nil, customer_key: nil, limit: nil, location_id: nil, page_cursor: nil, search: nil, space_id: nil)
         res = @client.post("/acs/entrances/list", {access_method_id: access_method_id, acs_credential_id: acs_credential_id, acs_entrance_ids: acs_entrance_ids, acs_system_id: acs_system_id, connected_account_id: connected_account_id, customer_key: customer_key, limit: limit, location_id: location_id, page_cursor: page_cursor, search: search, space_id: space_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
       end
 
+      # Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @param acs_entrance_id ID of the entrance for which you want to list all credentials that grant access.
+      # @param include_if Conditions that credentials must meet to be included in the returned list.
+      # @return [Seam::Resources::AcsCredential] OK
       def list_credentials_with_access(acs_entrance_id:, include_if: nil)
         res = @client.post("/acs/entrances/list_credentials_with_access", {acs_entrance_id: acs_entrance_id, include_if: include_if}.compact)
 
         Seam::Resources::AcsCredential.load_from_response(res.body["acs_credentials"])
       end
 
+      # Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
+      # @param acs_credential_id ID of the cloud_key credential to use for the unlock operation.
+      # @param acs_entrance_id ID of the entrance to unlock.
+      # @return [Seam::Resources::ActionAttempt] OK
       def unlock(acs_credential_id:, acs_entrance_id:, wait_for_action_attempt: nil)
         res = @client.post("/acs/entrances/unlock", {acs_credential_id: acs_credential_id, acs_entrance_id: acs_entrance_id}.compact)
 

data/lib/seam/routes/acs_systems.rb

@@ -8,24 +8,44 @@ module Seam
         @defaults = defaults
       end
 
+      # Returns a specified [access system](https://docs.seam.co/low-level-apis/access-systems).
+      # @param acs_system_id ID of the access system that you want to get.
+      # @return [Seam::Resources::AcsSystem] OK
       def get(acs_system_id:)
         res = @client.post("/acs/systems/get", {acs_system_id: acs_system_id}.compact)
 
         Seam::Resources::AcsSystem.load_from_response(res.body["acs_system"])
       end
 
+      # Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems).
+      #
+      # To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.
+      # @param connected_account_id ID of the connected account by which you want to filter the list of access systems.
+      # @param customer_key Customer key for which you want to list access systems.
+      # @param search String for which to search. Filters returned access systems to include all records that satisfy a partial match using `name` or `acs_system_id`.
+      # @return [Seam::Resources::AcsSystem] OK
       def list(connected_account_id: nil, customer_key: nil, search: nil)
         res = @client.post("/acs/systems/list", {connected_account_id: connected_account_id, customer_key: customer_key, search: search}.compact)
 
         Seam::Resources::AcsSystem.load_from_response(res.body["acs_systems"])
       end
 
+      # Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/low-level-apis/access-systems).
+      #
+      # Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.
+      # @param acs_system_id ID of the access system for which you want to retrieve all compatible credential manager systems.
+      # @return [Seam::Resources::AcsSystem] OK
       def list_compatible_credential_manager_acs_systems(acs_system_id:)
         res = @client.post("/acs/systems/list_compatible_credential_manager_acs_systems", {acs_system_id: acs_system_id}.compact)
 
         Seam::Resources::AcsSystem.load_from_response(res.body["acs_systems"])
       end
 
+      # Reports ACS system device status including encoders and entrances.
+      # @param acs_system_id ID of the ACS system to report resources for
+      # @param acs_encoders Array of ACS encoders to report
+      # @param acs_entrances Array of ACS entrances to report
+      # @return [nil] OK
       def report_devices(acs_system_id:, acs_encoders: nil, acs_entrances: nil)
         @client.post("/acs/systems/report_devices", {acs_system_id: acs_system_id, acs_encoders: acs_encoders, acs_entrances: acs_entrances}.compact)
 

data/lib/seam/routes/acs_users.rb

@@ -8,66 +8,138 @@ module Seam
         @defaults = defaults
       end
 
+      # Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group to which you want to add an access system user.
+      # @param acs_user_id ID of the access system user that you want to add to an access group.
+      # @return [nil] OK
       def add_to_access_group(acs_access_group_id:, acs_user_id:)
         @client.post("/acs/users/add_to_access_group", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact)
 
         nil
       end
 
+      # Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_system_id ID of the access system to which you want to add the new access system user.
+      # @param full_name Full name of the new access system user.
+      # @param access_schedule `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+      # @param acs_access_group_ids Array of access group IDs to indicate the access groups to which you want to add the new access system user.
+      # @param email
+      # @deprecated email: use email_address.
+      # @param email_address Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param phone_number Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+      # @param user_identity_id ID of the user identity with which you want to associate the new access system user.
+      # @return [Seam::Resources::AcsUser] OK
       def create(acs_system_id:, full_name:, access_schedule: nil, acs_access_group_ids: nil, email: nil, email_address: nil, phone_number: nil, user_identity_id: nil)
         res = @client.post("/acs/users/create", {acs_system_id: acs_system_id, full_name: full_name, access_schedule: access_schedule, acs_access_group_ids: acs_access_group_ids, email: email, email_address: email_address, phone_number: phone_number, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsUser.load_from_response(res.body["acs_user"])
       end
 
+      # Deletes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @param acs_system_id ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id
+      # @param user_identity_id ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
+      # @return [nil] OK
       def delete(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/users/delete", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_user_id ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.
+      # @param acs_system_id ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
+      # @return [Seam::Resources::AcsUser] OK
       def get(acs_user_id: nil, acs_system_id: nil, user_identity_id: nil)
         res = @client.post("/acs/users/get", {acs_user_id: acs_user_id, acs_system_id: acs_system_id, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsUser.load_from_response(res.body["acs_user"])
       end
 
+      # Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_system_id ID of the `acs_system` for which you want to retrieve all access system users.
+      # @param created_before Timestamp by which to limit returned access system users. Returns users created before this timestamp.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.
+      # @param user_identity_email_address Email address of the user identity for which you want to retrieve all access system users.
+      # @param user_identity_id ID of the user identity for which you want to retrieve all access system users.
+      # @param user_identity_phone_number Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).
+      # @return [Seam::Resources::AcsUser] OK
       def list(acs_system_id: nil, created_before: nil, limit: nil, page_cursor: nil, search: nil, user_identity_email_address: nil, user_identity_id: nil, user_identity_phone_number: nil)
         res = @client.post("/acs/users/list", {acs_system_id: acs_system_id, created_before: created_before, limit: limit, page_cursor: page_cursor, search: search, user_identity_email_address: user_identity_email_address, user_identity_id: user_identity_id, user_identity_phone_number: user_identity_phone_number}.compact)
 
         Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
       end
 
+      # Lists the [entrances](https://docs.seam.co/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) has access.
+      # @param acs_system_id ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+      # @return [Seam::Resources::AcsEntrance] OK
       def list_accessible_entrances(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
         res = @client.post("/acs/users/list_accessible_entrances", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
       end
 
+      # Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group from which you want to remove an access system user.
+      # @param acs_user_id ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
+      # @return [nil] OK
       def remove_from_access_group(acs_access_group_id:, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/users/remove_from_access_group", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Revokes access to all [entrances](https://docs.seam.co/api/acs/entrances) for a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_system_id ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+      # @return [nil] OK
       def revoke_access_to_all_entrances(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/users/revoke_access_to_all_entrances", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # [Suspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/api/acs/users/unsuspend) them.
+      # @param acs_system_id ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @return [nil] OK
       def suspend(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/users/suspend", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # [Unsuspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.
+      # @param acs_system_id ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @return [nil] OK
       def unsuspend(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
         @client.post("/acs/users/unsuspend", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param access_schedule `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+      # @param acs_system_id ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
+      # @param email
+      # @deprecated email: use email_address.
+      # @param email_address Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param full_name Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param hid_acs_system_id ID of the HID access control system associated with the user.
+      # @param phone_number Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+      # @param user_identity_id ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
+      # @return [nil] OK
       def update(access_schedule: nil, acs_system_id: nil, acs_user_id: nil, email: nil, email_address: nil, full_name: nil, hid_acs_system_id: nil, phone_number: nil, user_identity_id: nil)
         @client.post("/acs/users/update", {access_schedule: access_schedule, acs_system_id: acs_system_id, acs_user_id: acs_user_id, email: email, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number, user_identity_id: user_identity_id}.compact)
 

data/lib/seam/routes/action_attempts.rb

@@ -10,6 +10,9 @@ module Seam
         @defaults = defaults
       end
 
+      # Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts).
+      # @param action_attempt_id ID of the action attempt that you want to get.
+      # @return [Seam::Resources::ActionAttempt] OK
       def get(action_attempt_id:, wait_for_action_attempt: nil)
         res = @client.post("/action_attempts/get", {action_attempt_id: action_attempt_id}.compact)
 
@@ -18,6 +21,12 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.
+      # @param action_attempt_ids IDs of the action attempts that you want to retrieve.
+      # @param device_id ID of the device to filter action attempts by.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @return [Seam::Resources::ActionAttempt] OK
       def list(action_attempt_ids: nil, device_id: nil, limit: nil, page_cursor: nil)
         res = @client.post("/action_attempts/list", {action_attempt_ids: action_attempt_ids, device_id: device_id, limit: limit, page_cursor: page_cursor}.compact)