seam 2.132.0 → 2.133.0

data/lib/seam/resources/batch.rb

@@ -2,8 +2,133 @@
 
 module Seam
   module Resources
+    # A batch of workspace resources.
     class Batch < BaseResource
-      attr_accessor :access_codes, :access_grants, :access_methods, :acs_access_groups, :acs_credentials, :acs_encoders, :acs_entrances, :acs_systems, :acs_users, :action_attempts, :client_sessions, :connect_webviews, :connected_accounts, :devices, :events, :instant_keys, :noise_thresholds, :spaces, :thermostat_daily_programs, :thermostat_schedules, :unmanaged_access_codes, :unmanaged_devices, :user_identities, :workspaces
+      # Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+      #
+      # An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
+      #
+      # Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
+      #
+      # In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
+      #
+      # For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
+      attr_accessor :access_codes
+      # Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
+      attr_accessor :access_grants
+      # Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
+      attr_accessor :access_methods
+      # Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+      #
+      # Some access control systems use [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
+      #
+      # To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
+      attr_accessor :acs_access_groups
+      # Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      #
+      # An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
+      #
+      # For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
+      #
+      # For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.
+      attr_accessor :acs_credentials
+      # Represents a hardware device that encodes [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      #
+      # Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
+      #
+      # 1. Credential creation
+      #    Configure the access parameters for the credential.
+      # 2. Card encoding
+      #    Write the credential data onto the card using a compatible card encoder.
+      #
+      # Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
+      #
+      # See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      #
+      # To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
+      attr_accessor :acs_encoders
+      # Represents an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      #
+      # In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
+      attr_accessor :acs_entrances
+      # Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+      #
+      # Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users/object) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials/object) to grant access to the `acs_user`s.
+      #
+      # For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs).
+      attr_accessor :acs_systems
+      # Represents a [user](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access system](https://docs.seam.co/low-level-apis/access-systems).
+      #
+      # An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
+      #
+      # For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
+      attr_accessor :acs_users
+      # Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
+      #
+      # When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
+      #
+      # See also [Action Attempts](https://docs.seam.co/core-concepts/action-attempts).
+      attr_accessor :action_attempts
+      # Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
+      #
+      # You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
+      #
+      # When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
+      #
+      # A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
+      #
+      # See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
+      attr_accessor :client_sessions
+      # Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+      #
+      # Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
+      #
+      # Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
+      #
+      # To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
+      #
+      # When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
+      #
+      # To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.
+      attr_accessor :connect_webviews
+      # Represents a [connected account](https://docs.seam.co/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
+      attr_accessor :connected_accounts
+      # Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.
+      attr_accessor :devices
+      # Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.
+      #
+      # As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
+      attr_accessor :events
+      # Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.
+      #
+      # There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.
+      attr_accessor :instant_keys
+      # Represents a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
+      attr_accessor :noise_thresholds
+      # Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.
+      attr_accessor :spaces
+      # Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
+      attr_accessor :thermostat_daily_programs
+      # Represents a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
+      attr_accessor :thermostat_schedules
+      # Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+      #
+      # An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
+      #
+      # When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
+      #
+      # Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
+      #
+      # Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
+      #
+      # - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks)
+      attr_accessor :unmanaged_access_codes
+      # Represents an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+      attr_accessor :unmanaged_devices
+      # Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
+      attr_accessor :user_identities
+      # Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces).
+      attr_accessor :workspaces
     end
   end
 end

data/lib/seam/resources/client_session.rb

@@ -2,10 +2,43 @@
 
 module Seam
   module Resources
+    # Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
+    #
+    # You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
+    #
+    # When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
+    #
+    # A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
+    #
+    # See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
     class ClientSession < BaseResource
-      attr_accessor :client_session_id, :connect_webview_ids, :connected_account_ids, :customer_key, :device_count, :token, :user_identifier_key, :user_identity_id, :user_identity_ids, :workspace_id
+      # ID of the client session.
+      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).
+      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).
+      attr_accessor :connected_account_ids
+      # Customer key associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      attr_accessor :customer_key
+      # Number of devices associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      attr_accessor :device_count
+      # Client session token associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      attr_accessor :token
+      # Your user ID for the user associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      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.
+      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.
+      # @deprecated Use `user_identity_id` instead.
+      attr_accessor :user_identity_ids
+      # ID of the workspace associated with the client session.
+      attr_accessor :workspace_id
 
