seam 2.146.0 → 2.148.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a45352597670141b7fcf4d8043acf833a4019e97523ac004acdf9a24d140d3ad
-  data.tar.gz: cb4cf04a8b07d629f763f56b4f676150b431342abd6ad7365abfb64585af478a
+  metadata.gz: '06196d87a7db7cb6f396e2ce2f94f02d9dfb2c2eecff52fa314df6d95856ff57'
+  data.tar.gz: f7be00a016e5c13fc8e937595b80302453ae8625d27df6a0541d1eacf5b3504e
 SHA512:
-  metadata.gz: 56fca9672c6ccd40f33ce7773ca672f3c4910885b396eb2b9b3d3c7d251821ecb694c47ebb940a1c39f1bcfa1324cd7a2dca7151aaa3ca244e32da6fa57bfabe
-  data.tar.gz: 67313f9ffa5d35fe509944ed85c7c2f072480aedc62d48984ef2a656d150b6d11d5281d5721c270027b8ebc5e6646d2fde62ce918c228a43034f4649420710d6
+  metadata.gz: 68f7a956b71ae32046af99e15b612d1fa1ac4a689539dadf795776bdd873ea5bd4ed7ace6105f17678c760184567a02bd5b6d472d0c536ab19eba4fa3e45f655
+  data.tar.gz: 66906c6e6172416dc861bb7dc71b6e51a49baba23331b4ddc5d0ef1fa6f677fa13841bd913a6c2537cfbc00eaf74e9700f14cef44907efbff213960836ac5b75

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.146.0)
+    seam (2.148.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.146.0)
+  seam (2.148.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

@@ -212,6 +212,60 @@ module Seam
           date_accessor :created_at
         end
 
+        # Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.
+        class FailedToIssue < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_issue`
+          attr_accessor :error_code
+          # Indicates that this is an access code error.
+          # @return [TrueClass]
+          attr_accessor :is_access_code_error
+          # 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, nil]
+          date_accessor :created_at
+        end
+
+        # Seam was unable to apply this access code's requested update to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the update is applied.
+        class FailedToUpdate < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_update`
+          attr_accessor :error_code
+          # Indicates that this is an access code error.
+          # @return [TrueClass]
+          attr_accessor :is_access_code_error
+          # 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, nil]
+          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 FailedToExpire < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_expire`
+          attr_accessor :error_code
+          # Indicates that this is an access code error.
+          # @return [TrueClass]
+          attr_accessor :is_access_code_error
+          # 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, nil]
+          date_accessor :created_at
+        end
+
         # Indicates that the account is disconnected.
         class AccountDisconnected < Errors
           # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -490,6 +544,9 @@ module Seam
         # - `conflicting_external_modification`
         # - `access_code_inactive`
         # - `code_constraints_violated`
+        # - `failed_to_issue`
+        # - `failed_to_update`
+        # - `failed_to_expire`
         # - `account_disconnected`
         # - `salto_ks_subscription_limit_exceeded`
         # - `insufficient_permissions`
@@ -521,6 +578,9 @@ module Seam
           "conflicting_external_modification" => ConflictingExternalModification,
           "access_code_inactive" => AccessCodeInactive,
           "code_constraints_violated" => CodeConstraintsViolated,
+          "failed_to_issue" => FailedToIssue,
+          "failed_to_update" => FailedToUpdate,
+          "failed_to_expire" => FailedToExpire,
           "account_disconnected" => AccountDisconnected,
           "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
           "insufficient_permissions" => InsufficientPermissions,
@@ -686,6 +746,21 @@ module Seam
           date_accessor :created_at
         end
 
+        # Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
+        class DelayInIssuing < 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:
+          # - `delay_in_issuing`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time, nil]
+          date_accessor :created_at
+        end
+
         # Third-party integration detected that may cause access codes to fail.
         class ThirdPartyIntegrationDetected < Warnings
           # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
@@ -787,6 +862,7 @@ module Seam
         # - `external_modification_in_effect`
         # - `delay_in_setting_on_device`
         # - `delay_in_removing_from_device`
+        # - `delay_in_issuing`
         # - `third_party_integration_detected`
         # - `igloo_algopin_must_be_used_within_24_hours`
         # - `management_transferred`
@@ -804,6 +880,7 @@ module Seam
           "external_modification_in_effect" => ExternalModificationInEffect,
           "delay_in_setting_on_device" => DelayInSettingOnDevice,
           "delay_in_removing_from_device" => DelayInRemovingFromDevice,
+          "delay_in_issuing" => DelayInIssuing,
           "third_party_integration_detected" => ThirdPartyIntegrationDetected,
           "igloo_algopin_must_be_used_within_24_hours" => IglooAlgopinMustBeUsedWithinN24Hours,
           "management_transferred" => ManagementTransferred,

data/lib/seam/resources/access_grant.rb

@@ -320,7 +320,7 @@ module Seam
       # Display name of the Access Grant.
       # @return [String]
       attr_accessor :display_name
-      # Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields.
+      # Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields.
       # @return [String]
       attr_accessor :display_status
       # Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.

data/lib/seam/resources/device.rb

@@ -1083,9 +1083,6 @@ module Seam
           # Set to true when the device does not support the /dual-setpoints API endpoint.
           # @return [Boolean, nil]
           attr_accessor :dual_setpoints_not_supported
-          # Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
-          # @return [Array<Float>]
-          attr_accessor :enforced_setpoint_range_celsius
           # Product type for a Sensi device.
           # @return [String, nil]
           attr_accessor :product_type
@@ -2458,6 +2455,21 @@ module Seam
           date_accessor :created_at
         end
 
+        # Indicates that the accessory keypad paired with this lock has a low or critically low battery. Replace its batteries so guests can keep entering their access codes.
+        class AccessoryKeypadLowBattery < 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:
+          # - `accessory_keypad_low_battery`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
         # Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.
         class UnreliableOnlineStatus < Warnings
           # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
@@ -2525,6 +2537,7 @@ module Seam
         # - `provider_issue`
         # - `keynest_unsupported_locker`
         # - `accessory_keypad_setup_required`
+        # - `accessory_keypad_low_battery`
         # - `unreliable_online_status`
         # - `max_access_codes_reached`
         attr_accessor :warning_code
@@ -2558,6 +2571,7 @@ module Seam
           "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
         }.freeze

data/lib/seam/resources/event.rb

@@ -3481,8 +3481,12 @@ module Seam
 
       # A device battery level dropped below the low threshold.
       class DeviceLowBattery < SeamEvent
-        # Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.
+        # 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]
@@ -3493,6 +3497,9 @@ module Seam
         # The customer key associated with the device, if any.
         # @return [String, nil]
         attr_accessor :customer_key
+        # Number in the range 0 to 1.0 indicating the affected device's own battery level, when known.
+        # @return [Float, nil]
+        attr_accessor :device_battery_level
         # Custom metadata of the device, present when device_id is provided.
         # @return [Hash{String => String, Boolean}, nil]
         attr_accessor :device_custom_metadata
@@ -5079,6 +5086,11 @@ module Seam
       # - `access_code.removed_from_device`
       # - `access_code.delay_in_setting_on_device`
       # - `access_code.failed_to_set_on_device`
+      # - `access_code.issued`
+      # - `access_code.delay_in_issuing`
+      # - `access_code.failed_to_issue`
+      # - `access_code.failed_to_update`
+      # - `access_code.failed_to_expire`
       # - `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

@@ -214,6 +214,60 @@ module Seam
           date_accessor :created_at
         end
 
+        # Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.
+        class FailedToIssue < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_issue`
+          attr_accessor :error_code
+          # Indicates that this is an access code error.
+          # @return [TrueClass]
+          attr_accessor :is_access_code_error
+          # 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, nil]
+          date_accessor :created_at
+        end
+
+        # Seam was unable to apply this access code's requested update to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the update is applied.
+        class FailedToUpdate < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_update`
+          attr_accessor :error_code
+          # Indicates that this is an access code error.
+          # @return [TrueClass]
+          attr_accessor :is_access_code_error
+          # 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, nil]
+          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 FailedToExpire < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `failed_to_expire`
+          attr_accessor :error_code
+          # Indicates that this is an access code error.
+          # @return [TrueClass]
+          attr_accessor :is_access_code_error
+          # 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, nil]
+          date_accessor :created_at
+        end
+
         # Indicates that the account is disconnected.
         class AccountDisconnected < Errors
           # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -492,6 +546,9 @@ module Seam
         # - `conflicting_external_modification`
         # - `access_code_inactive`
         # - `code_constraints_violated`
+        # - `failed_to_issue`
+        # - `failed_to_update`
+        # - `failed_to_expire`
         # - `account_disconnected`
         # - `salto_ks_subscription_limit_exceeded`
         # - `insufficient_permissions`
@@ -523,6 +580,9 @@ module Seam
           "conflicting_external_modification" => ConflictingExternalModification,
           "access_code_inactive" => AccessCodeInactive,
           "code_constraints_violated" => CodeConstraintsViolated,
+          "failed_to_issue" => FailedToIssue,
+          "failed_to_update" => FailedToUpdate,
+          "failed_to_expire" => FailedToExpire,
           "account_disconnected" => AccountDisconnected,
           "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
           "insufficient_permissions" => InsufficientPermissions,
@@ -638,6 +698,21 @@ module Seam
           date_accessor :created_at
         end
 
+        # Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
+        class DelayInIssuing < 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:
+          # - `delay_in_issuing`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time, nil]
+          date_accessor :created_at
+        end
+
         # Third-party integration detected that may cause access codes to fail.
         class ThirdPartyIntegrationDetected < Warnings
           # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
@@ -739,6 +814,7 @@ module Seam
         # - `external_modification_in_effect`
         # - `delay_in_setting_on_device`
         # - `delay_in_removing_from_device`
+        # - `delay_in_issuing`
         # - `third_party_integration_detected`
         # - `igloo_algopin_must_be_used_within_24_hours`
         # - `management_transferred`
@@ -756,6 +832,7 @@ module Seam
           "external_modification_in_effect" => ExternalModificationInEffect,
           "delay_in_setting_on_device" => DelayInSettingOnDevice,
           "delay_in_removing_from_device" => DelayInRemovingFromDevice,
+          "delay_in_issuing" => DelayInIssuing,
           "third_party_integration_detected" => ThirdPartyIntegrationDetected,
           "igloo_algopin_must_be_used_within_24_hours" => IglooAlgopinMustBeUsedWithinN24Hours,
           "management_transferred" => ManagementTransferred,

data/lib/seam/resources/unmanaged_device.rb

@@ -800,6 +800,21 @@ module Seam
           date_accessor :created_at
         end
 
+        # Indicates that the accessory keypad paired with this lock has a low or critically low battery. Replace its batteries so guests can keep entering their access codes.
+        class AccessoryKeypadLowBattery < 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:
+          # - `accessory_keypad_low_battery`
+          attr_accessor :warning_code
+          # Date and time at which Seam created the warning.
+          # @return [Time]
+          date_accessor :created_at
+        end
+
         # Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.
         class UnreliableOnlineStatus < Warnings
           # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
@@ -867,6 +882,7 @@ module Seam
         # - `provider_issue`
         # - `keynest_unsupported_locker`
         # - `accessory_keypad_setup_required`
+        # - `accessory_keypad_low_battery`
         # - `unreliable_online_status`
         # - `max_access_codes_reached`
         attr_accessor :warning_code
@@ -900,6 +916,7 @@ module Seam
           "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
         }.freeze
