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-4fcae6958da081ca0e96ef6b3ce8f0b6e50994faaed8ecd6e94aa40ce1a93521.yml
-openapi_spec_hash: a825b1120bb26f04505e3bc9ab1e48f3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-5b7ee4cddd08558fb0cc5010d36899c0bbe5d6a8d39c8171f65b70b68927df3c.yml
+openapi_spec_hash: c01482dc89e9bf7ae4c9dad0fb547e62
 config_hash: 53778a0b839c4f6ad34fbba051f5e8a6

lib/finch_api.rb

@@ -118,7 +118,6 @@
 require_relative "finch_api/models/hris/individual_retrieve_many_params"
 require_relative "finch_api/models/hris/payment"
 require_relative "finch_api/models/hris/payment_list_params"
-require_relative "finch_api/models/hris/pay_statement"
 require_relative "finch_api/models/hris/pay_statement_response"
 require_relative "finch_api/models/hris/pay_statement_response_body"
 require_relative "finch_api/models/hris/pay_statement_retrieve_many_params"

lib/finch_api/models/hris/benefit_type.rb

@@ -7,25 +7,25 @@ module HRIS
       module BenefitType
         extend FinchAPI::Internal::Type::Enum
 
+        BENEFIT_TYPE_457 = :"457"
         BENEFIT_TYPE_401K = :"401k"
         BENEFIT_TYPE_401K_ROTH = :"401k_roth"
         BENEFIT_TYPE_401K_LOAN = :"401k_loan"
         BENEFIT_TYPE_403B = :"403b"
         BENEFIT_TYPE_403B_ROTH = :"403b_roth"
-        BENEFIT_TYPE_457 = :"457"
         BENEFIT_TYPE_457_ROTH = :"457_roth"
-        S125_MEDICAL = :s125_medical
-        S125_DENTAL = :s125_dental
-        S125_VISION = :s125_vision
-        HSA_PRE = :hsa_pre
-        HSA_POST = :hsa_post
-        FSA_MEDICAL = :fsa_medical
-        FSA_DEPENDENT_CARE = :fsa_dependent_care
-        SIMPLE_IRA = :simple_ira
-        SIMPLE = :simple
         COMMUTER = :commuter
         CUSTOM_POST_TAX = :custom_post_tax
         CUSTOM_PRE_TAX = :custom_pre_tax
+        FSA_DEPENDENT_CARE = :fsa_dependent_care
+        FSA_MEDICAL = :fsa_medical
+        HSA_POST = :hsa_post
+        HSA_PRE = :hsa_pre
+        S125_DENTAL = :s125_dental
+        S125_MEDICAL = :s125_medical
+        S125_VISION = :s125_vision
+        SIMPLE = :simple
+        SIMPLE_IRA = :simple_ira
 
         # @!method self.values
         #   @return [Array<Symbol>]

lib/finch_api/models/hris/company/pay_statement_item_list_response.rb

@@ -9,22 +9,22 @@ class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
           # @!attribute attributes
           #   The attributes of the pay statement item.
           #
-          #   @return [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes, nil]
-          optional :attributes, -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes }
+          #   @return [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes]
+          required :attributes, -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes }
 
           # @!attribute category
           #   The category of the pay statement item.
           #
-          #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category, nil]
-          optional :category, enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category }
+          #   @return [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category]
+          required :category, enum: -> { FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category }
 
           # @!attribute name
           #   The name of the pay statement item.
           #
-          #   @return [String, nil]
-          optional :name, String
+          #   @return [String]
+          required :name, String
 
-          # @!method initialize(attributes: nil, category: nil, name: nil)
+          # @!method initialize(attributes:, category:, name:)
           #   @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes] The attributes of the pay statement item.
           #
           #   @param category [Symbol, FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Category] The category of the pay statement item.
@@ -33,22 +33,22 @@ class PayStatementItemListResponse < FinchAPI::Internal::Type::BaseModel
 
           # @see FinchAPI::Models::HRIS::Company::PayStatementItemListResponse#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
-            # @!attribute employer
-            #   `true` if the amount is paid by the employers. This field is only available for
-            #   taxes.
-            #
-            #   @return [Boolean, nil]
-            optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
-
             # @!attribute metadata
             #   The metadata of the pay statement item derived by the rules engine if available.
             #   Each attribute will be a key-value pair defined by a rule.
             #
             #   @return [Hash{Symbol=>Object, nil}, nil]
-            optional :metadata,
+            required :metadata,
                      FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true],
                      nil?: true
 
+            # @!attribute employer
+            #   `true` if the amount is paid by the employers. This field is only available for
+            #   taxes.
+            #
+            #   @return [Boolean, nil]
+            optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true
+
             # @!attribute pre_tax
             #   `true` if the pay statement item is pre-tax. This field is only available for
             #   employee deductions.
@@ -62,17 +62,17 @@ class Attributes < FinchAPI::Internal::Type::BaseModel
             #   @return [String, nil]
             optional :type, String, nil?: true
 
-            # @!method initialize(employer: nil, metadata: nil, pre_tax: nil, type: nil)
+            # @!method initialize(metadata:, employer: nil, pre_tax: nil, type: nil)
             #   Some parameter documentations has been truncated, see
             #   {FinchAPI::Models::HRIS::Company::PayStatementItemListResponse::Attributes} for
             #   more details.
             #
             #   The attributes of the pay statement item.
             #
