seam 2.139.0 → 2.141.0

data/lib/seam/resources/action_attempt.rb

@@ -6,7 +6,9 @@ module Seam
     class ActionAttempt < BaseResource
       class Error < BaseResource
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
+        # @return [String]
         attr_accessor :type
       end
 
@@ -14,303 +16,493 @@ module Seam
         class AcsCredentialOnEncoder < BaseResource
           class VisionlineMetadata < BaseResource
             # Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is cancelled.
+            # @return [Boolean, nil]
             attr_accessor :cancelled
             # Format of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+            # @return [String, nil]
             attr_accessor :card_format
             # Holder of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+            # @return [String, nil]
             attr_accessor :card_holder
             # Card ID for the Visionline card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+            # @return [String, nil]
             attr_accessor :card_id
             # IDs of the common [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+            # @return [Array<String>]
             attr_accessor :common_acs_entrance_ids
             # Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is discarded.
+            # @return [Boolean, nil]
             attr_accessor :discarded
             # Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is expired.
+            # @return [Boolean, nil]
             attr_accessor :expired
             # IDs of the guest [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+            # @return [Array<String>]
             attr_accessor :guest_acs_entrance_ids
             # Number of issued cards associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+            # @return [Float, nil]
             attr_accessor :number_of_issued_cards
             # Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is overridden.
+            # @return [Boolean, nil]
             attr_accessor :overridden
             # Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is overwritten.
+            # @return [Boolean, nil]
             attr_accessor :overwritten
             # Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is pending auto-update.
+            # @return [Boolean, nil]
             attr_accessor :pending_auto_update
           end
 
+          # 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
           # A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+          # @return [String, nil]
           attr_accessor :card_number
           # Indicates whether the credential has been issued (encoded onto a card).
+          # @return [Boolean, nil]
           attr_accessor :is_issued
           # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.
+          # @return [Time, nil]
           date_accessor :created_at
           # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) will stop being usable.
+          # @return [Time, nil]
           date_accessor :ends_at
           # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable.
+          # @return [Time, nil]
           date_accessor :starts_at
         end
 
         class AcsCredentialOnSeam < 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
             # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+            # @return [String]
             attr_accessor :warning_code
+            # The PIN code that was assigned instead.
+            # @return [String, nil]
+            attr_accessor :new_code
+            # The originally requested PIN code that could not be used.
+            # @return [String, nil]
+            attr_accessor :original_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
+          # @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
 
+        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
           # 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
             # Previous end time for access.
+            # @return [Time, nil]
             date_accessor :ends_at
             # Previous start time for access.
+            # @return [Time, nil]
             date_accessor :starts_at
           end
 
           class To < BaseResource
             # New end time for access.
+            # @return [Time, nil]
             date_accessor :ends_at
             # New start time for access.
+            # @return [Time, nil]
             date_accessor :starts_at
           end
 
+          # Previous access time configuration.
+          # @return [From]
           resource_accessor :from, From
+          # New access time configuration.
+          # @return [To]
           resource_accessor :to, To
           # Detailed description of the mutation.
+          # @return [String]
           attr_accessor :message
           # Mutation code to indicate that Seam is in the process of updating the access times for this access method.
+          # @return [String]
           attr_accessor :mutation_code
           # Date and time at which the mutation was created.
+          # @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, nil]
+          attr_accessor :new_code
           # ID of the original access method from which this backup access method was split, if applicable.
+          # @return [String, nil]
           attr_accessor :original_access_method_id
+          # The originally requested PIN code that could not be used.
+          # @return [String, nil]
+          attr_accessor :original_code
+          # @return [String]
           attr_accessor :warning_code
           # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
           attr_accessor :warning_message
           # Date and time at which Seam created the warning.
+          # @return [Time]
           date_accessor :created_at
         end
 
+        # Snapshot of credential data read from the physical encoder.
+        # @return [AcsCredentialOnEncoder, nil]
         resource_accessor :acs_credential_on_encoder, AcsCredentialOnEncoder
+        # Corresponding credential data as stored on Seam and the access system.
+        # @return [AcsCredentialOnSeam, nil]
         resource_accessor :acs_credential_on_seam, AcsCredentialOnSeam
+        # 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
+        # @return [Array<Errors>]
         resource_list_accessor :errors, Errors
+        # Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
+        # @return [Array<PendingMutations>]
         resource_list_accessor :pending_mutations, PendingMutations
