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

data/sig/finch_api/models/hris/directory_list_params.rbs

@@ -2,13 +2,17 @@ module FinchAPI
   module Models
     module HRIS
       type directory_list_params =
-        { limit: Integer, offset: Integer }
+        { entity_ids: ::Array[String], limit: Integer, offset: Integer }
         & FinchAPI::Internal::Type::request_parameters
 
       class DirectoryListParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        attr_reader entity_ids: ::Array[String]?
+
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
         attr_reader limit: Integer?
 
         def limit=: (Integer) -> Integer
@@ -18,12 +22,14 @@ module FinchAPI
         def offset=: (Integer) -> Integer
 
         def initialize: (
+          ?entity_ids: ::Array[String],
           ?limit: Integer,
           ?offset: Integer,
           ?request_options: FinchAPI::request_opts
         ) -> void
 
         def to_hash: -> {
+          entity_ids: ::Array[String],
           limit: Integer,
           offset: Integer,
           request_options: FinchAPI::RequestOptions

data/sig/finch_api/models/hris/document_list_params.rbs

@@ -3,6 +3,7 @@ module FinchAPI
     module HRIS
       type document_list_params =
         {
+          entity_ids: ::Array[String],
           individual_ids: ::Array[String],
           limit: Integer,
           offset: Integer,
@@ -14,6 +15,10 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        attr_reader entity_ids: ::Array[String]?
+
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
         attr_reader individual_ids: ::Array[String]?
 
         def individual_ids=: (::Array[String]) -> ::Array[String]
@@ -33,6 +38,7 @@ module FinchAPI
         ) -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_]
 
         def initialize: (
+          ?entity_ids: ::Array[String],
           ?individual_ids: ::Array[String],
           ?limit: Integer,
           ?offset: Integer,
@@ -41,6 +47,7 @@ module FinchAPI
         ) -> void
 
         def to_hash: -> {
+          entity_ids: ::Array[String],
           individual_ids: ::Array[String],
           limit: Integer,
           offset: Integer,

data/sig/finch_api/models/hris/document_response.rbs

@@ -7,34 +7,26 @@ module FinchAPI
           individual_id: String?,
           type: FinchAPI::Models::HRIS::DocumentResponse::type_,
           url: String,
-          year: Float?
+          year: Float
         }
 
       class DocumentResponse < FinchAPI::Internal::Type::BaseModel
-        attr_reader id: String?
-
-        def id=: (String) -> String
+        attr_accessor id: String
 
         attr_accessor individual_id: String?
 
-        attr_reader type: FinchAPI::Models::HRIS::DocumentResponse::type_?
-
-        def type=: (
-          FinchAPI::Models::HRIS::DocumentResponse::type_
-        ) -> FinchAPI::Models::HRIS::DocumentResponse::type_
+        attr_accessor type: FinchAPI::Models::HRIS::DocumentResponse::type_
 
-        attr_reader url: String?
+        attr_accessor url: String
 
-        def url=: (String) -> String
-
-        attr_accessor year: Float?
+        attr_accessor year: Float
 
         def initialize: (
-          ?id: String,
-          ?individual_id: String?,
-          ?type: FinchAPI::Models::HRIS::DocumentResponse::type_,
-          ?url: String,
-          ?year: Float?
+          id: String,
+          individual_id: String?,
+          type: FinchAPI::Models::HRIS::DocumentResponse::type_,
+          url: String,
+          year: Float
         ) -> void
 
         def to_hash: -> {
@@ -42,7 +34,7 @@ module FinchAPI
           individual_id: String?,
           type: FinchAPI::Models::HRIS::DocumentResponse::type_,
           url: String,
-          year: Float?
+          year: Float
         }
 
         type type_ = :w4_2020 | :w4_2005

data/sig/finch_api/models/hris/document_retreive_params.rbs

@@ -2,15 +2,26 @@ module FinchAPI
   module Models
     module HRIS
       type document_retreive_params =
-        {  } & FinchAPI::Internal::Type::request_parameters
+        { entity_ids: ::Array[String] }
+        & FinchAPI::Internal::Type::request_parameters
 
       class DocumentRetreiveParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        def initialize: (?request_options: FinchAPI::request_opts) -> void
+        attr_reader entity_ids: ::Array[String]?
 
-        def to_hash: -> { request_options: FinchAPI::RequestOptions }
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          ?entity_ids: ::Array[String],
+          ?request_options: FinchAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          entity_ids: ::Array[String],
+          request_options: FinchAPI::RequestOptions
+        }
       end
     end
   end

data/sig/finch_api/models/hris/employment_retrieve_many_params.rbs

