seam 2.139.0 → 2.141.0

data/lib/seam/resources/acs_access_group.rb

@@ -10,97 +10,142 @@ module Seam
     class AcsAccessGroup < BaseResource
       class AccessSchedule < BaseResource
         # Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+        # @return [Time, nil]
         date_accessor :ends_at
         # Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+        # @return [Time]
         date_accessor :starts_at
       end
 
       class Errors < BaseResource
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # Date and time at which Seam created the error.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class PendingMutations < BaseResource
         class From < BaseResource
           # Old entrance ID.
+          # @return [String, nil]
           attr_accessor :acs_entrance_id
           # Old user ID.
+          # @return [String, nil]
           attr_accessor :acs_user_id
           # Name of the access group.
+          # @return [String, nil]
           attr_accessor :name
           # Ending time for the access schedule.
+          # @return [Time, nil]
           date_accessor :ends_at
           # Starting time for the access schedule.
+          # @return [Time, nil]
           date_accessor :starts_at
         end
 
         class To < BaseResource
           # New entrance ID.
+          # @return [String, nil]
           attr_accessor :acs_entrance_id
           # New user ID.
+          # @return [String, nil]
           attr_accessor :acs_user_id
           # Name of the access group.
+          # @return [String, nil]
           attr_accessor :name
           # Ending time for the access schedule.
+          # @return [Time, nil]
           date_accessor :ends_at
           # Starting time for the access schedule.
+          # @return [Time, nil]
           date_accessor :starts_at
         end
 
+        # @return [From]
         resource_accessor :from, From
+        # @return [To]
         resource_accessor :to, To
         # ID of the user involved in the scheduled change.
+        # @return [String]
         attr_accessor :acs_user_id
         # Detailed description of the mutation.
+        # @return [String]
         attr_accessor :message
+        # @return [String]
         attr_accessor :mutation_code
         # Whether the user is scheduled to be added to or removed from this access group.
+        # @return [String]
         attr_accessor :variant
         # Date and time at which the mutation was created.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class Warnings < BaseResource
         # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
+        # @return [Time]
         date_accessor :created_at
       end
 
+      # `starts_at` and `ends_at` timestamps for the access group's access.
+      # @return [AccessSchedule, nil]
       resource_accessor :access_schedule, AccessSchedule
+      # Errors associated with the `acs_access_group`.
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.
+      # @return [Array<PendingMutations>]
       resource_list_accessor :pending_mutations, PendingMutations
+      # Warnings associated with the `acs_access_group`.
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
+      # @return [String]
       # @deprecated Use `external_type`.
       attr_accessor :access_group_type
+      # @return [String]
       # @deprecated Use `external_type_display_name`.
       attr_accessor :access_group_type_display_name
       # ID of the access group.
+      # @return [String]
       attr_accessor :acs_access_group_id
       # ID of the access control system that contains the access group.
+      # @return [String]
       attr_accessor :acs_system_id
       # ID of the connected account that contains the access group.
+      # @return [String]
       attr_accessor :connected_account_id
       # Display name for the access group.
+      # @return [String]
       attr_accessor :display_name
       # Brand-specific terminology for the access group type.
+      # @return [String]
       attr_accessor :external_type
       # Display name that corresponds to the brand-specific terminology for the access group type.
+      # @return [String]
       attr_accessor :external_type_display_name
       # Indicates whether Seam manages the access group.
+      # @return [Boolean]
       attr_accessor :is_managed
       # Name of the access group.
+      # @return [String]
       attr_accessor :name
       # ID of the workspace that contains the access group.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the access group was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/acs_credential.rb

@@ -10,110 +10,177 @@ module Seam
     #
     # 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
+      class AkilesMetadata < BaseResource
+        # ID of the Akiles member PIN.
+        # @return [String, nil]
+        attr_accessor :member_pin_id
+      end
+
       class AssaAbloyVostioMetadata < BaseResource
         # Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
+        # @return [Boolean, nil]
         attr_accessor :auto_join
         # Names of the doors to which to grant access in the Vostio access system.
+        # @return [Array<String>]
         attr_accessor :door_names
         # Endpoint ID in the Vostio access system.
+        # @return [String, nil]
         attr_accessor :endpoint_id
         # Key ID in the Vostio access system.
