seam 2.139.0 → 2.141.0

data/lib/seam/resources/acs_system.rb

@@ -10,77 +10,113 @@ module Seam
     class AcsSystem < 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
         # Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
+        # @return [Boolean, nil]
         attr_accessor :is_bridge_error
         # 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 Location < BaseResource
         # Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located.
+        # @return [String, nil]
         attr_accessor :time_zone
       end
 
       class VisionlineMetadata < BaseResource
         # IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network.
+        # @return [String, nil]
         attr_accessor :lan_address
         # Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
+        # @return [String, nil]
         attr_accessor :mobile_access_uuid
         # Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+        # @return [String, nil]
         attr_accessor :system_id
       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
+        # @return [Array<String>]
         # @deprecated this field is deprecated.
         attr_accessor :misconfigured_acs_entrance_ids
         # 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
 
+      # Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [Location]
       resource_accessor :location, Location
+      # Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [VisionlineMetadata, nil]
       resource_accessor :visionline_metadata, VisionlineMetadata
+      # Errors associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Warnings associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [Float, nil]
       attr_accessor :acs_access_group_count
       # ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [String]
       attr_accessor :acs_system_id
       # Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [Float, nil]
       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).
+      # @return [String]
       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).
+      # @return [Array<String>]
       # @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).
+      # @return [String, nil]
       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.
+      # @return [String, nil]
       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.
+      # @return [String, nil]
       attr_accessor :external_type_display_name
       # Alternative text for the [access control system](https://docs.seam.co/low-level-apis/access-systems) image.
+      # @return [String]
       attr_accessor :image_alt_text
       # URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [String]
       attr_accessor :image_url
       # Indicates whether the `acs_system` is a credential manager.
+      # @return [Boolean]
       attr_accessor :is_credential_manager
       # Name of the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [String]
       attr_accessor :name
+      # @return [String, nil]
       # @deprecated Use `external_type`.
       attr_accessor :system_type
+      # @return [String, nil]
       # @deprecated Use `external_type_display_name`.
       attr_accessor :system_type_display_name
       # ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/acs_user.rb

@@ -10,135 +10,201 @@ module Seam
     class AcsUser < 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
+        # @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 access group ID.
+          # @return [String, nil]
           attr_accessor :acs_access_group_id
           # Previous credential ID.
+          # @return [String, nil]
           attr_accessor :acs_credential_id
           # Email address of the access system user.
+          # @return [String, nil]
           attr_accessor :email_address
           # Full name of the access system user.
+          # @return [String, nil]
           attr_accessor :full_name
+          # @return [Boolean]
           attr_accessor :is_suspended
           # Phone number of the access system user.
+          # @return [String, nil]
           attr_accessor :phone_number
           # Starting 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 access group ID.
+          # @return [String, nil]
           attr_accessor :acs_access_group_id
           # New credential ID.
+          # @return [String, nil]
           attr_accessor :acs_credential_id
           # Email address of the access system user.
+          # @return [String, nil]
           attr_accessor :email_address
           # Full name of the access system user.
+          # @return [String, nil]
           attr_accessor :full_name
+          # @return [Boolean]
           attr_accessor :is_suspended
           # Phone number of the access system user.
+          # @return [String, nil]
           attr_accessor :phone_number
           # Starting 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 access group involved in the scheduled change.
+        # @return [String]
         attr_accessor :acs_access_group_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 the access group.
+        # @return [String]
         attr_accessor :variant
         # Date and time at which the mutation was created.
+        # @return [Time]
         date_accessor :created_at
         # Optional: When the user creation is scheduled to occur.
+        # @return [Time, nil]
         date_accessor :scheduled_at
       end
 
       class SaltoKsMetadata < BaseResource
         # Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked.
+        # @return [Boolean, nil]
         attr_accessor :is_subscribed
       end
 
       class SaltoSpaceMetadata < BaseResource
         # Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.
+        # @return [Boolean, nil]
         attr_accessor :audit_openings
         # User ID in the Salto Space access system.
+        # @return [String, nil]
         attr_accessor :user_id
       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
+        # @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 system user's](https://docs.seam.co/low-level-apis/access-systems/user-management) access.
+      # @return [AccessSchedule, nil]
       resource_accessor :access_schedule, AccessSchedule
+      # Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [SaltoKsMetadata, nil]
       resource_accessor :salto_ks_metadata, SaltoKsMetadata
+      # Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [SaltoSpaceMetadata, nil]
       resource_accessor :salto_space_metadata, SaltoSpaceMetadata
+      # Errors associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # 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.
+      # @return [Array<PendingMutations>]
       resource_list_accessor :pending_mutations, PendingMutations
+      # Warnings associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # 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).
+      # @return [String]
       attr_accessor :acs_system_id
       # ID of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [String]
       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).
+      # @return [String]
       attr_accessor :connected_account_id
       # Display name for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [String]
       attr_accessor :display_name
+      # @return [String, nil]
       # @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).
+      # @return [String, nil]
       attr_accessor :email_address
       # Brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type.
+      # @return [String, nil]
       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.
+      # @return [String, nil]
       attr_accessor :external_type_display_name
       # Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [String, nil]
       attr_accessor :full_name
       # ID of the HID access control system associated with the user.
+      # @return [String, nil]
       attr_accessor :hid_acs_system_id
       # Indicates whether Seam manages the access system user.
+      # @return [Boolean]
       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).
+      # @return [Boolean, nil]
       attr_accessor :is_suspended
       # 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`).
+      # @return [String, nil]
       attr_accessor :phone_number
       # Email address of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @return [String, nil]
       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).
+      # @return [String, nil]
       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).
+      # @return [String, nil]
       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`).
+      # @return [String, nil]
       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).
+      # @return [String]
       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.
+      # @return [Time]
       date_accessor :created_at
     end
   end