release: 0.1.0-alpha.37

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.36"
+  ".": "0.1.0-alpha.37"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-970ab04a97244c68824c0c52e06925cba14fb7dbfc36c03167c1afe74cd1b150.yml
-openapi_spec_hash: 315e7859c3f77311261fb824b74a8247
-config_hash: f2846563903bf75ab0858872154df0f7
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-39e0191e43a9db93c8f35e91d10013f05352a2bedcf7ead6bac437957f6e922e.yml
+openapi_spec_hash: 58c2cf578f0736b8c5df957f6a61190b
+config_hash: 0892e2e0eeb0343a022afa62e9080dd1

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.37 (2025-12-01)
+
+Full Changelog: [v0.1.0-alpha.36...v0.1.0-alpha.37](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.36...v0.1.0-alpha.37)
+
+### Features
+
+* **api:** api update ([4ada9ae](https://github.com/Finch-API/finch-api-ruby/commit/4ada9aea1a5477c50ad4c2d1158edc4056b9bcce))
+
 ## 0.1.0-alpha.36 (2025-11-20)
 
 Full Changelog: [v0.1.0-alpha.35...v0.1.0-alpha.36](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.35...v0.1.0-alpha.36)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    finch-api (0.1.0.pre.alpha.36)
+    finch-api (0.1.0.pre.alpha.37)
       connection_pool
 
 GEM

README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "finch-api", "~> 0.1.0.pre.alpha.36"
+gem "finch-api", "~> 0.1.0.pre.alpha.37"
 ```
 
 <!-- x-release-please-end -->

lib/finch_api/models/request_forwarding_forward_params.rb

@@ -29,26 +29,26 @@ class RequestForwardingForwardParams < FinchAPI::Internal::Type::BaseModel
       #   @return [String, nil]
       optional :data, String, nil?: true
 
-      # @!attribute headers
-      #   The HTTP headers to include on the forwarded request. This value must be
-      #   specified as an object of key-value pairs. Example:
-      #   `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
+      # @!attribute params
+      #   The query parameters for the forwarded request. This value must be specified as
+      #   a valid JSON object rather than a query string.
       #
       #   @return [Hash{Symbol=>Object, nil}, nil]
-      optional :headers,
+      optional :params,
                FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
                nil?: true
 
-      # @!attribute params
-      #   The query parameters for the forwarded request. This value must be specified as
-      #   a valid JSON object rather than a query string.
+      # @!attribute request_headers
+      #   The HTTP headers to include on the forwarded request. This value must be
+      #   specified as an object of key-value pairs. Example:
+      #   `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
       #
       #   @return [Hash{Symbol=>Object, nil}, nil]
-      optional :params,
+      optional :request_headers,
                FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
                nil?: true
 
-      # @!method initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
+      # @!method initialize(method_:, route:, data: nil, params: nil, request_headers: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::RequestForwardingForwardParams} for more details.
       #
@@ -58,10 +58,10 @@ class RequestForwardingForwardParams < FinchAPI::Internal::Type::BaseModel
       #
       #   @param data [String, nil] The body for the forwarded request. This value must be specified as either a str
       #
-      #   @param headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers to include on the forwarded request. This value must be specifi
-      #
       #   @param params [Hash{Symbol=>Object, nil}, nil] The query parameters for the forwarded request. This value must be specified as
       #
+      #   @param request_headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers to include on the forwarded request. This value must be specifi
+      #
       #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/finch_api/models/sandbox/payment_create_params.rb

@@ -160,6 +160,7 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
             optional :amount, Integer
 
             # @!attribute name
+            #   The deduction name. Required when type is specified.
             #
             #   @return [String, nil]
             optional :name, String
@@ -176,8 +177,11 @@ class EmployeeDeduction < FinchAPI::Internal::Type::BaseModel
 
             # @!method initialize(amount: nil, name: nil, pre_tax: nil, type: nil)
             #   @param amount [Integer]
-            #   @param name [String]
+            #
+            #   @param name [String] The deduction name. Required when type is specified.
+            #
             #   @param pre_tax [Boolean]
+            #
             #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type]
 
             # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction#type
@@ -216,6 +220,7 @@ class EmployerContribution < FinchAPI::Internal::Type::BaseModel
             optional :amount, Integer
 
             # @!attribute name
+            #   The contribution name. Required when type is specified.
             #
             #   @return [String, nil]
             optional :name, String
@@ -228,7 +233,9 @@ class EmployerContribution < FinchAPI::Internal::Type::BaseModel
 
             # @!method initialize(amount: nil, name: nil, type: nil)
             #   @param amount [Integer]
-            #   @param name [String]
+            #
+            #   @param name [String] The contribution name. Required when type is specified.
+            #
             #   @param type [Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type]
 
             # @see FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution#type

lib/finch_api/resources/request_forwarding.rb

@@ -11,18 +11,18 @@ class RequestForwarding
       # Forward allows you to push or pull data models directly against an integration's
       # API.
       #
-      # @overload forward(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})
+      # @overload forward(method_:, route:, data: nil, params: nil, request_headers: nil, request_options: {})
       #
       # @param method_ [String] The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
       #
       # @param route [String] The URL route path for the forwarded request. This value must begin with a forwa
       #
       # @param data [String, nil] The body for the forwarded request. This value must be specified as either a str
       #
-      # @param headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers to include on the forwarded request. This value must be specifi
-      #
       # @param params [Hash{Symbol=>Object, nil}, nil] The query parameters for the forwarded request. This value must be specified as
       #
+      # @param request_headers [Hash{Symbol=>Object, nil}, nil] The HTTP headers to include on the forwarded request. This value must be specifi
+      #
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [FinchAPI::Models::RequestForwardingForwardResponse]

lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0.pre.alpha.36"
+  VERSION = "0.1.0.pre.alpha.37"
 end

rbi/finch_api/models/request_forwarding_forward_params.rbi

@@ -30,24 +30,24 @@ module FinchAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :data
 
-      # The HTTP headers to include on the forwarded request. This value must be
-      # specified as an object of key-value pairs. Example:
-      # `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
-      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
-      attr_accessor :headers
-
       # The query parameters for the forwarded request. This value must be specified as
       # a valid JSON object rather than a query string.
       sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
       attr_accessor :params
 
+      # The HTTP headers to include on the forwarded request. This value must be
+      # specified as an object of key-value pairs. Example:
+      # `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(T.anything)])) }
+      attr_accessor :request_headers
+
       sig do
         params(
           method_: String,
           route: String,
           data: T.nilable(String),
-          headers: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
           params: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+          request_headers: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
           request_options: FinchAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -62,13 +62,13 @@ module FinchAPI
         # The body for the forwarded request. This value must be specified as either a
         # string or a valid JSON object.
         data: nil,
-        # The HTTP headers to include on the forwarded request. This value must be
-        # specified as an object of key-value pairs. Example:
-        # `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
-        headers: nil,
         # The query parameters for the forwarded request. This value must be specified as
         # a valid JSON object rather than a query string.
         params: nil,
+        # The HTTP headers to include on the forwarded request. This value must be
+        # specified as an object of key-value pairs. Example:
+        # `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
+        request_headers: nil,
         request_options: {}
       )
       end
@@ -79,8 +79,8 @@ module FinchAPI
             method_: String,
             route: String,
             data: T.nilable(String),
-            headers: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
             params: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+            request_headers: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
             request_options: FinchAPI::RequestOptions
           }
         )