+        # @return [String, nil]
         attr_accessor :key_id
         # Key issuing request ID in the Vostio access system.
+        # @return [String, nil]
         attr_accessor :key_issuing_request_id
         # IDs of the guest entrances to override in the Vostio access system.
+        # @return [Array<String>]
         attr_accessor :override_guest_acs_entrance_ids
       end
 
       class Errors < BaseResource
+        # @return [String]
         attr_accessor :error_code
+        # @return [String]
         attr_accessor :message
         # Date and time at which Seam created the error.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class VisionlineMetadata < BaseResource
         # Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
+        # @return [Boolean, nil]
         attr_accessor :auto_join
         # Card function type in the Visionline access system.
+        # @return [String, nil]
         attr_accessor :card_function_type
         # ID of the card in the Visionline access system.
+        # @return [String, nil]
         attr_accessor :card_id
         # Common entrance IDs in the Visionline access system.
+        # @return [Array<String>]
         attr_accessor :common_acs_entrance_ids
         # ID of the credential in the Visionline access system.
+        # @return [String, nil]
         attr_accessor :credential_id
         # Guest entrance IDs in the Visionline access system.
+        # @return [Array<String>]
         attr_accessor :guest_acs_entrance_ids
         # Indicates whether the credential is valid.
+        # @return [Boolean, nil]
         attr_accessor :is_valid
         # IDs of the credentials to which you want to join.
+        # @return [Array<String>]
         attr_accessor :joiner_acs_credential_ids
       end
 
       class Warnings < BaseResource
         # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
+        # The PIN code that was assigned instead.
+        # @return [String]
+        attr_accessor :new_code
+        # The originally requested PIN code that could not be used.
+        # @return [String]
+        attr_accessor :original_code
         # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
+        # @return [Time]
         date_accessor :created_at
       end
 
+      # Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [AkilesMetadata, nil]
+      resource_accessor :akiles_metadata, AkilesMetadata
+      # Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [AssaAbloyVostioMetadata, nil]
       resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
+      # Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [VisionlineMetadata, nil]
       resource_accessor :visionline_metadata, VisionlineMetadata
+      # Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+      # @return [String]
       attr_accessor :access_method
       # ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [String]
       attr_accessor :acs_credential_id
       # ID of the credential pool to which the credential belongs.
+      # @return [String, nil]
       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).
+      # @return [String]
       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.
+      # @return [String, nil]
       attr_accessor :acs_user_id
       # Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [String, nil]
       attr_accessor :card_number
       # Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [String, nil]
       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.
+      # @return [String]
       attr_accessor :connected_account_id
       # Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
+      # @return [String]
       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`.
+      # @return [String, nil]
       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`.
+      # @return [String, nil]
       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.
+      # @return [String, nil]
       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.
+      # @return [Boolean, nil]
       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.
+      # @return [Boolean, nil]
       attr_accessor :is_latest_desired_state_synced_with_provider
       # Indicates whether Seam manages the credential.
+      # @return [Boolean]
       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).
+      # @return [Boolean, nil]
       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.
+      # @return [Boolean, nil]
       attr_accessor :is_one_time_use
       # ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [String, nil]
       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.
+      # @return [String, nil]
       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.
+      # @return [String, nil]
       attr_accessor :user_identity_id
       # ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.
+      # @return [Time]
       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.
+      # @return [Time, nil]
       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.
+      # @return [Time, nil]
       date_accessor :latest_desired_state_synced_with_provider_at
     end
   end

data/lib/seam/resources/acs_encoder.rb

@@ -19,26 +19,37 @@ module Seam
     class AcsEncoder < BaseResource
       class Errors < BaseResource
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # Date and time at which Seam created the error.
+        # @return [Time]
         date_accessor :created_at
       end
 
+      # Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
       # ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      # @return [String]
       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).
+      # @return [String]
       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).
+      # @return [String]
       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).
+      # @return [String]
       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).
+      # @return [String]
       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.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/acs_entrance.rb

@@ -9,193 +9,288 @@ module Seam
       class AkilesMetadata < BaseResource
         class Actions < BaseResource
           # ID of the gadget action.
+          # @return [String, nil]
           attr_accessor :id
           # Name of the gadget action.
+          # @return [String, nil]
           attr_accessor :name
         end
 