@@ -1043,6 +1060,9 @@ module Seam
       # - `android_phone`
       # - `ring_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]
+      attr_accessor :display_name
       # Indicates that Seam does not manage the device.
       # @return [FalseClass]
       attr_accessor :is_managed

data/lib/seam/resources/workspace.rb

@@ -29,9 +29,10 @@ module Seam
       resource_accessor :connect_webview_customization, ConnectWebviewCustomization
       # Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces).
       # @return [String]
+      # @deprecated Use `connect_partner_name` instead.
       attr_accessor :company_name
+      # Seam Connect partner name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces).
       # @return [String, nil]
-      # @deprecated Use `company_name` instead.
       attr_accessor :connect_partner_name
       # Indicates whether publishable key authentication is enabled for this workspace.
       # @return [Boolean]

data/lib/seam/routes/access_codes.rb

@@ -196,7 +196,7 @@ module Seam
       # @param type [String, nil] Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
       # @return [nil] OK
       def update(access_code_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, device_id: nil, ends_at: nil, is_external_modification_allowed: nil, is_managed: nil, name: nil, starts_at: nil, type: nil)
-        @client.put("/access_codes/update", {access_code_id: access_code_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, device_id: device_id, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_managed: is_managed, name: name, starts_at: starts_at, type: type}.compact)
+        @client.patch("/access_codes/update", {access_code_id: access_code_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, device_id: device_id, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_managed: is_managed, name: name, starts_at: starts_at, type: type}.compact)
 
         nil
       end

