finch-api 0.1.0.pre.alpha.36 → 0.1.0.pre.alpha.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1123f76013d8df32bff8cd3a6a3638af2a38ce653465da9293fe232e94a685
-  data.tar.gz: cd7c902e81cddd119af77d7f20b46043e653c9be23244bf8867cee42fd6cb526
+  metadata.gz: c373b41d8ec9162cf4f4a50d8ffb8cbdb2739e81bf4e6d18f3cd50465002d363
+  data.tar.gz: b06a4865378ccf104f73235380afac0ac5c2e16bc2126c2bd1d256d7519f4e4d
 SHA512:
-  metadata.gz: ca4aeba0ce1ea0e7a410644d82b1f9de08d233d8c73a40060b42662d8488a188feab1f8ffa310f6e5d04354cac5eb79263350d924112de995acfb65badd8e172
-  data.tar.gz: 98d6111a9d3eab330d22ef417776d6aeff31021f932742fc99e664890ee682c0878facc71fc65218e57dab4bf861c50204f32b65159e05dcc824b234f3402e77
+  metadata.gz: 643c7e5f63688fefcf77457038d98fcae7ed1131059107b097cba2c47ceed4ed29be2362888c6f38c020effe071b19645816a4d7303a64b13d919e1cbf9f7817
+  data.tar.gz: e0ef99cd6d99d60507ae5b270e61b7c1bc0229b8950789f9aaa0d6b4d90f2b81c9b02cff0867bfe28adf3490bedc4bbac6e777bd27a40a4f134acc2a48fd0f0b

data/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)

data/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 -->

data/lib/finch_api/models/request_forwarding_forward_params.rb

@@ -29,26 +29,26 @@ module FinchAPI
       #   @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 @@ module FinchAPI
       #
       #   @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

data/lib/finch_api/models/sandbox/payment_create_params.rb

@@ -160,6 +160,7 @@ module FinchAPI
             optional :amount, Integer
 
             # @!attribute name
+            #   The deduction name. Required when type is specified.
             #
             #   @return [String, nil]
             optional :name, String
@@ -176,8 +177,11 @@ module FinchAPI
 
             # @!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 @@ module FinchAPI
             optional :amount, Integer
 
             # @!attribute name
+            #   The contribution name. Required when type is specified.
             #
             #   @return [String, nil]
             optional :name, String
@@ -228,7 +233,9 @@ module FinchAPI
 
             # @!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

data/lib/finch_api/resources/request_forwarding.rb

@@ -11,7 +11,7 @@ module FinchAPI
       # 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`
       #
@@ -19,10 +19,10 @@ module FinchAPI
       #
       # @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]

data/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

data/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
           }
         )

data/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

data/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

data/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,16 +20,16 @@ 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
 
@@ -37,8 +37,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::RequestOptions
       }
     end

data/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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.36
+  version: 0.1.0.pre.alpha.37
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-21 00:00:00.000000000 Z
+date: 2025-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool