seam 2.142.0 → 2.145.0

data/lib/seam/resources/connect_webview.rb

@@ -16,6 +16,12 @@ module Seam
     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>]
+      # Known values:
+      # - `lock`
+      # - `thermostat`
+      # - `noise_sensor`
+      # - `access_control`
+      # - `camera`
       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>]
@@ -33,7 +39,7 @@ module Seam
       # @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]
+      # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # URL to which the Connect Webview should redirect when an unexpected error occurs.
       # @return [String, nil]
@@ -46,6 +52,10 @@ module Seam
       attr_accessor :customer_key
       # Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.
       # @return [String]
+      # Known values:
+      # - `none`
+      # - `single`
+      # - `multiple`
       attr_accessor :device_selection_mode
       # Indicates whether the user logged in successfully using the Connect Webview.
       # @return [Boolean]
@@ -55,6 +65,10 @@ module Seam
       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]
+      # Known values:
+      # - `pending`
+      # - `failed`
+      # - `authorized`
       attr_accessor :status
       # URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.
       # @return [String]

data/lib/seam/resources/connected_account.rb

@@ -4,33 +4,123 @@ module Seam
   module Resources
     # 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.
     class ConnectedAccount < BaseResource
+      # Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
       class Errors < BaseResource
-        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
+        # Indicates that the account is disconnected.
+        class AccountDisconnected < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `account_disconnected`
+          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
+
+        # Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
+        class BridgeDisconnected < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `bridge_disconnected`
+          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
+
+        # Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
+        class SaltoKsSubscriptionLimitExceeded < Errors
+          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 sites associated with the connected account that has an error.
-          # @return [Array<Sites>]
-          resource_list_accessor :sites, Sites
+          # 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]
+          # Known values:
+          # - `salto_ks_subscription_limit_exceeded`
+          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
+
+        # Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.
+        class DormakabaSitesDisconnected < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `dormakaba_sites_disconnected`
+          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
 
-        # 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]
+        # Known values:
+        # - `account_disconnected`
+        # - `bridge_disconnected`
+        # - `salto_ks_subscription_limit_exceeded`
+        # - `dormakaba_sites_disconnected`
         attr_accessor :error_code
         # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
         # @return [Boolean, nil]
@@ -44,6 +134,13 @@ module Seam
         # Date and time at which Seam created the error.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :error_code, {
+          "account_disconnected" => AccountDisconnected,
+          "bridge_disconnected" => BridgeDisconnected,
+          "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
+          "dormakaba_sites_disconnected" => DormakabaSitesDisconnected
+        }.freeze
       end
 
       class UserIdentifier < BaseResource
@@ -64,40 +161,181 @@ module Seam
         attr_accessor :username
       end
 
+      # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility.
       class Warnings < BaseResource
-        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
+        # Indicates that scheduled downtime is planned for the connected account.
+        class ScheduledMaintenanceWindow < Warnings
+          # 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]
+          # Known values:
+          # - `scheduled_maintenance_window`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.
+        class UnknownIssueWithConnectedAccount < Warnings
+          # 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]
+          # Known values:
+          # - `unknown_issue_with_connected_account`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
+        class SaltoKsSubscriptionLimitAlmostReached < Warnings
+          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 sites associated with the connected account that has a warning.
-          # @return [Array<Sites>]
-          resource_list_accessor :sites, Sites
+          # 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]
+          # Known values:
+          # - `salto_ks_subscription_limit_almost_reached`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
+        class AccountReauthorizationRequested < Warnings
+          # 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]
+          # Known values:
+          # - `account_reauthorization_requested`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam.
+        class BeingDeleted < Warnings
+          # 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]
+          # Known values:
+          # - `being_deleted`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.
+        class ProviderServiceUnavailable < Warnings
+          # 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]
+          # Known values:
+          # - `provider_service_unavailable`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that the connected account requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup.
+        class SetupRequired < Warnings
+          # 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]
+          # Known values:
+          # - `setup_required`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
+        # Indicates that one or more dormakaba sites associated with the connected account are not approved. Contact support@getseam.com to finish setting up your account.
+        class DormakabaSitesUnapproved < Warnings
+          # 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]
+          # Known values:
+          # - `dormakaba_sites_unapproved`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
         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]
+        # Known values:
+        # - `scheduled_maintenance_window`
+        # - `unknown_issue_with_connected_account`
+        # - `salto_ks_subscription_limit_almost_reached`
+        # - `account_reauthorization_requested`
+        # - `being_deleted`
+        # - `provider_service_unavailable`
+        # - `setup_required`
+        # - `dormakaba_sites_unapproved`
         attr_accessor :warning_code
         # Date and time at which Seam created the warning.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :warning_code, {
+          "scheduled_maintenance_window" => ScheduledMaintenanceWindow,
+          "unknown_issue_with_connected_account" => UnknownIssueWithConnectedAccount,
+          "salto_ks_subscription_limit_almost_reached" => SaltoKsSubscriptionLimitAlmostReached,
+          "account_reauthorization_requested" => AccountReauthorizationRequested,
+          "being_deleted" => BeingDeleted,
+          "provider_service_unavailable" => ProviderServiceUnavailable,
+          "setup_required" => SetupRequired,
+          "dormakaba_sites_unapproved" => DormakabaSitesUnapproved
+        }.freeze
       end
 
       # User identifier associated with the connected account.
@@ -111,6 +349,12 @@ module Seam
       resource_list_accessor :warnings, Warnings
       # List of capabilities that were accepted during the account connection process.
       # @return [Array<String>]
+      # Known values:
+      # - `lock`
+      # - `thermostat`
+      # - `noise_sensor`
+      # - `access_control`
+      # - `camera`
       attr_accessor :accepted_capabilities
       # Type of connected account.
       # @return [String, nil]
@@ -125,7 +369,7 @@ module Seam
       # @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]
+      # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # Your unique key for the customer associated with this connected account.
       # @return [String, nil]