seam 2.142.0 → 2.143.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8e9429cc66f5767d44b6d409f85a5dfa2f07d5f7af369eb20f1b2690ecb14ee
-  data.tar.gz: ecd20ffb6213341e419d9b9ae27abe1a783d7d8ced2ee33d2fe2a86d1606df69
+  metadata.gz: 6b823828403595f0d453e29c8621df7f1a3019d731abe06c8e5d4b1d9d787d20
+  data.tar.gz: 6ef6463ebed149d5b759e864d98138ec8fe6864b1cf951aab406fdf263181995
 SHA512:
-  metadata.gz: 59dc939e24445cc86e826a2e6287a48c5c5d1732aed9fdbe8428742de74476e228a67335e807faf3bae068c7d6a2074983838285f46a58f3cd09391de26532c8
-  data.tar.gz: 9adaf12116c5d351651cd8f9d7b513b352a1440336e05c64fed92b370ae49223bc725e4474854af9f9a86855526ef863da0f52331032d6a10b1bd7a587a9efe2
+  metadata.gz: 349e0b0fd1e88fdb68bdaa503195430ccceb7537962fabfb2377ef9f7c2a64f8785580cd9546bef106cbeabf40241037b8bd832690712c242bc10fcfac3f4478
+  data.tar.gz: 032e4ba16a1829281886e23b837bc0ff18a5c5f4cbc57ae8bdd5efa9bde99a804cce394bb914bb93bae78a4dca449e30de60acb3e8c27a9d4f9a58691d073a95

data/Gemfile.lock

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

data/lib/seam/resources/connect_webview.rb

@@ -33,7 +33,7 @@ module Seam
       # @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.
-      # @return [Hash]
+      # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # URL to which the Connect Webview should redirect when an unexpected error occurs.
       # @return [String, nil]

data/lib/seam/resources/connected_account.rb

@@ -125,7 +125,7 @@ module Seam
       # @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.
-      # @return [Hash]
+      # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # Your unique key for the customer associated with this connected account.
       # @return [String, nil]

data/lib/seam/resources/device.rb

@@ -1784,7 +1784,7 @@ module Seam
       # @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.
-      # @return [Hash]
+      # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # ID of the device.
       # @return [String]

data/lib/seam/resources/event.rb

@@ -268,7 +268,7 @@ module Seam
       attr_accessor :code
       # @return [String, nil]
       attr_accessor :connect_webview_id
-      # @return [Hash, nil]
+      # @return [Hash{String => String, Boolean}, nil]
       attr_accessor :connected_account_custom_metadata
       # @return [String, nil]
       attr_accessor :connected_account_id
@@ -289,7 +289,7 @@ module Seam
       # Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point.
       # @return [Float, nil]
       attr_accessor :desired_temperature_fahrenheit
-      # @return [Hash, nil]
+      # @return [Hash{String => String, Boolean}, nil]
       attr_accessor :device_custom_metadata
       # @return [String, nil]
       attr_accessor :device_id

data/lib/seam/resources/phone.rb

@@ -71,7 +71,7 @@ module Seam
       # @return [Array<Warnings>]
       resource_list_accessor :warnings, Warnings
       # Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
-      # @return [Hash]
+      # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # ID of the phone.
       # @return [String]

data/lib/seam/resources/unmanaged_device.rb

@@ -222,7 +222,7 @@ module Seam
       # @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.
-      # @return [Hash]
+      # @return [Hash{String => String, Boolean}]
       attr_accessor :custom_metadata
       # ID of the device.
       # @return [String]

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, 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. [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_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, 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.
       # @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, 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.
       # @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, 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. [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 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, 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.
       # @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, 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. [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 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, 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.
       # @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/version.rb

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

metadata

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