seam 2.149.0 → 2.150.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20eb2c8e0938d5dcb96d337254d2eaba3c77d9c1fe672292c09af488638aa3b3
-  data.tar.gz: 24d8ca1c9ce0dd9f901fc19fcb48990885e9301a9feb0fa26fd890cd0fdc55e6
+  metadata.gz: 622126d4b9112044964d3981c67d435df6ee7312b92328ba2164e0694f637453
+  data.tar.gz: b7125af103c4c2c77bc7af576f4e510991e9dcabc99f9cec77878798f6d3caf5
 SHA512:
-  metadata.gz: 054cbd509a8a694e7b3c56a068f10256b0563a3327d9d4032236a996cd7c9d2af2d761e65573f2a17e0fd9f475bb9eb4a388e3cb6b6f147b6d3fa41548589f32
-  data.tar.gz: 0cbe6605e8b2c9e913a97ad1810d837ee84c3480da6e713107bf031ba0100c6be31633941a2930f422fd11dec915633699b484f7bf14ef00bf89e3d25fca6492
+  metadata.gz: e7a700660cc4938aea1e2f413a9c02b05dae9d7f17db5c78e9710f804206d294c62f7de4cf7bbafb0dca7ea839bf9b8d9d9bb33ae0698ea2df9dd4043a0fb950
+  data.tar.gz: a5de101243c4b173a64449a8355b19ab4e578a743b92e3b6f70ef917a95d40e2e9f3f1d38ff0f83d5da8172b8ae4cb81914f075fb4aaca042d151abeb46c9c92

data/Gemfile.lock

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

data/README.md

@@ -163,6 +163,21 @@ When the `wait_for_action_attempt` option is enabled, the SDK:
 - Raises a `Seam::ActionAttemptTimeoutError` if the action attempt is still pending when the `timeout` is reached.
 - Both errors expose an `action_attempt` property.
 
+The `error` and `result` values are only present for their matching status:
+`error` is `nil` unless the `status` is `"error"`,
+and `result` is `nil` unless the `status` is `"success"`.
+
+```ruby
+action_attempt = seam.locks.unlock_door(
+  device_id: device_id,
+  wait_for_action_attempt: false
+)
+
+action_attempt.status # => "pending"
+action_attempt.error  # => nil
+action_attempt.result # => nil
+```
+
 If you already have an action attempt ID
 and want to wait for it to resolve, simply use:
 

data/lib/seam/base_resource.rb

@@ -78,6 +78,14 @@ module Seam
         end
       end
 
+      def self.available_only_for_statuses(attr, statuses)
+        unscoped = instance_method(attr)
+        define_method(attr) do
+          statuses.include?(status) ? unscoped.bind_call(self) : nil
+        end
+      end
+      private_class_method :available_only_for_statuses
+
       def self.resource_accessors
         @resource_accessors ||= {}
       end

data/lib/seam/resources/action_attempt.rb

@@ -32,10 +32,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -71,10 +75,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -399,10 +407,14 @@ module Seam
         end
 
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -644,10 +656,14 @@ module Seam
         end
 
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -883,10 +899,14 @@ module Seam
         end
 
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1058,10 +1078,14 @@ module Seam
         end
 
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of assigning a credential. If successful, includes the updated access method with the assigned credential.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1094,10 +1118,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1130,10 +1158,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1166,10 +1198,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1202,10 +1238,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1238,10 +1278,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1274,10 +1318,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1310,10 +1358,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1346,10 +1398,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1381,10 +1437,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1419,10 +1479,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1454,10 +1518,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1492,10 +1560,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1530,10 +1602,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1565,10 +1641,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1603,10 +1683,14 @@ module Seam
 
         # Error associated with the action.
         # @return [Error, nil]
+        # Only present when `status` is `error`; `nil` otherwise.
         resource_accessor :error, Error
+        available_only_for_statuses :error, ["error"]
         # Result of the action.
         # @return [Result, nil]
+        # Only present when `status` is `success`; `nil` otherwise.
         resource_accessor :result, Result
+        available_only_for_statuses :result, ["success"]
         # ID of the action attempt.
         # @return [String]
         attr_accessor :action_attempt_id
@@ -1623,11 +1707,14 @@ module Seam
         attr_accessor :status
       end
 
-      # Error associated with the action.
       # @return [Error, nil]
+      # Only present when `status` is `error`; `nil` otherwise.
       resource_accessor :error, Error
+      available_only_for_statuses :error, ["error"]
       # @return [Result, nil]
+      # Only present when `status` is `success`; `nil` otherwise.
       resource_accessor :result, Result
+      available_only_for_statuses :result, ["success"]
       # ID of the action attempt.
       # @return [String]
       attr_accessor :action_attempt_id

data/lib/seam/version.rb

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

data/lib/seam/wait_for_action_attempt.rb

@@ -18,8 +18,10 @@ module Seam
     attr_reader :code
 
     def initialize(action_attempt)
-      super(action_attempt.error.message, action_attempt)
-      @code = action_attempt.error.type
+      error = action_attempt.error
+      message = (error && error["message"]) || "Action attempt failed"
+      super(message, action_attempt)
+      @code = error && error["type"]
     end
   end
 

metadata

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