seam 2.145.0 → 2.146.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86d8cf2a61186f64568c6604e6917819447ff105c6921f7cf62ee66d50e1299f
-  data.tar.gz: 9d1d7eaf0d580309207c73b88e22800907cca39bf70e77d089a5a75864f21b82
+  metadata.gz: a45352597670141b7fcf4d8043acf833a4019e97523ac004acdf9a24d140d3ad
+  data.tar.gz: cb4cf04a8b07d629f763f56b4f676150b431342abd6ad7365abfb64585af478a
 SHA512:
-  metadata.gz: c9044764690069612b01f145aa5fe1b02fe2d5ac1c0f7bea8b05f68f616abac06830fa387f203d0d5d430b7b18cbaee0cd2ceeec3e7e1bae953a88a18a3294dc
-  data.tar.gz: 9f2f841bdd627b134e4eaa621ad71c1570f21a3829284f01cbaec8faa95b9079894232144bfd9c5aa5828a1c643ac0072634c35838bbb1d04f8b066561bf14e9
+  metadata.gz: 56fca9672c6ccd40f33ce7773ca672f3c4910885b396eb2b9b3d3c7d251821ecb694c47ebb940a1c39f1bcfa1324cd7a2dca7151aaa3ca244e32da6fa57bfabe
+  data.tar.gz: 67313f9ffa5d35fe509944ed85c7c2f072480aedc62d48984ef2a656d150b6d11d5281d5721c270027b8ebc5e6646d2fde62ce918c228a43034f4649420710d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.145.0)
+    seam (2.146.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.145.0)
+  seam (2.146.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

@@ -194,6 +194,24 @@ module Seam
           date_accessor :created_at
         end
 
+        # The code cannot be set on the device because it violates the device's code constraints (for example, its length, digits, or a too-simple value). The code will not be retried until you change it. See the device's `code_constraints` and `supported_code_lengths`.
+        class CodeConstraintsViolated < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `code_constraints_violated`
+          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.
@@ -471,6 +489,7 @@ module Seam
         # - `no_space_for_access_code_on_device`
         # - `conflicting_external_modification`
         # - `access_code_inactive`
+        # - `code_constraints_violated`
         # - `account_disconnected`
         # - `salto_ks_subscription_limit_exceeded`
         # - `insufficient_permissions`
@@ -501,6 +520,7 @@ module Seam
           "no_space_for_access_code_on_device" => NoSpaceForAccessCodeOnDevice,
           "conflicting_external_modification" => ConflictingExternalModification,
           "access_code_inactive" => AccessCodeInactive,
+          "code_constraints_violated" => CodeConstraintsViolated,
           "account_disconnected" => AccountDisconnected,
           "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
           "insufficient_permissions" => InsufficientPermissions,

data/lib/seam/resources/access_grant.rb

@@ -320,6 +320,9 @@ 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.
+      # @return [String]
+      attr_accessor :display_status
       # Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.
       # @return [String, nil]
       attr_accessor :instant_key_url

data/lib/seam/resources/access_method.rb

@@ -189,6 +189,9 @@ module Seam
       # Display name of the access method.
       # @return [String]
       attr_accessor :display_name
+      # Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. 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 `is_issued`, `errors`, and `pending_mutations`.
+      # @return [String]
+      attr_accessor :display_status
       # URL of the Instant Key for mobile key access methods.
       # @return [String, nil]
       attr_accessor :instant_key_url

data/lib/seam/resources/action_attempt.rb

@@ -1017,6 +1017,9 @@ module Seam
           # Display name of the access method.
           # @return [String]
           attr_accessor :display_name
+          # Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. 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 `is_issued`, `errors`, and `pending_mutations`.
+          # @return [String]
+          attr_accessor :display_status
           # URL of the Instant Key for mobile key access methods.
           # @return [String, nil]
           attr_accessor :instant_key_url

data/lib/seam/resources/connect_webview.rb

@@ -38,7 +38,7 @@ module Seam
       # ID of the connected account associated with the Connect Webview.
       # @return [String, nil]
       attr_accessor :connected_account_id
-      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
+      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
       # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # URL to which the Connect Webview should redirect when an unexpected error occurs.

data/lib/seam/resources/connected_account.rb

@@ -368,7 +368,7 @@ module Seam
       # ID of the connected account.
       # @return [String]
       attr_accessor :connected_account_id
-      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
+      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
       # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # Your unique key for the customer associated with this connected account.

data/lib/seam/resources/device.rb

@@ -2654,7 +2654,7 @@ module Seam
       # Unique identifier for the account associated with the device.
       # @return [String]
       attr_accessor :connected_account_id
-      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
+      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
       # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # ID of the device.

data/lib/seam/resources/unmanaged_access_code.rb

@@ -196,6 +196,24 @@ module Seam
           date_accessor :created_at
         end
 
+        # The code cannot be set on the device because it violates the device's code constraints (for example, its length, digits, or a too-simple value). The code will not be retried until you change it. See the device's `code_constraints` and `supported_code_lengths`.
+        class CodeConstraintsViolated < Errors
+          # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+          # @return [String]
+          # Known values:
+          # - `code_constraints_violated`
+          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.
@@ -473,6 +491,7 @@ module Seam
         # - `no_space_for_access_code_on_device`
         # - `conflicting_external_modification`
         # - `access_code_inactive`
+        # - `code_constraints_violated`
         # - `account_disconnected`
         # - `salto_ks_subscription_limit_exceeded`
         # - `insufficient_permissions`
@@ -503,6 +522,7 @@ module Seam
           "no_space_for_access_code_on_device" => NoSpaceForAccessCodeOnDevice,
           "conflicting_external_modification" => ConflictingExternalModification,
           "access_code_inactive" => AccessCodeInactive,
+          "code_constraints_violated" => CodeConstraintsViolated,
           "account_disconnected" => AccountDisconnected,
           "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
           "insufficient_permissions" => InsufficientPermissions,

data/lib/seam/resources/unmanaged_access_method.rb

@@ -183,6 +183,9 @@ module Seam
       # Display name of the access method.
       # @return [String]
       attr_accessor :display_name
+      # Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. 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 `is_issued`, `errors`, and `pending_mutations`.
+      # @return [String]
+      attr_accessor :display_status
       # Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.
       # @return [Boolean, nil]
       attr_accessor :is_assignment_required

data/lib/seam/resources/unmanaged_device.rb

@@ -990,7 +990,7 @@ module Seam
       # Unique identifier for the account associated with the device.
       # @return [String]
       attr_accessor :connected_account_id
-      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
+      # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
       # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # ID of the device.

data/lib/seam/resources/unmanaged_user_identity.rb

@@ -119,6 +119,12 @@ module Seam
       # Full name of the user associated with the user identity.
       # @return [String, nil]
       attr_accessor :full_name
+      # IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+      # @return [Array<String>]
+      attr_accessor :merged_user_identity_ids
+      # Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+      # @return [Array<String>]
+      attr_accessor :merged_user_identity_keys
       # Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
       # @return [String, nil]
       attr_accessor :phone_number

data/lib/seam/resources/user_identity.rb

@@ -119,6 +119,12 @@ module Seam
       # Full name of the user associated with the user identity.
       # @return [String, nil]
       attr_accessor :full_name
+      # IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+      # @return [Array<String>]
+      attr_accessor :merged_user_identity_ids
+      # Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+      # @return [Array<String>]
+      attr_accessor :merged_user_identity_keys
       # Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
       # @return [String, nil]
       attr_accessor :phone_number

data/lib/seam/routes/acs_credentials.rb

@@ -59,17 +59,17 @@ module Seam
       end
 
       # Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
-      # @param acs_user_id [String, nil] ID of the access system user for which you want to retrieve all credentials.
       # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all credentials.
-      # @param user_identity_id [String, nil] ID of the user identity for which you want to retrieve all credentials.
+      # @param acs_user_id [String, nil] ID of the access system user for which you want to retrieve all credentials.
       # @param created_before [Time, nil] Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
       # @param is_multi_phone_sync_credential [Boolean, nil] Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.
       # @param limit [Float, nil] Number of credentials to return.
       # @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 credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
+      # @param user_identity_id [String, nil] ID of the user identity for which you want to retrieve all credentials.
       # @return [Seam::Resources::AcsCredential] OK
-      def list(acs_user_id: nil, acs_system_id: nil, user_identity_id: nil, created_before: nil, is_multi_phone_sync_credential: nil, limit: nil, page_cursor: nil, search: nil)
-        res = @client.get("/acs/credentials/list", {acs_user_id: acs_user_id, acs_system_id: acs_system_id, user_identity_id: user_identity_id, created_before: created_before, is_multi_phone_sync_credential: is_multi_phone_sync_credential, limit: limit, page_cursor: page_cursor, search: search}.compact)
+      def list(acs_system_id: nil, acs_user_id: nil, created_before: nil, is_multi_phone_sync_credential: nil, limit: nil, page_cursor: nil, search: nil, user_identity_id: nil)
+        res = @client.get("/acs/credentials/list", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, created_before: created_before, is_multi_phone_sync_credential: is_multi_phone_sync_credential, limit: limit, page_cursor: page_cursor, search: search, user_identity_id: user_identity_id}.compact)
 
         Seam::Resources::AcsCredential.load_from_response(res.body["acs_credentials"])
       end

