seam 2.132.0 → 2.133.0

data/lib/seam/routes/thermostats_schedules.rb

@@ -8,30 +8,58 @@ module Seam
         @defaults = defaults
       end
 
+      # Creates a new [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param climate_preset_key Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule.
+      # @param device_id ID of the thermostat device for which you want to create a schedule.
+      # @param ends_at Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param starts_at Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param is_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+      # @param max_override_period_minutes Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+      # @param name Name of the thermostat schedule.
+      # @return [Seam::Resources::ThermostatSchedule] OK
       def create(climate_preset_key:, device_id:, ends_at:, starts_at:, is_override_allowed: nil, max_override_period_minutes: nil, name: nil)
         res = @client.post("/thermostats/schedules/create", {climate_preset_key: climate_preset_key, device_id: device_id, ends_at: ends_at, starts_at: starts_at, is_override_allowed: is_override_allowed, max_override_period_minutes: max_override_period_minutes, name: name}.compact)
 
         Seam::Resources::ThermostatSchedule.load_from_response(res.body["thermostat_schedule"])
       end
 
+      # Deletes a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param thermostat_schedule_id ID of the thermostat schedule that you want to delete.
+      # @return [nil] OK
       def delete(thermostat_schedule_id:)
         @client.post("/thermostats/schedules/delete", {thermostat_schedule_id: thermostat_schedule_id}.compact)
 
         nil
       end
 
+      # Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+      # @param thermostat_schedule_id ID of the thermostat schedule that you want to get.
+      # @return [Seam::Resources::ThermostatSchedule] OK
       def get(thermostat_schedule_id:)
         res = @client.post("/thermostats/schedules/get", {thermostat_schedule_id: thermostat_schedule_id}.compact)
 
         Seam::Resources::ThermostatSchedule.load_from_response(res.body["thermostat_schedule"])
       end
 
+      # Returns a list of all [thermostat schedules](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param device_id ID of the thermostat device for which you want to list schedules.
+      # @param user_identifier_key User identifier key by which to filter the list of returned thermostat schedules.
+      # @return [Seam::Resources::ThermostatSchedule] OK
       def list(device_id:, user_identifier_key: nil)
         res = @client.post("/thermostats/schedules/list", {device_id: device_id, user_identifier_key: user_identifier_key}.compact)
 
         Seam::Resources::ThermostatSchedule.load_from_response(res.body["thermostat_schedules"])
       end
 
+      # Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+      # @param thermostat_schedule_id ID of the thermostat schedule that you want to update.
+      # @param climate_preset_key Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.
+      # @param ends_at Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param is_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+      # @param max_override_period_minutes Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+      # @param name Name of the thermostat schedule.
+      # @param starts_at Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @return [nil] OK
       def update(thermostat_schedule_id:, climate_preset_key: nil, ends_at: nil, is_override_allowed: nil, max_override_period_minutes: nil, name: nil, starts_at: nil)
         @client.post("/thermostats/schedules/update", {thermostat_schedule_id: thermostat_schedule_id, climate_preset_key: climate_preset_key, ends_at: ends_at, is_override_allowed: is_override_allowed, max_override_period_minutes: max_override_period_minutes, name: name, starts_at: starts_at}.compact)
 

data/lib/seam/routes/thermostats_simulate.rb

@@ -8,12 +8,25 @@ module Seam
         @defaults = defaults
       end
 
+      # Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+      # @param device_id ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.
+      # @param hvac_mode HVAC mode that you want to simulate.
+      # @param cooling_set_point_celsius Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.
+      # @param cooling_set_point_fahrenheit Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.
+      # @param heating_set_point_celsius Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.
+      # @param heating_set_point_fahrenheit Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.
+      # @return [nil] OK
       def hvac_mode_adjusted(device_id:, hvac_mode:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil)
         @client.post("/thermostats/simulate/hvac_mode_adjusted", {device_id: device_id, hvac_mode: hvac_mode, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit}.compact)
 
         nil
       end
 
+      # Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+      # @param device_id ID of the thermostat device that you want to simulate reaching a specified temperature.
+      # @param temperature_celsius Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.
+      # @param temperature_fahrenheit Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.
+      # @return [nil] OK
       def temperature_reached(device_id:, temperature_celsius: nil, temperature_fahrenheit: nil)
         @client.post("/thermostats/simulate/temperature_reached", {device_id: device_id, temperature_celsius: temperature_celsius, temperature_fahrenheit: temperature_fahrenheit}.compact)
 

data/lib/seam/routes/user_identities.rb

@@ -12,84 +12,151 @@ module Seam
         @unmanaged ||= Seam::Clients::UserIdentitiesUnmanaged.new(client: @client, defaults: @defaults)
       end
 
