seam 2.138.0 → 2.140.0

data/lib/seam/resources/unmanaged_device.rb

@@ -6,23 +6,35 @@ module Seam
     class UnmanagedDevice < 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 [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
         # 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
         # Name of the device location.
+        # @return [String, nil]
         attr_accessor :location_name
+        # Name of the room within the device location, when the provider reports one.
+        # @return [String, nil]
+        attr_accessor :room_name
         # Time zone of the device location.
+        # @return [String, nil]
         attr_accessor :time_zone
         # Time zone of the device location.
+        # @return [String, nil]
         # @deprecated Use `time_zone` instead.
         attr_accessor :timezone
       end
@@ -30,135 +42,203 @@ module Seam
       class Properties < BaseResource
         class AccessoryKeypad < BaseResource
           class Battery < BaseResource
+            # @return [Float]
             attr_accessor :level
           end
 
+          # Keypad battery properties.
+          # @return [Battery, nil]
           resource_accessor :battery, Battery
           # Indicates if an accessory keypad is connected to the device.
+          # @return [Boolean]
           attr_accessor :is_connected
         end
 
         class Battery < BaseResource
           # Battery charge level as a value between 0 and 1, inclusive.
+          # @return [Float]
           attr_accessor :level
           # Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.
+          # @return [String]
           attr_accessor :status
         end
 
         class Model < BaseResource
+          # @return [Boolean, nil]
           # @deprecated use device.properties.model.can_connect_accessory_keypad
           attr_accessor :accessory_keypad_supported
           # Indicates whether the device can connect a accessory keypad.
+          # @return [Boolean, nil]
           attr_accessor :can_connect_accessory_keypad
           # Display name of the device model.
+          # @return [String]
           attr_accessor :display_name
           # Indicates whether the device has a built in accessory keypad.
+          # @return [Boolean, nil]
           attr_accessor :has_built_in_keypad
           # Display name that corresponds to the manufacturer-specific terminology for the device.
+          # @return [String]
           attr_accessor :manufacturer_display_name
+          # @return [Boolean, nil]
           # @deprecated use device.can_program_offline_access_codes.
           attr_accessor :offline_access_codes_supported
+          # @return [Boolean, nil]
           # @deprecated use device.can_program_online_access_codes.
           attr_accessor :online_access_codes_supported
         end
 
+        # Accessory keypad properties and state.
+        # @return [AccessoryKeypad, nil]
         resource_accessor :accessory_keypad, AccessoryKeypad
+        # Represents the current status of the battery charge level.
+        # @return [Battery, nil]
         resource_accessor :battery, Battery
+        # Device model-related properties.
+        # @return [Model]
         resource_accessor :model, Model
         # Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
+        # @return [Float, nil]
         attr_accessor :battery_level
         # Alt text for the device image.
+        # @return [String, nil]
         attr_accessor :image_alt_text
         # Image URL for the device.
+        # @return [String, nil]
         attr_accessor :image_url
         # Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.
+        # @return [String, nil]
         attr_accessor :manufacturer
         # Name of the device.
+        # @return [String]
         # @deprecated use device.display_name instead
         attr_accessor :name
         # Indicates whether it is currently possible to use offline access codes for the device.
+        # @return [Boolean, nil]
         # @deprecated use device.can_program_offline_access_codes
         attr_accessor :offline_access_codes_enabled
         # Indicates whether the device is online.
+        # @return [Boolean]
         attr_accessor :online
         # Indicates whether it is currently possible to use online access codes for the device.
+        # @return [Boolean, nil]
         # @deprecated use device.can_program_online_access_codes
         attr_accessor :online_access_codes_enabled
       end
 
       class Warnings < BaseResource
         # Number of active access codes on the device when the warning was set.
+        # @return [Integer]
         attr_accessor :active_access_code_count
         # Maximum number of active access codes supported by the device.
+        # @return [Integer]
         attr_accessor :max_active_access_code_count
         # 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
 
+      # Location information for the device.
+      # @return [Location, nil]
       resource_accessor :location, Location
+      # properties of the device.
+      # @return [Properties]
       resource_accessor :properties, Properties
+      # Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Indicates whether the lock supports configuring automatic locking.
+      # @return [Boolean, nil]
       attr_accessor :can_configure_auto_lock
       # Indicates whether the thermostat supports cooling.
+      # @return [Boolean, nil]
       attr_accessor :can_hvac_cool
       # Indicates whether the thermostat supports heating.
+      # @return [Boolean, nil]
       attr_accessor :can_hvac_heat
       # Indicates whether the thermostat supports simultaneous heating and cooling.
+      # @return [Boolean, nil]
       attr_accessor :can_hvac_heat_cool
       # Indicates whether the device supports programming offline access codes.
+      # @return [Boolean, nil]
       attr_accessor :can_program_offline_access_codes
       # Indicates whether the device supports programming online access codes.
+      # @return [Boolean, nil]
       attr_accessor :can_program_online_access_codes
       # Indicates whether the thermostat supports different climate programs for each day of the week.
+      # @return [Boolean, nil]
       attr_accessor :can_program_thermostat_programs_as_different_each_day
       # Indicates whether the thermostat supports a single climate program applied to every day.
+      # @return [Boolean, nil]
       attr_accessor :can_program_thermostat_programs_as_same_each_day
       # Indicates whether the thermostat supports weekday/weekend climate programs.
+      # @return [Boolean, nil]
       attr_accessor :can_program_thermostat_programs_as_weekday_weekend
       # Indicates whether the device supports remote locking.
+      # @return [Boolean, nil]
       attr_accessor :can_remotely_lock
       # Indicates whether the device supports remote unlocking.
+      # @return [Boolean, nil]
       attr_accessor :can_remotely_unlock
       # Indicates whether the thermostat supports running climate programs.
+      # @return [Boolean, nil]
       attr_accessor :can_run_thermostat_programs
       # Indicates whether the device supports simulating connection in a sandbox.
+      # @return [Boolean, nil]
       attr_accessor :can_simulate_connection
       # Indicates whether the device supports simulating disconnection in a sandbox.
+      # @return [Boolean, nil]
       attr_accessor :can_simulate_disconnection
       # Indicates whether the hub supports simulating connection in a sandbox.
+      # @return [Boolean, nil]
       attr_accessor :can_simulate_hub_connection
       # Indicates whether the hub supports simulating disconnection in a sandbox.
+      # @return [Boolean, nil]
       attr_accessor :can_simulate_hub_disconnection
       # Indicates whether the device supports simulating a paid subscription in a sandbox.
+      # @return [Boolean, nil]
       attr_accessor :can_simulate_paid_subscription
       # Indicates whether the device supports simulating removal in a sandbox.
+      # @return [Boolean, nil]
       attr_accessor :can_simulate_removal
       # Indicates whether the thermostat can be turned off.
+      # @return [Boolean, nil]
       attr_accessor :can_turn_off_hvac
       # Indicates whether the lock supports unlocking with an access code.
+      # @return [Boolean, nil]
       attr_accessor :can_unlock_with_code
       # Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).
+      # @return [Array<String>]
       attr_accessor :capabilities_supported
       # Unique identifier for the account associated with the device.
+      # @return [String]
       attr_accessor :connected_account_id
       # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
+      # @return [Hash]
       attr_accessor :custom_metadata
       # ID of the device.
+      # @return [String]
       attr_accessor :device_id
       # Type of the device.
+      # @return [String]
       attr_accessor :device_type
       # Indicates that Seam does not manage the device.
+      # @return [Boolean]
       attr_accessor :is_managed
       # Unique identifier for the Seam workspace associated with the device.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the device object was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/unmanaged_user_identity.rb

@@ -6,44 +6,64 @@ module Seam
     class UnmanagedUserIdentity < BaseResource
       class Errors < BaseResource
         # ID of the access system that the user identity is associated with.
+        # @return [String]
         attr_accessor :acs_system_id
         # ID of the access system user that has an issue.
+        # @return [String]
         attr_accessor :acs_user_id
         # 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 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
 
+      # Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Array of access system user IDs associated with the user identity.
+      # @return [Array<String>]
       attr_accessor :acs_user_ids
       # Display name for the user identity.
+      # @return [String]
       attr_accessor :display_name
       # Unique email address for the user identity.
+      # @return [String, nil]
       attr_accessor :email_address
       # Full name of the user associated with the user identity.
+      # @return [String, nil]
       attr_accessor :full_name
       # Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+      # @return [String, nil]
       attr_accessor :phone_number
       # ID of the user identity.
+      # @return [String]
       attr_accessor :user_identity_id
       # ID of the workspace that contains the user identity.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the user identity was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/user_identity.rb

@@ -6,46 +6,67 @@ module Seam
     class UserIdentity < BaseResource
       class Errors < BaseResource
         # ID of the access system that the user identity is associated with.
+        # @return [String]
         attr_accessor :acs_system_id
         # ID of the access system user that has an issue.
+        # @return [String]
         attr_accessor :acs_user_id
         # 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 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
 
+      # Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Array of access system user IDs associated with the user identity.
+      # @return [Array<String>]
       attr_accessor :acs_user_ids
       # Display name for the user identity.
+      # @return [String]
       attr_accessor :display_name
       # Unique email address for the user identity.
+      # @return [String, nil]
       attr_accessor :email_address
       # Full name of the user associated with the user identity.
+      # @return [String, nil]
       attr_accessor :full_name
       # Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
+      # @return [String, nil]
       attr_accessor :phone_number
       # ID of the user identity.
+      # @return [String]
       attr_accessor :user_identity_id
       # Unique key for the user identity.
+      # @return [String, nil]
       attr_accessor :user_identity_key
       # ID of the workspace that contains the user identity.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the user identity was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/webhook.rb

@@ -5,12 +5,16 @@ module Seam
     # Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.
     class Webhook < BaseResource
       # Types of events that the [webhook](https://docs.seam.co/developer-tools/webhooks) should receive.
+      # @return [Array<String>]
       attr_accessor :event_types
       # Secret associated with the [webhook](https://docs.seam.co/developer-tools/webhooks).
+      # @return [String, nil]
       attr_accessor :secret
       # URL for the [webhook](https://docs.seam.co/developer-tools/webhooks).
+      # @return [String]
       attr_accessor :url
       # ID of the webhook.
+      # @return [String]
       attr_accessor :webhook_id
     end
   end

data/lib/seam/resources/workspace.rb

@@ -6,35 +6,50 @@ module Seam
     class Workspace < BaseResource
       class ConnectWebviewCustomization < BaseResource
         # URL of the inviter logo for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+        # @return [String, nil]
         attr_accessor :inviter_logo_url
         # Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+        # @return [String, nil]
         attr_accessor :logo_shape
         # Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+        # @return [String, nil]
         attr_accessor :primary_button_color
         # Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+        # @return [String, nil]
         attr_accessor :primary_button_text_color
         # Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
+        # @return [String, nil]
         attr_accessor :success_message
       end
 
+      # @return [ConnectWebviewCustomization]
       resource_accessor :connect_webview_customization, ConnectWebviewCustomization
       # Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces).
+      # @return [String]
       attr_accessor :company_name
+      # @return [String, nil]
       # @deprecated Use `company_name` instead.
       attr_accessor :connect_partner_name
       # Indicates whether publishable key authentication is enabled for this workspace.
+      # @return [Boolean]
       attr_accessor :is_publishable_key_auth_enabled
       # Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @return [Boolean]
       attr_accessor :is_sandbox
       # Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
+      # @return [Boolean]
       attr_accessor :is_suspended
       # Name of the [workspace](https://docs.seam.co/core-concepts/workspaces).
+      # @return [String]
       attr_accessor :name
       # ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.
+      # @return [String, nil]
       attr_accessor :organization_id
       # Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.
+      # @return [String, nil]
       attr_accessor :publishable_key
       # ID of the workspace.
+      # @return [String]
       attr_accessor :workspace_id
     end
   end