-      date_accessor :created_at, :expires_at
+      # Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created.
+      date_accessor :created_at
+
+      # Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) expires.
+      date_accessor :expires_at
     end
   end
 end

data/lib/seam/resources/connect_webview.rb

@@ -2,10 +2,58 @@
 
 module Seam
   module Resources
+    # Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+    #
+    # Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
+    #
+    # Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
+    #
+    # To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
+    #
+    # When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
+    #
+    # To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.
     class ConnectWebview < BaseResource
-      attr_accessor :accepted_capabilities, :accepted_providers, :any_provider_allowed, :automatically_manage_new_devices, :connect_webview_id, :connected_account_id, :custom_metadata, :custom_redirect_failure_url, :custom_redirect_url, :customer_key, :device_selection_mode, :login_successful, :selected_provider, :status, :url, :wait_for_device_creation, :workspace_id
+      # 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`.
+      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).
+      attr_accessor :accepted_providers
+      # Indicates whether any provider is allowed.
+      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.
+      attr_accessor :automatically_manage_new_devices
+      # ID of the Connect Webview.
+      attr_accessor :connect_webview_id
+      # ID of the connected account associated with the Connect Webview.
+      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.
+      attr_accessor :custom_metadata
+      # URL to which the Connect Webview should redirect when an unexpected error occurs.
+      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.
+      attr_accessor :custom_redirect_url
+      # The customer key associated with this webview, if any.
+      attr_accessor :customer_key
+      # Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.
+      attr_accessor :device_selection_mode
+      # Indicates whether the user logged in successfully using the Connect Webview.
+      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).
+      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.
+      attr_accessor :status
+      # URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.
+      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.
+      attr_accessor :wait_for_device_creation
+      # ID of the workspace that contains the Connect Webview.
+      attr_accessor :workspace_id
 
-      date_accessor :authorized_at, :created_at
+      # Date and time at which the user authorized (through the Connect Webview) the management of their devices.
+      date_accessor :authorized_at
+
+      # Date and time at which the Connect Webview was created.
+      date_accessor :created_at
     end
   end
 end

data/lib/seam/resources/connected_account.rb

@@ -2,9 +2,41 @@
 
 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
-      attr_accessor :accepted_capabilities, :account_type, :account_type_display_name, :automatically_manage_new_devices, :connected_account_id, :custom_metadata, :customer_key, :default_checkin_time, :default_checkout_time, :display_name, :ical_feed_origin, :ical_url, :image_url, :time_zone, :user_identifier
+      # List of capabilities that were accepted during the account connection process.
+      attr_accessor :accepted_capabilities
+      # Type of connected account.
+      attr_accessor :account_type
+      # Display name for the connected account type.
+      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.
+      attr_accessor :automatically_manage_new_devices
+      # ID of the connected account.
+      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.
+      attr_accessor :custom_metadata
+      # Your unique key for the customer associated with this connected account.
+      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.
+      attr_accessor :default_checkin_time
+      # Default reservation check-out time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration.
+      attr_accessor :default_checkout_time
+      # Display name for the connected account.
+      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.
+      attr_accessor :ical_feed_origin
+      # For iCal connected accounts, the feed URL for the connection. Sourced from the connector configuration.
+      attr_accessor :ical_url
+      # Logo URL for the connected account provider.
+      attr_accessor :image_url
+      # IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.
+      attr_accessor :time_zone
+      # User identifier associated with the connected account.
+      # @deprecated Use `display_name` instead.
+      attr_accessor :user_identifier
 
+      # Date and time at which the connected account was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/customer_portal.rb

@@ -2,10 +2,24 @@
 
 module Seam
   module Resources
+    # Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
+    #
+    # With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
+    #
+    # Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.
     class CustomerPortal < BaseResource
-      attr_accessor :customer_key, :url, :workspace_id
+      # Customer key for the customer portal.
+      attr_accessor :customer_key
+      # URL for the customer portal.
+      attr_accessor :url
+      # ID of the workspace associated with the customer portal.
+      attr_accessor :workspace_id
 