+        # Actions the gadget exposes (for example, open).
+        # @return [Array<Actions>]
         resource_list_accessor :actions, Actions
         # ID of the Akiles gadget.
+        # @return [String, nil]
         attr_accessor :gadget_id
         # ID of the Akiles site the gadget belongs to.
+        # @return [String, nil]
         attr_accessor :site_id
         # Name of the Akiles site the gadget belongs to.
+        # @return [String, nil]
         attr_accessor :site_name
       end
 
       class AssaAbloyVostioMetadata < BaseResource
         # Name of the door in the Vostio access system.
+        # @return [String, nil]
         attr_accessor :door_name
         # Number of the door in the Vostio access system.
+        # @return [Float, nil]
         attr_accessor :door_number
         # Type of the door in the Vostio access system.
+        # @return [String, nil]
         attr_accessor :door_type
         # PMS ID of the door in the Vostio access system.
+        # @return [String, nil]
         attr_accessor :pms_id
         # Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.
+        # @return [Boolean, nil]
         attr_accessor :stand_open
       end
 
       class AvigilonAltaMetadata < BaseResource
         # Entry name for an Avigilon Alta system.
+        # @return [String, nil]
         attr_accessor :entry_name
         # Total count of entry relays for an Avigilon Alta system.
+        # @return [Float, nil]
         attr_accessor :entry_relays_total_count
         # Organization name for an Avigilon Alta system.
+        # @return [String, nil]
         attr_accessor :org_name
         # Site ID for an Avigilon Alta system.
+        # @return [Float, nil]
         attr_accessor :site_id
         # Site name for an Avigilon Alta system.
+        # @return [String, nil]
         attr_accessor :site_name
         # Zone ID for an Avigilon Alta system.
+        # @return [Float, nil]
         attr_accessor :zone_id
         # Zone name for an Avigilon Alta system.
+        # @return [String, nil]
         attr_accessor :zone_name
       end
 
       class BrivoMetadata < BaseResource
         # ID of the access point in the Brivo access system.
+        # @return [String, nil]
         attr_accessor :access_point_id
         # ID of the site that the access point belongs to.
+        # @return [Float, nil]
         attr_accessor :site_id
         # Name of the site that the access point belongs to.
+        # @return [String, nil]
         attr_accessor :site_name
       end
 
       class DormakabaAmbianceMetadata < BaseResource
         # Name of the access point in the dormakaba Ambiance access system.
+        # @return [String, nil]
         attr_accessor :access_point_name
       end
 
       class DormakabaCommunityMetadata < BaseResource
         # Type of access point profile in the dormakaba Community access system.
+        # @return [String, nil]
         attr_accessor :access_point_profile
       end
 
       class Errors < BaseResource
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # Date and time at which Seam created the error.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class HotekMetadata < BaseResource
         # Display name of the entrance.
+        # @return [String, nil]
         attr_accessor :common_area_name
         # Display name of the entrance.
+        # @return [String, nil]
         attr_accessor :common_area_number
         # Room number of the entrance.
+        # @return [String, nil]
         attr_accessor :room_number
       end
 
       class LatchMetadata < BaseResource
         # Accessibility type in the Latch access system.
+        # @return [String, nil]
         attr_accessor :accessibility_type
         # Name of the door in the Latch access system.
+        # @return [String, nil]
         attr_accessor :door_name
         # Type of the door in the Latch access system.
+        # @return [String, nil]
         attr_accessor :door_type
         # Indicates whether the entrance is connected.
+        # @return [Boolean, nil]
         attr_accessor :is_connected
       end
 
       class SaltoKsMetadata < BaseResource
         # Battery level of the door access device.
+        # @return [String, nil]
         attr_accessor :battery_level
         # Name of the door in the Salto KS access system.
+        # @return [String, nil]
         attr_accessor :door_name
         # Indicates whether an intrusion alarm is active on the door.
+        # @return [Boolean, nil]
         attr_accessor :intrusion_alarm
         # Indicates whether the door is left open.
+        # @return [Boolean, nil]
         attr_accessor :left_open_alarm
         # Type of the lock in the Salto KS access system.
+        # @return [String, nil]
         attr_accessor :lock_type
         # Locked state of the door in the Salto KS access system.
+        # @return [String, nil]
         attr_accessor :locked_state
         # Indicates whether the door access device is online.
