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

data/rbi/finch_api/resources/hris/benefits.rbi

@@ -11,6 +11,7 @@ module FinchAPI
         # `/providers` endpoint to view available types for each provider.
         sig do
           params(
+            entity_ids: T::Array[String],
             company_contribution:
               T.nilable(
                 FinchAPI::HRIS::BenefitCreateParams::CompanyContribution::OrHash
@@ -22,15 +23,17 @@ module FinchAPI
           ).returns(FinchAPI::HRIS::CreateCompanyBenefitsResponse)
         end
         def create(
-          # The company match for this benefit.
+          # Query param: The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          # Body param: The company match for this benefit.
           company_contribution: nil,
-          # Name of the benefit as it appears in the provider and pay statements. Recommend
-          # limiting this to <30 characters due to limitations in specific providers (e.g.
-          # Justworks).
+          # Body param: Name of the benefit as it appears in the provider and pay
+          # statements. Recommend limiting this to <30 characters due to limitations in
+          # specific providers (e.g. Justworks).
           description: nil,
-          # The frequency of the benefit deduction/contribution.
+          # Body param: The frequency of the benefit deduction/contribution.
           frequency: nil,
-          # Type of benefit.
+          # Body param: Type of benefit.
           type: nil,
           request_options: {}
         )
@@ -40,23 +43,33 @@ module FinchAPI
         sig do
           params(
             benefit_id: String,
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::HRIS::CompanyBenefit)
         end
-        def retrieve(benefit_id, request_options: {})
+        def retrieve(
+          benefit_id,
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
         # Updates an existing company-wide deduction or contribution
         sig do
           params(
             benefit_id: String,
+            entity_ids: T::Array[String],
             description: String,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::HRIS::UpdateCompanyBenefitResponse)
         end
         def update(
+          # Path param:
           benefit_id,
-          # Updated name or description.
+          # Query param: The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          # Body param: Updated name or description.
           description: nil,
           request_options: {}
         )
@@ -64,20 +77,34 @@ module FinchAPI
 
         # List all company-wide deductions and contributions.
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(
             FinchAPI::Internal::SinglePage[FinchAPI::HRIS::CompanyBenefit]
           )
         end
-        def list(request_options: {})
+        def list(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
         # Get deductions metadata
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(
             FinchAPI::Internal::SinglePage[FinchAPI::HRIS::SupportedBenefit]
           )
         end
-        def list_supported_benefits(request_options: {})
+        def list_supported_benefits(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi

@@ -14,6 +14,7 @@ module FinchAPI
             # information is available.
             sig do
               params(
+                entity_ids: T::Array[String],
                 attributes:
                   FinchAPI::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes::OrHash,
                 conditions:
@@ -30,14 +31,18 @@ module FinchAPI
               )
             end
             def create(
-              # Specifies the fields to be applied when the condition is met.
+              # Query param: The entity IDs to create the rule for.
+              entity_ids: nil,
+              # Body param: Specifies the fields to be applied when the condition is met.
               attributes: nil,
+              # Body param:
               conditions: nil,
-              # Specifies when the rules should stop applying rules based on the date.
+              # Body param: Specifies when the rules should stop applying rules based on the
+              # date.
               effective_end_date: nil,
-              # Specifies when the rule should begin applying based on the date.
+              # Body param: Specifies when the rule should begin applying based on the date.
               effective_start_date: nil,
-              # The entity type to which the rule is applied.
+              # Body param: The entity type to which the rule is applied.
               entity_type: nil,
               request_options: {}
             )
@@ -48,25 +53,41 @@ module FinchAPI
             sig do
               params(
                 rule_id: String,
+                entity_ids: T::Array[String],
                 optional_property: T.anything,
                 request_options: FinchAPI::RequestOptions::OrHash
               ).returns(
                 FinchAPI::Models::HRIS::Company::PayStatementItem::RuleUpdateResponse
               )
             end
-            def update(rule_id, optional_property: nil, request_options: {})
+            def update(
+              # Path param:
+              rule_id,
+              # Query param: The entity IDs to update the rule for.
+              entity_ids: nil,
+              # Body param:
+              optional_property: nil,
+              request_options: {}
+            )
             end
 
             # **Beta:** this endpoint currently serves employers onboarded after March 4th and
             # historical support will be added soon List all rules of a connection account.
             sig do
-              params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+              params(
+                entity_ids: T::Array[String],
+                request_options: FinchAPI::RequestOptions::OrHash
+              ).returns(
                 FinchAPI::Internal::ResponsesPage[
                   FinchAPI::Models::HRIS::Company::PayStatementItem::RuleListResponse
                 ]
               )
             end
-            def list(request_options: {})
+            def list(
+              # The entity IDs to retrieve rules for.
+              entity_ids: nil,
+              request_options: {}
+            )
             end
 
             # **Beta:** this endpoint currently serves employers onboarded after March 4th and
@@ -74,12 +95,18 @@ module FinchAPI
             sig do
               params(
                 rule_id: String,
+                entity_ids: T::Array[String],
                 request_options: FinchAPI::RequestOptions::OrHash
               ).returns(
                 FinchAPI::Models::HRIS::Company::PayStatementItem::RuleDeleteResponse
               )
             end
-            def delete(rule_id, request_options: {})
+            def delete(
+              rule_id,
+              # The entity IDs to delete the rule for.
+              entity_ids: nil,
+              request_options: {}
+            )
             end
 
             # @api private

data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi

@@ -20,6 +20,7 @@ module FinchAPI
                   FinchAPI::HRIS::Company::PayStatementItemListParams::Category::OrSymbol
                 ],
               end_date: Date,
+              entity_ids: T::Array[String],
               name: String,
               start_date: Date,
               type: String,
@@ -37,6 +38,8 @@ module FinchAPI
             # The end date to retrieve pay statement items by via their last seen pay date in
             # `YYYY-MM-DD` format.
             end_date: nil,
+            # The entity IDs to specify which entities' data to access.
+            entity_ids: nil,
             # Case-insensitive partial match search by pay statement item name.
             name: nil,
             # The start date to retrieve pay statement items by via their last seen pay date

data/rbi/finch_api/resources/hris/company.rbi

@@ -9,11 +9,16 @@ module FinchAPI
 
         # Read basic company data
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            FinchAPI::HRIS::HRISCompany
-          )
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(FinchAPI::HRIS::HRISCompany)
         end
-        def retrieve(request_options: {})
+        def retrieve(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/finch_api/resources/hris/directory.rbi

@@ -7,6 +7,7 @@ module FinchAPI
         # Read company directory and organization structure
         sig do
           params(
+            entity_ids: T::Array[String],
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
@@ -17,6 +18,8 @@ module FinchAPI
           )
         end
         def list(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           # Number of employees to return (defaults to all)
           limit: nil,
           # Index to start from (defaults to 0)

data/rbi/finch_api/resources/hris/documents.rbi

@@ -8,6 +8,7 @@ module FinchAPI
         # company-wide documents.
         sig do
           params(
+            entity_ids: T::Array[String],
             individual_ids: T::Array[String],
             limit: Integer,
             offset: Integer,
@@ -16,6 +17,8 @@ module FinchAPI
           ).returns(FinchAPI::Models::HRIS::DocumentListResponse)
         end
         def list(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           # Comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals
           individual_ids: nil,
@@ -35,12 +38,15 @@ module FinchAPI
         sig do
           params(
             document_id: String,
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Models::HRIS::DocumentRetreiveResponse::Variants)
         end
         def retreive(
           # The unique identifier of the document.
           document_id,
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           request_options: {}
         )
         end

data/rbi/finch_api/resources/hris/employments.rbi

@@ -11,6 +11,7 @@ module FinchAPI
               T::Array[
                 FinchAPI::HRIS::EmploymentRetrieveManyParams::Request::OrHash
               ],
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(
             FinchAPI::Internal::ResponsesPage[
@@ -19,8 +20,10 @@ module FinchAPI
           )
         end
         def retrieve_many(
-          # The array of batch requests.
+          # Body param: The array of batch requests.
           requests:,
+          # Query param: The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           request_options: {}
         )
         end

data/rbi/finch_api/resources/hris/individuals.rbi

@@ -7,6 +7,7 @@ module FinchAPI
         # Read individual data, excluding income and employment data
         sig do
           params(
+            entity_ids: T::Array[String],
             options:
               T.nilable(
                 FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash
@@ -22,7 +23,15 @@ module FinchAPI
             ]
           )
         end
-        def retrieve_many(options: nil, requests: nil, request_options: {})
+        def retrieve_many(
+          # Query param: The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          # Body param:
+          options: nil,
+          # Body param:
+          requests: nil,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/finch_api/resources/hris/pay_statements.rbi

@@ -14,6 +14,7 @@ module FinchAPI
               T::Array[
                 FinchAPI::HRIS::PayStatementRetrieveManyParams::Request::OrHash
               ],
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(
             FinchAPI::Internal::ResponsesPage[
@@ -22,8 +23,10 @@ module FinchAPI
           )
         end
         def retrieve_many(
-          # The array of batch requests.
+          # Body param: The array of batch requests.
           requests:,
+          # Query param: The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           request_options: {}
         )
         end

data/rbi/finch_api/resources/hris/payments.rbi

@@ -9,6 +9,7 @@ module FinchAPI
           params(
             end_date: Date,
             start_date: Date,
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Internal::SinglePage[FinchAPI::HRIS::Payment])
         end
@@ -19,6 +20,8 @@ module FinchAPI
           # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
           # format.
           start_date:,
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           request_options: {}
         )
         end

data/rbi/finch_api/resources/jobs/automated.rbi

@@ -37,18 +37,10 @@ module FinchAPI
         sig do
           params(
             job_id: String,
-            entity_id: String,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Jobs::AutomatedAsyncJob)
         end
-        def retrieve(
-          job_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`
-          entity_id: nil,
-          request_options: {}
-        )
+        def retrieve(job_id, request_options: {})
         end
 
         # Get all automated jobs. Automated jobs are completed by a machine. By default,
@@ -56,17 +48,12 @@ module FinchAPI
         # as data syncs, only the next scheduled job is shown.
         sig do
           params(
-            entity_id: String,
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Models::Jobs::AutomatedListResponse)
         end
         def list(
-          # 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)

data/rbi/finch_api/resources/jobs/manual.rbi

@@ -9,18 +9,10 @@ module FinchAPI
         sig do
           params(
             job_id: String,
-            entity_id: String,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Jobs::ManualAsyncJob)
         end
-        def retrieve(
-          job_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`
-          entity_id: nil,
-          request_options: {}
-        )
+        def retrieve(job_id, request_options: {})
         end
 
         # @api private

data/rbi/finch_api/resources/payroll/pay_groups.rbi

@@ -8,15 +8,22 @@ module FinchAPI
         sig do
           params(
             pay_group_id: String,
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Models::Payroll::PayGroupRetrieveResponse)
         end
-        def retrieve(pay_group_id, request_options: {})
+        def retrieve(
+          pay_group_id,
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
         # Read company pay groups and frequencies
         sig do
           params(
+            entity_ids: T::Array[String],
             individual_id: String,
             pay_frequencies: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
@@ -26,7 +33,13 @@ module FinchAPI
             ]
           )
         end
-        def list(individual_id: nil, pay_frequencies: nil, request_options: {})
+        def list(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          individual_id: nil,
+          pay_frequencies: nil,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/finch_api/resources/providers.rbi

@@ -6,7 +6,7 @@ module FinchAPI
       # Return details on all available payroll and HR systems.
       sig do
         params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-          FinchAPI::Internal::SinglePage[FinchAPI::Provider]
+          FinchAPI::Internal::SinglePage[FinchAPI::Models::ProviderListResponse]
         )
       end
       def list(request_options: {})

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.anything),
-          params: T.nilable(T.anything),
+          headers: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
+          params: T.nilable(T::Hash[Symbol, T.nilable(T.anything)]),
           request_options: FinchAPI::RequestOptions::OrHash
         ).returns(FinchAPI::Models::RequestForwardingForwardResponse)
       end

data/sig/finch_api/errors.rbs

@@ -21,11 +21,14 @@ module FinchAPI
 
       attr_accessor status: Integer?
 
+      attr_accessor headers: ::Hash[String, String]?
+
       attr_accessor body: top?
 
       def initialize: (
         url: URI::Generic,
         ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
         ?body: Object?,
         ?request: nil,
         ?response: nil,
@@ -37,6 +40,7 @@ module FinchAPI
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -48,6 +52,7 @@ module FinchAPI
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -59,6 +64,7 @@ module FinchAPI
       def self.for: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,
@@ -68,6 +74,7 @@ module FinchAPI
       def initialize: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,

data/sig/finch_api/file_part.rbs

@@ -14,7 +14,7 @@ module FinchAPI
 
     def initialize: (
       Pathname | StringIO | IO | String content,
-      ?filename: String?,
+      ?filename: (Pathname | String)?,
       ?content_type: String?
     ) -> void
   end