rbi/finch_api/models/sandbox/payment_create_params.rbi

@@ -471,6 +471,7 @@ module FinchAPI
             sig { params(amount: Integer).void }
             attr_writer :amount
 
+            # The deduction name. Required when type is specified.
             sig { returns(T.nilable(String)) }
             attr_reader :name
 
@@ -509,7 +510,13 @@ module FinchAPI
                   FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Type::OrSymbol
               ).returns(T.attached_class)
             end
-            def self.new(amount: nil, name: nil, pre_tax: nil, type: nil)
+            def self.new(
+              amount: nil,
+              # The deduction name. Required when type is specified.
+              name: nil,
+              pre_tax: nil,
+              type: nil
+            )
             end
 
             sig do
@@ -661,6 +668,7 @@ module FinchAPI
             sig { params(amount: Integer).void }
             attr_writer :amount
 
+            # The contribution name. Required when type is specified.
             sig { returns(T.nilable(String)) }
             attr_reader :name
 
@@ -692,7 +700,12 @@ module FinchAPI
                   FinchAPI::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Type::OrSymbol
               ).returns(T.attached_class)
             end
-            def self.new(amount: nil, name: nil, type: nil)
+            def self.new(
+              amount: nil,
+              # The contribution name. Required when type is specified.
+              name: nil,
+              type: nil
+            )
             end
 
             sig do