data/lib/seam/routes/access_grants.rb

@@ -14,8 +14,6 @@ module Seam
 
       # Creates a new [Access Grant](https://docs.seam.co/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
       # @param requested_access_methods [Array<Hash>]
-      # @param user_identity_id [String, nil] ID of user identity for whom access is being granted.
-      # @param user_identity [Hash, nil] When used, creates a new user identity with the given details, and grants them access.
       # @param access_grant_key [String, nil] Unique key for the access grant within the workspace.
       # @param acs_entrance_ids [Array<String>, nil] Set of IDs of the [entrances](https://docs.seam.co/api/acs/systems/list) to which access is being granted.
       # @param customization_profile_id [String, nil] ID of the customization profile to apply to the Access Grant and its access methods.
@@ -30,9 +28,11 @@ module Seam
       # @param space_ids [Array<String>, nil] Set of IDs of existing spaces to which access is being granted.
       # @param space_keys [Array<String>, nil] Set of keys of existing spaces to which access is being granted.
       # @param starts_at [String, nil] Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @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:, user_identity_id: nil, user_identity: nil, 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)
-        res = @client.post("/access_grants/create", {requested_access_methods: requested_access_methods, user_identity_id: user_identity_id, user_identity: user_identity, 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}.compact)
+      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)
 
         Seam::Resources::AccessGrant.load_from_response(res.body["access_grant"])
       end