data/lib/seam/routes/acs_encoders.rb

@@ -37,14 +37,14 @@ module Seam
       end
 
       # Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+      # @param acs_encoder_ids [Array<String>, nil] IDs of the encoders that you want to retrieve.
       # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all encoders.
       # @param acs_system_ids [Array<String>, nil] IDs of the access systems for which you want to retrieve all encoders.
-      # @param acs_encoder_ids [Array<String>, nil] IDs of the encoders that you want to retrieve.
       # @param limit [Float, nil] Number of encoders to return.
       # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
       # @return [Seam::Resources::AcsEncoder] OK
-      def list(acs_system_id: nil, acs_system_ids: nil, acs_encoder_ids: nil, limit: nil, page_cursor: nil)
-        res = @client.get("/acs/encoders/list", {acs_system_id: acs_system_id, acs_system_ids: acs_system_ids, acs_encoder_ids: acs_encoder_ids, limit: limit, page_cursor: page_cursor}.compact)
+      def list(acs_encoder_ids: nil, acs_system_id: nil, acs_system_ids: nil, limit: nil, page_cursor: nil)
+        res = @client.get("/acs/encoders/list", {acs_encoder_ids: acs_encoder_ids, acs_system_id: acs_system_id, acs_system_ids: acs_system_ids, limit: limit, page_cursor: page_cursor}.compact)
 
         Seam::Resources::AcsEncoder.load_from_response(res.body["acs_encoders"])
       end

