seam 2.141.2 → 2.142.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74daae0b262e03490e0317f9b90fa9c117834a99ebce0e1e32b7c020f05bc7cd
-  data.tar.gz: 56c57316a19a5e4bcbd2381ac9dce3b3c84ed58d060096e8cf323b4588862f8b
+  metadata.gz: f8e9429cc66f5767d44b6d409f85a5dfa2f07d5f7af369eb20f1b2690ecb14ee
+  data.tar.gz: ecd20ffb6213341e419d9b9ae27abe1a783d7d8ced2ee33d2fe2a86d1606df69
 SHA512:
-  metadata.gz: e822df4248a29c5d4ee8ea3eeab2e3d19c4c33eba33f088268df9a815f6c712a95d4b12520226eef849bd32fec3c873adfbcbcc63c786bd72cc8a404d74324b2
-  data.tar.gz: 93db379056b0471a97aff42553b8a25011019b1d5832bd69b8e3fac8471f71fa291dddbdde4de5eb1ddbd6a53bf08bfa609cb6674f6894be2b89d89076f89ef6
+  metadata.gz: 59dc939e24445cc86e826a2e6287a48c5c5d1732aed9fdbe8428742de74476e228a67335e807faf3bae068c7d6a2074983838285f46a58f3cd09391de26532c8
+  data.tar.gz: 9adaf12116c5d351651cd8f9d7b513b352a1440336e05c64fed92b370ae49223bc725e4474854af9f9a86855526ef863da0f52331032d6a10b1bd7a587a9efe2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.141.2)
+    seam (2.142.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.141.2)
+  seam (2.142.0)
   simplecov (1.1.1) sha256=25825ef13f0b2e74694d769817dad6ab8e90131dabdaa666e522fea105521e78
   simplecov-console (0.9.5) sha256=b1108bcfff5f210143e2b8301698c367b01586f20d25a73e95475a5df6fc6ff6
   standard (1.56.0) sha256=ae2af4d9669589162ac69ed5ef59dcf9f346d4afc81f7e62b84339310dfcb787

data/README.md

