finch-api 0.1.0.pre.alpha.53 → 0.1.0.pre.alpha.55

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d9261f34506bfef4ca99dc81cb63d8f50725777bd384079bcea8fac1739b3c
-  data.tar.gz: '0109404f9138252e1ffc5454dcee408699f4e6f46efc8b52c510a8d746ddafcf'
+  metadata.gz: 6eee3021f4fc42cd9883cd280e27567db13660d06902e6632f99e07ec0722fc4
+  data.tar.gz: beb752156687e60dfc0e570c7d5418361b74e374c563ef1591c32f0875fd18d1
 SHA512:
-  metadata.gz: 396a988d943b86e32bc28e6b2a6b7b5cfaf10993e08a2fa0cd8c7447f910f273d201ca2bb8c3b8fcb8618f8c04c68b6a4e7b517e941c9805af98771897e682d8
-  data.tar.gz: ce82d17d00d395a98fa9ae2ee12c9d2e0f600091b5e3e8c59cd3d9e7590b2db1f97c23583bf90070b630e377b18f54b6b04913d6d6f0479d97d634d57de2a816
+  metadata.gz: b0e288e8c437c82ea6d382877e1ec8ac6b553df761beb161b1c4d9b7343089b2d9f9424b745c02ea5edad724d65357e08939a1bffe3d71a8d777e7c5f9c2e4fd
+  data.tar.gz: 789d1b194b665bb969760140be9813aa34ecf30990e324980860653b4a818a8e9e2075c16eb1ddc1504f98fc94997815fb9ae3fd141f48385884b8fe8c9f0e71

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.1.0-alpha.55](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.54...v0.1.0-alpha.55) (2026-08-20)
+
+
+### Features
+
+* **stainless:** migrate SDK generation from Stainless SaaS to self-hosted stlc - PLAT-3989 ([3b99962](https://github.com/Finch-API/finch-api-ruby/commit/3b99962dbd58f8c0566f8412406cce02c73c272a))
+
+## 0.1.0-alpha.54 (2026-08-07)
+
+Full Changelog: [v0.1.0-alpha.53...v0.1.0-alpha.54](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.53...v0.1.0-alpha.54)
+
+### Features
+
+* **api:** api update ([49620bb](https://github.com/Finch-API/finch-api-ruby/commit/49620bb6a71aaa6bce7078c57020f36c63f2a778))
+
 ## 0.1.0-alpha.53 (2026-08-07)
 
 Full Changelog: [v0.1.0-alpha.52...v0.1.0-alpha.53](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.52...v0.1.0-alpha.53)

data/README.md

@@ -26,7 +26,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.53"
+gem "finch-api", "~> 0.1.0-alpha.55.pre.alpha.54"
 ```
 
 <!-- x-release-please-end -->

data/lib/finch_api/models/connect/session_new_params.rb

@@ -54,6 +54,14 @@ module FinchAPI
         #   @return [Float, nil]
         optional :minutes_to_expire, Float, nil?: true
 
+        # @!attribute recordkeeping
+        #   Optional recordkeeping configuration. Can only be provided when the
+        #   `recordkeeping` product is requested. Currently supports `recordkeeper` set to
+        #   `voya`, `empower`, `fidelity`, or `transamerica`.
+        #
+        #   @return [FinchAPI::Models::Connect::SessionNewParams::Recordkeeping, nil]
+        optional :recordkeeping, -> { FinchAPI::Connect::SessionNewParams::Recordkeeping }, nil?: true
+
         # @!attribute redirect_uri
         #   The URI to redirect to after the Connect flow is completed
         #
@@ -66,7 +74,7 @@ module FinchAPI
         #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil]
         optional :sandbox, enum: -> { FinchAPI::Connect::SessionNewParams::Sandbox }, nil?: true
 
-        # @!method initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {})
+        # @!method initialize(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, recordkeeping: nil, redirect_uri: nil, sandbox: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Connect::SessionNewParams} for more details.
         #
@@ -84,6 +92,8 @@ module FinchAPI
         #
         #   @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 129,600, which is 9
         #
+        #   @param recordkeeping [FinchAPI::Models::Connect::SessionNewParams::Recordkeeping, nil] Optional recordkeeping configuration. Can only be provided when the `recordkeepi
+        #
         #   @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
         #
         #   @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] Sandbox mode for testing
@@ -150,6 +160,44 @@ module FinchAPI
           end
         end
 
+        class Recordkeeping < FinchAPI::Internal::Type::BaseModel
+          # @!attribute recordkeeper
+          #   The recordkeeper to configure for this connection
+          #
+          #   @return [Symbol, FinchAPI::Models::Connect::SessionNewParams::Recordkeeping::Recordkeeper]
+          required :recordkeeper, enum: -> { FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper }
+
+          # @!attribute plan_id
+          #   The plan identifier used by the recordkeeper
+          #
+          #   @return [String, nil]
+          optional :plan_id, String, nil?: true
+
+          # @!method initialize(recordkeeper:, plan_id: nil)
+          #   Optional recordkeeping configuration. Can only be provided when the
+          #   `recordkeeping` product is requested. Currently supports `recordkeeper` set to
+          #   `voya`, `empower`, `fidelity`, or `transamerica`.
+          #
+          #   @param recordkeeper [Symbol, FinchAPI::Models::Connect::SessionNewParams::Recordkeeping::Recordkeeper] The recordkeeper to configure for this connection
+          #
+          #   @param plan_id [String, nil] The plan identifier used by the recordkeeper
+
+          # The recordkeeper to configure for this connection
+          #
+          # @see FinchAPI::Models::Connect::SessionNewParams::Recordkeeping#recordkeeper
+          module Recordkeeper
+            extend FinchAPI::Internal::Type::Enum
+
+            VOYA = :voya
+            EMPOWER = :empower
+            FIDELITY = :fidelity
+            TRANSAMERICA = :transamerica
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # Sandbox mode for testing
         module Sandbox
           extend FinchAPI::Internal::Type::Enum

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

@@ -21,11 +21,6 @@ module FinchAPI
         required :authentication_type,
                  enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType }
 
-        # @!attribute company_id
-        #
-        #   @return [String, nil]
-        required :company_id, String, nil?: true
-
         # @!attribute connection_id
         #
         #   @return [String]
@@ -51,16 +46,21 @@ module FinchAPI
         #   @return [String]
         required :token_type, String
 
-        # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:, token_type:)
+        # @!attribute company_id
+        #
+        #   @return [String, nil]
+        optional :company_id, String, nil?: true
+
+        # @!method initialize(access_token:, account_id:, authentication_type:, connection_id:, entity_id:, products:, provider_id:, token_type:, company_id: nil)
         #   @param access_token [String]
         #   @param account_id [String]
         #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType]
-        #   @param company_id [String, nil]
         #   @param connection_id [String]
         #   @param entity_id [String]
         #   @param products [Array<String>]
         #   @param provider_id [String]
         #   @param token_type [String]
+        #   @param company_id [String, nil]
 
         # @see FinchAPI::Models::Sandbox::ConnectionCreateResponse#authentication_type
         module AuthenticationType

data/lib/finch_api/resources/connect/sessions.rb

@@ -9,7 +9,7 @@ module FinchAPI
         #
         # Create a new connect session for an employer
         #
-        # @overload new(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, request_options: {})
+        # @overload new(customer_id:, customer_name:, products:, customer_email: nil, integration: nil, manual: nil, minutes_to_expire: nil, recordkeeping: nil, redirect_uri: nil, sandbox: nil, request_options: {})
         #
         # @param customer_id [String] Unique identifier for the customer
         #
@@ -25,6 +25,8 @@ module FinchAPI
         #
         # @param minutes_to_expire [Float, nil] The number of minutes until the session expires (defaults to 129,600, which is 9
         #
+        # @param recordkeeping [FinchAPI::Models::Connect::SessionNewParams::Recordkeeping, nil] Optional recordkeeping configuration. Can only be provided when the `recordkeepi
+        #
         # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
         #
         # @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] Sandbox mode for testing

data/lib/finch_api/version.rb

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

data/rbi/finch_api/models/connect/session_new_params.rbi

@@ -62,6 +62,24 @@ module FinchAPI
         sig { returns(T.nilable(Float)) }
         attr_accessor :minutes_to_expire
 
+        # Optional recordkeeping configuration. Can only be provided when the
+        # `recordkeeping` product is requested. Currently supports `recordkeeper` set to
+        # `voya`, `empower`, `fidelity`, or `transamerica`.
+        sig do
+          returns(T.nilable(FinchAPI::Connect::SessionNewParams::Recordkeeping))
+        end
+        attr_reader :recordkeeping
+
+        sig do
+          params(
+            recordkeeping:
+              T.nilable(
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::OrHash
+              )
+          ).void
+        end
+        attr_writer :recordkeeping
+
         # The URI to redirect to after the Connect flow is completed
         sig { returns(T.nilable(String)) }
         attr_accessor :redirect_uri
@@ -87,6 +105,10 @@ module FinchAPI
               ),
             manual: T.nilable(T::Boolean),
             minutes_to_expire: T.nilable(Float),
+            recordkeeping:
+              T.nilable(
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::OrHash
+              ),
             redirect_uri: T.nilable(String),
             sandbox:
               T.nilable(FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol),
@@ -111,6 +133,10 @@ module FinchAPI
           # The number of minutes until the session expires (defaults to 129,600, which is
           # 90 days)
           minutes_to_expire: nil,
+          # Optional recordkeeping configuration. Can only be provided when the
+          # `recordkeeping` product is requested. Currently supports `recordkeeper` set to
+          # `voya`, `empower`, `fidelity`, or `transamerica`.
+          recordkeeping: nil,
           # The URI to redirect to after the Connect flow is completed
           redirect_uri: nil,
           # Sandbox mode for testing
@@ -133,6 +159,8 @@ module FinchAPI
                 T.nilable(FinchAPI::Connect::SessionNewParams::Integration),
               manual: T.nilable(T::Boolean),
               minutes_to_expire: T.nilable(Float),
+              recordkeeping:
+                T.nilable(FinchAPI::Connect::SessionNewParams::Recordkeeping),
               redirect_uri: T.nilable(String),
               sandbox:
                 T.nilable(
@@ -337,6 +365,103 @@ module FinchAPI
           end
         end
 
+        class Recordkeeping < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                FinchAPI::Connect::SessionNewParams::Recordkeeping,
+                FinchAPI::Internal::AnyHash
+              )
+            end
+
+          # The recordkeeper to configure for this connection
+          sig do
+            returns(
+              FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::OrSymbol
+            )
+          end
+          attr_accessor :recordkeeper
+
+          # The plan identifier used by the recordkeeper
+          sig { returns(T.nilable(String)) }
+          attr_accessor :plan_id
+
+          # Optional recordkeeping configuration. Can only be provided when the
+          # `recordkeeping` product is requested. Currently supports `recordkeeper` set to
+          # `voya`, `empower`, `fidelity`, or `transamerica`.
+          sig do
+            params(
+              recordkeeper:
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::OrSymbol,
+              plan_id: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The recordkeeper to configure for this connection
+            recordkeeper:,
+            # The plan identifier used by the recordkeeper
+            plan_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                recordkeeper:
+                  FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::OrSymbol,
+                plan_id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The recordkeeper to configure for this connection
+          module Recordkeeper
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            VOYA =
+              T.let(
+                :voya,
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::TaggedSymbol
+              )
+            EMPOWER =
+              T.let(
+                :empower,
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::TaggedSymbol
+              )
+            FIDELITY =
+              T.let(
+                :fidelity,
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::TaggedSymbol
+              )
+            TRANSAMERICA =
+              T.let(
+                :transamerica,
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::Connect::SessionNewParams::Recordkeeping::Recordkeeper::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # Sandbox mode for testing
         module Sandbox
           extend FinchAPI::Internal::Type::Enum

data/rbi/finch_api/models/sandbox/connection_create_response.rbi

@@ -25,9 +25,6 @@ module FinchAPI
         end
         attr_accessor :authentication_type
 
-        sig { returns(T.nilable(String)) }
-        attr_accessor :company_id
-
         sig { returns(String) }
         attr_accessor :connection_id
 
@@ -43,30 +40,33 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :token_type
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :company_id
+
         sig do
           params(
             access_token: String,
             account_id: String,
             authentication_type:
               FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::OrSymbol,
-            company_id: T.nilable(String),
             connection_id: String,
             entity_id: String,
             products: T::Array[String],
             provider_id: String,
-            token_type: String
+            token_type: String,
+            company_id: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
           access_token:,
           account_id:,
           authentication_type:,
-          company_id:,
           connection_id:,
           entity_id:,
           products:,
           provider_id:,
-          token_type:
+          token_type:,
+          company_id: nil
         )
         end
 
@@ -77,12 +77,12 @@ module FinchAPI
               account_id: String,
               authentication_type:
                 FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol,
-              company_id: T.nilable(String),
               connection_id: String,
               entity_id: String,
               products: T::Array[String],
               provider_id: String,
-              token_type: String
+              token_type: String,
+              company_id: T.nilable(String)
             }
           )
         end

data/rbi/finch_api/resources/connect/sessions.rbi

@@ -18,6 +18,10 @@ module FinchAPI
               ),
             manual: T.nilable(T::Boolean),
             minutes_to_expire: T.nilable(Float),
+            recordkeeping:
+              T.nilable(
+                FinchAPI::Connect::SessionNewParams::Recordkeeping::OrHash
+              ),
             redirect_uri: T.nilable(String),
             sandbox:
               T.nilable(FinchAPI::Connect::SessionNewParams::Sandbox::OrSymbol),
@@ -42,6 +46,10 @@ module FinchAPI
           # The number of minutes until the session expires (defaults to 129,600, which is
           # 90 days)
           minutes_to_expire: nil,
+          # Optional recordkeeping configuration. Can only be provided when the
+          # `recordkeeping` product is requested. Currently supports `recordkeeper` set to
+          # `voya`, `empower`, `fidelity`, or `transamerica`.
+          recordkeeping: nil,
           # The URI to redirect to after the Connect flow is completed
           redirect_uri: nil,
           # Sandbox mode for testing

data/sig/finch_api/models/connect/session_new_params.rbs

@@ -10,6 +10,7 @@ module FinchAPI
           integration: FinchAPI::Connect::SessionNewParams::Integration?,
           manual: bool?,
           minutes_to_expire: Float?,
+          recordkeeping: FinchAPI::Connect::SessionNewParams::Recordkeeping?,
           redirect_uri: String?,
           sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?
         }
