chore: more accurate type annotations and aliases

Author: stainless-app[bot]

lib/finch_api/errors.rb

@@ -3,9 +3,9 @@
 module FinchAPI
   module Errors
     class Error < StandardError
-      # @!parse
-      #   # @return [StandardError, nil]
-      #   attr_accessor :cause
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
     end
 
     class ConversionError < FinchAPI::Errors::Error
@@ -40,13 +40,13 @@ def initialize(url:, status: nil, body: nil, request: nil, response: nil, messag
     end
 
     class APIConnectionError < FinchAPI::Errors::APIError
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :status
+      # @!attribute status
+      #
+      #   @return [nil]
 
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :body
+      # @!attribute body
+      #
+      #   @return [nil]
 
       # @api private
       #

lib/finch_api/internal/type/boolean.rb

@@ -46,17 +46,16 @@ def coerce(value, state:)
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Boolean, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Boolean, Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Boolean, Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Boolean, Object]
         end
       end
     end

lib/finch_api/internal/type/enum.rb

@@ -100,17 +100,16 @@ def coerce(value, state:)
           end
         end
 
-        # @!parse
-        #   # @api private
-        #   #
-        #   # @param value [Symbol, Object]
-        #   #
-        #   # @param state [Hash{Symbol=>Object}] .
-        #   #
-        #   #   @option state [Boolean] :can_retry
-        #   #
-        #   # @return [Symbol, Object]
-        #   def dump(value, state:) = super
+        # @!method dump(value, state:)
+        #   @api private
+        #
+        #   @param value [Symbol, Object]
+        #
+        #   @param state [Hash{Symbol=>Object}] .
+        #
+        #     @option state [Boolean] :can_retry
+        #
+        #   @return [Symbol, Object]
 
         # @api private
         #

lib/finch_api/internal/type/unknown.rb

@@ -48,17 +48,16 @@ def coerce(value, state:)
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Object]
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

lib/finch_api/request_options.rb

@@ -65,10 +65,9 @@ def self.validate!(opts)
     #   @return [Float, nil]
     optional :timeout, Float
 
-    # @!parse
-    #   # @!method initialize(values = {})
-    #   #   Returns a new instance of RequestOptions.
-    #   #
-    #   #   @param values [Hash{Symbol=>Object}]
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
   end
 end

test/finch_api/file_part_test.rb

@@ -8,5 +8,6 @@ def test_to_json
     filepart = FinchAPI::FilePart.new(StringIO.new(text))
 
     assert_equal(text.to_json, filepart.to_json)
+    assert_equal(text.to_yaml, filepart.to_yaml)
   end
 end