rbi/finch_api/resources/request_forwarding.rbi

@@ -12,8 +12,8 @@ module FinchAPI
           method_: String,
           route: String,
           data: T.nilable(String),
-          headers: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
           params: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+          request_headers: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
           request_options: FinchAPI::RequestOptions::OrHash
         ).returns(FinchAPI::Models::RequestForwardingForwardResponse)
       end
@@ -28,13 +28,13 @@ module FinchAPI
         # The body for the forwarded request. This value must be specified as either a
         # string or a valid JSON object.
         data: nil,
-        # The HTTP headers to include on the forwarded request. This value must be
-        # specified as an object of key-value pairs. Example:
-        # `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
-        headers: nil,
         # The query parameters for the forwarded request. This value must be specified as
         # a valid JSON object rather than a query string.
         params: nil,
+        # The HTTP headers to include on the forwarded request. This value must be
+        # specified as an object of key-value pairs. Example:
+        # `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
+        request_headers: nil,
         request_options: {}
       )
       end

sig/finch_api/models/request_forwarding_forward_params.rbs

@@ -5,8 +5,8 @@ module FinchAPI
         method_: String,
         route: String,
         data: String?,
-        headers: ::Hash[Symbol, top?]?,
-        params: ::Hash[Symbol, top?]?
+        params: ::Hash[Symbol, top?]?,
+        request_headers: ::Hash[Symbol, top?]?
       }
       & FinchAPI::Internal::Type::request_parameters
 
@@ -20,25 +20,25 @@ module FinchAPI
 
       attr_accessor data: String?
 
-      attr_accessor headers: ::Hash[Symbol, top?]?
-
       attr_accessor params: ::Hash[Symbol, top?]?
 
+      attr_accessor request_headers: ::Hash[Symbol, top?]?
+
       def initialize: (
         method_: String,
         route: String,
         ?data: String?,
-        ?headers: ::Hash[Symbol, top?]?,
         ?params: ::Hash[Symbol, top?]?,
+        ?request_headers: ::Hash[Symbol, top?]?,
         ?request_options: FinchAPI::request_opts
       ) -> void
 
       def to_hash: -> {
         method_: String,
         route: String,
         data: String?,
-        headers: ::Hash[Symbol, top?]?,
         params: ::Hash[Symbol, top?]?,
+        request_headers: ::Hash[Symbol, top?]?,
         request_options: FinchAPI::RequestOptions
       }
     end

sig/finch_api/resources/request_forwarding.rbs

@@ -5,8 +5,8 @@ module FinchAPI
         method_: String,
         route: String,
         ?data: String?,
-        ?headers: ::Hash[Symbol, top?]?,
         ?params: ::Hash[Symbol, top?]?,
+        ?request_headers: ::Hash[Symbol, top?]?,
         ?request_options: FinchAPI::request_opts
       ) -> FinchAPI::Models::RequestForwardingForwardResponse