@@ -3,7 +3,8 @@ module FinchAPI
     module HRIS
       type employment_retrieve_many_params =
         {
-          requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
+          requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
+          entity_ids: ::Array[String]
         }
         & FinchAPI::Internal::Type::request_parameters
 
@@ -13,13 +14,19 @@ module FinchAPI
 
         attr_accessor requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
 
+        attr_reader entity_ids: ::Array[String]?
+
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
         def initialize: (
           requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
+          ?entity_ids: ::Array[String],
           ?request_options: FinchAPI::request_opts
         ) -> void
 
         def to_hash: -> {
           requests: ::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
+          entity_ids: ::Array[String],
           request_options: FinchAPI::RequestOptions
         }
 

data/sig/finch_api/models/hris/individual_retrieve_many_params.rbs

@@ -3,6 +3,7 @@ module FinchAPI
     module HRIS
       type individual_retrieve_many_params =
         {
+          entity_ids: ::Array[String],
           options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
           requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
         }
@@ -12,6 +13,10 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        attr_reader entity_ids: ::Array[String]?
+
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
         attr_accessor options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?
 
         attr_reader requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]?
@@ -21,12 +26,14 @@ module FinchAPI
         ) -> ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
 
         def initialize: (
+          ?entity_ids: ::Array[String],
           ?options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
           ?requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           ?request_options: FinchAPI::request_opts
         ) -> void
 
         def to_hash: -> {
+          entity_ids: ::Array[String],
           options: FinchAPI::HRIS::IndividualRetrieveManyParams::Options?,
           requests: ::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
           request_options: FinchAPI::RequestOptions

data/sig/finch_api/models/hris/pay_statement.rbs

@@ -4,13 +4,13 @@ module FinchAPI
       type pay_statement =
         {
           earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?,
-          employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?,
-          employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?,
+          employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?,
+          employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?,
           gross_pay: FinchAPI::Money?,
           individual_id: String,
           net_pay: FinchAPI::Money?,
           payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
-          taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?,
+          taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?,
           total_hours: Float?,
           type: FinchAPI::Models::HRIS::PayStatement::type_?
         }
@@ -18,9 +18,9 @@ module FinchAPI
       class PayStatement < FinchAPI::Internal::Type::BaseModel
         attr_accessor earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?
 
-        attr_accessor employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?
+        attr_accessor employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?
 
-        attr_accessor employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?
+        attr_accessor employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?
 
         attr_accessor gross_pay: FinchAPI::Money?
 
@@ -30,7 +30,7 @@ module FinchAPI
 
         attr_accessor payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?
 
-        attr_accessor taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?
+        attr_accessor taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?
 
         attr_accessor total_hours: Float?
 
@@ -38,26 +38,26 @@ module FinchAPI
 
         def initialize: (
           earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?,
-          employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?,
-          employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?,
+          employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?,
+          employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?,
           gross_pay: FinchAPI::Money?,
           individual_id: String,
           net_pay: FinchAPI::Money?,
           payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
-          taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?,
+          taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?,
           total_hours: Float?,
           type: FinchAPI::Models::HRIS::PayStatement::type_?
         ) -> void
 
         def to_hash: -> {
           earnings: ::Array[FinchAPI::HRIS::PayStatement::Earning?]?,
-          employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction?]?,
-          employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution?]?,
+          employee_deductions: ::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]?,
+          employer_contributions: ::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]?,
           gross_pay: FinchAPI::Money?,
           individual_id: String,
           net_pay: FinchAPI::Money?,
           payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?,
-          taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax?]?,
+          taxes: ::Array[FinchAPI::HRIS::PayStatement::Tax]?,
           total_hours: Float?,
           type: FinchAPI::Models::HRIS::PayStatement::type_?
         }

data/sig/finch_api/models/hris/pay_statement_retrieve_many_params.rbs

@@ -3,7 +3,8 @@ module FinchAPI
     module HRIS
       type pay_statement_retrieve_many_params =
         {
-          requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
+          requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request],
+          entity_ids: ::Array[String]
         }
         & FinchAPI::Internal::Type::request_parameters
 
@@ -13,13 +14,19 @@ module FinchAPI
 
         attr_accessor requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request]
 
+        attr_reader entity_ids: ::Array[String]?
+
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
         def initialize: (
           requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request],
+          ?entity_ids: ::Array[String],
           ?request_options: FinchAPI::request_opts
         ) -> void
 
         def to_hash: -> {
           requests: ::Array[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request],
+          entity_ids: ::Array[String],
           request_options: FinchAPI::RequestOptions
         }
 