data/lib/seam/routes/access_methods.rb

@@ -27,16 +27,16 @@ module Seam
       end
 
       # Deletes an access method.
-      # @param access_method_id [String, nil] ID of access method to delete.
       # @param access_grant_id [String, nil] ID of access grant whose access methods should be deleted.
+      # @param access_method_id [String, nil] ID of access method to delete.
       # @param reservation_key [String, nil] Reservation key of the access grant whose access methods should be deleted.
       # @return [nil] OK
-      def delete(access_method_id: nil, access_grant_id: nil, reservation_key: nil)
-        if access_method_id.nil? && access_grant_id.nil? && reservation_key.nil?
+      def delete(access_grant_id: nil, access_method_id: nil, reservation_key: nil)
+        if access_grant_id.nil? && access_method_id.nil? && reservation_key.nil?
           raise TypeError, "At least one parameter is required for /access_methods/delete"
         end
 
-        @client.delete("/access_methods/delete", {access_method_id: access_method_id, access_grant_id: access_grant_id, reservation_key: reservation_key}.compact)
+        @client.delete("/access_methods/delete", {access_grant_id: access_grant_id, access_method_id: access_method_id, reservation_key: reservation_key}.compact)
 
         nil
       end

data/lib/seam/routes/acs_encoders_simulate.rb

@@ -10,11 +10,11 @@ module Seam
 
       # Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
       # @param acs_encoder_id [String] ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
-      # @param error_code [String, nil] Code of the error to simulate.
       # @param acs_credential_id [String, nil] ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
+      # @param error_code [String, nil] Code of the error to simulate.
       # @return [nil] OK
-      def next_credential_encode_will_fail(acs_encoder_id:, error_code: nil, acs_credential_id: nil)
-        @client.post("/acs/encoders/simulate/next_credential_encode_will_fail", {acs_encoder_id: acs_encoder_id, error_code: error_code, acs_credential_id: acs_credential_id}.compact)
+      def next_credential_encode_will_fail(acs_encoder_id:, acs_credential_id: nil, error_code: nil)
+        @client.post("/acs/encoders/simulate/next_credential_encode_will_fail", {acs_encoder_id: acs_encoder_id, acs_credential_id: acs_credential_id, error_code: error_code}.compact)
 
         nil
       end
@@ -31,11 +31,11 @@ module Seam
 
       # Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
       # @param acs_encoder_id [String] ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
-      # @param error_code [String, nil]
       # @param acs_credential_id_on_seam [String, nil]
+      # @param error_code [String, nil]
       # @return [nil] OK
