seam 2.139.0 → 2.141.0

data/lib/seam/resources/space.rb

@@ -6,42 +6,61 @@ module Seam
     class Space < BaseResource
       class CustomerData < BaseResource
         # Postal address for the space.
+        # @return [String, nil]
         attr_accessor :address
         # Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
+        # @return [String, nil]
         attr_accessor :default_checkin_time
         # Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
+        # @return [String, nil]
         attr_accessor :default_checkout_time
         # IANA time zone for the space, e.g. America/Los_Angeles.
+        # @return [String, nil]
         attr_accessor :time_zone
       end
 
       class Geolocation < BaseResource
         # Latitude of the space, in decimal degrees.
+        # @return [Float]
         attr_accessor :latitude
         # Longitude of the space, in decimal degrees.
+        # @return [Float]
         attr_accessor :longitude
       end
 
+      # Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam).
+      # @return [CustomerData, nil]
       resource_accessor :customer_data, CustomerData
+      # Geographic coordinates (latitude and longitude) of the space.
+      # @return [Geolocation, nil]
       resource_accessor :geolocation, Geolocation
       # Number of entrances in the space.
+      # @return [Float]
       attr_accessor :acs_entrance_count
       # Customer key associated with the space.
+      # @return [String, nil]
       attr_accessor :customer_key
       # Number of devices in the space.
+      # @return [Float]
       attr_accessor :device_count
       # Display name for the space.
+      # @return [String]
       attr_accessor :display_name
       # Name of the space.
+      # @return [String]
       attr_accessor :name
       # ID of the space.
+      # @return [String]
       attr_accessor :space_id
       # Unique key for the space within the workspace.
+      # @return [String, nil]
       attr_accessor :space_key
       # ID of the workspace associated with the space.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the space was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/thermostat_daily_program.rb

@@ -6,22 +6,31 @@ module Seam
     class ThermostatDailyProgram < BaseResource
       class Periods < BaseResource
         # Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
+        # @return [String]
         attr_accessor :climate_preset_key
         # Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+        # @return [String]
         attr_accessor :starts_at_time
       end
 
+      # Array of thermostat daily program periods.
+      # @return [Array<Periods>]
       resource_list_accessor :periods, Periods
       # ID of the thermostat device on which the thermostat daily program is configured.
+      # @return [String]
       attr_accessor :device_id
       # User-friendly name to identify the thermostat daily program.
+      # @return [String, nil]
       attr_accessor :name
       # ID of the thermostat daily program.
+      # @return [String]
       attr_accessor :thermostat_daily_program_id
       # ID of the workspace that contains the thermostat daily program.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the thermostat daily program was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/thermostat_schedule.rb