@@ -33,6 +34,8 @@ module FinchAPI
 
         attr_accessor minutes_to_expire: Float?
 
+        attr_accessor recordkeeping: FinchAPI::Connect::SessionNewParams::Recordkeeping?
+
         attr_accessor redirect_uri: String?
 
         attr_accessor sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?
@@ -45,6 +48,7 @@ module FinchAPI
           ?integration: FinchAPI::Connect::SessionNewParams::Integration?,
           ?manual: bool?,
           ?minutes_to_expire: Float?,
+          ?recordkeeping: FinchAPI::Connect::SessionNewParams::Recordkeeping?,
           ?redirect_uri: String?,
           ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?,
           ?request_options: FinchAPI::request_opts
@@ -58,6 +62,7 @@ module FinchAPI
           integration: FinchAPI::Connect::SessionNewParams::Integration?,
           manual: bool?,
           minutes_to_expire: Float?,
+          recordkeeping: FinchAPI::Connect::SessionNewParams::Recordkeeping?,
           redirect_uri: String?,
           sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?,
           request_options: FinchAPI::RequestOptions
@@ -135,6 +140,41 @@ module FinchAPI
           end
         end
 
+        type recordkeeping =
+          {
+            recordkeeper: FinchAPI::Models::Connect::SessionNewParams::Recordkeeping::recordkeeper,
+            plan_id: String?
+          }
+
+        class Recordkeeping < FinchAPI::Internal::Type::BaseModel
+          attr_accessor recordkeeper: FinchAPI::Models::Connect::SessionNewParams::Recordkeeping::recordkeeper
+
+          attr_accessor plan_id: String?
+
+          def initialize: (
+            recordkeeper: FinchAPI::Models::Connect::SessionNewParams::Recordkeeping::recordkeeper,
+            ?plan_id: String?
+          ) -> void
+
+          def to_hash: -> {
+            recordkeeper: FinchAPI::Models::Connect::SessionNewParams::Recordkeeping::recordkeeper,
+            plan_id: String?
+          }
+
+          type recordkeeper = :voya | :empower | :fidelity | :transamerica
+
+          module Recordkeeper
+            extend FinchAPI::Internal::Type::Enum
+
+            VOYA: :voya
+            EMPOWER: :empower
+            FIDELITY: :fidelity
+            TRANSAMERICA: :transamerica
+
+            def self?.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::Recordkeeping::recordkeeper]
+          end
+        end
+
         type sandbox = :finch | :provider
 
         module Sandbox

