seam 2.139.0 → 2.141.0

data/lib/seam/resources/client_session.rb

@@ -13,31 +13,43 @@ module Seam
     # 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).
     class ClientSession < BaseResource
       # ID of the client session.
+      # @return [String]
       attr_accessor :client_session_id
       # IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @return [Array<String>]
       attr_accessor :connect_webview_ids
       # IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @return [Array<String>]
       attr_accessor :connected_account_ids
       # Customer key associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @return [String, nil]
       attr_accessor :customer_key
       # Number of devices associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @return [Float]
       attr_accessor :device_count
       # Client session token associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @return [String]
       attr_accessor :token
       # Your user ID for the user associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @return [String, nil]
       attr_accessor :user_identifier_key
       # ID of the [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 the client session.
+      # @return [String, nil]
       attr_accessor :user_identity_id
       # IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
+      # @return [Array<String>]
       # @deprecated Use `user_identity_id` instead.
       attr_accessor :user_identity_ids
       # ID of the workspace associated with the client session.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) expires.
+      # @return [Time]
       date_accessor :expires_at
     end
   end

data/lib/seam/resources/connect_webview.rb

@@ -15,44 +15,63 @@ module Seam
     # 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.
     class ConnectWebview < BaseResource
       # High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.
+      # @return [Array<String>]
       attr_accessor :accepted_capabilities
       # List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
+      # @return [Array<String>]
       attr_accessor :accepted_providers
       # Indicates whether any provider is allowed.
+      # @return [Boolean]
       attr_accessor :any_provider_allowed
       # Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.
+      # @return [Boolean]
       attr_accessor :automatically_manage_new_devices
       # ID of the Connect Webview.
+      # @return [String]
       attr_accessor :connect_webview_id
       # ID of the connected account associated with the Connect Webview.
+      # @return [String, nil]
       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
       # URL to which the Connect Webview should redirect when an unexpected error occurs.
+      # @return [String, nil]
       attr_accessor :custom_redirect_failure_url
       # URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.
+      # @return [String, nil]
       attr_accessor :custom_redirect_url
       # The customer key associated with this webview, if any.
+      # @return [String, nil]
       attr_accessor :customer_key
       # Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.
+      # @return [String]
       attr_accessor :device_selection_mode
       # Indicates whether the user logged in successfully using the Connect Webview.
+      # @return [Boolean]
       attr_accessor :login_successful
       # Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
+      # @return [String, nil]
       attr_accessor :selected_provider
       # Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.
+      # @return [String]
       attr_accessor :status
       # URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.
+      # @return [String]
       attr_accessor :url
       # Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.
+      # @return [Boolean]
       attr_accessor :wait_for_device_creation
       # ID of the workspace that contains the Connect Webview.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the user authorized (through the Connect Webview) the management of their devices.
+      # @return [Time, nil]
       date_accessor :authorized_at
 
       # Date and time at which the Connect Webview was created.
+      # @return [Time]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/connected_account.rb

@@ -8,41 +8,59 @@ module Seam
         class SaltoKsMetadata < BaseResource
           class Sites < BaseResource
             # ID of a Salto site associated with the connected account that has an error.
+            # @return [String, nil]
             attr_accessor :site_id
             # Name of a Salto site associated with the connected account that has an error.
+            # @return [String, nil]
             attr_accessor :site_name
             # Subscription limit of site users for a Salto site associated with the connected account that has an error.
+            # @return [Integer, nil]
             attr_accessor :site_user_subscription_limit
             # Count of subscribed site users for a Salto site associated with the connected account that has an error.
+            # @return [Integer, nil]
             attr_accessor :subscribed_site_user_count
           end
 
+          # Salto sites associated with the connected account that has an error.
+          # @return [Array<Sites>]
           resource_list_accessor :sites, Sites
         end
 
+        # Salto KS metadata associated with the connected account that has an error.
+        # @return [SaltoKsMetadata]
         resource_accessor :salto_ks_metadata, SaltoKsMetadata
         # 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
         # Indicates whether the error is related specifically to the connected account.
+        # @return [Boolean, nil]
         attr_accessor :is_connected_account_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 UserIdentifier < BaseResource
         # API URL for the user identifier associated with the connected account.
+        # @return [String, nil]
         attr_accessor :api_url
         # Email address of the user identifier associated with the connected account.
+        # @return [String, nil]
         attr_accessor :email
         # Indicates whether the user identifier associated with the connected account is exclusive.
+        # @return [Boolean, nil]
         attr_accessor :exclusive
         # Phone number of the user identifier associated with the connected account.
+        # @return [String, nil]
         attr_accessor :phone
         # Username of the user identifier associated with the connected account.
+        # @return [String, nil]
         attr_accessor :username
       end
 
@@ -50,60 +68,92 @@ module Seam
         class SaltoKsMetadata < BaseResource
           class Sites < BaseResource
             # ID of a Salto site associated with the connected account that has a warning.
+            # @return [String, nil]
             attr_accessor :site_id
             # Name of a Salto site associated with the connected account that has a warning.
+            # @return [String, nil]
             attr_accessor :site_name
             # Subscription limit of site users for a Salto site associated with the connected account that has a warning.
+            # @return [Integer, nil]
             attr_accessor :site_user_subscription_limit
             # Count of subscribed site users for a Salto site associated with the connected account that has a warning.
+            # @return [Integer, nil]
             attr_accessor :subscribed_site_user_count
           end
 
+          # Salto sites associated with the connected account that has a warning.
+          # @return [Array<Sites>]
           resource_list_accessor :sites, Sites
         end
 
+        # Salto KS metadata associated with the connected account that has a warning.
+        # @return [SaltoKsMetadata]
         resource_accessor :salto_ks_metadata, SaltoKsMetadata
         # 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
 
+      # User identifier associated with the connected account.
+      # @return [UserIdentifier, nil]
       resource_accessor :user_identifier, UserIdentifier
+      # Errors associated with the connected account.
+      # @return [Array<Errors>]
       resource_list_accessor :errors, Errors
+      # Warnings associated with the connected account.
+      # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # List of capabilities that were accepted during the account connection process.
+      # @return [Array<String>]
       attr_accessor :accepted_capabilities
       # Type of connected account.
+      # @return [String, nil]
       attr_accessor :account_type
       # Display name for the connected account type.
+      # @return [String]
       attr_accessor :account_type_display_name
       # Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.
+      # @return [Boolean]
       attr_accessor :automatically_manage_new_devices
       # ID of the connected account.
+      # @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
       # Your unique key for the customer associated with this connected account.
+      # @return [String, nil]
       attr_accessor :customer_key
       # Default reservation check-in time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration — set during the connect_webview for providers like Lodgify whose API does not expose check-in times.
+      # @return [String, nil]
       attr_accessor :default_checkin_time
       # Default reservation check-out time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration.
+      # @return [String, nil]
       attr_accessor :default_checkout_time
       # Display name for the connected account.
+      # @return [String]
       attr_accessor :display_name
       # For iCal connected accounts, the platform that produced the feed (for example, `airbnb`, `vrbo`, or `booking`), or `unknown` when it could not be determined. Intended for rendering the source platform's logo.
+      # @return [String, nil]
       attr_accessor :ical_feed_origin
       # For iCal connected accounts, the feed URL for the connection. Sourced from the connector configuration.
+      # @return [String, nil]
       attr_accessor :ical_url
       # Logo URL for the connected account provider.
+      # @return [String, nil]
       attr_accessor :image_url
       # IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.
+      # @return [String, nil]
       attr_accessor :time_zone
 
       # Date and time at which the connected account was created.
+      # @return [Time, nil]
       date_accessor :created_at
     end
   end

data/lib/seam/resources/customer_portal.rb

@@ -9,16 +9,21 @@ module Seam
     # Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.
     class CustomerPortal < BaseResource
       # Customer key for the customer portal.
+      # @return [String]
       attr_accessor :customer_key
       # URL for the customer portal.
+      # @return [String]
       attr_accessor :url
       # ID of the workspace associated with the customer portal.
+      # @return [String]
       attr_accessor :workspace_id
 
       # Date and time at which the customer portal link was created.
+      # @return [Time]
       date_accessor :created_at
 
       # Date and time at which the customer portal link expires.
+      # @return [Time]
       date_accessor :expires_at
     end
   end