-      date_accessor :created_at, :expires_at
+      # Date and time at which the customer portal link was created.
+      date_accessor :created_at
+
+      # Date and time at which the customer portal link expires.
+      date_accessor :expires_at
     end
   end
 end

data/lib/seam/resources/device.rb

@@ -2,9 +2,78 @@
 
 module Seam
   module Resources
+    # Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam.
     class Device < BaseResource
-      attr_accessor :can_configure_auto_lock, :can_hvac_cool, :can_hvac_heat, :can_hvac_heat_cool, :can_program_offline_access_codes, :can_program_online_access_codes, :can_program_thermostat_programs_as_different_each_day, :can_program_thermostat_programs_as_same_each_day, :can_program_thermostat_programs_as_weekday_weekend, :can_remotely_lock, :can_remotely_unlock, :can_run_thermostat_programs, :can_simulate_connection, :can_simulate_disconnection, :can_simulate_hub_connection, :can_simulate_hub_disconnection, :can_simulate_paid_subscription, :can_simulate_removal, :can_turn_off_hvac, :can_unlock_with_code, :capabilities_supported, :connected_account_id, :custom_metadata, :device_id, :device_manufacturer, :device_provider, :device_type, :display_name, :is_managed, :location, :nickname, :properties, :space_ids, :workspace_id
+      # Indicates whether the lock supports configuring automatic locking.
+      attr_accessor :can_configure_auto_lock
+      # Indicates whether the thermostat supports cooling.
+      attr_accessor :can_hvac_cool
+      # Indicates whether the thermostat supports heating.
+      attr_accessor :can_hvac_heat
+      # Indicates whether the thermostat supports simultaneous heating and cooling.
+      attr_accessor :can_hvac_heat_cool
+      # Indicates whether the device supports programming offline access codes.
+      attr_accessor :can_program_offline_access_codes
+      # Indicates whether the device supports programming online access codes.
+      attr_accessor :can_program_online_access_codes
+      # Indicates whether the thermostat supports different climate programs for each day of the week.
+      attr_accessor :can_program_thermostat_programs_as_different_each_day
+      # Indicates whether the thermostat supports a single climate program applied to every day.
+      attr_accessor :can_program_thermostat_programs_as_same_each_day
+      # Indicates whether the thermostat supports weekday/weekend climate programs.
+      attr_accessor :can_program_thermostat_programs_as_weekday_weekend
+      # Indicates whether the device supports remote locking.
+      attr_accessor :can_remotely_lock
+      # Indicates whether the device supports remote unlocking.
+      attr_accessor :can_remotely_unlock
+      # Indicates whether the thermostat supports running climate programs.
+      attr_accessor :can_run_thermostat_programs
+      # Indicates whether the device supports simulating connection in a sandbox.
+      attr_accessor :can_simulate_connection
+      # Indicates whether the device supports simulating disconnection in a sandbox.
+      attr_accessor :can_simulate_disconnection
+      # Indicates whether the hub supports simulating connection in a sandbox.
+      attr_accessor :can_simulate_hub_connection
+      # Indicates whether the hub supports simulating disconnection in a sandbox.
+      attr_accessor :can_simulate_hub_disconnection
+      # Indicates whether the device supports simulating a paid subscription in a sandbox.
+      attr_accessor :can_simulate_paid_subscription
+      # Indicates whether the device supports simulating removal in a sandbox.
+      attr_accessor :can_simulate_removal
+      # Indicates whether the thermostat can be turned off.
+      attr_accessor :can_turn_off_hvac
+      # Indicates whether the lock supports unlocking with an access code.
+      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).
+      attr_accessor :capabilities_supported
+      # Unique identifier for the account associated with the device.
+      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.
+      attr_accessor :custom_metadata
+      # ID of the device.
+      attr_accessor :device_id
+      # Manufacturer of the device. Represents the hardware brand, which may differ from the provider.
+      attr_accessor :device_manufacturer
+      # Provider of the device. Represents the third-party service through which the device is controlled.
+      attr_accessor :device_provider
+      # Type of the device.
+      attr_accessor :device_type
+      # Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
+      attr_accessor :display_name
+      # Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+      attr_accessor :is_managed
+      # Location information for the device.
+      attr_accessor :location
+      # Optional nickname to describe the device, settable through Seam.
+      attr_accessor :nickname
+      # Properties of the device.
+      attr_accessor :properties
+      # IDs of the spaces the device is in.
+      attr_accessor :space_ids
+      # Unique identifier for the Seam workspace associated with the device.
+      attr_accessor :workspace_id
 