-      def next_credential_scan_will_fail(acs_encoder_id:, error_code: nil, acs_credential_id_on_seam: nil)
-        @client.post("/acs/encoders/simulate/next_credential_scan_will_fail", {acs_encoder_id: acs_encoder_id, error_code: error_code, acs_credential_id_on_seam: acs_credential_id_on_seam}.compact)
+      def next_credential_scan_will_fail(acs_encoder_id:, acs_credential_id_on_seam: nil, error_code: nil)
+        @client.post("/acs/encoders/simulate/next_credential_scan_will_fail", {acs_encoder_id: acs_encoder_id, acs_credential_id_on_seam: acs_credential_id_on_seam, error_code: error_code}.compact)
 
         nil
       end

data/lib/seam/routes/acs_users.rb

@@ -71,9 +71,9 @@ module Seam
       # @param limit [Integer, nil] Maximum number of records to return per page.
       # @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 access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.
-      # @param user_identity_email_address [String, nil] Email address of the user identity for which you want to retrieve all access system users.
+      # @param user_identity_email_address [String, Seam::Null, nil] Email address of the user identity for which you want to retrieve all access system users. Specify `null` to retrieve access system users whose user identity has no email address.
       # @param user_identity_id [String, nil] ID of the user identity for which you want to retrieve all access system users.
-      # @param user_identity_phone_number [String, nil] Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).
+      # @param user_identity_phone_number [String, Seam::Null, nil] Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). Specify `null` to retrieve access system users whose user identity has no phone number.
       # @return [Seam::Resources::AcsUser] OK
       def list(acs_system_id: nil, created_before: nil, limit: nil, page_cursor: nil, search: nil, user_identity_email_address: nil, user_identity_id: nil, user_identity_phone_number: nil)
         res = @client.get("/acs/users/list", {acs_system_id: acs_system_id, created_before: created_before, limit: limit, page_cursor: page_cursor, search: search, user_identity_email_address: user_identity_email_address, user_identity_id: user_identity_id, user_identity_phone_number: user_identity_phone_number}.compact)

data/lib/seam/routes/client_sessions.rb

@@ -80,9 +80,9 @@ module Seam
 
       # Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
       # @param client_session_id [String, nil] ID of the client session that you want to retrieve.
-      # @param connect_webview_id [String, nil] ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions.
+      # @param connect_webview_id [String, Seam::Null, nil] ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview.
       # @param user_identifier_key [String, nil] Your user ID for the user by which you want to filter client sessions.
-      # @param user_identity_id [String, nil] ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.
+      # @param user_identity_id [String, Seam::Null, nil] ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity.
       # @param without_user_identifier_key [Boolean, nil] Indicates whether to retrieve only client sessions without associated user identifier keys.
       # @return [Seam::Resources::ClientSession] OK
       def list(client_session_id: nil, connect_webview_id: nil, user_identifier_key: nil, user_identity_id: nil, without_user_identifier_key: nil)

data/lib/seam/routes/connect_webviews.rb

@@ -55,7 +55,7 @@ module Seam
       end
 
       # Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews).
-      # @param custom_metadata_has [Hash{String => String, Boolean}, nil] Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
+      # @param custom_metadata_has [Hash{String => String, Boolean}, nil] Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.
       # @param customer_key [String, nil] Customer key for which you want to list connect webviews.
       # @param limit [Float, nil] Maximum number of records to return per page.
       # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.

data/lib/seam/routes/connected_accounts.rb

@@ -40,7 +40,7 @@ module Seam
       end
 
       # Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts).
-      # @param custom_metadata_has [Hash{String => String, Boolean}, nil] Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
+      # @param custom_metadata_has [Hash{String => String, Boolean}, nil] Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.
       # @param customer_key [String, nil] Customer key by which you want to filter connected accounts.
       # @param limit [Integer, nil] Maximum number of records to return per page.
       # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.

data/lib/seam/routes/customers.rb

@@ -9,6 +9,7 @@ module Seam
       end
 
       # Creates a new customer portal magic link with configurable features.
+      # @param customer_data [Hash, nil]
       # @param customer_resources_filters [Array<Hash>, 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.
@@ -19,10 +20,9 @@ module Seam
       # @param locale [String, nil] The locale to use for the portal.
       # @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.
-      # @param customer_data [Hash, nil]
       # @return [Seam::Resources::CustomerPortal] OK
-      def create_portal(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, customer_data: nil)
-        res = @client.post("/customers/create_portal", {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, customer_data: customer_data}.compact)
+      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)
 
         Seam::Resources::CustomerPortal.load_from_response(res.body["customer_portal"])
       end