+      # Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      #
+      # You must specify either `user_identity_id` or `user_identity_key` to identify the user identity.
+      #
+      # If `user_identity_key` is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.
+      # @param acs_user_id ID of the access system user that you want to add to the user identity.
+      # @param user_identity_id ID of the user identity to which you want to add an access system user.
+      # @param user_identity_key Key of the user identity to which you want to add an access system user.
+      # @return [nil] OK
       def add_acs_user(acs_user_id:, user_identity_id: nil, user_identity_key: nil)
         @client.post("/user_identities/add_acs_user", {acs_user_id: acs_user_id, user_identity_id: user_identity_id, user_identity_key: user_identity_key}.compact)
 
         nil
       end
 
+      # Creates a new [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param acs_system_ids List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.
+      # @param email_address Unique email address for the new user identity.
+      # @param full_name Full name of the user associated with the new user identity.
+      # @param phone_number Unique phone number for the new user identity in E.164 format (for example, +15555550100).
+      # @param user_identity_key Unique key for the new user identity.
+      # @return [Seam::Resources::UserIdentity] OK
       def create(acs_system_ids: nil, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil)
         res = @client.post("/user_identities/create", {acs_system_ids: acs_system_ids, email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_key: user_identity_key}.compact)
 
         Seam::Resources::UserIdentity.load_from_response(res.body["user_identity"])
       end
 