@@ -6,36 +6,51 @@ module Seam
     class ThermostatSchedule < 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 [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
       # Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+      # @return [String]
       attr_accessor :climate_preset_key
       # ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device.
+      # @return [String]
       attr_accessor :device_id
       # Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
+      # @return [Boolean, nil]
       attr_accessor :is_override_allowed
       # Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+      # @return [Integer, nil]
       attr_accessor :max_override_period_minutes
       # User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+      # @return [String, nil]
       attr_accessor :name
       # ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+      # @return [String]
       attr_accessor :thermostat_schedule_id
       # ID of the workspace that contains the thermostat schedule.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @return [Time]
       date_accessor :ends_at
 
       # Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @return [Time]
       date_accessor :starts_at
     end
   end

data/lib/seam/resources/unmanaged_access_code.rb

@@ -16,106 +16,157 @@ module Seam
     class UnmanagedAccessCode < BaseResource
       class DormakabaOracodeMetadata < BaseResource
         # Indicates whether the stay can be cancelled via the Dormakaba Oracode API.
+        # @return [Boolean, nil]
         attr_accessor :is_cancellable
         # Indicates whether early check-in is available for this stay.
+        # @return [Boolean, nil]
         attr_accessor :is_early_checkin_able
         # Indicates whether the stay can be extended via the Dormakaba Oracode API.
+        # @return [Boolean, nil]
         attr_accessor :is_extendable
         # Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.
+        # @return [Boolean, nil]
         attr_accessor :is_overridable
         # Dormakaba Oracode site name associated with this access code.
+        # @return [String, nil]
         attr_accessor :site_name
         # Dormakaba Oracode stay ID associated with this access code.
+        # @return [Float, nil]
         attr_accessor :stay_id
         # Dormakaba Oracode user level ID associated with this access code.
+        # @return [String, nil]
         attr_accessor :user_level_id
         # Dormakaba Oracode user level name associated with this access code.
+        # @return [String, nil]
         attr_accessor :user_level_name
       end
 
       class Errors < BaseResource
         class ModifiedFields < BaseResource
           # The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).
+          # @return [String]
           attr_accessor :field
           # The previous value of the field.
+          # @return [String, nil]
           attr_accessor :from
           # The new value of the field.
+          # @return [String, nil]
           attr_accessor :to
         end
 
+        # List of fields that were changed externally, with their previous and new values.
+        # @return [Array<ModifiedFields>]
         resource_list_accessor :modified_fields, ModifiedFields
         # Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.
+        # @return [String, nil]
         attr_accessor :change_type
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+        # @return [String]
         attr_accessor :error_code
         # Indicates that this is an access code error.
+        # @return [Boolean]
         attr_accessor :is_access_code_error
         # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
+        # @return [Boolean, nil]
         attr_accessor :is_bridge_error
+        # @return [Boolean, nil]
         attr_accessor :is_connected_account_error
+        # @return [Boolean]
         attr_accessor :is_device_error
         # ID of the managed access code that conflicts with this managed access code, when Seam can identify it.
+        # @return [String, nil]
         attr_accessor :managed_access_code_id
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.
+        # @return [String, nil]
         attr_accessor :unmanaged_access_code_id
         # Date and time at which Seam created the error.
+        # @return [Time, nil]
         date_accessor :created_at
       end
 
       class Warnings < BaseResource
         class ModifiedFields < BaseResource
           # The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).
+          # @return [String]
           attr_accessor :field
           # The previous value of the field.
+          # @return [String, nil]
           attr_accessor :from
           # The new value of the field.
+          # @return [String, nil]
           attr_accessor :to
         end
 
+        # List of fields that were changed externally, with their previous and new values.
+        # @return [Array<ModifiedFields>]
         resource_list_accessor :modified_fields, ModifiedFields
         # Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.
+        # @return [String, nil]
         attr_accessor :change_type
         # 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, nil]
         date_accessor :created_at
       end
 
+      # Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.
+      # @return [DormakabaOracodeMetadata, nil]
       resource_accessor :dormakaba_oracode_metadata, DormakabaOracodeMetadata
+      # Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Unique identifier for the access code.
+      # @return [String]
       attr_accessor :access_code_id
       # Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.
+      # @return [Boolean, nil]
       attr_accessor :cannot_be_managed
       # Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.
+      # @return [Boolean, nil]
       attr_accessor :cannot_delete_unmanaged_access_code
       # Code used for access. Typically, a numeric or alphanumeric string.
+      # @return [String, nil]
       attr_accessor :code
       # Unique identifier for the device associated with the access code.
+      # @return [String]
       attr_accessor :device_id
       # Indicates that Seam does not manage the access code.
+      # @return [Boolean]
       attr_accessor :is_managed
       # Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+      # @return [String, nil]
       attr_accessor :name
       # Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.
+      # @return [String]
       attr_accessor :status
       # Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.
+      # @return [String]
       attr_accessor :type
       # Unique identifier for the Seam workspace associated with the access code.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the access code was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time after which the time-bound access code becomes inactive.
+      # @return [Time, nil]
       date_accessor :ends_at
 
       # Date and time at which the time-bound access code becomes active.
+      # @return [Time, nil]
       date_accessor :starts_at
     end
   end

data/lib/seam/resources/unmanaged_access_grant.rb

@@ -6,120 +6,176 @@ module Seam
     class UnmanagedAccessGrant < 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
         # IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure.
+        # @return [Array<String>]
         attr_accessor :missing_device_ids
         # Date and time at which Seam created the error.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class PendingMutations < BaseResource
         class From < BaseResource
           # Previous device IDs where access codes existed.
+          # @return [Array<String>]
           attr_accessor :device_ids
           # 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
           # Common code key to ensure PIN code reuse across devices.
+          # @return [String, nil]
           attr_accessor :common_code_key
           # New device IDs where access codes should be created.
+          # @return [Array<String>]
           attr_accessor :device_ids
           # 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
 
+        # @return [From]
         resource_accessor :from, From
+        # @return [To]
         resource_accessor :to, To
         # IDs of the access methods being updated.
+        # @return [Array<String>]
         attr_accessor :access_method_ids
         # Detailed description of the mutation.
+        # @return [String]
         attr_accessor :message
+        # @return [String]
         attr_accessor :mutation_code
         # Date and time at which the mutation was created.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class RequestedAccessMethods < BaseResource
         # Specific PIN code to use for this access method. Only applicable when mode is 'code'.
+        # @return [String, nil]
         attr_accessor :code
         # IDs of the access methods created for the requested access method.
+        # @return [Array<String>]
         attr_accessor :created_access_method_ids
         # Display name of the access method.
+        # @return [String]
         attr_accessor :display_name
         # Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.
+        # @return [Integer, nil]
         attr_accessor :instant_key_max_use_count
         # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+        # @return [String]
         attr_accessor :mode
         # Date and time at which the requested access method was added to the Access Grant.
+        # @return [Time]
         date_accessor :created_at
       end
 
       class Warnings < BaseResource
         class FailedDevices < BaseResource
           # Device whose access code could not be revoked.
+          # @return [String]
           attr_accessor :device_id
           # Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).
+          # @return [String]
           attr_accessor :error_code
           # Human-readable description of why revocation failed.
+          # @return [String]
           attr_accessor :message
         end
 
+        # Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget).
+        # @return [Array<FailedDevices>]
         resource_list_accessor :failed_devices, FailedDevices
         # IDs of the access methods being updated.
+        # @return [Array<String>]
         attr_accessor :access_method_ids
+        # @return [String]
         attr_accessor :device_id
         # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+        # @return [String]
         attr_accessor :message
         # The new PIN code that was assigned instead.
+        # @return [String]
         attr_accessor :new_code
         # The originally requested PIN code that was unavailable.
+        # @return [String]
         attr_accessor :original_code
         # Specific reason why the grant's times are not programmable on the device.
+        # @return [String]
         attr_accessor :reason
         # 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
 
+      # Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # List of pending mutations for the access grant. This shows updates that are in progress.
+      # @return [Array<PendingMutations>]
       resource_list_accessor :pending_mutations, PendingMutations
+      # Access methods that the user requested for the Access Grant.
+      # @return [Array<RequestedAccessMethods>]
       resource_list_accessor :requested_access_methods, RequestedAccessMethods
+      # Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # ID of the Access Grant.
+      # @return [String]
       attr_accessor :access_grant_id
       # IDs of the access methods created for the Access Grant.
+      # @return [Array<String>]
       attr_accessor :access_method_ids
       # Display name of the Access Grant.
+      # @return [String]
       attr_accessor :display_name
+      # @return [Array<String>]
       # @deprecated Use `space_ids`.
       attr_accessor :location_ids
       # Name of the Access Grant. If not provided, the display name will be computed.
+      # @return [String, nil]
       attr_accessor :name
       # Reservation key for the access grant.
+      # @return [String, nil]
       attr_accessor :reservation_key
       # IDs of the spaces to which the Access Grant gives access.
+      # @return [Array<String>]
       attr_accessor :space_ids
       # ID of user identity to which the Access Grant gives access.
+      # @return [String, nil]
       attr_accessor :user_identity_id
       # ID of the Seam workspace associated with the Access Grant.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the Access Grant was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time at which the Access Grant ends.
+      # @return [Time, nil]
       date_accessor :ends_at
 
       # Date and time at which the Access Grant starts.
+      # @return [Time]
       date_accessor :starts_at
     end
   end

data/lib/seam/resources/unmanaged_access_method.rb

@@ -6,78 +6,114 @@ module Seam
     class UnmanagedAccessMethod < 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
 
       class PendingMutations < BaseResource
         class From < BaseResource
+          # @return [Array<String>]
           attr_accessor :device_ids
           # 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
+          # @return [Array<String>]
           attr_accessor :device_ids
           # 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
 
+        # @return [From]
         resource_accessor :from, From
+        # @return [To]
         resource_accessor :to, To
         # Detailed description of the mutation.
+        # @return [String]
         attr_accessor :message
+        # @return [String]
         attr_accessor :mutation_code
         # 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
         # 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
         # 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
 
+      # Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
+      # @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
+      # Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # ID of the access method.
+      # @return [String]
       attr_accessor :access_method_id
       # The actual PIN code for code access methods.
+      # @return [String, nil]
       attr_accessor :code
       # Display name of the access method.
+      # @return [String]
       attr_accessor :display_name
       # 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
       # Indicates whether the access method has been issued.
+      # @return [Boolean]
       attr_accessor :is_issued
       # Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
+      # @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
       # ID of the Seam workspace associated with the access method.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the access method was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time at which the access method was issued.
+      # @return [Time, nil]
       date_accessor :issued_at
     end
   end