+        # @return [Boolean, nil]
         attr_accessor :online
         # Indicates whether privacy mode is enabled for the lock.
+        # @return [Boolean, nil]
         attr_accessor :privacy_mode
       end
 
       class SaltoSpaceMetadata < BaseResource
         # Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system.
+        # @return [Boolean, nil]
         attr_accessor :audit_on_keys
         # Description of the door in the Salto Space access system.
+        # @return [String, nil]
         attr_accessor :door_description
         # Door ID in the Salto Space access system.
+        # @return [String, nil]
         attr_accessor :door_id
         # Name of the door in the Salto Space access system.
+        # @return [String, nil]
         attr_accessor :door_name
         # Description of the room in the Salto Space access system.
+        # @return [String, nil]
         attr_accessor :room_description
         # Name of the room in the Salto Space access system.
+        # @return [String, nil]
         attr_accessor :room_name
       end
 
       class VisionlineMetadata < BaseResource
         class Profiles < BaseResource
           # Door profile ID in the Visionline access system.
+          # @return [String, nil]
           attr_accessor :visionline_door_profile_id
           # Door profile type in the Visionline access system.
+          # @return [String, nil]
           attr_accessor :visionline_door_profile_type
         end
 
+        # Profile for the door in the Visionline access system.
+        # @return [Array<Profiles>]
         resource_list_accessor :profiles, Profiles
         # Category of the door in the Visionline access system.
+        # @return [String, nil]
         attr_accessor :door_category
         # Name of the door in the Visionline access system.
+        # @return [String, nil]
         attr_accessor :door_name
       end
 
       class Warnings < BaseResource
         # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
+        # @return [Time]
         date_accessor :created_at
       end
 
+      # Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [AkilesMetadata, nil]
       resource_accessor :akiles_metadata, AkilesMetadata
+      # ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [AssaAbloyVostioMetadata, nil]
       resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
+      # Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [AvigilonAltaMetadata, nil]
       resource_accessor :avigilon_alta_metadata, AvigilonAltaMetadata
+      # Brivo-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [BrivoMetadata, nil]
       resource_accessor :brivo_metadata, BrivoMetadata
+      # dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [DormakabaAmbianceMetadata, nil]
       resource_accessor :dormakaba_ambiance_metadata, DormakabaAmbianceMetadata
+      # dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [DormakabaCommunityMetadata, nil]
       resource_accessor :dormakaba_community_metadata, DormakabaCommunityMetadata
+      # Hotek-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [HotekMetadata, nil]
       resource_accessor :hotek_metadata, HotekMetadata
+      # Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [LatchMetadata, nil]
       resource_accessor :latch_metadata, LatchMetadata
+      # Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [SaltoKsMetadata, nil]
       resource_accessor :salto_ks_metadata, SaltoKsMetadata
+      # Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [SaltoSpaceMetadata, nil]
       resource_accessor :salto_space_metadata, SaltoSpaceMetadata
+      # Visionline-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [VisionlineMetadata, nil]
       resource_accessor :visionline_metadata, VisionlineMetadata
+      # Errors associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Warnings associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # ID of the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [String]
       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).
+      # @return [String]
       attr_accessor :acs_system_id
       # Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.
+      # @return [Boolean, nil]
       attr_accessor :can_belong_to_reservation
       # Indicates whether the ACS entrance can be unlocked with card credentials.
+      # @return [Boolean, nil]
       attr_accessor :can_unlock_with_card
       # Indicates whether the ACS entrance can be unlocked with cloud key credentials.
+      # @return [Boolean, nil]
       attr_accessor :can_unlock_with_cloud_key
       # Indicates whether the ACS entrance can be unlocked with pin codes.
+      # @return [Boolean, nil]
       attr_accessor :can_unlock_with_code
       # Indicates whether the ACS entrance can be unlocked with mobile key credentials.
+      # @return [Boolean, nil]
       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).
+      # @return [String]
       attr_accessor :connected_account_id
       # Display name for the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
+      # @return [String]
       attr_accessor :display_name
       # Indicates whether the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.
+      # @return [Boolean, nil]
       attr_accessor :is_locked
       # IDs of the spaces that the entrance is in.
+      # @return [Array<String>]
       attr_accessor :space_ids
 
       # Date and time at which the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end