+      # Deletes a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/api/acs/credentials), [acs users](https://docs.seam.co/api/acs/users) and [client sessions](https://docs.seam.co/api/client_sessions).
+      # @param user_identity_id ID of the user identity that you want to delete.
+      # @return [nil] OK
       def delete(user_identity_id:)
         @client.post("/user_identities/delete", {user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Generates a new [instant key](https://docs.seam.co/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param user_identity_id ID of the user identity for which you want to generate an instant key.
+      # @param customization_profile_id
+      # @param max_use_count Maximum number of times the instant key can be used. Default: 1.
+      # @return [Seam::Resources::InstantKey] OK
       def generate_instant_key(user_identity_id:, customization_profile_id: nil, max_use_count: nil)
         res = @client.post("/user_identities/generate_instant_key", {user_identity_id: user_identity_id, customization_profile_id: customization_profile_id, max_use_count: max_use_count}.compact)
 
         Seam::Resources::InstantKey.load_from_response(res.body["instant_key"])
       end
 
+      # Returns a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param user_identity_id ID of the user identity that you want to get.
+      # @param user_identity_key
+      # @return [Seam::Resources::UserIdentity] OK
       def get(user_identity_id: nil, user_identity_key: nil)
         res = @client.post("/user_identities/get", {user_identity_id: user_identity_id, user_identity_key: user_identity_key}.compact)
 
         Seam::Resources::UserIdentity.load_from_response(res.body["user_identity"])
       end
 
+      # Grants a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/core-concepts/devices/).
+      # @param device_id ID of the managed device to which you want to grant access to the user identity.
+      # @param user_identity_id ID of the user identity that you want to grant access to a device.
+      # @return [nil] OK
       def grant_access_to_device(device_id:, user_identity_id:)
         @client.post("/user_identities/grant_access_to_device", {device_id: device_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Returns a list of all [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param created_before Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.
+      # @param credential_manager_acs_system_id `acs_system_id` of the credential manager by which you want to filter the list of user identities.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.
+      # @param user_identity_ids Array of user identity IDs by which to filter the list of user identities.
+      # @return [Seam::Resources::UserIdentity] OK
       def list(created_before: nil, credential_manager_acs_system_id: nil, limit: nil, page_cursor: nil, search: nil, user_identity_ids: nil)
         res = @client.post("/user_identities/list", {created_before: created_before, credential_manager_acs_system_id: credential_manager_acs_system_id, limit: limit, page_cursor: page_cursor, search: search, user_identity_ids: user_identity_ids}.compact)
 
         Seam::Resources::UserIdentity.load_from_response(res.body["user_identities"])
       end
 
+      # Returns a list of all [devices](https://docs.seam.co/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.
+      # @param user_identity_id ID of the user identity for which you want to retrieve all accessible devices.
+      # @return [Seam::Resources::Device] OK
       def list_accessible_devices(user_identity_id:)
         res = @client.post("/user_identities/list_accessible_devices", {user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::Device.load_from_response(res.body["devices"])
       end
 
+      # Returns a list of all [ACS entrances](https://docs.seam.co/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.
+      # @param user_identity_id ID of the user identity for which you want to retrieve all accessible entrances.
+      # @return [Seam::Resources::AcsEntrance] OK
       def list_accessible_entrances(user_identity_id:)
         res = @client.post("/user_identities/list_accessible_entrances", {user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
       end
 
+      # Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param user_identity_id ID of the user identity for which you want to retrieve all access systems.
+      # @return [Seam::Resources::AcsSystem] OK
       def list_acs_systems(user_identity_id:)
         res = @client.post("/user_identities/list_acs_systems", {user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsSystem.load_from_response(res.body["acs_systems"])
       end
 
+      # Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param user_identity_id ID of the user identity for which you want to retrieve all access system users.
+      # @return [Seam::Resources::AcsUser] OK
       def list_acs_users(user_identity_id:)
         res = @client.post("/user_identities/list_acs_users", {user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
       end
 
+      # Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param acs_user_id ID of the access system user that you want to remove from the user identity..
+      # @param user_identity_id ID of the user identity from which you want to remove an access system user.
+      # @return [nil] OK
       def remove_acs_user(acs_user_id:, user_identity_id:)
         @client.post("/user_identities/remove_acs_user", {acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Revokes access to a specified [device](https://docs.seam.co/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param device_id ID of the managed device to which you want to revoke access from the user identity.
+      # @param user_identity_id ID of the user identity from which you want to revoke access to a device.
+      # @return [nil] OK
       def revoke_access_to_device(device_id:, user_identity_id:)
         @client.post("/user_identities/revoke_access_to_device", {device_id: device_id, user_identity_id: user_identity_id}.compact)
 
         nil
       end
 
+      # Updates a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
+      # @param user_identity_id ID of the user identity that you want to update.
+      # @param email_address Unique email address for the user identity.
+      # @param full_name Full name of the user associated with the user identity.
+      # @param phone_number Unique phone number for the user identity.
+      # @param user_identity_key Unique key for the user identity.
+      # @return [nil] OK
       def update(user_identity_id:, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil)
         @client.post("/user_identities/update", {user_identity_id: user_identity_id, email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_key: user_identity_key}.compact)
 

data/lib/seam/routes/user_identities_unmanaged.rb

@@ -8,18 +8,34 @@ module Seam
         @defaults = defaults
       end
 
+      # Returns a specified unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
+      # @param user_identity_id ID of the unmanaged user identity that you want to get.
+      # @return [Seam::Resources::UnmanagedUserIdentity] OK
       def get(user_identity_id:)
         res = @client.post("/user_identities/unmanaged/get", {user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::UnmanagedUserIdentity.load_from_response(res.body["user_identity"])
       end
 
+      # Returns a list of all unmanaged [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
+      # @param created_before Timestamp by which to limit returned unmanaged user identities. Returns user identities created before this timestamp.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`,  `user_identity_id` or `acs_system_id`.
+      # @return [Seam::Resources::UnmanagedUserIdentity] OK
       def list(created_before: nil, limit: nil, page_cursor: nil, search: nil)
         res = @client.post("/user_identities/unmanaged/list", {created_before: created_before, limit: limit, page_cursor: page_cursor, search: search}.compact)
 
         Seam::Resources::UnmanagedUserIdentity.load_from_response(res.body["user_identities"])
       end
 
+      # Updates an unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.
+      #
+      # This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.
+      # @param is_managed Must be set to true to convert the unmanaged user identity to managed.
+      # @param user_identity_id ID of the unmanaged user identity that you want to update.
+      # @param user_identity_key Unique key for the user identity. If not provided, the existing key will be preserved.
+      # @return [nil] OK
       def update(is_managed:, user_identity_id:, user_identity_key: nil)
         @client.post("/user_identities/unmanaged/update", {is_managed: is_managed, user_identity_id: user_identity_id, user_identity_key: user_identity_key}.compact)
 

data/lib/seam/routes/webhooks.rb

@@ -8,30 +8,46 @@ module Seam
         @defaults = defaults
       end
 
+      # Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks).
+      # @param url URL for the new webhook.
+      # @param event_types Types of events that you want the new webhook to receive.
+      # @return [Seam::Resources::Webhook] OK
       def create(url:, event_types: nil)
         res = @client.post("/webhooks/create", {url: url, event_types: event_types}.compact)
 
         Seam::Resources::Webhook.load_from_response(res.body["webhook"])
       end
 
+      # Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+      # @param webhook_id ID of the webhook that you want to delete.
+      # @return [nil] OK
       def delete(webhook_id:)
         @client.post("/webhooks/delete", {webhook_id: webhook_id}.compact)
 
         nil
       end
 
+      # Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+      # @param webhook_id ID of the webhook that you want to get.
+      # @return [Seam::Resources::Webhook] OK
       def get(webhook_id:)
         res = @client.post("/webhooks/get", {webhook_id: webhook_id}.compact)
 
         Seam::Resources::Webhook.load_from_response(res.body["webhook"])
       end
 
+      # Returns a list of all [webhooks](https://docs.seam.co/developer-tools/webhooks).
+      # @return [Seam::Resources::Webhook] OK
       def list
         res = @client.post("/webhooks/list")
 
         Seam::Resources::Webhook.load_from_response(res.body["webhooks"])
       end
 
+      # Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
+      # @param event_types Types of events that you want the webhook to receive.
+      # @param webhook_id ID of the webhook that you want to update.
+      # @return [nil] OK
       def update(event_types:, webhook_id:)
         @client.post("/webhooks/update", {event_types: event_types, webhook_id: webhook_id}.compact)
 

data/lib/seam/routes/workspaces.rb

@@ -10,24 +10,47 @@ module Seam
         @defaults = defaults
       end
 
+      # Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces).
+      # @param name Name of the new workspace.
+      # @param company_name Company name for the new workspace.
+      # @param connect_partner_name Connect partner name for the new workspace.
+      # @deprecated connect_partner_name: Use `company_name` instead.
+      # @param connect_webview_customization [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the new 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).
+      # @param is_sandbox Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param organization_id ID of the organization to associate with the new workspace.
+      # @param webview_logo_shape
+      # @deprecated webview_logo_shape: Use `connect_webview_customization.webview_logo_shape` instead.
+      # @param webview_primary_button_color
+      # @deprecated webview_primary_button_color: Use `connect_webview_customization.webview_primary_button_color` instead.
+      # @param webview_primary_button_text_color
+      # @deprecated webview_primary_button_text_color: Use `connect_webview_customization.webview_primary_button_text_color` instead.
+      # @param webview_success_message
+      # @deprecated webview_success_message: Use `connect_webview_customization.webview_success_message` instead.
+      # @return [Seam::Resources::Workspace] OK
       def create(name:, company_name: nil, connect_partner_name: nil, connect_webview_customization: nil, is_sandbox: nil, organization_id: nil, webview_logo_shape: nil, webview_primary_button_color: nil, webview_primary_button_text_color: nil, webview_success_message: nil)
         res = @client.post("/workspaces/create", {name: name, company_name: company_name, connect_partner_name: connect_partner_name, connect_webview_customization: connect_webview_customization, is_sandbox: is_sandbox, organization_id: organization_id, webview_logo_shape: webview_logo_shape, webview_primary_button_color: webview_primary_button_color, webview_primary_button_text_color: webview_primary_button_text_color, webview_success_message: webview_success_message}.compact)
 
         Seam::Resources::Workspace.load_from_response(res.body["workspace"])
       end
 
+      # Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+      # @return [Seam::Resources::Workspace] OK
       def get
         res = @client.post("/workspaces/get")
 
         Seam::Resources::Workspace.load_from_response(res.body["workspace"])
       end
 
+      # Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+      # @return [Seam::Resources::Workspace] OK
       def list
         res = @client.post("/workspaces/list")
 
         Seam::Resources::Workspace.load_from_response(res.body["workspaces"])
       end
 
+      # Resets the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.
+      # @return [Seam::Resources::ActionAttempt] OK
       def reset_sandbox(wait_for_action_attempt: nil)
         res = @client.post("/workspaces/reset_sandbox")
 
@@ -36,6 +59,14 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
+      # @param connect_partner_name Connect partner name for the workspace.
+      # @param connect_webview_customization [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for 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).
+      # @param is_publishable_key_auth_enabled Indicates whether publishable key authentication is enabled for this workspace.
+      # @param is_suspended Indicates whether the workspace is suspended.
+      # @param name Name of the workspace.
+      # @param organization_id ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.
+      # @return [nil] OK
       def update(connect_partner_name: nil, connect_webview_customization: nil, is_publishable_key_auth_enabled: nil, is_suspended: nil, name: nil, organization_id: nil)
         @client.post("/workspaces/update", {connect_partner_name: connect_partner_name, connect_webview_customization: connect_webview_customization, is_publishable_key_auth_enabled: is_publishable_key_auth_enabled, is_suspended: is_suspended, name: name, organization_id: organization_id}.compact)
 

data/lib/seam/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Seam
-  VERSION = "2.132.0"
+  VERSION = "2.133.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seam
 version: !ruby/object:Gem::Version
-  version: 2.132.0
+  version: 2.133.0
 platform: ruby
 authors:
 - Seam Labs, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-28 00:00:00.000000000 Z
+date: 2026-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday