seam 2.132.0 → 2.133.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8a4ce290271f2b1c655d032f8a8250eba68852b90427fc858f09e7b7f0ad439
-  data.tar.gz: 4a78364e51f15e3f3cee4a5e8960110de3c75e8e046b04726a9023cbeaac6c66
+  metadata.gz: bb7fca448b6ccc8cda4ea8b19365646faea00d731221a22ac5bcc04a9448965c
+  data.tar.gz: cadee3c19b14602929d12e388fc9af7e88294734ece88b64eb4d81ed0159f206
 SHA512:
-  metadata.gz: 312ebd6671d023b18837d4df61a2f96f0014632c835d5d7f449353e99f5741f1207e19d816949e79b1f322a3529ccffc42ef4da31968929de48a60887504a579
-  data.tar.gz: 5b62ad40c08d9b8a13d4b6b6aefac6a78baff5ea78bac7081a93524ed11556442948d849febab66960ff40465d8111a753361bcecc63c4b9e4886f389c310833
+  metadata.gz: 610f1ddc0fa62ef6957bbdcad5ddc093f1a4a29a7d758f2df29eae8e8eee7dc323a59efff675f140a0e2d6d4f7c6fe3041610b6b379fedc09241ba35c420242d
+  data.tar.gz: 195a1e34533e3d32b846b42aad0aba9e61e5fed7f208b98074fbbf517fa611956781ad526cbb0faae8068f45d00670c839ee8d0cf779b651a6415ee0a77dc2f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.132.0)
+    seam (2.133.0)
       faraday (~> 2.7)
       faraday-retry (~> 2.2)
       svix (~> 1.30)

data/lib/seam/resources/access_code.rb

@@ -2,10 +2,63 @@
 
 module Seam
   module Resources
+    # Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+    #
+    # An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
+    #
+    # Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
+    #
+    # In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
+    #
+    # For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
     class AccessCode < BaseResource
-      attr_accessor :access_code_id, :code, :common_code_key, :device_id, :dormakaba_oracode_metadata, :is_backup, :is_backup_access_code_available, :is_external_modification_allowed, :is_managed, :is_offline_access_code, :is_one_time_use, :is_scheduled_on_device, :is_waiting_for_code_assignment, :name, :pending_mutations, :pulled_backup_access_code_id, :status, :type, :workspace_id
+      # Unique identifier for the access code.
+      attr_accessor :access_code_id
+      # Code used for access. Typically, a numeric or alphanumeric string.
+      attr_accessor :code
+      # Unique identifier for a group of access codes that share the same code.
+      attr_accessor :common_code_key
+      # Unique identifier for the device associated with the access code.
+      attr_accessor :device_id
+      # Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.
+      attr_accessor :dormakaba_oracode_metadata
+      # Indicates whether the access code is a backup code.
+      attr_accessor :is_backup
+      # Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
+      attr_accessor :is_backup_access_code_available
+      # Indicates whether changes to the access code from external sources are permitted.
+      attr_accessor :is_external_modification_allowed
+      # Indicates whether Seam manages the access code.
+      attr_accessor :is_managed
+      # Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.
+      attr_accessor :is_offline_access_code
+      # Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.
+      attr_accessor :is_one_time_use
+      # Indicates whether the code is set on the device according to a preconfigured schedule.
+      attr_accessor :is_scheduled_on_device
+      # Indicates whether the access code is waiting for a code assignment.
+      attr_accessor :is_waiting_for_code_assignment
+      # Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+      attr_accessor :name
+      # Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.
+      attr_accessor :pending_mutations
+      # Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
+      attr_accessor :pulled_backup_access_code_id
+      # Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
+      attr_accessor :status
+      # Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.
+      attr_accessor :type
+      # Unique identifier for the Seam workspace associated with the access code.
+      attr_accessor :workspace_id
 
