seam 2.148.0 → 2.149.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06196d87a7db7cb6f396e2ce2f94f02d9dfb2c2eecff52fa314df6d95856ff57'
-  data.tar.gz: f7be00a016e5c13fc8e937595b80302453ae8625d27df6a0541d1eacf5b3504e
+  metadata.gz: 20eb2c8e0938d5dcb96d337254d2eaba3c77d9c1fe672292c09af488638aa3b3
+  data.tar.gz: 24d8ca1c9ce0dd9f901fc19fcb48990885e9301a9feb0fa26fd890cd0fdc55e6
 SHA512:
-  metadata.gz: 68f7a956b71ae32046af99e15b612d1fa1ac4a689539dadf795776bdd873ea5bd4ed7ace6105f17678c760184567a02bd5b6d472d0c536ab19eba4fa3e45f655
-  data.tar.gz: 66906c6e6172416dc861bb7dc71b6e51a49baba23331b4ddc5d0ef1fa6f677fa13841bd913a6c2537cfbc00eaf74e9700f14cef44907efbff213960836ac5b75
+  metadata.gz: 054cbd509a8a694e7b3c56a068f10256b0563a3327d9d4032236a996cd7c9d2af2d761e65573f2a17e0fd9f475bb9eb4a388e3cb6b6f147b6d3fa41548589f32
+  data.tar.gz: 0cbe6605e8b2c9e913a97ad1810d837ee84c3480da6e713107bf031ba0100c6be31633941a2930f422fd11dec915633699b484f7bf14ef00bf89e3d25fca6492

data/Gemfile.lock

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

data/README.md

@@ -35,6 +35,8 @@ constraints.
     - [Resume pagination](#resume-pagination)
     - [Iterate over all resources](#iterate-over-all-resources)
     - [Return all resources across all pages as a list](#return-all-resources-across-all-pages-as-a-list)
+  - [Error Handling](#error-handling)
+    - [Validation errors](#validation-errors)
   - [Requests without a Workspace in scope](#requests-without-a-workspace-in-scope)
     - [Personal Access Token](#personal-access-token-1)
   - [Webhooks](#webhooks)
@@ -352,6 +354,33 @@ paginator = seam.create_paginator(seam.devices.method(:list), {limit: 20})
 all_devices = paginator.flatten_to_list
 ```
 
+### Error Handling
+
+Requests rejected by the Seam API raise a `Seam::Http::ApiError` subclass
+carrying the HTTP `status_code`, API error `code`, and `request_id`.
+
+#### Validation errors
+
+When the API rejects a request because a parameter is invalid, it raises a
+`Seam::Http::InvalidInputError`. Look up messages for a parameter you are
+already rendering, for example a field in a form:
+
+```ruby
+begin
+  seam.devices.list(device_ids: ["not-a-uuid"])
+rescue Seam::Http::InvalidInputError => error
+  puts error.get_validation_error_messages("device_ids")
+end
+```
+
+Or read every parameter that failed validation to summarize the request:
+
+```ruby
+error.validation_errors.each do |validation_error|
+  puts "#{validation_error.parameter_name}: #{validation_error.error_messages.join(", ")}"
+end
+```
+
 ### Requests without a Workspace in scope
 
 Some Seam API endpoints do not require a workspace in scope.

data/lib/seam/http.rb

@@ -36,17 +36,24 @@ module Seam
       end
     end
 
+    ValidationError = Data.define(:parameter_name, :error_messages)
+
     class InvalidInputError < ApiError
       attr_reader :validation_errors
 
       def initialize(error, status_code, request_id)
         super
         @code = "invalid_input"
-        @validation_errors = error["validation_errors"] || {}
+        @raw_validation_errors = error["validation_errors"] || {}
+        @validation_errors = @raw_validation_errors.filter_map do |parameter_name, _|
+          next if parameter_name == "_errors"
+
+          ValidationError.new(parameter_name:, error_messages: get_validation_error_messages(parameter_name))
+        end
       end
 
       def get_validation_error_messages(param_name)
-        @validation_errors.dig(param_name, "_errors") || []
+        @raw_validation_errors.dig(param_name, "_errors") || []
       end
     end
   end

data/lib/seam/version.rb

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

metadata

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