diff --git a/.release-please-manifest.json b/.release-please-manifest.json index db3930fd..9c28aaea 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.40" + ".": "0.1.0-alpha.41" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 97c0d1d0..b15bfab0 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 46 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-ded87cb73affcaff9cf779d9cfd119a4026cfc1757b39be95d933edea48a0328.yml -openapi_spec_hash: 0e6394b222fc68d7607114e70b72d23e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-46f433f34d440aa1dfcc48cc8d822c598571b68be2f723ec99e1b4fba6c13b1e.yml +openapi_spec_hash: 5b5cd728776723ac773900f7e8a32c05 config_hash: 0892e2e0eeb0343a022afa62e9080dd1 diff --git a/CHANGELOG.md b/CHANGELOG.md index ad7d6c44..433b1ec8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Changelog +## 0.1.0-alpha.41 (2026-01-13) + +Full Changelog: [v0.1.0-alpha.40...v0.1.0-alpha.41](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.40...v0.1.0-alpha.41) + +### Features + +* **api:** api update ([c7cf406](https://github.com/Finch-API/finch-api-ruby/commit/c7cf4068b9cff10eb1b8c34ee507375a31bcc412)) + + +### Chores + +* fix typo in descriptions ([6ea1ae9](https://github.com/Finch-API/finch-api-ruby/commit/6ea1ae93b192ad7ec8a54e9881665decc46a716b)) +* move `cgi` into dependencies for ruby 4 ([05f9567](https://github.com/Finch-API/finch-api-ruby/commit/05f95676c9102c184d4d157c055f4387f42dc66b)) + ## 0.1.0-alpha.40 (2026-01-05) Full Changelog: [v0.1.0-alpha.39...v0.1.0-alpha.40](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.39...v0.1.0-alpha.40) diff --git a/Gemfile.lock b/Gemfile.lock index 83076e7f..32357747 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,8 @@ GIT PATH remote: . specs: - finch-api (0.1.0.pre.alpha.40) + finch-api (0.1.0.pre.alpha.41) + cgi connection_pool GEM @@ -42,6 +43,7 @@ GEM base64 (0.3.0) benchmark (0.5.0) bigdecimal (3.3.1) + cgi (0.5.1) concurrent-ruby (1.3.5) connection_pool (2.5.4) console (1.34.2) diff --git a/README.md b/README.md index dfbcdc65..1da93493 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "finch-api", "~> 0.1.0.pre.alpha.40" +gem "finch-api", "~> 0.1.0.pre.alpha.41" ``` diff --git a/finch_api.gemspec b/finch_api.gemspec index bfcb4534..60566de5 100644 --- a/finch_api.gemspec +++ b/finch_api.gemspec @@ -24,5 +24,6 @@ Gem::Specification.new do |s| ".ignore" ] s.extra_rdoc_files = ["README.md"] + s.add_dependency "cgi" s.add_dependency "connection_pool" end diff --git a/lib/finch_api/models/hris/employment_data.rb b/lib/finch_api/models/hris/employment_data.rb index c6ddae23..83b576cc 100644 --- a/lib/finch_api/models/hris/employment_data.rb +++ b/lib/finch_api/models/hris/employment_data.rb @@ -36,8 +36,7 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel required :employment, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment }, nil?: true # @!attribute employment_status - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. # # @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] required :employment_status, @@ -154,7 +153,7 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel # # @param employment [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` + # @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. # # @param end_date [String, nil] # @@ -264,8 +263,7 @@ module Type end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. # # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#employment_status module EmploymentStatus diff --git a/lib/finch_api/models/hris/payment_list_params.rb b/lib/finch_api/models/hris/payment_list_params.rb index 7aab0985..deadad30 100644 --- a/lib/finch_api/models/hris/payment_list_params.rb +++ b/lib/finch_api/models/hris/payment_list_params.rb @@ -10,14 +10,14 @@ class PaymentListParams < FinchAPI::Internal::Type::BaseModel # @!attribute end_date # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. # # @return [Date] required :end_date, Date # @!attribute start_date # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. # # @return [Date] required :start_date, Date diff --git a/lib/finch_api/models/sandbox/directory_create_params.rb b/lib/finch_api/models/sandbox/directory_create_params.rb index 29fe73d5..79bf039c 100644 --- a/lib/finch_api/models/sandbox/directory_create_params.rb +++ b/lib/finch_api/models/sandbox/directory_create_params.rb @@ -69,8 +69,7 @@ class Body < FinchAPI::Internal::Type::BaseModel optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true # @!attribute employment_status - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. # # @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] optional :employment_status, @@ -225,7 +224,7 @@ class Body < FinchAPI::Internal::Type::BaseModel # # @param employment [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` + # @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. # # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is # @@ -392,8 +391,7 @@ module Type end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. # # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment_status module EmploymentStatus diff --git a/lib/finch_api/models/sandbox/employment_update_params.rb b/lib/finch_api/models/sandbox/employment_update_params.rb index 68ffc5a3..7989b35b 100644 --- a/lib/finch_api/models/sandbox/employment_update_params.rb +++ b/lib/finch_api/models/sandbox/employment_update_params.rb @@ -39,8 +39,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true # @!attribute employment_status - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. # # @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] optional :employment_status, @@ -137,7 +136,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel # # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` + # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. # # @param end_date [String, nil] # @@ -257,8 +256,7 @@ module Type end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/lib/finch_api/models/sandbox/employment_update_response.rb b/lib/finch_api/models/sandbox/employment_update_response.rb index 991fa3f2..446c273a 100644 --- a/lib/finch_api/models/sandbox/employment_update_response.rb +++ b/lib/finch_api/models/sandbox/employment_update_response.rb @@ -40,8 +40,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment }, nil?: true # @!attribute employment_status - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. # # @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] optional :employment_status, @@ -140,7 +139,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel # # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` + # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. # # @param end_date [String, nil] # @@ -260,8 +259,7 @@ module Type end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. # # @see FinchAPI::Models::Sandbox::EmploymentUpdateResponse#employment_status module EmploymentStatus diff --git a/lib/finch_api/resources/hris/benefits.rb b/lib/finch_api/resources/hris/benefits.rb index 166c7ad7..9f72a62d 100644 --- a/lib/finch_api/resources/hris/benefits.rb +++ b/lib/finch_api/resources/hris/benefits.rb @@ -71,7 +71,7 @@ def retrieve(benefit_id, params = {}) # # @overload update(benefit_id, entity_ids: nil, description: nil, request_options: {}) # - # @param benefit_id [String] Path param: + # @param benefit_id [String] Path param # # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. # diff --git a/lib/finch_api/resources/hris/benefits/individuals.rb b/lib/finch_api/resources/hris/benefits/individuals.rb index 17f4dfc1..8ec78fa6 100644 --- a/lib/finch_api/resources/hris/benefits/individuals.rb +++ b/lib/finch_api/resources/hris/benefits/individuals.rb @@ -12,7 +12,7 @@ class Individuals # # @overload enroll_many(benefit_id, entity_ids: nil, individuals: nil, request_options: {}) # - # @param benefit_id [String] Path param: + # @param benefit_id [String] Path param # # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. # @@ -94,7 +94,7 @@ def retrieve_many_benefits(benefit_id, params = {}) # # @overload unenroll_many(benefit_id, entity_ids: nil, individual_ids: nil, request_options: {}) # - # @param benefit_id [String] Path param: + # @param benefit_id [String] Path param # # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. # diff --git a/lib/finch_api/resources/hris/company/pay_statement_item.rb b/lib/finch_api/resources/hris/company/pay_statement_item.rb index c9f31e61..26bb84ca 100644 --- a/lib/finch_api/resources/hris/company/pay_statement_item.rb +++ b/lib/finch_api/resources/hris/company/pay_statement_item.rb @@ -11,9 +11,8 @@ class PayStatementItem # Some parameter documentations has been truncated, see # {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details. # - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Retrieve a list of detailed pay statement - # items for the access token's connection account. + # Retrieve a list of detailed pay statement items for the access token's + # connection account. # # @overload list(categories: nil, end_date: nil, entity_ids: nil, name: nil, start_date: nil, type: nil, request_options: {}) # diff --git a/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb b/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb index e6345cad..c7085069 100644 --- a/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb +++ b/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb @@ -10,12 +10,10 @@ class Rules # {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams} for more # details. # - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Custom rules can be created to associate - # specific attributes to pay statement items depending on the use case. For - # example, pay statement items that meet certain conditions can be labeled as a - # pre-tax 401k. This metadata can be retrieved where pay statement item - # information is available. + # Custom rules can be created to associate specific attributes to pay statement + # items depending on the use case. For example, pay statement items that meet + # certain conditions can be labeled as a pre-tax 401k. This metadata can be + # retrieved where pay statement item information is available. # # @overload create(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {}) # @@ -23,7 +21,7 @@ class Rules # # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Body param: Specifies the fields to be applied when the condition is met. # - # @param conditions [Array] Body param: + # @param conditions [Array] Body param # # @param effective_end_date [String, nil] Body param: Specifies when the rules should stop applying rules based on the dat # @@ -49,16 +47,15 @@ def create(params = {}) ) end - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Update a rule for a pay statement item. + # Update a rule for a pay statement item. # # @overload update(rule_id, entity_ids: nil, optional_property: nil, request_options: {}) # - # @param rule_id [String] Path param: + # @param rule_id [String] Path param # # @param entity_ids [Array] Query param: The entity IDs to update the rule for. # - # @param optional_property [Object] Body param: + # @param optional_property [Object] Body param # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # @@ -78,8 +75,7 @@ def update(rule_id, params = {}) ) 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. + # List all rules of a connection account. # # @overload list(entity_ids: nil, request_options: {}) # @@ -102,8 +98,7 @@ def list(params = {}) ) end - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Delete a rule for a pay statement item. + # Delete a rule for a pay statement item. # # @overload delete(rule_id, entity_ids: nil, request_options: {}) # diff --git a/lib/finch_api/resources/hris/individuals.rb b/lib/finch_api/resources/hris/individuals.rb index 13de1bfb..9f9182f6 100644 --- a/lib/finch_api/resources/hris/individuals.rb +++ b/lib/finch_api/resources/hris/individuals.rb @@ -10,9 +10,9 @@ class Individuals # # @param entity_ids [Array] Query param: The entity IDs to specify which entities' data to access. # - # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param: + # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param # - # @param requests [Array] Body param: + # @param requests [Array] Body param # # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/finch_api/resources/jobs/manual.rb b/lib/finch_api/resources/jobs/manual.rb index 0e04509a..fa482da0 100644 --- a/lib/finch_api/resources/jobs/manual.rb +++ b/lib/finch_api/resources/jobs/manual.rb @@ -4,8 +4,8 @@ module FinchAPI module Resources class Jobs class Manual - # Get a manual job by `job_id`. Manual jobs are completed by a human and include - # Assisted Benefits jobs. + # Check the status and outcome of a job by `job_id`. This includes all deductions + # jobs including those for both automated and assisted integrations. # # @overload retrieve(job_id, request_options: {}) # diff --git a/lib/finch_api/resources/sandbox/employment.rb b/lib/finch_api/resources/sandbox/employment.rb index e574911e..2a6b351c 100644 --- a/lib/finch_api/resources/sandbox/employment.rb +++ b/lib/finch_api/resources/sandbox/employment.rb @@ -21,7 +21,7 @@ class Employment # # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object. # - # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, ` + # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. # # @param end_date [String, nil] # diff --git a/lib/finch_api/version.rb b/lib/finch_api/version.rb index 5eaa7991..66e2f1a8 100644 --- a/lib/finch_api/version.rb +++ b/lib/finch_api/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module FinchAPI - VERSION = "0.1.0.pre.alpha.40" + VERSION = "0.1.0.pre.alpha.41" end diff --git a/rbi/finch_api/models/hris/employment_data.rbi b/rbi/finch_api/models/hris/employment_data.rbi index d806e603..e8b8f715 100644 --- a/rbi/finch_api/models/hris/employment_data.rbi +++ b/rbi/finch_api/models/hris/employment_data.rbi @@ -71,8 +71,7 @@ module FinchAPI end attr_writer :employment - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. sig do returns( T.nilable( @@ -221,8 +220,7 @@ module FinchAPI department:, # The employment object. employment:, - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. employment_status:, end_date:, # The legal first name of the individual. @@ -491,8 +489,7 @@ module FinchAPI end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/rbi/finch_api/models/hris/payment_list_params.rbi b/rbi/finch_api/models/hris/payment_list_params.rbi index 3084b348..d5c9c193 100644 --- a/rbi/finch_api/models/hris/payment_list_params.rbi +++ b/rbi/finch_api/models/hris/payment_list_params.rbi @@ -16,12 +16,12 @@ module FinchAPI end # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. sig { returns(Date) } attr_accessor :end_date # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. sig { returns(Date) } attr_accessor :start_date @@ -42,10 +42,10 @@ module FinchAPI end def self.new( # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. end_date:, # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. start_date:, # The entity IDs to specify which entities' data to access. entity_ids: nil, diff --git a/rbi/finch_api/models/sandbox/directory_create_params.rbi b/rbi/finch_api/models/sandbox/directory_create_params.rbi index f415016f..6965cd51 100644 --- a/rbi/finch_api/models/sandbox/directory_create_params.rbi +++ b/rbi/finch_api/models/sandbox/directory_create_params.rbi @@ -137,8 +137,7 @@ module FinchAPI end attr_writer :employment - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. sig do returns( T.nilable( @@ -354,8 +353,7 @@ module FinchAPI emails: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. employment_status: nil, # Social Security Number of the individual in **encrypted** format. This field is # only available with the `ssn` scope enabled and the @@ -778,8 +776,7 @@ module FinchAPI end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/rbi/finch_api/models/sandbox/employment_update_params.rbi b/rbi/finch_api/models/sandbox/employment_update_params.rbi index b00ad4aa..b190a9e5 100644 --- a/rbi/finch_api/models/sandbox/employment_update_params.rbi +++ b/rbi/finch_api/models/sandbox/employment_update_params.rbi @@ -67,8 +67,7 @@ module FinchAPI end attr_writer :employment - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. sig do returns( T.nilable( @@ -198,8 +197,7 @@ module FinchAPI department: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. employment_status: nil, end_date: nil, # The legal first name of the individual. @@ -492,8 +490,7 @@ module FinchAPI end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/rbi/finch_api/models/sandbox/employment_update_response.rbi b/rbi/finch_api/models/sandbox/employment_update_response.rbi index 722ecf21..62b5ff9a 100644 --- a/rbi/finch_api/models/sandbox/employment_update_response.rbi +++ b/rbi/finch_api/models/sandbox/employment_update_response.rbi @@ -77,8 +77,7 @@ module FinchAPI end attr_writer :employment - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. sig do returns( T.nilable( @@ -214,8 +213,7 @@ module FinchAPI department: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. employment_status: nil, end_date: nil, # The legal first name of the individual. @@ -509,8 +507,7 @@ module FinchAPI end end - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. module EmploymentStatus extend FinchAPI::Internal::Type::Enum diff --git a/rbi/finch_api/resources/hris/benefits.rbi b/rbi/finch_api/resources/hris/benefits.rbi index e1ae9ef5..6db6cd8e 100644 --- a/rbi/finch_api/resources/hris/benefits.rbi +++ b/rbi/finch_api/resources/hris/benefits.rbi @@ -65,7 +65,7 @@ module FinchAPI ).returns(FinchAPI::HRIS::UpdateCompanyBenefitResponse) end def update( - # Path param: + # Path param benefit_id, # Query param: The entity IDs to specify which entities' data to access. entity_ids: nil, diff --git a/rbi/finch_api/resources/hris/benefits/individuals.rbi b/rbi/finch_api/resources/hris/benefits/individuals.rbi index f2aa7794..1e0aa718 100644 --- a/rbi/finch_api/resources/hris/benefits/individuals.rbi +++ b/rbi/finch_api/resources/hris/benefits/individuals.rbi @@ -23,7 +23,7 @@ module FinchAPI ) end def enroll_many( - # Path param: + # Path param benefit_id, # Query param: The entity IDs to specify which entities' data to access. entity_ids: nil, @@ -87,7 +87,7 @@ module FinchAPI ) end def unenroll_many( - # Path param: + # Path param benefit_id, # Query param: The entity IDs to specify which entities' data to access. entity_ids: nil, diff --git a/rbi/finch_api/resources/hris/company/pay_statement_item.rbi b/rbi/finch_api/resources/hris/company/pay_statement_item.rbi index f323ea70..5a4d4c8e 100644 --- a/rbi/finch_api/resources/hris/company/pay_statement_item.rbi +++ b/rbi/finch_api/resources/hris/company/pay_statement_item.rbi @@ -10,9 +10,8 @@ module FinchAPI end attr_reader :rules - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Retrieve a list of detailed pay statement - # items for the access token's connection account. + # Retrieve a list of detailed pay statement items for the access token's + # connection account. sig do params( categories: diff --git a/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi b/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi index 650ca9ca..2f8060f0 100644 --- a/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi +++ b/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi @@ -6,12 +6,10 @@ module FinchAPI class Company class PayStatementItem class Rules - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Custom rules can be created to associate - # specific attributes to pay statement items depending on the use case. For - # example, pay statement items that meet certain conditions can be labeled as a - # pre-tax 401k. This metadata can be retrieved where pay statement item - # information is available. + # Custom rules can be created to associate specific attributes to pay statement + # items depending on the use case. For example, pay statement items that meet + # certain conditions can be labeled as a pre-tax 401k. This metadata can be + # retrieved where pay statement item information is available. sig do params( entity_ids: T::Array[String], @@ -35,7 +33,7 @@ module FinchAPI entity_ids: nil, # Body param: Specifies the fields to be applied when the condition is met. attributes: nil, - # Body param: + # Body param conditions: nil, # Body param: Specifies when the rules should stop applying rules based on the # date. @@ -48,8 +46,7 @@ module FinchAPI ) end - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Update a rule for a pay statement item. + # Update a rule for a pay statement item. sig do params( rule_id: String, @@ -61,18 +58,17 @@ module FinchAPI ) end def update( - # Path param: + # Path param rule_id, # Query param: The entity IDs to update the rule for. entity_ids: nil, - # Body param: + # 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. + # List all rules of a connection account. sig do params( entity_ids: T::Array[String], @@ -90,8 +86,7 @@ module FinchAPI ) end - # **Beta:** this endpoint currently serves employers onboarded after March 4th and - # historical support will be added soon Delete a rule for a pay statement item. + # Delete a rule for a pay statement item. sig do params( rule_id: String, diff --git a/rbi/finch_api/resources/hris/individuals.rbi b/rbi/finch_api/resources/hris/individuals.rbi index 6401666d..50b4843d 100644 --- a/rbi/finch_api/resources/hris/individuals.rbi +++ b/rbi/finch_api/resources/hris/individuals.rbi @@ -26,9 +26,9 @@ module FinchAPI def retrieve_many( # Query param: The entity IDs to specify which entities' data to access. entity_ids: nil, - # Body param: + # Body param options: nil, - # Body param: + # Body param requests: nil, request_options: {} ) diff --git a/rbi/finch_api/resources/hris/payments.rbi b/rbi/finch_api/resources/hris/payments.rbi index e53ecf03..0fdc717a 100644 --- a/rbi/finch_api/resources/hris/payments.rbi +++ b/rbi/finch_api/resources/hris/payments.rbi @@ -15,10 +15,10 @@ module FinchAPI end def list( # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. end_date:, # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` - # format. + # format. Filters payments by their **pay_date** field. start_date:, # The entity IDs to specify which entities' data to access. entity_ids: nil, diff --git a/rbi/finch_api/resources/jobs/manual.rbi b/rbi/finch_api/resources/jobs/manual.rbi index ca91bfdb..717b7c49 100644 --- a/rbi/finch_api/resources/jobs/manual.rbi +++ b/rbi/finch_api/resources/jobs/manual.rbi @@ -4,8 +4,8 @@ module FinchAPI module Resources class Jobs class Manual - # Get a manual job by `job_id`. Manual jobs are completed by a human and include - # Assisted Benefits jobs. + # Check the status and outcome of a job by `job_id`. This includes all deductions + # jobs including those for both automated and assisted integrations. sig do params( job_id: String, diff --git a/rbi/finch_api/resources/sandbox/employment.rbi b/rbi/finch_api/resources/sandbox/employment.rbi index 200984b1..df6a71dc 100644 --- a/rbi/finch_api/resources/sandbox/employment.rbi +++ b/rbi/finch_api/resources/sandbox/employment.rbi @@ -59,8 +59,7 @@ module FinchAPI department: nil, # The employment object. employment: nil, - # The detailed employment status of the individual. Available options: `active`, - # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. + # The detailed employment status of the individual. employment_status: nil, end_date: nil, # The legal first name of the individual.