-      date_accessor :created_at, :ends_at, :starts_at
+      # Date and time at which the access code was created.
+      date_accessor :created_at
+
+      # Date and time after which the time-bound access code becomes inactive.
+      date_accessor :ends_at
+
+      # Date and time at which the time-bound access code becomes active.
+      date_accessor :starts_at
 
       include Seam::Resources::ResourceErrorsSupport
       include Seam::Resources::ResourceWarningsSupport

data/lib/seam/resources/access_grant.rb

@@ -2,10 +2,47 @@
 
 module Seam
   module Resources
+    # Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
     class AccessGrant < BaseResource
-      attr_accessor :access_grant_id, :access_grant_key, :access_method_ids, :client_session_token, :customization_profile_id, :display_name, :instant_key_url, :location_ids, :name, :pending_mutations, :requested_access_methods, :reservation_key, :space_ids, :user_identity_id, :workspace_id
+      # ID of the Access Grant.
+      attr_accessor :access_grant_id
+      # Unique key for the access grant within the workspace.
+      attr_accessor :access_grant_key
+      # IDs of the access methods created for the Access Grant.
+      attr_accessor :access_method_ids
+      # Client Session Token. Only returned if the Access Grant has a mobile_key access method.
+      attr_accessor :client_session_token
+      # ID of the customization profile associated with the Access Grant.
+      attr_accessor :customization_profile_id
+      # Display name of the Access Grant.
+      attr_accessor :display_name
+      # Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.
+      attr_accessor :instant_key_url
+      # @deprecated Use `space_ids`.
+      attr_accessor :location_ids
+      # Name of the Access Grant. If not provided, the display name will be computed.
+      attr_accessor :name
+      # List of pending mutations for the access grant. This shows updates that are in progress.
+      attr_accessor :pending_mutations
+      # Access methods that the user requested for the Access Grant.
+      attr_accessor :requested_access_methods
+      # Reservation key for the access grant.
+      attr_accessor :reservation_key
+      # IDs of the spaces to which the Access Grant gives access.
+      attr_accessor :space_ids
+      # ID of user identity to which the Access Grant gives access.
+      attr_accessor :user_identity_id
+      # ID of the Seam workspace associated with the Access Grant.
+      attr_accessor :workspace_id
 
-      date_accessor :created_at, :ends_at, :starts_at
+      # Date and time at which the Access Grant was created.
+      date_accessor :created_at
+
+      # Date and time at which the Access Grant ends.
+      date_accessor :ends_at
+
+      # Date and time at which the Access Grant starts.
+      date_accessor :starts_at
 
       include Seam::Resources::ResourceErrorsSupport
       include Seam::Resources::ResourceWarningsSupport

data/lib/seam/resources/access_method.rb

@@ -2,10 +2,42 @@
 
 module Seam
   module Resources
+    # Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
     class AccessMethod < BaseResource
-      attr_accessor :access_method_id, :client_session_token, :code, :customization_profile_id, :display_name, :instant_key_url, :is_assignment_required, :is_encoding_required, :is_issued, :is_ready_for_assignment, :is_ready_for_encoding, :mode, :pending_mutations, :workspace_id
+      # ID of the access method.
+      attr_accessor :access_method_id
+      # Token of the client session associated with the access method.
+      attr_accessor :client_session_token
+      # The actual PIN code for code access methods.
+      attr_accessor :code
+      # ID of the customization profile associated with the access method.
+      attr_accessor :customization_profile_id
+      # Display name of the access method.
+      attr_accessor :display_name
+      # URL of the Instant Key for mobile key access methods.
+      attr_accessor :instant_key_url
+      # Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.
+      attr_accessor :is_assignment_required
+      # Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.
+      attr_accessor :is_encoding_required
+      # Indicates whether the access method has been issued.
+      attr_accessor :is_issued
+      # Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
+      attr_accessor :is_ready_for_assignment
+      # Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
+      attr_accessor :is_ready_for_encoding
+      # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+      attr_accessor :mode
+      # Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
+      attr_accessor :pending_mutations
+      # ID of the Seam workspace associated with the access method.
+      attr_accessor :workspace_id
 
-      date_accessor :created_at, :issued_at
+      # Date and time at which the access method was created.
+      date_accessor :created_at
+
+      # Date and time at which the access method was issued.
+      date_accessor :issued_at
 
       include Seam::Resources::ResourceErrorsSupport
       include Seam::Resources::ResourceWarningsSupport

data/lib/seam/resources/acs_access_group.rb

@@ -2,9 +2,40 @@
 
 module Seam
   module Resources
+    # 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.
+    #
+    # Some access control systems use [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
+    #
+    # To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
     class AcsAccessGroup < BaseResource
-      attr_accessor :access_group_type, :access_group_type_display_name, :access_schedule, :acs_access_group_id, :acs_system_id, :connected_account_id, :display_name, :external_type, :external_type_display_name, :is_managed, :name, :pending_mutations, :workspace_id
+      # @deprecated Use `external_type`.
+      attr_accessor :access_group_type
+      # @deprecated Use `external_type_display_name`.
+      attr_accessor :access_group_type_display_name
+      # `starts_at` and `ends_at` timestamps for the access group's access.
+      attr_accessor :access_schedule
+      # ID of the access group.
+      attr_accessor :acs_access_group_id
+      # ID of the access control system that contains the access group.
+      attr_accessor :acs_system_id
+      # ID of the connected account that contains the access group.
+      attr_accessor :connected_account_id
+      # Display name for the access group.
+      attr_accessor :display_name
+      # Brand-specific terminology for the access group type.
+      attr_accessor :external_type
+      # Display name that corresponds to the brand-specific terminology for the access group type.
+      attr_accessor :external_type_display_name
+      # Indicates whether Seam manages the access group.
+      attr_accessor :is_managed
+      # Name of the access group.
+      attr_accessor :name
+      # Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.
+      attr_accessor :pending_mutations
+      # ID of the workspace that contains the access group.
+      attr_accessor :workspace_id
 
+      # Date and time at which the access group was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/acs_credential.rb

@@ -2,10 +2,69 @@
 
 module Seam
   module Resources
+    # Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+    #
+    # An access control system generally uses digital means of access to authorize a user 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.
+    #
+    # For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
+    #
+    # For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.
     class AcsCredential < BaseResource
-      attr_accessor :access_method, :acs_credential_id, :acs_credential_pool_id, :acs_system_id, :acs_user_id, :assa_abloy_vostio_metadata, :card_number, :code, :connected_account_id, :display_name, :ends_at, :external_type, :external_type_display_name, :is_issued, :is_latest_desired_state_synced_with_provider, :is_managed, :is_multi_phone_sync_credential, :is_one_time_use, :parent_acs_credential_id, :starts_at, :user_identity_id, :visionline_metadata, :workspace_id
+      # Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+      attr_accessor :access_method
+      # ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :acs_credential_id
+      # ID of the credential pool to which the credential belongs.
+      attr_accessor :acs_credential_pool_id
+      # ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :acs_system_id
+      # ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
+      attr_accessor :acs_user_id
+      # Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :assa_abloy_vostio_metadata
+      # Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :card_number
+      # Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :code
+      # ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
+      attr_accessor :connected_account_id
+      # Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
+      attr_accessor :display_name
+      # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) 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`.
+      attr_accessor :ends_at
+      # Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
+      attr_accessor :external_type
+      # Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
+      attr_accessor :external_type_display_name
+      # Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
+      attr_accessor :is_issued
+      # Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
+      attr_accessor :is_latest_desired_state_synced_with_provider
+      # Indicates whether Seam manages the credential.
+      attr_accessor :is_managed
+      # Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) 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).
+      attr_accessor :is_multi_phone_sync_credential
+      # Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
+      attr_accessor :is_one_time_use
+      # ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :parent_acs_credential_id
+      # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      attr_accessor :starts_at
+      # ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
+      attr_accessor :user_identity_id
+      # Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :visionline_metadata
+      # ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      attr_accessor :workspace_id
 
