seam 2.163.0 → 2.165.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '022132618ebc3f3a0f2e87d0da9b4a2828cdd1cbe909102476566f4bc628cc4e'
-  data.tar.gz: e941ead73232338993a765c5debd07954951a7d53358070d8605bef50791bf4f
+  metadata.gz: '0728def14eca9e4d20afc7b4b6c8d6a312f6369058f1a1ffb39912223af2090d'
+  data.tar.gz: 2fe687ec9d2b0e01b5bfff64abcd2bd162ade8f4d014754dc01acda67eae9334
 SHA512:
-  metadata.gz: 4281355eb3fe9a3ea175d777eb7f221bd9f56d208867bc02d5de3ba4c66a09e207af356984f09e0224a924bffe5f17470c35db56f82334afc16efd0043fff4e4
-  data.tar.gz: d6d7887c567584108811221a7f4dd8661465735913d5636e868908464caa1672e00d1ce48394fead2e61c179d4d53059cc33161990e2cbc894fb21f9eedcc2f2
+  metadata.gz: 74524876fa1bc0ca169ac6fdacc094eb06d2479da4865ec6b0150054f9ee243064b649193c4ab2080eba422ee33e469496fd413de94d025f330003439d85e6c1
+  data.tar.gz: 5334fa180093c7f8ba841e8c165bac6b711a7277f330d2eaa472ecb08a0e910388a4f8cd2c38046de359f78fb2095befc806629f6e6c64d2031fe981f6ddb472

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.163.0)
+    seam (2.165.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.163.0)
+  seam (2.165.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_grant.rb

@@ -24,10 +24,26 @@ module Seam
           date_accessor :created_at
         end
 
+        # Indicates that the access system rejected the access that Seam tried to set up for this access grant, so its credentials cannot open the affected entrances. For example, a hotel room may already be reserved or checked in for another guest. The message contains the reason that the access system gave. Seam keeps retrying, and this error clears automatically once the access system accepts the access.
+        class AccessNotProvisioned < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `access_not_provisioned`
+          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
+
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         # @return [String]
         # Known values:
         # - `cannot_create_requested_access_methods`
+        # - `access_not_provisioned`
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
@@ -37,7 +53,8 @@ module Seam
         date_accessor :created_at
 
         discriminated_by :error_code, {
-          "cannot_create_requested_access_methods" => CannotCreateRequestedAccessMethods
+          "cannot_create_requested_access_methods" => CannotCreateRequestedAccessMethods,
+          "access_not_provisioned" => AccessNotProvisioned
         }.freeze
       end
 
@@ -152,8 +169,10 @@ module Seam
             # Device whose access code could not be revoked.
             # @return [String]
             attr_accessor :device_id
-            # Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).
+            # Reason the access code could not be revoked.
             # @return [String]
+            # Known values:
+            # - `offline_access_code_not_revocable`
             attr_accessor :error_code
             # Human-readable description of why revocation failed.
             # @return [String]

data/lib/seam/resources/access_method.rb

@@ -21,10 +21,26 @@ module Seam
           date_accessor :created_at
         end
 
+        # Indicates that the access system rejected the access that Seam tried to set up for this access method, so its credential cannot open the affected entrances, even after it is issued. For example, a hotel room may already be reserved or checked in for another guest. The message contains the reason that the access system gave. Seam keeps retrying, and this error clears automatically once the access system accepts the access.
+        class AccessNotProvisioned < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `access_not_provisioned`
+          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
+
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         # @return [String]
         # Known values:
         # - `failed_to_issue`
+        # - `access_not_provisioned`
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
@@ -34,7 +50,8 @@ module Seam
         date_accessor :created_at
 
         discriminated_by :error_code, {
-          "failed_to_issue" => FailedToIssue
+          "failed_to_issue" => FailedToIssue,
+          "access_not_provisioned" => AccessNotProvisioned
         }.freeze
       end
 
@@ -241,7 +258,7 @@ module Seam
       # Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
       # @return [Boolean, nil]
       attr_accessor :is_ready_for_assignment
-      # Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
+      # Indicates whether the access method is ready to be encoded. This is true when the card has not yet been issued and the access system has received all the access the card needs. While it is false, `pending_mutations` contains `waiting_for_access_on_acs_system`.
       # @return [Boolean, nil]
       attr_accessor :is_ready_for_encoding
       # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.

data/lib/seam/resources/acs_entrance.rb

@@ -101,9 +101,27 @@ module Seam
         attr_accessor :access_point_profile
       end
 
+      # Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
       class Errors < BaseResource
+        # Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.
+        class EntranceRemoved < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `entrance_removed`
+          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
+
         # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         # @return [String]
+        # Known values:
+        # - `entrance_removed`
         attr_accessor :error_code
         # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         # @return [String]
@@ -111,6 +129,10 @@ module Seam
         # Date and time at which Seam created the error.
         # @return [Time]
         date_accessor :created_at
+
+        discriminated_by :error_code, {
+          "entrance_removed" => EntranceRemoved
+        }.freeze
       end
 
       class HotekMetadata < BaseResource

data/lib/seam/resources/acs_system.rb

@@ -78,6 +78,21 @@ module Seam
           date_accessor :created_at
         end
 
+        # Indicates that the access control system has reached the maximum number of users its license allows, so Seam cannot create new users on it and access for new guests is not provisioned. Remove unused users from the access control system or increase its license. The error clears once Seam can create users again.
+        class UserLicenseLimitReached < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `user_license_limit_reached`
+          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
+
         # Indicates that the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is not letting Seam act on it, so access cannot be managed until this is resolved. The error message says which of two causes applies. Either Seam's integration user does not have sufficient permissions on the provider's system, or has been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. Or the provider account or site does not have a valid subscription with the provider: set up or renew that subscription with the provider.
         class InsufficientPermissions < Errors
           # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -160,6 +175,7 @@ module Seam
         # - `bridge_disconnected`
         # - `visionline_instance_unreachable`
         # - `salto_ks_subscription_limit_exceeded`
+        # - `user_license_limit_reached`
         # - `insufficient_permissions`
         # - `acs_system_disconnected`
         # - `account_disconnected`
@@ -178,6 +194,7 @@ module Seam
           "bridge_disconnected" => BridgeDisconnected,
           "visionline_instance_unreachable" => VisionlineInstanceUnreachable,
           "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
+          "user_license_limit_reached" => UserLicenseLimitReached,
           "insufficient_permissions" => InsufficientPermissions,
           "acs_system_disconnected" => AcsSystemDisconnected,
           "account_disconnected" => AccountDisconnected,

data/lib/seam/resources/action_attempt.rb

@@ -944,6 +944,7 @@ module Seam
             # @return [String]
             # Known values:
             # - `failed_to_issue`
+            # - `access_not_provisioned`
             attr_accessor :error_code
             # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
             # @return [String]
@@ -973,20 +974,21 @@ module Seam
             end
 
             # Previous access time configuration.
-            # @return [From]
+            # @return [From, nil]
             resource_accessor :from, From
             # New access time configuration.
-            # @return [To]
+            # @return [To, nil]
             resource_accessor :to, To
             # Detailed description of the mutation.
             # @return [String]
             attr_accessor :message
-            # Mutation code to indicate that Seam is in the process of updating the access times for this access method.
+            # Mutation code to indicate that the access system has not yet received all the access this card needs, so the card is not ready to be encoded.
             # @return [String]
             # Known values:
             # - `provisioning_access`
             # - `revoking_access`
             # - `updating_access_times`
+            # - `waiting_for_access_on_acs_system`
             attr_accessor :mutation_code
             # Date and time at which the mutation was created.
             # @return [Time]
@@ -1057,7 +1059,7 @@ module Seam
           # Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
           # @return [Boolean, nil]
           attr_accessor :is_ready_for_assignment
-          # Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
+          # Indicates whether the access method is ready to be encoded. This is true when the card has not yet been issued and the access system has received all the access the card needs. While it is false, `pending_mutations` contains `waiting_for_access_on_acs_system`.
           # @return [Boolean, nil]
           attr_accessor :is_ready_for_encoding
           # Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
@@ -1464,6 +1466,252 @@ module Seam
         attr_accessor :status
       end
 
+      # Converting an unmanaged access code to managed is pending.
+      class ConvertAccessCodeToManaged < 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 converting an unmanaged access code to a managed access code.
+        # @return [String]
+        # Known values:
+        # - `CONVERT_ACCESS_CODE_TO_MANAGED`
+        attr_accessor :action_type
+        # @return [String]
+        # Known values:
+        # - `success`
+        # - `pending`
+        # - `error`
+        attr_accessor :status
+      end
+
+      # Setting the speaker volume is pending.
+      class SetSpeakerVolume < 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 setting the volume on a speaker.
+        # @return [String]
+        # Known values:
+        # - `SET_SPEAKER_VOLUME`
+        attr_accessor :action_type
+        # @return [String]
+        # Known values:
+        # - `success`
+        # - `pending`
+        # - `error`
+        attr_accessor :status
+      end
+
+      # Muting or unmuting the speaker is pending.
+      class SetSpeakerMute < 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 muting or unmuting a speaker.
+        # @return [String]
+        # Known values:
+        # - `SET_SPEAKER_MUTE`
+        attr_accessor :action_type
+        # @return [String]
+        # Known values:
+        # - `success`
+        # - `pending`
+        # - `error`
+        attr_accessor :status
+      end
+
+      # Pausing playback on the speaker is pending.
+      class PauseSpeakerPlayback < 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
+          # IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.
+          # @return [Array<String>]
+          attr_accessor :affected_device_ids
+        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 pausing playback on a speaker.
+        # @return [String]
+        # Known values:
+        # - `PAUSE_SPEAKER_PLAYBACK`
+        attr_accessor :action_type
+        # @return [String]
+        # Known values:
+        # - `success`
+        # - `pending`
+        # - `error`
+        attr_accessor :status
+      end
+
+      # Resuming playback on the speaker is pending.
+      class ResumeSpeakerPlayback < 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
+          # IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.
+          # @return [Array<String>]
+          attr_accessor :affected_device_ids
+        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 resuming playback on a speaker.
+        # @return [String]
+        # Known values:
+        # - `RESUME_SPEAKER_PLAYBACK`
+        attr_accessor :action_type
+        # @return [String]
+        # Known values:
+        # - `success`
+        # - `pending`
+        # - `error`
+        attr_accessor :status
+      end
+
+      # Playing a chime on the speaker is pending.
+      class PlaySpeakerChime < 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 playing a chime on a speaker.
+        # @return [String]
+        # Known values:
+        # - `PLAY_SPEAKER_CHIME`
+        attr_accessor :action_type
+        # @return [String]
+        # Known values:
+        # - `success`
+        # - `pending`
+        # - `error`
+        attr_accessor :status
+      end
+
       class SyncAccessCodes < ActionAttempt
         class Error < BaseResource
           # Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -1777,6 +2025,12 @@ module Seam
       # - `SIMULATE_MANUAL_LOCK_VIA_KEYPAD`
       # - `PUSH_THERMOSTAT_PROGRAMS`
       # - `CONFIGURE_AUTO_LOCK`
+      # - `CONVERT_ACCESS_CODE_TO_MANAGED`
+      # - `SET_SPEAKER_VOLUME`
+      # - `SET_SPEAKER_MUTE`
+      # - `PAUSE_SPEAKER_PLAYBACK`
+      # - `RESUME_SPEAKER_PLAYBACK`
+      # - `PLAY_SPEAKER_CHIME`
       # - `SYNC_ACCESS_CODES`
       # - `CREATE_ACCESS_CODE`
       # - `DELETE_ACCESS_CODE`
@@ -1808,6 +2062,12 @@ module Seam
         "SIMULATE_MANUAL_LOCK_VIA_KEYPAD" => SimulateManualLockViaKeypad,
         "PUSH_THERMOSTAT_PROGRAMS" => PushThermostatPrograms,
         "CONFIGURE_AUTO_LOCK" => ConfigureAutoLock,
+        "CONVERT_ACCESS_CODE_TO_MANAGED" => ConvertAccessCodeToManaged,
+        "SET_SPEAKER_VOLUME" => SetSpeakerVolume,
+        "SET_SPEAKER_MUTE" => SetSpeakerMute,
+        "PAUSE_SPEAKER_PLAYBACK" => PauseSpeakerPlayback,
+        "RESUME_SPEAKER_PLAYBACK" => ResumeSpeakerPlayback,
+        "PLAY_SPEAKER_CHIME" => PlaySpeakerChime,
         "SYNC_ACCESS_CODES" => SyncAccessCodes,
         "CREATE_ACCESS_CODE" => CreateAccessCode,
         "DELETE_ACCESS_CODE" => DeleteAccessCode,

data/lib/seam/resources/connect_webview.rb

@@ -22,6 +22,7 @@ module Seam
       # - `noise_sensor`
       # - `access_control`
       # - `camera`
+      # - `speaker`
       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<String>]

data/lib/seam/resources/connected_account.rb

@@ -355,6 +355,7 @@ module Seam
       # - `noise_sensor`
       # - `access_control`
       # - `camera`
+      # - `speaker`
       attr_accessor :accepted_capabilities
       # Type of connected account.
       # @return [String, nil]