data/sig/finch_api/models/hris/payment_list_params.rbs

@@ -2,7 +2,7 @@ module FinchAPI
   module Models
     module HRIS
       type payment_list_params =
-        { end_date: Date, start_date: Date }
+        { end_date: Date, start_date: Date, entity_ids: ::Array[String] }
         & FinchAPI::Internal::Type::request_parameters
 
       class PaymentListParams < FinchAPI::Internal::Type::BaseModel
@@ -13,15 +13,21 @@ module FinchAPI
 
         attr_accessor start_date: Date
 
+        attr_reader entity_ids: ::Array[String]?
+
+        def entity_ids=: (::Array[String]) -> ::Array[String]
+
         def initialize: (
           end_date: Date,
           start_date: Date,
+          ?entity_ids: ::Array[String],
           ?request_options: FinchAPI::request_opts
         ) -> void
 
         def to_hash: -> {
           end_date: Date,
           start_date: Date,
+          entity_ids: ::Array[String],
           request_options: FinchAPI::RequestOptions
         }
       end

data/sig/finch_api/models/hris/supported_benefit.rbs

@@ -47,13 +47,14 @@ module FinchAPI
           hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?
         }
 
-        type company_contribution = :fixed | :percent
+        type company_contribution = :fixed | :percent | :tiered
 
         module CompanyContribution
           extend FinchAPI::Internal::Type::Enum
 
           FIXED: :fixed
           PERCENT: :percent
+          TIERED: :tiered
 
           def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution]
         end

data/sig/finch_api/models/hris/w42005.rbs

@@ -5,76 +5,62 @@ module FinchAPI
         {
           data: FinchAPI::HRIS::W42005::Data,
           type: FinchAPI::Models::HRIS::W42005::type_,
-          year: Float?
+          year: Float
         }
 
       class W42005 < FinchAPI::Internal::Type::BaseModel
-        attr_reader data: FinchAPI::HRIS::W42005::Data?
+        attr_accessor data: FinchAPI::HRIS::W42005::Data
 
-        def data=: (
-          FinchAPI::HRIS::W42005::Data
-        ) -> FinchAPI::HRIS::W42005::Data
+        attr_accessor type: FinchAPI::Models::HRIS::W42005::type_
 
-        attr_reader type: FinchAPI::Models::HRIS::W42005::type_?
-
-        def type=: (
-          FinchAPI::Models::HRIS::W42005::type_
-        ) -> FinchAPI::Models::HRIS::W42005::type_
-
-        attr_accessor year: Float?
+        attr_accessor year: Float
 
         def initialize: (
-          ?data: FinchAPI::HRIS::W42005::Data,
-          ?type: FinchAPI::Models::HRIS::W42005::type_,
-          ?year: Float?
+          data: FinchAPI::HRIS::W42005::Data,
+          type: FinchAPI::Models::HRIS::W42005::type_,
+          year: Float
         ) -> void
 
         def to_hash: -> {
           data: FinchAPI::HRIS::W42005::Data,
           type: FinchAPI::Models::HRIS::W42005::type_,
-          year: Float?
+          year: Float
         }
 
         type data =
           {
-            additional_withholding: Integer?,
-            exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
+            additional_withholding: Integer,
+            exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?,
             filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
             individual_id: String,
-            total_number_of_allowances: Integer?
+            total_number_of_allowances: Integer
           }
 
         class Data < FinchAPI::Internal::Type::BaseModel
-          attr_accessor additional_withholding: Integer?
+          attr_accessor additional_withholding: Integer
 
-          attr_reader exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?
-
-          def exemption=: (
-            FinchAPI::Models::HRIS::W42005::Data::exemption
-          ) -> FinchAPI::Models::HRIS::W42005::Data::exemption
+          attr_accessor exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?
 
           attr_accessor filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?
 
-          attr_reader individual_id: String?
-
-          def individual_id=: (String) -> String
+          attr_accessor individual_id: String
 
-          attr_accessor total_number_of_allowances: Integer?
+          attr_accessor total_number_of_allowances: Integer
 
           def initialize: (
-            ?additional_withholding: Integer?,
-            ?exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
-            ?filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
-            ?individual_id: String,
-            ?total_number_of_allowances: Integer?
+            additional_withholding: Integer,
+            exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?,
+            filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
+            individual_id: String,
+            total_number_of_allowances: Integer
           ) -> void
 
           def to_hash: -> {
-            additional_withholding: Integer?,
-            exemption: FinchAPI::Models::HRIS::W42005::Data::exemption,
+            additional_withholding: Integer,
+            exemption: FinchAPI::Models::HRIS::W42005::Data::exemption?,
             filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?,
             individual_id: String,
-            total_number_of_allowances: Integer?
+            total_number_of_allowances: Integer
           }
 
           type exemption = :exempt | :non_exempt