data/lib/seam/routes/devices.rb

@@ -37,7 +37,7 @@ module Seam
       # @param connected_account_id [String, nil] ID of the connected account for which you want to list devices.
       # @param connected_account_ids [Array<String>, nil] Array of IDs of the connected accounts for which you want to list devices.
       # @param created_before [Time, nil] Timestamp by which to limit returned devices. Returns devices created before this timestamp.
-      # @param custom_metadata_has [Hash{String => String, Boolean}, nil] Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
+      # @param custom_metadata_has [Hash{String => String, Boolean}, nil] Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.
       # @param customer_key [String, nil] Customer key for which you want to list devices.
       # @param device_ids [Array<String>, nil] Array of device IDs for which you want to list devices.
       # @param device_type [String, nil] Device type for which you want to list devices.

data/lib/seam/routes/noise_sensors_noise_thresholds.rb

@@ -60,7 +60,7 @@ module Seam
       # @param starts_daily_at [String, nil] Time at which the noise threshold should become active daily.
       # @return [nil] OK
       def update(device_id:, noise_threshold_id:, ends_daily_at: nil, name: nil, noise_threshold_decibels: nil, noise_threshold_nrs: nil, starts_daily_at: nil)
-        @client.put("/noise_sensors/noise_thresholds/update", {device_id: device_id, noise_threshold_id: noise_threshold_id, ends_daily_at: ends_daily_at, name: name, noise_threshold_decibels: noise_threshold_decibels, noise_threshold_nrs: noise_threshold_nrs, starts_daily_at: starts_daily_at}.compact)
+        @client.patch("/noise_sensors/noise_thresholds/update", {device_id: device_id, noise_threshold_id: noise_threshold_id, ends_daily_at: ends_daily_at, name: name, noise_threshold_decibels: noise_threshold_decibels, noise_threshold_nrs: noise_threshold_nrs, starts_daily_at: starts_daily_at}.compact)
 
         nil
       end

data/lib/seam/routes/user_identities.rb

@@ -142,16 +142,16 @@ module Seam
       #
       # Identify the user identities either by ID or by key, but not both in the same request. Repeating a merge that has already been applied makes no further changes.
       # @param merged_user_identity_ids [Array<String>, nil] IDs of the user identities to merge into the primary user identity. These user identities are deleted.
-      # @param user_identity_id [String, nil] ID of the primary user identity to keep.
       # @param merged_user_identity_keys [Array<String>, nil] Keys of the user identities to merge into the primary user identity. These user identities are deleted.
+      # @param user_identity_id [String, nil] ID of the primary user identity to keep.
       # @param user_identity_key [String, nil] Key of the primary user identity to keep.
       # @return [nil] OK
-      def merge(merged_user_identity_ids: nil, user_identity_id: nil, merged_user_identity_keys: nil, user_identity_key: nil)
-        if merged_user_identity_ids.nil? && user_identity_id.nil? && merged_user_identity_keys.nil? && user_identity_key.nil?
+      def merge(merged_user_identity_ids: nil, merged_user_identity_keys: nil, user_identity_id: nil, user_identity_key: nil)
+        if merged_user_identity_ids.nil? && merged_user_identity_keys.nil? && user_identity_id.nil? && user_identity_key.nil?
           raise TypeError, "At least one parameter is required for /user_identities/merge"
         end
 
-        @client.post("/user_identities/merge", {merged_user_identity_ids: merged_user_identity_ids, user_identity_id: user_identity_id, merged_user_identity_keys: merged_user_identity_keys, user_identity_key: user_identity_key}.compact)
+        @client.post("/user_identities/merge", {merged_user_identity_ids: merged_user_identity_ids, merged_user_identity_keys: merged_user_identity_keys, user_identity_id: user_identity_id, user_identity_key: user_identity_key}.compact)
 
         nil
       end

data/lib/seam/routes/workspaces.rb

@@ -13,11 +13,11 @@ module Seam
       # Creates a new [workspace](https://docs.seam.co/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.
-      # @deprecated connect_partner_name: Use `company_name` instead.
       # @param connect_webview_customization [Hash, nil] [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
       # @param is_sandbox [Boolean, nil] Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
-      # @param organization_id [String, nil] ID of the organization to associate with the new workspace.
+      # @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.
       # @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]

data/lib/seam/version.rb

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

metadata

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