-      date_accessor :created_at, :issued_at, :latest_desired_state_synced_with_provider_at
+      # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.
+      date_accessor :created_at
+
+      # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
+      date_accessor :issued_at
+
+      # Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
+      date_accessor :latest_desired_state_synced_with_provider_at
 
       include Seam::Resources::ResourceErrorsSupport
       include Seam::Resources::ResourceWarningsSupport

data/lib/seam/resources/acs_encoder.rb

@@ -2,9 +2,33 @@
 
 module Seam
   module Resources
+    # Represents a hardware device that encodes [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+    #
+    # Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
+    #
+    # 1. Credential creation
+    #    Configure the access parameters for the credential.
+    # 2. Card encoding
+    #    Write the credential data onto the card using a compatible card encoder.
+    #
+    # Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
+    #
+    # See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+    #
+    # To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
     class AcsEncoder < BaseResource
-      attr_accessor :acs_encoder_id, :acs_system_id, :connected_account_id, :display_name, :workspace_id
+      # ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      attr_accessor :acs_encoder_id
+      # ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      attr_accessor :acs_system_id
+      # ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      attr_accessor :connected_account_id
+      # Display name for the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      attr_accessor :display_name
+      # ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      attr_accessor :workspace_id
 
+      # Date and time at which the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/acs_entrance.rb

@@ -2,9 +2,56 @@
 
 module Seam
   module Resources
+    # Represents an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+    #
+    # In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
     class AcsEntrance < BaseResource
-      attr_accessor :acs_entrance_id, :acs_system_id, :akiles_metadata, :assa_abloy_vostio_metadata, :avigilon_alta_metadata, :brivo_metadata, :can_belong_to_reservation, :can_unlock_with_card, :can_unlock_with_cloud_key, :can_unlock_with_code, :can_unlock_with_mobile_key, :connected_account_id, :display_name, :dormakaba_ambiance_metadata, :dormakaba_community_metadata, :hotek_metadata, :is_locked, :latch_metadata, :salto_ks_metadata, :salto_space_metadata, :space_ids, :visionline_metadata
+      # ID of the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :acs_entrance_id
+      # ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :acs_system_id
+      # Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :akiles_metadata
+      # ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :assa_abloy_vostio_metadata
+      # Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :avigilon_alta_metadata
+      # Brivo-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :brivo_metadata
+      # Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.
+      attr_accessor :can_belong_to_reservation
+      # Indicates whether the ACS entrance can be unlocked with card credentials.
+      attr_accessor :can_unlock_with_card
+      # Indicates whether the ACS entrance can be unlocked with cloud key credentials.
+      attr_accessor :can_unlock_with_cloud_key
+      # Indicates whether the ACS entrance can be unlocked with pin codes.
+      attr_accessor :can_unlock_with_code
+      # Indicates whether the ACS entrance can be unlocked with mobile key credentials.
+      attr_accessor :can_unlock_with_mobile_key
+      # ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :connected_account_id
+      # Display name for the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :display_name
+      # dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :dormakaba_ambiance_metadata
+      # dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :dormakaba_community_metadata
+      # Hotek-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :hotek_metadata
+      # Indicates whether the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.
+      attr_accessor :is_locked
+      # Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :latch_metadata
+      # Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :salto_ks_metadata
+      # Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :salto_space_metadata
+      # IDs of the spaces that the entrance is in.
+      attr_accessor :space_ids
+      # Visionline-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      attr_accessor :visionline_metadata
 
+      # Date and time at which the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/acs_system.rb

@@ -2,9 +2,49 @@
 
 module Seam
   module Resources