-            #   @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for
-            #
             #   @param metadata [Hash{Symbol=>Object, nil}, nil] The metadata of the pay statement item derived by the rules engine if available.
             #
+            #   @param employer [Boolean, nil] `true` if the amount is paid by the employers. This field is only available for
+            #
             #   @param pre_tax [Boolean, nil] `true` if the pay statement item is pre-tax. This field is only available for em
             #
             #   @param type [String, nil] The type of the pay statement item.

lib/finch_api/models/hris/employment_data.rb

@@ -23,18 +23,6 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
           #   @return [String, nil]
           required :class_code, String, nil?: true
 
-          # @!attribute custom_fields
-          #   Custom fields for the individual. These are fields which are defined by the
-          #   employer in the system. Custom fields are not currently supported for assisted
-          #   connections.
-          #
-          #   @return [Array<FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
-          required :custom_fields,
-                   -> {
-                     FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]
-                   },
-                   nil?: true
-
           # @!attribute department
           #   The department object.
           #
@@ -112,13 +100,17 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
           #   @return [String, nil]
           required :title, String, nil?: true
 
-          # @!attribute work_id
-          #   @deprecated
-          #
-          #   This field is deprecated in favour of `source_id`
+          # @!attribute custom_fields
+          #   Custom fields for the individual. These are fields which are defined by the
+          #   employer in the system. Custom fields are not currently supported for assisted
+          #   connections.
           #
-          #   @return [String, nil]
-          required :work_id, String, nil?: true
+          #   @return [Array<FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
+          optional :custom_fields,
+                   -> {
+                     FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField]
+                   },
+                   nil?: true
 
           # @!attribute income
           #   The employee's income as reported by the provider. This may not always be
@@ -142,16 +134,22 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
           #   @return [String, nil]
           optional :source_id, String, nil?: true
 
-          # @!method initialize(id:, class_code:, custom_fields:, department:, employment:, employment_status:, end_date:, first_name:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, work_id:, income: nil, income_history: nil, source_id: nil)
+          # @!attribute work_id
+          #   @deprecated
+          #
+          #   This field is deprecated in favour of `source_id`
+          #
+          #   @return [String, nil]
+          optional :work_id, String, nil?: true
+
+          # @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::EmploymentData::UnionMember0} for more details.
           #
           #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
           #
           #   @param class_code [String, nil] Worker's compensation classification code for this employee
           #
-          #   @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
-          #
           #   @param department [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Department, nil] The department object.
           #
           #   @param employment [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object.
@@ -178,52 +176,15 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
           #
           #   @param title [String, nil] The current title of the individual.
           #
-          #   @param work_id [String, nil] This field is deprecated in favour of `source_id`
+          #   @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
           #
           #   @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
           #
           #   @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
           #
           #   @param source_id [String, nil] The source system's unique employment identifier for this individual
-
-          class CustomField < FinchAPI::Internal::Type::BaseModel
-            # @!attribute name
-            #
-            #   @return [String, nil]
-            optional :name, String, nil?: true
-
-            # @!attribute value
-            #
-            #   @return [String, Array<Object>, Object, Float, Boolean, nil]
-            optional :value,
-                     union: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value },
-                     nil?: true
-
-            # @!method initialize(name: nil, value: nil)
-            #   @param name [String, nil]
-            #   @param value [String, Array<Object>, Object, Float, Boolean, nil]
-
-            # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField#value
-            module Value
-              extend FinchAPI::Internal::Type::Union
-
-              variant String
-
-              variant -> { FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField::Value::UnionMember1Array }
-
-              variant FinchAPI::Internal::Type::Unknown
-
-              variant Float
-
-              variant FinchAPI::Internal::Type::Boolean
-
-              # @!method self.variants
-              #   @return [Array(String, Array<Object>, Object, Float, Boolean)]
-
-              # @type [FinchAPI::Internal::Type::Converter]
-              UnionMember1Array = FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown]
-            end
-          end
+          #
+          #   @param work_id [String, nil] This field is deprecated in favour of `source_id`
 
           # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#department
           class Department < FinchAPI::Internal::Type::BaseModel
@@ -335,6 +296,45 @@ class Manager < FinchAPI::Internal::Type::BaseModel
             #
             #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
           end
+
+          class CustomField < FinchAPI::Internal::Type::BaseModel
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute value
+            #
+            #   @return [String, Array<Object>, Object, Float, Boolean, nil]
+            optional :value,
+                     union: -> { FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField::Value },
+                     nil?: true
+
+            # @!method initialize(name: nil, value: nil)
+            #   @param name [String, nil]
+            #   @param value [String, Array<Object>, Object, Float, Boolean, nil]
+
+            # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField#value
+            module Value
+              extend FinchAPI::Internal::Type::Union
+
+              variant String
+
+              variant -> { FinchAPI::Models::HRIS::EmploymentData::UnionMember0::CustomField::Value::UnionMember1Array }
+
+              variant FinchAPI::Internal::Type::Unknown
+
+              variant Float
+
+              variant FinchAPI::Internal::Type::Boolean
+
+              # @!method self.variants
+              #   @return [Array(String, Array<Object>, Object, Float, Boolean)]
+
+              # @type [FinchAPI::Internal::Type::Converter]
+              UnionMember1Array = FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown]
+            end
+          end
         end
 
         class BatchError < FinchAPI::Internal::Type::BaseModel