seam 2.140.0 → 2.141.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564fdfd341da5fc43c859ba3a1bb7d013b40845ffbab7e0e05f917493b974821
-  data.tar.gz: a9ce5bded784a3153d98b85d6fcaaa1625837f84e9078c94a6c372e9a4a2eb24
+  metadata.gz: e99e4c607a0b5f8714d0067e093f8ab93766a3af4cd069f26988e483da203943
+  data.tar.gz: db6cd5c445363a9bdc119946829dac7a44aaf0ff7a278063e818133680e1edea
 SHA512:
-  metadata.gz: 1cbe2df337d9004d747493a81330ccceda4caa1476e38d0907670b9f47d16bd4e5036a2745c958ca203ff0154e773ef91339769881da525a30ef2839f4d93761
-  data.tar.gz: 0d69f48f2499b5f2275e44ddce95be1ffa50a417e8430374197f6a976fef7691facf1fdf80f247a8dfe0f166f2a32a966b79e74c7c851252e3df5fb502e46332
+  metadata.gz: 418154fb53f041f8682566396ecfae077473c5d64993afb5208d2eee316b60e508362de340b6ce83d68058b2098bf76347f70042ea023215c15a5d921916cea9
+  data.tar.gz: b58f492190db82e6be16f4f65a968a40d8569278781aa1238dec0c70c88e4241394ffff34b2ce9e6c662b048d635581e57eadb32b54a589b3513e683bac1b802

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seam (2.140.0)
+    seam (2.141.1)
       faraday (~> 2.7)
       faraday-retry (~> 2.2)
       svix (~> 1.30)

data/README.md