+        # @return [Array<Warnings>]
         resource_list_accessor :warnings, Warnings
+        # @return [Hash, nil]
+        attr_accessor :access_code
         # 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 access method.
+        # @return [String]
         attr_accessor :access_method_id
         # 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
         # Token of the client session associated with the access method.
+        # @return [String, nil]
         attr_accessor :client_session_token
+        # @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
         # ID of the customization profile associated with the access method.
+        # @return [String, nil]
         attr_accessor :customization_profile_id
+        # @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
         # URL of the Instant Key for mobile key access methods.
+        # @return [String, nil]
         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.
+        # @return [Boolean, nil]
         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.
+        # @return [Boolean, nil]
         attr_accessor :is_encoding_required
+        # @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
         # 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.
+        # @return [Boolean, nil]
         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.
+        # @return [Boolean, nil]
         attr_accessor :is_ready_for_encoding
         # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+        # @return [String]
         attr_accessor :mode
+        # @return [Hash]
+        attr_accessor :noise_threshold
         # 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
+        # @return [Boolean, nil]
         attr_accessor :was_confirmed_by_device
+        # @return [String]
         attr_accessor :workspace_id
+        # @return [Time]
         date_accessor :created_at
+        # @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
 
+      # Error associated with the action.
+      # @return [Error]
       resource_accessor :error, Error
+      # @return [Result]
       resource_accessor :result, Result
       # ID of the action attempt.
+      # @return [String]
       attr_accessor :action_attempt_id
+      # @return [String]
       attr_accessor :action_type
+      # @return [String]
       attr_accessor :status
     end
   end

data/lib/seam/resources/batch.rb

@@ -13,16 +13,20 @@ module Seam
       # 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.
+      # @return [Hash, nil]
       attr_accessor :access_codes
       # 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.
+      # @return [Hash, nil]
       attr_accessor :access_grants
       # 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.
+      # @return [Hash, nil]
       attr_accessor :access_methods
       # 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).
+      # @return [Hash, nil]
       attr_accessor :acs_access_groups
       # 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).
       #
@@ -31,6 +35,7 @@ module Seam
       # 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.
+      # @return [Hash, nil]
       attr_accessor :acs_credentials
       # 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).
       #
@@ -46,28 +51,33 @@ module Seam
       # 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).
+      # @return [Hash, nil]
       attr_accessor :acs_encoders
       # 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.
+      # @return [Hash, nil]
       attr_accessor :acs_entrances
       # 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).
+      # @return [Hash, nil]
       attr_accessor :acs_systems
       # 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).
+      # @return [Hash, nil]
       attr_accessor :acs_users
       # Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
       #
       # When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
       #
       # See also [Action Attempts](https://docs.seam.co/core-concepts/action-attempts).
+      # @return [Hash, nil]
       attr_accessor :action_attempts
       # Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
       #
@@ -78,6 +88,7 @@ module Seam
       # A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
       #
       # See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
+      # @return [Hash, nil]
       attr_accessor :client_sessions
       # Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
       #
@@ -90,26 +101,35 @@ module Seam
       # When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
       #
       # To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.
+      # @return [Hash, nil]
       attr_accessor :connect_webviews
       # Represents a [connected account](https://docs.seam.co/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
+      # @return [Hash, nil]
       attr_accessor :connected_accounts
       # Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.
+      # @return [Hash, nil]
       attr_accessor :devices
       # Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.
       #
       # As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
+      # @return [Hash, nil]
       attr_accessor :events
       # Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.
       #
       # There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.
+      # @return [Hash, nil]
       attr_accessor :instant_keys
       # Represents a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
+      # @return [Hash, nil]
       attr_accessor :noise_thresholds
       # Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.
+      # @return [Hash, nil]
       attr_accessor :spaces
       # Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
+      # @return [Hash, nil]
       attr_accessor :thermostat_daily_programs
       # Represents a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
+      # @return [Hash, nil]
       attr_accessor :thermostat_schedules
       # Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
       #
@@ -122,12 +142,16 @@ module Seam
       # Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
       #
       # - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks)
+      # @return [Hash, nil]
       attr_accessor :unmanaged_access_codes
       # Represents an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+      # @return [Hash, nil]
       attr_accessor :unmanaged_devices
       # Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
+      # @return [Hash, nil]
       attr_accessor :user_identities
       # Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces).
+      # @return [Hash, nil]
       attr_accessor :workspaces
     end
   end