data/lib/seam/routes/connect_webviews.rb

@@ -18,7 +18,7 @@ module Seam
       # @param accepted_capabilities [Array<String>, nil] List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.
       # @param accepted_providers [Array<String>, nil] Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters.
       # @param automatically_manage_new_devices [Boolean, nil] Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
-      # @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).
+      # @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
       # @param custom_redirect_failure_url [String, nil] Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.
       # @param custom_redirect_url [String, nil] URL that you want to redirect the user to after the provider login is complete.
       # @param customer_key [String, nil] Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.
@@ -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.
+      # @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 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.
+      # @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 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`.
@@ -67,7 +67,7 @@ module Seam
       # @param connected_account_id [String] ID of the connected account that you want to update.
       # @param accepted_capabilities [Array<String>, nil] List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.
       # @param automatically_manage_new_devices [Boolean, nil] Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
-      # @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).
+      # @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
       # @param customer_key [String, nil] The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.
       # @param display_name [String, nil] Human-readable name for the connected account, shown in the dashboard. For example, `Booking from Airbnb House 1`.
       # @return [nil] OK

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.
+      # @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 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.
@@ -84,7 +84,7 @@ module Seam
       # You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
       # @param device_id [String] ID of the device that you want to update.
       # @param backup_access_code_pool_enabled [Boolean, nil] Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.
-      # @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
+      # @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
       # @param is_managed [Boolean, nil] Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.
       # @param name [String, Seam::Null, nil] Name for the device.
       # @param properties [Hash, nil]

data/lib/seam/routes/devices_unmanaged.rb

@@ -52,7 +52,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{String => String, Boolean}, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.
+      # @param custom_metadata [Hash{String => String, Boolean}, nil] Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Set a key to `null` or to an empty string to remove that key from the custom metadata.
       # @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)

data/lib/seam/routes/events.rb

@@ -37,7 +37,7 @@ module Seam
       # @param acs_system_id [String, nil] ID of the access system for which you want to list events.
       # @param acs_system_ids [Array<String>, nil] IDs of the access systems for which you want to list events.
       # @param acs_user_id [String, nil] ID of the ACS user for which you want to list events.
-      # @param between [Array<Time>, nil] Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
+      # @param between [Array<String>, nil] Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
       # @param connect_webview_id [String, nil] ID of the Connect Webview for which you want to list events.
       # @param connected_account_id [String, nil] ID of the connected account for which you want to list events.
       # @param customer_key [String, nil] Customer key for which you want to list events.

data/lib/seam/routes/user_identities.rb

@@ -134,6 +134,28 @@ module Seam
         Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
       end
 
+      # Merges one or more [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity.
+      #
+      # The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`.
+      #
+      # Access grants, access system users, client sessions and other resources belonging to the merged user identities are moved to the primary user identity.
+      #
+      # 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_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?
+          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)
+
+        nil
+      end
+
       # Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
       # @param acs_user_id [String] ID of the access system user that you want to remove from the user identity..
       # @param user_identity_id [String] ID of the user identity from which you want to remove an access system user.

data/lib/seam/version.rb

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

metadata

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