From a8020cc33a70e68d5c73206d54bb189606643b13 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 16 Nov 2026 06:45:18 +0000 Subject: [PATCH 1/2] feat(deps-dev): bump the seam group with 2 updates Bumps the seam group with 2 updates: [@seamapi/blueprint](https://github.com/seamapi/blueprint) and [@seamapi/types](https://github.com/seamapi/types). Updates `@seamapi/blueprint` from 1.13.2 to 1.13.3 - [Release notes](https://github.com/seamapi/blueprint/releases) - [Commits](https://github.com/seamapi/blueprint/compare/v1.13.2...v1.13.3) Updates `@seamapi/types` from 1.1189.0 to 1.1201.0 - [Release notes](https://github.com/seamapi/types/releases) - [Commits](https://github.com/seamapi/types/compare/v1.1189.0...v1.1201.0) --- updated-dependencies: - dependency-name: "@seamapi/blueprint" dependency-version: 1.13.3 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: seam - dependency-name: "@seamapi/types" dependency-version: 1.1201.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: seam ... Signed-off-by: dependabot[bot] --- package-lock.json | 16 ++++++++-------- package.json | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7d3fb88..c6d153f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,10 +6,10 @@ "": { "name": "@seamapi/ruby", "devDependencies": { - "@seamapi/blueprint": "^1.13.2", + "@seamapi/blueprint": "^1.13.3", "@seamapi/fake-seam-connect": "2.0.8", "@seamapi/smith": "^1.2.0", - "@seamapi/types": "1.1189.0", + "@seamapi/types": "1.1201.0", "change-case": "^5.4.4", "markdown-toc": "^1.2.0", "prettier": "^3.2.5" @@ -795,9 +795,9 @@ "license": "MIT" }, "node_modules/@seamapi/blueprint": { - "version": "1.13.2", - "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-1.13.2.tgz", - "integrity": "sha512-FS8zYX01P/eCXcZDUp+dOY3b34tjDmKj6TR1gE8P7IE8Fc7Q9Sr57yUBDv+OKhPIpMifDkr6+0G+A/ej/nIDTw==", + "version": "1.13.3", + "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-1.13.3.tgz", + "integrity": "sha512-OuYxF4b8r5cEjgsfNyfAucfbaDlTwiWbXSxhh4Fjic04KhcYhiPxGc9PplNVkWLyFJTXi1yOmZJgO/koJuOK4w==", "dev": true, "license": "MIT", "dependencies": { @@ -861,9 +861,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.1189.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1189.0.tgz", - "integrity": "sha512-b4elCtQSd54yz8vtgDXw3dBXwX6RP2T+C8hkfbZ4NWGiq5VXCXE6iiNFLCXhZh4ecWY6QHD3cK9+lt+SEIkG3g==", + "version": "1.1201.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1201.0.tgz", + "integrity": "sha512-KYCgnWd8hwwrnttrtv+rE61G292g/F4EbtofDzUK8+vXXsr5oOlWV8l00E2Se9kulB6mIhTXrpJhJkcxRNz6yg==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 05528e1..8bae344 100644 --- a/package.json +++ b/package.json @@ -29,10 +29,10 @@ }, "packageManager": "npm@11.19.0", "devDependencies": { - "@seamapi/blueprint": "^1.13.2", + "@seamapi/blueprint": "^1.13.3", "@seamapi/fake-seam-connect": "2.0.8", "@seamapi/smith": "^1.2.0", - "@seamapi/types": "1.1189.0", + "@seamapi/types": "1.1201.0", "change-case": "^5.4.4", "markdown-toc": "^1.2.0", "prettier": "^3.2.5" From 23723d8143ce690613c119522fc94e7c5acfbda7 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 16 Nov 2026 06:46:05 +0000 Subject: [PATCH 2/2] ci: Generate code --- lib/seam/resources/access_grant.rb | 3 - lib/seam/resources/acs_access_group.rb | 17 - lib/seam/resources/acs_system.rb | 48 +-- lib/seam/resources/acs_user.rb | 3 - lib/seam/resources/client_session.rb | 4 - lib/seam/resources/connect_webview.rb | 1 + lib/seam/resources/connected_account.rb | 22 +- lib/seam/resources/device.rb | 326 ++++++------------- lib/seam/resources/device_provider.rb | 3 + lib/seam/resources/event.rb | 45 +-- lib/seam/resources/phone.rb | 34 ++ lib/seam/resources/unmanaged_access_grant.rb | 3 - lib/seam/resources/unmanaged_device.rb | 60 ++-- lib/seam/resources/workspace.rb | 4 - lib/seam/routes/access_codes.rb | 6 +- lib/seam/routes/access_grants.rb | 14 +- lib/seam/routes/acs_entrances.rb | 6 +- lib/seam/routes/acs_users.rb | 16 +- lib/seam/routes/client_sessions.rb | 22 +- lib/seam/routes/customers.rb | 5 +- lib/seam/routes/devices.rb | 6 +- lib/seam/routes/spaces.rb | 5 +- lib/seam/routes/thermostats.rb | 12 +- lib/seam/routes/workspaces.rb | 14 +- 24 files changed, 236 insertions(+), 443 deletions(-) diff --git a/lib/seam/resources/access_grant.rb b/lib/seam/resources/access_grant.rb index 5b576a4..6aacea7 100644 --- a/lib/seam/resources/access_grant.rb +++ b/lib/seam/resources/access_grant.rb @@ -368,9 +368,6 @@ class AccessRevoked < Warnings # Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. # @return [String, nil] attr_accessor :instant_key_url - # @return [Array] - # @deprecated Use `space_ids`. - attr_accessor :location_ids # Name of the Access Grant. If not provided, the display name will be computed. # @return [String, nil] attr_accessor :name diff --git a/lib/seam/resources/acs_access_group.rb b/lib/seam/resources/acs_access_group.rb index 70dc843..de48877 100644 --- a/lib/seam/resources/acs_access_group.rb +++ b/lib/seam/resources/acs_access_group.rb @@ -140,23 +140,6 @@ class Warnings < BaseResource # Warnings associated with the `acs_access_group`. # @return [Array] resource_list_accessor :warnings, Warnings - # @return [String] - # Known values: - # - `pti_unit` - # - `pti_access_level` - # - `salto_ks_access_group` - # - `brivo_group` - # - `salto_space_group` - # - `dormakaba_community_access_group` - # - `dormakaba_ambiance_access_group` - # - `avigilon_alta_group` - # - `kisi_access_group` - # - `akiles_member_group` - # @deprecated Use `external_type`. - attr_accessor :access_group_type - # @return [String] - # @deprecated Use `external_type_display_name`. - attr_accessor :access_group_type_display_name # ID of the access group. # @return [String] attr_accessor :acs_access_group_id diff --git a/lib/seam/resources/acs_system.rb b/lib/seam/resources/acs_system.rb index 6a7f4eb..42b5c11 100644 --- a/lib/seam/resources/acs_system.rb +++ b/lib/seam/resources/acs_system.rb @@ -238,14 +238,26 @@ class SaltoKsSubscriptionLimitAlmostReached < Warnings date_accessor :created_at end + # Indicates that the Salto KS site does not accept custom PIN codes, either because its Salto subscription does not include the Custom PIN feature or because Custom PIN is turned off in the site's settings. Salto KS generates every PIN on the site, so a PIN code requested on an access grant or reservation is replaced with a Salto-generated one. The message says which of the two applies. + class SaltoKsCustomPinsNotSupported < 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: + # - `salto_ks_custom_pins_not_supported` + attr_accessor :warning_code + # Date and time at which Seam created the warning. + # @return [Time] + date_accessor :created_at + end + # Indicates the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). class TimeZoneDoesNotMatchLocation < Warnings # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. # @return [String] attr_accessor :message - # @return [Array] - # @deprecated this field is deprecated. - attr_accessor :misconfigured_acs_entrance_ids # Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. # @return [String] # Known values: @@ -293,6 +305,7 @@ class UnknownIssueWithAcsSystem < Warnings # @return [String] # Known values: # - `salto_ks_subscription_limit_almost_reached` + # - `salto_ks_custom_pins_not_supported` # - `time_zone_does_not_match_location` # - `setup_required` # - `unknown_issue_with_acs_system` @@ -303,6 +316,7 @@ class UnknownIssueWithAcsSystem < Warnings discriminated_by :warning_code, { "salto_ks_subscription_limit_almost_reached" => SaltoKsSubscriptionLimitAlmostReached, + "salto_ks_custom_pins_not_supported" => SaltoKsCustomPinsNotSupported, "time_zone_does_not_match_location" => TimeZoneDoesNotMatchLocation, "setup_required" => SetupRequired, "unknown_issue_with_acs_system" => UnknownIssueWithAcsSystem @@ -333,10 +347,6 @@ class UnknownIssueWithAcsSystem < Warnings # ID of the connected account associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). # @return [String] attr_accessor :connected_account_id - # IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). - # @return [Array] - # @deprecated Use `connected_account_id`. - attr_accessor :connected_account_ids # ID of the default credential manager `acs_system` for this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). # @return [String, nil] attr_accessor :default_credential_manager_acs_system_id @@ -376,30 +386,6 @@ class UnknownIssueWithAcsSystem < Warnings # Name of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). # @return [String] attr_accessor :name - # @return [String, nil] - # Known values: - # - `pti_site` - # - `avigilon_alta_org` - # - `salto_ks_site` - # - `salto_space_system` - # - `brivo_account` - # - `hid_credential_manager_organization` - # - `visionline_system` - # - `assa_abloy_credential_service` - # - `latch_building` - # - `dormakaba_community_site` - # - `dormakaba_ambiance_site` - # - `legic_connect_credential_service` - # - `assa_abloy_vostio` - # - `assa_abloy_vostio_credential_service` - # - `hotek_site` - # - `kisi_organization` - # - `akiles_organization` - # @deprecated Use `external_type`. - attr_accessor :system_type - # @return [String, nil] - # @deprecated Use `external_type_display_name`. - attr_accessor :system_type_display_name # ID of the workspace that contains the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). # @return [String] attr_accessor :workspace_id diff --git a/lib/seam/resources/acs_user.rb b/lib/seam/resources/acs_user.rb index 6d70617..9b36252 100644 --- a/lib/seam/resources/acs_user.rb +++ b/lib/seam/resources/acs_user.rb @@ -351,9 +351,6 @@ class LatchResidentUser < Warnings # Display name for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). # @return [String] attr_accessor :display_name - # @return [String, nil] - # @deprecated use email_address. - attr_accessor :email # Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). # @return [String, nil] attr_accessor :email_address diff --git a/lib/seam/resources/client_session.rb b/lib/seam/resources/client_session.rb index 2fbe3c2..66a724b 100644 --- a/lib/seam/resources/client_session.rb +++ b/lib/seam/resources/client_session.rb @@ -36,10 +36,6 @@ class ClientSession < BaseResource # ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. # @return [String, nil] attr_accessor :user_identity_id - # IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. - # @return [Array] - # @deprecated Use `user_identity_id` instead. - attr_accessor :user_identity_ids # ID of the workspace associated with the client session. # @return [String] attr_accessor :workspace_id diff --git a/lib/seam/resources/connect_webview.rb b/lib/seam/resources/connect_webview.rb index 672874e..dc08b6c 100644 --- a/lib/seam/resources/connect_webview.rb +++ b/lib/seam/resources/connect_webview.rb @@ -23,6 +23,7 @@ class ConnectWebview < BaseResource # - `access_control` # - `camera` # - `speaker` + # - `pool` attr_accessor :accepted_capabilities # List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). # @return [Array] diff --git a/lib/seam/resources/connected_account.rb b/lib/seam/resources/connected_account.rb index 5723dfc..c67c103 100644 --- a/lib/seam/resources/connected_account.rb +++ b/lib/seam/resources/connected_account.rb @@ -143,24 +143,6 @@ class DormakabaSitesDisconnected < Errors }.freeze end - class UserIdentifier < BaseResource - # API URL for the user identifier associated with the connected account. - # @return [String, nil] - attr_accessor :api_url - # Email address of the user identifier associated with the connected account. - # @return [String, nil] - attr_accessor :email - # Indicates whether the user identifier associated with the connected account is exclusive. - # @return [Boolean, nil] - attr_accessor :exclusive - # Phone number of the user identifier associated with the connected account. - # @return [String, nil] - attr_accessor :phone - # Username of the user identifier associated with the connected account. - # @return [String, nil] - attr_accessor :username - end - # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility. class Warnings < BaseResource # Indicates that scheduled downtime is planned for the connected account. @@ -338,9 +320,6 @@ class DormakabaSitesUnapproved < Warnings }.freeze end - # User identifier associated with the connected account. - # @return [UserIdentifier, nil] - resource_accessor :user_identifier, UserIdentifier # Errors associated with the connected account. # @return [Array] resource_list_accessor :errors, Errors @@ -356,6 +335,7 @@ class DormakabaSitesUnapproved < Warnings # - `access_control` # - `camera` # - `speaker` + # - `pool` attr_accessor :accepted_capabilities # Type of connected account. # @return [String, nil] diff --git a/lib/seam/resources/device.rb b/lib/seam/resources/device.rb index 9b5053d..7ace670 100644 --- a/lib/seam/resources/device.rb +++ b/lib/seam/resources/device.rb @@ -353,10 +353,6 @@ class Location < BaseResource # Time zone of the device location. # @return [String, nil] attr_accessor :time_zone - # Time zone of the device location. - # @return [String, nil] - # @deprecated Use `time_zone` instead. - attr_accessor :timezone end class NamedSensors < BaseResource @@ -372,9 +368,12 @@ class NamedSensors < BaseResource # Display name of the sensor. Defaults to `sensor_name`. # @return [String] attr_accessor :display_name - # Indicates whether the device detects that the space is occupied, if the device measures occupancy. + # Estimated number of occupants detected by the device. + # @return [Float, nil] + attr_accessor :estimated_occupant_count + # Indicates whether the device detects occupancy. # @return [Boolean, nil] - attr_accessor :is_occupied + attr_accessor :is_occupancy_detected # Indicates whether the device detects smoking, if the device measures it. # @return [Boolean, nil] attr_accessor :is_smoking_detected @@ -387,9 +386,6 @@ class NamedSensors < BaseResource # Noise level as a Noise Risk Score (NRS), if the device reports one. # @return [Float, nil] attr_accessor :noise_level_nrs - # Number of occupants the device detects, if the device counts occupants. - # @return [Float, nil] - attr_accessor :occupant_count # Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity. # @return [Float, nil] attr_accessor :relative_humidity @@ -440,9 +436,6 @@ class Battery < BaseResource end class Model < BaseResource - # @return [Boolean, nil] - # @deprecated use device.properties.model.can_connect_accessory_keypad - attr_accessor :accessory_keypad_supported # Indicates whether the device can connect a accessory keypad. # @return [Boolean, nil] attr_accessor :can_connect_accessory_keypad @@ -455,12 +448,6 @@ class Model < BaseResource # Display name that corresponds to the manufacturer-specific terminology for the device. # @return [String] attr_accessor :manufacturer_display_name - # @return [Boolean, nil] - # @deprecated use device.can_program_offline_access_codes. - attr_accessor :offline_access_codes_supported - # @return [Boolean, nil] - # @deprecated use device.can_program_online_access_codes. - attr_accessor :online_access_codes_supported end class AssaAbloyCredentialServiceMetadata < BaseResource @@ -699,10 +686,6 @@ class PredefinedTimeSlots < BaseResource # IANA time zone for a dormakaba Oracode device. # @return [String, nil] attr_accessor :iana_timezone - # Site ID for a dormakaba Oracode device. - # @return [Float, nil] - # @deprecated Previously marked as "@DEPRECATED." - attr_accessor :site_id # Site name for a dormakaba Oracode device. # @return [String, nil] attr_accessor :site_name @@ -1128,33 +1111,6 @@ class SaltoKsMetadata < BaseResource attr_accessor :site_name end - class SaltoMetadata < BaseResource - # Battery level for a Salto device. - # @return [String, nil] - attr_accessor :battery_level - # Customer reference for a Salto device. - # @return [String, nil] - attr_accessor :customer_reference - # Lock ID for a Salto device. - # @return [String, nil] - attr_accessor :lock_id - # Lock type for a Salto device. - # @return [String, nil] - attr_accessor :lock_type - # Locked state for a Salto device. - # @return [String, nil] - attr_accessor :locked_state - # Model for a Salto device. - # @return [String, nil] - attr_accessor :model - # Site ID for the Salto KS site to which the device belongs. - # @return [String, nil] - attr_accessor :site_id - # Site name for the Salto KS site to which the device belongs. - # @return [String, nil] - attr_accessor :site_name - end - class SchlageMetadata < BaseResource # Device ID for a Schlage device. # @return [String, nil] @@ -1189,14 +1145,35 @@ class SensiMetadata < BaseResource # Device name for a Sensi device. # @return [String, nil] attr_accessor :device_name - # Deprecated. Seam no longer sets this field. - # @return [Boolean, nil] - attr_accessor :dual_setpoints_not_supported # Product type for a Sensi device. # @return [String, nil] attr_accessor :product_type end + class SensiboMetadata < BaseResource + # Firmware version of the Sensibo device. + # @return [String, nil] + attr_accessor :firmware_version + # MAC address of the Sensibo device. + # @return [String, nil] + attr_accessor :mac_address + # ID of the Sensibo device, which Sensibo calls a pod. + # @return [String, nil] + attr_accessor :pod_id + # Product model of the Sensibo device, such as `skyv2` or `air`. + # @return [String, nil] + attr_accessor :product_model + # Name of the room that the Sensibo device is in. + # @return [String, nil] + attr_accessor :room_name + # Serial number of the Sensibo device. + # @return [String, nil] + attr_accessor :serial_number + # Temperature unit that the Sensibo device displays: `C` or `F`. + # @return [String, nil] + attr_accessor :temperature_unit + end + class SmartthingsMetadata < BaseResource # Device ID for a SmartThings device. # @return [String, nil] @@ -1335,6 +1312,30 @@ class WirelessKeypads < BaseResource attr_accessor :timezone_raw_offset_ms end + class TuyaMetadata < BaseResource + # Tuya product category code for the device (e.g. ms). + # @return [String, nil] + attr_accessor :category + # Device ID for a Tuya device. + # @return [String, nil] + attr_accessor :device_id + # Device name for a Tuya device. + # @return [String, nil] + attr_accessor :device_name + # Model reported for a Tuya device. + # @return [String, nil] + attr_accessor :model + # Tuya product ID for the device. + # @return [String, nil] + attr_accessor :product_id + # Tuya product name for the device. + # @return [String, nil] + attr_accessor :product_name + # Time zone reported for a Tuya device (e.g. +08:00). + # @return [String, nil] + attr_accessor :time_zone + end + class TwoNMetadata < BaseResource # Device ID for a 2N device. # @return [Float, nil] @@ -1559,54 +1560,6 @@ class TimePairs < BaseResource attr_accessor :time_zone end - class ActiveThermostatSchedule < BaseResource - class Errors < BaseResource - # Unique identifier of the type of error. Enables quick recognition and categorization of the issue. - # @return [String] - attr_accessor :error_code - # 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 - - # Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - # @return [Array] - resource_list_accessor :errors, Errors - # Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - # @return [String] - attr_accessor :climate_preset_key - # ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device. - # @return [String] - attr_accessor :device_id - # Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. - # @return [Boolean, nil] - attr_accessor :is_override_allowed - # Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - # @return [Integer, nil] - attr_accessor :max_override_period_minutes - # User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - # @return [String, nil] - attr_accessor :name - # ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - # @return [String] - attr_accessor :thermostat_schedule_id - # ID of the workspace that contains the thermostat schedule. - # @return [String] - attr_accessor :workspace_id - # Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. - # @return [Time] - date_accessor :created_at - # Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - # @return [Time] - date_accessor :ends_at - # Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - # @return [Time] - date_accessor :starts_at - end - class AvailableClimatePresets < BaseResource class EcobeeMetadata < BaseResource # Reference to the Ecobee climate, if applicable. @@ -1679,10 +1632,6 @@ class EcobeeMetadata < BaseResource # - `heat_cool` # - `eco` attr_accessor :hvac_mode_setting - # Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - # @return [Boolean] - # @deprecated Use 'thermostat_schedule.is_override_allowed' - attr_accessor :manual_override_allowed # User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). # @return [String, nil] attr_accessor :name @@ -1760,91 +1709,6 @@ class EcobeeMetadata < BaseResource # - `heat_cool` # - `eco` attr_accessor :hvac_mode_setting - # Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - # @return [Boolean, nil] - # @deprecated Use 'thermostat_schedule.is_override_allowed' - attr_accessor :manual_override_allowed - # User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). - # @return [String, nil] - attr_accessor :name - end - - class DefaultClimateSetting < BaseResource - class EcobeeMetadata < BaseResource - # Reference to the Ecobee climate, if applicable. - # @return [String, nil] - attr_accessor :climate_ref - # Indicates if the climate preset is optimized by Ecobee. - # @return [Boolean, nil] - attr_accessor :is_optimized - # Indicates whether the climate preset is owned by the user or the system. - # @return [String, nil] - # Known values: - # - `user` - # - `system` - attr_accessor :owner - end - - # Metadata specific to the Ecobee climate, if applicable. - # @return [EcobeeMetadata, nil] - resource_accessor :ecobee_metadata, EcobeeMetadata - # Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. - # @return [Boolean, nil] - attr_accessor :can_delete - # Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. - # @return [Boolean, nil] - attr_accessor :can_edit - # Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. - # @return [Boolean, nil] - attr_accessor :can_use_with_thermostat_daily_programs - # Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). - # @return [String, nil] - attr_accessor :climate_preset_key - # The climate preset mode for the thermostat, based on the available climate preset modes reported by the device. - # @return [String, nil] - # Known values: - # - `home` - # - `away` - # - `wake` - # - `sleep` - # - `occupied` - # - `unoccupied` - attr_accessor :climate_preset_mode - # Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - # @return [Float, nil] - attr_accessor :cooling_set_point_celsius - # Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - # @return [Float, nil] - attr_accessor :cooling_set_point_fahrenheit - # Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). - # @return [String, nil] - attr_accessor :display_name - # Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. - # @return [String, nil] - # Known values: - # - `auto` - # - `on` - # - `circulate` - attr_accessor :fan_mode_setting - # Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - # @return [Float, nil] - attr_accessor :heating_set_point_celsius - # Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). - # @return [Float, nil] - attr_accessor :heating_set_point_fahrenheit - # Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - # @return [String, nil] - # Known values: - # - `off` - # - `heat` - # - `cool` - # - `heat_cool` - # - `eco` - attr_accessor :hvac_mode_setting - # Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - # @return [Boolean, nil] - # @deprecated Use 'thermostat_schedule.is_override_allowed' - attr_accessor :manual_override_allowed # User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). # @return [String, nil] attr_accessor :name @@ -2030,9 +1894,6 @@ class ThermostatWeeklyProgram < BaseResource # Metadata for a Salto KS device. # @return [SaltoKsMetadata, nil] resource_accessor :salto_ks_metadata, SaltoKsMetadata - # Metada for a Salto device. - # @return [SaltoMetadata, nil] - resource_accessor :salto_metadata, SaltoMetadata # Metadata for a Schlage device. # @return [SchlageMetadata, nil] resource_accessor :schlage_metadata, SchlageMetadata @@ -2042,6 +1903,9 @@ class ThermostatWeeklyProgram < BaseResource # Metadata for a Sensi device. # @return [SensiMetadata, nil] resource_accessor :sensi_metadata, SensiMetadata + # Metadata for a Sensibo device. + # @return [SensiboMetadata, nil] + resource_accessor :sensibo_metadata, SensiboMetadata # Metadata for a SmartThings device. # @return [SmartthingsMetadata, nil] resource_accessor :smartthings_metadata, SmartthingsMetadata @@ -2057,6 +1921,9 @@ class ThermostatWeeklyProgram < BaseResource # Metadata for a TTLock device. # @return [TtlockMetadata, nil] resource_accessor :ttlock_metadata, TtlockMetadata + # Metadata for a Tuya device. + # @return [TuyaMetadata, nil] + resource_accessor :tuya_metadata, TuyaMetadata # Metadata for a 2N device. # @return [TwoNMetadata, nil] resource_accessor :two_n_metadata, TwoNMetadata @@ -2081,14 +1948,9 @@ class ThermostatWeeklyProgram < BaseResource # Keypad battery status. # @return [KeypadBattery, nil] resource_accessor :keypad_battery, KeypadBattery - # Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - # @return [ActiveThermostatSchedule, nil] - resource_accessor :active_thermostat_schedule, ActiveThermostatSchedule # Current climate setting. # @return [CurrentClimateSetting, nil] resource_accessor :current_climate_setting, CurrentClimateSetting - # @return [DefaultClimateSetting, nil] - resource_accessor :default_climate_setting, DefaultClimateSetting # Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. # @return [TemperatureThreshold, nil] resource_accessor :temperature_threshold, TemperatureThreshold @@ -2135,26 +1997,12 @@ class ThermostatWeeklyProgram < BaseResource # Indicates current noise level in decibels, if the device supports noise detection. # @return [Float, nil] attr_accessor :noise_level_decibels - # Indicates whether it is currently possible to use offline access codes for the device. - # @return [Boolean, nil] - # @deprecated use device.can_program_offline_access_codes - attr_accessor :offline_access_codes_enabled # Indicates whether the device is online. # @return [Boolean] attr_accessor :online - # Indicates whether it is currently possible to use online access codes for the device. - # @return [Boolean, nil] - # @deprecated use device.can_program_online_access_codes - attr_accessor :online_access_codes_enabled # Serial number of the device. # @return [String, nil] attr_accessor :serial_number - # @return [Boolean, nil] - # @deprecated use device.properties.model.can_connect_accessory_keypad - attr_accessor :supports_accessory_keypad - # @return [Boolean, nil] - # @deprecated use offline_access_codes_enabled - attr_accessor :supports_offline_access_codes # The delay in seconds before the lock automatically locks after being unlocked. # @return [Float, nil] attr_accessor :auto_lock_delay_seconds @@ -2214,13 +2062,6 @@ class ThermostatWeeklyProgram < BaseResource # Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. # @return [String, nil] attr_accessor :fallback_climate_preset_key - # @return [String, nil] - # Known values: - # - `auto` - # - `on` - # - `circulate` - # @deprecated Use `current_climate_setting.fan_mode_setting` instead. - attr_accessor :fan_mode_setting # Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat. # @return [Boolean, nil] attr_accessor :is_cooling @@ -2615,6 +2456,21 @@ class HubRequiredForAdditionalCapabilities < Warnings date_accessor :created_at end + # Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back. + class ServiceMode < 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: + # - `service_mode` + attr_accessor :warning_code + # Date and time at which Seam created the warning. + # @return [Time] + date_accessor :created_at + end + # Indicates a provider-specific issue that may affect device functionality. class ProviderIssue < Warnings # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2711,6 +2567,21 @@ class MaxAccessCodesReached < Warnings date_accessor :created_at end + # Indicates that a third-party subscription is required to enable additional device capabilities. + class SubscriptionRequiredForAdditionalCapabilities < 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: + # - `subscription_required_for_additional_capabilities` + attr_accessor :warning_code + # Date and time at which Seam created the warning. + # @return [Time] + date_accessor :created_at + end + # Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable. class CloudRecordingNotEnabled < Warnings # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2754,12 +2625,14 @@ class CloudRecordingNotEnabled < Warnings # - `time_zone_mismatch` # - `two_n_device_missing_timezone` # - `hub_required_for_additional_capabilities` + # - `service_mode` # - `provider_issue` # - `keynest_unsupported_locker` # - `accessory_keypad_setup_required` # - `accessory_keypad_low_battery` # - `unreliable_online_status` # - `max_access_codes_reached` + # - `subscription_required_for_additional_capabilities` # - `cloud_recording_not_enabled` attr_accessor :warning_code # Date and time at which Seam created the warning. @@ -2789,12 +2662,14 @@ class CloudRecordingNotEnabled < Warnings "time_zone_mismatch" => TimeZoneMismatch, "two_n_device_missing_timezone" => TwoNDeviceMissingTimezone, "hub_required_for_additional_capabilities" => HubRequiredForAdditionalCapabilities, + "service_mode" => ServiceMode, "provider_issue" => ProviderIssue, "keynest_unsupported_locker" => KeynestUnsupportedLocker, "accessory_keypad_setup_required" => AccessoryKeypadSetupRequired, "accessory_keypad_low_battery" => AccessoryKeypadLowBattery, "unreliable_online_status" => UnreliableOnlineStatus, "max_access_codes_reached" => MaxAccessCodesReached, + "subscription_required_for_additional_capabilities" => SubscriptionRequiredForAdditionalCapabilities, "cloud_recording_not_enabled" => CloudRecordingNotEnabled }.freeze end @@ -2898,6 +2773,7 @@ class CloudRecordingNotEnabled < Warnings # - `thermostat` # - `battery` # - `phone` + # - `pool` attr_accessor :capabilities_supported # Carbon dioxide concentration in parts per million, if the device measures it. # @return [Float, nil] @@ -2951,6 +2827,7 @@ class CloudRecordingNotEnabled < Warnings # - `omnitec_lock` # - `kisi_lock` # - `aqara_lock` + # - `tuya_lock` # - `eufy_lock` # - `keynest_key` # - `noiseaware_activity_zone` @@ -2960,6 +2837,7 @@ class CloudRecordingNotEnabled < Warnings # - `honeywell_resideo_thermostat` # - `tado_thermostat` # - `sensi_thermostat` + # - `sensibo_thermostat` # - `smartthings_thermostat` # - `ios_phone` # - `android_phone` @@ -2970,16 +2848,21 @@ class CloudRecordingNotEnabled < Warnings # - `unifi_protect_camera` # - `sonos_speaker` # - `alertify_sensor` + # - `hayward_pool_system` + # - `hayward_pool` 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. # @return [String] attr_accessor :display_name + # Estimated number of occupants detected by the device. + # @return [Float, nil] + attr_accessor :estimated_occupant_count # Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). # @return [TrueClass] attr_accessor :is_managed - # Indicates whether the device detects that the space is occupied, if the device measures occupancy. + # Indicates whether the device detects occupancy. # @return [Boolean, nil] - attr_accessor :is_occupied + attr_accessor :is_occupancy_detected # Indicates whether the device detects smoking, if the device measures it. # @return [Boolean, nil] attr_accessor :is_smoking_detected @@ -2995,9 +2878,6 @@ class CloudRecordingNotEnabled < Warnings # Noise level as a Noise Risk Score (NRS), if the device reports one. # @return [Float, nil] attr_accessor :noise_level_nrs - # Number of occupants the device detects, if the device counts occupants. - # @return [Float, nil] - attr_accessor :occupant_count # Relative humidity, as a value between 0 and 1, inclusive, if the device measures humidity. # @return [Float, nil] attr_accessor :relative_humidity diff --git a/lib/seam/resources/device_provider.rb b/lib/seam/resources/device_provider.rb index ed6395d..f0445e6 100644 --- a/lib/seam/resources/device_provider.rb +++ b/lib/seam/resources/device_provider.rb @@ -121,6 +121,7 @@ class DeviceProvider < BaseResource # - `tado` # - `salto_space` # - `sensi` + # - `sensibo` # - `keynest` # - `korelock` # - `keyincode` @@ -147,6 +148,8 @@ class DeviceProvider < BaseResource # - `aqara` # - `eufy` # - `sonos` + # - `hayward_omnilogic` + # - `tuya` attr_accessor :device_provider_name # Display name for the device provider. # @return [String] diff --git a/lib/seam/resources/event.rb b/lib/seam/resources/event.rb index 6b92243..d2867f2 100644 --- a/lib/seam/resources/event.rb +++ b/lib/seam/resources/event.rb @@ -2436,38 +2436,6 @@ class ConnectedAccountCreated < SeamEvent date_accessor :occurred_at end - # A connected account had a successful login using a Connect Webview. - class ConnectedAccountSuccessfulLogin < SeamEvent - # ID of the Connect Webview associated with the event. - # @return [String] - attr_accessor :connect_webview_id - # Custom metadata of the connected account, present when connected_account_id is provided. - # @return [Hash{String => String, Boolean}, nil] - attr_accessor :connected_account_custom_metadata - # ID of the affected connected account. - # @return [String] - attr_accessor :connected_account_id - # Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. - # @return [String, nil] - attr_accessor :event_description - # ID of the event. - # @return [String] - attr_accessor :event_id - # @return [String] - # Known values: - # - `connected_account.successful_login` - attr_accessor :event_type - # ID of the workspace associated with the event. - # @return [String] - attr_accessor :workspace_id - # Date and time at which the event was created. - # @return [Time] - date_accessor :created_at - # Date and time at which the event occurred. - # @return [Time] - date_accessor :occurred_at - end - # A connected account was disconnected. class ConnectedAccountDisconnected < SeamEvent class ConnectedAccountErrors < BaseResource @@ -3484,10 +3452,6 @@ class DeviceLowBattery < SeamEvent # Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. # @return [Float, nil] attr_accessor :accessory_keypad_battery_level - # Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event. - # @return [Float] - # @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery. - attr_accessor :battery_level # Custom metadata of the connected account, present when connected_account_id is provided. # @return [Hash{String => String, Boolean}, nil] attr_accessor :connected_account_custom_metadata @@ -4948,11 +4912,6 @@ class DeviceNameChanged < SeamEvent # A camera was activated, for example, by motion detection. For Ring cameras, this event is available only in the Seam Console, not through the API or webhooks. class CameraActivated < SeamEvent - # The reason the camera was activated. - # @return [String] - # Known values: - # - `motion_detected` - attr_accessor :activation_reason # Custom metadata of the connected account, present when connected_account_id is provided. # @return [Hash{String => String, Boolean}, nil] attr_accessor :connected_account_custom_metadata @@ -4981,6 +4940,9 @@ class CameraActivated < SeamEvent # URL to a thumbnail image captured at the time of activation. # @return [String, nil] attr_accessor :image_url + # Whether motion detection activated the camera, if known. + # @return [Boolean, nil] + attr_accessor :is_motion_detected # IDs of the media, such as a video clip and a thumbnail image, captured for this activation. Use `/media/get` to retrieve each one. # @return [Array] attr_accessor :media_ids @@ -5382,7 +5344,6 @@ class SpaceDeleted < SeamEvent "client_session.deleted" => ClientSessionDeleted, "connected_account.connected" => ConnectedAccountConnected, "connected_account.created" => ConnectedAccountCreated, - "connected_account.successful_login" => ConnectedAccountSuccessfulLogin, "connected_account.disconnected" => ConnectedAccountDisconnected, "connected_account.completed_first_sync" => ConnectedAccountCompletedFirstSync, "connected_account.deleted" => ConnectedAccountDeleted, diff --git a/lib/seam/resources/phone.rb b/lib/seam/resources/phone.rb index 38c4767..190db77 100644 --- a/lib/seam/resources/phone.rb +++ b/lib/seam/resources/phone.rb @@ -681,6 +681,21 @@ class HubRequiredForAdditionalCapabilities < Warnings date_accessor :created_at end + # Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back. + class ServiceMode < 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: + # - `service_mode` + attr_accessor :warning_code + # Date and time at which Seam created the warning. + # @return [Time] + date_accessor :created_at + end + # Indicates a provider-specific issue that may affect device functionality. class ProviderIssue < Warnings # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -777,6 +792,21 @@ class MaxAccessCodesReached < Warnings date_accessor :created_at end + # Indicates that a third-party subscription is required to enable additional device capabilities. + class SubscriptionRequiredForAdditionalCapabilities < 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: + # - `subscription_required_for_additional_capabilities` + attr_accessor :warning_code + # Date and time at which Seam created the warning. + # @return [Time] + date_accessor :created_at + end + # Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable. class CloudRecordingNotEnabled < Warnings # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -820,12 +850,14 @@ class CloudRecordingNotEnabled < Warnings # - `time_zone_mismatch` # - `two_n_device_missing_timezone` # - `hub_required_for_additional_capabilities` + # - `service_mode` # - `provider_issue` # - `keynest_unsupported_locker` # - `accessory_keypad_setup_required` # - `accessory_keypad_low_battery` # - `unreliable_online_status` # - `max_access_codes_reached` + # - `subscription_required_for_additional_capabilities` # - `cloud_recording_not_enabled` attr_accessor :warning_code # Date and time at which Seam created the warning. @@ -855,12 +887,14 @@ class CloudRecordingNotEnabled < Warnings "time_zone_mismatch" => TimeZoneMismatch, "two_n_device_missing_timezone" => TwoNDeviceMissingTimezone, "hub_required_for_additional_capabilities" => HubRequiredForAdditionalCapabilities, + "service_mode" => ServiceMode, "provider_issue" => ProviderIssue, "keynest_unsupported_locker" => KeynestUnsupportedLocker, "accessory_keypad_setup_required" => AccessoryKeypadSetupRequired, "accessory_keypad_low_battery" => AccessoryKeypadLowBattery, "unreliable_online_status" => UnreliableOnlineStatus, "max_access_codes_reached" => MaxAccessCodesReached, + "subscription_required_for_additional_capabilities" => SubscriptionRequiredForAdditionalCapabilities, "cloud_recording_not_enabled" => CloudRecordingNotEnabled }.freeze end diff --git a/lib/seam/resources/unmanaged_access_grant.rb b/lib/seam/resources/unmanaged_access_grant.rb index 9b875b3..4917121 100644 --- a/lib/seam/resources/unmanaged_access_grant.rb +++ b/lib/seam/resources/unmanaged_access_grant.rb @@ -353,9 +353,6 @@ class AccessRevoked < Warnings # Display name of the Access Grant. # @return [String] attr_accessor :display_name - # @return [Array] - # @deprecated Use `space_ids`. - attr_accessor :location_ids # Name of the Access Grant. If not provided, the display name will be computed. # @return [String, nil] attr_accessor :name diff --git a/lib/seam/resources/unmanaged_device.rb b/lib/seam/resources/unmanaged_device.rb index 92353fd..e1778ed 100644 --- a/lib/seam/resources/unmanaged_device.rb +++ b/lib/seam/resources/unmanaged_device.rb @@ -326,10 +326,6 @@ class Location < BaseResource # Time zone of the device location. # @return [String, nil] attr_accessor :time_zone - # Time zone of the device location. - # @return [String, nil] - # @deprecated Use `time_zone` instead. - attr_accessor :timezone end class Properties < BaseResource @@ -362,9 +358,6 @@ class Battery < BaseResource end class Model < BaseResource - # @return [Boolean, nil] - # @deprecated use device.properties.model.can_connect_accessory_keypad - attr_accessor :accessory_keypad_supported # Indicates whether the device can connect a accessory keypad. # @return [Boolean, nil] attr_accessor :can_connect_accessory_keypad @@ -377,12 +370,6 @@ class Model < BaseResource # Display name that corresponds to the manufacturer-specific terminology for the device. # @return [String] attr_accessor :manufacturer_display_name - # @return [Boolean, nil] - # @deprecated use device.can_program_offline_access_codes. - attr_accessor :offline_access_codes_supported - # @return [Boolean, nil] - # @deprecated use device.can_program_online_access_codes. - attr_accessor :online_access_codes_supported end # Accessory keypad properties and state. @@ -410,17 +397,9 @@ class Model < BaseResource # @return [String] # @deprecated use device.display_name instead attr_accessor :name - # Indicates whether it is currently possible to use offline access codes for the device. - # @return [Boolean, nil] - # @deprecated use device.can_program_offline_access_codes - attr_accessor :offline_access_codes_enabled # Indicates whether the device is online. # @return [Boolean] attr_accessor :online - # Indicates whether it is currently possible to use online access codes for the device. - # @return [Boolean, nil] - # @deprecated use device.can_program_online_access_codes - attr_accessor :online_access_codes_enabled end # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility. @@ -755,6 +734,21 @@ class HubRequiredForAdditionalCapabilities < Warnings date_accessor :created_at end + # Indicates that a technician has put the pool controller in service mode. Schedules and remote changes will not run until it is switched back. + class ServiceMode < 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: + # - `service_mode` + attr_accessor :warning_code + # Date and time at which Seam created the warning. + # @return [Time] + date_accessor :created_at + end + # Indicates a provider-specific issue that may affect device functionality. class ProviderIssue < Warnings # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -851,6 +845,21 @@ class MaxAccessCodesReached < Warnings date_accessor :created_at end + # Indicates that a third-party subscription is required to enable additional device capabilities. + class SubscriptionRequiredForAdditionalCapabilities < 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: + # - `subscription_required_for_additional_capabilities` + attr_accessor :warning_code + # Date and time at which Seam created the warning. + # @return [Time] + date_accessor :created_at + end + # Indicates that the camera's account plan does not include cloud recording, so event media such as motion clips is unavailable. class CloudRecordingNotEnabled < Warnings # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -894,12 +903,14 @@ class CloudRecordingNotEnabled < Warnings # - `time_zone_mismatch` # - `two_n_device_missing_timezone` # - `hub_required_for_additional_capabilities` + # - `service_mode` # - `provider_issue` # - `keynest_unsupported_locker` # - `accessory_keypad_setup_required` # - `accessory_keypad_low_battery` # - `unreliable_online_status` # - `max_access_codes_reached` + # - `subscription_required_for_additional_capabilities` # - `cloud_recording_not_enabled` attr_accessor :warning_code # Date and time at which Seam created the warning. @@ -929,12 +940,14 @@ class CloudRecordingNotEnabled < Warnings "time_zone_mismatch" => TimeZoneMismatch, "two_n_device_missing_timezone" => TwoNDeviceMissingTimezone, "hub_required_for_additional_capabilities" => HubRequiredForAdditionalCapabilities, + "service_mode" => ServiceMode, "provider_issue" => ProviderIssue, "keynest_unsupported_locker" => KeynestUnsupportedLocker, "accessory_keypad_setup_required" => AccessoryKeypadSetupRequired, "accessory_keypad_low_battery" => AccessoryKeypadLowBattery, "unreliable_online_status" => UnreliableOnlineStatus, "max_access_codes_reached" => MaxAccessCodesReached, + "subscription_required_for_additional_capabilities" => SubscriptionRequiredForAdditionalCapabilities, "cloud_recording_not_enabled" => CloudRecordingNotEnabled }.freeze end @@ -1026,6 +1039,7 @@ class CloudRecordingNotEnabled < Warnings # - `thermostat` # - `battery` # - `phone` + # - `pool` attr_accessor :capabilities_supported # Unique identifier for the account associated with the device. # @return [String] @@ -1073,6 +1087,7 @@ class CloudRecordingNotEnabled < Warnings # - `omnitec_lock` # - `kisi_lock` # - `aqara_lock` + # - `tuya_lock` # - `eufy_lock` # - `keynest_key` # - `noiseaware_activity_zone` @@ -1082,6 +1097,7 @@ class CloudRecordingNotEnabled < Warnings # - `honeywell_resideo_thermostat` # - `tado_thermostat` # - `sensi_thermostat` + # - `sensibo_thermostat` # - `smartthings_thermostat` # - `ios_phone` # - `android_phone` @@ -1092,6 +1108,8 @@ class CloudRecordingNotEnabled < Warnings # - `unifi_protect_camera` # - `sonos_speaker` # - `alertify_sensor` + # - `hayward_pool_system` + # - `hayward_pool` 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. # @return [String] diff --git a/lib/seam/resources/workspace.rb b/lib/seam/resources/workspace.rb index fd5a6c6..5bdd50a 100644 --- a/lib/seam/resources/workspace.rb +++ b/lib/seam/resources/workspace.rb @@ -27,10 +27,6 @@ class ConnectWebviewCustomization < BaseResource # @return [ConnectWebviewCustomization] resource_accessor :connect_webview_customization, ConnectWebviewCustomization - # Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces). - # @return [String] - # @deprecated Use `connect_partner_name` instead. - attr_accessor :company_name # Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces). # @return [String, nil] attr_accessor :connect_partner_name diff --git a/lib/seam/routes/access_codes.rb b/lib/seam/routes/access_codes.rb index 41e6e73..a15d16e 100644 --- a/lib/seam/routes/access_codes.rb +++ b/lib/seam/routes/access_codes.rb @@ -38,11 +38,9 @@ def unmanaged # @param preferred_code_length [Float, nil] Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. # @param starts_at [String, nil] Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. # @param use_backup_access_code_pool [Boolean, nil] Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code). - # @param use_offline_access_code [Boolean, nil] - # @deprecated use_offline_access_code: Use `is_offline_access_code` instead. # @return [Seam::Resources::AccessCode] OK - def create(device_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, common_code_key: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil) - res = @client.post("/access_codes/create", {device_id: device_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, common_code_key: common_code_key, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact) + def create(device_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, common_code_key: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil) + res = @client.post("/access_codes/create", {device_id: device_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, common_code_key: common_code_key, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, use_backup_access_code_pool: use_backup_access_code_pool}.compact) Seam::Resources::AccessCode.from_http_response(res, "access_code", "/access_codes/create") end diff --git a/lib/seam/routes/access_grants.rb b/lib/seam/routes/access_grants.rb index b89868a..564d731 100644 --- a/lib/seam/routes/access_grants.rb +++ b/lib/seam/routes/access_grants.rb @@ -19,10 +19,6 @@ def unmanaged # @param customization_profile_id [String, nil] ID of the customization profile to apply to the Access Grant and its access methods. # @param device_ids [Array, nil] Set of IDs of the [devices](https://www.seam.co/docs/api/devices/list) to which access is being granted. # @param ends_at [String, Seam::Null, nil] Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - # @param location [Hash, nil] - # @deprecated location: Create a space first, then reference it using `space_ids`. - # @param location_ids [Array, nil] - # @deprecated location_ids: Use `space_ids`. # @param name [String, Seam::Null, nil] Name for the access grant. # @param reservation_key [String, nil] Reservation key for the access grant. # @param space_ids [Array, nil] Set of IDs of existing spaces to which access is being granted. @@ -31,8 +27,8 @@ def unmanaged # @param user_identity [Hash, nil] When used, creates a new user identity with the given details, and grants them access. # @param user_identity_id [String, nil] ID of user identity for whom access is being granted. # @return [Seam::Resources::AccessGrant] OK - def create(requested_access_methods:, access_grant_key: nil, acs_entrance_ids: nil, customization_profile_id: nil, device_ids: nil, ends_at: nil, location: nil, location_ids: nil, name: nil, reservation_key: nil, space_ids: nil, space_keys: nil, starts_at: nil, user_identity: nil, user_identity_id: nil) - res = @client.post("/access_grants/create", {requested_access_methods: requested_access_methods, access_grant_key: access_grant_key, acs_entrance_ids: acs_entrance_ids, customization_profile_id: customization_profile_id, device_ids: device_ids, ends_at: ends_at, location: location, location_ids: location_ids, name: name, reservation_key: reservation_key, space_ids: space_ids, space_keys: space_keys, starts_at: starts_at, user_identity: user_identity, user_identity_id: user_identity_id}.compact) + def create(requested_access_methods:, access_grant_key: nil, acs_entrance_ids: nil, customization_profile_id: nil, device_ids: nil, ends_at: nil, name: nil, reservation_key: nil, space_ids: nil, space_keys: nil, starts_at: nil, user_identity: nil, user_identity_id: nil) + res = @client.post("/access_grants/create", {requested_access_methods: requested_access_methods, access_grant_key: access_grant_key, acs_entrance_ids: acs_entrance_ids, customization_profile_id: customization_profile_id, device_ids: device_ids, ends_at: ends_at, name: name, reservation_key: reservation_key, space_ids: space_ids, space_keys: space_keys, starts_at: starts_at, user_identity: user_identity, user_identity_id: user_identity_id}.compact) Seam::Resources::AccessGrant.from_http_response(res, "access_grant", "/access_grants/create") end @@ -89,16 +85,14 @@ def get_related(access_grant_ids: nil, access_grant_keys: nil, exclude: nil, inc # @param customer_key [String, nil] Customer key for which you want to list access grants. # @param device_id [String, nil] ID of the device by which you want to filter the list of Access Grants. # @param limit [Float, nil] Numerical limit on the number of access grants to return. - # @param location_id [String, nil] - # @deprecated location_id: Use `space_id`. # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. # @param reservation_key [String, nil] Filter Access Grants by reservation_key. # @param search [String, nil] String for which to search. Filters returned Access Grants to include all records that satisfy a partial match using `name`, `access_grant_key`, `reservation_key`, `access_grant_id`, `user_identity_id`, `user_identity_full_name`, `user_identity_email_address` or `user_identity_phone_number`. # @param space_id [String, nil] ID of the space by which you want to filter the list of Access Grants. # @param user_identity_id [String, nil] ID of user identity by which you want to filter the list of Access Grants. # @return [Seam::Resources::AccessGrant] OK - def list(access_code_id: nil, access_grant_ids: nil, access_grant_key: nil, acs_entrance_id: nil, acs_system_id: nil, customer_key: nil, device_id: nil, limit: nil, location_id: nil, page_cursor: nil, reservation_key: nil, search: nil, space_id: nil, user_identity_id: nil) - res = @client.get("/access_grants/list", {access_code_id: access_code_id, access_grant_ids: access_grant_ids, access_grant_key: access_grant_key, acs_entrance_id: acs_entrance_id, acs_system_id: acs_system_id, customer_key: customer_key, device_id: device_id, limit: limit, location_id: location_id, page_cursor: page_cursor, reservation_key: reservation_key, search: search, space_id: space_id, user_identity_id: user_identity_id}.compact) + def list(access_code_id: nil, access_grant_ids: nil, access_grant_key: nil, acs_entrance_id: nil, acs_system_id: nil, customer_key: nil, device_id: nil, limit: nil, page_cursor: nil, reservation_key: nil, search: nil, space_id: nil, user_identity_id: nil) + res = @client.get("/access_grants/list", {access_code_id: access_code_id, access_grant_ids: access_grant_ids, access_grant_key: access_grant_key, acs_entrance_id: acs_entrance_id, acs_system_id: acs_system_id, customer_key: customer_key, device_id: device_id, limit: limit, page_cursor: page_cursor, reservation_key: reservation_key, search: search, space_id: space_id, user_identity_id: user_identity_id}.compact) Seam::Resources::AccessGrant.list_from_http_response(res, "access_grants", "/access_grants/list") end diff --git a/lib/seam/routes/acs_entrances.rb b/lib/seam/routes/acs_entrances.rb index 2d7ed9b..825bfe9 100644 --- a/lib/seam/routes/acs_entrances.rb +++ b/lib/seam/routes/acs_entrances.rb @@ -38,14 +38,12 @@ def grant_access(acs_entrance_id:, acs_user_id: nil, user_identity_id: nil) # @param connected_account_id [String, nil] ID of the connected account for which you want to retrieve all entrances. # @param customer_key [String, nil] Customer key for which you want to list entrances. # @param limit [Integer, nil] Maximum number of records to return per page. - # @param location_id [String, Seam::Null, nil] - # @deprecated location_id: Use `space_id`. # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. # @param search [String, nil] String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. # @param space_id [String, nil] ID of the space for which you want to list entrances. # @return [Seam::Resources::AcsEntrance] OK - def list(access_method_id: nil, acs_credential_id: nil, acs_entrance_ids: nil, acs_system_id: nil, connected_account_id: nil, customer_key: nil, limit: nil, location_id: nil, page_cursor: nil, search: nil, space_id: nil) - res = @client.get("/acs/entrances/list", {access_method_id: access_method_id, acs_credential_id: acs_credential_id, acs_entrance_ids: acs_entrance_ids, acs_system_id: acs_system_id, connected_account_id: connected_account_id, customer_key: customer_key, limit: limit, location_id: location_id, page_cursor: page_cursor, search: search, space_id: space_id}.compact) + def list(access_method_id: nil, acs_credential_id: nil, acs_entrance_ids: nil, acs_system_id: nil, connected_account_id: nil, customer_key: nil, limit: nil, page_cursor: nil, search: nil, space_id: nil) + res = @client.get("/acs/entrances/list", {access_method_id: access_method_id, acs_credential_id: acs_credential_id, acs_entrance_ids: acs_entrance_ids, acs_system_id: acs_system_id, connected_account_id: connected_account_id, customer_key: customer_key, limit: limit, page_cursor: page_cursor, search: search, space_id: space_id}.compact) Seam::Resources::AcsEntrance.list_from_http_response(res, "acs_entrances", "/acs/entrances/list") end diff --git a/lib/seam/routes/acs_users.rb b/lib/seam/routes/acs_users.rb index f08f57b..a820b4e 100644 --- a/lib/seam/routes/acs_users.rb +++ b/lib/seam/routes/acs_users.rb @@ -23,14 +23,12 @@ def add_to_access_group(acs_access_group_id:, acs_user_id:) # @param full_name [String] Full name of the new access system user. # @param access_schedule [Hash, nil] `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. # @param acs_access_group_ids [Array, nil] Array of access group IDs to indicate the access groups to which you want to add the new access system user. - # @param email [String, nil] - # @deprecated email: use email_address. # @param email_address [String, nil] Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). # @param phone_number [String, nil] Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). # @param user_identity_id [String, nil] ID of the user identity with which you want to associate the new access system user. # @return [Seam::Resources::AcsUser] OK - def create(acs_system_id:, full_name:, access_schedule: nil, acs_access_group_ids: nil, email: nil, email_address: nil, phone_number: nil, user_identity_id: nil) - res = @client.post("/acs/users/create", {acs_system_id: acs_system_id, full_name: full_name, access_schedule: access_schedule, acs_access_group_ids: acs_access_group_ids, email: email, email_address: email_address, phone_number: phone_number, user_identity_id: user_identity_id}.compact) + def create(acs_system_id:, full_name:, access_schedule: nil, acs_access_group_ids: nil, email_address: nil, phone_number: nil, user_identity_id: nil) + res = @client.post("/acs/users/create", {acs_system_id: acs_system_id, full_name: full_name, access_schedule: access_schedule, acs_access_group_ids: acs_access_group_ids, email_address: email_address, phone_number: phone_number, user_identity_id: user_identity_id}.compact) Seam::Resources::AcsUser.from_http_response(res, "acs_user", "/acs/users/create") end @@ -168,22 +166,20 @@ def unsuspend(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil) # @param access_schedule [Hash, Seam::Null, nil] `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. # @param acs_system_id [String, nil] ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. # @param acs_user_id [String, nil] ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id. - # @param email [String, nil] - # @deprecated email: use email_address. # @param email_address [String, nil] Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). # @param full_name [String, nil] Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). # @param hid_acs_system_id [String, nil] ID of the HID access control system associated with the user. # @param phone_number [String, nil] Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). # @param user_identity_id [String, nil] ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. # @return [nil] OK - def update(access_schedule: nil, acs_system_id: nil, acs_user_id: nil, email: nil, email_address: nil, full_name: nil, hid_acs_system_id: nil, phone_number: nil, user_identity_id: nil) + def update(access_schedule: nil, acs_system_id: nil, acs_user_id: nil, email_address: nil, full_name: nil, hid_acs_system_id: nil, phone_number: nil, user_identity_id: nil) Seam::RequestParameters.require_at_least_one( "/acs/users/update", - {access_schedule: access_schedule, acs_system_id: acs_system_id, acs_user_id: acs_user_id, email: email, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number, user_identity_id: user_identity_id}, - [:access_schedule, :acs_system_id, :acs_user_id, :email, :email_address, :full_name, :hid_acs_system_id, :phone_number, :user_identity_id] + {access_schedule: access_schedule, acs_system_id: acs_system_id, acs_user_id: acs_user_id, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number, user_identity_id: user_identity_id}, + [:access_schedule, :acs_system_id, :acs_user_id, :email_address, :full_name, :hid_acs_system_id, :phone_number, :user_identity_id] ) - @client.patch("/acs/users/update", {access_schedule: access_schedule, acs_system_id: acs_system_id, acs_user_id: acs_user_id, email: email, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number, user_identity_id: user_identity_id}.compact) + @client.patch("/acs/users/update", {access_schedule: access_schedule, acs_system_id: acs_system_id, acs_user_id: acs_user_id, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number, user_identity_id: user_identity_id}.compact) nil end diff --git a/lib/seam/routes/client_sessions.rb b/lib/seam/routes/client_sessions.rb index 3f029e5..2fec22a 100644 --- a/lib/seam/routes/client_sessions.rb +++ b/lib/seam/routes/client_sessions.rb @@ -16,11 +16,9 @@ def initialize(client:, defaults:) # @param expires_at [Time, nil] Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. # @param user_identifier_key [String, nil] Your user ID for the user for whom you want to create a client session. When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. # @param user_identity_id [String, nil] ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. - # @param user_identity_ids [Array, nil] IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. - # @deprecated user_identity_ids: Use `user_identity_id` instead. # @return [Seam::Resources::ClientSession] OK - def create(connect_webview_ids: nil, connected_account_ids: nil, customer_id: nil, customer_key: nil, expires_at: nil, user_identifier_key: nil, user_identity_id: nil, user_identity_ids: nil) - res = @client.put("/client_sessions/create", {connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, customer_id: customer_id, customer_key: customer_key, expires_at: expires_at, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, user_identity_ids: user_identity_ids}.compact) + def create(connect_webview_ids: nil, connected_account_ids: nil, customer_id: nil, customer_key: nil, expires_at: nil, user_identifier_key: nil, user_identity_id: nil) + res = @client.put("/client_sessions/create", {connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, customer_id: customer_id, customer_key: customer_key, expires_at: expires_at, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id}.compact) Seam::Resources::ClientSession.from_http_response(res, "client_session", "/client_sessions/create") end @@ -50,11 +48,9 @@ def get(client_session_id: nil, user_identifier_key: nil) # @param expires_at [Time, nil] Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it. # @param user_identifier_key [String, nil] Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the `user_identifier_key` must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the `user_identifier_key` can retrieve the client session. # @param user_identity_id [String, nil] ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). - # @param user_identity_ids [Array, nil] IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. - # @deprecated user_identity_ids: Use `user_identity_id`. # @return [Seam::Resources::ClientSession] OK - def get_or_create(connect_webview_ids: nil, connected_account_ids: nil, expires_at: nil, user_identifier_key: nil, user_identity_id: nil, user_identity_ids: nil) - res = @client.post("/client_sessions/get_or_create", {connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, expires_at: expires_at, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, user_identity_ids: user_identity_ids}.compact) + def get_or_create(connect_webview_ids: nil, connected_account_ids: nil, expires_at: nil, user_identifier_key: nil, user_identity_id: nil) + res = @client.post("/client_sessions/get_or_create", {connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, expires_at: expires_at, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id}.compact) Seam::Resources::ClientSession.from_http_response(res, "client_session", "/client_sessions/get_or_create") end @@ -65,17 +61,15 @@ def get_or_create(connect_webview_ids: nil, connected_account_ids: nil, expires_ # @param connected_account_ids [Array, nil] IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that you want to associate with the client session. # @param user_identifier_key [String, nil] Your user ID for the user that you want to associate with the client session. # @param user_identity_id [String, nil] ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. - # @param user_identity_ids [Array, nil] IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. - # @deprecated user_identity_ids: Use `user_identity_id`. # @return [nil] OK - def grant_access(client_session_id: nil, connect_webview_ids: nil, connected_account_ids: nil, user_identifier_key: nil, user_identity_id: nil, user_identity_ids: nil) + def grant_access(client_session_id: nil, connect_webview_ids: nil, connected_account_ids: nil, user_identifier_key: nil, user_identity_id: nil) Seam::RequestParameters.require_at_least_one( "/client_sessions/grant_access", - {client_session_id: client_session_id, connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, user_identity_ids: user_identity_ids}, - [:client_session_id, :connect_webview_ids, :connected_account_ids, :user_identifier_key, :user_identity_id, :user_identity_ids] + {client_session_id: client_session_id, connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id}, + [:client_session_id, :connect_webview_ids, :connected_account_ids, :user_identifier_key, :user_identity_id] ) - @client.patch("/client_sessions/grant_access", {client_session_id: client_session_id, connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, user_identity_ids: user_identity_ids}.compact) + @client.patch("/client_sessions/grant_access", {client_session_id: client_session_id, connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id}.compact) nil end diff --git a/lib/seam/routes/customers.rb b/lib/seam/routes/customers.rb index ff45995..e5f6876 100644 --- a/lib/seam/routes/customers.rb +++ b/lib/seam/routes/customers.rb @@ -12,7 +12,6 @@ def initialize(client:, defaults:) # @param customer_data [Hash, nil] # @param customer_resources_filters [Array, nil] Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata. # @param customization_profile_id [String, nil] The ID of the customization profile to use for the portal. - # @param deep_link [Hash, nil] Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource. # @param exclude_locale_picker [Boolean, nil] Whether to exclude the option to select a locale within the portal UI. # @param features [Hash, nil] Features to include in the portal. Settings you omit use the portal's customization profile, then the Seam default. Settings you pass take precedence over the customization profile's, so changing the profile doesn't change them. # @param is_embedded [Boolean, nil] Whether the portal is embedded in another application. @@ -21,8 +20,8 @@ def initialize(client:, defaults:) # @param navigation_mode [String, nil] Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links. # @param read_only [Boolean, nil] Whether the portal is read-only. When true, the customer can browse the portal but cannot perform any mutating action; write requests made with the portal's client session are rejected. # @return [Seam::Resources::CustomerPortal] OK - def create_portal(customer_data: nil, customer_resources_filters: nil, customization_profile_id: nil, deep_link: nil, exclude_locale_picker: nil, features: nil, is_embedded: nil, landing_page: nil, locale: nil, navigation_mode: nil, read_only: nil) - res = @client.post("/customers/create_portal", {customer_data: customer_data, customer_resources_filters: customer_resources_filters, customization_profile_id: customization_profile_id, deep_link: deep_link, exclude_locale_picker: exclude_locale_picker, features: features, is_embedded: is_embedded, landing_page: landing_page, locale: locale, navigation_mode: navigation_mode, read_only: read_only}.compact) + def create_portal(customer_data: nil, customer_resources_filters: nil, customization_profile_id: nil, exclude_locale_picker: nil, features: nil, is_embedded: nil, landing_page: nil, locale: nil, navigation_mode: nil, read_only: nil) + res = @client.post("/customers/create_portal", {customer_data: customer_data, customer_resources_filters: customer_resources_filters, customization_profile_id: customization_profile_id, exclude_locale_picker: exclude_locale_picker, features: features, is_embedded: is_embedded, landing_page: landing_page, locale: locale, navigation_mode: navigation_mode, read_only: read_only}.compact) Seam::Resources::CustomerPortal.from_http_response(res, "customer_portal", "/customers/create_portal") end diff --git a/lib/seam/routes/devices.rb b/lib/seam/routes/devices.rb index 181bce9..89bcc19 100644 --- a/lib/seam/routes/devices.rb +++ b/lib/seam/routes/devices.rb @@ -49,12 +49,10 @@ def get(device_id: nil, name: nil) # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. # @param search [String, nil] String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. # @param space_id [String, nil] ID of the space for which you want to list devices. - # @param unstable_location_id [String, Seam::Null, nil] - # @deprecated unstable_location_id: Use `space_id`. # @param user_identifier_key [String, nil] Your own internal user ID for the user for which you want to list devices. # @return [Seam::Resources::Device] OK - def list(connect_webview_id: nil, connected_account_id: nil, connected_account_ids: nil, created_before: nil, custom_metadata_has: nil, customer_key: nil, device_ids: nil, device_type: nil, device_types: nil, limit: nil, manufacturer: nil, page_cursor: nil, search: nil, space_id: nil, unstable_location_id: nil, user_identifier_key: nil) - res = @client.get("/devices/list", {connect_webview_id: connect_webview_id, connected_account_id: connected_account_id, connected_account_ids: connected_account_ids, created_before: created_before, custom_metadata_has: custom_metadata_has, customer_key: customer_key, device_ids: device_ids, device_type: device_type, device_types: device_types, limit: limit, manufacturer: manufacturer, page_cursor: page_cursor, search: search, space_id: space_id, unstable_location_id: unstable_location_id, user_identifier_key: user_identifier_key}.compact) + def list(connect_webview_id: nil, connected_account_id: nil, connected_account_ids: nil, created_before: nil, custom_metadata_has: nil, customer_key: nil, device_ids: nil, device_type: nil, device_types: nil, limit: nil, manufacturer: nil, page_cursor: nil, search: nil, space_id: nil, user_identifier_key: nil) + res = @client.get("/devices/list", {connect_webview_id: connect_webview_id, connected_account_id: connected_account_id, connected_account_ids: connected_account_ids, created_before: created_before, custom_metadata_has: custom_metadata_has, customer_key: customer_key, device_ids: device_ids, device_type: device_type, device_types: device_types, limit: limit, manufacturer: manufacturer, page_cursor: page_cursor, search: search, space_id: space_id, user_identifier_key: user_identifier_key}.compact) Seam::Resources::Device.list_from_http_response(res, "devices", "/devices/list") end diff --git a/lib/seam/routes/spaces.rb b/lib/seam/routes/spaces.rb index 6f0dda1..e0450b7 100644 --- a/lib/seam/routes/spaces.rb +++ b/lib/seam/routes/spaces.rb @@ -143,12 +143,13 @@ def remove_devices(device_ids:, space_id:) # @param acs_entrance_ids [Array, nil] IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. # @param customer_data [Hash, nil] Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it. # @param device_ids [Array, nil] IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. + # @param geolocation [Hash, Seam::Null, nil] Geographic coordinates of the space. Pass null to clear them. Seam keeps this value until the connected PMS reports different coordinates for the space. # @param name [String, nil] Name of the space. # @param space_id [String, nil] ID of the space that you want to update. # @param space_key [String, nil] Unique key of the space that you want to update. # @return [Seam::Resources::Space] OK - def update(acs_entrance_ids: nil, customer_data: nil, device_ids: nil, name: nil, space_id: nil, space_key: nil) - res = @client.patch("/spaces/update", {acs_entrance_ids: acs_entrance_ids, customer_data: customer_data, device_ids: device_ids, name: name, space_id: space_id, space_key: space_key}.compact) + def update(acs_entrance_ids: nil, customer_data: nil, device_ids: nil, geolocation: nil, name: nil, space_id: nil, space_key: nil) + res = @client.patch("/spaces/update", {acs_entrance_ids: acs_entrance_ids, customer_data: customer_data, device_ids: device_ids, geolocation: geolocation, name: name, space_id: space_id, space_key: space_key}.compact) Seam::Resources::Space.from_http_response(res, "space", "/spaces/update") end diff --git a/lib/seam/routes/thermostats.rb b/lib/seam/routes/thermostats.rb index 51f0118..73755ed 100644 --- a/lib/seam/routes/thermostats.rb +++ b/lib/seam/routes/thermostats.rb @@ -69,12 +69,10 @@ def cool(device_id:, cooling_set_point_celsius: nil, cooling_set_point_fahrenhei # @param heating_set_point_celsius [Float, nil] Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). # @param heating_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). # @param hvac_mode_setting [String, nil] Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - # @param manual_override_allowed [Boolean, nil] Indicates whether a person at the thermostat or using the API can change the thermostat's settings. - # @deprecated manual_override_allowed: Use 'thermostat_schedule.is_override_allowed' # @param name [String, Seam::Null, nil] User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). # @return [nil] OK - def create_climate_preset(climate_preset_key:, device_id:, climate_preset_mode: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, ecobee_metadata: nil, fan_mode_setting: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, manual_override_allowed: nil, name: nil) - @client.post("/thermostats/create_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id, climate_preset_mode: climate_preset_mode, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, ecobee_metadata: ecobee_metadata, fan_mode_setting: fan_mode_setting, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, manual_override_allowed: manual_override_allowed, name: name}.compact) + def create_climate_preset(climate_preset_key:, device_id:, climate_preset_mode: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, ecobee_metadata: nil, fan_mode_setting: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, name: nil) + @client.post("/thermostats/create_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id, climate_preset_mode: climate_preset_mode, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, ecobee_metadata: ecobee_metadata, fan_mode_setting: fan_mode_setting, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, name: name}.compact) nil end @@ -206,12 +204,10 @@ def set_temperature_threshold(device_id:, lower_limit_celsius: nil, lower_limit_ # @param heating_set_point_celsius [Float, nil] Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). # @param heating_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). # @param hvac_mode_setting [String, nil] Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - # @param manual_override_allowed [Boolean, nil] Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - # @deprecated manual_override_allowed: Use 'thermostat_schedule.is_override_allowed' # @param name [String, Seam::Null, nil] User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). # @return [nil] OK - def update_climate_preset(climate_preset_key:, device_id:, climate_preset_mode: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, ecobee_metadata: nil, fan_mode_setting: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, manual_override_allowed: nil, name: nil) - @client.patch("/thermostats/update_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id, climate_preset_mode: climate_preset_mode, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, ecobee_metadata: ecobee_metadata, fan_mode_setting: fan_mode_setting, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, manual_override_allowed: manual_override_allowed, name: name}.compact) + def update_climate_preset(climate_preset_key:, device_id:, climate_preset_mode: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, ecobee_metadata: nil, fan_mode_setting: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, name: nil) + @client.patch("/thermostats/update_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id, climate_preset_mode: climate_preset_mode, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, ecobee_metadata: ecobee_metadata, fan_mode_setting: fan_mode_setting, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, name: name}.compact) nil end diff --git a/lib/seam/routes/workspaces.rb b/lib/seam/routes/workspaces.rb index 4b45c0c..f5aa769 100644 --- a/lib/seam/routes/workspaces.rb +++ b/lib/seam/routes/workspaces.rb @@ -12,23 +12,13 @@ def initialize(client:, defaults:) # Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). # @param name [String] Name of the new workspace. - # @param company_name [String, nil] Company name for the new workspace. - # @deprecated company_name: Use `connect_partner_name` instead. # @param connect_partner_name [String, Seam::Null, nil] Connect partner name for the new workspace. # @param connect_webview_customization [Hash, nil] [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). # @param is_sandbox [Boolean, nil] Indicates whether the new workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). # @param organization_id [String, nil] ID of the organization to associate with the new workspace. If omitted, the new workspace is associated with the organization that you administer, if you administer exactly one. If you administer no organization, Seam creates one for you and associates the new workspace with it. - # @param webview_logo_shape [String, nil] - # @deprecated webview_logo_shape: Use `connect_webview_customization.webview_logo_shape` instead. - # @param webview_primary_button_color [String, nil] - # @deprecated webview_primary_button_color: Use `connect_webview_customization.webview_primary_button_color` instead. - # @param webview_primary_button_text_color [String, nil] - # @deprecated webview_primary_button_text_color: Use `connect_webview_customization.webview_primary_button_text_color` instead. - # @param webview_success_message [String, nil] - # @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) + def create(name:, connect_partner_name: nil, connect_webview_customization: nil, is_sandbox: nil, organization_id: nil) + res = @client.post("/workspaces/create", {name: name, connect_partner_name: connect_partner_name, connect_webview_customization: connect_webview_customization, is_sandbox: is_sandbox, organization_id: organization_id}.compact) Seam::Resources::Workspace.from_http_response(res, "workspace", "/workspaces/create") end