data/sig/finch_api/models/hris/w42020.rbs

@@ -5,87 +5,77 @@ module FinchAPI
         {
           data: FinchAPI::HRIS::W42020::Data,
           type: FinchAPI::Models::HRIS::W42020::type_,
-          year: Float?
+          year: Float
         }
 
       class W42020 < FinchAPI::Internal::Type::BaseModel
-        attr_reader data: FinchAPI::HRIS::W42020::Data?
+        attr_accessor data: FinchAPI::HRIS::W42020::Data
 
-        def data=: (
-          FinchAPI::HRIS::W42020::Data
-        ) -> FinchAPI::HRIS::W42020::Data
+        attr_accessor type: FinchAPI::Models::HRIS::W42020::type_
 
-        attr_reader type: FinchAPI::Models::HRIS::W42020::type_?
-
-        def type=: (
-          FinchAPI::Models::HRIS::W42020::type_
-        ) -> FinchAPI::Models::HRIS::W42020::type_
-
-        attr_accessor year: Float?
+        attr_accessor year: Float
 
         def initialize: (
-          ?data: FinchAPI::HRIS::W42020::Data,
-          ?type: FinchAPI::Models::HRIS::W42020::type_,
-          ?year: Float?
+          data: FinchAPI::HRIS::W42020::Data,
+          type: FinchAPI::Models::HRIS::W42020::type_,
+          year: Float
         ) -> void
 
         def to_hash: -> {
           data: FinchAPI::HRIS::W42020::Data,
           type: FinchAPI::Models::HRIS::W42020::type_,
-          year: Float?
+          year: Float
         }
 
         type data =
           {
-            amount_for_other_dependents: Integer?,
-            :amount_for_qualifying_children_under_17 => Integer?,
-            deductions: Integer?,
-            extra_withholding: Integer?,
+            amount_for_other_dependents: Integer,
+            :amount_for_qualifying_children_under_17 => Integer,
+            deductions: Integer,
+            extra_withholding: Integer,
             filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?,
             individual_id: String,
-            other_income: Integer?,
-            total_claim_dependent_and_other_credits: Integer?
+            other_income: Integer,
+            total_claim_dependent_and_other_credits: Integer
           }
 
         class Data < FinchAPI::Internal::Type::BaseModel
-          attr_accessor amount_for_other_dependents: Integer?
+          attr_accessor amount_for_other_dependents: Integer
 
-          attr_accessor amount_for_qualifying_children_under_17: Integer?
+          attr_accessor amount_for_qualifying_children_under_17: Integer
 
-          attr_accessor deductions: Integer?
+          attr_accessor deductions: Integer
 
-          attr_accessor extra_withholding: Integer?
+          attr_accessor extra_withholding: Integer
 
           attr_accessor filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?
 
-          attr_reader individual_id: String?
+          attr_accessor individual_id: String
 
-          def individual_id=: (String) -> String
+          attr_accessor other_income: Integer
 
-          attr_accessor other_income: Integer?
-
-          attr_accessor total_claim_dependent_and_other_credits: Integer?
+          attr_accessor total_claim_dependent_and_other_credits: Integer
 
           def initialize: (
-            ?amount_for_other_dependents: Integer?,
-            ?amount_for_qualifying_children_under_17: Integer?,
-            ?deductions: Integer?,
-            ?extra_withholding: Integer?,
-            ?filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?,
-            ?individual_id: String,
-            ?other_income: Integer?,
-            ?total_claim_dependent_and_other_credits: Integer?
+            amount_for_other_dependents: Integer,
+            amount_for_qualifying_children_under_17: Integer,
+            deductions: Integer,
+            extra_withholding: Integer,
+            filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?,
+            individual_id: String,
+            other_income: Integer,
+            total_claim_dependent_and_other_credits: Integer
           ) -> void
 
           def to_hash: -> {
-            amount_for_other_dependents: Integer?,
-            :amount_for_qualifying_children_under_17 => Integer?,
-            deductions: Integer?,
-            extra_withholding: Integer?,
+            amount_for_other_dependents: Integer,
+            :amount_for_qualifying_children_under_17 => Integer,
+            deductions: Integer,
+            extra_withholding: Integer,
             filing_status: FinchAPI::Models::HRIS::W42020::Data::filing_status?,
             individual_id: String,
-            other_income: Integer?,
-            total_claim_dependent_and_other_credits: Integer?
+            other_income: Integer,
+            total_claim_dependent_and_other_credits: Integer
           }
 
           type filing_status =