@@ -14,7 +14,9 @@ Please refer to the official [Seam Docs](https://docs.seam.co/latest/) to get st
 Parts of this SDK are generated from always up-to-date type information
 provided by [@seamapi/types](https://github.com/seamapi/types/).
 This ensures all API methods, request shapes, and response shapes are
-accurate and fully typed.
+accurate and fully typed. Ruby cannot statically enforce literal booleans, so
+the generated YARD types use `TrueClass` and `FalseClass` to document singleton
+constraints.
 
 <!-- toc -->
 

data/lib/seam/resources/access_code.rb

@@ -62,7 +62,7 @@ module Seam
         # @return [String]
         attr_accessor :error_code
         # Indicates that this is an access code error.
-        # @return [Boolean]
+        # @return [TrueClass]
         attr_accessor :is_access_code_error
         # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
         # @return [Boolean, nil]
@@ -197,7 +197,7 @@ module Seam
       # @return [Boolean]
       attr_accessor :is_external_modification_allowed
       # Indicates whether Seam manages the access code.
-      # @return [Boolean]
+      # @return [TrueClass]
       attr_accessor :is_managed
       # Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.
       # @return [Boolean]

data/lib/seam/resources/acs_access_group.rb

@@ -135,7 +135,7 @@ module Seam
       # @return [String]
       attr_accessor :external_type_display_name
       # Indicates whether Seam manages the access group.
-      # @return [Boolean]
+      # @return [TrueClass]
       attr_accessor :is_managed
       # Name of the access group.
       # @return [String]

data/lib/seam/resources/acs_credential.rb

@@ -150,7 +150,7 @@ module Seam
       # @return [Boolean, nil]
       attr_accessor :is_latest_desired_state_synced_with_provider
       # Indicates whether Seam manages the credential.
-      # @return [Boolean]
+      # @return [TrueClass]
       attr_accessor :is_managed
       # Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
       # @return [Boolean, nil]

data/lib/seam/resources/acs_user.rb

@@ -179,7 +179,7 @@ module Seam
       # @return [String, nil]
       attr_accessor :hid_acs_system_id
       # Indicates whether Seam manages the access system user.
-      # @return [Boolean]
+      # @return [TrueClass]
       attr_accessor :is_managed
       # Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).
       # @return [Boolean, nil]

data/lib/seam/resources/device.rb

@@ -1004,7 +1004,7 @@ module Seam
           # @return [String, nil]
           attr_accessor :end_date_recurrence_rule
           # When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
-          # @return [Boolean, nil]
+          # @return [TrueClass, nil]
           attr_accessor :matching_start_end_time
           # Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
           # @return [String, nil]
@@ -1043,7 +1043,7 @@ module Seam
           # @return [String, nil]
           attr_accessor :end_date_recurrence_rule
           # When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.
-          # @return [Boolean, nil]
+          # @return [TrueClass, nil]
           attr_accessor :matching_start_end_time
           # Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.
           # @return [String, nil]
@@ -1796,7 +1796,7 @@ module Seam
       # @return [String]
       attr_accessor :display_name
       # Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
-      # @return [Boolean]
+      # @return [TrueClass]
       attr_accessor :is_managed
       # Optional nickname to describe the device, settable through Seam.
       # @return [String, nil]

data/lib/seam/resources/unmanaged_access_code.rb

@@ -64,7 +64,7 @@ module Seam
         # @return [String]
         attr_accessor :error_code
         # Indicates that this is an access code error.
-        # @return [Boolean]
+        # @return [TrueClass]
         attr_accessor :is_access_code_error
         # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
         # @return [Boolean, nil]
@@ -130,10 +130,10 @@ module Seam
       # @return [String]
       attr_accessor :access_code_id
       # Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.
-      # @return [Boolean, nil]
+      # @return [TrueClass, nil]
       attr_accessor :cannot_be_managed
       # Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.
-      # @return [Boolean, nil]
+      # @return [TrueClass, nil]
       attr_accessor :cannot_delete_unmanaged_access_code
       # Code used for access. Typically, a numeric or alphanumeric string.
       # @return [String, nil]
@@ -142,7 +142,7 @@ module Seam
       # @return [String]
       attr_accessor :device_id
       # Indicates that Seam does not manage the access code.
-      # @return [Boolean]
+      # @return [FalseClass]
       attr_accessor :is_managed
       # Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
       # @return [String, nil]

data/lib/seam/resources/unmanaged_device.rb

@@ -231,7 +231,7 @@ module Seam
       # @return [String]
       attr_accessor :device_type
       # Indicates that Seam does not manage the device.
-      # @return [Boolean]
+      # @return [FalseClass]
       attr_accessor :is_managed
       # Unique identifier for the Seam workspace associated with the device.
       # @return [String]

data/lib/seam/routes/access_grants_unmanaged.rb

@@ -37,7 +37,7 @@ module Seam
       #
       # When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.
       # @param access_grant_id [String] ID of the unmanaged Access Grant to update.
-      # @param is_managed [Boolean] Must be set to true to convert the unmanaged access grant to managed.
+      # @param is_managed [TrueClass] Must be set to true to convert the unmanaged access grant to managed.
       # @param access_grant_key [String, nil] Unique key for the access grant. If not provided, the existing key will be preserved.
       # @return [nil] OK
       def update(access_grant_id:, is_managed:, access_grant_key: nil)

data/lib/seam/routes/devices_unmanaged.rb

@@ -53,7 +53,7 @@ module Seam
       # An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
       # @param device_id [String] ID of the unmanaged device that you want to update.
       # @param custom_metadata [Hash, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.
-      # @param is_managed [Boolean, nil] Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.
+      # @param is_managed [TrueClass, nil] Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.
       # @return [nil] OK
       def update(device_id:, custom_metadata: nil, is_managed: nil)
         @client.patch("/devices/unmanaged/update", {device_id: device_id, custom_metadata: custom_metadata, is_managed: is_managed}.compact)

data/lib/seam/routes/user_identities_unmanaged.rb

@@ -32,7 +32,7 @@ module Seam
       # Updates an unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.
       #
       # This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.
-      # @param is_managed [Boolean] Must be set to true to convert the unmanaged user identity to managed.
+      # @param is_managed [TrueClass] Must be set to true to convert the unmanaged user identity to managed.
       # @param user_identity_id [String] ID of the unmanaged user identity that you want to update.
       # @param user_identity_key [String, nil] Unique key for the user identity. If not provided, the existing key will be preserved.
       # @return [nil] OK

data/lib/seam/version.rb

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

metadata

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