finch-api 0.1.0.pre.alpha.28 → 0.1.0.pre.alpha.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf78c65c2b898a2b5031cd7fcc3328bfdc13e98431b09900bc6e1d8210edca8
-  data.tar.gz: 9d8bb5ffed3d5db0299511d1204935d73e3b3cf039e876925135cc17a8e405b9
+  metadata.gz: 1c13a4af631ebb4f8780ba93cd0678bae144e736eada662e057b3d3c05bdc4d2
+  data.tar.gz: 357f7b8c96ddc548b5337a47dae1bf906d97773a096753752109b054d881a612
 SHA512:
-  metadata.gz: 7886c407c082c9c2ca8070104bd1024515434914420b22e1a20df818cfe8d37aebac55d0687ea126f93dc3a0d1b7c4628d7b178dc5f7dcf8bdd93e5c9ede7be8
-  data.tar.gz: 23e139493a3c37ed53380063b9f3dd3507e542baea5f5c5afe59c95b2850f00e311bff1fe5fb645499c2ff10f337b91d3de7e51232f4fac3d3b6949ef16015b0
+  metadata.gz: 0fb55a12f59529e6c8ee96d440131da38c3d0f1e814a8213a5fb8af64ee4f293fd12e107658b3e24b92dda68d9a7ae386b4f6e43ffe8667cceb292fb70ae8152
+  data.tar.gz: e9a162190490a8d62cea6a1250bd3c775268c0b68e94e56cfbab6ddbac9a31c8355091c98358a8b43d9a996a43c20807ee583f07f360e7745213a3accd157f95

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.1.0-alpha.29 (2025-08-24)
+
+Full Changelog: [v0.1.0-alpha.28...v0.1.0-alpha.29](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.28...v0.1.0-alpha.29)
+
+### Features
+
+* **api:** api update ([a8f432a](https://github.com/Finch-API/finch-api-ruby/commit/a8f432a47e2e5ffbb1be53637b672383301d1baf))
+
+
+### Chores
+
+* add json schema comment for rubocop.yml ([9c458ab](https://github.com/Finch-API/finch-api-ruby/commit/9c458abf8ac902197c09eb4be5612d48d8d0723e))
+
 ## 0.1.0-alpha.28 (2025-08-20)
 
 Full Changelog: [v0.1.0-alpha.27...v0.1.0-alpha.28](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.27...v0.1.0-alpha.28)

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.28"
+gem "finch-api", "~> 0.1.0.pre.alpha.29"
 ```
 
 <!-- x-release-please-end -->

data/lib/finch_api/models/introspection.rb

@@ -99,6 +99,18 @@ module FinchAPI
       #   @return [String, nil]
       optional :customer_name, String, nil?: true
 
+      # @!attribute entity_ids
+      #   Array of entity IDs associated with this connection.
+      #
+      #   @return [Array<String>, nil]
+      optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute entity_mode
+      #   Indicates whether this connection manages a single entity or multiple entities.
+      #
+      #   @return [Symbol, FinchAPI::Models::Introspection::EntityMode, nil]
+      optional :entity_mode, enum: -> { FinchAPI::Introspection::EntityMode }
+
       # @!attribute manual
       #   Whether the connection associated with the `access_token` uses the Assisted
       #   Connect Flow. (`true` if using Assisted Connect, `false` if connection is
@@ -122,7 +134,7 @@ module FinchAPI
       #   @return [String, nil]
       optional :username, String, nil?: true
 
-      # @!method initialize(id:, client_id:, client_type:, connection_id:, connection_status:, connection_type:, products:, provider_id:, account_id: nil, authentication_methods: nil, company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, manual: nil, payroll_provider_id: nil, username: nil)
+      # @!method initialize(id:, client_id:, client_type:, connection_id:, connection_status:, connection_type:, products:, provider_id:, account_id: nil, authentication_methods: nil, company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, entity_ids: nil, entity_mode: nil, manual: nil, payroll_provider_id: nil, username: nil)
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::Introspection} for more details.
       #
@@ -154,6 +166,10 @@ module FinchAPI
       #
       #   @param customer_name [String, nil] The name of your customer you provided to Finch when a connect session was creat
       #
+      #   @param entity_ids [Array<String>] Array of entity IDs associated with this connection.
+      #
+      #   @param entity_mode [Symbol, FinchAPI::Models::Introspection::EntityMode] Indicates whether this connection manages a single entity or multiple entities.
+      #
       #   @param manual [Boolean] Whether the connection associated with the `access_token` uses the Assisted Conn
       #
       #   @param payroll_provider_id [String] [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll
@@ -317,6 +333,19 @@ module FinchAPI
           end
         end
       end
+
+      # Indicates whether this connection manages a single entity or multiple entities.
+      #
+      # @see FinchAPI::Models::Introspection#entity_mode
+      module EntityMode
+        extend FinchAPI::Internal::Type::Enum
+
+        SINGLE = :single
+        MULTI = :multi
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/finch_api/version.rb

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

data/rbi/finch_api/models/introspection.rbi

@@ -95,6 +95,24 @@ module FinchAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :customer_name
 
+      # Array of entity IDs associated with this connection.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :entity_ids
+
+      sig { params(entity_ids: T::Array[String]).void }
+      attr_writer :entity_ids
+
+      # Indicates whether this connection manages a single entity or multiple entities.
+      sig do
+        returns(T.nilable(FinchAPI::Introspection::EntityMode::TaggedSymbol))
+      end
+      attr_reader :entity_mode
+
+      sig do
+        params(entity_mode: FinchAPI::Introspection::EntityMode::OrSymbol).void
+      end
+      attr_writer :entity_mode
+
       # Whether the connection associated with the `access_token` uses the Assisted
       # Connect Flow. (`true` if using Assisted Connect, `false` if connection is
       # automated)
@@ -133,6 +151,8 @@ module FinchAPI
           customer_email: T.nilable(String),
           customer_id: T.nilable(String),
           customer_name: T.nilable(String),
+          entity_ids: T::Array[String],
+          entity_mode: FinchAPI::Introspection::EntityMode::OrSymbol,
           manual: T::Boolean,
           payroll_provider_id: String,
           username: T.nilable(String)
@@ -173,6 +193,10 @@ module FinchAPI
         # The name of your customer you provided to Finch when a connect session was
         # created for this connection
         customer_name: nil,
+        # Array of entity IDs associated with this connection.
+        entity_ids: nil,
+        # Indicates whether this connection manages a single entity or multiple entities.
+        entity_mode: nil,
         # Whether the connection associated with the `access_token` uses the Assisted
         # Connect Flow. (`true` if using Assisted Connect, `false` if connection is
         # automated)
@@ -204,6 +228,8 @@ module FinchAPI
             customer_email: T.nilable(String),
             customer_id: T.nilable(String),
             customer_name: T.nilable(String),
+            entity_ids: T::Array[String],
+            entity_mode: FinchAPI::Introspection::EntityMode::TaggedSymbol,
             manual: T::Boolean,
             payroll_provider_id: String,
             username: T.nilable(String)
@@ -544,6 +570,27 @@ module FinchAPI
           end
         end
       end
+
+      # Indicates whether this connection manages a single entity or multiple entities.
+      module EntityMode
+        extend FinchAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, FinchAPI::Introspection::EntityMode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SINGLE =
+          T.let(:single, FinchAPI::Introspection::EntityMode::TaggedSymbol)
+        MULTI = T.let(:multi, FinchAPI::Introspection::EntityMode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[FinchAPI::Introspection::EntityMode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/sig/finch_api/models/introspection.rbs

@@ -16,6 +16,8 @@ module FinchAPI
         customer_email: String?,
         customer_id: String?,
         customer_name: String?,
+        entity_ids: ::Array[String],
+        entity_mode: FinchAPI::Models::Introspection::entity_mode,
         manual: bool,
         payroll_provider_id: String,
         username: String?
@@ -58,6 +60,16 @@ module FinchAPI
 
       attr_accessor customer_name: String?
 
+      attr_reader entity_ids: ::Array[String]?
+
+      def entity_ids=: (::Array[String]) -> ::Array[String]
+
+      attr_reader entity_mode: FinchAPI::Models::Introspection::entity_mode?
+
+      def entity_mode=: (
+        FinchAPI::Models::Introspection::entity_mode
+      ) -> FinchAPI::Models::Introspection::entity_mode
+
       attr_reader manual: bool?
 
       def manual=: (bool) -> bool
@@ -83,6 +95,8 @@ module FinchAPI
         ?customer_email: String?,
         ?customer_id: String?,
         ?customer_name: String?,
+        ?entity_ids: ::Array[String],
+        ?entity_mode: FinchAPI::Models::Introspection::entity_mode,
         ?manual: bool,
         ?payroll_provider_id: String,
         ?username: String?
@@ -103,6 +117,8 @@ module FinchAPI
         customer_email: String?,
         customer_id: String?,
         customer_name: String?,
+        entity_ids: ::Array[String],
+        entity_mode: FinchAPI::Models::Introspection::entity_mode,
         manual: bool,
         payroll_provider_id: String,
         username: String?
@@ -252,6 +268,17 @@ module FinchAPI
           end
         end
       end
+
+      type entity_mode = :single | :multi
+
+      module EntityMode
+        extend FinchAPI::Internal::Type::Enum
+
+        SINGLE: :single
+        MULTI: :multi
+
+        def self?.values: -> ::Array[FinchAPI::Models::Introspection::entity_mode]
+      end
     end
   end
 end

metadata

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