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

data/lib/finch_api/models/introspection.rb

@@ -99,17 +99,12 @@ module FinchAPI
       #   @return [String, nil]
       optional :customer_name, String, nil?: true
 
-      # @!attribute entity_ids
-      #   Array of entity IDs associated with this connection.
+      # @!attribute entities
+      #   Array of detailed entity information for each connected account in multi-account
+      #   mode
       #
-      #   @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 }
+      #   @return [Array<FinchAPI::Models::Introspection::Entity>, nil]
+      optional :entities, -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Introspection::Entity] }
 
       # @!attribute manual
       #   Whether the connection associated with the `access_token` uses the Assisted
@@ -134,7 +129,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, 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, entities: nil, manual: nil, payroll_provider_id: nil, username: nil)
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::Introspection} for more details.
       #
@@ -166,9 +161,7 @@ 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 entities [Array<FinchAPI::Models::Introspection::Entity>] Array of detailed entity information for each connected account in multi-account
       #
       #   @param manual [Boolean] Whether the connection associated with the `access_token` uses the Assisted Conn
       #
@@ -334,17 +327,39 @@ module FinchAPI
         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
+      class Entity < FinchAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The connection account ID for this entity
+        #
+        #   @return [String]
+        required :id, String
 
-        SINGLE = :single
-        MULTI = :multi
+        # @!attribute name
+        #   The name of the entity (payroll provider company name)
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
 
-        # @!method self.values
-        #   @return [Array<Symbol>]
+        # @!attribute source_id
+        #   The source ID of the entity
+        #
+        #   @return [String, nil]
+        required :source_id, String, nil?: true
+
+        # @!attribute type
+        #   The type of entity
+        #
+        #   @return [String, nil]
+        required :type, String, nil?: true
+
+        # @!method initialize(id:, name:, source_id:, type:)
+        #   @param id [String] The connection account ID for this entity
+        #
+        #   @param name [String, nil] The name of the entity (payroll provider company name)
+        #
+        #   @param source_id [String, nil] The source ID of the entity
+        #
+        #   @param type [String, nil] The type of entity
       end
     end
   end

data/lib/finch_api/models/jobs/automated_list_params.rb

@@ -8,14 +8,6 @@ module FinchAPI
         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 @@ module FinchAPI
         #   @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)

data/lib/finch_api/models/jobs/automated_retrieve_params.rb

@@ -8,20 +8,7 @@ module FinchAPI
         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

data/lib/finch_api/models/jobs/manual_retrieve_params.rb

@@ -8,20 +8,7 @@ module FinchAPI
         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

data/lib/finch_api/models/payroll/pay_group_list_params.rb

@@ -8,6 +8,12 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
         # @!attribute individual_id
         #
         #   @return [String, nil]
@@ -18,9 +24,13 @@ module FinchAPI
         #   @return [Array<String>, nil]
         optional :pay_frequencies, FinchAPI::Internal::Type::ArrayOf[String]
 
-        # @!method initialize(individual_id: nil, pay_frequencies: nil, request_options: {})
+        # @!method initialize(entity_ids: nil, individual_id: nil, pay_frequencies: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param individual_id [String]
+        #
         #   @param pay_frequencies [Array<String>]
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb

@@ -8,7 +8,15 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute entity_ids
+        #   The entity IDs to specify which entities' data to access.
+        #
+        #   @return [Array<String>, nil]
+        optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(entity_ids: nil, request_options: {})
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end