data/sig/finch_api/models/sandbox/connection_create_response.rbs

@@ -6,12 +6,12 @@ module FinchAPI
           access_token: String,
           account_id: String,
           authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
-          company_id: String?,
           connection_id: String,
           entity_id: String,
           products: ::Array[String],
           provider_id: String,
-          token_type: String
+          token_type: String,
+          company_id: String?
         }
 
       class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel
@@ -21,8 +21,6 @@ module FinchAPI
 
         attr_accessor authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type
 
-        attr_accessor company_id: String?
-
         attr_accessor connection_id: String
 
         attr_accessor entity_id: String
@@ -33,28 +31,30 @@ module FinchAPI
 
         attr_accessor token_type: String
 
+        attr_accessor company_id: String?
+
         def initialize: (
           access_token: String,
           account_id: String,
           authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
-          company_id: String?,
           connection_id: String,
           entity_id: String,
           products: ::Array[String],
           provider_id: String,
-          token_type: String
+          token_type: String,
+          ?company_id: String?
         ) -> void
 
         def to_hash: -> {
           access_token: String,
           account_id: String,
           authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
-          company_id: String?,
           connection_id: String,
           entity_id: String,
           products: ::Array[String],
           provider_id: String,
-          token_type: String
+          token_type: String,
+          company_id: String?
         }
 
         type authentication_type = :api_token | :assisted | :credential | :oauth

data/sig/finch_api/resources/connect/sessions.rbs

@@ -10,6 +10,7 @@ module FinchAPI
           ?integration: FinchAPI::Connect::SessionNewParams::Integration?,
           ?manual: bool?,
           ?minutes_to_expire: Float?,
+          ?recordkeeping: FinchAPI::Connect::SessionNewParams::Recordkeeping?,
           ?redirect_uri: String?,
           ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?,
           ?request_options: FinchAPI::request_opts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.53
+  version: 0.1.0.pre.alpha.55
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-07 00:00:00.000000000 Z
+date: 2026-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi