seam 2.158.0 → 2.160.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25a61d2b647b8a194add41ffc332ab8708743ace9d8a6d203fb3acfb768c5475
-  data.tar.gz: 224f3aee42977300ca859d37b15b29950cda8ceb384f75269695591e2c96c388
+  metadata.gz: d9ac3e0c9cb925b018222545bcee3b309b2ff98db71a6475235a2d78cee404c0
+  data.tar.gz: 3c1ae4fb9af5eae7103e2994a9c9e7b5073090932b89beec66dea6eaaee5b31b
 SHA512:
-  metadata.gz: d7ed8024b8644b021a0abec47ea4eb454e2c46449f7875f5e684a9983b4069ccf2622d3735dbd949ef704d04f7f84271c51c37305e43b941416cb331ac7b8e9d
-  data.tar.gz: bee8647cdaa28d0102de7b04ec20ee298ed4cdf6374acc54ed6195e130eabb6dfccedce6fb559b1e85415c6575b39a1219c8052a70ea02d40c8fe9d9eb1a13e3
+  metadata.gz: 12634a54049fc148d9426f8cd7a022f2e0f6cf4d126a4cbb69bd3427fe79e5aa973c56cc99eae40b77259bd37ea51e52c8fe87799c3b501a7c4b836f1ba2269d
+  data.tar.gz: 34828e2361372b547ff08e97840a70d96b4a9a328d60c60b7f1c019708af1fb1a3d3a20d5dc2623ceb53188dbf0d376c57255e3379f75359a0086e53ed9790df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.158.0)
+    seam (2.160.0)
       faraday (~> 2.7)
       faraday-retry (~> 2.2)
       svix (~> 1.30)
@@ -171,7 +171,7 @@ CHECKSUMS
   rubocop-ast (1.50.0) sha256=b9ca88300da0803ee222ad20cdb30494c0a784eed06fdc35d254b06d662788db
   rubocop-performance (1.26.1) sha256=cd19b936ff196df85829d264b522fd4f98b6c89ad271fa52744a8c11b8f71834
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
-  seam (2.158.0)
+  seam (2.160.0)
   simplecov (1.1.1) sha256=25825ef13f0b2e74694d769817dad6ab8e90131dabdaa666e522fea105521e78
   simplecov-console (0.9.5) sha256=b1108bcfff5f210143e2b8301698c367b01586f20d25a73e95475a5df6fc6ff6
   standard (1.56.0) sha256=ae2af4d9669589162ac69ed5ef59dcf9f346d4afc81f7e62b84339310dfcb787

data/lib/seam/resources/access_code.rb

@@ -248,12 +248,12 @@ module Seam
           date_accessor :created_at
         end
 
-        # This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and this error clears automatically once the access code is no longer active.
-        class FailedToRemove < Errors
+        # This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to delete it, and this error clears automatically once the access code is no longer active.
+        class FailedToDelete < Errors
           # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
           # @return [String]
           # Known values:
-          # - `failed_to_remove`
+          # - `failed_to_delete`
           attr_accessor :error_code
           # Indicates that this is an access code error.
           # @return [TrueClass]
@@ -546,7 +546,7 @@ module Seam
         # - `code_constraints_violated`
         # - `failed_to_issue`
         # - `failed_to_update`
-        # - `failed_to_remove`
+        # - `failed_to_delete`
         # - `account_disconnected`
         # - `salto_ks_subscription_limit_exceeded`
         # - `insufficient_permissions`
@@ -580,7 +580,7 @@ module Seam
           "code_constraints_violated" => CodeConstraintsViolated,
           "failed_to_issue" => FailedToIssue,
           "failed_to_update" => FailedToUpdate,
-          "failed_to_remove" => FailedToRemove,
+          "failed_to_delete" => FailedToDelete,
           "account_disconnected" => AccountDisconnected,
           "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
           "insufficient_permissions" => InsufficientPermissions,

data/lib/seam/resources/action_attempt.rb

@@ -1264,6 +1264,46 @@ module Seam
         attr_accessor :status
       end
 
+      # Activating the weekly program is pending.
+      class ActivateWeeklyProgram < ActionAttempt
+        class Error < BaseResource
+          # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+          # @return [String]
+          attr_accessor :message
+          # Type of the error.
+          # @return [String]
+          attr_accessor :type
+        end
+
+        class Result < BaseResource
+        end
+
+        # Error associated with the action.
+        # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
+        resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
+        # Result of the action.
+        # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
+        resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
+        # ID of the action attempt.
+        # @return [String]
+        attr_accessor :action_attempt_id
+        # Action attempt to track the status of returning a thermostat to its weekly program.
+        # @return [String]
+        # Known values:
+        # - `ACTIVATE_WEEKLY_PROGRAM`
+        attr_accessor :action_type
+        # @return [String]
+        # Known values:
+        # - `success`
+        # - `pending`
+        # - `error`
+        attr_accessor :status
+      end
+
       # Simulating a keypad code entry is pending.
       class SimulateKeypadCodeEntry < ActionAttempt
         class Error < BaseResource
@@ -1732,6 +1772,7 @@ module Seam
       # - `SET_FAN_MODE`
       # - `SET_HVAC_MODE`
       # - `ACTIVATE_CLIMATE_PRESET`
+      # - `ACTIVATE_WEEKLY_PROGRAM`
       # - `SIMULATE_KEYPAD_CODE_ENTRY`
       # - `SIMULATE_MANUAL_LOCK_VIA_KEYPAD`
       # - `PUSH_THERMOSTAT_PROGRAMS`
@@ -1762,6 +1803,7 @@ module Seam
         "SET_FAN_MODE" => SetFanMode,
         "SET_HVAC_MODE" => SetHvacMode,
         "ACTIVATE_CLIMATE_PRESET" => ActivateClimatePreset,
+        "ACTIVATE_WEEKLY_PROGRAM" => ActivateWeeklyProgram,
         "SIMULATE_KEYPAD_CODE_ENTRY" => SimulateKeypadCodeEntry,
         "SIMULATE_MANUAL_LOCK_VIA_KEYPAD" => SimulateManualLockViaKeypad,
         "PUSH_THERMOSTAT_PROGRAMS" => PushThermostatPrograms,

data/lib/seam/resources/device.rb

@@ -481,6 +481,24 @@ module Seam
           attr_accessor :time_zone
         end
 
+        class ArloMetadata < BaseResource
+          # Device ID reported by Arlo.
+          # @return [String, nil]
+          attr_accessor :device_id
+          # Device name reported by Arlo.
+          # @return [String, nil]
+          attr_accessor :device_name
+          # Firmware version reported by Arlo.
+          # @return [String, nil]
+          attr_accessor :firmware_version
+          # Hardware version reported by Arlo.
+          # @return [String, nil]
+          attr_accessor :hardware_version
+          # Model ID reported by Arlo.
+          # @return [String, nil]
+          attr_accessor :model_id
+        end
+
         class AssaAbloyVostioMetadata < BaseResource
           # Encoder name for an ASSA ABLOY Vostio system.
           # @return [String, nil]
@@ -1799,6 +1817,9 @@ module Seam
         # Metadata for an Aqara device.
         # @return [AqaraMetadata, nil]
         resource_accessor :aqara_metadata, AqaraMetadata
+        # Metadata for an Arlo camera.
+        # @return [ArloMetadata, nil]
+        resource_accessor :arlo_metadata, ArloMetadata
         # Metadata for an ASSA ABLOY Vostio system.
         # @return [AssaAbloyVostioMetadata, nil]
         resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
@@ -2638,6 +2659,9 @@ module Seam
       # Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
       # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
+      # Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set.
+      # @return [Boolean, nil]
+      attr_accessor :can_activate_weekly_program
       # Indicates whether the lock supports configuring automatic locking.
       # @return [Boolean, nil]
       attr_accessor :can_configure_auto_lock
@@ -2764,6 +2788,7 @@ module Seam
       # - `android_phone`
       # - `ring_camera`
       # - `tapo_camera`
+      # - `arlo_camera`
       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]