@@ -27,6 +27,7 @@ accurate and fully typed.
     - [API Key](#api-key)
     - [Personal Access Token](#personal-access-token)
   - [Action Attempts](#action-attempts)
+  - [Setting a value to null](#setting-a-value-to-null)
   - [Pagination](#pagination)
     - [Manually fetch pages with the next_page_cursor](#manually-fetch-pages-with-the-next_page_cursor)
     - [Resume pagination](#resume-pagination)
@@ -43,6 +44,7 @@ accurate and fully typed.
     - [Configuring the Faraday Client](#configuring-the-faraday-client)
     - [Using the Faraday Client](#using-the-faraday-client)
     - [Overriding the Client](#overriding-the-client)
+    - [Serializing URL search params](#serializing-url-search-params)
 - [Development and Testing](#development-and-testing)
   - [Quickstart](#quickstart)
   - [Source code](#source-code)
@@ -226,6 +228,35 @@ rescue Seam::ActionAttemptTimeoutError
 end
 ```
 
+### Setting a value to null
+
+The Seam API distinguishes three states for an updatable parameter:
+omitted (leave the stored value unchanged), null (unset the stored value),
+and a value (set it).
+
+Ruby's `nil` means omitted.
+The SDK removes `nil` parameters from the request entirely,
+so passing `nil` never unsets a value.
+To unset a value, pass the `Seam::NULL` sentinel,
+which the SDK sends as JSON `null` in request bodies
+and as an empty value in query strings:
+
+```ruby
+require "seam"
+
+seam = Seam.new
+
+# Leaves ends_at unchanged.
+seam.access_grants.update(access_grant_id: access_grant_id, ends_at: nil)
+
+# Unsets ends_at so the grant no longer expires.
+seam.access_grants.update(access_grant_id: access_grant_id, ends_at: Seam::NULL)
+```
+
+Only pass `Seam::NULL` for parameters the API documents as nullable.
+Generated methods document nullable parameters
+with `Seam::Null` in their `@param` types, e.g. `[String, Seam::Null, nil]`.
+
 ### Pagination
 
 Some Seam API endpoints that return lists of resources support pagination.
@@ -489,6 +520,61 @@ devices = seam.client.get("/devices/list").body["devices"]
 A Faraday compatible client may be provided to create a `Seam` instance.
 This API is used internally and is not directly supported.
 
+#### Serializing URL search params
+
+The Seam API parses URL search params as complex types.
+If you call it with your own HTTP client,
+`Seam.serialize_url_search_params` is exported for that purpose.
+The `_strict=true` parameter is added to any non-empty query
+so the Seam API uses strict, schema-aware parsing.
+A query with no serializable params remains empty.
+
+```ruby
+require "net/http"
+require "seam"
+
+uri = URI("https://connect.getseam.com/devices/list")
+uri.query = Seam.serialize_url_search_params({device_ids: ["device1", "device2"]})
+
+Net::HTTP.get(uri, {"Authorization" => "Bearer your-api-key"})
+```
+
+The serialization defines the name and value of each search param,
+where every value is a string.
+`Seam::UrlSearchParams` holds those pairs and renders the query string,
+as [URLSearchParams] does for the [reference implementation]:
+
+```ruby
+require "seam"
+
+search_params = Seam::UrlSearchParams.new
+
+Seam.update_url_search_params(search_params, {device_ids: ["device1", "device2"]})
+
+search_params.to_a
+# => [["device_ids", "device1"], ["device_ids", "device2"], ["_strict", "true"]]
+
+search_params.to_s
+# => "device_ids=device1&device_ids=device2&_strict=true"
+```
+
+Pass either the query string or the pairs to your HTTP client.
+A client may percent-encode a few characters differently
+than `URLSearchParams` does,
+which the Seam API reads as the same params either way.
+
+A param set to `nil` is omitted,
+while a param set to `Seam::NULL` is serialized to an empty value,
+which the Seam API reads as null,
+as described in [Setting a value to null](#setting-a-value-to-null).
+A param that cannot be represented raises a `Seam::UnserializableParamError`.
+
+The Seam API parses these params with the corresponding [parser].
+
+[URLSearchParams]: https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams
+[reference implementation]: https://github.com/seamapi/url-search-params-serializer
+[parser]: https://github.com/seamapi/url-search-params-parser
+
 ## Development and Testing
 
 ### Quickstart

data/lib/seam/action_attempt_resolver.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "wait_for_action_attempt"
+
+module Seam
+  class ActionAttemptResolver
+    def self.resolve(action_attempt, client, wait_for_action_attempt)
+      return wait_until_resolved(action_attempt, client) if wait_for_action_attempt == true
+
+      options = wait_options(wait_for_action_attempt)
+      return action_attempt if options.nil?
+
+      wait_until_resolved(action_attempt, client, timeout: options[:timeout],
+        polling_interval: options[:polling_interval])
+    end
+
+    # The client wraps its defaults in a DeepHashAccessor, so the hash form of
+    # this option reaches here as an accessor when it comes from the client
+    # and as a plain Hash when it comes from the method call.
+    def self.wait_options(wait_for_action_attempt)
+      case wait_for_action_attempt
+      when Hash then wait_for_action_attempt
+      when Seam::DeepHashAccessor then wait_for_action_attempt.to_h
+      end
+    end
+
+    def self.wait_until_resolved(action_attempt, client, timeout: nil, polling_interval: nil)
+      timeout = timeout.nil? ? 5.0 : timeout
+      polling_interval = polling_interval.nil? ? 0.5 : polling_interval
+
+      time_waiting = 0.0
+
+      while action_attempt.status == "pending"
+        sleep(polling_interval)
+        time_waiting += polling_interval
+
+        raise Seam::ActionAttemptTimeoutError.new(action_attempt, timeout) if time_waiting > timeout
+
+        action_attempt = update_action_attempt(action_attempt, client)
+      end
+
+      raise Seam::ActionAttemptFailedError.new(action_attempt) if action_attempt.status == "error"
+
+      action_attempt
+    end
+
+    def self.update_action_attempt(action_attempt, client)
+      response = client.get("/action_attempts/get", {action_attempt_id: action_attempt.action_attempt_id})
+
+      action_attempt.update_from_response(response.body["action_attempt"])
+      action_attempt
+    end
+  end
+end

data/lib/seam/null.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module Seam
+  # The type of the {Seam::NULL} sentinel.
+  class Null
+    include Singleton
+
+    def to_s
+      "NULL"
+    end
+
+    def inspect
+      "NULL"
+    end
+  end
+
+  # Sentinel for an explicit JSON null: +nil+ omits a parameter, +Seam::NULL+
+  # unsets its stored value. Only for parameters the API documents as
+  # nullable.
+  NULL = Null.instance
+end

data/lib/seam/request.rb

@@ -5,6 +5,7 @@ require "faraday/retry"
 require_relative "defaults"
 require_relative "version"
 require_relative "paginator"
+require_relative "strict_url_search_params_serializer"
 
 module Seam
   module Http
@@ -16,7 +17,11 @@ module Seam
         default_options = {
           url: endpoint,
           headers: auth_headers.merge(default_headers),
-          request: {timeout: timeout, open_timeout: timeout}
+          request: {
+            timeout: timeout,
+            open_timeout: timeout,
+            params_encoder: UrlSearchParamsEncoder
+          }
         }
 
         options = deep_merge(default_options, faraday_options)
@@ -33,6 +38,7 @@ module Seam
         faraday_retry_options = default_faraday_retry_options.merge(faraday_retry_options)
 
         Faraday.new(options) do |builder|
+          builder.use ReplaceNullMiddleware
           builder.request :json
           builder.use Seam::PaginationMiddleware
           builder.response :json
@@ -97,6 +103,14 @@ module Seam
         end
       end
 
+      class ReplaceNullMiddleware < Faraday::Middleware
+        def on_request(env)
+          return unless env.body.is_a?(Hash) || env.body.is_a?(Array)
+
+          env.body = Seam.replace_null(env.body)
+        end
+      end
+
       def self.deep_merge(hash1, hash2)
         result = hash1.dup
         hash2.each do |key, value|
@@ -111,5 +125,39 @@ module Seam
 
       private_class_method :deep_merge
     end
+
+    module UrlSearchParamsEncoder
+      # Pairs decoded from a query string already present in the request
+      # path, passed through {encode} verbatim rather than re-serialized.
+      Decoded = Struct.new(:values)
+
+      def self.encode(params)
+        search_params = Seam::UrlSearchParams.new
+        map_params = {}
+
+        params.each do |name, value|
+          if value.is_a?(Decoded)
+            value.values.each { |element| search_params.append(name, element) }
+          else
+            map_params[name] = value
+          end
+        end
+
+        return search_params.to_s if map_params.empty?
+
+        Seam.update_url_search_params(search_params, map_params)
+        search_params.to_s
+      end
+
+      # Called by Faraday when a request path carries its own query string.
+      def self.decode(query)
+        return {} if query.nil? || query.empty?
+
+        pairs = URI.decode_www_form(query.encode(Encoding::UTF_8))
+        pairs.each_with_object({}) do |(name, value), decoded|
+          (decoded[name] ||= Decoded.new([])).values << value
+        end
+      end
+    end
   end
 end

data/lib/seam/routes/access_codes.rb

@@ -129,7 +129,7 @@ module Seam
       # @param customer_key [String, nil] Customer key for which you want to list access codes.
       # @param device_id [String, nil] ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
       # @param limit [Float, nil] Numerical limit on the number of access codes to return.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
       # @param user_identifier_key [String, nil] Your user ID for the user by which to filter access codes.
       # @return [Seam::Resources::AccessCode] OK

data/lib/seam/routes/access_codes_unmanaged.rb

@@ -53,7 +53,7 @@ module Seam
       # Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
       # @param device_id [String] ID of the device for which you want to list unmanaged access codes.
       # @param limit [Float, nil] Numerical limit on the number of unmanaged access codes to return.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
       # @param user_identifier_key [String, nil] Your user ID for the user by which to filter unmanaged access codes.
       # @return [Seam::Resources::UnmanagedAccessCode] OK

data/lib/seam/routes/access_grants.rb

@@ -20,12 +20,12 @@ module Seam
       # @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.
       # @param device_ids [Array<String>, nil] Set of IDs of the [devices](https://docs.seam.co/api/devices/list) to which access is being granted.
-      # @param ends_at [String, nil] Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param ends_at [String, Seam::Null, nil] Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
       # @param location [Hash, nil]
       # @deprecated location: Create a space first, then reference it using `space_ids`.
       # @param location_ids [Array<String>, nil]
       # @deprecated location_ids: Use `space_ids`.
-      # @param name [String, nil] Name for the access grant.
+      # @param name [String, Seam::Null, nil] Name for the access grant.
       # @param reservation_key [String, nil] Reservation key for the access grant.
       # @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.
@@ -79,7 +79,7 @@ module Seam
       # Gets an Access Grant.
       # @param access_code_id [String, nil] ID of the access code by which you want to filter the list of Access Grants.
       # @param access_grant_ids [Array<String>, nil] IDs of the access grants to retrieve.
-      # @param access_grant_key [String, nil] Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.
+      # @param access_grant_key [String, Seam::Null, nil] Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.
       # @param acs_entrance_id [String, nil] ID of the entrance by which you want to filter the list of Access Grants.
       # @param acs_system_id [String, nil] ID of the access system by which you want to filter the list of Access Grants.
       # @param customer_key [String, nil] Customer key for which you want to list access grants.
@@ -87,7 +87,7 @@ module Seam
       # @param limit [Float, nil] Numerical limit on the number of access grants to return.
       # @param location_id [String, nil]
       # @deprecated location_id: Use `space_id`.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 reservation_key [String, nil] Filter Access Grants by reservation_key.
       # @param space_id [String, nil] ID of the space by which you want to filter the list of Access Grants.
       # @param user_identity_id [String, nil] ID of user identity by which you want to filter the list of Access Grants.
@@ -111,8 +111,8 @@ module Seam
       # Updates an existing Access Grant's time window.
       # @param access_grant_id [String, nil] ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
       # @param access_grant_key [String, nil] Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
-      # @param ends_at [Time, nil] Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
-      # @param name [String, nil] Display name for the access grant.
+      # @param ends_at [Time, Seam::Null, nil] Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+      # @param name [String, Seam::Null, nil] Display name for the access grant.
       # @param starts_at [Time, nil] Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
       # @return [nil] OK
       def update(access_grant_id: nil, access_grant_key: nil, ends_at: nil, name: nil, starts_at: nil)

data/lib/seam/routes/access_grants_unmanaged.rb

@@ -21,7 +21,7 @@ module Seam
       # @param acs_entrance_id [String, nil] ID of the entrance by which you want to filter the list of unmanaged Access Grants.
       # @param acs_system_id [String, nil] ID of the access system by which you want to filter the list of unmanaged Access Grants.
       # @param limit [Float, nil] Numerical limit on the number of unmanaged access grants to return.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 reservation_key [String, nil] Filter unmanaged Access Grants by reservation_key.
       # @param user_identity_id [String, nil] ID of user identity by which you want to filter the list of unmanaged Access Grants.
       # @return [Seam::Resources::UnmanagedAccessGrant] OK

data/lib/seam/routes/access_methods.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "seam/helpers/action_attempt"
+require "seam/action_attempt_resolver"
 
 module Seam
   module Clients
@@ -23,7 +23,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
       # Deletes an access method.
@@ -50,7 +50,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
       # Gets an access method.
@@ -80,7 +80,7 @@ module Seam
       # @param acs_entrance_id [String, nil] ID of the entrance for which you want to retrieve all access methods that grant access to it.
       # @param device_id [String, nil] ID of the device by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
       # @param limit [Integer, nil] Maximum number of records to return per page.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 space_id [String, nil] ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
       # @return [Seam::Resources::AccessMethod] OK
       def list(access_code_id: nil, access_grant_id: nil, access_grant_key: nil, acs_entrance_id: nil, device_id: nil, limit: nil, page_cursor: nil, space_id: nil)
@@ -102,7 +102,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
     end
   end

data/lib/seam/routes/acs_credentials.rb

@@ -65,7 +65,7 @@ module Seam
       # @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, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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`.
       # @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)

data/lib/seam/routes/acs_encoders.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "seam/helpers/action_attempt"
+require "seam/action_attempt_resolver"
 
 module Seam
   module Clients
@@ -24,7 +24,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
       # Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
@@ -41,7 +41,7 @@ module Seam
       # @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, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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.post("/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)
@@ -58,7 +58,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
       # Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
@@ -72,7 +72,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
     end
   end

data/lib/seam/routes/acs_entrances.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "seam/helpers/action_attempt"
+require "seam/action_attempt_resolver"
 
 module Seam
   module Clients
@@ -38,9 +38,9 @@ module Seam
       # @param connected_account_id [String, nil] ID of the connected account for which you want to retrieve all entrances.
       # @param customer_key [String, nil] Customer key for which you want to list entrances.
       # @param limit [Integer, nil] Maximum number of records to return per page.
-      # @param location_id [String, nil]
+      # @param location_id [String, Seam::Null, nil]
       # @deprecated location_id: Use `space_id`.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 entrances to include all records that satisfy a partial match using `display_name`.
       # @param space_id [String, nil] ID of the space for which you want to list entrances.
       # @return [Seam::Resources::AcsEntrance] OK
@@ -69,7 +69,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
     end
   end

data/lib/seam/routes/acs_users.rb

@@ -69,7 +69,7 @@ module Seam
       # @param acs_system_id [String, nil] ID of the `acs_system` for which you want to retrieve all access system users.
       # @param created_before [Time, nil] Timestamp by which to limit returned access system users. Returns users created before this timestamp.
       # @param limit [Integer, nil] Maximum number of records to return per page.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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_id [String, nil] ID of the user identity for which you want to retrieve all access system users.
@@ -153,7 +153,7 @@ module Seam
       end
 
       # Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
-      # @param access_schedule [Hash, nil] `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+      # @param access_schedule [Hash, Seam::Null, nil] `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
       # @param acs_system_id [String, nil] ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
       # @param acs_user_id [String, nil] ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
       # @param email [String, nil]

data/lib/seam/routes/action_attempts.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "seam/helpers/action_attempt"
+require "seam/action_attempt_resolver"
 
 module Seam
   module Clients
@@ -18,14 +18,14 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
       # Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.
       # @param action_attempt_ids [Array<String>, nil] IDs of the action attempts that you want to retrieve.
       # @param device_id [String, nil] ID of the device to filter action attempts by.
       # @param limit [Integer, nil] Maximum number of records to return per page.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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::ActionAttempt] OK
       def list(action_attempt_ids: nil, device_id: nil, limit: nil, page_cursor: nil)
         res = @client.post("/action_attempts/list", {action_attempt_ids: action_attempt_ids, device_id: device_id, limit: limit, page_cursor: page_cursor}.compact)

data/lib/seam/routes/connect_webviews.rb

@@ -58,7 +58,7 @@ module Seam
       # @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 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, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 Connect Webviews to include all records that satisfy a partial match using `connect_webview_id`, `accepted_providers`, `custom_metadata`, or `customer_key`.
       # @param user_identifier_key [String, nil] Your user ID for the user by which you want to filter Connect Webviews.
       # @return [Seam::Resources::ConnectWebview] OK

data/lib/seam/routes/connected_accounts.rb

@@ -43,7 +43,7 @@ module Seam
       # @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 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, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`.
       # @param space_id [String, nil] ID of the space by which you want to filter connected accounts.
       # @param user_identifier_key [String, nil] Your user ID for the user by which you want to filter connected accounts.

data/lib/seam/routes/devices.rb

@@ -44,10 +44,10 @@ module Seam
       # @param device_types [Array<String>, nil] Array of device types for which you want to list devices.
       # @param limit [Float, nil] Numerical limit on the number of devices to return.
       # @param manufacturer [String, nil] Manufacturer for which you want to list devices.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
       # @param space_id [String, nil] ID of the space for which you want to list devices.
-      # @param unstable_location_id [String, nil]
+      # @param unstable_location_id [String, Seam::Null, nil]
       # @deprecated unstable_location_id: Use `space_id`.
       # @param user_identifier_key [String, nil] Your own internal user ID for the user for which you want to list devices.
       # @return [Seam::Resources::Device] OK
@@ -86,7 +86,7 @@ module Seam
       # @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 is_managed [Boolean, nil] Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.
-      # @param name [String, nil] Name for the device.
+      # @param name [String, Seam::Null, nil] Name for the device.
       # @param properties [Hash, nil]
       # @return [nil] OK
       def update(device_id:, backup_access_code_pool_enabled: nil, custom_metadata: nil, is_managed: nil, name: nil, properties: nil)

data/lib/seam/routes/devices_unmanaged.rb

@@ -39,7 +39,7 @@ module Seam
       # @param device_types [Array<String>, nil] Array of device types for which you want to list devices.
       # @param limit [Float, nil] Numerical limit on the number of devices to return.
       # @param manufacturer [String, nil] Manufacturer for which you want to list devices.
-      # @param page_cursor [String, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @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 devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
       # @return [Seam::Resources::UnmanagedDevice] OK
       def list(connect_webview_id: nil, connected_account_id: nil, connected_account_ids: nil, created_before: nil, customer_key: nil, device_ids: nil, device_type: nil, device_types: nil, limit: nil, manufacturer: nil, page_cursor: nil, search: nil)

data/lib/seam/routes/locks.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "seam/helpers/action_attempt"
+require "seam/action_attempt_resolver"
 
 module Seam
   module Clients
@@ -24,7 +24,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
       # Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
@@ -64,7 +64,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
       # Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock).
@@ -75,7 +75,7 @@ module Seam
 
         wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
 
-        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+        Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
     end
   end