+      # Date and time at which the device object was created.
       date_accessor :created_at
 
       include Seam::Resources::ResourceErrorsSupport

data/lib/seam/resources/device_provider.rb

@@ -3,7 +3,54 @@
 module Seam
   module Resources
     class DeviceProvider < BaseResource
-      attr_accessor :can_configure_auto_lock, :can_hvac_cool, :can_hvac_heat, :can_hvac_heat_cool, :can_program_offline_access_codes, :can_program_online_access_codes, :can_program_thermostat_programs_as_different_each_day, :can_program_thermostat_programs_as_same_each_day, :can_program_thermostat_programs_as_weekday_weekend, :can_remotely_lock, :can_remotely_unlock, :can_run_thermostat_programs, :can_simulate_connection, :can_simulate_disconnection, :can_simulate_hub_connection, :can_simulate_hub_disconnection, :can_simulate_paid_subscription, :can_simulate_removal, :can_turn_off_hvac, :can_unlock_with_code, :device_provider_name, :display_name, :image_url, :provider_categories
+      # Indicates whether the lock supports configuring automatic locking.
+      attr_accessor :can_configure_auto_lock
+      # Indicates whether the thermostat supports cooling.
+      attr_accessor :can_hvac_cool
+      # Indicates whether the thermostat supports heating.
+      attr_accessor :can_hvac_heat
+      # Indicates whether the thermostat supports simultaneous heating and cooling.
+      attr_accessor :can_hvac_heat_cool
+      # Indicates whether the device supports programming offline access codes.
+      attr_accessor :can_program_offline_access_codes
+      # Indicates whether the device supports programming online access codes.
+      attr_accessor :can_program_online_access_codes
+      # Indicates whether the thermostat supports different climate programs for each day of the week.
+      attr_accessor :can_program_thermostat_programs_as_different_each_day
+      # Indicates whether the thermostat supports a single climate program applied to every day.
+      attr_accessor :can_program_thermostat_programs_as_same_each_day
+      # Indicates whether the thermostat supports weekday/weekend climate programs.
+      attr_accessor :can_program_thermostat_programs_as_weekday_weekend
+      # Indicates whether the device supports remote locking.
+      attr_accessor :can_remotely_lock
+      # Indicates whether the device supports remote unlocking.
+      attr_accessor :can_remotely_unlock
+      # Indicates whether the thermostat supports running climate programs.
+      attr_accessor :can_run_thermostat_programs
+      # Indicates whether the device supports simulating connection in a sandbox.
+      attr_accessor :can_simulate_connection
+      # Indicates whether the device supports simulating disconnection in a sandbox.
+      attr_accessor :can_simulate_disconnection
+      # Indicates whether the hub supports simulating connection in a sandbox.
+      attr_accessor :can_simulate_hub_connection
+      # Indicates whether the hub supports simulating disconnection in a sandbox.
+      attr_accessor :can_simulate_hub_disconnection
+      # Indicates whether the device supports simulating a paid subscription in a sandbox.
+      attr_accessor :can_simulate_paid_subscription
+      # Indicates whether the device supports simulating removal in a sandbox.
+      attr_accessor :can_simulate_removal
+      # Indicates whether the thermostat can be turned off.
+      attr_accessor :can_turn_off_hvac
+      # Indicates whether the lock supports unlocking with an access code.
+      attr_accessor :can_unlock_with_code
+      # Name of the device provider.
+      attr_accessor :device_provider_name
+      # Display name for the device provider.
+      attr_accessor :display_name
+      # Image URL for the device provider.
+      attr_accessor :image_url
+      # List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.
+      attr_accessor :provider_categories
     end
   end
 end