data/lib/seam/resources/device_provider.rb

@@ -3,6 +3,9 @@
 module Seam
   module Resources
     class DeviceProvider < BaseResource
+      # Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set.
+      # @return [Boolean, nil]
+      attr_accessor :can_activate_weekly_program
       # Indicates whether the lock supports configuring automatic locking.
       # @return [Boolean, nil]
       attr_accessor :can_configure_auto_lock
@@ -124,6 +127,7 @@ module Seam
       # - `thirty_three_lock`
       # - `ring`
       # - `tapo`
+      # - `arlo`
       # - `ical`
       # - `lodgify`
       # - `hostaway`

data/lib/seam/resources/event.rb

@@ -5092,7 +5092,7 @@ module Seam
       # - `access_code.delay_in_issuing`
       # - `access_code.failed_to_issue`
       # - `access_code.failed_to_update`
-      # - `access_code.failed_to_remove`
+      # - `access_code.failed_to_delete`
       # - `access_code.deleted`
       # - `access_code.delay_in_removing_from_device`
       # - `access_code.failed_to_remove_from_device`

data/lib/seam/resources/unmanaged_access_code.rb

@@ -250,12 +250,12 @@ module Seam
           date_accessor :created_at
         end
 
-        # This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and this error clears automatically once the access code is no longer active.
-        class FailedToRemove < Errors
+        # This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to delete it, and this error clears automatically once the access code is no longer active.
+        class FailedToDelete < Errors
           # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
           # @return [String]
           # Known values:
-          # - `failed_to_remove`
+          # - `failed_to_delete`
           attr_accessor :error_code
           # Indicates that this is an access code error.
           # @return [TrueClass]
@@ -548,7 +548,7 @@ module Seam
         # - `code_constraints_violated`
         # - `failed_to_issue`
         # - `failed_to_update`
-        # - `failed_to_remove`
+        # - `failed_to_delete`
         # - `account_disconnected`
         # - `salto_ks_subscription_limit_exceeded`
         # - `insufficient_permissions`
@@ -582,7 +582,7 @@ module Seam
           "code_constraints_violated" => CodeConstraintsViolated,
           "failed_to_issue" => FailedToIssue,
           "failed_to_update" => FailedToUpdate,
-          "failed_to_remove" => FailedToRemove,
+          "failed_to_delete" => FailedToDelete,
           "account_disconnected" => AccountDisconnected,
           "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
           "insufficient_permissions" => InsufficientPermissions,

data/lib/seam/resources/unmanaged_device.rb

@@ -934,6 +934,9 @@ module Seam
       # Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
       # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
+      # Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set.
+      # @return [Boolean, nil]
+      attr_accessor :can_activate_weekly_program
       # Indicates whether the lock supports configuring automatic locking.
       # @return [Boolean, nil]
       attr_accessor :can_configure_auto_lock
@@ -1060,6 +1063,7 @@ module Seam
       # - `android_phone`
       # - `ring_camera`
       # - `tapo_camera`
+      # - `arlo_camera`
       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]

data/lib/seam/routes/thermostats.rb

@@ -34,6 +34,17 @@ module Seam
         Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Returns a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to its [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs), the schedule that is configured on the device itself, releasing any hold that Seam has set. Seam stops managing the thermostat's climate until you [activate a climate preset](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings), make a direct climate setting change, or one of the thermostat's [scheduled](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) presets reaches its activation time.
+      # @param device_id [String] ID of the thermostat device that you want to return to its weekly program.
+      # @return [Seam::Resources::ActionAttempt] OK
+      def activate_weekly_program(device_id:, wait_for_action_attempt: nil)
+        res = @client.post("/thermostats/activate_weekly_program", {device_id: device_id}.compact)
+
+        wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
+
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+      end
+
       # Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
       # @param device_id [String] ID of the thermostat device that you want to set to cool mode.
       # @param cooling_set_point_celsius [Float, nil] [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.

data/lib/seam/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seam
 version: !ruby/object:Gem::Version
-  version: 2.158.0
+  version: 2.160.0
 platform: ruby
 authors:
 - Seam Labs, Inc.