feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-ef0b0fb4ec85648855da514cbc53018cb429fb37bce8570bc6c44254eb32c62f.yml
-openapi_spec_hash: 38622a4a3cdef04686053018329616f2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-df44cda9b18320f8a8117d5c8dfa02ebd6739fc77fc87eb284748c987a7412a4.yml
+openapi_spec_hash: 69524ddfedf3c4492e77826561f7c7d8
 config_hash: 6d3585c0032e08d723d077d660fc8448

lib/finch_api/models/introspection.rb

@@ -99,18 +99,6 @@ class Introspection < FinchAPI::Internal::Type::BaseModel
       #   @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
@@ -134,7 +122,7 @@ class Introspection < FinchAPI::Internal::Type::BaseModel
       #   @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, entity_ids: nil, entity_mode: 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, manual: nil, payroll_provider_id: nil, username: nil)
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::Introspection} for more details.
       #
@@ -166,10 +154,6 @@ class Introspection < FinchAPI::Internal::Type::BaseModel
       #
       #   @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
@@ -333,19 +317,6 @@ module LastSuccessfulSync
           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

lib/finch_api/models/jobs/automated_list_params.rb

@@ -8,14 +8,6 @@ class AutomatedListParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!attribute entity_id
-        #   The entity ID to use when authenticating with a multi-account token. Required
-        #   when using a multi-account token to specify which entity's data to access.
-        #   Example: `123e4567-e89b-12d3-a456-426614174000`
-        #
-        #   @return [String, nil]
-        optional :entity_id, String
-
         # @!attribute limit
         #   Number of items to return
         #
@@ -28,12 +20,7 @@ class AutomatedListParams < FinchAPI::Internal::Type::BaseModel
         #   @return [Integer, nil]
         optional :offset, Integer
 
-        # @!method initialize(entity_id: nil, limit: nil, offset: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {FinchAPI::Models::Jobs::AutomatedListParams} for more details.
-        #
-        #   @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
-        #
+        # @!method initialize(limit: nil, offset: nil, request_options: {})
         #   @param limit [Integer] Number of items to return
         #
         #   @param offset [Integer] Index to start from (defaults to 0)

lib/finch_api/models/jobs/automated_retrieve_params.rb

@@ -8,20 +8,7 @@ class AutomatedRetrieveParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!attribute entity_id
-        #   The entity ID to use when authenticating with a multi-account token. Required
-        #   when using a multi-account token to specify which entity's data to access.
-        #   Example: `123e4567-e89b-12d3-a456-426614174000`
-        #
-        #   @return [String, nil]
-        optional :entity_id, String
-
-        # @!method initialize(entity_id: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {FinchAPI::Models::Jobs::AutomatedRetrieveParams} for more details.
-        #
-        #   @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
-        #
+        # @!method initialize(request_options: {})
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

lib/finch_api/models/jobs/manual_retrieve_params.rb

@@ -8,20 +8,7 @@ class ManualRetrieveParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!attribute entity_id
-        #   The entity ID to use when authenticating with a multi-account token. Required
-        #   when using a multi-account token to specify which entity's data to access.
-        #   Example: `123e4567-e89b-12d3-a456-426614174000`
-        #
-        #   @return [String, nil]
-        optional :entity_id, String
-
-        # @!method initialize(entity_id: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {FinchAPI::Models::Jobs::ManualRetrieveParams} for more details.
-        #
-        #   @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
-        #
+        # @!method initialize(request_options: {})
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

lib/finch_api/resources/jobs/automated.rb

@@ -41,43 +41,30 @@ def create(params)
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {FinchAPI::Models::Jobs::AutomatedRetrieveParams} for more details.
-        #
         # Get an automated job by `job_id`.
         #
-        # @overload retrieve(job_id, entity_id: nil, request_options: {})
+        # @overload retrieve(job_id, request_options: {})
         #
         # @param job_id [String]
-        #
-        # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
-        #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob]
         #
         # @see FinchAPI::Models::Jobs::AutomatedRetrieveParams
         def retrieve(job_id, params = {})
-          parsed, options = FinchAPI::Jobs::AutomatedRetrieveParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["jobs/automated/%1$s", job_id],
-            query: parsed,
             model: FinchAPI::Jobs::AutomatedAsyncJob,
-            options: options
+            options: params[:request_options]
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {FinchAPI::Models::Jobs::AutomatedListParams} for more details.
-        #
         # Get all automated jobs. Automated jobs are completed by a machine. By default,
         # jobs are sorted in descending order by submission time. For scheduled jobs such
         # as data syncs, only the next scheduled job is shown.
         #
-        # @overload list(entity_id: nil, limit: nil, offset: nil, request_options: {})
-        #
-        # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
+        # @overload list(limit: nil, offset: nil, request_options: {})
         #
         # @param limit [Integer] Number of items to return
         #

lib/finch_api/resources/jobs/manual.rb

@@ -4,31 +4,23 @@ module FinchAPI
   module Resources
     class Jobs
       class Manual
-        # Some parameter documentations has been truncated, see
-        # {FinchAPI::Models::Jobs::ManualRetrieveParams} for more details.
-        #
         # Get a manual job by `job_id`. Manual jobs are completed by a human and include
         # Assisted Benefits jobs.
         #
-        # @overload retrieve(job_id, entity_id: nil, request_options: {})
+        # @overload retrieve(job_id, request_options: {})
         #
         # @param job_id [String]
-        #
-        # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
-        #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [FinchAPI::Models::Jobs::ManualAsyncJob]
         #
         # @see FinchAPI::Models::Jobs::ManualRetrieveParams
         def retrieve(job_id, params = {})
-          parsed, options = FinchAPI::Jobs::ManualRetrieveParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["jobs/manual/%1$s", job_id],
-            query: parsed,
             model: FinchAPI::Jobs::ManualAsyncJob,
-            options: options
+            options: params[:request_options]
           )
         end
 

rbi/finch_api/models/introspection.rbi

@@ -95,24 +95,6 @@ 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)
@@ -151,8 +133,6 @@ 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)
@@ -193,10 +173,6 @@ 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)
@@ -228,8 +204,6 @@ 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)
@@ -570,27 +544,6 @@ 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

rbi/finch_api/models/jobs/automated_list_params.rbi

@@ -15,15 +15,6 @@ module FinchAPI
             )
           end
 
-        # The entity ID to use when authenticating with a multi-account token. Required
-        # when using a multi-account token to specify which entity's data to access.
-        # Example: `123e4567-e89b-12d3-a456-426614174000`
-        sig { returns(T.nilable(String)) }
-        attr_reader :entity_id
-
-        sig { params(entity_id: String).void }
-        attr_writer :entity_id
-
         # Number of items to return
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
@@ -40,17 +31,12 @@ module FinchAPI
 
         sig do
           params(
-            entity_id: String,
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity ID to use when authenticating with a multi-account token. Required
-          # when using a multi-account token to specify which entity's data to access.
-          # Example: `123e4567-e89b-12d3-a456-426614174000`
-          entity_id: nil,
           # Number of items to return
           limit: nil,
           # Index to start from (defaults to 0)
@@ -62,7 +48,6 @@ module FinchAPI
         sig do
           override.returns(
             {
-              entity_id: String,
               limit: Integer,
               offset: Integer,
               request_options: FinchAPI::RequestOptions

rbi/finch_api/models/jobs/automated_retrieve_params.rbi

@@ -15,35 +15,15 @@ module FinchAPI
             )
           end
 
-        # The entity ID to use when authenticating with a multi-account token. Required
-        # when using a multi-account token to specify which entity's data to access.
-        # Example: `123e4567-e89b-12d3-a456-426614174000`
-        sig { returns(T.nilable(String)) }
-        attr_reader :entity_id
-
-        sig { params(entity_id: String).void }
-        attr_writer :entity_id
-
         sig do
-          params(
-            entity_id: String,
-            request_options: FinchAPI::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The entity ID to use when authenticating with a multi-account token. Required
-          # when using a multi-account token to specify which entity's data to access.
-          # Example: `123e4567-e89b-12d3-a456-426614174000`
-          entity_id: nil,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            { entity_id: String, request_options: FinchAPI::RequestOptions }
-          )
-        end
+        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
         def to_hash
         end
       end