+    # Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+    #
+    # Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users/object) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials/object) to grant access to the `acs_user`s.
+    #
+    # For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).
     class AcsSystem < BaseResource
-      attr_accessor :acs_access_group_count, :acs_system_id, :acs_user_count, :connected_account_id, :connected_account_ids, :default_credential_manager_acs_system_id, :external_type, :external_type_display_name, :image_alt_text, :image_url, :is_credential_manager, :location, :name, :system_type, :system_type_display_name, :visionline_metadata, :workspace_id
+      # Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :acs_access_group_count
+      # ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :acs_system_id
+      # Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :acs_user_count
+      # ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :connected_account_id
+      # IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @deprecated Use `connected_account_id`.
+      attr_accessor :connected_account_ids
+      # ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :default_credential_manager_acs_system_id
+      # Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type.
+      attr_accessor :external_type
+      # Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type.
+      attr_accessor :external_type_display_name
+      # Alternative text for the [access control system](https://docs.seam.co/low-level-apis/access-systems) image.
+      attr_accessor :image_alt_text
+      # URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :image_url
+      # Indicates whether the `acs_system` is a credential manager.
+      attr_accessor :is_credential_manager
+      # Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :location
+      # Name of the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :name
+      # @deprecated Use `external_type`.
+      attr_accessor :system_type
+      # @deprecated Use `external_type_display_name`.
+      attr_accessor :system_type_display_name
+      # Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :visionline_metadata
+      # ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      attr_accessor :workspace_id
 
+      # Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/acs_user.rb

@@ -2,9 +2,58 @@
 
 module Seam
   module Resources
+    # Represents a [user](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access system](https://docs.seam.co/low-level-apis/access-systems).
+    #
+    # An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
+    #
+    # For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
     class AcsUser < BaseResource
-      attr_accessor :access_schedule, :acs_system_id, :acs_user_id, :connected_account_id, :display_name, :email, :email_address, :external_type, :external_type_display_name, :full_name, :hid_acs_system_id, :is_managed, :is_suspended, :pending_mutations, :phone_number, :salto_ks_metadata, :salto_space_metadata, :user_identity_email_address, :user_identity_full_name, :user_identity_id, :user_identity_phone_number, :workspace_id
+      # `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/low-level-apis/access-systems/user-management) access.
+      attr_accessor :access_schedule
+      # ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :acs_system_id
+      # ID of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :acs_user_id
+      # The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :connected_account_id
+      # Display name for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :display_name
+      # @deprecated use email_address.
+      attr_accessor :email
+      # Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :email_address
+      # Brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type.
+      attr_accessor :external_type
+      # Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type.
+      attr_accessor :external_type_display_name
+      # Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :full_name
+      # ID of the HID access control system associated with the user.
+      attr_accessor :hid_acs_system_id
+      # Indicates whether Seam manages the access system user.
+      attr_accessor :is_managed
+      # Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).
+      attr_accessor :is_suspended
+      # Pending mutations associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.
+      attr_accessor :pending_mutations
+      # 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`).
+      attr_accessor :phone_number
+      # Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :salto_ks_metadata
+      # Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :salto_space_metadata
+      # Email address of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :user_identity_email_address
+      # Full name of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :user_identity_full_name
+      # ID of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :user_identity_id
+      # Phone number of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+      attr_accessor :user_identity_phone_number
+      # ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      attr_accessor :workspace_id
 
+      # Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/action_attempt.rb

@@ -2,8 +2,17 @@
 
 module Seam
   module Resources
+    # Locking a door is pending.
     class ActionAttempt < BaseResource
-      attr_accessor :action_attempt_id, :action_type, :error, :result, :status
+      # ID of the action attempt.
+      attr_accessor :action_attempt_id
+      # Action attempt to track the status of locking a door.
+      attr_accessor :action_type
+      # Error associated with the action.
+      attr_accessor :error
+      # Result of the action.
+      attr_accessor :result
+      attr_accessor :status
     end
   end
 end