From 1e24a6c308f2bda2dfc8d253bad8c0e7c007d149 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 5 Mar 2025 16:11:14 +0000 Subject: [PATCH 01/67] chore(internal): version bump (#4) --- sig/finch-api/version.rbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sig/finch-api/version.rbs b/sig/finch-api/version.rbs index 80866030..31b24595 100644 --- a/sig/finch-api/version.rbs +++ b/sig/finch-api/version.rbs @@ -1,3 +1,3 @@ module FinchAPI - VERSION: "0.0.1-alpha.0" + VERSION: "0.1.0-alpha.1" end From f2353c89d8c6b257767ff0a4213f170ae18afbdb Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 5 Mar 2025 18:07:50 +0000 Subject: [PATCH 02/67] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 06d70961..7cc1a4d2 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 41 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-7a816d4a5f0039230590a6662f3513d5756344ca662761ecbc49016593f65836.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-a8fb4796584347205fabadf0148a039a0259b7363ffa476579032acd2987311a.yml From e19278e42797781e1ed237688abe62a2b9e85b4c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 5 Mar 2025 23:24:04 +0000 Subject: [PATCH 03/67] chore: update custom timeout header name (#6) --- lib/finch-api/base_client.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index 4f024e48..abc471b4 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -246,8 +246,8 @@ def initialize( end timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..)) - unless headers.key?("x-stainless-read-timeout") || timeout.zero? - headers["x-stainless-read-timeout"] = timeout.to_s + unless headers.key?("x-stainless-timeout") || timeout.zero? + headers["x-stainless-timeout"] = timeout.to_s end headers.reject! { |_, v| v.to_s.empty? } From a64444614bbee1dd6cb93d1f5ba3440eb15e192c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 5 Mar 2025 23:44:34 +0000 Subject: [PATCH 04/67] chore: bump lockfile (#7) --- Gemfile.lock | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 7dcdc3da..6f85e901 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -93,7 +93,7 @@ GEM rbs (3.8.1) logger regexp_parser (2.10.0) - rubocop (1.72.2) + rubocop (1.73.2) json (~> 2.3) language_server-protocol (~> 3.17.0.2) lint_roller (~> 1.1.0) @@ -108,13 +108,13 @@ GEM parser (>= 3.3.1.0) ruby-progressbar (1.13.0) securerandom (0.4.1) - sorbet (0.5.11856) - sorbet-static (= 0.5.11856) - sorbet-runtime (0.5.11856) - sorbet-static (0.5.11856-x86_64-linux) - sorbet-static-and-runtime (0.5.11856) - sorbet (= 0.5.11856) - sorbet-runtime (= 0.5.11856) + sorbet (0.5.11888) + sorbet-static (= 0.5.11888) + sorbet-runtime (0.5.11888) + sorbet-static (0.5.11888-x86_64-linux) + sorbet-static-and-runtime (0.5.11888) + sorbet (= 0.5.11888) + sorbet-runtime (= 0.5.11888) spoom (1.5.4) erubi (>= 1.10.0) prism (>= 0.28.0) @@ -157,7 +157,7 @@ GEM tzinfo (2.0.6) concurrent-ruby (~> 1.0) unicode-display_width (2.6.0) - uri (1.0.2) + uri (1.0.3) webrick (1.9.1) yard (0.9.37) yard-sorbet (0.9.0) From d36ae33b0e14ea198ea19c80602a5c26256f2646 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 6 Mar 2025 02:01:24 +0000 Subject: [PATCH 05/67] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 7cc1a4d2..27e0c64c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 41 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-a8fb4796584347205fabadf0148a039a0259b7363ffa476579032acd2987311a.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-777eedfd80c3e04a8739959418783d1c976180f4f09d7a883f7de5c2b6cda5a6.yml From 0b3397f11d90ca29a56b7fa7f162d96edf07be06 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 6 Mar 2025 15:24:51 +0000 Subject: [PATCH 06/67] chore: rename misleading variable (#8) --- lib/finch-api/base_client.rb | 2 +- lib/finch-api/base_page.rb | 4 ++-- lib/finch-api/individuals_page.rb | 8 ++++---- lib/finch-api/page.rb | 8 ++++---- lib/finch-api/responses_page.rb | 6 +++--- lib/finch-api/single_page.rb | 8 ++++---- rbi/lib/finch-api/base_page.rbi | 4 ++-- rbi/lib/finch-api/individuals_page.rbi | 4 ++-- rbi/lib/finch-api/page.rbi | 4 ++-- rbi/lib/finch-api/responses_page.rbi | 4 ++-- rbi/lib/finch-api/single_page.rbi | 4 ++-- sig/finch-api/base_page.rbs | 2 +- sig/finch-api/individuals_page.rbs | 2 +- sig/finch-api/page.rbs | 2 +- sig/finch-api/responses_page.rbs | 2 +- sig/finch-api/single_page.rbs | 2 +- 16 files changed, 33 insertions(+), 33 deletions(-) diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index abc471b4..21cd1e5d 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -447,7 +447,7 @@ def request(req) in { stream: Class => st } st.new(model: model, url: url, status: status, response: response, messages: decoded) in { page: Class => page } - page.new(client: self, req: req, headers: response, unwrapped: decoded) + page.new(client: self, req: req, headers: response, page_data: decoded) else unwrapped = FinchAPI::Util.dig(decoded, req[:unwrap]) FinchAPI::Converter.coerce(model, unwrapped) diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index 428f6416..99abce0b 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -33,8 +33,8 @@ def to_enum = super(:auto_paging_each) # # @param client [FinchAPI::BaseClient] # # @param req [Hash{Symbol=>Object}] # # @param headers [Hash{String=>String}, Net::HTTPHeader] - # # @param unwrapped [Object] + # # @param page_data [Object] # # - # def initialize(client:, req:, headers:, unwrapped:); end + # def initialize(client:, req:, headers:, page_data:); end end end diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index 9f549ce6..e0bb6864 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -36,20 +36,20 @@ class IndividualsPage # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] - # @param unwrapped [Hash{Symbol=>Object}] + # @param page_data [Hash{Symbol=>Object}] # - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) @client = client @req = req model = req.fetch(:model) - case unwrapped + case page_data in {individuals: Array | nil => individuals} @individuals = individuals&.map { model.coerce(_1) } else end - case unwrapped + case page_data in {paging: Hash | nil => paging} @paging = FinchAPI::Models::Paging.coerce(paging) else diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index 167eedd3..0e02faa3 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -36,20 +36,20 @@ class Page # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] - # @param unwrapped [Hash{Symbol=>Object}] + # @param page_data [Hash{Symbol=>Object}] # - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) @client = client @req = req model = req.fetch(:model) - case unwrapped + case page_data in {data: Array | nil => data} @data = data&.map { model.coerce(_1) } else end - case unwrapped + case page_data in {paging: Hash | nil => paging} @paging = FinchAPI::Models::Paging.coerce(paging) else diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index c041c8b0..8b543983 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -33,14 +33,14 @@ class ResponsesPage # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] - # @param unwrapped [Array] + # @param page_data [Array] # - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) @client = client @req = req model = req.fetch(:model) - case unwrapped + case page_data in {responses: Array | nil => responses} @responses = responses&.map { model.coerce(_1) } else diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index 3cf33206..7ed9e046 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -30,16 +30,16 @@ class SinglePage < ::Array # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] - # @param unwrapped [Array] + # @param page_data [Array] # - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) @client = client @req = req model = req.fetch(:model) - case unwrapped + case page_data in Array - super(unwrapped&.map { model.coerce(_1) }) + super(page_data&.map { model.coerce(_1) }) else super([]) end diff --git a/rbi/lib/finch-api/base_page.rbi b/rbi/lib/finch-api/base_page.rbi index ef4c814e..be43acec 100644 --- a/rbi/lib/finch-api/base_page.rbi +++ b/rbi/lib/finch-api/base_page.rbi @@ -29,11 +29,11 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::RequestComponentsShape, headers: T.any(T::Hash[String, String], Net::HTTPHeader), - unwrapped: T.anything + page_data: T.anything ) .void end - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) end end end diff --git a/rbi/lib/finch-api/individuals_page.rbi b/rbi/lib/finch-api/individuals_page.rbi index 3209623f..c0fb6f19 100644 --- a/rbi/lib/finch-api/individuals_page.rbi +++ b/rbi/lib/finch-api/individuals_page.rbi @@ -27,11 +27,11 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::RequestComponentsShape, headers: T.any(T::Hash[String, String], Net::HTTPHeader), - unwrapped: T::Hash[Symbol, T.anything] + page_data: T::Hash[Symbol, T.anything] ) .void end - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) end end end diff --git a/rbi/lib/finch-api/page.rbi b/rbi/lib/finch-api/page.rbi index 3ff8f43e..5d4c8f8f 100644 --- a/rbi/lib/finch-api/page.rbi +++ b/rbi/lib/finch-api/page.rbi @@ -27,11 +27,11 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::RequestComponentsShape, headers: T.any(T::Hash[String, String], Net::HTTPHeader), - unwrapped: T::Hash[Symbol, T.anything] + page_data: T::Hash[Symbol, T.anything] ) .void end - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) end end end diff --git a/rbi/lib/finch-api/responses_page.rbi b/rbi/lib/finch-api/responses_page.rbi index a2d3aefe..f4aa8481 100644 --- a/rbi/lib/finch-api/responses_page.rbi +++ b/rbi/lib/finch-api/responses_page.rbi @@ -19,11 +19,11 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::RequestComponentsShape, headers: T.any(T::Hash[String, String], Net::HTTPHeader), - unwrapped: T::Array[T.anything] + page_data: T::Array[T.anything] ) .void end - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) end end end diff --git a/rbi/lib/finch-api/single_page.rbi b/rbi/lib/finch-api/single_page.rbi index 25050792..c88f53ea 100644 --- a/rbi/lib/finch-api/single_page.rbi +++ b/rbi/lib/finch-api/single_page.rbi @@ -11,11 +11,11 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::RequestComponentsShape, headers: T.any(T::Hash[String, String], Net::HTTPHeader), - unwrapped: T::Array[T.anything] + page_data: T::Array[T.anything] ) .void end - def initialize(client:, req:, headers:, unwrapped:) + def initialize(client:, req:, headers:, page_data:) end sig { override.returns(T::Boolean) } diff --git a/sig/finch-api/base_page.rbs b/sig/finch-api/base_page.rbs index 1ba129aa..091a57cd 100644 --- a/sig/finch-api/base_page.rbs +++ b/sig/finch-api/base_page.rbs @@ -14,7 +14,7 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::request_components, headers: ::Hash[String, String], - unwrapped: top + page_data: top ) -> void end end diff --git a/sig/finch-api/individuals_page.rbs b/sig/finch-api/individuals_page.rbs index c9e6da1e..99dc7aa5 100644 --- a/sig/finch-api/individuals_page.rbs +++ b/sig/finch-api/individuals_page.rbs @@ -10,7 +10,7 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::request_components, headers: ::Hash[String, String], - unwrapped: ::Hash[Symbol, top] + page_data: ::Hash[Symbol, top] ) -> void end end diff --git a/sig/finch-api/page.rbs b/sig/finch-api/page.rbs index fb9b1943..00a92ead 100644 --- a/sig/finch-api/page.rbs +++ b/sig/finch-api/page.rbs @@ -10,7 +10,7 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::request_components, headers: ::Hash[String, String], - unwrapped: ::Hash[Symbol, top] + page_data: ::Hash[Symbol, top] ) -> void end end diff --git a/sig/finch-api/responses_page.rbs b/sig/finch-api/responses_page.rbs index dfe5d3e0..9df96faa 100644 --- a/sig/finch-api/responses_page.rbs +++ b/sig/finch-api/responses_page.rbs @@ -8,7 +8,7 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::request_components, headers: ::Hash[String, String], - unwrapped: ::Array[top] + page_data: ::Array[top] ) -> void end end diff --git a/sig/finch-api/single_page.rbs b/sig/finch-api/single_page.rbs index ed1aed9d..65d4b480 100644 --- a/sig/finch-api/single_page.rbs +++ b/sig/finch-api/single_page.rbs @@ -6,7 +6,7 @@ module FinchAPI client: FinchAPI::BaseClient, req: FinchAPI::BaseClient::request_components, headers: ::Hash[String, String], - unwrapped: ::Array[top] + page_data: ::Array[top] ) -> void def next_page?: -> bool From 4ba4a39da10518ea5f4ec13f35d2ffcdac9931dc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 6 Mar 2025 21:45:09 +0000 Subject: [PATCH 07/67] chore: move examples into tests (#9) --- lib/finch-api/base_model.rb | 62 ++++++++++++ lib/finch-api/models/account_update_event.rb | 23 ----- lib/finch-api/models/company_event.rb | 7 -- .../models/connect/session_new_params.rb | 40 -------- .../connect/session_reauthenticate_params.rb | 18 ---- .../models/connection_status_type.rb | 17 ---- .../models/create_access_token_response.rb | 22 ----- lib/finch-api/models/directory_event.rb | 11 --- lib/finch-api/models/employment_event.rb | 11 --- .../models/hris/benefit_contribution.rb | 10 -- .../hris/benefit_features_and_operations.rb | 27 ------ .../models/hris/benefit_frequency.rb | 11 --- lib/finch-api/models/hris/benefit_type.rb | 18 ---- .../hris/benefits/enrolled_individual.rb | 14 --- .../hris/benefits/individual_benefit.rb | 10 -- .../benefits/individual_enroll_many_params.rb | 28 ------ lib/finch-api/models/hris/company.rb | 40 -------- .../models/hris/document_list_params.rb | 9 -- .../models/hris/document_response.rb | 10 -- .../models/hris/document_retreive_response.rb | 20 ---- lib/finch-api/models/hris/employment_data.rb | 46 --------- lib/finch-api/models/hris/individual.rb | 50 ---------- lib/finch-api/models/hris/pay_statement.rb | 54 ----------- lib/finch-api/models/hris/payment.rb | 17 ---- .../models/hris/supported_benefit.rb | 27 ------ lib/finch-api/models/hris/w42005.rb | 30 ------ lib/finch-api/models/hris/w42020.rb | 20 ---- lib/finch-api/models/income.rb | 18 ---- lib/finch-api/models/individual_event.rb | 11 --- lib/finch-api/models/introspection.rb | 38 -------- lib/finch-api/models/job_completion_event.rb | 17 ---- .../models/jobs/automated_async_job.rb | 27 ------ .../models/jobs/automated_create_params.rb | 8 -- lib/finch-api/models/jobs/manual_async_job.rb | 13 --- lib/finch-api/models/operation_support.rb | 14 --- lib/finch-api/models/pay_statement_event.rb | 11 --- lib/finch-api/models/payment_event.rb | 11 --- .../models/payroll/pay_group_list_response.rb | 17 ---- .../payroll/pay_group_retrieve_response.rb | 17 ---- lib/finch-api/models/provider.rb | 16 ---- .../models/sandbox/company_update_params.rb | 40 -------- .../models/sandbox/company_update_response.rb | 40 -------- .../sandbox/connection_create_params.rb | 13 --- .../sandbox/connection_create_response.rb | 13 --- .../connections/account_create_params.rb | 13 --- .../connections/account_create_response.rb | 13 --- .../connections/account_update_response.rb | 13 --- .../models/sandbox/directory_create_params.rb | 96 ------------------- .../sandbox/employment_update_params.rb | 46 --------- .../sandbox/employment_update_response.rb | 46 --------- .../sandbox/individual_update_params.rb | 50 ---------- .../sandbox/individual_update_response.rb | 50 ---------- .../models/sandbox/job_create_params.rb | 8 -- .../sandbox/jobs/sandbox_job_configuration.rb | 20 ---- .../models/sandbox/payment_create_params.rb | 54 ----------- lib/finch-api/models/webhook_event.rb | 21 ---- .../resources/hris/documents_test.rb | 14 +++ 57 files changed, 76 insertions(+), 1344 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index b31a922a..ef040e4a 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -294,6 +294,35 @@ def self.try_strict_coerce(value) # # We can therefore convert string values to Symbols, but can't convert other # values safely. + # + # @example + # ```ruby + # # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType` + # case connection_status_type + # when FinchAPI::Models::ConnectionStatusType::PENDING + # # ... + # when FinchAPI::Models::ConnectionStatusType::PROCESSING + # # ... + # when FinchAPI::Models::ConnectionStatusType::CONNECTED + # # ... + # else + # # ... + # end + # ``` + # + # @example + # ```ruby + # case connection_status_type + # in :pending + # # ... + # in :processing + # # ... + # in :connected + # # ... + # else + # # ... + # end + # ``` class Enum extend FinchAPI::Converter @@ -369,6 +398,30 @@ def self.try_strict_coerce(value) # # @abstract # + # @example + # ```ruby + # # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse` + # case document_retreive_response + # when FinchAPI::Models::HRIS::W42020 + # # ... + # when FinchAPI::Models::HRIS::W42005 + # # ... + # else + # # ... + # end + # ``` + # + # @example + # ```ruby + # case document_retreive_response + # in {type: :w4_2020, data: data, year: year} + # # ... + # in {type: :w4_2005, data: data, year: year} + # # ... + # else + # # ... + # end + # ``` class Union extend FinchAPI::Converter @@ -839,6 +892,15 @@ def initialize(type_info, spec = {}) # # @abstract # + # @example + # ```ruby + # # `operation_support_matrix` is a `FinchAPI::Models::OperationSupportMatrix` + # operation_support_matrix => { + # create: create, + # delete: delete, + # read: read + # } + # ``` class BaseModel extend FinchAPI::Converter diff --git a/lib/finch-api/models/account_update_event.rb b/lib/finch-api/models/account_update_event.rb index 4d3ad167..b0037c1d 100644 --- a/lib/finch-api/models/account_update_event.rb +++ b/lib/finch-api/models/account_update_event.rb @@ -1921,22 +1921,6 @@ class PayPeriod < FinchAPI::BaseModel # @abstract # # The type of authentication method. - # - # @example - # ```ruby - # case type - # in :assisted - # # ... - # in :credential - # # ... - # in :api_token - # # ... - # in :api_credential - # # ... - # in :oauth - # # ... - # end - # ``` class Type < FinchAPI::Enum ASSISTED = :assisted CREDENTIAL = :credential @@ -1956,13 +1940,6 @@ class Type < FinchAPI::Enum # @abstract # - # @example - # ```ruby - # case event_type - # in :"account.updated" - # # ... - # end - # ``` class EventType < FinchAPI::Enum ACCOUNT_UPDATED = :"account.updated" diff --git a/lib/finch-api/models/company_event.rb b/lib/finch-api/models/company_event.rb index 2aa752c4..e1e013ee 100644 --- a/lib/finch-api/models/company_event.rb +++ b/lib/finch-api/models/company_event.rb @@ -27,13 +27,6 @@ class CompanyEvent < FinchAPI::Models::BaseWebhookEvent # @abstract # - # @example - # ```ruby - # case event_type - # in :"company.updated" - # # ... - # end - # ``` class EventType < FinchAPI::Enum COMPANY_UPDATED = :"company.updated" diff --git a/lib/finch-api/models/connect/session_new_params.rb b/lib/finch-api/models/connect/session_new_params.rb index 3e3be8d4..372cb350 100644 --- a/lib/finch-api/models/connect/session_new_params.rb +++ b/lib/finch-api/models/connect/session_new_params.rb @@ -88,24 +88,6 @@ class SessionNewParams < FinchAPI::BaseModel # @abstract # # The Finch products that can be requested during the Connect flow. - # - # @example - # ```ruby - # case product - # in :company - # # ... - # in :directory - # # ... - # in :individual - # # ... - # in :employment - # # ... - # in :payment - # # ... - # in ... - # #... - # end - # ``` class Product < FinchAPI::Enum COMPANY = :company DIRECTORY = :directory @@ -147,19 +129,6 @@ class Integration < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case auth_method - # in :assisted - # # ... - # in :credential - # # ... - # in :oauth - # # ... - # in :api_token - # # ... - # end - # ``` class AuthMethod < FinchAPI::Enum ASSISTED = :assisted CREDENTIAL = :credential @@ -177,15 +146,6 @@ class AuthMethod < FinchAPI::Enum # @abstract # - # @example - # ```ruby - # case sandbox - # in :finch - # # ... - # in :provider - # # ... - # end - # ``` class Sandbox < FinchAPI::Enum FINCH = :finch PROVIDER = :provider diff --git a/lib/finch-api/models/connect/session_reauthenticate_params.rb b/lib/finch-api/models/connect/session_reauthenticate_params.rb index 2c9d4a30..3b6bc44f 100644 --- a/lib/finch-api/models/connect/session_reauthenticate_params.rb +++ b/lib/finch-api/models/connect/session_reauthenticate_params.rb @@ -49,24 +49,6 @@ class SessionReauthenticateParams < FinchAPI::BaseModel # @abstract # # The Finch products that can be requested during the Connect flow. - # - # @example - # ```ruby - # case product - # in :company - # # ... - # in :directory - # # ... - # in :individual - # # ... - # in :employment - # # ... - # in :payment - # # ... - # in ... - # #... - # end - # ``` class Product < FinchAPI::Enum COMPANY = :company DIRECTORY = :directory diff --git a/lib/finch-api/models/connection_status_type.rb b/lib/finch-api/models/connection_status_type.rb index 37bb73e7..3a0979d2 100644 --- a/lib/finch-api/models/connection_status_type.rb +++ b/lib/finch-api/models/connection_status_type.rb @@ -4,23 +4,6 @@ module FinchAPI module Models # @abstract # - # @example - # ```ruby - # case connection_status_type - # in :pending - # # ... - # in :processing - # # ... - # in :connected - # # ... - # in :error_no_account_setup - # # ... - # in :error_permissions - # # ... - # in ... - # #... - # end - # ``` class ConnectionStatusType < FinchAPI::Enum PENDING = :pending PROCESSING = :processing diff --git a/lib/finch-api/models/create_access_token_response.rb b/lib/finch-api/models/create_access_token_response.rb index 859c9d0a..2ef85938 100644 --- a/lib/finch-api/models/create_access_token_response.rb +++ b/lib/finch-api/models/create_access_token_response.rb @@ -106,18 +106,6 @@ class CreateAccessTokenResponse < FinchAPI::BaseModel # @abstract # # The type of application associated with a token. - # - # @example - # ```ruby - # case client_type - # in :production - # # ... - # in :development - # # ... - # in :sandbox - # # ... - # end - # ``` class ClientType < FinchAPI::Enum PRODUCTION = :production DEVELOPMENT = :development @@ -137,16 +125,6 @@ class ClientType < FinchAPI::Enum # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - # - # @example - # ```ruby - # case connection_type - # in :provider - # # ... - # in :finch - # # ... - # end - # ``` class ConnectionType < FinchAPI::Enum PROVIDER = :provider FINCH = :finch diff --git a/lib/finch-api/models/directory_event.rb b/lib/finch-api/models/directory_event.rb index 553c0d74..72234db2 100644 --- a/lib/finch-api/models/directory_event.rb +++ b/lib/finch-api/models/directory_event.rb @@ -50,17 +50,6 @@ class Data < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case event_type - # in :"directory.created" - # # ... - # in :"directory.updated" - # # ... - # in :"directory.deleted" - # # ... - # end - # ``` class EventType < FinchAPI::Enum DIRECTORY_CREATED = :"directory.created" DIRECTORY_UPDATED = :"directory.updated" diff --git a/lib/finch-api/models/employment_event.rb b/lib/finch-api/models/employment_event.rb index c7d603b1..95090c69 100644 --- a/lib/finch-api/models/employment_event.rb +++ b/lib/finch-api/models/employment_event.rb @@ -50,17 +50,6 @@ class Data < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case event_type - # in :"employment.created" - # # ... - # in :"employment.updated" - # # ... - # in :"employment.deleted" - # # ... - # end - # ``` class EventType < FinchAPI::Enum EMPLOYMENT_CREATED = :"employment.created" EMPLOYMENT_UPDATED = :"employment.updated" diff --git a/lib/finch-api/models/hris/benefit_contribution.rb b/lib/finch-api/models/hris/benefit_contribution.rb index e3092be8..48e09273 100644 --- a/lib/finch-api/models/hris/benefit_contribution.rb +++ b/lib/finch-api/models/hris/benefit_contribution.rb @@ -27,16 +27,6 @@ class BenefitContribution < FinchAPI::BaseModel # @abstract # # Contribution type. - # - # @example - # ```ruby - # case type - # in :fixed - # # ... - # in :percent - # # ... - # end - # ``` class Type < FinchAPI::Enum FIXED = :fixed PERCENT = :percent diff --git a/lib/finch-api/models/hris/benefit_features_and_operations.rb b/lib/finch-api/models/hris/benefit_features_and_operations.rb index 94e3d83d..2fc798e7 100644 --- a/lib/finch-api/models/hris/benefit_features_and_operations.rb +++ b/lib/finch-api/models/hris/benefit_features_and_operations.rb @@ -126,15 +126,6 @@ class SupportedFeatures < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case company_contribution - # in :fixed - # # ... - # in :percent - # # ... - # end - # ``` class CompanyContribution < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -149,15 +140,6 @@ class CompanyContribution < FinchAPI::Enum # @abstract # - # @example - # ```ruby - # case employee_deduction - # in :fixed - # # ... - # in :percent - # # ... - # end - # ``` class EmployeeDeduction < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -172,15 +154,6 @@ class EmployeeDeduction < FinchAPI::Enum # @abstract # - # @example - # ```ruby - # case hsa_contribution_limit - # in :individual - # # ... - # in :family - # # ... - # end - # ``` class HsaContributionLimit < FinchAPI::Enum INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/hris/benefit_frequency.rb b/lib/finch-api/models/hris/benefit_frequency.rb index 4cc1d21b..06b78c94 100644 --- a/lib/finch-api/models/hris/benefit_frequency.rb +++ b/lib/finch-api/models/hris/benefit_frequency.rb @@ -5,17 +5,6 @@ module Models module HRIS # @abstract # - # @example - # ```ruby - # case benefit_frequency - # in :one_time - # # ... - # in :every_paycheck - # # ... - # in :monthly - # # ... - # end - # ``` class BenefitFrequency < FinchAPI::Enum ONE_TIME = :one_time EVERY_PAYCHECK = :every_paycheck diff --git a/lib/finch-api/models/hris/benefit_type.rb b/lib/finch-api/models/hris/benefit_type.rb index ca5830ef..d2a6877f 100644 --- a/lib/finch-api/models/hris/benefit_type.rb +++ b/lib/finch-api/models/hris/benefit_type.rb @@ -6,24 +6,6 @@ module HRIS # @abstract # # Type of benefit. - # - # @example - # ```ruby - # case benefit_type - # in :"401k" - # # ... - # in :"401k_roth" - # # ... - # in :"401k_loan" - # # ... - # in :"403b" - # # ... - # in :"403b_roth" - # # ... - # in ... - # #... - # end - # ``` class BenefitType < FinchAPI::Enum NUMBER_401K = :"401k" NUMBER_401K_ROTH = :"401k_roth" diff --git a/lib/finch-api/models/hris/benefits/enrolled_individual.rb b/lib/finch-api/models/hris/benefits/enrolled_individual.rb index e9f69a87..a012ae2c 100644 --- a/lib/finch-api/models/hris/benefits/enrolled_individual.rb +++ b/lib/finch-api/models/hris/benefits/enrolled_individual.rb @@ -74,20 +74,6 @@ class Body < FinchAPI::BaseModel # @abstract # # HTTP status code. Either 201 or 200 - # - # @example - # ```ruby - # case code - # in 200 - # # ... - # in 201 - # # ... - # in 404 - # # ... - # in 403 - # # ... - # end - # ``` class Code < FinchAPI::Enum OK = 200 CREATED = 201 diff --git a/lib/finch-api/models/hris/benefits/individual_benefit.rb b/lib/finch-api/models/hris/benefits/individual_benefit.rb index 399c4c50..f092679b 100644 --- a/lib/finch-api/models/hris/benefits/individual_benefit.rb +++ b/lib/finch-api/models/hris/benefits/individual_benefit.rb @@ -96,16 +96,6 @@ class Body < FinchAPI::BaseModel # @abstract # # Type for HSA contribution limit if the benefit is a HSA. - # - # @example - # ```ruby - # case hsa_contribution_limit - # in :individual - # # ... - # in :family - # # ... - # end - # ``` class HsaContributionLimit < FinchAPI::Enum INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb index 2c910c6f..dc18ec58 100644 --- a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +++ b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb @@ -130,16 +130,6 @@ class Configuration < FinchAPI::BaseModel # # For HSA benefits only - whether the contribution limit is for an individual or # family - # - # @example - # ```ruby - # case annual_contribution_limit - # in :individual - # # ... - # in :family - # # ... - # end - # ``` class AnnualContributionLimit < FinchAPI::Enum INDIVIDUAL = :individual FAMILY = :family @@ -184,15 +174,6 @@ class CompanyContribution < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :fixed - # # ... - # in :percent - # # ... - # end - # ``` class Type < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -238,15 +219,6 @@ class EmployeeDeduction < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :fixed - # # ... - # in :percent - # # ... - # end - # ``` class Type < FinchAPI::Enum FIXED = :fixed PERCENT = :percent diff --git a/lib/finch-api/models/hris/company.rb b/lib/finch-api/models/hris/company.rb index 9eb638c2..3d43e7ca 100644 --- a/lib/finch-api/models/hris/company.rb +++ b/lib/finch-api/models/hris/company.rb @@ -133,16 +133,6 @@ class Account < FinchAPI::BaseModel # @abstract # # The type of bank account. - # - # @example - # ```ruby - # case account_type - # in :checking - # # ... - # in :savings - # # ... - # end - # ``` class AccountType < FinchAPI::Enum CHECKING = :checking SAVINGS = :savings @@ -221,18 +211,6 @@ class Entity < FinchAPI::BaseModel # @abstract # # The tax payer subtype of the company. - # - # @example - # ```ruby - # case subtype - # in :s_corporation - # # ... - # in :c_corporation - # # ... - # in :b_corporation - # # ... - # end - # ``` class Subtype < FinchAPI::Enum S_CORPORATION = :s_corporation C_CORPORATION = :c_corporation @@ -249,24 +227,6 @@ class Subtype < FinchAPI::Enum # @abstract # # The tax payer type of the company. - # - # @example - # ```ruby - # case type - # in :llc - # # ... - # in :lp - # # ... - # in :corporation - # # ... - # in :sole_proprietor - # # ... - # in :non_profit - # # ... - # in ... - # #... - # end - # ``` class Type < FinchAPI::Enum LLC = :llc LP = :lp diff --git a/lib/finch-api/models/hris/document_list_params.rb b/lib/finch-api/models/hris/document_list_params.rb index 31186fbd..f37e5c11 100644 --- a/lib/finch-api/models/hris/document_list_params.rb +++ b/lib/finch-api/models/hris/document_list_params.rb @@ -63,15 +63,6 @@ class DocumentListParams < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :w4_2020 - # # ... - # in :w4_2005 - # # ... - # end - # ``` class Type < FinchAPI::Enum W4_2020 = :w4_2020 W4_2005 = :w4_2005 diff --git a/lib/finch-api/models/hris/document_response.rb b/lib/finch-api/models/hris/document_response.rb index 78f9739b..2100a49d 100644 --- a/lib/finch-api/models/hris/document_response.rb +++ b/lib/finch-api/models/hris/document_response.rb @@ -62,16 +62,6 @@ class DocumentResponse < FinchAPI::BaseModel # @abstract # # The type of document. - # - # @example - # ```ruby - # case type - # in :w4_2020 - # # ... - # in :w4_2005 - # # ... - # end - # ``` class Type < FinchAPI::Enum W4_2020 = :w4_2020 W4_2005 = :w4_2005 diff --git a/lib/finch-api/models/hris/document_retreive_response.rb b/lib/finch-api/models/hris/document_retreive_response.rb index dc47ccf2..40720f8d 100644 --- a/lib/finch-api/models/hris/document_retreive_response.rb +++ b/lib/finch-api/models/hris/document_retreive_response.rb @@ -7,26 +7,6 @@ module HRIS # # A 2020 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. - # - # @example - # ```ruby - # case document_retreive_response - # in {type: "w4_2020", data: FinchAPI::Models::HRIS::W42020::Data, year: Float} - # # FinchAPI::Models::HRIS::W42020 ... - # in {type: "w4_2005", data: FinchAPI::Models::HRIS::W42005::Data, year: Float} - # # FinchAPI::Models::HRIS::W42005 ... - # end - # ``` - # - # @example - # ```ruby - # case document_retreive_response - # in FinchAPI::Models::HRIS::W42020 - # # ... - # in FinchAPI::Models::HRIS::W42005 - # # ... - # end - # ``` class DocumentRetreiveResponse < FinchAPI::Union discriminator :type diff --git a/lib/finch-api/models/hris/employment_data.rb b/lib/finch-api/models/hris/employment_data.rb index a1bfd120..6eeaa796 100644 --- a/lib/finch-api/models/hris/employment_data.rb +++ b/lib/finch-api/models/hris/employment_data.rb @@ -255,24 +255,6 @@ class Employment < FinchAPI::BaseModel # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - # - # @example - # ```ruby - # case subtype - # in :full_time - # # ... - # in :intern - # # ... - # in :part_time - # # ... - # in :temp - # # ... - # in :seasonal - # # ... - # in ... - # #... - # end - # ``` class Subtype < FinchAPI::Enum FULL_TIME = :full_time INTERN = :intern @@ -292,16 +274,6 @@ class Subtype < FinchAPI::Enum # @abstract # # The main employment type of the individual. - # - # @example - # ```ruby - # case type - # in :employee - # # ... - # in :contractor - # # ... - # end - # ``` class Type < FinchAPI::Enum EMPLOYEE = :employee CONTRACTOR = :contractor @@ -319,24 +291,6 @@ class Type < FinchAPI::Enum # # The detailed employment status of the individual. Available options: `active`, # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - # - # @example - # ```ruby - # case employment_status - # in :active - # # ... - # in :deceased - # # ... - # in :leave - # # ... - # in :onboarding - # # ... - # in :prehire - # # ... - # in ... - # #... - # end - # ``` class EmploymentStatus < FinchAPI::Enum ACTIVE = :active DECEASED = :deceased diff --git a/lib/finch-api/models/hris/individual.rb b/lib/finch-api/models/hris/individual.rb index 1e7f9ec5..6daab665 100644 --- a/lib/finch-api/models/hris/individual.rb +++ b/lib/finch-api/models/hris/individual.rb @@ -150,15 +150,6 @@ class Email < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -175,24 +166,6 @@ class Type < FinchAPI::Enum # @abstract # # The EEOC-defined ethnicity of the individual. - # - # @example - # ```ruby - # case ethnicity - # in :asian - # # ... - # in :white - # # ... - # in :black_or_african_american - # # ... - # in :native_hawaiian_or_pacific_islander - # # ... - # in :american_indian_or_alaska_native - # # ... - # in ... - # #... - # end - # ``` class Ethnicity < FinchAPI::Enum ASIAN = :asian WHITE = :white @@ -214,20 +187,6 @@ class Ethnicity < FinchAPI::Enum # @abstract # # The gender of the individual. - # - # @example - # ```ruby - # case gender - # in :female - # # ... - # in :male - # # ... - # in :other - # # ... - # in :decline_to_specify - # # ... - # end - # ``` class Gender < FinchAPI::Enum FEMALE = :female MALE = :male @@ -263,15 +222,6 @@ class PhoneNumber < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/hris/pay_statement.rb b/lib/finch-api/models/hris/pay_statement.rb index 2bc89ee0..e70d6d90 100644 --- a/lib/finch-api/models/hris/pay_statement.rb +++ b/lib/finch-api/models/hris/pay_statement.rb @@ -194,24 +194,6 @@ class Metadata < FinchAPI::BaseModel # @abstract # # The type of earning. - # - # @example - # ```ruby - # case type - # in :salary - # # ... - # in :wage - # # ... - # in :reimbursement - # # ... - # in :overtime - # # ... - # in :severance - # # ... - # in ... - # #... - # end - # ``` class Type < FinchAPI::Enum SALARY = :salary WAGE = :wage @@ -413,16 +395,6 @@ class Metadata < FinchAPI::BaseModel # @abstract # # The payment method. - # - # @example - # ```ruby - # case payment_method - # in :check - # # ... - # in :direct_deposit - # # ... - # end - # ``` class PaymentMethod < FinchAPI::Enum CHECK = :check DIRECT_DEPOSIT = :direct_deposit @@ -525,20 +497,6 @@ class Metadata < FinchAPI::BaseModel # @abstract # # The type of taxes. - # - # @example - # ```ruby - # case type - # in :state - # # ... - # in :federal - # # ... - # in :local - # # ... - # in :fica - # # ... - # end - # ``` class Type < FinchAPI::Enum STATE = :state FEDERAL = :federal @@ -557,18 +515,6 @@ class Type < FinchAPI::Enum # @abstract # # The type of the payment associated with the pay statement. - # - # @example - # ```ruby - # case type - # in :regular_payroll - # # ... - # in :off_cycle_payroll - # # ... - # in :one_time_payment - # # ... - # end - # ``` class Type < FinchAPI::Enum REGULAR_PAYROLL = :regular_payroll OFF_CYCLE_PAYROLL = :off_cycle_payroll diff --git a/lib/finch-api/models/hris/payment.rb b/lib/finch-api/models/hris/payment.rb index 3e834e23..9a5dd63b 100644 --- a/lib/finch-api/models/hris/payment.rb +++ b/lib/finch-api/models/hris/payment.rb @@ -111,23 +111,6 @@ class Payment < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case pay_frequency - # in :annually - # # ... - # in :semi_annually - # # ... - # in :quarterly - # # ... - # in :monthly - # # ... - # in :semi_monthly - # # ... - # in ... - # #... - # end - # ``` class PayFrequency < FinchAPI::Enum ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually diff --git a/lib/finch-api/models/hris/supported_benefit.rb b/lib/finch-api/models/hris/supported_benefit.rb index c20638c9..64280504 100644 --- a/lib/finch-api/models/hris/supported_benefit.rb +++ b/lib/finch-api/models/hris/supported_benefit.rb @@ -94,15 +94,6 @@ class SupportedBenefit < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case company_contribution - # in :fixed - # # ... - # in :percent - # # ... - # end - # ``` class CompanyContribution < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -117,15 +108,6 @@ class CompanyContribution < FinchAPI::Enum # @abstract # - # @example - # ```ruby - # case employee_deduction - # in :fixed - # # ... - # in :percent - # # ... - # end - # ``` class EmployeeDeduction < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -140,15 +122,6 @@ class EmployeeDeduction < FinchAPI::Enum # @abstract # - # @example - # ```ruby - # case hsa_contribution_limit - # in :individual - # # ... - # in :family - # # ... - # end - # ``` class HsaContributionLimit < FinchAPI::Enum INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/hris/w42005.rb b/lib/finch-api/models/hris/w42005.rb index 616ba232..a98b550a 100644 --- a/lib/finch-api/models/hris/w42005.rb +++ b/lib/finch-api/models/hris/w42005.rb @@ -110,16 +110,6 @@ class Data < FinchAPI::BaseModel # @abstract # # Indicates exemption status from federal tax withholding. - # - # @example - # ```ruby - # case exemption - # in :exempt - # # ... - # in :non_exempt - # # ... - # end - # ``` class Exemption < FinchAPI::Enum EXEMPT = :exempt NON_EXEMPT = :non_exempt @@ -135,18 +125,6 @@ class Exemption < FinchAPI::Enum # @abstract # # The individual's filing status for tax purposes. - # - # @example - # ```ruby - # case filing_status - # in :married - # # ... - # in :married_but_withhold_at_higher_single_rate - # # ... - # in :single - # # ... - # end - # ``` class FilingStatus < FinchAPI::Enum MARRIED = :married MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate @@ -164,14 +142,6 @@ class FilingStatus < FinchAPI::Enum # @abstract # # Specifies the form type, indicating that this document is a 2005 W4 form. - # - # @example - # ```ruby - # case type - # in :w4_2005 - # # ... - # end - # ``` class Type < FinchAPI::Enum W4_2005 = :w4_2005 diff --git a/lib/finch-api/models/hris/w42020.rb b/lib/finch-api/models/hris/w42020.rb index 053888d5..58d2776a 100644 --- a/lib/finch-api/models/hris/w42020.rb +++ b/lib/finch-api/models/hris/w42020.rb @@ -127,18 +127,6 @@ class Data < FinchAPI::BaseModel # @abstract # # The individual's filing status for tax purposes. - # - # @example - # ```ruby - # case filing_status - # in :head_of_household - # # ... - # in :married_filing_jointly_or_qualifying_surviving_spouse - # # ... - # in :single_or_married_filing_separately - # # ... - # end - # ``` class FilingStatus < FinchAPI::Enum HEAD_OF_HOUSEHOLD = :head_of_household MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = :married_filing_jointly_or_qualifying_surviving_spouse @@ -156,14 +144,6 @@ class FilingStatus < FinchAPI::Enum # @abstract # # Specifies the form type, indicating that this document is a 2020 W4 form. - # - # @example - # ```ruby - # case type - # in :w4_2020 - # # ... - # end - # ``` class Type < FinchAPI::Enum W4_2020 = :w4_2020 diff --git a/lib/finch-api/models/income.rb b/lib/finch-api/models/income.rb index 06851161..77706f42 100644 --- a/lib/finch-api/models/income.rb +++ b/lib/finch-api/models/income.rb @@ -46,24 +46,6 @@ class Income < FinchAPI::BaseModel # # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. - # - # @example - # ```ruby - # case unit - # in :yearly - # # ... - # in :quarterly - # # ... - # in :monthly - # # ... - # in :semi_monthly - # # ... - # in :bi_weekly - # # ... - # in ... - # #... - # end - # ``` class Unit < FinchAPI::Enum YEARLY = :yearly QUARTERLY = :quarterly diff --git a/lib/finch-api/models/individual_event.rb b/lib/finch-api/models/individual_event.rb index 818affba..2ded3587 100644 --- a/lib/finch-api/models/individual_event.rb +++ b/lib/finch-api/models/individual_event.rb @@ -50,17 +50,6 @@ class Data < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case event_type - # in :"individual.created" - # # ... - # in :"individual.updated" - # # ... - # in :"individual.deleted" - # # ... - # end - # ``` class EventType < FinchAPI::Enum INDIVIDUAL_CREATED = :"individual.created" INDIVIDUAL_UPDATED = :"individual.updated" diff --git a/lib/finch-api/models/introspection.rb b/lib/finch-api/models/introspection.rb index 9d7db423..5af1d4a7 100644 --- a/lib/finch-api/models/introspection.rb +++ b/lib/finch-api/models/introspection.rb @@ -222,22 +222,6 @@ class ConnectionStatus < FinchAPI::BaseModel # @abstract # # The type of authentication method. - # - # @example - # ```ruby - # case type - # in :assisted - # # ... - # in :credential - # # ... - # in :api_token - # # ... - # in :api_credential - # # ... - # in :oauth - # # ... - # end - # ``` class Type < FinchAPI::Enum ASSISTED = :assisted CREDENTIAL = :credential @@ -257,18 +241,6 @@ class Type < FinchAPI::Enum # @abstract # # The type of application associated with a token. - # - # @example - # ```ruby - # case client_type - # in :production - # # ... - # in :development - # # ... - # in :sandbox - # # ... - # end - # ``` class ClientType < FinchAPI::Enum PRODUCTION = :production DEVELOPMENT = :development @@ -316,16 +288,6 @@ class ConnectionStatus < FinchAPI::BaseModel # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - # - # @example - # ```ruby - # case connection_type - # in :provider - # # ... - # in :finch - # # ... - # end - # ``` class ConnectionType < FinchAPI::Enum PROVIDER = :provider FINCH = :finch diff --git a/lib/finch-api/models/job_completion_event.rb b/lib/finch-api/models/job_completion_event.rb index 895cd676..8c7ca1cf 100644 --- a/lib/finch-api/models/job_completion_event.rb +++ b/lib/finch-api/models/job_completion_event.rb @@ -53,23 +53,6 @@ class Data < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case event_type - # in :"job.benefit_create.completed" - # # ... - # in :"job.benefit_enroll.completed" - # # ... - # in :"job.benefit_register.completed" - # # ... - # in :"job.benefit_unenroll.completed" - # # ... - # in :"job.benefit_update.completed" - # # ... - # in ... - # #... - # end - # ``` class EventType < FinchAPI::Enum JOB_BENEFIT_CREATE_COMPLETED = :"job.benefit_create.completed" JOB_BENEFIT_ENROLL_COMPLETED = :"job.benefit_enroll.completed" diff --git a/lib/finch-api/models/jobs/automated_async_job.rb b/lib/finch-api/models/jobs/automated_async_job.rb index 3addbe79..476afc5b 100644 --- a/lib/finch-api/models/jobs/automated_async_job.rb +++ b/lib/finch-api/models/jobs/automated_async_job.rb @@ -99,23 +99,6 @@ class Params < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case status - # in :pending - # # ... - # in :in_progress - # # ... - # in :complete - # # ... - # in :error - # # ... - # in :reauth_error - # # ... - # in ... - # #... - # end - # ``` class Status < FinchAPI::Enum PENDING = :pending IN_PROGRESS = :in_progress @@ -135,16 +118,6 @@ class Status < FinchAPI::Enum # @abstract # # The type of automated job - # - # @example - # ```ruby - # case type - # in :data_sync_all - # # ... - # in :w4_form_employee_sync - # # ... - # end - # ``` class Type < FinchAPI::Enum DATA_SYNC_ALL = :data_sync_all W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync diff --git a/lib/finch-api/models/jobs/automated_create_params.rb b/lib/finch-api/models/jobs/automated_create_params.rb index b4fdf4a1..e075c8e3 100644 --- a/lib/finch-api/models/jobs/automated_create_params.rb +++ b/lib/finch-api/models/jobs/automated_create_params.rb @@ -31,14 +31,6 @@ class AutomatedCreateParams < FinchAPI::BaseModel # @abstract # # The type of job to start. - # - # @example - # ```ruby - # case type - # in :w4_form_employee_sync - # # ... - # end - # ``` class Type < FinchAPI::Enum W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync diff --git a/lib/finch-api/models/jobs/manual_async_job.rb b/lib/finch-api/models/jobs/manual_async_job.rb index f16a6248..26a2989b 100644 --- a/lib/finch-api/models/jobs/manual_async_job.rb +++ b/lib/finch-api/models/jobs/manual_async_job.rb @@ -31,19 +31,6 @@ class ManualAsyncJob < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case status - # in :pending - # # ... - # in :in_progress - # # ... - # in :error - # # ... - # in :complete - # # ... - # end - # ``` class Status < FinchAPI::Enum PENDING = :pending IN_PROGRESS = :in_progress diff --git a/lib/finch-api/models/operation_support.rb b/lib/finch-api/models/operation_support.rb index b886afc8..e14959d9 100644 --- a/lib/finch-api/models/operation_support.rb +++ b/lib/finch-api/models/operation_support.rb @@ -11,20 +11,6 @@ module Models # so Finch cannot support # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch - # - # @example - # ```ruby - # case operation_support - # in :supported - # # ... - # in :not_supported_by_finch - # # ... - # in :not_supported_by_provider - # # ... - # in :client_access_only - # # ... - # end - # ``` class OperationSupport < FinchAPI::Enum SUPPORTED = :supported NOT_SUPPORTED_BY_FINCH = :not_supported_by_finch diff --git a/lib/finch-api/models/pay_statement_event.rb b/lib/finch-api/models/pay_statement_event.rb index a336948a..8aa11014 100644 --- a/lib/finch-api/models/pay_statement_event.rb +++ b/lib/finch-api/models/pay_statement_event.rb @@ -61,17 +61,6 @@ class Data < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case event_type - # in :"pay_statement.created" - # # ... - # in :"pay_statement.updated" - # # ... - # in :"pay_statement.deleted" - # # ... - # end - # ``` class EventType < FinchAPI::Enum PAY_STATEMENT_CREATED = :"pay_statement.created" PAY_STATEMENT_UPDATED = :"pay_statement.updated" diff --git a/lib/finch-api/models/payment_event.rb b/lib/finch-api/models/payment_event.rb index 8a976da6..19077f72 100644 --- a/lib/finch-api/models/payment_event.rb +++ b/lib/finch-api/models/payment_event.rb @@ -53,17 +53,6 @@ class Data < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case event_type - # in :"payment.created" - # # ... - # in :"payment.updated" - # # ... - # in :"payment.deleted" - # # ... - # end - # ``` class EventType < FinchAPI::Enum PAYMENT_CREATED = :"payment.created" PAYMENT_UPDATED = :"payment.updated" diff --git a/lib/finch-api/models/payroll/pay_group_list_response.rb b/lib/finch-api/models/payroll/pay_group_list_response.rb index 524a6aae..2d045bd3 100644 --- a/lib/finch-api/models/payroll/pay_group_list_response.rb +++ b/lib/finch-api/models/payroll/pay_group_list_response.rb @@ -46,23 +46,6 @@ class PayGroupListResponse < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case pay_frequency - # in :annually - # # ... - # in :semi_annually - # # ... - # in :quarterly - # # ... - # in :monthly - # # ... - # in :semi_monthly - # # ... - # in ... - # #... - # end - # ``` class PayFrequency < FinchAPI::Enum ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually diff --git a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb index 7220ce13..6a2b8d53 100644 --- a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +++ b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb @@ -40,23 +40,6 @@ class PayGroupRetrieveResponse < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case pay_frequency - # in :annually - # # ... - # in :semi_annually - # # ... - # in :quarterly - # # ... - # in :monthly - # # ... - # in :semi_monthly - # # ... - # in ... - # #... - # end - # ``` class PayFrequency < FinchAPI::Enum ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually diff --git a/lib/finch-api/models/provider.rb b/lib/finch-api/models/provider.rb index b246e22d..1a115409 100644 --- a/lib/finch-api/models/provider.rb +++ b/lib/finch-api/models/provider.rb @@ -2003,22 +2003,6 @@ class PayPeriod < FinchAPI::BaseModel # @abstract # # The type of authentication method. - # - # @example - # ```ruby - # case type - # in :assisted - # # ... - # in :credential - # # ... - # in :api_token - # # ... - # in :api_credential - # # ... - # in :oauth - # # ... - # end - # ``` class Type < FinchAPI::Enum ASSISTED = :assisted CREDENTIAL = :credential diff --git a/lib/finch-api/models/sandbox/company_update_params.rb b/lib/finch-api/models/sandbox/company_update_params.rb index 3307ee2f..ae3b1ba1 100644 --- a/lib/finch-api/models/sandbox/company_update_params.rb +++ b/lib/finch-api/models/sandbox/company_update_params.rb @@ -135,16 +135,6 @@ class Account < FinchAPI::BaseModel # @abstract # # The type of bank account. - # - # @example - # ```ruby - # case account_type - # in :checking - # # ... - # in :savings - # # ... - # end - # ``` class AccountType < FinchAPI::Enum CHECKING = :checking SAVINGS = :savings @@ -225,18 +215,6 @@ class Entity < FinchAPI::BaseModel # @abstract # # The tax payer subtype of the company. - # - # @example - # ```ruby - # case subtype - # in :s_corporation - # # ... - # in :c_corporation - # # ... - # in :b_corporation - # # ... - # end - # ``` class Subtype < FinchAPI::Enum S_CORPORATION = :s_corporation C_CORPORATION = :c_corporation @@ -253,24 +231,6 @@ class Subtype < FinchAPI::Enum # @abstract # # The tax payer type of the company. - # - # @example - # ```ruby - # case type - # in :llc - # # ... - # in :lp - # # ... - # in :corporation - # # ... - # in :sole_proprietor - # # ... - # in :non_profit - # # ... - # in ... - # #... - # end - # ``` class Type < FinchAPI::Enum LLC = :llc LP = :lp diff --git a/lib/finch-api/models/sandbox/company_update_response.rb b/lib/finch-api/models/sandbox/company_update_response.rb index e5799b21..65bd508a 100644 --- a/lib/finch-api/models/sandbox/company_update_response.rb +++ b/lib/finch-api/models/sandbox/company_update_response.rb @@ -117,16 +117,6 @@ class Account < FinchAPI::BaseModel # @abstract # # The type of bank account. - # - # @example - # ```ruby - # case account_type - # in :checking - # # ... - # in :savings - # # ... - # end - # ``` class AccountType < FinchAPI::Enum CHECKING = :checking SAVINGS = :savings @@ -207,18 +197,6 @@ class Entity < FinchAPI::BaseModel # @abstract # # The tax payer subtype of the company. - # - # @example - # ```ruby - # case subtype - # in :s_corporation - # # ... - # in :c_corporation - # # ... - # in :b_corporation - # # ... - # end - # ``` class Subtype < FinchAPI::Enum S_CORPORATION = :s_corporation C_CORPORATION = :c_corporation @@ -235,24 +213,6 @@ class Subtype < FinchAPI::Enum # @abstract # # The tax payer type of the company. - # - # @example - # ```ruby - # case type - # in :llc - # # ... - # in :lp - # # ... - # in :corporation - # # ... - # in :sole_proprietor - # # ... - # in :non_profit - # # ... - # in ... - # #... - # end - # ``` class Type < FinchAPI::Enum LLC = :llc LP = :lp diff --git a/lib/finch-api/models/sandbox/connection_create_params.rb b/lib/finch-api/models/sandbox/connection_create_params.rb index 3ab58352..d716b7b7 100644 --- a/lib/finch-api/models/sandbox/connection_create_params.rb +++ b/lib/finch-api/models/sandbox/connection_create_params.rb @@ -58,19 +58,6 @@ class ConnectionCreateParams < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case authentication_type - # in :credential - # # ... - # in :api_token - # # ... - # in :oauth - # # ... - # in :assisted - # # ... - # end - # ``` class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connection_create_response.rb b/lib/finch-api/models/sandbox/connection_create_response.rb index 97ec669f..f3317630 100644 --- a/lib/finch-api/models/sandbox/connection_create_response.rb +++ b/lib/finch-api/models/sandbox/connection_create_response.rb @@ -81,19 +81,6 @@ class ConnectionCreateResponse < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case authentication_type - # in :credential - # # ... - # in :api_token - # # ... - # in :oauth - # # ... - # in :assisted - # # ... - # end - # ``` class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connections/account_create_params.rb b/lib/finch-api/models/sandbox/connections/account_create_params.rb index 4ab7c58b..1046f8ed 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_params.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_params.rb @@ -54,19 +54,6 @@ class AccountCreateParams < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case authentication_type - # in :credential - # # ... - # in :api_token - # # ... - # in :oauth - # # ... - # in :assisted - # # ... - # end - # ``` class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connections/account_create_response.rb b/lib/finch-api/models/sandbox/connections/account_create_response.rb index 5914f541..6045d5eb 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_response.rb @@ -60,19 +60,6 @@ class AccountCreateResponse < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case authentication_type - # in :credential - # # ... - # in :api_token - # # ... - # in :oauth - # # ... - # in :assisted - # # ... - # end - # ``` class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connections/account_update_response.rb b/lib/finch-api/models/sandbox/connections/account_update_response.rb index 148377e3..8215a82d 100644 --- a/lib/finch-api/models/sandbox/connections/account_update_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_update_response.rb @@ -58,19 +58,6 @@ class AccountUpdateResponse < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case authentication_type - # in :credential - # # ... - # in :api_token - # # ... - # in :oauth - # # ... - # in :assisted - # # ... - # end - # ``` class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/directory_create_params.rb b/lib/finch-api/models/sandbox/directory_create_params.rb index b9e88d1d..e22837b7 100644 --- a/lib/finch-api/models/sandbox/directory_create_params.rb +++ b/lib/finch-api/models/sandbox/directory_create_params.rb @@ -344,15 +344,6 @@ class Email < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -398,24 +389,6 @@ class Employment < FinchAPI::BaseModel # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - # - # @example - # ```ruby - # case subtype - # in :full_time - # # ... - # in :intern - # # ... - # in :part_time - # # ... - # in :temp - # # ... - # in :seasonal - # # ... - # in ... - # #... - # end - # ``` class Subtype < FinchAPI::Enum FULL_TIME = :full_time INTERN = :intern @@ -435,16 +408,6 @@ class Subtype < FinchAPI::Enum # @abstract # # The main employment type of the individual. - # - # @example - # ```ruby - # case type - # in :employee - # # ... - # in :contractor - # # ... - # end - # ``` class Type < FinchAPI::Enum EMPLOYEE = :employee CONTRACTOR = :contractor @@ -461,24 +424,6 @@ class Type < FinchAPI::Enum # @abstract # # The detailed employment status of the individual. - # - # @example - # ```ruby - # case employment_status - # in :active - # # ... - # in :deceased - # # ... - # in :leave - # # ... - # in :onboarding - # # ... - # in :prehire - # # ... - # in ... - # #... - # end - # ``` class EmploymentStatus < FinchAPI::Enum ACTIVE = :active DECEASED = :deceased @@ -499,24 +444,6 @@ class EmploymentStatus < FinchAPI::Enum # @abstract # # The EEOC-defined ethnicity of the individual. - # - # @example - # ```ruby - # case ethnicity - # in :asian - # # ... - # in :white - # # ... - # in :black_or_african_american - # # ... - # in :native_hawaiian_or_pacific_islander - # # ... - # in :american_indian_or_alaska_native - # # ... - # in ... - # #... - # end - # ``` class Ethnicity < FinchAPI::Enum ASIAN = :asian WHITE = :white @@ -538,20 +465,6 @@ class Ethnicity < FinchAPI::Enum # @abstract # # The gender of the individual. - # - # @example - # ```ruby - # case gender - # in :female - # # ... - # in :male - # # ... - # in :other - # # ... - # in :decline_to_specify - # # ... - # end - # ``` class Gender < FinchAPI::Enum FEMALE = :female MALE = :male @@ -614,15 +527,6 @@ class PhoneNumber < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/employment_update_params.rb b/lib/finch-api/models/sandbox/employment_update_params.rb index b1c95cff..96dd750c 100644 --- a/lib/finch-api/models/sandbox/employment_update_params.rb +++ b/lib/finch-api/models/sandbox/employment_update_params.rb @@ -248,24 +248,6 @@ class Employment < FinchAPI::BaseModel # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - # - # @example - # ```ruby - # case subtype - # in :full_time - # # ... - # in :intern - # # ... - # in :part_time - # # ... - # in :temp - # # ... - # in :seasonal - # # ... - # in ... - # #... - # end - # ``` class Subtype < FinchAPI::Enum FULL_TIME = :full_time INTERN = :intern @@ -285,16 +267,6 @@ class Subtype < FinchAPI::Enum # @abstract # # The main employment type of the individual. - # - # @example - # ```ruby - # case type - # in :employee - # # ... - # in :contractor - # # ... - # end - # ``` class Type < FinchAPI::Enum EMPLOYEE = :employee CONTRACTOR = :contractor @@ -311,24 +283,6 @@ class Type < FinchAPI::Enum # @abstract # # The detailed employment status of the individual. - # - # @example - # ```ruby - # case employment_status - # in :active - # # ... - # in :deceased - # # ... - # in :leave - # # ... - # in :onboarding - # # ... - # in :prehire - # # ... - # in ... - # #... - # end - # ``` class EmploymentStatus < FinchAPI::Enum ACTIVE = :active DECEASED = :deceased diff --git a/lib/finch-api/models/sandbox/employment_update_response.rb b/lib/finch-api/models/sandbox/employment_update_response.rb index dcd77e86..397d8faa 100644 --- a/lib/finch-api/models/sandbox/employment_update_response.rb +++ b/lib/finch-api/models/sandbox/employment_update_response.rb @@ -254,24 +254,6 @@ class Employment < FinchAPI::BaseModel # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - # - # @example - # ```ruby - # case subtype - # in :full_time - # # ... - # in :intern - # # ... - # in :part_time - # # ... - # in :temp - # # ... - # in :seasonal - # # ... - # in ... - # #... - # end - # ``` class Subtype < FinchAPI::Enum FULL_TIME = :full_time INTERN = :intern @@ -291,16 +273,6 @@ class Subtype < FinchAPI::Enum # @abstract # # The main employment type of the individual. - # - # @example - # ```ruby - # case type - # in :employee - # # ... - # in :contractor - # # ... - # end - # ``` class Type < FinchAPI::Enum EMPLOYEE = :employee CONTRACTOR = :contractor @@ -317,24 +289,6 @@ class Type < FinchAPI::Enum # @abstract # # The detailed employment status of the individual. - # - # @example - # ```ruby - # case employment_status - # in :active - # # ... - # in :deceased - # # ... - # in :leave - # # ... - # in :onboarding - # # ... - # in :prehire - # # ... - # in ... - # #... - # end - # ``` class EmploymentStatus < FinchAPI::Enum ACTIVE = :active DECEASED = :deceased diff --git a/lib/finch-api/models/sandbox/individual_update_params.rb b/lib/finch-api/models/sandbox/individual_update_params.rb index 9ebf2475..4f96e9e8 100644 --- a/lib/finch-api/models/sandbox/individual_update_params.rb +++ b/lib/finch-api/models/sandbox/individual_update_params.rb @@ -146,15 +146,6 @@ class Email < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -171,24 +162,6 @@ class Type < FinchAPI::Enum # @abstract # # The EEOC-defined ethnicity of the individual. - # - # @example - # ```ruby - # case ethnicity - # in :asian - # # ... - # in :white - # # ... - # in :black_or_african_american - # # ... - # in :native_hawaiian_or_pacific_islander - # # ... - # in :american_indian_or_alaska_native - # # ... - # in ... - # #... - # end - # ``` class Ethnicity < FinchAPI::Enum ASIAN = :asian WHITE = :white @@ -210,20 +183,6 @@ class Ethnicity < FinchAPI::Enum # @abstract # # The gender of the individual. - # - # @example - # ```ruby - # case gender - # in :female - # # ... - # in :male - # # ... - # in :other - # # ... - # in :decline_to_specify - # # ... - # end - # ``` class Gender < FinchAPI::Enum FEMALE = :female MALE = :male @@ -265,15 +224,6 @@ class PhoneNumber < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/individual_update_response.rb b/lib/finch-api/models/sandbox/individual_update_response.rb index 10b86276..edb9f45d 100644 --- a/lib/finch-api/models/sandbox/individual_update_response.rb +++ b/lib/finch-api/models/sandbox/individual_update_response.rb @@ -154,15 +154,6 @@ class Email < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -179,24 +170,6 @@ class Type < FinchAPI::Enum # @abstract # # The EEOC-defined ethnicity of the individual. - # - # @example - # ```ruby - # case ethnicity - # in :asian - # # ... - # in :white - # # ... - # in :black_or_african_american - # # ... - # in :native_hawaiian_or_pacific_islander - # # ... - # in :american_indian_or_alaska_native - # # ... - # in ... - # #... - # end - # ``` class Ethnicity < FinchAPI::Enum ASIAN = :asian WHITE = :white @@ -218,20 +191,6 @@ class Ethnicity < FinchAPI::Enum # @abstract # # The gender of the individual. - # - # @example - # ```ruby - # case gender - # in :female - # # ... - # in :male - # # ... - # in :other - # # ... - # in :decline_to_specify - # # ... - # end - # ``` class Gender < FinchAPI::Enum FEMALE = :female MALE = :male @@ -273,15 +232,6 @@ class PhoneNumber < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case type - # in :work - # # ... - # in :personal - # # ... - # end - # ``` class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/job_create_params.rb b/lib/finch-api/models/sandbox/job_create_params.rb index 1d6b7205..33ee8ba1 100644 --- a/lib/finch-api/models/sandbox/job_create_params.rb +++ b/lib/finch-api/models/sandbox/job_create_params.rb @@ -25,14 +25,6 @@ class JobCreateParams < FinchAPI::BaseModel # @abstract # # The type of job to start. Currently the only supported type is `data_sync_all` - # - # @example - # ```ruby - # case type - # in :data_sync_all - # # ... - # end - # ``` class Type < FinchAPI::Enum DATA_SYNC_ALL = :data_sync_all diff --git a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb index 74375558..090179ca 100644 --- a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +++ b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb @@ -26,19 +26,6 @@ class SandboxJobConfiguration < FinchAPI::BaseModel # @abstract # - # @example - # ```ruby - # case completion_status - # in :complete - # # ... - # in :reauth_error - # # ... - # in :permissions_error - # # ... - # in :error - # # ... - # end - # ``` class CompletionStatus < FinchAPI::Enum COMPLETE = :complete REAUTH_ERROR = :reauth_error @@ -55,13 +42,6 @@ class CompletionStatus < FinchAPI::Enum # @abstract # - # @example - # ```ruby - # case type - # in :data_sync_all - # # ... - # end - # ``` class Type < FinchAPI::Enum DATA_SYNC_ALL = :data_sync_all diff --git a/lib/finch-api/models/sandbox/payment_create_params.rb b/lib/finch-api/models/sandbox/payment_create_params.rb index df02a216..551313b0 100644 --- a/lib/finch-api/models/sandbox/payment_create_params.rb +++ b/lib/finch-api/models/sandbox/payment_create_params.rb @@ -246,24 +246,6 @@ class Metadata < FinchAPI::BaseModel # @abstract # # The type of earning. - # - # @example - # ```ruby - # case type - # in :salary - # # ... - # in :wage - # # ... - # in :reimbursement - # # ... - # in :overtime - # # ... - # in :severance - # # ... - # in ... - # #... - # end - # ``` class Type < FinchAPI::Enum SALARY = :salary WAGE = :wage @@ -466,16 +448,6 @@ class Metadata < FinchAPI::BaseModel # @abstract # # The payment method. - # - # @example - # ```ruby - # case payment_method - # in :check - # # ... - # in :direct_deposit - # # ... - # end - # ``` class PaymentMethod < FinchAPI::Enum CHECK = :check DIRECT_DEPOSIT = :direct_deposit @@ -583,20 +555,6 @@ class Metadata < FinchAPI::BaseModel # @abstract # # The type of taxes. - # - # @example - # ```ruby - # case type - # in :state - # # ... - # in :federal - # # ... - # in :local - # # ... - # in :fica - # # ... - # end - # ``` class Type < FinchAPI::Enum STATE = :state FEDERAL = :federal @@ -615,18 +573,6 @@ class Type < FinchAPI::Enum # @abstract # # The type of the payment associated with the pay statement. - # - # @example - # ```ruby - # case type - # in :regular_payroll - # # ... - # in :off_cycle_payroll - # # ... - # in :one_time_payment - # # ... - # end - # ``` class Type < FinchAPI::Enum REGULAR_PAYROLL = :regular_payroll OFF_CYCLE_PAYROLL = :off_cycle_payroll diff --git a/lib/finch-api/models/webhook_event.rb b/lib/finch-api/models/webhook_event.rb index 3b4914ad..c06178d2 100644 --- a/lib/finch-api/models/webhook_event.rb +++ b/lib/finch-api/models/webhook_event.rb @@ -4,27 +4,6 @@ module FinchAPI module Models # @abstract # - # @example - # ```ruby - # case webhook_event - # in FinchAPI::Models::AccountUpdateEvent - # # ... - # in FinchAPI::Models::JobCompletionEvent - # # ... - # in FinchAPI::Models::CompanyEvent - # # ... - # in FinchAPI::Models::DirectoryEvent - # # ... - # in FinchAPI::Models::EmploymentEvent - # # ... - # in FinchAPI::Models::IndividualEvent - # # ... - # in FinchAPI::Models::PaymentEvent - # # ... - # in FinchAPI::Models::PayStatementEvent - # # ... - # end - # ``` class WebhookEvent < FinchAPI::Union discriminator :event_type diff --git a/test/finch-api/resources/hris/documents_test.rb b/test/finch-api/resources/hris/documents_test.rb index c76aade7..7232d55c 100644 --- a/test/finch-api/resources/hris/documents_test.rb +++ b/test/finch-api/resources/hris/documents_test.rb @@ -24,5 +24,19 @@ def test_retreive assert_pattern do response => FinchAPI::Models::HRIS::DocumentRetreiveResponse end + + assert_pattern do + case response + in FinchAPI::Models::HRIS::W42020 + in FinchAPI::Models::HRIS::W42005 + end + end + + assert_pattern do + case response + in {type: :w4_2020, data: FinchAPI::Models::HRIS::W42020::Data | nil, year: Float | nil} + in {type: :w4_2005, data: FinchAPI::Models::HRIS::W42005::Data | nil, year: Float | nil} + end + end end end From 74f6a630c57dfbc065fe3dccc20d2a0912241e58 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 6 Mar 2025 22:44:34 +0000 Subject: [PATCH 08/67] feat: add jsonl support (#10) --- lib/finch-api/util.rb | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 4cf22db3..a48723ed 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -496,10 +496,7 @@ def encode_content(headers, body) # def decode_content(headers, stream:, suppress_error: false) case headers["content-type"] - in %r{^text/event-stream} - lines = enum_lines(stream) - parse_sse(lines) - in %r{^application/json} + in %r{^application/(?:vnd\.api\+)?json} json = stream.to_a.join begin JSON.parse(json, symbolize_names: true) @@ -507,6 +504,11 @@ def decode_content(headers, stream:, suppress_error: false) raise e unless suppress_error json end + in %r{^text/event-stream} + lines = enum_lines(stream) + parse_sse(lines) + in %r{^application/(?:x-)?jsonl} + enum_lines(stream) in %r{^text/} stream.to_a.join else @@ -615,7 +617,7 @@ def parse_sse(lines) in "event" current.merge!(event: value) in "data" - (current[:data] ||= String.new) << value << "\n" + (current[:data] ||= String.new) << (value << "\n") in "id" unless value.include?("\0") current.merge!(id: value) in "retry" if /^\d+$/ =~ value From 4eb4cc36954eeb5fb39beee0d335d573cddd11b6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 7 Mar 2025 00:02:27 +0000 Subject: [PATCH 09/67] chore: support different EOLs in streaming (#11) --- lib/finch-api/util.rb | 30 ++++++++++++++++++------- rbi/lib/finch-api/util.rbi | 4 ++-- sig/finch-api/util.rbs | 4 ++-- test/finch-api/util_test.rb | 45 ++++++++++++++++++++++++++++++------- 4 files changed, 63 insertions(+), 20 deletions(-) diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index a48723ed..fab02e58 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -577,15 +577,29 @@ class << self # # @return [Enumerable] # - def enum_lines(enum) + def decode_lines(enum) + re = /(\r\n|\r|\n)/ + buffer = String.new.b + cr_seen = nil + chain_fused(enum) do |y| - buffer = String.new enum.each do |row| buffer << row - while (idx = buffer.index("\n")) - y << buffer.slice!(..idx) + while (match = re.match(buffer, cr_seen.to_i)) + case [match.captures.first, cr_seen] + in ["\r", nil] + cr_seen = match.end(1) + next + in ["\r" | "\r\n", Integer] + y << buffer.slice!(..(cr_seen.pred)) + else + y << buffer.slice!(..(match.end(1).pred)) + end + cr_seen = nil end end + + y << buffer.slice!(..(cr_seen.pred)) unless cr_seen.nil? y << buffer unless buffer.empty? end end @@ -598,13 +612,13 @@ def enum_lines(enum) # # @return [Hash{Symbol=>Object}] # - def parse_sse(lines) + def decode_sse(lines) chain_fused(lines) do |y| blank = {event: nil, data: nil, id: nil, retry: nil} current = {} lines.each do |line| - case line.strip + case line.sub(/\R$/, "") in "" next if current.empty? y << {**blank, **current} @@ -612,12 +626,12 @@ def parse_sse(lines) in /^:/ next in /^([^:]+):\s?(.*)$/ - _, field, value = Regexp.last_match.to_a + field, value = Regexp.last_match.captures case field in "event" current.merge!(event: value) in "data" - (current[:data] ||= String.new) << (value << "\n") + (current[:data] ||= String.new.b) << value << "\n" in "id" unless value.include?("\0") current.merge!(id: value) in "retry" if /^\d+$/ =~ value diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index ccc5b64c..8eaae982 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -157,11 +157,11 @@ module FinchAPI end sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) } - def self.enum_lines(enum) + def self.decode_lines(enum) end sig { params(lines: T::Enumerable[String]).returns(FinchAPI::Util::SSEMessage) } - def self.parse_sse(lines) + def self.decode_sse(lines) end end end diff --git a/sig/finch-api/util.rbs b/sig/finch-api/util.rbs index 0b823e57..a658eeda 100644 --- a/sig/finch-api/util.rbs +++ b/sig/finch-api/util.rbs @@ -100,9 +100,9 @@ module FinchAPI type sse_message = { event: String?, data: String?, id: String?, retry: Integer? } - def self?.enum_lines: (Enumerable[String] enum) -> Enumerable[String] + def self?.decode_lines: (Enumerable[String] enum) -> Enumerable[String] - def self?.parse_sse: ( + def self?.decode_sse: ( Enumerable[String] lines ) -> FinchAPI::Util::sse_message end diff --git a/test/finch-api/util_test.rb b/test/finch-api/util_test.rb index 24d9972d..f555604e 100644 --- a/test/finch-api/util_test.rb +++ b/test/finch-api/util_test.rb @@ -320,8 +320,8 @@ def test_close_fused_sse_chain .map(&:to_s) fused_1 = FinchAPI::Util.fused_enum(enum) - fused_2 = FinchAPI::Util.enum_lines(fused_1) - fused_3 = FinchAPI::Util.parse_sse(fused_2) + fused_2 = FinchAPI::Util.decode_lines(fused_1) + fused_3 = FinchAPI::Util.decode_sse(fused_2) assert_equal(0, taken) FinchAPI::Util.close_fused!(fused_3) @@ -330,7 +330,7 @@ def test_close_fused_sse_chain end class FinchAPI::Test::UtilSseTest < Minitest::Test - def test_enum_lines + def test_decode_lines cases = { %w[] => %w[], %W[\n\n] => %W[\n \n], @@ -340,15 +340,37 @@ def test_enum_lines %W[a\nb\n] => %W[a\n b\n], %W[\na b\n] => %W[\n ab\n], %W[\na b\n\n] => %W[\n ab\n \n], - %W[\na b] => %W[\n ab] + %W[\na b] => %W[\n ab], + %W[\u1F62E\u200D\u1F4A8] => %W[\u1F62E\u200D\u1F4A8], + %W[\u1F62E \u200D \u1F4A8] => %W[\u1F62E\u200D\u1F4A8] } + eols = %W[\n \r \r\n] cases.each do |enum, expected| - lines = FinchAPI::Util.enum_lines(enum) + eols.each do |eol| + lines = FinchAPI::Util.decode_lines(enum.map { _1.gsub("\n", eol) }) + assert_equal(expected.map { _1.gsub("\n", eol) }, lines.to_a, "eol=#{JSON.generate(eol)}") + end + end + end + + def test_mixed_decode_lines + cases = { + %w[] => %w[], + %W[\r\r] => %W[\r \r], + %W[\r \r] => %W[\r \r], + %W[\r\r\r] => %W[\r \r \r], + %W[\r\r \r] => %W[\r \r \r], + %W[\r \n] => %W[\r\n], + %W[\r\r\n] => %W[\r \r\n], + %W[\n\r] => %W[\n \r] + } + cases.each do |enum, expected| + lines = FinchAPI::Util.decode_lines(enum) assert_equal(expected, lines.to_a) end end - def test_parse_sse + def test_decode_sse cases = { "empty input" => { [] => [] @@ -372,8 +394,8 @@ def test_parse_sse }, "complete event" => { [ - "event: update\n", "id: 123\n", + "event: update\n", "data: hello world\n", "retry: 5000\n", "\n" @@ -454,12 +476,19 @@ def test_parse_sse {data: "first\n"}, {data: "second\n"} ] + }, + "multibyte unicode" => { + [ + "data: \u1F62E\u200D\u1F4A8\n" + ] => [ + {data: "\u1F62E\u200D\u1F4A8\n"} + ] } } cases.each do |name, test_cases| test_cases.each do |input, expected| - actual = FinchAPI::Util.parse_sse(input).map(&:compact) + actual = FinchAPI::Util.decode_sse(input).map(&:compact) assert_equal(expected, actual, name) end end From e093ce41d1d87e0848f49cde7e5eac8e8d11bbe5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 7 Mar 2025 05:53:24 +0000 Subject: [PATCH 10/67] chore: generate better supported rbi signatures (#12) --- lib/finch-api/base_model.rb | 884 +++++++++--------- lib/finch-api/models/account_update_event.rb | 10 - lib/finch-api/models/company_event.rb | 5 - .../models/connect/session_new_params.rb | 15 - .../connect/session_reauthenticate_params.rb | 5 - .../models/connection_status_type.rb | 5 - .../models/create_access_token_response.rb | 10 - lib/finch-api/models/directory_event.rb | 5 - lib/finch-api/models/employment_event.rb | 5 - .../models/hris/benefit_contribution.rb | 5 - .../hris/benefit_features_and_operations.rb | 15 - .../models/hris/benefit_frequency.rb | 5 - lib/finch-api/models/hris/benefit_type.rb | 5 - .../hris/benefits/enrolled_individual.rb | 5 - .../hris/benefits/individual_benefit.rb | 5 - .../benefits/individual_enroll_many_params.rb | 15 - lib/finch-api/models/hris/company.rb | 15 - .../models/hris/document_list_params.rb | 5 - .../models/hris/document_response.rb | 5 - lib/finch-api/models/hris/employment_data.rb | 15 - lib/finch-api/models/hris/individual.rb | 20 - lib/finch-api/models/hris/pay_statement.rb | 20 - lib/finch-api/models/hris/payment.rb | 5 - .../models/hris/supported_benefit.rb | 15 - lib/finch-api/models/hris/w42005.rb | 15 - lib/finch-api/models/hris/w42020.rb | 10 - lib/finch-api/models/income.rb | 5 - lib/finch-api/models/individual_event.rb | 5 - lib/finch-api/models/introspection.rb | 15 - lib/finch-api/models/job_completion_event.rb | 5 - .../models/jobs/automated_async_job.rb | 10 - .../models/jobs/automated_create_params.rb | 5 - lib/finch-api/models/jobs/manual_async_job.rb | 5 - lib/finch-api/models/operation_support.rb | 5 - lib/finch-api/models/pay_statement_event.rb | 5 - lib/finch-api/models/payment_event.rb | 5 - .../models/payroll/pay_group_list_response.rb | 5 - .../payroll/pay_group_retrieve_response.rb | 5 - lib/finch-api/models/provider.rb | 5 - .../models/sandbox/company_update_params.rb | 15 - .../models/sandbox/company_update_response.rb | 15 - .../sandbox/connection_create_params.rb | 5 - .../sandbox/connection_create_response.rb | 5 - .../connections/account_create_params.rb | 5 - .../connections/account_create_response.rb | 5 - .../connections/account_update_response.rb | 5 - .../models/sandbox/directory_create_params.rb | 35 - .../sandbox/employment_update_params.rb | 15 - .../sandbox/employment_update_response.rb | 15 - .../sandbox/individual_update_params.rb | 20 - .../sandbox/individual_update_response.rb | 20 - .../models/sandbox/job_create_params.rb | 5 - .../sandbox/jobs/sandbox_job_configuration.rb | 10 - .../models/sandbox/payment_create_params.rb | 20 - rbi/lib/finch-api/base_client.rbi | 40 +- rbi/lib/finch-api/base_model.rbi | 438 ++++----- .../finch-api/models/account_update_event.rbi | 12 +- rbi/lib/finch-api/models/company_event.rbi | 6 +- .../models/connect/session_new_params.rbi | 18 +- .../connect/session_reauthenticate_params.rbi | 6 +- .../models/connection_status_type.rbi | 6 +- .../models/create_access_token_response.rbi | 12 +- rbi/lib/finch-api/models/directory_event.rbi | 6 +- rbi/lib/finch-api/models/employment_event.rbi | 6 +- .../models/hris/benefit_contribution.rbi | 6 +- .../hris/benefit_features_and_operations.rbi | 18 +- .../models/hris/benefit_frequency.rbi | 6 +- .../finch-api/models/hris/benefit_type.rbi | 6 +- .../hris/benefits/enrolled_individual.rbi | 6 +- .../hris/benefits/individual_benefit.rbi | 6 +- .../individual_enroll_many_params.rbi | 18 +- rbi/lib/finch-api/models/hris/company.rbi | 18 +- .../models/hris/document_list_params.rbi | 6 +- .../models/hris/document_response.rbi | 6 +- .../hris/document_retreive_response.rbi | 6 +- .../finch-api/models/hris/employment_data.rbi | 18 +- rbi/lib/finch-api/models/hris/individual.rbi | 24 +- .../finch-api/models/hris/pay_statement.rbi | 24 +- rbi/lib/finch-api/models/hris/payment.rbi | 6 +- .../models/hris/supported_benefit.rbi | 18 +- rbi/lib/finch-api/models/hris/w42005.rbi | 18 +- rbi/lib/finch-api/models/hris/w42020.rbi | 12 +- rbi/lib/finch-api/models/income.rbi | 6 +- rbi/lib/finch-api/models/individual_event.rbi | 6 +- rbi/lib/finch-api/models/introspection.rbi | 18 +- .../finch-api/models/job_completion_event.rbi | 6 +- .../models/jobs/automated_async_job.rbi | 12 +- .../models/jobs/automated_create_params.rbi | 6 +- .../models/jobs/manual_async_job.rbi | 6 +- .../finch-api/models/operation_support.rbi | 6 +- .../finch-api/models/pay_statement_event.rbi | 6 +- rbi/lib/finch-api/models/payment_event.rbi | 6 +- .../payroll/pay_group_list_response.rbi | 6 +- .../payroll/pay_group_retrieve_response.rbi | 6 +- rbi/lib/finch-api/models/provider.rbi | 6 +- .../models/sandbox/company_update_params.rbi | 18 +- .../sandbox/company_update_response.rbi | 18 +- .../sandbox/connection_create_params.rbi | 6 +- .../sandbox/connection_create_response.rbi | 6 +- .../connections/account_create_params.rbi | 6 +- .../connections/account_create_response.rbi | 6 +- .../connections/account_update_response.rbi | 6 +- .../sandbox/directory_create_params.rbi | 42 +- .../sandbox/employment_update_params.rbi | 18 +- .../sandbox/employment_update_response.rbi | 18 +- .../sandbox/individual_update_params.rbi | 24 +- .../sandbox/individual_update_response.rbi | 24 +- .../models/sandbox/job_create_params.rbi | 6 +- .../jobs/sandbox_job_configuration.rbi | 12 +- .../models/sandbox/payment_create_params.rbi | 24 +- rbi/lib/finch-api/models/webhook_event.rbi | 16 +- rbi/lib/finch-api/pooled_net_requester.rbi | 18 +- rbi/lib/finch-api/util.rbi | 270 +++--- 113 files changed, 1276 insertions(+), 1529 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index ef040e4a..0aa5ed46 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -192,33 +192,35 @@ def self.===(other) = true # def self.==(other) = other.is_a?(Class) && other <= FinchAPI::Unknown - # @!parse - # # @private - # # - # # @param value [Object] - # # - # # @return [Object] - # # - # def self.coerce(value) = super - - # @!parse - # # @private - # # - # # @param value [Object] - # # - # # @return [Object] - # # - # def self.dump(value) = super + class << self + # @!parse + # # @private + # # + # # @param value [Object] + # # + # # @return [Object] + # # + # def coerce(value) = super + + # @!parse + # # @private + # # + # # @param value [Object] + # # + # # @return [Object] + # # + # def dump(value) = super - # @private - # - # @param value [Object] - # - # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # - def self.try_strict_coerce(value) - # prevent unknown variant from being chosen during the first coercion pass - [false, true, 0] + # @private + # + # @param value [Object] + # + # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] + # + def try_strict_coerce(value) + # prevent unknown variant from being chosen during the first coercion pass + [false, true, 0] + end end # rubocop:enable Lint/UnusedMethodArgument @@ -246,36 +248,38 @@ def self.===(other) = other == true || other == false # def self.==(other) = other.is_a?(Class) && other <= FinchAPI::BooleanModel - # @!parse - # # @private - # # - # # @param value [Boolean, Object] - # # - # # @return [Boolean, Object] - # # - # def self.coerce(value) = super - - # @!parse - # # @private - # # - # # @param value [Boolean, Object] - # # - # # @return [Boolean, Object] - # # - # def self.dump(value) = super + class << self + # @!parse + # # @private + # # + # # @param value [Boolean, Object] + # # + # # @return [Boolean, Object] + # # + # def coerce(value) = super + + # @!parse + # # @private + # # + # # @param value [Boolean, Object] + # # + # # @return [Boolean, Object] + # # + # def dump(value) = super - # @private - # - # @param value [Object] - # - # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # - def self.try_strict_coerce(value) - case value - in true | false - [true, value, 1] - else - [false, false, 0] + # @private + # + # @param value [Object] + # + # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] + # + def try_strict_coerce(value) + case value + in true | false + [true, value, 1] + else + [false, false, 0] + end end end end @@ -326,17 +330,19 @@ def self.try_strict_coerce(value) class Enum extend FinchAPI::Converter - # All of the valid Symbol values for this enum. - # - # @return [Array] - # - def self.values = (@values ||= constants.map { const_get(_1) }) + class << self + # All of the valid Symbol values for this enum. + # + # @return [Array] + # + def values = (@values ||= constants.map { const_get(_1) }) - # @private - # - # Guard against thread safety issues by instantiating `@values`. - # - private_class_method def self.finalize! = values + # @private + # + # Guard against thread safety issues by instantiating `@values`. + # + private def finalize! = values + end private_class_method :new @@ -354,41 +360,43 @@ def self.==(other) other.is_a?(Class) && other <= FinchAPI::Enum && other.values.to_set == values.to_set end - # @private - # - # @param value [String, Symbol, Object] - # - # @return [Symbol, Object] - # - def self.coerce(value) = (value.is_a?(String) ? value.to_sym : value) + class << self + # @private + # + # @param value [String, Symbol, Object] + # + # @return [Symbol, Object] + # + def coerce(value) = (value.is_a?(String) ? value.to_sym : value) - # @!parse - # # @private - # # - # # @param value [Symbol, Object] - # # - # # @return [Symbol, Object] - # # - # def self.dump(value) = super + # @!parse + # # @private + # # + # # @param value [Symbol, Object] + # # + # # @return [Symbol, Object] + # # + # def dump(value) = super - # @private - # - # @param value [Object] - # - # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # - def self.try_strict_coerce(value) - return [true, value, 1] if values.include?(value) + # @private + # + # @param value [Object] + # + # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] + # + def try_strict_coerce(value) + return [true, value, 1] if values.include?(value) - case value - in String if values.include?(val = value.to_sym) - [true, val, 1] - else - case [value, values.first] - in [true | false, true | false] | [Integer, Integer] | [Symbol | String, Symbol] - [false, true, 0] + case value + in String if values.include?(val = value.to_sym) + [true, val, 1] else - [false, false, 0] + case [value, values.first] + in [true | false, true | false] | [Integer, Integer] | [Symbol | String, Symbol] + [false, true, 0] + else + [false, false, 0] + end end end end @@ -425,15 +433,15 @@ def self.try_strict_coerce(value) class Union extend FinchAPI::Converter - # @private - # - # All of the specified variant info for this union. - # - # @return [Array] - # - private_class_method def self.known_variants = (@known_variants ||= []) - class << self + # @private + # + # All of the specified variant info for this union. + # + # @return [Array] + # + private def known_variants = (@known_variants ||= []) + # @private # # All of the specified variants for this union. @@ -443,68 +451,68 @@ class << self protected def variants @known_variants.map { |key, variant_fn| [key, variant_fn.call] } end - end - # @private - # - # @param property [Symbol] - # - private_class_method def self.discriminator(property) - case property - in Symbol - @discriminator = property - end - end - - # @private - # - # @param key [Symbol, Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] - # - # @param spec [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] . - # - # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const - # - # @option spec [Proc] :enum - # - # @option spec [Proc] :union - # - # @option spec [Boolean] :"nil?" - # - private_class_method def self.variant(key, spec = nil) - variant_info = - case key + # @private + # + # @param property [Symbol] + # + private def discriminator(property) + case property in Symbol - [key, FinchAPI::Converter.type_info(spec)] - in Proc | FinchAPI::Converter | Class | Hash - [nil, FinchAPI::Converter.type_info(key)] + @discriminator = property end + end - known_variants << variant_info - end - - # @private - # - # @param value [Object] - # - # @return [FinchAPI::Converter, Class, nil] - # - private_class_method def self.resolve_variant(value) - case [@discriminator, value] - in [_, FinchAPI::BaseModel] - value.class - in [Symbol, Hash] - key = - if value.key?(@discriminator) - value.fetch(@discriminator) - elsif value.key?((discriminator = @discriminator.to_s)) - value.fetch(discriminator) + # @private + # + # @param key [Symbol, Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + private def variant(key, spec = nil) + variant_info = + case key + in Symbol + [key, FinchAPI::Converter.type_info(spec)] + in Proc | FinchAPI::Converter | Class | Hash + [nil, FinchAPI::Converter.type_info(key)] end - key = key.to_sym if key.is_a?(String) - _, resolved = known_variants.find { |k,| k == key } - resolved.nil? ? FinchAPI::Unknown : resolved.call - else - nil + known_variants << variant_info + end + + # @private + # + # @param value [Object] + # + # @return [FinchAPI::Converter, Class, nil] + # + private def resolve_variant(value) + case [@discriminator, value] + in [_, FinchAPI::BaseModel] + value.class + in [Symbol, Hash] + key = + if value.key?(@discriminator) + value.fetch(@discriminator) + elsif value.key?((discriminator = @discriminator.to_s)) + value.fetch(discriminator) + end + + key = key.to_sym if key.is_a?(String) + _, resolved = known_variants.find { |k,| k == key } + resolved.nil? ? FinchAPI::Unknown : resolved.call + else + nil + end end end @@ -531,87 +539,89 @@ def self.==(other) other.is_a?(Class) && other <= FinchAPI::Union && other.variants == variants end - # @private - # - # @param value [Object] - # - # @return [Object] - # - def self.coerce(value) - if (variant = resolve_variant(value)) - return FinchAPI::Converter.coerce(variant, value) - end + class << self + # @private + # + # @param value [Object] + # + # @return [Object] + # + def coerce(value) + if (variant = resolve_variant(value)) + return FinchAPI::Converter.coerce(variant, value) + end - matches = [] + matches = [] - known_variants.each do |_, variant_fn| - variant = variant_fn.call + known_variants.each do |_, variant_fn| + variant = variant_fn.call - case FinchAPI::Converter.try_strict_coerce(variant, value) - in [true, coerced, _] - return coerced - in [false, true, score] - matches << [score, variant] - in [false, false, _] - nil + case FinchAPI::Converter.try_strict_coerce(variant, value) + in [true, coerced, _] + return coerced + in [false, true, score] + matches << [score, variant] + in [false, false, _] + nil + end end - end - - _, variant = matches.sort! { _2.first <=> _1.first }.find { |score,| !score.zero? } - variant.nil? ? value : FinchAPI::Converter.coerce(variant, value) - end - # @private - # - # @param value [Object] - # - # @return [Object] - # - def self.dump(value) - if (variant = resolve_variant(value)) - return FinchAPI::Converter.dump(variant, value) + _, variant = matches.sort! { _2.first <=> _1.first }.find { |score,| !score.zero? } + variant.nil? ? value : FinchAPI::Converter.coerce(variant, value) end - known_variants.each do |_, variant_fn| - variant = variant_fn.call - if variant === value + # @private + # + # @param value [Object] + # + # @return [Object] + # + def dump(value) + if (variant = resolve_variant(value)) return FinchAPI::Converter.dump(variant, value) end - end - value - end - # @private - # - # @param value [Object] - # - # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # - def self.try_strict_coerce(value) - # TODO(ruby) this will result in super linear decoding behaviour for nested unions - # follow up with a decoding context that captures current strictness levels - if (variant = resolve_variant(value)) - return Converter.try_strict_coerce(variant, value) + known_variants.each do |_, variant_fn| + variant = variant_fn.call + if variant === value + return FinchAPI::Converter.dump(variant, value) + end + end + value end - coercible = false - max_score = 0 + # @private + # + # @param value [Object] + # + # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] + # + def try_strict_coerce(value) + # TODO(ruby) this will result in super linear decoding behaviour for nested unions + # follow up with a decoding context that captures current strictness levels + if (variant = resolve_variant(value)) + return Converter.try_strict_coerce(variant, value) + end - known_variants.each do |_, variant_fn| - variant = variant_fn.call + coercible = false + max_score = 0 - case FinchAPI::Converter.try_strict_coerce(variant, value) - in [true, coerced, score] - return [true, coerced, score] - in [false, true, score] - coercible = true - max_score = [max_score, score].max - in [false, false, _] - nil + known_variants.each do |_, variant_fn| + variant = variant_fn.call + + case FinchAPI::Converter.try_strict_coerce(variant, value) + in [true, coerced, score] + return [true, coerced, score] + in [false, true, score] + coercible = true + max_score = [max_score, score].max + in [false, false, _] + nil + end end - end - [false, coercible, max_score] + [false, coercible, max_score] + end end # rubocop:enable Style/CaseEquality @@ -904,20 +914,18 @@ def initialize(type_info, spec = {}) class BaseModel extend FinchAPI::Converter - # @private - # - # Assumes superclass fields are totally defined before fields are accessed / - # defined on subclasses. - # - # @return [Hash{Symbol=>Hash{Symbol=>Object}}] - # - def self.known_fields - @known_fields ||= (self < FinchAPI::BaseModel ? superclass.known_fields.dup : {}) - end - class << self # @private # + # Assumes superclass fields are totally defined before fields are accessed / + # defined on subclasses. + # + # @return [Hash{Symbol=>Hash{Symbol=>Object}}] + # + def known_fields + @known_fields ||= (self < FinchAPI::BaseModel ? superclass.known_fields.dup : {}) + end + # @return [Hash{Symbol=>Hash{Symbol=>Object}}] # def fields @@ -925,135 +933,135 @@ def fields {**field.except(:type_fn), type: field.fetch(:type_fn).call} end end - end - # @private - # - # @return [Hash{Symbol=>Proc}] - # - def self.defaults = (@defaults ||= {}) + # @private + # + # @return [Hash{Symbol=>Proc}] + # + def defaults = (@defaults ||= {}) - # @private - # - # @param name_sym [Symbol] - # - # @param required [Boolean] - # - # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] - # - # @param spec [Hash{Symbol=>Object}] . - # - # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const - # - # @option spec [Proc] :enum - # - # @option spec [Proc] :union - # - # @option spec [Boolean] :"nil?" - # - private_class_method def self.add_field(name_sym, required:, type_info:, spec:) - type_fn, info = - case type_info - in Proc | Class | FinchAPI::Converter - [FinchAPI::Converter.type_info({**spec, union: type_info}), spec] - in Hash - [FinchAPI::Converter.type_info(type_info), type_info] - end + # @private + # + # @param name_sym [Symbol] + # + # @param required [Boolean] + # + # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + private def add_field(name_sym, required:, type_info:, spec:) + type_fn, info = + case type_info + in Proc | Class | FinchAPI::Converter + [FinchAPI::Converter.type_info({**spec, union: type_info}), spec] + in Hash + [FinchAPI::Converter.type_info(type_info), type_info] + end - fallback = info[:const] - defaults[name_sym] = fallback if required && !info[:nil?] && info.key?(:const) + fallback = info[:const] + defaults[name_sym] = fallback if required && !info[:nil?] && info.key?(:const) - key = info.fetch(:api_name, name_sym) - setter = "#{name_sym}=" + key = info.fetch(:api_name, name_sym) + setter = "#{name_sym}=" - if known_fields.key?(name_sym) - [name_sym, setter].each { undef_method(_1) } - end + if known_fields.key?(name_sym) + [name_sym, setter].each { undef_method(_1) } + end - known_fields[name_sym] = {mode: @mode, key: key, required: required, type_fn: type_fn} + known_fields[name_sym] = {mode: @mode, key: key, required: required, type_fn: type_fn} - define_method(setter) do |val| - @data[key] = val - end + define_method(setter) do |val| + @data[key] = val + end - define_method(name_sym) do - field_type = type_fn.call - value = @data.fetch(key) { self.class.defaults[key] } - FinchAPI::Converter.coerce(field_type, value) - rescue StandardError - name = self.class.name.split("::").last - raise FinchAPI::ConversionError.new( - "Failed to parse #{name}.#{name_sym} as #{field_type.inspect}. " \ - "To get the unparsed API response, use #{name}[:#{key}]." - ) + define_method(name_sym) do + field_type = type_fn.call + value = @data.fetch(key) { self.class.defaults[key] } + FinchAPI::Converter.coerce(field_type, value) + rescue StandardError + name = self.class.name.split("::").last + raise FinchAPI::ConversionError.new( + "Failed to parse #{name}.#{name_sym} as #{field_type.inspect}. " \ + "To get the unparsed API response, use #{name}[:#{key}]." + ) + end end - end - # @private - # - # @param name_sym [Symbol] - # - # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] - # - # @param spec [Hash{Symbol=>Object}] . - # - # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const - # - # @option spec [Proc] :enum - # - # @option spec [Proc] :union - # - # @option spec [Boolean] :"nil?" - # - def self.required(name_sym, type_info, spec = {}) - add_field(name_sym, required: true, type_info: type_info, spec: spec) - end + # @private + # + # @param name_sym [Symbol] + # + # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + def required(name_sym, type_info, spec = {}) + add_field(name_sym, required: true, type_info: type_info, spec: spec) + end - # @private - # - # @param name_sym [Symbol] - # - # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] - # - # @param spec [Hash{Symbol=>Object}] . - # - # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const - # - # @option spec [Proc] :enum - # - # @option spec [Proc] :union - # - # @option spec [Boolean] :"nil?" - # - def self.optional(name_sym, type_info, spec = {}) - add_field(name_sym, required: false, type_info: type_info, spec: spec) - end + # @private + # + # @param name_sym [Symbol] + # + # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + # + def optional(name_sym, type_info, spec = {}) + add_field(name_sym, required: false, type_info: type_info, spec: spec) + end - # @private - # - # `request_only` attributes not excluded from `.#coerce` when receiving responses - # even if well behaved servers should not send them - # - # @param blk [Proc] - # - private_class_method def self.request_only(&blk) - @mode = :dump - blk.call - ensure - @mode = nil - end + # @private + # + # `request_only` attributes not excluded from `.#coerce` when receiving responses + # even if well behaved servers should not send them + # + # @param blk [Proc] + # + private def request_only(&blk) + @mode = :dump + blk.call + ensure + @mode = nil + end - # @private - # - # `response_only` attributes are omitted from `.#dump` when making requests - # - # @param blk [Proc] - # - private_class_method def self.response_only(&blk) - @mode = :coerce - blk.call - ensure - @mode = nil + # @private + # + # `response_only` attributes are omitted from `.#dump` when making requests + # + # @param blk [Proc] + # + private def response_only(&blk) + @mode = :coerce + blk.call + ensure + @mode = nil + end end # @param other [Object] @@ -1069,108 +1077,110 @@ def ==(other) end end - # @private - # - # @param value [FinchAPI::BaseModel, Hash{Object=>Object}, Object] - # - # @return [FinchAPI::BaseModel, Object] - # - def self.coerce(value) - case FinchAPI::Util.coerce_hash(value) - in Hash => coerced - new(coerced) - else - value + class << self + # @private + # + # @param value [FinchAPI::BaseModel, Hash{Object=>Object}, Object] + # + # @return [FinchAPI::BaseModel, Object] + # + def coerce(value) + case FinchAPI::Util.coerce_hash(value) + in Hash => coerced + new(coerced) + else + value + end end - end - # @private - # - # @param value [FinchAPI::BaseModel, Object] - # - # @return [Hash{Object=>Object}, Object] - # - def self.dump(value) - unless (coerced = FinchAPI::Util.coerce_hash(value)).is_a?(Hash) - return value - end + # @private + # + # @param value [FinchAPI::BaseModel, Object] + # + # @return [Hash{Object=>Object}, Object] + # + def dump(value) + unless (coerced = FinchAPI::Util.coerce_hash(value)).is_a?(Hash) + return value + end - values = coerced.filter_map do |key, val| - name = key.to_sym - case (field = known_fields[name]) - in nil - [name, val] - else - mode, type_fn, api_name = field.fetch_values(:mode, :type_fn, :key) - case mode - in :coerce - next + values = coerced.filter_map do |key, val| + name = key.to_sym + case (field = known_fields[name]) + in nil + [name, val] else - target = type_fn.call - [api_name, FinchAPI::Converter.dump(target, val)] + mode, type_fn, api_name = field.fetch_values(:mode, :type_fn, :key) + case mode + in :coerce + next + else + target = type_fn.call + [api_name, FinchAPI::Converter.dump(target, val)] + end end - end - end.to_h + end.to_h - defaults.each do |key, val| - next if values.key?(key) + defaults.each do |key, val| + next if values.key?(key) - values[key] = val - end - - values - end + values[key] = val + end - # @private - # - # @param value [Object] - # - # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # - def self.try_strict_coerce(value) - case value - in Hash | FinchAPI::BaseModel - value = value.to_h - else - return [false, false, 0] + values end - keys = value.keys.to_set - great_success = true - tally = 0 - acc = {} + # @private + # + # @param value [Object] + # + # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] + # + def try_strict_coerce(value) + case value + in Hash | FinchAPI::BaseModel + value = value.to_h + else + return [false, false, 0] + end + + keys = value.keys.to_set + great_success = true + tally = 0 + acc = {} - known_fields.each_value do |field| - mode, required, type_fn, api_name = field.fetch_values(:mode, :required, :type_fn, :key) - keys.delete(api_name) + known_fields.each_value do |field| + mode, required, type_fn, api_name = field.fetch_values(:mode, :required, :type_fn, :key) + keys.delete(api_name) - case [required && mode != :dump, value.key?(api_name)] - in [_, true] - target = type_fn.call - item = value.fetch(api_name) - case FinchAPI::Converter.try_strict_coerce(target, item) - in [true, coerced, score] - tally += score - acc[api_name] = coerced - in [false, true, score] + case [required && mode != :dump, value.key?(api_name)] + in [_, true] + target = type_fn.call + item = value.fetch(api_name) + case FinchAPI::Converter.try_strict_coerce(target, item) + in [true, coerced, score] + tally += score + acc[api_name] = coerced + in [false, true, score] + great_success = false + tally += score + acc[api_name] = item + in [false, false, _] + great_success &&= item.nil? + end + in [true, false] great_success = false - tally += score - acc[api_name] = item - in [false, false, _] - great_success &&= item.nil? + in [false, false] + nil end - in [true, false] - great_success = false - in [false, false] - nil end - end - keys.each do |key| - acc[key] = value.fetch(key) - end + keys.each do |key| + acc[key] = value.fetch(key) + end - great_success ? [true, new(acc), tally] : [false, true, tally] + great_success ? [true, new(acc), tally] : [false, true, tally] + end end # Returns the raw value associated with the given key, if found. Otherwise, nil is diff --git a/lib/finch-api/models/account_update_event.rb b/lib/finch-api/models/account_update_event.rb index b0037c1d..5874bf66 100644 --- a/lib/finch-api/models/account_update_event.rb +++ b/lib/finch-api/models/account_update_event.rb @@ -1929,11 +1929,6 @@ class Type < FinchAPI::Enum OAUTH = :oauth finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end @@ -1944,11 +1939,6 @@ class EventType < FinchAPI::Enum ACCOUNT_UPDATED = :"account.updated" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/company_event.rb b/lib/finch-api/models/company_event.rb index e1e013ee..738ec6db 100644 --- a/lib/finch-api/models/company_event.rb +++ b/lib/finch-api/models/company_event.rb @@ -31,11 +31,6 @@ class EventType < FinchAPI::Enum COMPANY_UPDATED = :"company.updated" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/connect/session_new_params.rb b/lib/finch-api/models/connect/session_new_params.rb index 372cb350..c3925389 100644 --- a/lib/finch-api/models/connect/session_new_params.rb +++ b/lib/finch-api/models/connect/session_new_params.rb @@ -99,11 +99,6 @@ class Product < FinchAPI::Enum SSN = :ssn finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Integration < FinchAPI::BaseModel @@ -136,11 +131,6 @@ class AuthMethod < FinchAPI::Enum API_TOKEN = :api_token finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -151,11 +141,6 @@ class Sandbox < FinchAPI::Enum PROVIDER = :provider finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/connect/session_reauthenticate_params.rb b/lib/finch-api/models/connect/session_reauthenticate_params.rb index 3b6bc44f..4c3f1e74 100644 --- a/lib/finch-api/models/connect/session_reauthenticate_params.rb +++ b/lib/finch-api/models/connect/session_reauthenticate_params.rb @@ -60,11 +60,6 @@ class Product < FinchAPI::Enum SSN = :ssn finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/connection_status_type.rb b/lib/finch-api/models/connection_status_type.rb index 3a0979d2..4d2215eb 100644 --- a/lib/finch-api/models/connection_status_type.rb +++ b/lib/finch-api/models/connection_status_type.rb @@ -13,11 +13,6 @@ class ConnectionStatusType < FinchAPI::Enum REAUTH = :reauth finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/create_access_token_response.rb b/lib/finch-api/models/create_access_token_response.rb index 2ef85938..6b3864fe 100644 --- a/lib/finch-api/models/create_access_token_response.rb +++ b/lib/finch-api/models/create_access_token_response.rb @@ -112,11 +112,6 @@ class ClientType < FinchAPI::Enum SANDBOX = :sandbox finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -130,11 +125,6 @@ class ConnectionType < FinchAPI::Enum FINCH = :finch finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/directory_event.rb b/lib/finch-api/models/directory_event.rb index 72234db2..30479a27 100644 --- a/lib/finch-api/models/directory_event.rb +++ b/lib/finch-api/models/directory_event.rb @@ -56,11 +56,6 @@ class EventType < FinchAPI::Enum DIRECTORY_DELETED = :"directory.deleted" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/employment_event.rb b/lib/finch-api/models/employment_event.rb index 95090c69..a691d012 100644 --- a/lib/finch-api/models/employment_event.rb +++ b/lib/finch-api/models/employment_event.rb @@ -56,11 +56,6 @@ class EventType < FinchAPI::Enum EMPLOYMENT_DELETED = :"employment.deleted" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_contribution.rb b/lib/finch-api/models/hris/benefit_contribution.rb index 48e09273..7cdc6657 100644 --- a/lib/finch-api/models/hris/benefit_contribution.rb +++ b/lib/finch-api/models/hris/benefit_contribution.rb @@ -32,11 +32,6 @@ class Type < FinchAPI::Enum PERCENT = :percent finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_features_and_operations.rb b/lib/finch-api/models/hris/benefit_features_and_operations.rb index 2fc798e7..030ae9fb 100644 --- a/lib/finch-api/models/hris/benefit_features_and_operations.rb +++ b/lib/finch-api/models/hris/benefit_features_and_operations.rb @@ -131,11 +131,6 @@ class CompanyContribution < FinchAPI::Enum PERCENT = :percent finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -145,11 +140,6 @@ class EmployeeDeduction < FinchAPI::Enum PERCENT = :percent finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -159,11 +149,6 @@ class HsaContributionLimit < FinchAPI::Enum FAMILY = :family finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_frequency.rb b/lib/finch-api/models/hris/benefit_frequency.rb index 06b78c94..de52d30c 100644 --- a/lib/finch-api/models/hris/benefit_frequency.rb +++ b/lib/finch-api/models/hris/benefit_frequency.rb @@ -11,11 +11,6 @@ class BenefitFrequency < FinchAPI::Enum MONTHLY = :monthly finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_type.rb b/lib/finch-api/models/hris/benefit_type.rb index d2a6877f..cfeb25eb 100644 --- a/lib/finch-api/models/hris/benefit_type.rb +++ b/lib/finch-api/models/hris/benefit_type.rb @@ -28,11 +28,6 @@ class BenefitType < FinchAPI::Enum CUSTOM_PRE_TAX = :custom_pre_tax finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefits/enrolled_individual.rb b/lib/finch-api/models/hris/benefits/enrolled_individual.rb index a012ae2c..b0f17658 100644 --- a/lib/finch-api/models/hris/benefits/enrolled_individual.rb +++ b/lib/finch-api/models/hris/benefits/enrolled_individual.rb @@ -81,11 +81,6 @@ class Code < FinchAPI::Enum FORBIDDEN = 403 finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefits/individual_benefit.rb b/lib/finch-api/models/hris/benefits/individual_benefit.rb index f092679b..695b332c 100644 --- a/lib/finch-api/models/hris/benefits/individual_benefit.rb +++ b/lib/finch-api/models/hris/benefits/individual_benefit.rb @@ -101,11 +101,6 @@ class HsaContributionLimit < FinchAPI::Enum FAMILY = :family finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb index dc18ec58..cabd80f7 100644 --- a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +++ b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb @@ -135,11 +135,6 @@ class AnnualContributionLimit < FinchAPI::Enum FAMILY = :family finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class CompanyContribution < FinchAPI::BaseModel @@ -179,11 +174,6 @@ class Type < FinchAPI::Enum PERCENT = :percent finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -224,11 +214,6 @@ class Type < FinchAPI::Enum PERCENT = :percent finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/company.rb b/lib/finch-api/models/hris/company.rb index 3d43e7ca..a8e2e756 100644 --- a/lib/finch-api/models/hris/company.rb +++ b/lib/finch-api/models/hris/company.rb @@ -138,11 +138,6 @@ class AccountType < FinchAPI::Enum SAVINGS = :savings finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -217,11 +212,6 @@ class Subtype < FinchAPI::Enum B_CORPORATION = :b_corporation finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -237,11 +227,6 @@ class Type < FinchAPI::Enum COOPERATIVE = :cooperative finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/document_list_params.rb b/lib/finch-api/models/hris/document_list_params.rb index f37e5c11..e175a22d 100644 --- a/lib/finch-api/models/hris/document_list_params.rb +++ b/lib/finch-api/models/hris/document_list_params.rb @@ -68,11 +68,6 @@ class Type < FinchAPI::Enum W4_2005 = :w4_2005 finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/document_response.rb b/lib/finch-api/models/hris/document_response.rb index 2100a49d..d776e335 100644 --- a/lib/finch-api/models/hris/document_response.rb +++ b/lib/finch-api/models/hris/document_response.rb @@ -67,11 +67,6 @@ class Type < FinchAPI::Enum W4_2005 = :w4_2005 finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/employment_data.rb b/lib/finch-api/models/hris/employment_data.rb index 6eeaa796..12f6497b 100644 --- a/lib/finch-api/models/hris/employment_data.rb +++ b/lib/finch-api/models/hris/employment_data.rb @@ -264,11 +264,6 @@ class Subtype < FinchAPI::Enum INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -279,11 +274,6 @@ class Type < FinchAPI::Enum CONTRACTOR = :contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -301,11 +291,6 @@ class EmploymentStatus < FinchAPI::Enum TERMINATED = :terminated finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/hris/individual.rb b/lib/finch-api/models/hris/individual.rb index 6daab665..6eecfd85 100644 --- a/lib/finch-api/models/hris/individual.rb +++ b/lib/finch-api/models/hris/individual.rb @@ -155,11 +155,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -177,11 +172,6 @@ class Ethnicity < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -194,11 +184,6 @@ class Gender < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class PhoneNumber < FinchAPI::BaseModel @@ -227,11 +212,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/pay_statement.rb b/lib/finch-api/models/hris/pay_statement.rb index e70d6d90..819e3de5 100644 --- a/lib/finch-api/models/hris/pay_statement.rb +++ b/lib/finch-api/models/hris/pay_statement.rb @@ -210,11 +210,6 @@ class Type < FinchAPI::Enum OTHER = :other finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -400,11 +395,6 @@ class PaymentMethod < FinchAPI::Enum DIRECT_DEPOSIT = :direct_deposit finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Tax < FinchAPI::BaseModel @@ -504,11 +494,6 @@ class Type < FinchAPI::Enum FICA = :fica finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -521,11 +506,6 @@ class Type < FinchAPI::Enum ONE_TIME_PAYMENT = :one_time_payment finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/payment.rb b/lib/finch-api/models/hris/payment.rb index 9a5dd63b..b2f06c0e 100644 --- a/lib/finch-api/models/hris/payment.rb +++ b/lib/finch-api/models/hris/payment.rb @@ -123,11 +123,6 @@ class PayFrequency < FinchAPI::Enum OTHER = :other finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class PayPeriod < FinchAPI::BaseModel diff --git a/lib/finch-api/models/hris/supported_benefit.rb b/lib/finch-api/models/hris/supported_benefit.rb index 64280504..64d1122d 100644 --- a/lib/finch-api/models/hris/supported_benefit.rb +++ b/lib/finch-api/models/hris/supported_benefit.rb @@ -99,11 +99,6 @@ class CompanyContribution < FinchAPI::Enum PERCENT = :percent finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -113,11 +108,6 @@ class EmployeeDeduction < FinchAPI::Enum PERCENT = :percent finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -127,11 +117,6 @@ class HsaContributionLimit < FinchAPI::Enum FAMILY = :family finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/w42005.rb b/lib/finch-api/models/hris/w42005.rb index a98b550a..c0821600 100644 --- a/lib/finch-api/models/hris/w42005.rb +++ b/lib/finch-api/models/hris/w42005.rb @@ -115,11 +115,6 @@ class Exemption < FinchAPI::Enum NON_EXEMPT = :non_exempt finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -131,11 +126,6 @@ class FilingStatus < FinchAPI::Enum SINGLE = :single finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -146,11 +136,6 @@ class Type < FinchAPI::Enum W4_2005 = :w4_2005 finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/hris/w42020.rb b/lib/finch-api/models/hris/w42020.rb index 58d2776a..7f0e1926 100644 --- a/lib/finch-api/models/hris/w42020.rb +++ b/lib/finch-api/models/hris/w42020.rb @@ -133,11 +133,6 @@ class FilingStatus < FinchAPI::Enum SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -148,11 +143,6 @@ class Type < FinchAPI::Enum W4_2020 = :w4_2020 finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/income.rb b/lib/finch-api/models/income.rb index 77706f42..04e87cac 100644 --- a/lib/finch-api/models/income.rb +++ b/lib/finch-api/models/income.rb @@ -58,11 +58,6 @@ class Unit < FinchAPI::Enum FIXED = :fixed finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/individual_event.rb b/lib/finch-api/models/individual_event.rb index 2ded3587..907d9860 100644 --- a/lib/finch-api/models/individual_event.rb +++ b/lib/finch-api/models/individual_event.rb @@ -56,11 +56,6 @@ class EventType < FinchAPI::Enum INDIVIDUAL_DELETED = :"individual.deleted" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/introspection.rb b/lib/finch-api/models/introspection.rb index 5af1d4a7..9fc45166 100644 --- a/lib/finch-api/models/introspection.rb +++ b/lib/finch-api/models/introspection.rb @@ -230,11 +230,6 @@ class Type < FinchAPI::Enum OAUTH = :oauth finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -247,11 +242,6 @@ class ClientType < FinchAPI::Enum SANDBOX = :sandbox finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class ConnectionStatus < FinchAPI::BaseModel @@ -293,11 +283,6 @@ class ConnectionType < FinchAPI::Enum FINCH = :finch finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/job_completion_event.rb b/lib/finch-api/models/job_completion_event.rb index 8c7ca1cf..25497d6c 100644 --- a/lib/finch-api/models/job_completion_event.rb +++ b/lib/finch-api/models/job_completion_event.rb @@ -62,11 +62,6 @@ class EventType < FinchAPI::Enum JOB_DATA_SYNC_ALL_COMPLETED = :"job.data_sync_all.completed" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/jobs/automated_async_job.rb b/lib/finch-api/models/jobs/automated_async_job.rb index 476afc5b..a96ecad9 100644 --- a/lib/finch-api/models/jobs/automated_async_job.rb +++ b/lib/finch-api/models/jobs/automated_async_job.rb @@ -108,11 +108,6 @@ class Status < FinchAPI::Enum PERMISSIONS_ERROR = :permissions_error finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -123,11 +118,6 @@ class Type < FinchAPI::Enum W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/jobs/automated_create_params.rb b/lib/finch-api/models/jobs/automated_create_params.rb index e075c8e3..5c7c43b3 100644 --- a/lib/finch-api/models/jobs/automated_create_params.rb +++ b/lib/finch-api/models/jobs/automated_create_params.rb @@ -35,11 +35,6 @@ class Type < FinchAPI::Enum W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Params < FinchAPI::BaseModel diff --git a/lib/finch-api/models/jobs/manual_async_job.rb b/lib/finch-api/models/jobs/manual_async_job.rb index 26a2989b..456ed29e 100644 --- a/lib/finch-api/models/jobs/manual_async_job.rb +++ b/lib/finch-api/models/jobs/manual_async_job.rb @@ -38,11 +38,6 @@ class Status < FinchAPI::Enum COMPLETE = :complete finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/operation_support.rb b/lib/finch-api/models/operation_support.rb index e14959d9..ee695b65 100644 --- a/lib/finch-api/models/operation_support.rb +++ b/lib/finch-api/models/operation_support.rb @@ -18,11 +18,6 @@ class OperationSupport < FinchAPI::Enum CLIENT_ACCESS_ONLY = :client_access_only finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/pay_statement_event.rb b/lib/finch-api/models/pay_statement_event.rb index 8aa11014..713e44ca 100644 --- a/lib/finch-api/models/pay_statement_event.rb +++ b/lib/finch-api/models/pay_statement_event.rb @@ -67,11 +67,6 @@ class EventType < FinchAPI::Enum PAY_STATEMENT_DELETED = :"pay_statement.deleted" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/payment_event.rb b/lib/finch-api/models/payment_event.rb index 19077f72..6cd5bb8a 100644 --- a/lib/finch-api/models/payment_event.rb +++ b/lib/finch-api/models/payment_event.rb @@ -59,11 +59,6 @@ class EventType < FinchAPI::Enum PAYMENT_DELETED = :"payment.deleted" finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/payroll/pay_group_list_response.rb b/lib/finch-api/models/payroll/pay_group_list_response.rb index 2d045bd3..c87f079d 100644 --- a/lib/finch-api/models/payroll/pay_group_list_response.rb +++ b/lib/finch-api/models/payroll/pay_group_list_response.rb @@ -58,11 +58,6 @@ class PayFrequency < FinchAPI::Enum OTHER = :other finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb index 6a2b8d53..5c32f802 100644 --- a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +++ b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb @@ -52,11 +52,6 @@ class PayFrequency < FinchAPI::Enum OTHER = :other finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/provider.rb b/lib/finch-api/models/provider.rb index 1a115409..18a4ca4c 100644 --- a/lib/finch-api/models/provider.rb +++ b/lib/finch-api/models/provider.rb @@ -2011,11 +2011,6 @@ class Type < FinchAPI::Enum OAUTH = :oauth finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/company_update_params.rb b/lib/finch-api/models/sandbox/company_update_params.rb index ae3b1ba1..3ef4e37c 100644 --- a/lib/finch-api/models/sandbox/company_update_params.rb +++ b/lib/finch-api/models/sandbox/company_update_params.rb @@ -140,11 +140,6 @@ class AccountType < FinchAPI::Enum SAVINGS = :savings finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -221,11 +216,6 @@ class Subtype < FinchAPI::Enum B_CORPORATION = :b_corporation finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -241,11 +231,6 @@ class Type < FinchAPI::Enum COOPERATIVE = :cooperative finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/company_update_response.rb b/lib/finch-api/models/sandbox/company_update_response.rb index 65bd508a..a7b7318d 100644 --- a/lib/finch-api/models/sandbox/company_update_response.rb +++ b/lib/finch-api/models/sandbox/company_update_response.rb @@ -122,11 +122,6 @@ class AccountType < FinchAPI::Enum SAVINGS = :savings finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -203,11 +198,6 @@ class Subtype < FinchAPI::Enum B_CORPORATION = :b_corporation finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -223,11 +213,6 @@ class Type < FinchAPI::Enum COOPERATIVE = :cooperative finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connection_create_params.rb b/lib/finch-api/models/sandbox/connection_create_params.rb index d716b7b7..8cc58932 100644 --- a/lib/finch-api/models/sandbox/connection_create_params.rb +++ b/lib/finch-api/models/sandbox/connection_create_params.rb @@ -65,11 +65,6 @@ class AuthenticationType < FinchAPI::Enum ASSISTED = :assisted finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connection_create_response.rb b/lib/finch-api/models/sandbox/connection_create_response.rb index f3317630..3029b6d2 100644 --- a/lib/finch-api/models/sandbox/connection_create_response.rb +++ b/lib/finch-api/models/sandbox/connection_create_response.rb @@ -88,11 +88,6 @@ class AuthenticationType < FinchAPI::Enum ASSISTED = :assisted finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_create_params.rb b/lib/finch-api/models/sandbox/connections/account_create_params.rb index 1046f8ed..c273c416 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_params.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_params.rb @@ -61,11 +61,6 @@ class AuthenticationType < FinchAPI::Enum ASSISTED = :assisted finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_create_response.rb b/lib/finch-api/models/sandbox/connections/account_create_response.rb index 6045d5eb..8e6672ca 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_response.rb @@ -67,11 +67,6 @@ class AuthenticationType < FinchAPI::Enum ASSISTED = :assisted finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_update_response.rb b/lib/finch-api/models/sandbox/connections/account_update_response.rb index 8215a82d..fe37714d 100644 --- a/lib/finch-api/models/sandbox/connections/account_update_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_update_response.rb @@ -65,11 +65,6 @@ class AuthenticationType < FinchAPI::Enum ASSISTED = :assisted finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/directory_create_params.rb b/lib/finch-api/models/sandbox/directory_create_params.rb index e22837b7..adeb1d50 100644 --- a/lib/finch-api/models/sandbox/directory_create_params.rb +++ b/lib/finch-api/models/sandbox/directory_create_params.rb @@ -349,11 +349,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -398,11 +393,6 @@ class Subtype < FinchAPI::Enum INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -413,11 +403,6 @@ class Type < FinchAPI::Enum CONTRACTOR = :contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -434,11 +419,6 @@ class EmploymentStatus < FinchAPI::Enum TERMINATED = :terminated finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -455,11 +435,6 @@ class Ethnicity < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -472,11 +447,6 @@ class Gender < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Manager < FinchAPI::BaseModel @@ -532,11 +502,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/employment_update_params.rb b/lib/finch-api/models/sandbox/employment_update_params.rb index 96dd750c..09b2a719 100644 --- a/lib/finch-api/models/sandbox/employment_update_params.rb +++ b/lib/finch-api/models/sandbox/employment_update_params.rb @@ -257,11 +257,6 @@ class Subtype < FinchAPI::Enum INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -272,11 +267,6 @@ class Type < FinchAPI::Enum CONTRACTOR = :contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -293,11 +283,6 @@ class EmploymentStatus < FinchAPI::Enum TERMINATED = :terminated finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/sandbox/employment_update_response.rb b/lib/finch-api/models/sandbox/employment_update_response.rb index 397d8faa..cf696397 100644 --- a/lib/finch-api/models/sandbox/employment_update_response.rb +++ b/lib/finch-api/models/sandbox/employment_update_response.rb @@ -263,11 +263,6 @@ class Subtype < FinchAPI::Enum INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -278,11 +273,6 @@ class Type < FinchAPI::Enum CONTRACTOR = :contractor finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -299,11 +289,6 @@ class EmploymentStatus < FinchAPI::Enum TERMINATED = :terminated finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/sandbox/individual_update_params.rb b/lib/finch-api/models/sandbox/individual_update_params.rb index 4f96e9e8..4d6de34c 100644 --- a/lib/finch-api/models/sandbox/individual_update_params.rb +++ b/lib/finch-api/models/sandbox/individual_update_params.rb @@ -151,11 +151,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -173,11 +168,6 @@ class Ethnicity < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -190,11 +180,6 @@ class Gender < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class PhoneNumber < FinchAPI::BaseModel @@ -229,11 +214,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/individual_update_response.rb b/lib/finch-api/models/sandbox/individual_update_response.rb index edb9f45d..b91ba2d9 100644 --- a/lib/finch-api/models/sandbox/individual_update_response.rb +++ b/lib/finch-api/models/sandbox/individual_update_response.rb @@ -159,11 +159,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -181,11 +176,6 @@ class Ethnicity < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -198,11 +188,6 @@ class Gender < FinchAPI::Enum DECLINE_TO_SPECIFY = :decline_to_specify finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class PhoneNumber < FinchAPI::BaseModel @@ -237,11 +222,6 @@ class Type < FinchAPI::Enum PERSONAL = :personal finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/job_create_params.rb b/lib/finch-api/models/sandbox/job_create_params.rb index 33ee8ba1..a64dea40 100644 --- a/lib/finch-api/models/sandbox/job_create_params.rb +++ b/lib/finch-api/models/sandbox/job_create_params.rb @@ -29,11 +29,6 @@ class Type < FinchAPI::Enum DATA_SYNC_ALL = :data_sync_all finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb index 090179ca..1516f2b8 100644 --- a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +++ b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb @@ -33,11 +33,6 @@ class CompletionStatus < FinchAPI::Enum ERROR = :error finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end # @abstract @@ -46,11 +41,6 @@ class Type < FinchAPI::Enum DATA_SYNC_ALL = :data_sync_all finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/payment_create_params.rb b/lib/finch-api/models/sandbox/payment_create_params.rb index 551313b0..77f49849 100644 --- a/lib/finch-api/models/sandbox/payment_create_params.rb +++ b/lib/finch-api/models/sandbox/payment_create_params.rb @@ -262,11 +262,6 @@ class Type < FinchAPI::Enum OTHER = :other finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -453,11 +448,6 @@ class PaymentMethod < FinchAPI::Enum DIRECT_DEPOSIT = :direct_deposit finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end class Tax < FinchAPI::BaseModel @@ -562,11 +552,6 @@ class Type < FinchAPI::Enum FICA = :fica finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end @@ -579,11 +564,6 @@ class Type < FinchAPI::Enum ONE_TIME_PAYMENT = :one_time_payment finalize! - - # @!parse - # # @return [Array] - # # - # def self.values; end end end end diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index f72fad18..087b56a4 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -43,25 +43,27 @@ module FinchAPI PLATFORM_HEADERS = T::Hash[String, String] - sig { params(req: FinchAPI::BaseClient::RequestComponentsShape).void } - def self.validate!(req) - end - - sig do - params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean) - end - def self.should_retry?(status, headers:) - end - - sig do - params( - request: FinchAPI::BaseClient::RequestInputShape, - status: Integer, - response_headers: T.any(T::Hash[String, String], Net::HTTPHeader) - ) - .returns(FinchAPI::BaseClient::RequestInputShape) - end - def self.follow_redirect(request, status:, response_headers:) + class << self + sig { params(req: FinchAPI::BaseClient::RequestComponentsShape).void } + def self.validate!(req) + end + + sig do + params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean) + end + def self.should_retry?(status, headers:) + end + + sig do + params( + request: FinchAPI::BaseClient::RequestInputShape, + status: Integer, + response_headers: T.any(T::Hash[String, String], Net::HTTPHeader) + ) + .returns(FinchAPI::BaseClient::RequestInputShape) + end + def self.follow_redirect(request, status:, response_headers:) + end end sig { returns(T.anything) } diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 35b4ce59..c74ba900 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -22,33 +22,35 @@ module FinchAPI def try_strict_coerce(value) end - sig do - params( - spec: T.any( - { - const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)), - enum: T.nilable(T.proc.returns(FinchAPI::Converter::Input)), - union: T.nilable(T.proc.returns(FinchAPI::Converter::Input)) - }, - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input + class << self + sig do + params( + spec: T.any( + { + const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)), + enum: T.nilable(T.proc.returns(FinchAPI::Converter::Input)), + union: T.nilable(T.proc.returns(FinchAPI::Converter::Input)) + }, + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ) ) - ) - .returns(T.proc.returns(T.anything).void) - end - def self.type_info(spec) - end + .returns(T.proc.returns(T.anything).void) + end + def self.type_info(spec) + end - sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } - def self.coerce(target, value) - end + sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } + def self.coerce(target, value) + end - sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } - def self.dump(target, value) - end + sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } + def self.dump(target, value) + end - sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } - def self.try_strict_coerce(target, value) + sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } + def self.try_strict_coerce(target, value) + end end end @@ -65,20 +67,22 @@ module FinchAPI def self.==(other) end - sig { override.params(value: T.anything).returns(T.anything) } - def self.coerce(value) - end + class << self + sig { override.params(value: T.anything).returns(T.anything) } + def coerce(value) + end - sig { override.params(value: T.anything).returns(T.anything) } - def self.dump(value) - end + sig { override.params(value: T.anything).returns(T.anything) } + def dump(value) + end - sig do - override - .params(value: T.anything) - .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) - end - def self.try_strict_coerce(value) + sig do + override + .params(value: T.anything) + .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) + end + def try_strict_coerce(value) + end end end @@ -95,20 +99,22 @@ module FinchAPI def self.==(other) end - sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } - def self.coerce(value) - end + class << self + sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } + def coerce(value) + end - sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } - def self.dump(value) - end + sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } + def dump(value) + end - sig do - override - .params(value: T.anything) - .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) - end - def self.try_strict_coerce(value) + sig do + override + .params(value: T.anything) + .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) + end + def try_strict_coerce(value) + end end end @@ -117,12 +123,14 @@ module FinchAPI extend FinchAPI::Converter - sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } - def self.values - end + class << self + sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } + def values + end - sig { void } - private_class_method def self.finalize! + sig { void } + private def finalize! + end end sig { params(other: T.anything).returns(T::Boolean) } @@ -133,20 +141,22 @@ module FinchAPI def self.==(other) end - sig { override.params(value: T.any(String, Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } - def self.coerce(value) - end + class << self + sig { override.params(value: T.any(String, Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } + def coerce(value) + end - sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } - def self.dump(value) - end + sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } + def dump(value) + end - sig do - override - .params(value: T.anything) - .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) - end - def self.try_strict_coerce(value) + sig do + override + .params(value: T.anything) + .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) + end + def try_strict_coerce(value) + end end end @@ -155,39 +165,41 @@ module FinchAPI extend FinchAPI::Converter - sig { returns(T::Array[[T.nilable(Symbol), Proc]]) } - private_class_method def self.known_variants - end - - sig { overridable.returns(T::Array[[T.nilable(Symbol), T.anything]]) } - private_class_method def self.variants - end - - sig { params(property: Symbol).void } - private_class_method def self.discriminator(property) - end - - sig do - params( - key: T.any( - Symbol, - T::Hash[Symbol, T.anything], - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input - ), - spec: T.any( - T::Hash[Symbol, T.anything], - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input + class << self + sig { returns(T::Array[[T.nilable(Symbol), Proc]]) } + private def known_variants + end + + sig { overridable.returns(T::Array[[T.nilable(Symbol), T.anything]]) } + protected def variants + end + + sig { params(property: Symbol).void } + private def discriminator(property) + end + + sig do + params( + key: T.any( + Symbol, + T::Hash[Symbol, T.anything], + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ), + spec: T.any( + T::Hash[Symbol, T.anything], + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ) ) - ) - .void - end - private_class_method def self.variant(key, spec = nil) - end + .void + end + private def variant(key, spec = nil) + end - sig { params(value: T.anything).returns(T.nilable(FinchAPI::Converter::Input)) } - private_class_method def self.resolve_variant(value) + sig { params(value: T.anything).returns(T.nilable(FinchAPI::Converter::Input)) } + private def resolve_variant(value) + end end sig { params(other: T.anything).returns(T::Boolean) } @@ -198,20 +210,22 @@ module FinchAPI def self.==(other) end - sig { override.params(value: T.anything).returns(T.anything) } - def self.coerce(value) - end + class << self + sig { override.params(value: T.anything).returns(T.anything) } + def coerce(value) + end - sig { override.params(value: T.anything).returns(T.anything) } - def self.dump(value) - end + sig { override.params(value: T.anything).returns(T.anything) } + def dump(value) + end - sig do - override - .params(value: T.anything) - .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) - end - def self.try_strict_coerce(value) + sig do + override + .params(value: T.anything) + .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) + end + def try_strict_coerce(value) + end end end @@ -334,117 +348,121 @@ module FinchAPI KnownFieldShape = T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean} } - sig do - returns( - T::Hash[Symbol, - T.all( - FinchAPI::BaseModel::KnownFieldShape, - {type_fn: T.proc.returns(FinchAPI::Converter::Input)} - )] - ) - end - def self.known_fields - end - - sig do - returns( - T::Hash[Symbol, - T.all(FinchAPI::BaseModel::KnownFieldShape, {type: FinchAPI::Converter::Input})] - ) - end - def self.fields - end - - sig { returns(T::Hash[Symbol, T.proc.returns(T::Class[T.anything])]) } - def self.defaults - end - - sig do - params( - name_sym: Symbol, - required: T::Boolean, - type_info: T.any( - { - const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)), - enum: T.nilable(T.proc.returns(FinchAPI::Converter::Input)), - union: T.nilable(T.proc.returns(FinchAPI::Converter::Input)), - api_name: Symbol, - nil?: T::Boolean - }, - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input - ), - spec: T::Hash[Symbol, T.anything] - ) - .void - end - private_class_method def self.add_field(name_sym, required:, type_info:, spec:) - end - - sig do - params( - name_sym: Symbol, - type_info: T.any( - T::Hash[Symbol, T.anything], - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input - ), - spec: T::Hash[Symbol, T.anything] - ) - .void - end - def self.required(name_sym, type_info, spec = {}) - end - - sig do - params( - name_sym: Symbol, - type_info: T.any( - T::Hash[Symbol, T.anything], - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input - ), - spec: T::Hash[Symbol, T.anything] - ) - .void - end - def self.optional(name_sym, type_info, spec = {}) - end + class << self + sig do + returns( + T::Hash[Symbol, + T.all( + FinchAPI::BaseModel::KnownFieldShape, + {type_fn: T.proc.returns(FinchAPI::Converter::Input)} + )] + ) + end + def known_fields + end + + sig do + returns( + T::Hash[Symbol, + T.all(FinchAPI::BaseModel::KnownFieldShape, {type: FinchAPI::Converter::Input})] + ) + end + def fields + end + + sig { returns(T::Hash[Symbol, T.proc.returns(T::Class[T.anything])]) } + def defaults + end + + sig do + params( + name_sym: Symbol, + required: T::Boolean, + type_info: T.any( + { + const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)), + enum: T.nilable(T.proc.returns(FinchAPI::Converter::Input)), + union: T.nilable(T.proc.returns(FinchAPI::Converter::Input)), + api_name: Symbol, + nil?: T::Boolean + }, + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ), + spec: T::Hash[Symbol, T.anything] + ) + .void + end + private def add_field(name_sym, required:, type_info:, spec:) + end + + sig do + params( + name_sym: Symbol, + type_info: T.any( + T::Hash[Symbol, T.anything], + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ), + spec: T::Hash[Symbol, T.anything] + ) + .void + end + def required(name_sym, type_info, spec = {}) + end + + sig do + params( + name_sym: Symbol, + type_info: T.any( + T::Hash[Symbol, T.anything], + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ), + spec: T::Hash[Symbol, T.anything] + ) + .void + end + def optional(name_sym, type_info, spec = {}) + end - sig { params(blk: T.proc.void).void } - private_class_method def self.request_only(&blk) - end + sig { params(blk: T.proc.void).void } + private def request_only(&blk) + end - sig { params(blk: T.proc.void).void } - private_class_method def self.response_only(&blk) + sig { params(blk: T.proc.void).void } + private def response_only(&blk) + end end sig { params(other: T.anything).returns(T::Boolean) } def ==(other) end - sig do - override - .params(value: T.any(FinchAPI::BaseModel, T::Hash[T.anything, T.anything], T.anything)) - .returns(T.any(T.attached_class, T.anything)) - end - def self.coerce(value) - end - - sig do - override - .params(value: T.any(T.attached_class, T.anything)) - .returns(T.any(T::Hash[T.anything, T.anything], T.anything)) - end - def self.dump(value) - end - - sig do - override - .params(value: T.anything) - .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) - end - def self.try_strict_coerce(value) + class << self + sig do + override + .params(value: T.any(FinchAPI::BaseModel, T::Hash[T.anything, T.anything], T.anything)) + .returns(T.any(T.attached_class, T.anything)) + end + def coerce(value) + end + + sig do + override + .params(value: T.any(T.attached_class, T.anything)) + .returns(T.any(T::Hash[T.anything, T.anything], T.anything)) + end + def dump(value) + end + + sig do + override + .params(value: T.anything) + .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) + end + def try_strict_coerce(value) + end end sig { params(key: Symbol).returns(T.nilable(T.anything)) } diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index 812c9003..b9e76cd4 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -2458,8 +2458,10 @@ module FinchAPI API_CREDENTIAL = :api_credential OAUTH = :oauth - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -2470,8 +2472,10 @@ module FinchAPI ACCOUNT_UPDATED = :"account.updated" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index 2c38858d..b6b760f1 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -34,8 +34,10 @@ module FinchAPI COMPANY_UPDATED = :"company.updated" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 5ea91e8d..25c730e0 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -143,8 +143,10 @@ module FinchAPI BENEFITS = :benefits SSN = :ssn - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -181,8 +183,10 @@ module FinchAPI OAUTH = T.let(:oauth, T.nilable(Symbol)) API_TOKEN = T.let(:api_token, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -193,8 +197,10 @@ module FinchAPI FINCH = T.let(:finch, T.nilable(Symbol)) PROVIDER = T.let(:provider, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 582cb438..6092f209 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -85,8 +85,10 @@ module FinchAPI BENEFITS = :benefits SSN = :ssn - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/connection_status_type.rbi b/rbi/lib/finch-api/models/connection_status_type.rbi index fb495a37..4669a5ce 100644 --- a/rbi/lib/finch-api/models/connection_status_type.rbi +++ b/rbi/lib/finch-api/models/connection_status_type.rbi @@ -12,8 +12,10 @@ module FinchAPI ERROR_PERMISSIONS = :error_permissions REAUTH = :reauth - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index 341c7933..e791131d 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -139,8 +139,10 @@ module FinchAPI DEVELOPMENT = :development SANDBOX = :sandbox - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -150,8 +152,10 @@ module FinchAPI PROVIDER = :provider FINCH = :finch - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index bb7e3bfb..28a572f2 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -52,8 +52,10 @@ module FinchAPI DIRECTORY_UPDATED = :"directory.updated" DIRECTORY_DELETED = :"directory.deleted" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index 96cc16e3..fa9a3daa 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -52,8 +52,10 @@ module FinchAPI EMPLOYMENT_UPDATED = :"employment.updated" EMPLOYMENT_DELETED = :"employment.deleted" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index 6ec99ded..0765173a 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -34,8 +34,10 @@ module FinchAPI FIXED = T.let(:fixed, T.nilable(Symbol)) PERCENT = T.let(:percent, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 6d5c8163..9e7c330d 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -157,8 +157,10 @@ module FinchAPI FIXED = T.let(:fixed, T.nilable(Symbol)) PERCENT = T.let(:percent, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -168,8 +170,10 @@ module FinchAPI FIXED = T.let(:fixed, T.nilable(Symbol)) PERCENT = T.let(:percent, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -179,8 +183,10 @@ module FinchAPI INDIVIDUAL = T.let(:individual, T.nilable(Symbol)) FAMILY = T.let(:family, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi index ccd5d033..8daa0206 100644 --- a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi @@ -10,8 +10,10 @@ module FinchAPI EVERY_PAYCHECK = T.let(:every_paycheck, T.nilable(Symbol)) MONTHLY = T.let(:monthly, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_type.rbi b/rbi/lib/finch-api/models/hris/benefit_type.rbi index 98b48853..54cd8af9 100644 --- a/rbi/lib/finch-api/models/hris/benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_type.rbi @@ -26,8 +26,10 @@ module FinchAPI CUSTOM_POST_TAX = T.let(:custom_post_tax, T.nilable(Symbol)) CUSTOM_PRE_TAX = T.let(:custom_pre_tax, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index d814a30e..bbeb0014 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -104,8 +104,10 @@ module FinchAPI NOT_FOUND = 404 FORBIDDEN = 403 - sig { override.returns(T::Array[Integer]) } - def self.values + class << self + sig { override.returns(T::Array[Integer]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index 8121a4a0..6aa7bbf1 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -141,8 +141,10 @@ module FinchAPI INDIVIDUAL = T.let(:individual, T.nilable(Symbol)) FAMILY = T.let(:family, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index a5eedd15..7d589852 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -194,8 +194,10 @@ module FinchAPI INDIVIDUAL = :individual FAMILY = :family - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -230,8 +232,10 @@ module FinchAPI FIXED = :fixed PERCENT = :percent - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -267,8 +271,10 @@ module FinchAPI FIXED = :fixed PERCENT = :percent - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index a07708a8..3b958c38 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -215,8 +215,10 @@ module FinchAPI CHECKING = T.let(:checking, T.nilable(Symbol)) SAVINGS = T.let(:savings, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -311,8 +313,10 @@ module FinchAPI C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol)) B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -327,8 +331,10 @@ module FinchAPI PARTNERSHIP = T.let(:partnership, T.nilable(Symbol)) COOPERATIVE = T.let(:cooperative, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index 9f8761d3..0834d36f 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -73,8 +73,10 @@ module FinchAPI W4_2020 = :w4_2020 W4_2005 = :w4_2005 - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index bd3fbbf5..96bab8b4 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -76,8 +76,10 @@ module FinchAPI W4_2020 = :w4_2020 W4_2005 = :w4_2005 - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index 526e6ccb..20f15cef 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -6,8 +6,10 @@ module FinchAPI class DocumentRetreiveResponse < FinchAPI::Union abstract! - sig { override.returns([[Symbol, FinchAPI::Models::HRIS::W42020], [Symbol, FinchAPI::Models::HRIS::W42005]]) } - private_class_method def self.variants + class << self + sig { override.returns([[Symbol, FinchAPI::Models::HRIS::W42020], [Symbol, FinchAPI::Models::HRIS::W42005]]) } + private def variants + end end end end diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index 1c8c47d4..014fb705 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -337,8 +337,10 @@ module FinchAPI SEASONAL = T.let(:seasonal, T.nilable(Symbol)) INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -348,8 +350,10 @@ module FinchAPI EMPLOYEE = T.let(:employee, T.nilable(Symbol)) CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -365,8 +369,10 @@ module FinchAPI RETIRED = T.let(:retired, T.nilable(Symbol)) TERMINATED = T.let(:terminated, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index a0c7e992..8edb7881 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -203,8 +203,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -221,8 +223,10 @@ module FinchAPI TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -234,8 +238,10 @@ module FinchAPI OTHER = T.let(:other, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -270,8 +276,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 8f17bf18..86dbb65d 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -283,8 +283,10 @@ module FinchAPI NUMBER_1099 = T.let(:"1099", T.nilable(Symbol)) OTHER = T.let(:other, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -534,8 +536,10 @@ module FinchAPI CHECK = T.let(:check, T.nilable(Symbol)) DIRECT_DEPOSIT = T.let(:direct_deposit, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -668,8 +672,10 @@ module FinchAPI LOCAL = T.let(:local, T.nilable(Symbol)) FICA = T.let(:fica, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -681,8 +687,10 @@ module FinchAPI OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, T.nilable(Symbol)) ONE_TIME_PAYMENT = T.let(:one_time_payment, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 600beb6f..5babe079 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -171,8 +171,10 @@ module FinchAPI DAILY = :daily OTHER = :other - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index ea88e4f7..e1e3bf52 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -123,8 +123,10 @@ module FinchAPI FIXED = T.let(:fixed, T.nilable(Symbol)) PERCENT = T.let(:percent, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -134,8 +136,10 @@ module FinchAPI FIXED = T.let(:fixed, T.nilable(Symbol)) PERCENT = T.let(:percent, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -145,8 +149,10 @@ module FinchAPI INDIVIDUAL = T.let(:individual, T.nilable(Symbol)) FAMILY = T.let(:family, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index f05a7c9b..ef119f7d 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -117,8 +117,10 @@ module FinchAPI EXEMPT = :exempt NON_EXEMPT = :non_exempt - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -129,8 +131,10 @@ module FinchAPI MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate SINGLE = :single - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -140,8 +144,10 @@ module FinchAPI W4_2005 = :w4_2005 - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 43d18748..89f661a1 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -156,8 +156,10 @@ module FinchAPI T.nilable(Symbol) ) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -167,8 +169,10 @@ module FinchAPI W4_2020 = :w4_2020 - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index 5c93bb0e..929d1196 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -74,8 +74,10 @@ module FinchAPI HOURLY = T.let(:hourly, T.nilable(Symbol)) FIXED = T.let(:fixed, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index c4eeb27b..54c34110 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -52,8 +52,10 @@ module FinchAPI INDIVIDUAL_UPDATED = :"individual.updated" INDIVIDUAL_DELETED = :"individual.deleted" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index a8ca675f..ca2e8be0 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -291,8 +291,10 @@ module FinchAPI API_CREDENTIAL = :api_credential OAUTH = :oauth - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -304,8 +306,10 @@ module FinchAPI DEVELOPMENT = :development SANDBOX = :sandbox - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -341,8 +345,10 @@ module FinchAPI PROVIDER = :provider FINCH = :finch - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index 66bf53f7..c0148b8b 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -63,8 +63,10 @@ module FinchAPI JOB_BENEFIT_UPDATE_COMPLETED = :"job.benefit_update.completed" JOB_DATA_SYNC_ALL_COMPLETED = :"job.data_sync_all.completed" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index ed1d0b60..c2f47148 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -153,8 +153,10 @@ module FinchAPI REAUTH_ERROR = :reauth_error PERMISSIONS_ERROR = :permissions_error - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -164,8 +166,10 @@ module FinchAPI DATA_SYNC_ALL = :data_sync_all W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index 05af55bd..5a266557 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -55,8 +55,10 @@ module FinchAPI W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index cbf87fd5..17473673 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -44,8 +44,10 @@ module FinchAPI ERROR = :error COMPLETE = :complete - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/operation_support.rbi b/rbi/lib/finch-api/models/operation_support.rbi index 04720507..332a51fa 100644 --- a/rbi/lib/finch-api/models/operation_support.rbi +++ b/rbi/lib/finch-api/models/operation_support.rbi @@ -10,8 +10,10 @@ module FinchAPI NOT_SUPPORTED_BY_PROVIDER = :not_supported_by_provider CLIENT_ACCESS_ONLY = :client_access_only - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 3393d442..355af816 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -60,8 +60,10 @@ module FinchAPI PAY_STATEMENT_UPDATED = :"pay_statement.updated" PAY_STATEMENT_DELETED = :"pay_statement.deleted" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index bc50e386..6c662cab 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -60,8 +60,10 @@ module FinchAPI PAYMENT_UPDATED = :"payment.updated" PAYMENT_DELETED = :"payment.deleted" - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index 8b0c4239..4e8ea257 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -49,8 +49,10 @@ module FinchAPI DAILY = :daily OTHER = :other - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index 9c9ee374..91cdf0e6 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -72,8 +72,10 @@ module FinchAPI DAILY = :daily OTHER = :other - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 8bda9b52..2a49c456 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -2359,8 +2359,10 @@ module FinchAPI API_CREDENTIAL = :api_credential OAUTH = :oauth - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index 086cbf4d..eb6dafca 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -210,8 +210,10 @@ module FinchAPI CHECKING = T.let(:checking, T.nilable(Symbol)) SAVINGS = T.let(:savings, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -309,8 +311,10 @@ module FinchAPI C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol)) B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -325,8 +329,10 @@ module FinchAPI PARTNERSHIP = T.let(:partnership, T.nilable(Symbol)) COOPERATIVE = T.let(:cooperative, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index 5f86de5e..fb0d25bf 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -204,8 +204,10 @@ module FinchAPI CHECKING = T.let(:checking, T.nilable(Symbol)) SAVINGS = T.let(:savings, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -303,8 +305,10 @@ module FinchAPI C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol)) B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -319,8 +323,10 @@ module FinchAPI PARTNERSHIP = T.let(:partnership, T.nilable(Symbol)) COOPERATIVE = T.let(:cooperative, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 8f2ad1a0..232ae956 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -81,8 +81,10 @@ module FinchAPI OAUTH = :oauth ASSISTED = :assisted - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index 21a1d9ad..10b04f36 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -119,8 +119,10 @@ module FinchAPI OAUTH = :oauth ASSISTED = :assisted - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index 9022f32e..aa3677b7 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -82,8 +82,10 @@ module FinchAPI OAUTH = :oauth ASSISTED = :assisted - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index dc7eb0cd..9b3de50a 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -109,8 +109,10 @@ module FinchAPI OAUTH = :oauth ASSISTED = :assisted - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index a78fca46..454b1b1b 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -98,8 +98,10 @@ module FinchAPI OAUTH = :oauth ASSISTED = :assisted - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index 9b66a4da..7c1f4590 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -461,8 +461,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -502,8 +504,10 @@ module FinchAPI SEASONAL = T.let(:seasonal, T.nilable(Symbol)) INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -513,8 +517,10 @@ module FinchAPI EMPLOYEE = T.let(:employee, T.nilable(Symbol)) CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -530,8 +536,10 @@ module FinchAPI RETIRED = T.let(:retired, T.nilable(Symbol)) TERMINATED = T.let(:terminated, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -550,8 +558,10 @@ module FinchAPI TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -563,8 +573,10 @@ module FinchAPI OTHER = T.let(:other, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -617,8 +629,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index 97e7af6b..65cf6290 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -321,8 +321,10 @@ module FinchAPI SEASONAL = T.let(:seasonal, T.nilable(Symbol)) INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -332,8 +334,10 @@ module FinchAPI EMPLOYEE = T.let(:employee, T.nilable(Symbol)) CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -349,8 +353,10 @@ module FinchAPI RETIRED = T.let(:retired, T.nilable(Symbol)) TERMINATED = T.let(:terminated, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 8b3d459d..fcdebb8b 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -326,8 +326,10 @@ module FinchAPI SEASONAL = T.let(:seasonal, T.nilable(Symbol)) INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -337,8 +339,10 @@ module FinchAPI EMPLOYEE = T.let(:employee, T.nilable(Symbol)) CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -354,8 +358,10 @@ module FinchAPI RETIRED = T.let(:retired, T.nilable(Symbol)) TERMINATED = T.let(:terminated, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index f6d5c048..288e5e78 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -198,8 +198,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -216,8 +218,10 @@ module FinchAPI TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -229,8 +233,10 @@ module FinchAPI OTHER = T.let(:other, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -265,8 +271,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index ff29b8b1..3c2808b6 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -205,8 +205,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -223,8 +225,10 @@ module FinchAPI TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -236,8 +240,10 @@ module FinchAPI OTHER = T.let(:other, T.nilable(Symbol)) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -272,8 +278,10 @@ module FinchAPI WORK = T.let(:work, T.nilable(Symbol)) PERSONAL = T.let(:personal, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index 732117ba..aa5f594d 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -36,8 +36,10 @@ module FinchAPI DATA_SYNC_ALL = :data_sync_all - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index 24b3eae4..77c5869e 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -37,8 +37,10 @@ module FinchAPI PERMISSIONS_ERROR = :permissions_error ERROR = :error - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -47,8 +49,10 @@ module FinchAPI DATA_SYNC_ALL = :data_sync_all - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index 57fdc6e4..b3cdb269 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -400,8 +400,10 @@ module FinchAPI NUMBER_1099 = T.let(:"1099", T.nilable(Symbol)) OTHER = T.let(:other, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -706,8 +708,10 @@ module FinchAPI CHECK = T.let(:check, T.nilable(Symbol)) DIRECT_DEPOSIT = T.let(:direct_deposit, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end @@ -852,8 +856,10 @@ module FinchAPI LOCAL = T.let(:local, T.nilable(Symbol)) FICA = T.let(:fica, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end @@ -865,8 +871,10 @@ module FinchAPI OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, T.nilable(Symbol)) ONE_TIME_PAYMENT = T.let(:one_time_payment, T.nilable(Symbol)) - sig { override.returns(T::Array[Symbol]) } - def self.values + class << self + sig { override.returns(T::Array[Symbol]) } + def values + end end end end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index 432e6317..2c8dda39 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -5,13 +5,15 @@ module FinchAPI class WebhookEvent < FinchAPI::Union abstract! - sig do - override - .returns( - [[NilClass, FinchAPI::Models::AccountUpdateEvent], [NilClass, FinchAPI::Models::JobCompletionEvent], [NilClass, FinchAPI::Models::CompanyEvent], [NilClass, FinchAPI::Models::DirectoryEvent], [NilClass, FinchAPI::Models::EmploymentEvent], [NilClass, FinchAPI::Models::IndividualEvent], [NilClass, FinchAPI::Models::PaymentEvent], [NilClass, FinchAPI::Models::PayStatementEvent]] - ) - end - private_class_method def self.variants + class << self + sig do + override + .returns( + [[NilClass, FinchAPI::Models::AccountUpdateEvent], [NilClass, FinchAPI::Models::JobCompletionEvent], [NilClass, FinchAPI::Models::CompanyEvent], [NilClass, FinchAPI::Models::DirectoryEvent], [NilClass, FinchAPI::Models::EmploymentEvent], [NilClass, FinchAPI::Models::IndividualEvent], [NilClass, FinchAPI::Models::PaymentEvent], [NilClass, FinchAPI::Models::PayStatementEvent]] + ) + end + private def variants + end end end end diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index 3d103567..1f8d891c 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -6,16 +6,18 @@ module FinchAPI {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} end - sig { params(url: URI::Generic).returns(Net::HTTP) } - def self.connect(url) - end + class << self + sig { params(url: URI::Generic).returns(Net::HTTP) } + def connect(url) + end - sig { params(conn: Net::HTTP, deadline: Float).void } - def self.calibrate_socket_timeout(conn, deadline) - end + sig { params(conn: Net::HTTP, deadline: Float).void } + def calibrate_socket_timeout(conn, deadline) + end - sig { params(request: FinchAPI::PooledNetRequester::RequestShape).returns(Net::HTTPGenericRequest) } - def self.build_request(request) + sig { params(request: FinchAPI::PooledNetRequester::RequestShape).returns(Net::HTTPGenericRequest) } + def build_request(request) + end end sig { params(url: URI::Generic, blk: T.proc.params(arg0: Net::HTTP).void).void } diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 8eaae982..14e9e74d 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -6,80 +6,90 @@ module FinchAPI def self.monotonic_secs end - sig { returns(String) } - def self.arch - end + class << self + sig { returns(String) } + def arch + end - sig { returns(String) } - def self.os + sig { returns(String) } + def os + end end - sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) } - def self.primitive?(input) - end + class << self + sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) } + def primitive?(input) + end - sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) } - def self.coerce_boolean(input) - end + sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) } + def coerce_boolean(input) + end - sig { params(input: T.anything).returns(T.nilable(T::Boolean)) } - def self.coerce_boolean!(input) - end + sig { params(input: T.anything).returns(T.nilable(T::Boolean)) } + def coerce_boolean!(input) + end - sig { params(input: T.anything).returns(T.any(Integer, T.anything)) } - def self.coerce_integer(input) - end + sig { params(input: T.anything).returns(T.any(Integer, T.anything)) } + def coerce_integer(input) + end - sig { params(input: T.anything).returns(T.any(Float, T.anything)) } - def self.coerce_float(input) - end + sig { params(input: T.anything).returns(T.any(Float, T.anything)) } + def coerce_float(input) + end - sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) } - def self.coerce_hash(input) + sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) } + def coerce_hash(input) + end end OMIT = T.let(T.anything, T.anything) - sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) } - private_class_method def self.deep_merge_lr(lhs, rhs, concat: false) - end - - sig do - params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean) - .returns(T.anything) - end - def self.deep_merge(*values, sentinel: nil, concat: false) - end - - sig do - params( - data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything), - pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])), - sentinel: T.nilable(T.anything), - blk: T.nilable(T.proc.returns(T.anything)) - ) - .returns(T.nilable(T.anything)) - end - def self.dig(data, pick, sentinel = nil, &blk) - end - - sig { params(uri: URI::Generic).returns(String) } - def self.uri_origin(uri) - end - - sig { params(path: T.any(String, T::Array[String])).returns(String) } - def self.interpolate_path(path) - end - - sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) } - def self.decode_query(query) - end - - sig do - params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) - .returns(T.nilable(String)) - end - def self.encode_query(query) + class << self + sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) } + private def deep_merge_lr(lhs, rhs, concat: false) + end + + sig do + params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean) + .returns(T.anything) + end + def deep_merge(*values, sentinel: nil, concat: false) + end + + sig do + params( + data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything), + pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])), + sentinel: T.nilable(T.anything), + blk: T.nilable(T.proc.returns(T.anything)) + ) + .returns(T.nilable(T.anything)) + end + def dig(data, pick, sentinel = nil, &blk) + end + end + + class << self + sig { params(uri: URI::Generic).returns(String) } + def uri_origin(uri) + end + + sig { params(path: T.any(String, T::Array[String])).returns(String) } + def interpolate_path(path) + end + end + + class << self + sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) } + def decode_query(query) + end + + sig do + params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) + .returns(T.nilable(String)) + end + def encode_query(query) + end end ParsedUriShape = T.type_alias do @@ -92,76 +102,86 @@ module FinchAPI } end - sig { params(url: T.any(URI::Generic, String)).returns(FinchAPI::Util::ParsedUriShape) } - def self.parse_uri(url) - end - - sig { params(parsed: FinchAPI::Util::ParsedUriShape).returns(URI::Generic) } - def self.unparse_uri(parsed) - end - - sig do - params(lhs: FinchAPI::Util::ParsedUriShape, rhs: FinchAPI::Util::ParsedUriShape).returns(URI::Generic) - end - def self.join_parsed_uri(lhs, rhs) - end - - sig do - params( - headers: T::Hash[String, - T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))] - ) - .returns(T::Hash[String, String]) - end - def self.normalized_headers(*headers) - end - - sig { params(io: StringIO, boundary: String, key: T.any(Symbol, String), val: T.anything).void } - private_class_method def self.encode_multipart_formdata(io, boundary:, key:, val:) - end - - sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) } - def self.encode_content(headers, body) - end - - sig do - params( - headers: T.any(T::Hash[String, String], Net::HTTPHeader), - stream: T::Enumerable[String], - suppress_error: T::Boolean - ) - .returns(T.anything) - end - def self.decode_content(headers, stream:, suppress_error: false) - end - - sig { params(enum: T::Enumerable[T.anything], close: T.proc.void).returns(T::Enumerable[T.anything]) } - def self.fused_enum(enum, &close) - end - - sig { params(enum: T.nilable(T::Enumerable[T.anything])).void } - def self.close_fused!(enum) - end - - sig do - params( - enum: T.nilable(T::Enumerable[T.anything]), - blk: T.proc.params(arg0: Enumerator::Yielder).void - ).void - end - def self.chain_fused(enum, &blk) + class << self + sig { params(url: T.any(URI::Generic, String)).returns(FinchAPI::Util::ParsedUriShape) } + def parse_uri(url) + end + + sig { params(parsed: FinchAPI::Util::ParsedUriShape).returns(URI::Generic) } + def unparse_uri(parsed) + end + + sig do + params(lhs: FinchAPI::Util::ParsedUriShape, rhs: FinchAPI::Util::ParsedUriShape).returns(URI::Generic) + end + def join_parsed_uri(lhs, rhs) + end + end + + class << self + sig do + params( + headers: T::Hash[String, + T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))] + ) + .returns(T::Hash[String, String]) + end + def normalized_headers(*headers) + end + end + + class << self + sig { params(io: StringIO, boundary: String, key: T.any(Symbol, String), val: T.anything).void } + private def encode_multipart_formdata(io, boundary:, key:, val:) + end + + sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) } + def encode_content(headers, body) + end + + sig do + params( + headers: T.any(T::Hash[String, String], Net::HTTPHeader), + stream: T::Enumerable[String], + suppress_error: T::Boolean + ) + .returns(T.anything) + end + def decode_content(headers, stream:, suppress_error: false) + end + end + + class << self + sig { params(enum: T::Enumerable[T.anything], close: T.proc.void).returns(T::Enumerable[T.anything]) } + def fused_enum(enum, &close) + end + + sig { params(enum: T.nilable(T::Enumerable[T.anything])).void } + def close_fused!(enum) + end + + sig do + params( + enum: T.nilable(T::Enumerable[T.anything]), + blk: T.proc.params(arg0: Enumerator::Yielder).void + ).void + end + def chain_fused(enum, &blk) + end end SSEMessage = T.type_alias do {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)} end - sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) } - def self.decode_lines(enum) - end + class << self + sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) } + def decode_lines(enum) + end - sig { params(lines: T::Enumerable[String]).returns(FinchAPI::Util::SSEMessage) } - def self.decode_sse(lines) + sig { params(lines: T::Enumerable[String]).returns(FinchAPI::Util::SSEMessage) } + def decode_sse(lines) + end end end end From 327147477a34f2f0bd0e0e6b813a2646493ca2df Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 7 Mar 2025 19:09:18 +0000 Subject: [PATCH 11/67] chore: modify sorbet initializers to better support auto-completion (#13) --- rbi/lib/finch-api/base_client.rbi | 10 +- rbi/lib/finch-api/base_model.rbi | 12 +- rbi/lib/finch-api/client.rbi | 4 +- rbi/lib/finch-api/errors.rbi | 16 +- .../models/access_token_create_params.rbi | 4 +- .../models/account_disconnect_params.rbi | 7 +- .../models/account_introspect_params.rbi | 7 +- .../finch-api/models/account_update_event.rbi | 164 +++++++++--------- .../finch-api/models/base_webhook_event.rbi | 4 +- rbi/lib/finch-api/models/company_event.rbi | 6 +- .../models/connect/session_new_params.rbi | 10 +- .../models/connect/session_new_response.rbi | 4 +- .../connect/session_reauthenticate_params.rbi | 10 +- .../session_reauthenticate_response.rbi | 4 +- .../models/create_access_token_response.rbi | 4 +- rbi/lib/finch-api/models/directory_event.rbi | 8 +- .../finch-api/models/disconnect_response.rbi | 4 +- rbi/lib/finch-api/models/employment_event.rbi | 8 +- .../models/hris/benefit_contribution.rbi | 4 +- .../models/hris/benefit_create_params.rbi | 4 +- .../hris/benefit_features_and_operations.rbi | 8 +- .../models/hris/benefit_list_params.rbi | 7 +- ...benefit_list_supported_benefits_params.rbi | 7 +- .../models/hris/benefit_retrieve_params.rbi | 7 +- .../models/hris/benefit_update_params.rbi | 4 +- .../hris/benefits/enrolled_individual.rbi | 9 +- .../hris/benefits/individual_benefit.rbi | 8 +- .../individual_enroll_many_params.rbi | 20 +-- .../individual_enrolled_ids_params.rbi | 7 +- .../individual_enrolled_ids_response.rbi | 4 +- ...dividual_retrieve_many_benefits_params.rbi | 4 +- .../individual_unenroll_many_params.rbi | 4 +- .../hris/benefits/unenrolled_individual.rbi | 9 +- .../models/hris/benefits_support.rbi | 4 +- rbi/lib/finch-api/models/hris/company.rbi | 28 ++- .../finch-api/models/hris/company_benefit.rbi | 4 +- .../models/hris/company_retrieve_params.rbi | 7 +- .../hris/create_company_benefits_response.rbi | 4 +- .../directory_list_individuals_params.rbi | 4 +- .../models/hris/directory_list_params.rbi | 4 +- .../models/hris/document_list_params.rbi | 4 +- .../models/hris/document_list_response.rbi | 4 +- .../models/hris/document_response.rbi | 4 +- .../models/hris/document_retreive_params.rbi | 7 +- .../finch-api/models/hris/employment_data.rbi | 20 +-- .../models/hris/employment_data_response.rbi | 7 +- .../hris/employment_retrieve_many_params.rbi | 8 +- rbi/lib/finch-api/models/hris/individual.rbi | 12 +- .../models/hris/individual_in_directory.rbi | 20 +-- .../models/hris/individual_response.rbi | 7 +- .../hris/individual_retrieve_many_params.rbi | 12 +- .../finch-api/models/hris/pay_statement.rbi | 63 ++++--- .../models/hris/pay_statement_response.rbi | 7 +- .../hris/pay_statement_response_body.rbi | 4 +- .../pay_statement_retrieve_many_params.rbi | 8 +- rbi/lib/finch-api/models/hris/payment.rbi | 8 +- .../models/hris/payment_list_params.rbi | 4 +- .../models/hris/support_per_benefit_type.rbi | 4 +- .../models/hris/supported_benefit.rbi | 4 +- .../hris/update_company_benefit_response.rbi | 4 +- rbi/lib/finch-api/models/hris/w42005.rbi | 11 +- rbi/lib/finch-api/models/hris/w42020.rbi | 11 +- rbi/lib/finch-api/models/income.rbi | 4 +- rbi/lib/finch-api/models/individual_event.rbi | 8 +- rbi/lib/finch-api/models/introspection.rbi | 16 +- .../finch-api/models/job_completion_event.rbi | 8 +- .../models/jobs/automated_async_job.rbi | 18 +- .../models/jobs/automated_create_params.rbi | 8 +- .../models/jobs/automated_create_response.rbi | 10 +- .../models/jobs/automated_list_params.rbi | 4 +- .../models/jobs/automated_retrieve_params.rbi | 7 +- .../models/jobs/manual_async_job.rbi | 10 +- .../models/jobs/manual_retrieve_params.rbi | 7 +- rbi/lib/finch-api/models/location.rbi | 15 +- rbi/lib/finch-api/models/money.rbi | 4 +- .../models/operation_support_matrix.rbi | 4 +- rbi/lib/finch-api/models/paging.rbi | 4 +- .../finch-api/models/pay_statement_event.rbi | 8 +- rbi/lib/finch-api/models/payment_event.rbi | 8 +- .../models/payroll/pay_group_list_params.rbi | 4 +- .../payroll/pay_group_list_response.rbi | 4 +- .../payroll/pay_group_retrieve_params.rbi | 7 +- .../payroll/pay_group_retrieve_response.rbi | 5 +- rbi/lib/finch-api/models/provider.rbi | 156 ++++++++--------- .../finch-api/models/provider_list_params.rbi | 7 +- .../request_forwarding_forward_params.rbi | 4 +- .../request_forwarding_forward_response.rbi | 8 +- .../models/sandbox/company_update_params.rbi | 28 ++- .../sandbox/company_update_response.rbi | 37 ++-- .../sandbox/connection_create_params.rbi | 10 +- .../sandbox/connection_create_response.rbi | 4 +- .../connections/account_create_params.rbi | 10 +- .../connections/account_create_response.rbi | 14 +- .../connections/account_update_params.rbi | 4 +- .../connections/account_update_response.rbi | 13 +- .../sandbox/directory_create_params.rbi | 32 ++-- .../sandbox/employment_update_params.rbi | 20 +-- .../sandbox/employment_update_response.rbi | 20 +-- .../sandbox/individual_update_params.rbi | 12 +- .../sandbox/individual_update_response.rbi | 12 +- .../models/sandbox/job_create_params.rbi | 11 +- .../models/sandbox/job_create_response.rbi | 10 +- .../jobs/configuration_retrieve_params.rbi | 7 +- .../jobs/configuration_update_params.rbi | 7 +- .../jobs/sandbox_job_configuration.rbi | 4 +- .../models/sandbox/payment_create_params.rbi | 56 +++--- .../sandbox/payment_create_response.rbi | 4 +- rbi/lib/finch-api/pooled_net_requester.rbi | 4 +- rbi/lib/finch-api/request_options.rbi | 4 + rbi/lib/finch-api/resources/access_tokens.rbi | 4 +- rbi/lib/finch-api/resources/account.rbi | 4 +- rbi/lib/finch-api/resources/connect.rbi | 4 +- .../finch-api/resources/connect/sessions.rbi | 4 +- rbi/lib/finch-api/resources/hris.rbi | 4 +- rbi/lib/finch-api/resources/hris/benefits.rbi | 4 +- .../resources/hris/benefits/individuals.rbi | 4 +- rbi/lib/finch-api/resources/hris/company.rbi | 4 +- .../finch-api/resources/hris/directory.rbi | 4 +- .../finch-api/resources/hris/documents.rbi | 4 +- .../finch-api/resources/hris/employments.rbi | 4 +- .../finch-api/resources/hris/individuals.rbi | 4 +- .../resources/hris/pay_statements.rbi | 4 +- rbi/lib/finch-api/resources/hris/payments.rbi | 4 +- rbi/lib/finch-api/resources/jobs.rbi | 4 +- .../finch-api/resources/jobs/automated.rbi | 4 +- rbi/lib/finch-api/resources/jobs/manual.rbi | 4 +- rbi/lib/finch-api/resources/payroll.rbi | 4 +- .../resources/payroll/pay_groups.rbi | 4 +- rbi/lib/finch-api/resources/providers.rbi | 4 +- .../resources/request_forwarding.rbi | 4 +- rbi/lib/finch-api/resources/sandbox.rbi | 4 +- .../finch-api/resources/sandbox/company.rbi | 4 +- .../resources/sandbox/connections.rbi | 4 +- .../sandbox/connections/accounts.rbi | 4 +- .../finch-api/resources/sandbox/directory.rbi | 4 +- .../resources/sandbox/employment.rbi | 4 +- .../resources/sandbox/individual.rbi | 4 +- rbi/lib/finch-api/resources/sandbox/jobs.rbi | 4 +- .../resources/sandbox/jobs/configuration.rbi | 4 +- .../finch-api/resources/sandbox/payment.rbi | 4 +- rbi/lib/finch-api/resources/webhooks.rbi | 4 +- sig/finch-api/request_options.rbs | 4 + 142 files changed, 725 insertions(+), 748 deletions(-) diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index 087b56a4..e0384f35 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -45,13 +45,13 @@ module FinchAPI class << self sig { params(req: FinchAPI::BaseClient::RequestComponentsShape).void } - def self.validate!(req) + def validate!(req) end sig do params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean) end - def self.should_retry?(status, headers:) + def should_retry?(status, headers:) end sig do @@ -62,7 +62,7 @@ module FinchAPI ) .returns(FinchAPI::BaseClient::RequestInputShape) end - def self.follow_redirect(request, status:, response_headers:) + def follow_redirect(request, status:, response_headers:) end end @@ -85,9 +85,9 @@ module FinchAPI T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))], idempotency_header: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( base_url:, timeout: 0.0, max_retries: 0, diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index c74ba900..011d1cef 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -279,9 +279,9 @@ module FinchAPI ), spec: T::Hash[Symbol, T.anything] ) - .void + .returns(T.attached_class) end - def initialize(type_info, spec = {}) + def self.new(type_info, spec = {}) end end @@ -335,9 +335,9 @@ module FinchAPI ), spec: T::Hash[Symbol, T.anything] ) - .void + .returns(T.attached_class) end - def initialize(type_info, spec = {}) + def self.new(type_info, spec = {}) end end @@ -479,8 +479,8 @@ module FinchAPI def deconstruct_keys(keys) end - sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).void } - def initialize(data = {}) + sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(T.attached_class) } + def self.new(data = {}) end sig { returns(String) } diff --git a/rbi/lib/finch-api/client.rbi b/rbi/lib/finch-api/client.rbi index c8e4dd05..5eb4a38f 100644 --- a/rbi/lib/finch-api/client.rbi +++ b/rbi/lib/finch-api/client.rbi @@ -85,9 +85,9 @@ module FinchAPI initial_retry_delay: Float, max_retry_delay: Float ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( base_url: nil, access_token: nil, client_id: ENV["FINCH_CLIENT_ID"], diff --git a/rbi/lib/finch-api/errors.rbi b/rbi/lib/finch-api/errors.rbi index da720877..5e66d661 100644 --- a/rbi/lib/finch-api/errors.rbi +++ b/rbi/lib/finch-api/errors.rbi @@ -32,9 +32,9 @@ module FinchAPI response: NilClass, message: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil) + def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil) end end @@ -56,9 +56,9 @@ module FinchAPI response: NilClass, message: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.") + def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.") end end @@ -72,9 +72,9 @@ module FinchAPI response: NilClass, message: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.") + def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.") end end @@ -106,9 +106,9 @@ module FinchAPI response: NilClass, message: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize(url:, status:, body:, request:, response:, message: nil) + def self.new(url:, status:, body:, request:, response:, message: nil) end end diff --git a/rbi/lib/finch-api/models/access_token_create_params.rbi b/rbi/lib/finch-api/models/access_token_create_params.rbi index 690fa5a9..31126cb9 100644 --- a/rbi/lib/finch-api/models/access_token_create_params.rbi +++ b/rbi/lib/finch-api/models/access_token_create_params.rbi @@ -46,9 +46,9 @@ module FinchAPI redirect_uri: String, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {}) + def self.new(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/account_disconnect_params.rbi b/rbi/lib/finch-api/models/account_disconnect_params.rbi index 1eb51817..3b22ac66 100644 --- a/rbi/lib/finch-api/models/account_disconnect_params.rbi +++ b/rbi/lib/finch-api/models/account_disconnect_params.rbi @@ -6,8 +6,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/account_introspect_params.rbi b/rbi/lib/finch-api/models/account_introspect_params.rbi index b3aa30db..c7d35ad8 100644 --- a/rbi/lib/finch-api/models/account_introspect_params.rbi +++ b/rbi/lib/finch-api/models/account_introspect_params.rbi @@ -6,8 +6,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index b9e76cd4..503fcb3e 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -19,8 +19,8 @@ module FinchAPI def event_type=(_) end - sig { params(data: FinchAPI::Models::AccountUpdateEvent::Data, event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig { params(data: FinchAPI::Models::AccountUpdateEvent::Data, event_type: Symbol).returns(T.attached_class) } + def self.new(data: nil, event_type: nil) end sig { override.returns({data: FinchAPI::Models::AccountUpdateEvent::Data, event_type: Symbol}) } @@ -52,9 +52,9 @@ module FinchAPI authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, status: Symbol ) - .void + .returns(T.attached_class) end - def initialize(authentication_method:, status:) + def self.new(authentication_method:, status:) end sig do @@ -103,9 +103,9 @@ module FinchAPI supported_fields: T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields), type: Symbol ) - .void + .returns(T.attached_class) end - def initialize(benefits_support: nil, supported_fields: nil, type: nil) + def self.new(benefits_support: nil, supported_fields: nil, type: nil) end sig do @@ -237,9 +237,9 @@ module FinchAPI pay_statement: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, payment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( company: nil, directory: nil, employment: nil, @@ -404,9 +404,9 @@ module FinchAPI primary_email: T::Boolean, primary_phone_number: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, accounts: nil, departments: nil, @@ -487,15 +487,9 @@ module FinchAPI institution_name: T::Boolean, routing_number: T::Boolean ) - .void - end - def initialize( - account_name: nil, - account_number: nil, - account_type: nil, - institution_name: nil, - routing_number: nil - ) + .returns(T.attached_class) + end + def self.new(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil) end sig do @@ -549,9 +543,9 @@ module FinchAPI name: T::Boolean, parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) - .void + .returns(T.attached_class) end - def initialize(name: nil, parent: nil) + def self.new(name: nil, parent: nil) end sig do @@ -575,8 +569,8 @@ module FinchAPI def name=(_) end - sig { params(name: T::Boolean).void } - def initialize(name: nil) + sig { params(name: T::Boolean).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T::Boolean}) } @@ -602,8 +596,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T::Boolean, type: T::Boolean).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } @@ -669,9 +663,9 @@ module FinchAPI postal_code: T::Boolean, state: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) end sig do @@ -740,9 +734,9 @@ module FinchAPI individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging ) - .void + .returns(T.attached_class) end - def initialize(individuals: nil, paging: nil) + def self.new(individuals: nil, paging: nil) end sig do @@ -837,17 +831,9 @@ module FinchAPI manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, middle_name: T::Boolean ) - .void - end - def initialize( - id: nil, - department: nil, - first_name: nil, - is_active: nil, - last_name: nil, - manager: nil, - middle_name: nil - ) + .returns(T.attached_class) + end + def self.new(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil) end sig do @@ -876,8 +862,8 @@ module FinchAPI def id=(_) end - sig { params(id: T::Boolean).void } - def initialize(id: nil) + sig { params(id: T::Boolean).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: T::Boolean}) } @@ -903,8 +889,8 @@ module FinchAPI def offset=(_) end - sig { params(count: T::Boolean, offset: T::Boolean).void } - def initialize(count: nil, offset: nil) + sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } + def self.new(count: nil, offset: nil) end sig { override.returns({count: T::Boolean, offset: T::Boolean}) } @@ -1135,9 +1121,9 @@ module FinchAPI start_date: T::Boolean, title: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, class_code: nil, custom_fields: nil, @@ -1194,8 +1180,8 @@ module FinchAPI def name=(_) end - sig { params(name: T::Boolean).void } - def initialize(name: nil) + sig { params(name: T::Boolean).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T::Boolean}) } @@ -1220,8 +1206,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T::Boolean, type: T::Boolean).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } @@ -1254,8 +1240,10 @@ module FinchAPI def unit=(_) end - sig { params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).void } - def initialize(amount: nil, currency: nil, unit: nil) + sig do + params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).returns(T.attached_class) + end + def self.new(amount: nil, currency: nil, unit: nil) end sig { override.returns({amount: T::Boolean, currency: T::Boolean, unit: T::Boolean}) } @@ -1321,9 +1309,9 @@ module FinchAPI postal_code: T::Boolean, state: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) end sig do @@ -1352,8 +1340,8 @@ module FinchAPI def id=(_) end - sig { params(id: T::Boolean).void } - def initialize(id: nil) + sig { params(id: T::Boolean).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: T::Boolean}) } @@ -1522,9 +1510,9 @@ module FinchAPI residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, ssn: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, dob: nil, emails: nil, @@ -1581,8 +1569,8 @@ module FinchAPI def type=(_) end - sig { params(data: T::Boolean, type: T::Boolean).void } - def initialize(data: nil, type: nil) + sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: T::Boolean, type: T::Boolean}) } @@ -1607,8 +1595,8 @@ module FinchAPI def type=(_) end - sig { params(data: T::Boolean, type: T::Boolean).void } - def initialize(data: nil, type: nil) + sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: T::Boolean, type: T::Boolean}) } @@ -1674,9 +1662,9 @@ module FinchAPI postal_code: T::Boolean, state: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) end sig do @@ -1736,9 +1724,10 @@ module FinchAPI individual_ids: T::Boolean, name: T::Boolean, pay_frequencies: T::Boolean - ).void + ) + .returns(T.attached_class) end - def initialize(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil) + def self.new(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil) end sig do @@ -1802,9 +1791,9 @@ module FinchAPI paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) - .void + .returns(T.attached_class) end - def initialize(paging: nil, pay_statements: nil) + def self.new(paging: nil, pay_statements: nil) end sig do @@ -1836,8 +1825,8 @@ module FinchAPI def offset=(_) end - sig { params(count: T::Boolean, offset: T::Boolean).void } - def initialize(count:, offset:) + sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } + def self.new(count:, offset:) end sig { override.returns({count: T::Boolean, offset: T::Boolean}) } @@ -1991,9 +1980,9 @@ module FinchAPI total_hours: T::Boolean, type: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( earnings: nil, employee_deductions: nil, employer_contributions: nil, @@ -2061,9 +2050,10 @@ module FinchAPI end sig do - params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean).void + params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean) + .returns(T.attached_class) end - def initialize(amount: nil, currency: nil, name: nil, type: nil) + def self.new(amount: nil, currency: nil, name: nil, type: nil) end sig do @@ -2129,9 +2119,9 @@ module FinchAPI pre_tax: T::Boolean, type: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil) + def self.new(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil) end sig do @@ -2175,8 +2165,14 @@ module FinchAPI def name=(_) end - sig { params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean).void } - def initialize(amount: nil, currency: nil, name: nil) + sig do + params( + amount: T::Boolean, + currency: T::Boolean, + name: T::Boolean + ).returns(T.attached_class) + end + def self.new(amount: nil, currency: nil, name: nil) end sig { override.returns({amount: T::Boolean, currency: T::Boolean, name: T::Boolean}) } @@ -2233,9 +2229,9 @@ module FinchAPI name: T::Boolean, type: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, currency: nil, employer: nil, name: nil, type: nil) + def self.new(amount: nil, currency: nil, employer: nil, name: nil, type: nil) end sig do @@ -2381,9 +2377,9 @@ module FinchAPI pay_group_ids: T::Boolean, pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, company_debit: nil, debit_date: nil, @@ -2438,8 +2434,8 @@ module FinchAPI def start_date=(_) end - sig { params(end_date: T::Boolean, start_date: T::Boolean).void } - def initialize(end_date: nil, start_date: nil) + sig { params(end_date: T::Boolean, start_date: T::Boolean).returns(T.attached_class) } + def self.new(end_date: nil, start_date: nil) end sig { override.returns({end_date: T::Boolean, start_date: T::Boolean}) } diff --git a/rbi/lib/finch-api/models/base_webhook_event.rbi b/rbi/lib/finch-api/models/base_webhook_event.rbi index dbf35f17..e37f3e40 100644 --- a/rbi/lib/finch-api/models/base_webhook_event.rbi +++ b/rbi/lib/finch-api/models/base_webhook_event.rbi @@ -27,8 +27,8 @@ module FinchAPI def connection_id=(_) end - sig { params(account_id: String, company_id: String, connection_id: String).void } - def initialize(account_id:, company_id:, connection_id: nil) + sig { params(account_id: String, company_id: String, connection_id: String).returns(T.attached_class) } + def self.new(account_id:, company_id:, connection_id: nil) end sig { override.returns({account_id: String, company_id: String, connection_id: String}) } diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index b6b760f1..5096e2e0 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -21,8 +21,10 @@ module FinchAPI def event_type=(_) end - sig { params(data: T.nilable(T::Hash[Symbol, T.anything]), event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig do + params(data: T.nilable(T::Hash[Symbol, T.anything]), event_type: Symbol).returns(T.attached_class) + end + def self.new(data: nil, event_type: nil) end sig { override.returns({data: T.nilable(T::Hash[Symbol, T.anything]), event_type: Symbol}) } diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 25c730e0..98f04cdb 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -95,9 +95,9 @@ module FinchAPI sandbox: T.nilable(Symbol), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( customer_id:, customer_name:, products:, @@ -167,8 +167,10 @@ module FinchAPI def provider=(_) end - sig { params(auth_method: T.nilable(Symbol), provider: T.nilable(String)).void } - def initialize(auth_method: nil, provider: nil) + sig do + params(auth_method: T.nilable(Symbol), provider: T.nilable(String)).returns(T.attached_class) + end + def self.new(auth_method: nil, provider: nil) end sig { override.returns({auth_method: T.nilable(Symbol), provider: T.nilable(String)}) } diff --git a/rbi/lib/finch-api/models/connect/session_new_response.rbi b/rbi/lib/finch-api/models/connect/session_new_response.rbi index 9dbeb488..c22e5851 100644 --- a/rbi/lib/finch-api/models/connect/session_new_response.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_response.rbi @@ -20,8 +20,8 @@ module FinchAPI def session_id=(_) end - sig { params(connect_url: String, session_id: String).void } - def initialize(connect_url:, session_id:) + sig { params(connect_url: String, session_id: String).returns(T.attached_class) } + def self.new(connect_url:, session_id:) end sig { override.returns({connect_url: String, session_id: String}) } diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 6092f209..32f04917 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -47,15 +47,9 @@ module FinchAPI redirect_uri: T.nilable(String), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize( - connection_id:, - minutes_to_expire: nil, - products: nil, - redirect_uri: nil, - request_options: {} - ) + def self.new(connection_id:, minutes_to_expire: nil, products: nil, redirect_uri: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi index e7344c65..f7c2f733 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi @@ -20,8 +20,8 @@ module FinchAPI def session_id=(_) end - sig { params(connect_url: String, session_id: String).void } - def initialize(connect_url:, session_id:) + sig { params(connect_url: String, session_id: String).returns(T.attached_class) } + def self.new(connect_url:, session_id:) end sig { override.returns({connect_url: String, session_id: String}) } diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index e791131d..a3945ba9 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -96,9 +96,9 @@ module FinchAPI customer_id: T.nilable(String), token_type: String ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( access_token:, account_id:, client_type:, diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index 28a572f2..b9d57c97 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -19,8 +19,8 @@ module FinchAPI def event_type=(_) end - sig { params(data: FinchAPI::Models::DirectoryEvent::Data, event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig { params(data: FinchAPI::Models::DirectoryEvent::Data, event_type: Symbol).returns(T.attached_class) } + def self.new(data: nil, event_type: nil) end sig { override.returns({data: FinchAPI::Models::DirectoryEvent::Data, event_type: Symbol}) } @@ -36,8 +36,8 @@ module FinchAPI def individual_id=(_) end - sig { params(individual_id: String).void } - def initialize(individual_id: nil) + sig { params(individual_id: String).returns(T.attached_class) } + def self.new(individual_id: nil) end sig { override.returns({individual_id: String}) } diff --git a/rbi/lib/finch-api/models/disconnect_response.rbi b/rbi/lib/finch-api/models/disconnect_response.rbi index 16d35b15..fd0919b1 100644 --- a/rbi/lib/finch-api/models/disconnect_response.rbi +++ b/rbi/lib/finch-api/models/disconnect_response.rbi @@ -11,8 +11,8 @@ module FinchAPI def status=(_) end - sig { params(status: String).void } - def initialize(status:) + sig { params(status: String).returns(T.attached_class) } + def self.new(status:) end sig { override.returns({status: String}) } diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index fa9a3daa..9e8d92ac 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -19,8 +19,8 @@ module FinchAPI def event_type=(_) end - sig { params(data: FinchAPI::Models::EmploymentEvent::Data, event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig { params(data: FinchAPI::Models::EmploymentEvent::Data, event_type: Symbol).returns(T.attached_class) } + def self.new(data: nil, event_type: nil) end sig { override.returns({data: FinchAPI::Models::EmploymentEvent::Data, event_type: Symbol}) } @@ -36,8 +36,8 @@ module FinchAPI def individual_id=(_) end - sig { params(individual_id: String).void } - def initialize(individual_id: nil) + sig { params(individual_id: String).returns(T.attached_class) } + def self.new(individual_id: nil) end sig { override.returns({individual_id: String}) } diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index 0765173a..05db919f 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -20,8 +20,8 @@ module FinchAPI def type=(_) end - sig { params(amount: T.nilable(Integer), type: T.nilable(Symbol)).void } - def initialize(amount: nil, type: nil) + sig { params(amount: T.nilable(Integer), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(amount: nil, type: nil) end sig { override.returns({amount: T.nilable(Integer), type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi index 23bcb010..8db9cd4f 100644 --- a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi @@ -38,9 +38,9 @@ module FinchAPI type: T.nilable(Symbol), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(description: nil, frequency: nil, type: nil, request_options: {}) + def self.new(description: nil, frequency: nil, type: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 9e7c330d..51a97da6 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -31,9 +31,9 @@ module FinchAPI supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType ) - .void + .returns(T.attached_class) end - def initialize(supported_features: nil, supported_operations: nil) + def self.new(supported_features: nil, supported_operations: nil) end sig do @@ -121,9 +121,9 @@ module FinchAPI frequencies: T::Array[T.nilable(Symbol)], hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( annual_maximum: nil, catch_up: nil, company_contribution: nil, diff --git a/rbi/lib/finch-api/models/hris/benefit_list_params.rbi b/rbi/lib/finch-api/models/hris/benefit_list_params.rbi index 90e4e917..0d10d271 100644 --- a/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_list_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi b/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi index a37943fb..413b3305 100644 --- a/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi b/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi index 7219ab5d..37dbfb13 100644 --- a/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi index 58f79cb6..f18a1660 100644 --- a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi @@ -23,9 +23,9 @@ module FinchAPI T::Hash[Symbol, T.anything] ) ) - .void + .returns(T.attached_class) end - def initialize(description: nil, request_options: {}) + def self.new(description: nil, request_options: {}) end sig { override.returns({description: String, request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index bbeb0014..e196b50c 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -38,9 +38,9 @@ module FinchAPI code: Integer, individual_id: String ) - .void + .returns(T.attached_class) end - def initialize(body: nil, code: nil, individual_id: nil) + def self.new(body: nil, code: nil, individual_id: nil) end sig do @@ -78,9 +78,10 @@ module FinchAPI end sig do - params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String)).void + params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String)) + .returns(T.attached_class) end - def initialize(finch_code: nil, message: nil, name: nil) + def self.new(finch_code: nil, message: nil, name: nil) end sig do diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index 6aa7bbf1..f33dff24 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -40,9 +40,9 @@ module FinchAPI code: Integer, individual_id: String ) - .void + .returns(T.attached_class) end - def initialize(body: nil, code: nil, individual_id: nil) + def self.new(body: nil, code: nil, individual_id: nil) end sig do @@ -109,9 +109,9 @@ module FinchAPI employee_deduction: T.nilable(FinchAPI::Models::HRIS::BenefitContribution), hsa_contribution_limit: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( annual_maximum: nil, catch_up: nil, company_contribution: nil, diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index 7d589852..7606de81 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -24,9 +24,9 @@ module FinchAPI individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(individuals: nil, request_options: {}) + def self.new(individuals: nil, request_options: {}) end sig do @@ -70,9 +70,9 @@ module FinchAPI configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, individual_id: String ) - .void + .returns(T.attached_class) end - def initialize(configuration: nil, individual_id: nil) + def self.new(configuration: nil, individual_id: nil) end sig do @@ -162,9 +162,9 @@ module FinchAPI company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( annual_contribution_limit: nil, annual_maximum: nil, catch_up: nil, @@ -218,8 +218,8 @@ module FinchAPI def type=(_) end - sig { params(amount: Integer, type: Symbol).void } - def initialize(amount: nil, type: nil) + sig { params(amount: Integer, type: Symbol).returns(T.attached_class) } + def self.new(amount: nil, type: nil) end sig { override.returns({amount: Integer, type: Symbol}) } @@ -257,8 +257,8 @@ module FinchAPI def type=(_) end - sig { params(amount: Integer, type: Symbol).void } - def initialize(amount: nil, type: nil) + sig { params(amount: Integer, type: Symbol).returns(T.attached_class) } + def self.new(amount: nil, type: nil) end sig { override.returns({amount: Integer, type: Symbol}) } diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi index 9bc56fac..47a06df2 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi @@ -8,8 +8,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi index 403bd593..7249275b 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi @@ -21,8 +21,8 @@ module FinchAPI def individual_ids=(_) end - sig { params(benefit_id: String, individual_ids: T::Array[String]).void } - def initialize(benefit_id:, individual_ids:) + sig { params(benefit_id: String, individual_ids: T::Array[String]).returns(T.attached_class) } + def self.new(benefit_id:, individual_ids:) end sig { override.returns({benefit_id: String, individual_ids: T::Array[String]}) } diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi index 8f9e56fa..7260acb8 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi @@ -21,9 +21,9 @@ module FinchAPI individual_ids: String, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(individual_ids: nil, request_options: {}) + def self.new(individual_ids: nil, request_options: {}) end sig { override.returns({individual_ids: String, request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi index 54f6a304..9cd88cf3 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi @@ -21,9 +21,9 @@ module FinchAPI individual_ids: T::Array[String], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(individual_ids: nil, request_options: {}) + def self.new(individual_ids: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi index dd3d1062..a7449d81 100644 --- a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi @@ -38,9 +38,9 @@ module FinchAPI code: Integer, individual_id: String ) - .void + .returns(T.attached_class) end - def initialize(body: nil, code: nil, individual_id: nil) + def self.new(body: nil, code: nil, individual_id: nil) end sig do @@ -78,9 +78,10 @@ module FinchAPI end sig do - params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String)).void + params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String)) + .returns(T.attached_class) end - def initialize(finch_code: nil, message: nil, name: nil) + def self.new(finch_code: nil, message: nil, name: nil) end sig do diff --git a/rbi/lib/finch-api/models/hris/benefits_support.rbi b/rbi/lib/finch-api/models/hris/benefits_support.rbi index 4bd2a008..8089dc9a 100644 --- a/rbi/lib/finch-api/models/hris/benefits_support.rbi +++ b/rbi/lib/finch-api/models/hris/benefits_support.rbi @@ -151,9 +151,9 @@ module FinchAPI simple: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), simple_ira: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( commuter: nil, custom_post_tax: nil, custom_pre_tax: nil, diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 3b958c38..520edb5d 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -100,9 +100,9 @@ module FinchAPI primary_email: T.nilable(String), primary_phone_number: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id:, accounts:, departments:, @@ -183,15 +183,9 @@ module FinchAPI institution_name: T.nilable(String), routing_number: T.nilable(String) ) - .void - end - def initialize( - account_name: nil, - account_number: nil, - account_type: nil, - institution_name: nil, - routing_number: nil - ) + .returns(T.attached_class) + end + def self.new(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil) end sig do @@ -248,9 +242,9 @@ module FinchAPI name: T.nilable(String), parent: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent) ) - .void + .returns(T.attached_class) end - def initialize(name: nil, parent: nil) + def self.new(name: nil, parent: nil) end sig do @@ -271,8 +265,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -298,8 +292,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/hris/company_benefit.rbi b/rbi/lib/finch-api/models/hris/company_benefit.rbi index f677e92b..28058d3d 100644 --- a/rbi/lib/finch-api/models/hris/company_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/company_benefit.rbi @@ -43,9 +43,9 @@ module FinchAPI frequency: T.nilable(Symbol), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(benefit_id:, description:, frequency:, type:) + def self.new(benefit_id:, description:, frequency:, type:) end sig do diff --git a/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi b/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi index ebbd2c49..77c4d11f 100644 --- a/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi b/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi index c397c8b7..6ca84f99 100644 --- a/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +++ b/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi @@ -12,8 +12,8 @@ module FinchAPI def benefit_id=(_) end - sig { params(benefit_id: String).void } - def initialize(benefit_id:) + sig { params(benefit_id: String).returns(T.attached_class) } + def self.new(benefit_id:) end sig { override.returns({benefit_id: String}) } diff --git a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi index 1af6722d..630e3552 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi @@ -29,9 +29,9 @@ module FinchAPI offset: Integer, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(limit: nil, offset: nil, request_options: {}) + def self.new(limit: nil, offset: nil, request_options: {}) end sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/directory_list_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_params.rbi index f8dc2476..014aaaba 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_params.rbi @@ -29,9 +29,9 @@ module FinchAPI offset: Integer, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(limit: nil, offset: nil, request_options: {}) + def self.new(limit: nil, offset: nil, request_options: {}) end sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index 0834d36f..8eef50a0 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -47,9 +47,9 @@ module FinchAPI types: T::Array[Symbol], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) + def self.new(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/hris/document_list_response.rbi b/rbi/lib/finch-api/models/hris/document_list_response.rbi index 29a4abae..5897ce5c 100644 --- a/rbi/lib/finch-api/models/hris/document_list_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_response.rbi @@ -25,9 +25,9 @@ module FinchAPI sig do params(documents: T::Array[FinchAPI::Models::HRIS::DocumentResponse], paging: FinchAPI::Models::Paging) - .void + .returns(T.attached_class) end - def initialize(documents:, paging:) + def self.new(documents:, paging:) end sig do diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index 96bab8b4..270f5dd7 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -52,9 +52,9 @@ module FinchAPI url: String, year: T.nilable(Float) ) - .void + .returns(T.attached_class) end - def initialize(id: nil, individual_id: nil, type: nil, url: nil, year: nil) + def self.new(id: nil, individual_id: nil, type: nil, url: nil, year: nil) end sig do diff --git a/rbi/lib/finch-api/models/hris/document_retreive_params.rbi b/rbi/lib/finch-api/models/hris/document_retreive_params.rbi index ec5025f8..a2bc8af2 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index 014fb705..5bb0c4bc 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -202,9 +202,9 @@ module FinchAPI title: T.nilable(String), work_id: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, class_code: nil, custom_fields: nil, @@ -275,8 +275,8 @@ module FinchAPI def value=(_) end - sig { params(name: String, value: T.anything).void } - def initialize(name: nil, value: nil) + sig { params(name: String, value: T.anything).returns(T.attached_class) } + def self.new(name: nil, value: nil) end sig { override.returns({name: String, value: T.anything}) } @@ -293,8 +293,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -319,8 +319,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } @@ -385,8 +385,8 @@ module FinchAPI def id=(_) end - sig { params(id: String).void } - def initialize(id: nil) + sig { params(id: String).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: String}) } diff --git a/rbi/lib/finch-api/models/hris/employment_data_response.rbi b/rbi/lib/finch-api/models/hris/employment_data_response.rbi index 90a1c460..c83bf785 100644 --- a/rbi/lib/finch-api/models/hris/employment_data_response.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data_response.rbi @@ -28,8 +28,11 @@ module FinchAPI def individual_id=(_) end - sig { params(body: FinchAPI::Models::HRIS::EmploymentData, code: Integer, individual_id: String).void } - def initialize(body: nil, code: nil, individual_id: nil) + sig do + params(body: FinchAPI::Models::HRIS::EmploymentData, code: Integer, individual_id: String) + .returns(T.attached_class) + end + def self.new(body: nil, code: nil, individual_id: nil) end sig { override.returns({body: FinchAPI::Models::HRIS::EmploymentData, code: Integer, individual_id: String}) } diff --git a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi index c5609a7c..43596013 100644 --- a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi @@ -23,9 +23,9 @@ module FinchAPI requests: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(requests:, request_options: {}) + def self.new(requests:, request_options: {}) end sig do @@ -49,8 +49,8 @@ module FinchAPI def individual_id=(_) end - sig { params(individual_id: String).void } - def initialize(individual_id:) + sig { params(individual_id: String).returns(T.attached_class) } + def self.new(individual_id:) end sig { override.returns({individual_id: String}) } diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index 8edb7881..a3885d51 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -130,9 +130,9 @@ module FinchAPI residence: T.nilable(FinchAPI::Models::Location), ssn: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, dob: nil, emails: nil, @@ -189,8 +189,8 @@ module FinchAPI def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: String, type: T.nilable(Symbol)}) } @@ -262,8 +262,8 @@ module FinchAPI def type=(_) end - sig { params(data: T.nilable(String), type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: T.nilable(String), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: T.nilable(String), type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi index 1ca71c73..1fabaa08 100644 --- a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +++ b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi @@ -76,17 +76,9 @@ module FinchAPI manager: T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager), middle_name: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( - id: nil, - department: nil, - first_name: nil, - is_active: nil, - last_name: nil, - manager: nil, - middle_name: nil - ) + def self.new(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil) end sig do @@ -115,8 +107,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -133,8 +125,8 @@ module FinchAPI def id=(_) end - sig { params(id: String).void } - def initialize(id: nil) + sig { params(id: String).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: String}) } diff --git a/rbi/lib/finch-api/models/hris/individual_response.rbi b/rbi/lib/finch-api/models/hris/individual_response.rbi index 3f4d6195..4dfb5812 100644 --- a/rbi/lib/finch-api/models/hris/individual_response.rbi +++ b/rbi/lib/finch-api/models/hris/individual_response.rbi @@ -28,8 +28,11 @@ module FinchAPI def individual_id=(_) end - sig { params(body: FinchAPI::Models::HRIS::Individual, code: Integer, individual_id: String).void } - def initialize(body: nil, code: nil, individual_id: nil) + sig do + params(body: FinchAPI::Models::HRIS::Individual, code: Integer, individual_id: String) + .returns(T.attached_class) + end + def self.new(body: nil, code: nil, individual_id: nil) end sig { override.returns({body: FinchAPI::Models::HRIS::Individual, code: Integer, individual_id: String}) } diff --git a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi index b0d55cf0..1b781b09 100644 --- a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi @@ -35,9 +35,9 @@ module FinchAPI requests: T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(options: nil, requests: nil, request_options: {}) + def self.new(options: nil, requests: nil, request_options: {}) end sig do @@ -62,8 +62,8 @@ module FinchAPI def include=(_) end - sig { params(include: T::Array[String]).void } - def initialize(include: nil) + sig { params(include: T::Array[String]).returns(T.attached_class) } + def self.new(include: nil) end sig { override.returns({include: T::Array[String]}) } @@ -80,8 +80,8 @@ module FinchAPI def individual_id=(_) end - sig { params(individual_id: String).void } - def initialize(individual_id: nil) + sig { params(individual_id: String).returns(T.attached_class) } + def self.new(individual_id: nil) end sig { override.returns({individual_id: String}) } diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 86dbb65d..a786da8f 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -109,9 +109,9 @@ module FinchAPI total_hours: T.nilable(Float), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( earnings: nil, employee_deductions: nil, employer_contributions: nil, @@ -206,9 +206,9 @@ module FinchAPI name: T.nilable(String), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil) end sig do @@ -239,8 +239,11 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata).void } - def initialize(metadata: nil) + sig do + params(metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata) + .returns(T.attached_class) + end + def self.new(metadata: nil) end sig { override.returns({metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata}) } @@ -256,8 +259,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } @@ -352,9 +355,9 @@ module FinchAPI pre_tax: T.nilable(T::Boolean), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) end sig do @@ -385,8 +388,11 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata).void } - def initialize(metadata: nil) + sig do + params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata) + .returns(T.attached_class) + end + def self.new(metadata: nil) end sig do @@ -404,8 +410,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } @@ -467,9 +473,9 @@ module FinchAPI name: T.nilable(String), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, name: nil, type: nil) end sig do @@ -499,8 +505,11 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata).void } - def initialize(metadata: nil) + sig do + params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata) + .returns(T.attached_class) + end + def self.new(metadata: nil) end sig do @@ -519,8 +528,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } @@ -604,9 +613,9 @@ module FinchAPI name: T.nilable(String), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil) end sig do @@ -637,8 +646,10 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata).void } - def initialize(metadata: nil) + sig do + params(metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata).returns(T.attached_class) + end + def self.new(metadata: nil) end sig { override.returns({metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata}) } @@ -654,8 +665,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi index 53e22ac0..dc4ecd14 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi @@ -31,8 +31,11 @@ module FinchAPI def payment_id=(_) end - sig { params(body: FinchAPI::Models::HRIS::PayStatementResponseBody, code: Integer, payment_id: String).void } - def initialize(body: nil, code: nil, payment_id: nil) + sig do + params(body: FinchAPI::Models::HRIS::PayStatementResponseBody, code: Integer, payment_id: String) + .returns(T.attached_class) + end + def self.new(body: nil, code: nil, payment_id: nil) end sig do diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi index 7a7a8f37..dc41c553 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi @@ -25,9 +25,9 @@ module FinchAPI sig do params(paging: FinchAPI::Models::Paging, pay_statements: T::Array[FinchAPI::Models::HRIS::PayStatement]) - .void + .returns(T.attached_class) end - def initialize(paging: nil, pay_statements: nil) + def self.new(paging: nil, pay_statements: nil) end sig do diff --git a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi index fae3af84..a899aa93 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi @@ -23,9 +23,9 @@ module FinchAPI requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(requests:, request_options: {}) + def self.new(requests:, request_options: {}) end sig do @@ -65,8 +65,8 @@ module FinchAPI def offset=(_) end - sig { params(payment_id: String, limit: Integer, offset: Integer).void } - def initialize(payment_id:, limit: nil, offset: nil) + sig { params(payment_id: String, limit: Integer, offset: Integer).returns(T.attached_class) } + def self.new(payment_id:, limit: nil, offset: nil) end sig { override.returns({payment_id: String, limit: Integer, offset: Integer}) } diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 5babe079..48276262 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -118,9 +118,9 @@ module FinchAPI pay_group_ids: T.nilable(T::Array[String]), pay_period: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, company_debit: nil, debit_date: nil, @@ -195,8 +195,8 @@ module FinchAPI def start_date=(_) end - sig { params(end_date: T.nilable(String), start_date: T.nilable(String)).void } - def initialize(end_date: nil, start_date: nil) + sig { params(end_date: T.nilable(String), start_date: T.nilable(String)).returns(T.attached_class) } + def self.new(end_date: nil, start_date: nil) end sig { override.returns({end_date: T.nilable(String), start_date: T.nilable(String)}) } diff --git a/rbi/lib/finch-api/models/hris/payment_list_params.rbi b/rbi/lib/finch-api/models/hris/payment_list_params.rbi index 8c986cc1..a7216211 100644 --- a/rbi/lib/finch-api/models/hris/payment_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/payment_list_params.rbi @@ -29,9 +29,9 @@ module FinchAPI start_date: Date, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(end_date:, start_date:, request_options: {}) + def self.new(end_date:, start_date:, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi index b685b6eb..83a54a99 100644 --- a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi @@ -25,9 +25,9 @@ module FinchAPI company_benefits: FinchAPI::Models::OperationSupportMatrix, individual_benefits: FinchAPI::Models::OperationSupportMatrix ) - .void + .returns(T.attached_class) end - def initialize(company_benefits: nil, individual_benefits: nil) + def self.new(company_benefits: nil, individual_benefits: nil) end sig do diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index e1e3bf52..aac3e406 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -85,9 +85,9 @@ module FinchAPI hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( annual_maximum: nil, catch_up: nil, company_contribution: nil, diff --git a/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi b/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi index dc95d139..b9d0cc85 100644 --- a/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +++ b/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi @@ -12,8 +12,8 @@ module FinchAPI def benefit_id=(_) end - sig { params(benefit_id: String).void } - def initialize(benefit_id:) + sig { params(benefit_id: String).returns(T.attached_class) } + def self.new(benefit_id:) end sig { override.returns({benefit_id: String}) } diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index ef119f7d..1b1f016c 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -28,8 +28,11 @@ module FinchAPI def year=(_) end - sig { params(data: FinchAPI::Models::HRIS::W42005::Data, type: Symbol, year: T.nilable(Float)).void } - def initialize(data: nil, type: nil, year: nil) + sig do + params(data: FinchAPI::Models::HRIS::W42005::Data, type: Symbol, year: T.nilable(Float)) + .returns(T.attached_class) + end + def self.new(data: nil, type: nil, year: nil) end sig { override.returns({data: FinchAPI::Models::HRIS::W42005::Data, type: Symbol, year: T.nilable(Float)}) } @@ -85,9 +88,9 @@ module FinchAPI individual_id: String, total_number_of_allowances: T.nilable(Integer) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( additional_withholding: nil, exemption: nil, filing_status: nil, diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 89f661a1..1116cb72 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -28,8 +28,11 @@ module FinchAPI def year=(_) end - sig { params(data: FinchAPI::Models::HRIS::W42020::Data, type: Symbol, year: T.nilable(Float)).void } - def initialize(data: nil, type: nil, year: nil) + sig do + params(data: FinchAPI::Models::HRIS::W42020::Data, type: Symbol, year: T.nilable(Float)) + .returns(T.attached_class) + end + def self.new(data: nil, type: nil, year: nil) end sig { override.returns({data: FinchAPI::Models::HRIS::W42020::Data, type: Symbol, year: T.nilable(Float)}) } @@ -112,9 +115,9 @@ module FinchAPI other_income: T.nilable(Integer), total_claim_dependent_and_other_credits: T.nilable(Integer) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( amount_for_other_dependents: nil, amount_for_qualifying_children_under_17: nil, deductions: nil, diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index 929d1196..38e2665d 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -42,9 +42,9 @@ module FinchAPI effective_date: T.nilable(String), unit: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, currency: nil, effective_date: nil, unit: nil) + def self.new(amount: nil, currency: nil, effective_date: nil, unit: nil) end sig do diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 54c34110..90da97ed 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -19,8 +19,8 @@ module FinchAPI def event_type=(_) end - sig { params(data: FinchAPI::Models::IndividualEvent::Data, event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig { params(data: FinchAPI::Models::IndividualEvent::Data, event_type: Symbol).returns(T.attached_class) } + def self.new(data: nil, event_type: nil) end sig { override.returns({data: FinchAPI::Models::IndividualEvent::Data, event_type: Symbol}) } @@ -36,8 +36,8 @@ module FinchAPI def individual_id=(_) end - sig { params(individual_id: String).void } - def initialize(individual_id: nil) + sig { params(individual_id: String).returns(T.attached_class) } + def self.new(individual_id: nil) end sig { override.returns({individual_id: String}) } diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index ca2e8be0..5302ee33 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -156,9 +156,9 @@ module FinchAPI provider_id: String, username: String ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( account_id:, authentication_methods:, client_id:, @@ -238,9 +238,9 @@ module FinchAPI products: T::Array[String], type: Symbol ) - .void + .returns(T.attached_class) end - def initialize(connection_status: nil, products: nil, type: nil) + def self.new(connection_status: nil, products: nil, type: nil) end sig do @@ -273,8 +273,8 @@ module FinchAPI def status=(_) end - sig { params(message: String, status: Symbol).void } - def initialize(message: nil, status: nil) + sig { params(message: String, status: Symbol).returns(T.attached_class) } + def self.new(message: nil, status: nil) end sig { override.returns({message: String, status: Symbol}) } @@ -330,8 +330,8 @@ module FinchAPI def status=(_) end - sig { params(message: String, status: Symbol).void } - def initialize(message: nil, status: nil) + sig { params(message: String, status: Symbol).returns(T.attached_class) } + def self.new(message: nil, status: nil) end sig { override.returns({message: String, status: Symbol}) } diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index c0148b8b..d682064f 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -19,8 +19,8 @@ module FinchAPI def event_type=(_) end - sig { params(data: FinchAPI::Models::JobCompletionEvent::Data, event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig { params(data: FinchAPI::Models::JobCompletionEvent::Data, event_type: Symbol).returns(T.attached_class) } + def self.new(data: nil, event_type: nil) end sig { override.returns({data: FinchAPI::Models::JobCompletionEvent::Data, event_type: Symbol}) } @@ -44,8 +44,8 @@ module FinchAPI def job_url=(_) end - sig { params(job_id: String, job_url: String).void } - def initialize(job_id:, job_url:) + sig { params(job_id: String, job_url: String).returns(T.attached_class) } + def self.new(job_id:, job_url:) end sig { override.returns({job_id: String, job_url: String}) } diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index c2f47148..63c9171c 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -91,19 +91,9 @@ module FinchAPI status: Symbol, type: Symbol ) - .void + .returns(T.attached_class) end - def initialize( - completed_at:, - created_at:, - job_id:, - job_url:, - params:, - scheduled_at:, - started_at:, - status:, - type: - ) + def self.new(completed_at:, created_at:, job_id:, job_url:, params:, scheduled_at:, started_at:, status:, type:) end sig do @@ -134,8 +124,8 @@ module FinchAPI def individual_id=(_) end - sig { params(individual_id: String).void } - def initialize(individual_id: nil) + sig { params(individual_id: String).returns(T.attached_class) } + def self.new(individual_id: nil) end sig { override.returns({individual_id: String}) } diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index 5a266557..52c7f57c 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -32,9 +32,9 @@ module FinchAPI params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(type:, params:, request_options: {}) + def self.new(type:, params:, request_options: {}) end sig do @@ -71,8 +71,8 @@ module FinchAPI def individual_id=(_) end - sig { params(individual_id: String).void } - def initialize(individual_id:) + sig { params(individual_id: String).returns(T.attached_class) } + def self.new(individual_id:) end sig { override.returns({individual_id: String}) } diff --git a/rbi/lib/finch-api/models/jobs/automated_create_response.rbi b/rbi/lib/finch-api/models/jobs/automated_create_response.rbi index 43308533..2b8574f8 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_response.rbi @@ -37,14 +37,10 @@ module FinchAPI end sig do - params( - allowed_refreshes: Integer, - job_id: String, - job_url: String, - remaining_refreshes: Integer - ).void + params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer) + .returns(T.attached_class) end - def initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:) + def self.new(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:) end sig do diff --git a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi index 7343edb5..a43ad8a0 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi @@ -29,9 +29,9 @@ module FinchAPI offset: Integer, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(limit: nil, offset: nil, request_options: {}) + def self.new(limit: nil, offset: nil, request_options: {}) end sig { override.returns({limit: Integer, offset: Integer, request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi b/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi index df84a332..6de22d1f 100644 --- a/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index 17473673..dbd8d0b1 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -28,8 +28,14 @@ module FinchAPI def status=(_) end - sig { params(body: T.nilable(T::Array[T.anything]), job_id: String, status: Symbol).void } - def initialize(body:, job_id:, status:) + sig do + params( + body: T.nilable(T::Array[T.anything]), + job_id: String, + status: Symbol + ).returns(T.attached_class) + end + def self.new(body:, job_id:, status:) end sig { override.returns({body: T.nilable(T::Array[T.anything]), job_id: String, status: Symbol}) } diff --git a/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi b/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi index 480e3614..2cf683b0 100644 --- a/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/location.rbi b/rbi/lib/finch-api/models/location.rbi index a79e7d3b..37d65c8b 100644 --- a/rbi/lib/finch-api/models/location.rbi +++ b/rbi/lib/finch-api/models/location.rbi @@ -78,18 +78,9 @@ module FinchAPI source_id: T.nilable(String), state: T.nilable(String) ) - .void - end - def initialize( - city: nil, - country: nil, - line1: nil, - line2: nil, - name: nil, - postal_code: nil, - source_id: nil, - state: nil - ) + .returns(T.attached_class) + end + def self.new(city: nil, country: nil, line1: nil, line2: nil, name: nil, postal_code: nil, source_id: nil, state: nil) end sig do diff --git a/rbi/lib/finch-api/models/money.rbi b/rbi/lib/finch-api/models/money.rbi index 64e1b602..08502d23 100644 --- a/rbi/lib/finch-api/models/money.rbi +++ b/rbi/lib/finch-api/models/money.rbi @@ -19,8 +19,8 @@ module FinchAPI def currency=(_) end - sig { params(amount: T.nilable(Integer), currency: String).void } - def initialize(amount: nil, currency: nil) + sig { params(amount: T.nilable(Integer), currency: String).returns(T.attached_class) } + def self.new(amount: nil, currency: nil) end sig { override.returns({amount: T.nilable(Integer), currency: String}) } diff --git a/rbi/lib/finch-api/models/operation_support_matrix.rbi b/rbi/lib/finch-api/models/operation_support_matrix.rbi index 4b88a1bb..ab902c92 100644 --- a/rbi/lib/finch-api/models/operation_support_matrix.rbi +++ b/rbi/lib/finch-api/models/operation_support_matrix.rbi @@ -35,8 +35,8 @@ module FinchAPI def update=(_) end - sig { params(create: Symbol, delete: Symbol, read: Symbol, update: Symbol).void } - def initialize(create: nil, delete: nil, read: nil, update: nil) + sig { params(create: Symbol, delete: Symbol, read: Symbol, update: Symbol).returns(T.attached_class) } + def self.new(create: nil, delete: nil, read: nil, update: nil) end sig { override.returns({create: Symbol, delete: Symbol, read: Symbol, update: Symbol}) } diff --git a/rbi/lib/finch-api/models/paging.rbi b/rbi/lib/finch-api/models/paging.rbi index 7de9992a..e25dd0b8 100644 --- a/rbi/lib/finch-api/models/paging.rbi +++ b/rbi/lib/finch-api/models/paging.rbi @@ -19,8 +19,8 @@ module FinchAPI def offset=(_) end - sig { params(count: Integer, offset: Integer).void } - def initialize(count: nil, offset: nil) + sig { params(count: Integer, offset: Integer).returns(T.attached_class) } + def self.new(count: nil, offset: nil) end sig { override.returns({count: Integer, offset: Integer}) } diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 355af816..daee2039 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -19,8 +19,8 @@ module FinchAPI def event_type=(_) end - sig { params(data: FinchAPI::Models::PayStatementEvent::Data, event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig { params(data: FinchAPI::Models::PayStatementEvent::Data, event_type: Symbol).returns(T.attached_class) } + def self.new(data: nil, event_type: nil) end sig { override.returns({data: FinchAPI::Models::PayStatementEvent::Data, event_type: Symbol}) } @@ -44,8 +44,8 @@ module FinchAPI def payment_id=(_) end - sig { params(individual_id: String, payment_id: String).void } - def initialize(individual_id: nil, payment_id: nil) + sig { params(individual_id: String, payment_id: String).returns(T.attached_class) } + def self.new(individual_id: nil, payment_id: nil) end sig { override.returns({individual_id: String, payment_id: String}) } diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index 6c662cab..0bee1654 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -19,8 +19,8 @@ module FinchAPI def event_type=(_) end - sig { params(data: FinchAPI::Models::PaymentEvent::Data, event_type: Symbol).void } - def initialize(data: nil, event_type: nil) + sig { params(data: FinchAPI::Models::PaymentEvent::Data, event_type: Symbol).returns(T.attached_class) } + def self.new(data: nil, event_type: nil) end sig { override.returns({data: FinchAPI::Models::PaymentEvent::Data, event_type: Symbol}) } @@ -44,8 +44,8 @@ module FinchAPI def payment_id=(_) end - sig { params(pay_date: String, payment_id: String).void } - def initialize(pay_date:, payment_id:) + sig { params(pay_date: String, payment_id: String).returns(T.attached_class) } + def self.new(pay_date:, payment_id:) end sig { override.returns({pay_date: String, payment_id: String}) } diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi index 26870e63..41e3fc06 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi @@ -29,9 +29,9 @@ module FinchAPI pay_frequencies: T::Array[String], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(individual_id: nil, pay_frequencies: nil, request_options: {}) + def self.new(individual_id: nil, pay_frequencies: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index 4e8ea257..72d3d5e1 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -28,8 +28,8 @@ module FinchAPI def pay_frequencies=(_) end - sig { params(id: String, name: String, pay_frequencies: T::Array[Symbol]).void } - def initialize(id: nil, name: nil, pay_frequencies: nil) + sig { params(id: String, name: String, pay_frequencies: T::Array[Symbol]).returns(T.attached_class) } + def self.new(id: nil, name: nil, pay_frequencies: nil) end sig { override.returns({id: String, name: String, pay_frequencies: T::Array[Symbol]}) } diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi index 42a0b78a..34297679 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi @@ -7,8 +7,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index 91cdf0e6..c9d4d00c 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -42,9 +42,10 @@ module FinchAPI individual_ids: T::Array[String], name: String, pay_frequencies: T::Array[Symbol] - ).void + ) + .returns(T.attached_class) end - def initialize(id:, individual_ids:, name:, pay_frequencies:) + def self.new(id:, individual_ids:, name:, pay_frequencies:) end sig do diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 2a49c456..34aa2f91 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -99,9 +99,9 @@ module FinchAPI primary_color: String, products: T::Array[String] ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, authentication_methods: nil, beta: nil, @@ -172,9 +172,9 @@ module FinchAPI supported_fields: T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields), type: Symbol ) - .void + .returns(T.attached_class) end - def initialize(benefits_support: nil, supported_fields: nil, type: nil) + def self.new(benefits_support: nil, supported_fields: nil, type: nil) end sig do @@ -278,9 +278,9 @@ module FinchAPI pay_statement: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, payment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( company: nil, directory: nil, employment: nil, @@ -409,9 +409,9 @@ module FinchAPI primary_email: T::Boolean, primary_phone_number: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, accounts: nil, departments: nil, @@ -492,15 +492,9 @@ module FinchAPI institution_name: T::Boolean, routing_number: T::Boolean ) - .void - end - def initialize( - account_name: nil, - account_number: nil, - account_type: nil, - institution_name: nil, - routing_number: nil - ) + .returns(T.attached_class) + end + def self.new(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil) end sig do @@ -548,9 +542,9 @@ module FinchAPI name: T::Boolean, parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) - .void + .returns(T.attached_class) end - def initialize(name: nil, parent: nil) + def self.new(name: nil, parent: nil) end sig do @@ -574,8 +568,8 @@ module FinchAPI def name=(_) end - sig { params(name: T::Boolean).void } - def initialize(name: nil) + sig { params(name: T::Boolean).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T::Boolean}) } @@ -601,8 +595,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T::Boolean, type: T::Boolean).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } @@ -668,9 +662,9 @@ module FinchAPI postal_code: T::Boolean, state: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) end sig do @@ -723,9 +717,9 @@ module FinchAPI individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging ) - .void + .returns(T.attached_class) end - def initialize(individuals: nil, paging: nil) + def self.new(individuals: nil, paging: nil) end sig do @@ -820,17 +814,9 @@ module FinchAPI manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, middle_name: T::Boolean ) - .void - end - def initialize( - id: nil, - department: nil, - first_name: nil, - is_active: nil, - last_name: nil, - manager: nil, - middle_name: nil - ) + .returns(T.attached_class) + end + def self.new(id: nil, department: nil, first_name: nil, is_active: nil, last_name: nil, manager: nil, middle_name: nil) end sig do @@ -859,8 +845,8 @@ module FinchAPI def id=(_) end - sig { params(id: T::Boolean).void } - def initialize(id: nil) + sig { params(id: T::Boolean).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: T::Boolean}) } @@ -886,8 +872,8 @@ module FinchAPI def offset=(_) end - sig { params(count: T::Boolean, offset: T::Boolean).void } - def initialize(count: nil, offset: nil) + sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } + def self.new(count: nil, offset: nil) end sig { override.returns({count: T::Boolean, offset: T::Boolean}) } @@ -1080,9 +1066,9 @@ module FinchAPI start_date: T::Boolean, title: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, class_code: nil, custom_fields: nil, @@ -1139,8 +1125,8 @@ module FinchAPI def name=(_) end - sig { params(name: T::Boolean).void } - def initialize(name: nil) + sig { params(name: T::Boolean).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T::Boolean}) } @@ -1165,8 +1151,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T::Boolean, type: T::Boolean).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T::Boolean, type: T::Boolean}) } @@ -1199,8 +1185,10 @@ module FinchAPI def unit=(_) end - sig { params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).void } - def initialize(amount: nil, currency: nil, unit: nil) + sig do + params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).returns(T.attached_class) + end + def self.new(amount: nil, currency: nil, unit: nil) end sig { override.returns({amount: T::Boolean, currency: T::Boolean, unit: T::Boolean}) } @@ -1266,9 +1254,9 @@ module FinchAPI postal_code: T::Boolean, state: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) end sig do @@ -1297,8 +1285,8 @@ module FinchAPI def id=(_) end - sig { params(id: T::Boolean).void } - def initialize(id: nil) + sig { params(id: T::Boolean).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: T::Boolean}) } @@ -1445,9 +1433,9 @@ module FinchAPI residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, ssn: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, dob: nil, emails: nil, @@ -1504,8 +1492,8 @@ module FinchAPI def type=(_) end - sig { params(data: T::Boolean, type: T::Boolean).void } - def initialize(data: nil, type: nil) + sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: T::Boolean, type: T::Boolean}) } @@ -1530,8 +1518,8 @@ module FinchAPI def type=(_) end - sig { params(data: T::Boolean, type: T::Boolean).void } - def initialize(data: nil, type: nil) + sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: T::Boolean, type: T::Boolean}) } @@ -1597,9 +1585,9 @@ module FinchAPI postal_code: T::Boolean, state: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) end sig do @@ -1659,9 +1647,10 @@ module FinchAPI individual_ids: T::Boolean, name: T::Boolean, pay_frequencies: T::Boolean - ).void + ) + .returns(T.attached_class) end - def initialize(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil) + def self.new(id: nil, individual_ids: nil, name: nil, pay_frequencies: nil) end sig do @@ -1713,9 +1702,9 @@ module FinchAPI paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) - .void + .returns(T.attached_class) end - def initialize(paging: nil, pay_statements: nil) + def self.new(paging: nil, pay_statements: nil) end sig do @@ -1747,8 +1736,8 @@ module FinchAPI def offset=(_) end - sig { params(count: T::Boolean, offset: T::Boolean).void } - def initialize(count:, offset:) + sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } + def self.new(count:, offset:) end sig { override.returns({count: T::Boolean, offset: T::Boolean}) } @@ -1902,9 +1891,9 @@ module FinchAPI total_hours: T::Boolean, type: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( earnings: nil, employee_deductions: nil, employer_contributions: nil, @@ -1972,9 +1961,10 @@ module FinchAPI end sig do - params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean).void + params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean) + .returns(T.attached_class) end - def initialize(amount: nil, currency: nil, name: nil, type: nil) + def self.new(amount: nil, currency: nil, name: nil, type: nil) end sig do @@ -2040,9 +2030,9 @@ module FinchAPI pre_tax: T::Boolean, type: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil) + def self.new(amount: nil, currency: nil, name: nil, pre_tax: nil, type: nil) end sig do @@ -2086,8 +2076,10 @@ module FinchAPI def name=(_) end - sig { params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean).void } - def initialize(amount: nil, currency: nil, name: nil) + sig do + params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean).returns(T.attached_class) + end + def self.new(amount: nil, currency: nil, name: nil) end sig { override.returns({amount: T::Boolean, currency: T::Boolean, name: T::Boolean}) } @@ -2144,9 +2136,9 @@ module FinchAPI name: T::Boolean, type: T::Boolean ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, currency: nil, employer: nil, name: nil, type: nil) + def self.new(amount: nil, currency: nil, employer: nil, name: nil, type: nil) end sig do @@ -2282,9 +2274,9 @@ module FinchAPI pay_group_ids: T::Boolean, pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, company_debit: nil, debit_date: nil, @@ -2339,8 +2331,8 @@ module FinchAPI def start_date=(_) end - sig { params(end_date: T::Boolean, start_date: T::Boolean).void } - def initialize(end_date: nil, start_date: nil) + sig { params(end_date: T::Boolean, start_date: T::Boolean).returns(T.attached_class) } + def self.new(end_date: nil, start_date: nil) end sig { override.returns({end_date: T::Boolean, start_date: T::Boolean}) } diff --git a/rbi/lib/finch-api/models/provider_list_params.rbi b/rbi/lib/finch-api/models/provider_list_params.rbi index f4339070..26777e40 100644 --- a/rbi/lib/finch-api/models/provider_list_params.rbi +++ b/rbi/lib/finch-api/models/provider_list_params.rbi @@ -6,8 +6,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi index ec90cff9..f39a9f0f 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi @@ -55,9 +55,9 @@ module FinchAPI params: T.nilable(T.anything), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}) + def self.new(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi index 653c39c3..2bce56b8 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi @@ -45,9 +45,9 @@ module FinchAPI request: FinchAPI::Models::RequestForwardingForwardResponse::Request, status_code: Integer ) - .void + .returns(T.attached_class) end - def initialize(data:, headers:, request:, status_code:) + def self.new(data:, headers:, request:, status_code:) end sig do @@ -113,9 +113,9 @@ module FinchAPI params: T.nilable(T.anything), route: String ) - .void + .returns(T.attached_class) end - def initialize(data:, headers:, method_:, params:, route:) + def self.new(data:, headers:, method_:, params:, route:) end sig do diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index eb6dafca..d2627782 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -95,9 +95,9 @@ module FinchAPI primary_phone_number: T.nilable(String), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( accounts:, departments:, ein:, @@ -178,15 +178,9 @@ module FinchAPI institution_name: T.nilable(String), routing_number: T.nilable(String) ) - .void - end - def initialize( - account_name: nil, - account_number: nil, - account_type: nil, - institution_name: nil, - routing_number: nil - ) + .returns(T.attached_class) + end + def self.new(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil) end sig do @@ -243,9 +237,9 @@ module FinchAPI name: T.nilable(String), parent: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent) ) - .void + .returns(T.attached_class) end - def initialize(name: nil, parent: nil) + def self.new(name: nil, parent: nil) end sig do @@ -269,8 +263,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -296,8 +290,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index fb0d25bf..9b69794f 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -91,18 +91,9 @@ module FinchAPI primary_email: T.nilable(String), primary_phone_number: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( - accounts:, - departments:, - ein:, - entity:, - legal_name:, - locations:, - primary_email:, - primary_phone_number: - ) + def self.new(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:) end sig do @@ -172,15 +163,9 @@ module FinchAPI institution_name: T.nilable(String), routing_number: T.nilable(String) ) - .void - end - def initialize( - account_name: nil, - account_number: nil, - account_type: nil, - institution_name: nil, - routing_number: nil - ) + .returns(T.attached_class) + end + def self.new(account_name: nil, account_number: nil, account_type: nil, institution_name: nil, routing_number: nil) end sig do @@ -237,9 +222,9 @@ module FinchAPI name: T.nilable(String), parent: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent) ) - .void + .returns(T.attached_class) end - def initialize(name: nil, parent: nil) + def self.new(name: nil, parent: nil) end sig do @@ -263,8 +248,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -290,8 +275,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 232ae956..a03664c8 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -47,15 +47,9 @@ module FinchAPI products: T::Array[String], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize( - provider_id:, - authentication_type: nil, - employee_size: nil, - products: nil, - request_options: {} - ) + def self.new(provider_id:, authentication_type: nil, employee_size: nil, products: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index 10b04f36..45946c5f 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -79,9 +79,9 @@ module FinchAPI provider_id: String, token_type: String ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( access_token:, account_id:, authentication_type:, diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index aa3677b7..37cac0c3 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -48,15 +48,9 @@ module FinchAPI products: T::Array[String], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize( - company_id:, - provider_id:, - authentication_type: nil, - products: nil, - request_options: {} - ) + def self.new(company_id:, provider_id:, authentication_type: nil, products: nil, request_options: {}) end sig do diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index 9b3de50a..43e2b4c0 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -71,17 +71,9 @@ module FinchAPI products: T::Array[String], provider_id: String ) - .void - end - def initialize( - access_token:, - account_id:, - authentication_type:, - company_id:, - connection_id:, - products:, - provider_id: - ) + .returns(T.attached_class) + end + def self.new(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:) end sig do diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi index 68e7e533..bc03bce1 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi @@ -21,9 +21,9 @@ module FinchAPI connection_status: Symbol, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(connection_status: nil, request_options: {}) + def self.new(connection_status: nil, request_options: {}) end sig { override.returns({connection_status: Symbol, request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index 454b1b1b..d3798128 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -62,16 +62,9 @@ module FinchAPI provider_id: String, connection_id: String ) - .void - end - def initialize( - account_id:, - authentication_type:, - company_id:, - products:, - provider_id:, - connection_id: nil - ) + .returns(T.attached_class) + end + def self.new(account_id:, authentication_type:, company_id:, products:, provider_id:, connection_id: nil) end sig do diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index 7c1f4590..fd4b4097 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -23,9 +23,9 @@ module FinchAPI body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(body: nil, request_options: {}) + def self.new(body: nil, request_options: {}) end sig do @@ -316,9 +316,9 @@ module FinchAPI start_date: T.nilable(String), title: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( class_code: nil, custom_fields: nil, department: nil, @@ -403,8 +403,8 @@ module FinchAPI def value=(_) end - sig { params(name: T.nilable(String), value: T.anything).void } - def initialize(name: nil, value: nil) + sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) } + def self.new(name: nil, value: nil) end sig { override.returns({name: T.nilable(String), value: T.anything}) } @@ -421,8 +421,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -447,8 +447,8 @@ module FinchAPI def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: String, type: T.nilable(Symbol)}) } @@ -486,8 +486,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } @@ -589,8 +589,8 @@ module FinchAPI def id=(_) end - sig { params(id: String).void } - def initialize(id: nil) + sig { params(id: String).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: String}) } @@ -615,8 +615,8 @@ module FinchAPI def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: String, type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index 65cf6290..19fe6272 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -188,9 +188,9 @@ module FinchAPI title: T.nilable(String), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( class_code: nil, custom_fields: nil, department: nil, @@ -259,8 +259,8 @@ module FinchAPI def value=(_) end - sig { params(name: T.nilable(String), value: T.anything).void } - def initialize(name: nil, value: nil) + sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) } + def self.new(name: nil, value: nil) end sig { override.returns({name: T.nilable(String), value: T.anything}) } @@ -277,8 +277,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -303,8 +303,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } @@ -369,8 +369,8 @@ module FinchAPI def id=(_) end - sig { params(id: String).void } - def initialize(id: nil) + sig { params(id: String).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: String}) } diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index fcdebb8b..318003c9 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -193,9 +193,9 @@ module FinchAPI start_date: T.nilable(String), title: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, class_code: nil, custom_fields: nil, @@ -264,8 +264,8 @@ module FinchAPI def value=(_) end - sig { params(name: T.nilable(String), value: T.anything).void } - def initialize(name: nil, value: nil) + sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) } + def self.new(name: nil, value: nil) end sig { override.returns({name: T.nilable(String), value: T.anything}) } @@ -282,8 +282,8 @@ module FinchAPI def name=(_) end - sig { params(name: T.nilable(String)).void } - def initialize(name: nil) + sig { params(name: T.nilable(String)).returns(T.attached_class) } + def self.new(name: nil) end sig { override.returns({name: T.nilable(String)}) } @@ -308,8 +308,8 @@ module FinchAPI def type=(_) end - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).void } - def initialize(subtype: nil, type: nil) + sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(subtype: nil, type: nil) end sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } @@ -374,8 +374,8 @@ module FinchAPI def id=(_) end - sig { params(id: String).void } - def initialize(id: nil) + sig { params(id: String).returns(T.attached_class) } + def self.new(id: nil) end sig { override.returns({id: String}) } diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index 288e5e78..9784ddac 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -125,9 +125,9 @@ module FinchAPI ssn: T.nilable(String), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( dob: nil, emails: nil, encrypted_ssn: nil, @@ -184,8 +184,8 @@ module FinchAPI def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: String, type: T.nilable(Symbol)}) } @@ -257,8 +257,8 @@ module FinchAPI def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: String, type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index 3c2808b6..d46fb531 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -132,9 +132,9 @@ module FinchAPI residence: T.nilable(FinchAPI::Models::Location), ssn: T.nilable(String) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( id: nil, dob: nil, emails: nil, @@ -191,8 +191,8 @@ module FinchAPI def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: String, type: T.nilable(Symbol)}) } @@ -264,8 +264,8 @@ module FinchAPI def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).void } - def initialize(data: nil, type: nil) + sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + def self.new(data: nil, type: nil) end sig { override.returns({data: String, type: T.nilable(Symbol)}) } diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index aa5f594d..66f566b5 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -16,15 +16,10 @@ module FinchAPI end sig do - params( - type: Symbol, - request_options: T.any( - FinchAPI::RequestOptions, - T::Hash[Symbol, T.anything] - ) - ).void + params(type: Symbol, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) end - def initialize(type:, request_options: {}) + def self.new(type:, request_options: {}) end sig { override.returns({type: Symbol, request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/sandbox/job_create_response.rbi b/rbi/lib/finch-api/models/sandbox/job_create_response.rbi index cdbcda55..ee774705 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_response.rbi @@ -37,14 +37,10 @@ module FinchAPI end sig do - params( - allowed_refreshes: Integer, - job_id: String, - job_url: String, - remaining_refreshes: Integer - ).void + params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer) + .returns(T.attached_class) end - def initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:) + def self.new(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:) end sig do diff --git a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi index 3c2ebe25..73144afb 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi @@ -8,8 +8,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi b/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi index e4437abf..c4294ff7 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi @@ -8,8 +8,11 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void } - def initialize(request_options: {}) + sig do + params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + .returns(T.attached_class) + end + def self.new(request_options: {}) end sig { override.returns({request_options: FinchAPI::RequestOptions}) } diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index 77c5869e..578a1801 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -21,8 +21,8 @@ module FinchAPI def type=(_) end - sig { params(completion_status: Symbol, type: Symbol).void } - def initialize(completion_status:, type:) + sig { params(completion_status: Symbol, type: Symbol).returns(T.attached_class) } + def self.new(completion_status:, type:) end sig { override.returns({completion_status: Symbol, type: Symbol}) } diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index b3cdb269..205e885e 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -41,9 +41,9 @@ module FinchAPI start_date: String, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) - .void + .returns(T.attached_class) end - def initialize(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) + def self.new(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) end sig do @@ -208,9 +208,9 @@ module FinchAPI total_hours: T.nilable(Float), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize( + def self.new( earnings: nil, employee_deductions: nil, employer_contributions: nil, @@ -309,9 +309,9 @@ module FinchAPI name: T.nilable(String), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, hours: nil, name: nil, type: nil) end sig do @@ -350,9 +350,9 @@ module FinchAPI params( metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata ) - .void + .returns(T.attached_class) end - def initialize(metadata: nil) + def self.new(metadata: nil) end sig do @@ -373,8 +373,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } @@ -477,9 +477,9 @@ module FinchAPI pre_tax: T.nilable(T::Boolean), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, name: nil, pre_tax: nil, type: nil) end sig do @@ -524,9 +524,9 @@ module FinchAPI params( metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata ) - .void + .returns(T.attached_class) end - def initialize(metadata: nil) + def self.new(metadata: nil) end sig do @@ -549,8 +549,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } @@ -620,9 +620,9 @@ module FinchAPI name: T.nilable(String), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, name: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, name: nil, type: nil) end sig do @@ -666,9 +666,9 @@ module FinchAPI params( metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata ) - .void + .returns(T.attached_class) end - def initialize(metadata: nil) + def self.new(metadata: nil) end sig do @@ -691,8 +691,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } @@ -776,9 +776,9 @@ module FinchAPI name: T.nilable(String), type: T.nilable(Symbol) ) - .void + .returns(T.attached_class) end - def initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil) + def self.new(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil) end sig do @@ -815,9 +815,9 @@ module FinchAPI sig do params(metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata) - .void + .returns(T.attached_class) end - def initialize(metadata: nil) + def self.new(metadata: nil) end sig do @@ -838,8 +838,8 @@ module FinchAPI def metadata=(_) end - sig { params(metadata: T::Hash[Symbol, T.anything]).void } - def initialize(metadata: nil) + sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(metadata: nil) end sig { override.returns({metadata: T::Hash[Symbol, T.anything]}) } diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi index a0321cec..36cb3cc9 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi @@ -20,8 +20,8 @@ module FinchAPI def payment_id=(_) end - sig { params(pay_date: String, payment_id: String).void } - def initialize(pay_date:, payment_id:) + sig { params(pay_date: String, payment_id: String).returns(T.attached_class) } + def self.new(pay_date:, payment_id:) end sig { override.returns({pay_date: String, payment_id: String}) } diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index 1f8d891c..0abea432 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -31,8 +31,8 @@ module FinchAPI def execute(request) end - sig { void } - def initialize + sig { returns(T.attached_class) } + def self.new end end end diff --git a/rbi/lib/finch-api/request_options.rbi b/rbi/lib/finch-api/request_options.rbi index 68b232aa..8d9d8be5 100644 --- a/rbi/lib/finch-api/request_options.rbi +++ b/rbi/lib/finch-api/request_options.rbi @@ -80,5 +80,9 @@ module FinchAPI sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } def timeout=(_) end + + sig { params(values: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + def self.new(values = {}) + end end end diff --git a/rbi/lib/finch-api/resources/access_tokens.rbi b/rbi/lib/finch-api/resources/access_tokens.rbi index 2f4987c0..aab817aa 100644 --- a/rbi/lib/finch-api/resources/access_tokens.rbi +++ b/rbi/lib/finch-api/resources/access_tokens.rbi @@ -16,8 +16,8 @@ module FinchAPI def create(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/account.rbi b/rbi/lib/finch-api/resources/account.rbi index f38446bf..102bdc47 100644 --- a/rbi/lib/finch-api/resources/account.rbi +++ b/rbi/lib/finch-api/resources/account.rbi @@ -17,8 +17,8 @@ module FinchAPI def introspect(request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/connect.rbi b/rbi/lib/finch-api/resources/connect.rbi index 40e87df2..9a5a228e 100644 --- a/rbi/lib/finch-api/resources/connect.rbi +++ b/rbi/lib/finch-api/resources/connect.rbi @@ -7,8 +7,8 @@ module FinchAPI def sessions end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/connect/sessions.rbi b/rbi/lib/finch-api/resources/connect/sessions.rbi index e4f411dc..c64f9418 100644 --- a/rbi/lib/finch-api/resources/connect/sessions.rbi +++ b/rbi/lib/finch-api/resources/connect/sessions.rbi @@ -52,8 +52,8 @@ module FinchAPI ) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris.rbi b/rbi/lib/finch-api/resources/hris.rbi index dbb1355d..b3e3fab4 100644 --- a/rbi/lib/finch-api/resources/hris.rbi +++ b/rbi/lib/finch-api/resources/hris.rbi @@ -35,8 +35,8 @@ module FinchAPI def benefits end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/benefits.rbi b/rbi/lib/finch-api/resources/hris/benefits.rbi index 25af1e23..45323dee 100644 --- a/rbi/lib/finch-api/resources/hris/benefits.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits.rbi @@ -55,8 +55,8 @@ module FinchAPI def list_supported_benefits(request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi index b4afcec1..68d08dd5 100644 --- a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi @@ -48,8 +48,8 @@ module FinchAPI def unenroll_many(benefit_id, individual_ids: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/company.rbi b/rbi/lib/finch-api/resources/hris/company.rbi index ea45c69e..48172364 100644 --- a/rbi/lib/finch-api/resources/hris/company.rbi +++ b/rbi/lib/finch-api/resources/hris/company.rbi @@ -11,8 +11,8 @@ module FinchAPI def retrieve(request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/directory.rbi b/rbi/lib/finch-api/resources/hris/directory.rbi index e6f9b8ab..ef589561 100644 --- a/rbi/lib/finch-api/resources/hris/directory.rbi +++ b/rbi/lib/finch-api/resources/hris/directory.rbi @@ -26,8 +26,8 @@ module FinchAPI def list_individuals(limit: nil, offset: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/documents.rbi b/rbi/lib/finch-api/resources/hris/documents.rbi index 67236063..1f807e4f 100644 --- a/rbi/lib/finch-api/resources/hris/documents.rbi +++ b/rbi/lib/finch-api/resources/hris/documents.rbi @@ -27,8 +27,8 @@ module FinchAPI def retreive(document_id, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/employments.rbi b/rbi/lib/finch-api/resources/hris/employments.rbi index bf594782..1d6dd04d 100644 --- a/rbi/lib/finch-api/resources/hris/employments.rbi +++ b/rbi/lib/finch-api/resources/hris/employments.rbi @@ -14,8 +14,8 @@ module FinchAPI def retrieve_many(requests:, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/individuals.rbi b/rbi/lib/finch-api/resources/hris/individuals.rbi index f13687c9..156041f6 100644 --- a/rbi/lib/finch-api/resources/hris/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/individuals.rbi @@ -15,8 +15,8 @@ module FinchAPI def retrieve_many(options: nil, requests: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/pay_statements.rbi b/rbi/lib/finch-api/resources/hris/pay_statements.rbi index 6e317654..2383e1a5 100644 --- a/rbi/lib/finch-api/resources/hris/pay_statements.rbi +++ b/rbi/lib/finch-api/resources/hris/pay_statements.rbi @@ -14,8 +14,8 @@ module FinchAPI def retrieve_many(requests:, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/hris/payments.rbi b/rbi/lib/finch-api/resources/hris/payments.rbi index dfe5b0b0..5652b236 100644 --- a/rbi/lib/finch-api/resources/hris/payments.rbi +++ b/rbi/lib/finch-api/resources/hris/payments.rbi @@ -15,8 +15,8 @@ module FinchAPI def list(end_date:, start_date:, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/jobs.rbi b/rbi/lib/finch-api/resources/jobs.rbi index f5213482..07750bc4 100644 --- a/rbi/lib/finch-api/resources/jobs.rbi +++ b/rbi/lib/finch-api/resources/jobs.rbi @@ -11,8 +11,8 @@ module FinchAPI def manual end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/jobs/automated.rbi b/rbi/lib/finch-api/resources/jobs/automated.rbi index cfe326ca..a73a040d 100644 --- a/rbi/lib/finch-api/resources/jobs/automated.rbi +++ b/rbi/lib/finch-api/resources/jobs/automated.rbi @@ -36,8 +36,8 @@ module FinchAPI def list(limit: nil, offset: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/jobs/manual.rbi b/rbi/lib/finch-api/resources/jobs/manual.rbi index da55b586..9ed53f9c 100644 --- a/rbi/lib/finch-api/resources/jobs/manual.rbi +++ b/rbi/lib/finch-api/resources/jobs/manual.rbi @@ -14,8 +14,8 @@ module FinchAPI def retrieve(job_id, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/payroll.rbi b/rbi/lib/finch-api/resources/payroll.rbi index d3dacfd8..a3958085 100644 --- a/rbi/lib/finch-api/resources/payroll.rbi +++ b/rbi/lib/finch-api/resources/payroll.rbi @@ -7,8 +7,8 @@ module FinchAPI def pay_groups end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/payroll/pay_groups.rbi b/rbi/lib/finch-api/resources/payroll/pay_groups.rbi index b3584857..edf16ebc 100644 --- a/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +++ b/rbi/lib/finch-api/resources/payroll/pay_groups.rbi @@ -25,8 +25,8 @@ module FinchAPI def list(individual_id: nil, pay_frequencies: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/providers.rbi b/rbi/lib/finch-api/resources/providers.rbi index 716c3454..71cad80d 100644 --- a/rbi/lib/finch-api/resources/providers.rbi +++ b/rbi/lib/finch-api/resources/providers.rbi @@ -10,8 +10,8 @@ module FinchAPI def list(request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/request_forwarding.rbi b/rbi/lib/finch-api/resources/request_forwarding.rbi index 998c93e6..e842f8e7 100644 --- a/rbi/lib/finch-api/resources/request_forwarding.rbi +++ b/rbi/lib/finch-api/resources/request_forwarding.rbi @@ -17,8 +17,8 @@ module FinchAPI def forward(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox.rbi b/rbi/lib/finch-api/resources/sandbox.rbi index 39fb2ff4..acc78527 100644 --- a/rbi/lib/finch-api/resources/sandbox.rbi +++ b/rbi/lib/finch-api/resources/sandbox.rbi @@ -31,8 +31,8 @@ module FinchAPI def jobs end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/company.rbi b/rbi/lib/finch-api/resources/sandbox/company.rbi index 483d2c4c..6225cc28 100644 --- a/rbi/lib/finch-api/resources/sandbox/company.rbi +++ b/rbi/lib/finch-api/resources/sandbox/company.rbi @@ -31,8 +31,8 @@ module FinchAPI ) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/connections.rbi b/rbi/lib/finch-api/resources/sandbox/connections.rbi index be9afce1..ad284bcd 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections.rbi @@ -27,8 +27,8 @@ module FinchAPI ) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi index bd825c8c..c43d4368 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi @@ -28,8 +28,8 @@ module FinchAPI def update(connection_status: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/directory.rbi b/rbi/lib/finch-api/resources/sandbox/directory.rbi index b2e56c8f..69be3b59 100644 --- a/rbi/lib/finch-api/resources/sandbox/directory.rbi +++ b/rbi/lib/finch-api/resources/sandbox/directory.rbi @@ -14,8 +14,8 @@ module FinchAPI def create(body: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/employment.rbi b/rbi/lib/finch-api/resources/sandbox/employment.rbi index 55ace8c4..0a2a7901 100644 --- a/rbi/lib/finch-api/resources/sandbox/employment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/employment.rbi @@ -53,8 +53,8 @@ module FinchAPI ) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/individual.rbi b/rbi/lib/finch-api/resources/sandbox/individual.rbi index 5826ec6c..ed859405 100644 --- a/rbi/lib/finch-api/resources/sandbox/individual.rbi +++ b/rbi/lib/finch-api/resources/sandbox/individual.rbi @@ -41,8 +41,8 @@ module FinchAPI ) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/jobs.rbi b/rbi/lib/finch-api/resources/sandbox/jobs.rbi index da174818..0fa85d95 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs.rbi @@ -18,8 +18,8 @@ module FinchAPI def create(type:, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi index 8cc6491d..946788e7 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi @@ -23,8 +23,8 @@ module FinchAPI def update(completion_status:, type:, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/sandbox/payment.rbi b/rbi/lib/finch-api/resources/sandbox/payment.rbi index 9cca17f8..d4f7c2d0 100644 --- a/rbi/lib/finch-api/resources/sandbox/payment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/payment.rbi @@ -16,8 +16,8 @@ module FinchAPI def create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {}) end - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/rbi/lib/finch-api/resources/webhooks.rbi b/rbi/lib/finch-api/resources/webhooks.rbi index ea96b9fa..f2ba07c8 100644 --- a/rbi/lib/finch-api/resources/webhooks.rbi +++ b/rbi/lib/finch-api/resources/webhooks.rbi @@ -3,8 +3,8 @@ module FinchAPI module Resources class Webhooks - sig { params(client: FinchAPI::Client).void } - def initialize(client:) + sig { params(client: FinchAPI::Client).returns(T.attached_class) } + def self.new(client:) end end end diff --git a/sig/finch-api/request_options.rbs b/sig/finch-api/request_options.rbs index 6c85d582..18bf621b 100644 --- a/sig/finch-api/request_options.rbs +++ b/sig/finch-api/request_options.rbs @@ -36,5 +36,9 @@ module FinchAPI attr_accessor max_retries: Integer? attr_accessor timeout: Float? + + def initialize: ( + ?FinchAPI::request_options | ::Hash[Symbol, top] values + ) -> void end end From 6d5ad336c49d7492c9a1382cd0eb6e4938a9630d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 8 Mar 2025 18:19:39 +0000 Subject: [PATCH 12/67] feat: add SKIP_BREW env var to ./scripts/bootstrap (#14) --- scripts/bootstrap | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/bootstrap b/scripts/bootstrap index 0b65ccb0..88566757 100755 --- a/scripts/bootstrap +++ b/scripts/bootstrap @@ -4,7 +4,7 @@ set -e cd "$(dirname "$0")/.." -if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ]; then +if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ]; then brew bundle check >/dev/null 2>&1 || { echo "==> Installing Homebrew dependencies…" brew bundle From 353250b0ba9474617d2c844eb01d9753405b87ca Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 9 Mar 2025 08:11:16 +0000 Subject: [PATCH 13/67] chore: add `sorbet` section to README (#15) --- README.md | 50 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 5b36337d..2b15158e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Finch Ruby API library -The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.0.0+ -application. +The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.0.0+ application. It is generated with [Stainless](https://www.stainless.com/). @@ -13,8 +12,7 @@ The underlying REST API documentation can be found on [developer.tryfinch.com](h ## Installation -To use this gem during the beta, install directly from GitHub with Bundler by -adding the following to your application's `Gemfile`: +To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`: ```ruby gem "finch-api", git: "https://github.com/Finch-API/finch-api-ruby", branch: "main" @@ -26,8 +24,7 @@ To fetch an initial copy of the gem: bundle install ``` -To update the version used by your application when updates are pushed to -GitHub: +To update the version used by your application when updates are pushed to GitHub: ```sh bundle update finch-api @@ -43,14 +40,14 @@ finch = FinchAPI::Client.new(access_token: "My Access Token") page = finch.hris.directory.list -puts(page.id) +item = page.individuals[0] + +puts(item.id) ``` ### Errors -When the library is unable to connect to the API, or if the API returns a -non-success status code (i.e., 4xx or 5xx response), a subclass of -`FinchAPI::Error` will be thrown: +When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `FinchAPI::Error` will be thrown: ```ruby begin @@ -78,10 +75,9 @@ Error codes are as followed: ### Retries -Certain errors will be automatically retried 2 times by default, with a short -exponential backoff. Connection errors (for example, due to a network -connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, -and timeouts will all be retried by default. +Certain errors will be automatically retried 2 times by default, with a short exponential backoff. + +Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default. You can use the `max_retries` option to configure or disable this: @@ -98,8 +94,8 @@ finch.hris.directory.list(request_options: {max_retries: 5}) ### Timeouts By default, requests will time out after 60 seconds. -Timeouts are applied separately to the initial connection and the overall request time, -so in some cases a request could wait 2\*timeout seconds before it fails. + +Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails. You can use the `timeout` option to configure or disable this: @@ -113,12 +109,26 @@ finch = FinchAPI::Client.new( finch.hris.directory.list(request_options: {timeout: 5}) ``` +## Sorbet Support + +This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the Sorbet runtime. + +What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet. + +Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `FinchAPI::BaseModel` class, you will need to use the `**` splat operator to pass the arguments: + +```ruby +model = DirectoryListParams.new + +finch.hris.directory.list(**model) +``` + ## Versioning -This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the -library is in initial development and has a major version of `0`, APIs may change -at any time. +This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time. + +This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes. ## Requirements -Ruby 3.0 or higher. +Ruby 3.0.0 or higher. From 00b0b73708af0e39e23f03028bb4d32250c07cf4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 9 Mar 2025 09:10:57 +0000 Subject: [PATCH 14/67] chore: add more examples to README.md (#16) --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2b15158e..7f5b67fa 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,26 @@ finch = FinchAPI::Client.new(access_token: "My Access Token") page = finch.hris.directory.list -item = page.individuals[0] +puts(page.id) +``` + +## Pagination + +List methods in the Finch API are paginated. -puts(item.id) +This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually: + +```ruby +page = finch.hris.directory.list + +# Fetch single item from page. +directory = page.individuals[0] +puts(directory.id) + +# Automatically fetches more pages as needed. +page.auto_paging_each do |directory| + puts(directory.id) +end ``` ### Errors @@ -111,9 +128,9 @@ finch.hris.directory.list(request_options: {timeout: 5}) ## Sorbet Support -This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the Sorbet runtime. +This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`. -What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet. +What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself. Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `FinchAPI::BaseModel` class, you will need to use the `**` splat operator to pass the arguments: From b0d79ac02e99852b1ab14892a0f14fa275105819 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 10 Mar 2025 17:07:21 +0000 Subject: [PATCH 15/67] chore(internal): codegen related update (#17) --- lib/finch-api/models/webhook_event.rb | 6 +++--- rbi/lib/finch-api/models/webhook_event.rbi | 2 +- sig/finch-api/models/webhook_event.rbs | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/finch-api/models/webhook_event.rb b/lib/finch-api/models/webhook_event.rb index c06178d2..ee9d49c0 100644 --- a/lib/finch-api/models/webhook_event.rb +++ b/lib/finch-api/models/webhook_event.rb @@ -7,11 +7,11 @@ module Models class WebhookEvent < FinchAPI::Union discriminator :event_type - variant -> { FinchAPI::Models::AccountUpdateEvent } + variant :"account.updated", -> { FinchAPI::Models::AccountUpdateEvent } - variant -> { FinchAPI::Models::JobCompletionEvent } + variant :"company.updated", -> { FinchAPI::Models::CompanyEvent } - variant -> { FinchAPI::Models::CompanyEvent } + variant -> { FinchAPI::Models::JobCompletionEvent } variant -> { FinchAPI::Models::DirectoryEvent } diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index 2c8dda39..c325459e 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -9,7 +9,7 @@ module FinchAPI sig do override .returns( - [[NilClass, FinchAPI::Models::AccountUpdateEvent], [NilClass, FinchAPI::Models::JobCompletionEvent], [NilClass, FinchAPI::Models::CompanyEvent], [NilClass, FinchAPI::Models::DirectoryEvent], [NilClass, FinchAPI::Models::EmploymentEvent], [NilClass, FinchAPI::Models::IndividualEvent], [NilClass, FinchAPI::Models::PaymentEvent], [NilClass, FinchAPI::Models::PayStatementEvent]] + [[Symbol, FinchAPI::Models::AccountUpdateEvent], [Symbol, FinchAPI::Models::CompanyEvent], [NilClass, FinchAPI::Models::JobCompletionEvent], [NilClass, FinchAPI::Models::DirectoryEvent], [NilClass, FinchAPI::Models::EmploymentEvent], [NilClass, FinchAPI::Models::IndividualEvent], [NilClass, FinchAPI::Models::PaymentEvent], [NilClass, FinchAPI::Models::PayStatementEvent]] ) end private def variants diff --git a/sig/finch-api/models/webhook_event.rbs b/sig/finch-api/models/webhook_event.rbs index aa6a84b3..79c08e7b 100644 --- a/sig/finch-api/models/webhook_event.rbs +++ b/sig/finch-api/models/webhook_event.rbs @@ -2,8 +2,8 @@ module FinchAPI module Models type webhook_event = FinchAPI::Models::AccountUpdateEvent - | FinchAPI::Models::JobCompletionEvent | FinchAPI::Models::CompanyEvent + | FinchAPI::Models::JobCompletionEvent | FinchAPI::Models::DirectoryEvent | FinchAPI::Models::EmploymentEvent | FinchAPI::Models::IndividualEvent @@ -11,7 +11,7 @@ module FinchAPI | FinchAPI::Models::PayStatementEvent class WebhookEvent < FinchAPI::Union - private def self.variants: -> [[nil, FinchAPI::Models::AccountUpdateEvent], [nil, FinchAPI::Models::JobCompletionEvent], [nil, FinchAPI::Models::CompanyEvent], [nil, FinchAPI::Models::DirectoryEvent], [nil, FinchAPI::Models::EmploymentEvent], [nil, FinchAPI::Models::IndividualEvent], [nil, FinchAPI::Models::PaymentEvent], [nil, FinchAPI::Models::PayStatementEvent]] + private def self.variants: -> [[:"account.updated", FinchAPI::Models::AccountUpdateEvent], [:"company.updated", FinchAPI::Models::CompanyEvent], [nil, FinchAPI::Models::JobCompletionEvent], [nil, FinchAPI::Models::DirectoryEvent], [nil, FinchAPI::Models::EmploymentEvent], [nil, FinchAPI::Models::IndividualEvent], [nil, FinchAPI::Models::PaymentEvent], [nil, FinchAPI::Models::PayStatementEvent]] end end end From 92bf05cf13896ff88e36de59a7c780835686f75f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 10 Mar 2025 19:36:53 +0000 Subject: [PATCH 16/67] feat: support client level methods (#18) --- .rubocop.yml | 10 ++++---- lib/finch-api/base_model.rb | 2 +- lib/finch-api/resources/hris/directory.rb | 23 +------------------ .../finch-api/resources/hris/directory.rbi | 11 +-------- sig/finch-api/resources/hris/directory.rbs | 11 +-------- 5 files changed, 9 insertions(+), 48 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 2663e1d2..216938a5 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -58,6 +58,11 @@ Layout/MultilineMethodParameterLineBreaks: Layout/SpaceInsideHashLiteralBraces: EnforcedStyle: no_space +# Fairly useful in tests for pattern assertions. +Lint/EmptyInPattern: + Exclude: + - "test/**/*" + Lint/MissingSuper: Exclude: - "**/*.rbi" @@ -115,11 +120,6 @@ Style/BisectedAttrAccessor: Exclude: - "**/*.rbi" -# Fairly useful in tests for pattern matching. -Style/CaseEquality: - Exclude: - - "test/**/*" - # We prefer nested modules in lib/, but are currently using compact style for tests. Style/ClassAndModuleChildren: Exclude: diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index 0aa5ed46..e8170289 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -155,7 +155,7 @@ def try_strict_coerce(target, value) in [-> { _1 <= Date || _1 <= Time }, String] Kernel.then do [true, target.parse(value), 1] - rescue ArgumentError, Date::Error + rescue ArgumentError [false, false, 0] end in [_, ^target] diff --git a/lib/finch-api/resources/hris/directory.rb b/lib/finch-api/resources/hris/directory.rb index 88b8fa41..6eb7a56a 100644 --- a/lib/finch-api/resources/hris/directory.rb +++ b/lib/finch-api/resources/hris/directory.rb @@ -31,28 +31,7 @@ def list(params = {}) # @deprecated use `list` instead # # Read company directory and organization structure - # - # @param params [FinchAPI::Models::HRIS::DirectoryListIndividualsParams, Hash{Symbol=>Object}] . - # - # @option params [Integer] :limit Number of employees to return (defaults to all) - # - # @option params [Integer] :offset Index to start from (defaults to 0) - # - # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options - # - # @return [FinchAPI::IndividualsPage] - # - def list_individuals(params = {}) - parsed, options = FinchAPI::Models::HRIS::DirectoryListIndividualsParams.dump_request(params) - @client.request( - method: :get, - path: "employer/directory", - query: parsed, - page: FinchAPI::IndividualsPage, - model: FinchAPI::Models::HRIS::IndividualInDirectory, - options: options - ) - end + alias_method :list_individuals, :list # @param client [FinchAPI::Client] # diff --git a/rbi/lib/finch-api/resources/hris/directory.rbi b/rbi/lib/finch-api/resources/hris/directory.rbi index ef589561..f442315c 100644 --- a/rbi/lib/finch-api/resources/hris/directory.rbi +++ b/rbi/lib/finch-api/resources/hris/directory.rbi @@ -15,16 +15,7 @@ module FinchAPI def list(limit: nil, offset: nil, request_options: {}) end - sig do - params( - limit: Integer, - offset: Integer, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - ) - .returns(FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory]) - end - def list_individuals(limit: nil, offset: nil, request_options: {}) - end + alias_method :list_individuals, :list sig { params(client: FinchAPI::Client).returns(T.attached_class) } def self.new(client:) diff --git a/sig/finch-api/resources/hris/directory.rbs b/sig/finch-api/resources/hris/directory.rbs index acb8b868..c38e8eec 100644 --- a/sig/finch-api/resources/hris/directory.rbs +++ b/sig/finch-api/resources/hris/directory.rbs @@ -13,16 +13,7 @@ module FinchAPI request_options: FinchAPI::request_opts ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] - def list_individuals: - ( - ?FinchAPI::Models::HRIS::DirectoryListIndividualsParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] - | ( - limit: Integer, - offset: Integer, - request_options: FinchAPI::request_opts - ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] + alias list_individuals list def initialize: (client: FinchAPI::Client) -> void end From 7ff758e5ccd442f8fe4843f70025f7c302e6d1ba Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 10 Mar 2025 19:38:22 +0000 Subject: [PATCH 17/67] fix: rectify a mistake where wrong lines were chosen during rebase (#19) --- lib/finch-api/util.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index fab02e58..d181d88e 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -505,10 +505,10 @@ def decode_content(headers, stream:, suppress_error: false) json end in %r{^text/event-stream} - lines = enum_lines(stream) - parse_sse(lines) + lines = decode_lines(stream) + decode_sse(lines) in %r{^application/(?:x-)?jsonl} - enum_lines(stream) + decode_lines(stream) in %r{^text/} stream.to_a.join else From d715c0202babd8cdd2911f8cd390611865c0955f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 11 Mar 2025 16:51:16 +0000 Subject: [PATCH 18/67] chore(internal): codegen related update (#20) --- .stats.yml | 2 +- lib/finch-api.rb | 1 + .../models/jobs/automated_list_response.rb | 100 ++++++++++++++ lib/finch-api/resources/jobs/automated.rb | 5 +- .../models/jobs/automated_list_response.rbi | 128 ++++++++++++++++++ .../finch-api/resources/jobs/automated.rbi | 2 +- .../models/jobs/automated_list_response.rbs | 102 ++++++++++++++ sig/finch-api/resources/jobs/automated.rbs | 4 +- .../resources/jobs/automated_test.rb | 20 +-- 9 files changed, 341 insertions(+), 23 deletions(-) create mode 100644 lib/finch-api/models/jobs/automated_list_response.rb create mode 100644 rbi/lib/finch-api/models/jobs/automated_list_response.rbi create mode 100644 sig/finch-api/models/jobs/automated_list_response.rbs diff --git a/.stats.yml b/.stats.yml index 27e0c64c..424dc58b 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 41 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-777eedfd80c3e04a8739959418783d1c976180f4f09d7a883f7de5c2b6cda5a6.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-f1779210fbedfc6099076412405288b489f727cbb0b3a85e7b7c12fabb37ef47.yml diff --git a/lib/finch-api.rb b/lib/finch-api.rb index 1b0521be..f0fa4ae5 100644 --- a/lib/finch-api.rb +++ b/lib/finch-api.rb @@ -104,6 +104,7 @@ require_relative "finch-api/models/jobs/automated_create_params" require_relative "finch-api/models/jobs/automated_create_response" require_relative "finch-api/models/jobs/automated_list_params" +require_relative "finch-api/models/jobs/automated_list_response" require_relative "finch-api/models/jobs/automated_retrieve_params" require_relative "finch-api/models/jobs/manual_async_job" require_relative "finch-api/models/jobs/manual_retrieve_params" diff --git a/lib/finch-api/models/jobs/automated_list_response.rb b/lib/finch-api/models/jobs/automated_list_response.rb new file mode 100644 index 00000000..bdbd0998 --- /dev/null +++ b/lib/finch-api/models/jobs/automated_list_response.rb @@ -0,0 +1,100 @@ +# frozen_string_literal: true + +module FinchAPI + module Models + module Jobs + class AutomatedListResponse < FinchAPI::BaseModel + # @!attribute data + # + # @return [Array] + required :data, -> { FinchAPI::ArrayOf[FinchAPI::Models::Jobs::AutomatedAsyncJob] } + + # @!attribute meta + # + # @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta] + required :meta, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta } + + # @!parse + # # @param data [Array] + # # @param meta [FinchAPI::Models::Jobs::AutomatedListResponse::Meta] + # # + # def initialize(data:, meta:, **) = super + + # def initialize: (Hash | FinchAPI::BaseModel) -> void + + class Meta < FinchAPI::BaseModel + # @!attribute [r] quotas + # Information about remaining quotas for this connection. Only applicable for + # customers opted in to use Finch's Data Sync Refresh endpoint + # (`POST /jobs/automated`). Please contact a Finch representative for more + # details. + # + # @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, nil] + optional :quotas, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas } + + # @!parse + # # @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas] + # attr_writer :quotas + + # @!parse + # # @param quotas [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas] + # # + # def initialize(quotas: nil, **) = super + + # def initialize: (Hash | FinchAPI::BaseModel) -> void + + class Quotas < FinchAPI::BaseModel + # @!attribute [r] data_sync_all + # + # @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, nil] + optional :data_sync_all, -> { FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll } + + # @!parse + # # @return [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll] + # attr_writer :data_sync_all + + # @!parse + # # Information about remaining quotas for this connection. Only applicable for + # # customers opted in to use Finch's Data Sync Refresh endpoint + # # (`POST /jobs/automated`). Please contact a Finch representative for more + # # details. + # # + # # @param data_sync_all [FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll] + # # + # def initialize(data_sync_all: nil, **) = super + + # def initialize: (Hash | FinchAPI::BaseModel) -> void + + class DataSyncAll < FinchAPI::BaseModel + # @!attribute [r] allowed_refreshes + # + # @return [Integer, nil] + optional :allowed_refreshes, Integer + + # @!parse + # # @return [Integer] + # attr_writer :allowed_refreshes + + # @!attribute [r] remaining_refreshes + # + # @return [Integer, nil] + optional :remaining_refreshes, Integer + + # @!parse + # # @return [Integer] + # attr_writer :remaining_refreshes + + # @!parse + # # @param allowed_refreshes [Integer] + # # @param remaining_refreshes [Integer] + # # + # def initialize(allowed_refreshes: nil, remaining_refreshes: nil, **) = super + + # def initialize: (Hash | FinchAPI::BaseModel) -> void + end + end + end + end + end + end +end diff --git a/lib/finch-api/resources/jobs/automated.rb b/lib/finch-api/resources/jobs/automated.rb index d91cbd90..61d6d0cf 100644 --- a/lib/finch-api/resources/jobs/automated.rb +++ b/lib/finch-api/resources/jobs/automated.rb @@ -71,7 +71,7 @@ def retrieve(job_id, params = {}) # # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # - # @return [FinchAPI::Page] + # @return [FinchAPI::Models::Jobs::AutomatedListResponse] # def list(params = {}) parsed, options = FinchAPI::Models::Jobs::AutomatedListParams.dump_request(params) @@ -79,8 +79,7 @@ def list(params = {}) method: :get, path: "jobs/automated", query: parsed, - page: FinchAPI::Page, - model: FinchAPI::Models::Jobs::AutomatedAsyncJob, + model: FinchAPI::Models::Jobs::AutomatedListResponse, options: options ) end diff --git a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi new file mode 100644 index 00000000..455b4020 --- /dev/null +++ b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi @@ -0,0 +1,128 @@ +# typed: strong + +module FinchAPI + module Models + module Jobs + class AutomatedListResponse < FinchAPI::BaseModel + sig { returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) } + def data + end + + sig do + params(_: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) + .returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) + end + def data=(_) + end + + sig { returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta) } + def meta + end + + sig do + params(_: FinchAPI::Models::Jobs::AutomatedListResponse::Meta) + .returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta) + end + def meta=(_) + end + + sig do + params( + data: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + ) + .returns(T.attached_class) + end + def self.new(data:, meta:) + end + + sig do + override + .returns( + { + data: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + } + ) + end + def to_hash + end + + class Meta < FinchAPI::BaseModel + sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas)) } + def quotas + end + + sig do + params(_: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas) + .returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas) + end + def quotas=(_) + end + + sig { params(quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas).returns(T.attached_class) } + def self.new(quotas: nil) + end + + sig { override.returns({quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas}) } + def to_hash + end + + class Quotas < FinchAPI::BaseModel + sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll)) } + def data_sync_all + end + + sig do + params(_: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll) + .returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll) + end + def data_sync_all=(_) + end + + sig do + params(data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll) + .returns(T.attached_class) + end + def self.new(data_sync_all: nil) + end + + sig do + override.returns({data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll}) + end + def to_hash + end + + class DataSyncAll < FinchAPI::BaseModel + sig { returns(T.nilable(Integer)) } + def allowed_refreshes + end + + sig { params(_: Integer).returns(Integer) } + def allowed_refreshes=(_) + end + + sig { returns(T.nilable(Integer)) } + def remaining_refreshes + end + + sig { params(_: Integer).returns(Integer) } + def remaining_refreshes=(_) + end + + sig do + params(allowed_refreshes: Integer, remaining_refreshes: Integer).returns(T.attached_class) + end + def self.new(allowed_refreshes: nil, remaining_refreshes: nil) + end + + sig { override.returns({allowed_refreshes: Integer, remaining_refreshes: Integer}) } + def to_hash + end + end + end + end + end + end + end +end diff --git a/rbi/lib/finch-api/resources/jobs/automated.rbi b/rbi/lib/finch-api/resources/jobs/automated.rbi index a73a040d..58d66ba3 100644 --- a/rbi/lib/finch-api/resources/jobs/automated.rbi +++ b/rbi/lib/finch-api/resources/jobs/automated.rbi @@ -31,7 +31,7 @@ module FinchAPI offset: Integer, request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) - .returns(FinchAPI::Page[FinchAPI::Models::Jobs::AutomatedAsyncJob]) + .returns(FinchAPI::Models::Jobs::AutomatedListResponse) end def list(limit: nil, offset: nil, request_options: {}) end diff --git a/sig/finch-api/models/jobs/automated_list_response.rbs b/sig/finch-api/models/jobs/automated_list_response.rbs new file mode 100644 index 00000000..417d88ce --- /dev/null +++ b/sig/finch-api/models/jobs/automated_list_response.rbs @@ -0,0 +1,102 @@ +module FinchAPI + module Models + module Jobs + type automated_list_response = + { + data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + } + + class AutomatedListResponse < FinchAPI::BaseModel + attr_accessor data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob] + + attr_accessor meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + + def initialize: + ( + data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + ) -> void + | ( + ?FinchAPI::Models::Jobs::automated_list_response + | FinchAPI::BaseModel data + ) -> void + + def to_hash: -> FinchAPI::Models::Jobs::automated_list_response + + type meta = + { + quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + } + + class Meta < FinchAPI::BaseModel + attr_reader quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas? + + def quotas=: ( + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + ) -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + + def initialize: + ( + quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + ) -> void + | ( + ?FinchAPI::Models::Jobs::AutomatedListResponse::meta + | FinchAPI::BaseModel data + ) -> void + + def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::meta + + type quotas = + { + data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll + } + + class Quotas < FinchAPI::BaseModel + attr_reader data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll? + + def data_sync_all=: ( + FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll + ) -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll + + def initialize: + ( + data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll + ) -> void + | ( + ?FinchAPI::Models::Jobs::AutomatedListResponse::Meta::quotas + | FinchAPI::BaseModel data + ) -> void + + def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::quotas + + type data_sync_all = + { allowed_refreshes: Integer, remaining_refreshes: Integer } + + class DataSyncAll < FinchAPI::BaseModel + attr_reader allowed_refreshes: Integer? + + def allowed_refreshes=: (Integer) -> Integer + + attr_reader remaining_refreshes: Integer? + + def remaining_refreshes=: (Integer) -> Integer + + def initialize: + ( + allowed_refreshes: Integer, + remaining_refreshes: Integer + ) -> void + | ( + ?FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::data_sync_all + | FinchAPI::BaseModel data + ) -> void + + def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::data_sync_all + end + end + end + end + end + end +end diff --git a/sig/finch-api/resources/jobs/automated.rbs b/sig/finch-api/resources/jobs/automated.rbs index 93150c5f..438ca4f3 100644 --- a/sig/finch-api/resources/jobs/automated.rbs +++ b/sig/finch-api/resources/jobs/automated.rbs @@ -28,12 +28,12 @@ module FinchAPI ( ?FinchAPI::Models::Jobs::AutomatedListParams | ::Hash[Symbol, top] params - ) -> FinchAPI::Page[FinchAPI::Models::Jobs::AutomatedAsyncJob] + ) -> FinchAPI::Models::Jobs::AutomatedListResponse | ( limit: Integer, offset: Integer, request_options: FinchAPI::request_opts - ) -> FinchAPI::Page[FinchAPI::Models::Jobs::AutomatedAsyncJob] + ) -> FinchAPI::Models::Jobs::AutomatedListResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/test/finch-api/resources/jobs/automated_test.rb b/test/finch-api/resources/jobs/automated_test.rb index d5a1f007..a7b47234 100644 --- a/test/finch-api/resources/jobs/automated_test.rb +++ b/test/finch-api/resources/jobs/automated_test.rb @@ -49,25 +49,13 @@ def test_list response = @finch.jobs.automated.list assert_pattern do - response => FinchAPI::Page + response => FinchAPI::Models::Jobs::AutomatedListResponse end - row = response.to_enum.first assert_pattern do - row => FinchAPI::Models::Jobs::AutomatedAsyncJob - end - - assert_pattern do - row => { - completed_at: Time | nil, - created_at: Time, - job_id: String, - job_url: String, - params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params | nil, - scheduled_at: Time | nil, - started_at: Time | nil, - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type + response => { + data: ^(FinchAPI::ArrayOf[FinchAPI::Models::Jobs::AutomatedAsyncJob]), + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta } end end From e95562f4be1b85f0c5de44037eb0c64ac0c66dde Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 11 Mar 2025 17:19:05 +0000 Subject: [PATCH 19/67] chore: pagination (#21) --- lib/finch-api/individuals_page.rb | 8 ++++---- lib/finch-api/page.rb | 8 ++++---- lib/finch-api/responses_page.rb | 4 ++-- lib/finch-api/single_page.rb | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index e0bb6864..6e8fd83e 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -60,7 +60,7 @@ def initialize(client:, req:, headers:, page_data:) # @return [Boolean] # def next_page? - paging&.offset.to_i + individuals.size < paging&.count.to_i + paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i end # @raise [FinchAPI::HTTP::Error] @@ -68,10 +68,10 @@ def next_page? # def next_page unless next_page? - raise RuntimeError.new("No more pages available; please check #next_page? before calling #next_page") + raise RuntimeError.new("No more pages available. Please check #next_page? before calling ##{__method__}") end - req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + individuals.size}}) + req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + individuals.to_a.size}}) @client.request(req) end @@ -79,7 +79,7 @@ def next_page # def auto_paging_each(&blk) unless block_given? - raise ArgumentError.new("A block must be given to #auto_paging_each") + raise ArgumentError.new("A block must be given to ##{__method__}") end page = self loop do diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index 0e02faa3..c7d23c9b 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -60,7 +60,7 @@ def initialize(client:, req:, headers:, page_data:) # @return [Boolean] # def next_page? - paging&.offset.to_i + data.size < paging&.count.to_i + paging&.offset.to_i + data.to_a.size < paging&.count.to_i end # @raise [FinchAPI::HTTP::Error] @@ -68,10 +68,10 @@ def next_page? # def next_page unless next_page? - raise RuntimeError.new("No more pages available; please check #next_page? before calling #next_page") + raise RuntimeError.new("No more pages available. Please check #next_page? before calling ##{__method__}") end - req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + data.size}}) + req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + data.to_a.size}}) @client.request(req) end @@ -79,7 +79,7 @@ def next_page # def auto_paging_each(&blk) unless block_given? - raise ArgumentError.new("A block must be given to #auto_paging_each") + raise ArgumentError.new("A block must be given to ##{__method__}") end page = self loop do diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index 8b543983..5f030210 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -58,14 +58,14 @@ def next_page? # @return [FinchAPI::ResponsesPage] # def next_page - raise NotImplementedError + RuntimeError.new("No more pages available.") end # @param blk [Proc] # def auto_paging_each(&blk) unless block_given? - raise ArgumentError.new("A block must be given to #auto_paging_each") + raise ArgumentError.new("A block must be given to ##{__method__}") end page = self loop do diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index 7ed9e046..3d57bff5 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -56,14 +56,14 @@ def next_page? # @return [FinchAPI::SinglePage] # def next_page - raise NotImplementedError + RuntimeError.new("No more pages available.") end # @param blk [Proc] # def auto_paging_each(&blk) unless block_given? - raise ArgumentError.new("A block must be given to #auto_paging_each") + raise ArgumentError.new("A block must be given to ##{__method__}") end page = self loop do From c4ee1708018b48967978e1a94c882e15bc920aa5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 12 Mar 2025 15:57:25 +0000 Subject: [PATCH 20/67] chore: fused enum should use faster internal iteration by default (#22) --- lib/finch-api/base_client.rb | 2 ++ lib/finch-api/pooled_net_requester.rb | 3 ++- lib/finch-api/util.rb | 11 +++++++++-- rbi/lib/finch-api/util.rbi | 7 +++++-- sig/finch-api/util.rbs | 7 ++++++- test/finch-api/util_test.rb | 2 +- 6 files changed, 25 insertions(+), 7 deletions(-) diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index 21cd1e5d..ae3620bf 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -457,8 +457,10 @@ def request(req) # @return [String] # def inspect + # rubocop:disable Layout/LineLength base_url = FinchAPI::Util.unparse_uri(@base_url) "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{base_url} max_retries=#{@max_retries} timeout=#{@timeout}>" + # rubocop:enable Layout/LineLength end end end diff --git a/lib/finch-api/pooled_net_requester.rb b/lib/finch-api/pooled_net_requester.rb index 0087f71d..7b38e863 100644 --- a/lib/finch-api/pooled_net_requester.rb +++ b/lib/finch-api/pooled_net_requester.rb @@ -156,11 +156,12 @@ def execute(request) end conn, response = enum.next - body = FinchAPI::Util.fused_enum(enum) do + body = FinchAPI::Util.fused_enum(enum, external: true) do finished = true tap do enum.next rescue StopIteration + nil end conn.finish if !eof && conn&.started? end diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index d181d88e..79e680e7 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -524,17 +524,22 @@ class << self # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html # # @param enum [Enumerable] + # @param external [Boolean] # @param close [Proc] # # @return [Enumerable] # - def fused_enum(enum, &close) + def fused_enum(enum, external: false, &close) fused = false iter = Enumerator.new do |y| next if fused fused = true - loop { y << enum.next } + if external + loop { y << enum.next } + else + enum.each(&y) + end ensure close&.call close = nil @@ -613,6 +618,7 @@ def decode_lines(enum) # @return [Hash{Symbol=>Object}] # def decode_sse(lines) + # rubocop:disable Metrics/BlockLength chain_fused(lines) do |y| blank = {event: nil, data: nil, id: nil, retry: nil} current = {} @@ -641,6 +647,7 @@ def decode_sse(lines) else end end + # rubocop:enable Metrics/BlockLength y << {**blank, **current} unless current.empty? end diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 14e9e74d..36478fdf 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -152,8 +152,11 @@ module FinchAPI end class << self - sig { params(enum: T::Enumerable[T.anything], close: T.proc.void).returns(T::Enumerable[T.anything]) } - def fused_enum(enum, &close) + sig do + params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void) + .returns(T::Enumerable[T.anything]) + end + def fused_enum(enum, external: false, &close) end sig { params(enum: T.nilable(T::Enumerable[T.anything])).void } diff --git a/sig/finch-api/util.rbs b/sig/finch-api/util.rbs index a658eeda..74adefe6 100644 --- a/sig/finch-api/util.rbs +++ b/sig/finch-api/util.rbs @@ -87,7 +87,12 @@ module FinchAPI suppress_error: bool ) -> top - def self?.fused_enum: (Enumerable[top] enum) { -> void } -> Enumerable[top] + def self?.fused_enum: ( + Enumerable[top] enum, + external: bool + ) { + -> void + } -> Enumerable[top] def self?.close_fused!: (Enumerable[top]? enum) -> void diff --git a/test/finch-api/util_test.rb b/test/finch-api/util_test.rb index f555604e..cd0b6d94 100644 --- a/test/finch-api/util_test.rb +++ b/test/finch-api/util_test.rb @@ -244,7 +244,7 @@ def test_rewind_chain def test_external_iteration it = [1, 2, 3].to_enum first = it.next - fused = FinchAPI::Util.fused_enum(it) + fused = FinchAPI::Util.fused_enum(it, external: true) assert_equal(1, first) assert_equal([2, 3], fused.to_a) From 1896856a88362566dd81a1afed4e97096b62c7d6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 12 Mar 2025 17:33:58 +0000 Subject: [PATCH 21/67] chore: improve documentation (#24) --- README.md | 2 +- lib/finch-api/base_page.rb | 20 ++++++++++++++++++++ lib/finch-api/individuals_page.rb | 10 +++++----- lib/finch-api/page.rb | 2 +- lib/finch-api/responses_page.rb | 10 +++++----- lib/finch-api/single_page.rb | 10 +++++----- 6 files changed, 37 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 7f5b67fa..c0604ca7 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ page = finch.hris.directory.list puts(page.id) ``` -## Pagination +### Pagination List methods in the Finch API are paginated. diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index 99abce0b..d212c61b 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -5,6 +5,26 @@ module FinchAPI # # @abstract # + # @example + # ```ruby + # if page.has_next? + # page = page.next_page + # end + # ``` + # + # @example + # ```ruby + # page.auto_paging_each do |access_token| + # puts(access_token) + # end + # ``` + # + # @example + # ```ruby + # access_tokens = page.to_enum.take(2) + # + # access_tokens => Array + # ``` module BasePage # @return [Boolean] # diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index 6e8fd83e..35d3ec4b 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -4,22 +4,22 @@ module FinchAPI # @example # ```ruby # if individuals_page.has_next? - # page = individuals_page.next_page + # individuals_page = individuals_page.next_page # end # ``` # # @example # ```ruby - # individuals_page.auto_paging_each do |item| - # # item ... + # individuals_page.auto_paging_each do |directory| + # puts(directory) # end # ``` # # @example # ```ruby - # items = individuals_page.to_enum.take(2) + # directories = individuals_page.to_enum.take(2) # - # items => Array + # directories => Array # ``` class IndividualsPage include FinchAPI::BasePage diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index c7d23c9b..12d6d2af 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -11,7 +11,7 @@ module FinchAPI # @example # ```ruby # page.auto_paging_each do |item| - # # item ... + # puts(item) # end # ``` # diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index 5f030210..155e4609 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -4,22 +4,22 @@ module FinchAPI # @example # ```ruby # if responses_page.has_next? - # page = responses_page.next_page + # responses_page = responses_page.next_page # end # ``` # # @example # ```ruby - # responses_page.auto_paging_each do |item| - # # item ... + # responses_page.auto_paging_each do |individual| + # puts(individual) # end # ``` # # @example # ```ruby - # items = responses_page.to_enum.take(2) + # individuals = responses_page.to_enum.take(2) # - # items => Array + # individuals => Array # ``` class ResponsesPage include FinchAPI::BasePage diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index 3d57bff5..69b2c104 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -4,22 +4,22 @@ module FinchAPI # @example # ```ruby # if single_page.has_next? - # page = single_page.next_page + # single_page = single_page.next_page # end # ``` # # @example # ```ruby - # single_page.auto_paging_each do |item| - # # item ... + # single_page.auto_paging_each do |payment| + # puts(payment) # end # ``` # # @example # ```ruby - # items = single_page.to_enum.take(2) + # payments = single_page.to_enum.take(2) # - # items => Array + # payments => Array # ``` class SinglePage < ::Array include FinchAPI::BasePage From 5adeadbe7a0cbeb213d9a37cebe6b8c04288c98a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 12 Mar 2025 20:38:16 +0000 Subject: [PATCH 22/67] feat: support streaming uploads (#25) --- lib/finch-api/pooled_net_requester.rb | 30 +++- lib/finch-api/util.rb | 181 +++++++++++++++------ rbi/lib/finch-api/pooled_net_requester.rbi | 11 +- rbi/lib/finch-api/util.rbi | 36 +++- sig/finch-api/pooled_net_requester.rbs | 6 +- sig/finch-api/util.rbs | 22 ++- test/finch-api/util_test.rb | 33 +++- 7 files changed, 252 insertions(+), 67 deletions(-) diff --git a/lib/finch-api/pooled_net_requester.rb b/lib/finch-api/pooled_net_requester.rb index 7b38e863..eeefdf72 100644 --- a/lib/finch-api/pooled_net_requester.rb +++ b/lib/finch-api/pooled_net_requester.rb @@ -48,9 +48,11 @@ def calibrate_socket_timeout(conn, deadline) # # @option request [Hash{String=>String}] :headers # + # @param blk [Proc] + # # @return [Net::HTTPGenericRequest] # - def build_request(request) + def build_request(request, &) method, url, headers, body = request.fetch_values(:method, :url, :headers, :body) req = Net::HTTPGenericRequest.new( method.to_s.upcase, @@ -64,12 +66,14 @@ def build_request(request) case body in nil in String - req.body = body + req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"] + req.body_stream = FinchAPI::Util::ReadIOAdapter.new(body, &) in StringIO - req.body = body.string - in IO - body.rewind - req.body_stream = body + req["content-length"] ||= body.size.to_s unless req["transfer-encoding"] + req.body_stream = FinchAPI::Util::ReadIOAdapter.new(body, &) + in IO | Enumerator + req["transfer-encoding"] ||= "chunked" unless req["content-length"] + req.body_stream = FinchAPI::Util::ReadIOAdapter.new(body, &) end req @@ -97,7 +101,7 @@ def build_request(request) pool = @mutex.synchronize do - @pools[origin] ||= ConnectionPool.new(size: Etc.nprocessors) do + @pools[origin] ||= ConnectionPool.new(size: @size) do self.class.connect(url) end end @@ -128,7 +132,6 @@ def build_request(request) # def execute(request) url, deadline = request.fetch_values(:url, :deadline) - req = self.class.build_request(request) eof = false finished = false @@ -136,6 +139,10 @@ def execute(request) with_pool(url) do |conn| next if finished + req = self.class.build_request(request) do + self.class.calibrate_socket_timeout(conn, deadline) + end + self.class.calibrate_socket_timeout(conn, deadline) conn.start unless conn.started? @@ -168,8 +175,13 @@ def execute(request) [response, (response.body = body)] end - def initialize + # @private + # + # @param size [Integer] + # + def initialize(size: Etc.nprocessors) @mutex = Mutex.new + @size = size @pools = {} end end diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 79e680e7..dae7b9ed 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -399,41 +399,152 @@ def normalized_headers(*headers) end end + # @private + # + # An adapter that satisfies the IO interface required by `::IO.copy_stream` + class ReadIOAdapter + # @private + # + # @param max_len [Integer, nil] + # + # @return [String] + # + private def read_enum(max_len) + case max_len + in nil + @stream.to_a.join + in Integer + @buf << @stream.next while @buf.length < max_len + @buf.slice!(..max_len) + end + rescue StopIteration + @stream = nil + @buf.slice!(0..) + end + + # @private + # + # @param max_len [Integer, nil] + # @param out_string [String, nil] + # + # @return [String, nil] + # + def read(max_len = nil, out_string = nil) + case @stream + in nil + nil + in IO | StringIO + @stream.read(max_len, out_string) + in Enumerator + read = read_enum(max_len) + case out_string + in String + out_string.replace(read) + in nil + read + end + end + .tap(&@blk) + end + + # @private + # + # @param stream [String, IO, StringIO, Enumerable] + # @param blk [Proc] + # + def initialize(stream, &blk) + @stream = stream.is_a?(String) ? StringIO.new(stream) : stream + @buf = String.new.b + @blk = blk + end + end + + class << self + # @param blk [Proc] + # + # @return [Enumerable] + # + def string_io(&blk) + Enumerator.new do |y| + y.define_singleton_method(:write) do + self << _1.clone + _1.bytesize + end + + blk.call(y) + end + end + end + class << self # @private # - # @param io [StringIO] + # @param y [Enumerator::Yielder] # @param boundary [String] # @param key [Symbol, String] # @param val [Object] # - private def encode_multipart_formdata(io, boundary:, key:, val:) - io << "--#{boundary}\r\n" - io << "Content-Disposition: form-data" + private def encode_multipart_formdata(y, boundary:, key:, val:) + y << "--#{boundary}\r\n" + y << "Content-Disposition: form-data" unless key.nil? name = ERB::Util.url_encode(key.to_s) - io << "; name=\"#{name}\"" + y << "; name=\"#{name}\"" end if val.is_a?(IO) filename = ERB::Util.url_encode(File.basename(val.to_path)) - io << "; filename=\"#{filename}\"" + y << "; filename=\"#{filename}\"" end - io << "\r\n" + y << "\r\n" case val - in IO | StringIO - io << "Content-Type: application/octet-stream\r\n\r\n" - IO.copy_stream(val, io) + in IO + y << "Content-Type: application/octet-stream\r\n\r\n" + IO.copy_stream(val, y) + in StringIO + y << "Content-Type: application/octet-stream\r\n\r\n" + y << val.string in String - io << "Content-Type: application/octet-stream\r\n\r\n" - io << val.to_s + y << "Content-Type: application/octet-stream\r\n\r\n" + y << val.to_s in true | false | Integer | Float | Symbol - io << "Content-Type: text/plain\r\n\r\n" - io << val.to_s + y << "Content-Type: text/plain\r\n\r\n" + y << val.to_s else - io << "Content-Type: application/json\r\n\r\n" - io << JSON.fast_generate(val) + y << "Content-Type: application/json\r\n\r\n" + y << JSON.fast_generate(val) end - io << "\r\n" + y << "\r\n" + end + + # @private + # + # @param body [Object] + # + # @return [Array(String, Enumerable)] + # + private def encode_multipart_streaming(body) + boundary = SecureRandom.urlsafe_base64(60) + + strio = string_io do |y| + case body + in Hash + body.each do |key, val| + case val + in Array if val.all? { primitive?(_1) } + val.each do |v| + encode_multipart_formdata(y, boundary: boundary, key: key, val: v) + end + else + encode_multipart_formdata(y, boundary: boundary, key: key, val: val) + end + end + else + encode_multipart_formdata(y, boundary: boundary, key: nil, val: body) + end + y << "--#{boundary}--\r\n" + end + + [boundary, strio] end # @private @@ -449,37 +560,11 @@ def encode_content(headers, body) in ["application/json", Hash | Array] [headers, JSON.fast_generate(body)] in [%r{^multipart/form-data}, Hash | IO | StringIO] - boundary = SecureRandom.urlsafe_base64(60) - strio = StringIO.new.tap do |io| - case body - in Hash - body.each do |key, val| - case val - in Array if val.all? { primitive?(_1) } - val.each do |v| - encode_multipart_formdata(io, boundary: boundary, key: key, val: v) - end - else - encode_multipart_formdata(io, boundary: boundary, key: key, val: val) - end - end - else - encode_multipart_formdata(io, boundary: boundary, key: nil, val: body) - end - io << "--#{boundary}--\r\n" - io.rewind - end - headers = { - **headers, - "content-type" => "#{content_type}; boundary=#{boundary}", - "transfer-encoding" => "chunked" - } + boundary, strio = encode_multipart_streaming(body) + headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"} [headers, strio] in [_, StringIO] [headers, body.string] - in [_, IO] - headers = {**headers, "transfer-encoding" => "chunked"} - [headers, body] else [headers, body] end @@ -589,8 +674,9 @@ def decode_lines(enum) chain_fused(enum) do |y| enum.each do |row| + offset = buffer.bytesize buffer << row - while (match = re.match(buffer, cr_seen.to_i)) + while (match = re.match(buffer, cr_seen&.to_i || offset)) case [match.captures.first, cr_seen] in ["\r", nil] cr_seen = match.end(1) @@ -600,6 +686,7 @@ def decode_lines(enum) else y << buffer.slice!(..(match.end(1).pred)) end + offset = 0 cr_seen = nil end end @@ -637,7 +724,7 @@ def decode_sse(lines) in "event" current.merge!(event: value) in "data" - (current[:data] ||= String.new.b) << value << "\n" + (current[:data] ||= String.new.b) << (value << "\n") in "id" unless value.include?("\0") current.merge!(id: value) in "retry" if /^\d+$/ =~ value diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index 0abea432..5f90cab1 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -15,8 +15,11 @@ module FinchAPI def calibrate_socket_timeout(conn, deadline) end - sig { params(request: FinchAPI::PooledNetRequester::RequestShape).returns(Net::HTTPGenericRequest) } - def build_request(request) + sig do + params(request: FinchAPI::PooledNetRequester::RequestShape, blk: T.proc.params(arg0: String).void) + .returns(Net::HTTPGenericRequest) + end + def build_request(request, &blk) end end @@ -31,8 +34,8 @@ module FinchAPI def execute(request) end - sig { returns(T.attached_class) } - def self.new + sig { params(size: Integer).returns(T.attached_class) } + def self.new(size: Etc.nprocessors) end end end diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 36478fdf..d01babac 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -130,9 +130,41 @@ module FinchAPI end end + class ReadIOAdapter + sig { params(max_len: T.nilable(Integer)).returns(String) } + private def read_enum(max_len) + end + + sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) } + def read(max_len = nil, out_string = nil) + end + + sig do + params( + stream: T.any(String, IO, StringIO, T::Enumerable[String]), + blk: T.proc.params(arg0: String).void + ) + .returns(T.attached_class) + end + def self.new(stream, &blk) + end + end + + class << self + sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) } + def string_io(&blk) + end + end + class << self - sig { params(io: StringIO, boundary: String, key: T.any(Symbol, String), val: T.anything).void } - private def encode_multipart_formdata(io, boundary:, key:, val:) + sig do + params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void + end + private def encode_multipart_formdata(y, boundary:, key:, val:) + end + + sig { params(body: T.anything).returns([String, T::Enumerable[String]]) } + private def encode_multipart_streaming(body) end sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) } diff --git a/sig/finch-api/pooled_net_requester.rbs b/sig/finch-api/pooled_net_requester.rbs index 80a36fd0..71660d52 100644 --- a/sig/finch-api/pooled_net_requester.rbs +++ b/sig/finch-api/pooled_net_requester.rbs @@ -15,7 +15,9 @@ module FinchAPI def self.build_request: ( FinchAPI::PooledNetRequester::request request - ) -> top + ) { + (String arg0) -> void + } -> top private def with_pool: (URI::Generic url) { (top arg0) -> void } -> void @@ -23,6 +25,6 @@ module FinchAPI FinchAPI::PooledNetRequester::request request ) -> [top, Enumerable[String]] - def initialize: -> void + def initialize: (size: Integer) -> void end end diff --git a/sig/finch-api/util.rbs b/sig/finch-api/util.rbs index 74adefe6..28d21827 100644 --- a/sig/finch-api/util.rbs +++ b/sig/finch-api/util.rbs @@ -72,13 +72,33 @@ module FinchAPI | ::Array[(String | Integer)?])?] headers ) -> ::Hash[String, String] + class ReadIOAdapter + private def read_enum: (Integer? max_len) -> String + + def read: (?Integer? max_len, ?String? out_string) -> String? + + def initialize: ( + String | IO | StringIO | Enumerable[String] stream + ) { + (String arg0) -> void + } -> void + end + + def self?.string_io: { + (Enumerator::Yielder y) -> void + } -> Enumerable[String] + def self?.encode_multipart_formdata: ( - StringIO io, + Enumerator::Yielder y, boundary: String, key: Symbol | String, val: top ) -> void + def self?.encode_multipart_streaming: ( + top body + ) -> [String, Enumerable[String]] + def self?.encode_content: (::Hash[String, String] headers, top body) -> top def self?.decode_content: ( diff --git a/test/finch-api/util_test.rb b/test/finch-api/util_test.rb index cd0b6d94..8a647c91 100644 --- a/test/finch-api/util_test.rb +++ b/test/finch-api/util_test.rb @@ -161,7 +161,8 @@ class FinchAPI::Test::UtilFormDataEncodingTest < Minitest::Test class FakeCGI < CGI def initialize(headers, io) @ctype = headers["content-type"] - @io = io + @io = FinchAPI::Util::ReadIOAdapter.new(io) {} + @c_len = io.to_a.join.bytesize.to_s super() end @@ -171,7 +172,7 @@ def env_table { "REQUEST_METHOD" => "POST", "CONTENT_TYPE" => @ctype, - "CONTENT_LENGTH" => stdinput.string.length + "CONTENT_LENGTH" => @c_len } end end @@ -208,6 +209,34 @@ def test_hash_encode end end +class FinchAPI::Test::UtilIOAdapterTest < Minitest::Test + def test_copy_read + cases = { + StringIO.new("abc") => "abc", + Enumerator.new { _1 << "abc" } => "abc" + } + cases.each do |input, expected| + io = StringIO.new + adapter = FinchAPI::Util::ReadIOAdapter.new(input) {} + IO.copy_stream(adapter, io) + assert_equal(expected, io.string) + end + end + + def test_copy_write + cases = { + StringIO.new => "", + StringIO.new("abc") => "abc" + } + cases.each do |input, expected| + enum = FinchAPI::Util.string_io do |y| + IO.copy_stream(input, y) + end + assert_equal(expected, enum.to_a.join) + end + end +end + class FinchAPI::Test::UtilFusedEnumTest < Minitest::Test def test_closing arr = [1, 2, 3] From d0260a33499410c0e267b01b8583d2d072b7ae61 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 12 Mar 2025 21:02:43 +0000 Subject: [PATCH 23/67] fix: enums should only coerce matching symbols into strings (#26) --- lib/finch-api/base_model.rb | 29 +++++++++++++++++++++++++---- test/finch-api/base_model_test.rb | 16 +++++++++++++++- 2 files changed, 40 insertions(+), 5 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index e8170289..e90812e5 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -55,11 +55,11 @@ def type_info(spec) type_info(spec.slice(:const, :enum, :union).first&.last) in Proc spec - in FinchAPI::Converter | Class + in FinchAPI::Converter | Class | Symbol -> { spec } in true | false -> { FinchAPI::BooleanModel } - in NilClass | true | false | Symbol | Integer | Float + in NilClass | Integer | Float -> { spec.class } end end @@ -82,6 +82,13 @@ def coerce(target, value) case target in FinchAPI::Converter target.coerce(value) + in Symbol + case value + in Symbol | String if (val = value.to_sym) == target + val + else + value + end in Class case target in -> { _1 <= NilClass } @@ -140,6 +147,13 @@ def try_strict_coerce(target, value) case target in FinchAPI::Converter target.try_strict_coerce(value) + in Symbol + case value + in Symbol | String if (val = value.to_sym) == target + [true, val, 1] + else + [false, false, 0] + end in Class case [target, value] in [-> { _1 <= NilClass }, _] @@ -367,7 +381,14 @@ class << self # # @return [Symbol, Object] # - def coerce(value) = (value.is_a?(String) ? value.to_sym : value) + def coerce(value) + case value + in Symbol | String if values.include?(val = value.to_sym) + val + else + value + end + end # @!parse # # @private @@ -388,7 +409,7 @@ def try_strict_coerce(value) return [true, value, 1] if values.include?(value) case value - in String if values.include?(val = value.to_sym) + in Symbol | String if values.include?(val = value.to_sym) [true, val, 1] else case [value, values.first] diff --git a/test/finch-api/base_model_test.rb b/test/finch-api/base_model_test.rb index f1002ea7..a95f1c32 100644 --- a/test/finch-api/base_model_test.rb +++ b/test/finch-api/base_model_test.rb @@ -22,7 +22,7 @@ def test_basic_coerce end assert_pattern do - FinchAPI::Converter.coerce(A2, %w[a b c]) => [:a, :b, :c] + FinchAPI::Converter.coerce(A2, %w[a b c]) => [:a, :b, "c"] end end @@ -338,4 +338,18 @@ def test_basic_eql refute_equal(U1, U2) assert_equal(U1, U3) end + + class U4 < FinchAPI::Union + variant :a, const: :a + variant :b, const: :b + end + + def test_basic_const_union + assert_pattern do + U4.coerce(nil) => nil + U4.coerce("") => "" + U4.coerce(:a) => :a + U4.coerce("a") => :a + end + end end From 3fbfa6cf8802942f58d331a1193b9ed537f5669d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 12 Mar 2025 22:59:42 +0000 Subject: [PATCH 24/67] chore: remove stale thread local checks (#27) --- lib/finch-api/pooled_net_requester.rb | 21 ++------------------- 1 file changed, 2 insertions(+), 19 deletions(-) diff --git a/lib/finch-api/pooled_net_requester.rb b/lib/finch-api/pooled_net_requester.rb index eeefdf72..7c33d507 100644 --- a/lib/finch-api/pooled_net_requester.rb +++ b/lib/finch-api/pooled_net_requester.rb @@ -85,20 +85,8 @@ def build_request(request, &) # @param url [URI::Generic] # @param blk [Proc] # - private def with_pool(url, &blk) + private def with_pool(url, &) origin = FinchAPI::Util.uri_origin(url) - th = Thread.current - key = :"#{object_id}-#{self.class.name}-connection_in_use_for_#{origin}" - - if th[key] - tap do - conn = self.class.connect(url) - return blk.call(conn) - ensure - conn.finish if conn&.started? - end - end - pool = @mutex.synchronize do @pools[origin] ||= ConnectionPool.new(size: @size) do @@ -106,12 +94,7 @@ def build_request(request, &) end end - pool.with do |conn| - th[key] = true - blk.call(conn) - ensure - th[key] = nil - end + pool.with(&) end # @private From 0b49043f7bcd2fa9cc522ca65945634add1338a8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 15:21:06 +0000 Subject: [PATCH 25/67] chore: refactor BasePage to have initializer (#28) --- lib/finch-api.rb | 1 + lib/finch-api/base_page.rb | 21 ++++++++++++--------- lib/finch-api/individuals_page.rb | 6 +----- lib/finch-api/page.rb | 6 +----- lib/finch-api/responses_page.rb | 6 +----- lib/finch-api/single_page.rb | 9 ++------- manifest.yaml | 1 + 7 files changed, 19 insertions(+), 31 deletions(-) diff --git a/lib/finch-api.rb b/lib/finch-api.rb index f0fa4ae5..33a05cae 100644 --- a/lib/finch-api.rb +++ b/lib/finch-api.rb @@ -7,6 +7,7 @@ require "etc" require "json" require "net/http" +require "pathname" require "rbconfig" require "securerandom" require "set" diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index d212c61b..23fb80fd 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -47,14 +47,17 @@ def to_enum = super(:auto_paging_each) alias_method :enum_for, :to_enum - # @!parse - # # @private - # # - # # @param client [FinchAPI::BaseClient] - # # @param req [Hash{Symbol=>Object}] - # # @param headers [Hash{String=>String}, Net::HTTPHeader] - # # @param page_data [Object] - # # - # def initialize(client:, req:, headers:, page_data:); end + # @private + # + # @param client [FinchAPI::BaseClient] + # @param req [Hash{Symbol=>Object}] + # @param headers [Hash{String=>String}, Net::HTTPHeader] + # @param page_data [Object] + # + def initialize(client:, req:, headers:, page_data:) + @client = client + @req = req + super() + end end end diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index 35d3ec4b..fd871aff 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -30,7 +30,6 @@ class IndividualsPage # @return [FinchAPI::Models::Paging] attr_accessor :paging - # rubocop:disable Lint/UnusedMethodArgument # @private # # @param client [FinchAPI::BaseClient] @@ -39,8 +38,7 @@ class IndividualsPage # @param page_data [Hash{Symbol=>Object}] # def initialize(client:, req:, headers:, page_data:) - @client = client - @req = req + super model = req.fetch(:model) case page_data @@ -55,10 +53,8 @@ def initialize(client:, req:, headers:, page_data:) else end end - # rubocop:enable Lint/UnusedMethodArgument # @return [Boolean] - # def next_page? paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i end diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index 12d6d2af..955f34ae 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -30,7 +30,6 @@ class Page # @return [FinchAPI::Models::Paging] attr_accessor :paging - # rubocop:disable Lint/UnusedMethodArgument # @private # # @param client [FinchAPI::BaseClient] @@ -39,8 +38,7 @@ class Page # @param page_data [Hash{Symbol=>Object}] # def initialize(client:, req:, headers:, page_data:) - @client = client - @req = req + super model = req.fetch(:model) case page_data @@ -55,10 +53,8 @@ def initialize(client:, req:, headers:, page_data:) else end end - # rubocop:enable Lint/UnusedMethodArgument # @return [Boolean] - # def next_page? paging&.offset.to_i + data.to_a.size < paging&.count.to_i end diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index 155e4609..b50d12fb 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -27,7 +27,6 @@ class ResponsesPage # @return [Array] attr_accessor :responses - # rubocop:disable Lint/UnusedMethodArgument # @private # # @param client [FinchAPI::BaseClient] @@ -36,8 +35,7 @@ class ResponsesPage # @param page_data [Array] # def initialize(client:, req:, headers:, page_data:) - @client = client - @req = req + super model = req.fetch(:model) case page_data @@ -46,10 +44,8 @@ def initialize(client:, req:, headers:, page_data:) else end end - # rubocop:enable Lint/UnusedMethodArgument # @return [Boolean] - # def next_page? false end diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index 69b2c104..1920206e 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -24,7 +24,6 @@ module FinchAPI class SinglePage < ::Array include FinchAPI::BasePage - # rubocop:disable Lint/UnusedMethodArgument # @private # # @param client [FinchAPI::BaseClient] @@ -33,21 +32,17 @@ class SinglePage < ::Array # @param page_data [Array] # def initialize(client:, req:, headers:, page_data:) - @client = client - @req = req + super model = req.fetch(:model) case page_data in Array - super(page_data&.map { model.coerce(_1) }) + replace(page_data&.map { model.coerce(_1) }) else - super([]) end end - # rubocop:enable Lint/UnusedMethodArgument # @return [Boolean] - # def next_page? false end diff --git a/manifest.yaml b/manifest.yaml index e2306edd..fa9c3e5e 100644 --- a/manifest.yaml +++ b/manifest.yaml @@ -5,6 +5,7 @@ dependencies: - etc - json - net/http + - pathname - rbconfig - securerandom - set From ac6b9994ed71d42702133590144fe5a22c273111 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 16:30:15 +0000 Subject: [PATCH 26/67] chore: improve rbi typedef for page classes (#29) --- rbi/lib/finch-api/individuals_page.rbi | 4 ++-- rbi/lib/finch-api/page.rbi | 4 ++-- rbi/lib/finch-api/responses_page.rbi | 4 ++-- rbi/lib/finch-api/single_page.rbi | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/rbi/lib/finch-api/individuals_page.rbi b/rbi/lib/finch-api/individuals_page.rbi index c0fb6f19..d4a9dc49 100644 --- a/rbi/lib/finch-api/individuals_page.rbi +++ b/rbi/lib/finch-api/individuals_page.rbi @@ -29,9 +29,9 @@ module FinchAPI headers: T.any(T::Hash[String, String], Net::HTTPHeader), page_data: T::Hash[Symbol, T.anything] ) - .void + .returns(T.attached_class) end - def initialize(client:, req:, headers:, page_data:) + def self.new(client:, req:, headers:, page_data:) end end end diff --git a/rbi/lib/finch-api/page.rbi b/rbi/lib/finch-api/page.rbi index 5d4c8f8f..098d52a0 100644 --- a/rbi/lib/finch-api/page.rbi +++ b/rbi/lib/finch-api/page.rbi @@ -29,9 +29,9 @@ module FinchAPI headers: T.any(T::Hash[String, String], Net::HTTPHeader), page_data: T::Hash[Symbol, T.anything] ) - .void + .returns(T.attached_class) end - def initialize(client:, req:, headers:, page_data:) + def self.new(client:, req:, headers:, page_data:) end end end diff --git a/rbi/lib/finch-api/responses_page.rbi b/rbi/lib/finch-api/responses_page.rbi index f4aa8481..f1c9f771 100644 --- a/rbi/lib/finch-api/responses_page.rbi +++ b/rbi/lib/finch-api/responses_page.rbi @@ -21,9 +21,9 @@ module FinchAPI headers: T.any(T::Hash[String, String], Net::HTTPHeader), page_data: T::Array[T.anything] ) - .void + .returns(T.attached_class) end - def initialize(client:, req:, headers:, page_data:) + def self.new(client:, req:, headers:, page_data:) end end end diff --git a/rbi/lib/finch-api/single_page.rbi b/rbi/lib/finch-api/single_page.rbi index c88f53ea..3a1f1000 100644 --- a/rbi/lib/finch-api/single_page.rbi +++ b/rbi/lib/finch-api/single_page.rbi @@ -13,9 +13,9 @@ module FinchAPI headers: T.any(T::Hash[String, String], Net::HTTPHeader), page_data: T::Array[T.anything] ) - .void + .returns(T.attached_class) end - def initialize(client:, req:, headers:, page_data:) + def self.new(client:, req:, headers:, page_data:) end sig { override.returns(T::Boolean) } From d8c970e6728b8a61c13e518850776d75cbdcece8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 16:46:36 +0000 Subject: [PATCH 27/67] chore(internal): remove extra empty newlines (#30) --- .github/workflows/ci.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 32e3f314..6992080f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -42,4 +42,3 @@ jobs: - name: Run tests run: ./scripts/test - From 74a9ff6839ce6c108514d1197987e5a6223a571e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 18:11:06 +0000 Subject: [PATCH 28/67] chore: sdk internal updates (#31) --- lib/finch-api/util.rb | 7 +++++-- rbi/lib/finch-api/individuals_page.rbi | 12 ------------ rbi/lib/finch-api/page.rbi | 12 ------------ rbi/lib/finch-api/responses_page.rbi | 12 ------------ rbi/lib/finch-api/single_page.rbi | 12 ------------ rbi/lib/finch-api/util.rbi | 4 ++-- sig/finch-api/individuals_page.rbs | 7 ------- sig/finch-api/page.rbs | 7 ------- sig/finch-api/responses_page.rbs | 7 ------- sig/finch-api/single_page.rbs | 7 ------- sig/finch-api/util.rbs | 4 ++-- 11 files changed, 9 insertions(+), 82 deletions(-) diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index dae7b9ed..6c8614e3 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -557,7 +557,7 @@ class << self def encode_content(headers, body) content_type = headers["content-type"] case [content_type, body] - in ["application/json", Hash | Array] + in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array] [headers, JSON.fast_generate(body)] in [%r{^multipart/form-data}, Hash | IO | StringIO] boundary, strio = encode_multipart_streaming(body) @@ -593,7 +593,10 @@ def decode_content(headers, stream:, suppress_error: false) lines = decode_lines(stream) decode_sse(lines) in %r{^application/(?:x-)?jsonl} - decode_lines(stream) + lines = decode_lines(stream) + chain_fused(lines) do |y| + lines.each { y << JSON.parse(_1, symbolize_names: true) } + end in %r{^text/} stream.to_a.join else diff --git a/rbi/lib/finch-api/individuals_page.rbi b/rbi/lib/finch-api/individuals_page.rbi index d4a9dc49..be04110a 100644 --- a/rbi/lib/finch-api/individuals_page.rbi +++ b/rbi/lib/finch-api/individuals_page.rbi @@ -21,17 +21,5 @@ module FinchAPI sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } def paging=(_) end - - sig do - params( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::RequestComponentsShape, - headers: T.any(T::Hash[String, String], Net::HTTPHeader), - page_data: T::Hash[Symbol, T.anything] - ) - .returns(T.attached_class) - end - def self.new(client:, req:, headers:, page_data:) - end end end diff --git a/rbi/lib/finch-api/page.rbi b/rbi/lib/finch-api/page.rbi index 098d52a0..4edca1be 100644 --- a/rbi/lib/finch-api/page.rbi +++ b/rbi/lib/finch-api/page.rbi @@ -21,17 +21,5 @@ module FinchAPI sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } def paging=(_) end - - sig do - params( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::RequestComponentsShape, - headers: T.any(T::Hash[String, String], Net::HTTPHeader), - page_data: T::Hash[Symbol, T.anything] - ) - .returns(T.attached_class) - end - def self.new(client:, req:, headers:, page_data:) - end end end diff --git a/rbi/lib/finch-api/responses_page.rbi b/rbi/lib/finch-api/responses_page.rbi index f1c9f771..7fbdd9e0 100644 --- a/rbi/lib/finch-api/responses_page.rbi +++ b/rbi/lib/finch-api/responses_page.rbi @@ -13,17 +13,5 @@ module FinchAPI sig { params(_: T::Array[Elem]).returns(T::Array[Elem]) } def responses=(_) end - - sig do - params( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::RequestComponentsShape, - headers: T.any(T::Hash[String, String], Net::HTTPHeader), - page_data: T::Array[T.anything] - ) - .returns(T.attached_class) - end - def self.new(client:, req:, headers:, page_data:) - end end end diff --git a/rbi/lib/finch-api/single_page.rbi b/rbi/lib/finch-api/single_page.rbi index 3a1f1000..54ae37cb 100644 --- a/rbi/lib/finch-api/single_page.rbi +++ b/rbi/lib/finch-api/single_page.rbi @@ -6,18 +6,6 @@ module FinchAPI Elem = type_member - sig do - params( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::RequestComponentsShape, - headers: T.any(T::Hash[String, String], Net::HTTPHeader), - page_data: T::Array[T.anything] - ) - .returns(T.attached_class) - end - def self.new(client:, req:, headers:, page_data:) - end - sig { override.returns(T::Boolean) } def next_page? end diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index d01babac..4e48c0bc 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -205,7 +205,7 @@ module FinchAPI end end - SSEMessage = T.type_alias do + ServerSentEvent = T.type_alias do {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)} end @@ -214,7 +214,7 @@ module FinchAPI def decode_lines(enum) end - sig { params(lines: T::Enumerable[String]).returns(FinchAPI::Util::SSEMessage) } + sig { params(lines: T::Enumerable[String]).returns(FinchAPI::Util::ServerSentEvent) } def decode_sse(lines) end end diff --git a/sig/finch-api/individuals_page.rbs b/sig/finch-api/individuals_page.rbs index 99dc7aa5..f969517f 100644 --- a/sig/finch-api/individuals_page.rbs +++ b/sig/finch-api/individuals_page.rbs @@ -5,12 +5,5 @@ module FinchAPI attr_accessor individuals: ::Array[Elem] attr_accessor paging: FinchAPI::Models::Paging - - def initialize: ( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::request_components, - headers: ::Hash[String, String], - page_data: ::Hash[Symbol, top] - ) -> void end end diff --git a/sig/finch-api/page.rbs b/sig/finch-api/page.rbs index 00a92ead..a4bb2473 100644 --- a/sig/finch-api/page.rbs +++ b/sig/finch-api/page.rbs @@ -5,12 +5,5 @@ module FinchAPI attr_accessor data: ::Array[Elem] attr_accessor paging: FinchAPI::Models::Paging - - def initialize: ( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::request_components, - headers: ::Hash[String, String], - page_data: ::Hash[Symbol, top] - ) -> void end end diff --git a/sig/finch-api/responses_page.rbs b/sig/finch-api/responses_page.rbs index 9df96faa..b68444a4 100644 --- a/sig/finch-api/responses_page.rbs +++ b/sig/finch-api/responses_page.rbs @@ -3,12 +3,5 @@ module FinchAPI include FinchAPI::BasePage[Elem] attr_accessor responses: ::Array[Elem] - - def initialize: ( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::request_components, - headers: ::Hash[String, String], - page_data: ::Array[top] - ) -> void end end diff --git a/sig/finch-api/single_page.rbs b/sig/finch-api/single_page.rbs index 65d4b480..8db70e39 100644 --- a/sig/finch-api/single_page.rbs +++ b/sig/finch-api/single_page.rbs @@ -2,13 +2,6 @@ module FinchAPI class SinglePage[Elem] < ::Array[Elem] include FinchAPI::BasePage[Elem] - def initialize: ( - client: FinchAPI::BaseClient, - req: FinchAPI::BaseClient::request_components, - headers: ::Hash[String, String], - page_data: ::Array[top] - ) -> void - def next_page?: -> bool def next_page: -> self diff --git a/sig/finch-api/util.rbs b/sig/finch-api/util.rbs index 28d21827..ed376006 100644 --- a/sig/finch-api/util.rbs +++ b/sig/finch-api/util.rbs @@ -122,13 +122,13 @@ module FinchAPI (Enumerator::Yielder arg0) -> void } -> void - type sse_message = + type server_sent_event = { event: String?, data: String?, id: String?, retry: Integer? } def self?.decode_lines: (Enumerable[String] enum) -> Enumerable[String] def self?.decode_sse: ( Enumerable[String] lines - ) -> FinchAPI::Util::sse_message + ) -> FinchAPI::Util::server_sent_event end end From fd8bb80dd8174a3da2e715313e5348b6ad61e75f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 19:30:03 +0000 Subject: [PATCH 29/67] feat: support jsonl uploads (#32) --- lib/finch-api/util.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 6c8614e3..72f9b5cd 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -559,6 +559,8 @@ def encode_content(headers, body) case [content_type, body] in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array] [headers, JSON.fast_generate(body)] + in [%r{^application/(?:x-)?jsonl}, Enumerable] + [headers, body.lazy.map { JSON.fast_generate(_1) }] in [%r{^multipart/form-data}, Hash | IO | StringIO] boundary, strio = encode_multipart_streaming(body) headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"} @@ -589,14 +591,14 @@ def decode_content(headers, stream:, suppress_error: false) raise e unless suppress_error json end - in %r{^text/event-stream} - lines = decode_lines(stream) - decode_sse(lines) in %r{^application/(?:x-)?jsonl} lines = decode_lines(stream) chain_fused(lines) do |y| lines.each { y << JSON.parse(_1, symbolize_names: true) } end + in %r{^text/event-stream} + lines = decode_lines(stream) + decode_sse(lines) in %r{^text/} stream.to_a.join else From e366baa122865a1734c9e17bba6a0531c115c1a3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 14 Mar 2025 08:49:24 +0000 Subject: [PATCH 30/67] chore: add most doc strings to rbi type definitions (#33) --- .yardopts | 2 + lib/finch-api/base_client.rb | 35 ++-- lib/finch-api/base_model.rb | 173 ++++++------------ lib/finch-api/base_page.rb | 9 +- lib/finch-api/client.rb | 10 +- lib/finch-api/errors.rb | 15 +- lib/finch-api/extern.rb | 3 +- lib/finch-api/individuals_page.rb | 6 +- lib/finch-api/models/account_update_event.rb | 1 - lib/finch-api/models/company_event.rb | 1 - .../models/connect/session_new_params.rb | 2 - .../models/connection_status_type.rb | 1 - lib/finch-api/models/directory_event.rb | 1 - lib/finch-api/models/employment_event.rb | 1 - .../hris/benefit_features_and_operations.rb | 3 - .../models/hris/benefit_frequency.rb | 1 - .../benefits/individual_enroll_many_params.rb | 2 - .../models/hris/document_list_params.rb | 1 - lib/finch-api/models/hris/individual.rb | 2 - lib/finch-api/models/hris/payment.rb | 1 - .../models/hris/supported_benefit.rb | 3 - lib/finch-api/models/individual_event.rb | 1 - lib/finch-api/models/job_completion_event.rb | 1 - .../models/jobs/automated_async_job.rb | 1 - lib/finch-api/models/jobs/manual_async_job.rb | 1 - lib/finch-api/models/pay_statement_event.rb | 1 - lib/finch-api/models/payment_event.rb | 1 - .../models/payroll/pay_group_list_response.rb | 1 - .../payroll/pay_group_retrieve_response.rb | 1 - .../sandbox/connection_create_params.rb | 1 - .../sandbox/connection_create_response.rb | 1 - .../connections/account_create_params.rb | 1 - .../connections/account_create_response.rb | 1 - .../connections/account_update_response.rb | 1 - .../models/sandbox/directory_create_params.rb | 2 - .../sandbox/individual_update_params.rb | 2 - .../sandbox/individual_update_response.rb | 2 - .../sandbox/jobs/sandbox_job_configuration.rb | 2 - lib/finch-api/models/webhook_event.rb | 1 - lib/finch-api/page.rb | 6 +- lib/finch-api/pooled_net_requester.rb | 21 +-- lib/finch-api/request_options.rb | 13 +- lib/finch-api/resources/access_tokens.rb | 2 - lib/finch-api/resources/account.rb | 3 - lib/finch-api/resources/connect.rb | 1 - lib/finch-api/resources/connect/sessions.rb | 3 - lib/finch-api/resources/hris.rb | 1 - lib/finch-api/resources/hris/benefits.rb | 6 - .../resources/hris/benefits/individuals.rb | 5 - lib/finch-api/resources/hris/company.rb | 2 - lib/finch-api/resources/hris/directory.rb | 2 - lib/finch-api/resources/hris/documents.rb | 3 - lib/finch-api/resources/hris/employments.rb | 2 - lib/finch-api/resources/hris/individuals.rb | 2 - .../resources/hris/pay_statements.rb | 2 - lib/finch-api/resources/hris/payments.rb | 2 - lib/finch-api/resources/jobs.rb | 1 - lib/finch-api/resources/jobs/automated.rb | 4 - lib/finch-api/resources/jobs/manual.rb | 2 - lib/finch-api/resources/payroll.rb | 1 - lib/finch-api/resources/payroll/pay_groups.rb | 3 - lib/finch-api/resources/providers.rb | 2 - lib/finch-api/resources/request_forwarding.rb | 2 - lib/finch-api/resources/sandbox.rb | 1 - lib/finch-api/resources/sandbox/company.rb | 2 - .../resources/sandbox/connections.rb | 2 - .../resources/sandbox/connections/accounts.rb | 3 - lib/finch-api/resources/sandbox/directory.rb | 2 - lib/finch-api/resources/sandbox/employment.rb | 2 - lib/finch-api/resources/sandbox/individual.rb | 2 - lib/finch-api/resources/sandbox/jobs.rb | 2 - .../resources/sandbox/jobs/configuration.rb | 3 - lib/finch-api/resources/sandbox/payment.rb | 2 - lib/finch-api/resources/webhooks.rb | 1 - lib/finch-api/responses_page.rb | 6 +- lib/finch-api/single_page.rb | 6 +- lib/finch-api/util.rb | 102 ++++------- rbi/lib/finch-api/base_client.rbi | 11 ++ rbi/lib/finch-api/base_model.rbi | 106 +++++++++++ rbi/lib/finch-api/base_page.rbi | 2 + rbi/lib/finch-api/client.rbi | 4 + rbi/lib/finch-api/errors.rbi | 5 + rbi/lib/finch-api/extern.rbi | 1 + .../finch-api/models/account_update_event.rbi | 6 + .../finch-api/models/base_webhook_event.rbi | 6 + .../models/connect/session_new_params.rbi | 3 + .../models/connect/session_new_response.rbi | 2 + .../connect/session_reauthenticate_params.rbi | 6 + .../session_reauthenticate_response.rbi | 2 + .../models/create_access_token_response.rbi | 21 +++ rbi/lib/finch-api/models/directory_event.rbi | 1 + .../finch-api/models/disconnect_response.rbi | 1 + rbi/lib/finch-api/models/employment_event.rbi | 1 + .../models/hris/benefit_contribution.rbi | 3 + .../models/hris/benefit_create_params.rbi | 4 + .../hris/benefit_features_and_operations.rbi | 10 + .../finch-api/models/hris/benefit_type.rbi | 1 + .../models/hris/benefit_update_params.rbi | 1 + .../hris/benefits/enrolled_individual.rbi | 5 + .../hris/benefits/individual_benefit.rbi | 5 + .../individual_enroll_many_params.rbi | 12 ++ ...dividual_retrieve_many_benefits_params.rbi | 2 + .../individual_unenroll_many_params.rbi | 1 + .../hris/benefits/unenrolled_individual.rbi | 4 + .../models/hris/benefits_support.rbi | 2 + rbi/lib/finch-api/models/hris/company.rbi | 24 +++ .../finch-api/models/hris/company_benefit.rbi | 1 + .../directory_list_individuals_params.rbi | 2 + .../models/hris/directory_list_params.rbi | 2 + .../models/hris/document_list_params.rbi | 6 + .../models/hris/document_response.rbi | 8 + .../hris/document_retreive_response.rbi | 3 + .../finch-api/models/hris/employment_data.rbi | 33 ++++ .../hris/employment_retrieve_many_params.rbi | 4 + rbi/lib/finch-api/models/hris/individual.rbi | 16 ++ .../models/hris/individual_in_directory.rbi | 11 ++ .../finch-api/models/hris/pay_statement.rbi | 43 +++++ .../hris/pay_statement_response_body.rbi | 1 + .../pay_statement_retrieve_many_params.rbi | 4 + rbi/lib/finch-api/models/hris/payment.rbi | 6 + .../models/hris/payment_list_params.rbi | 4 + .../models/hris/supported_benefit.rbi | 11 ++ rbi/lib/finch-api/models/hris/w42005.rbi | 14 ++ rbi/lib/finch-api/models/hris/w42020.rbi | 17 ++ rbi/lib/finch-api/models/income.rbi | 10 + rbi/lib/finch-api/models/individual_event.rbi | 1 + rbi/lib/finch-api/models/introspection.rbi | 33 ++++ .../finch-api/models/job_completion_event.rbi | 2 + .../models/jobs/automated_async_job.rbi | 15 ++ .../models/jobs/automated_create_params.rbi | 3 + .../models/jobs/automated_create_response.rbi | 4 + .../models/jobs/automated_list_params.rbi | 2 + .../models/jobs/automated_list_response.rbi | 8 + .../models/jobs/manual_async_job.rbi | 1 + rbi/lib/finch-api/models/location.rbi | 6 + rbi/lib/finch-api/models/money.rbi | 1 + .../finch-api/models/operation_support.rbi | 7 + .../models/operation_support_matrix.rbi | 28 +++ rbi/lib/finch-api/models/paging.rbi | 2 + .../finch-api/models/pay_statement_event.rbi | 2 + rbi/lib/finch-api/models/payment_event.rbi | 2 + .../payroll/pay_group_list_response.rbi | 3 + .../payroll/pay_group_retrieve_response.rbi | 3 + rbi/lib/finch-api/models/provider.rbi | 18 ++ .../request_forwarding_forward_params.rbi | 12 ++ .../request_forwarding_forward_response.rbi | 21 +++ .../models/sandbox/company_update_params.rbi | 23 +++ .../sandbox/company_update_response.rbi | 23 +++ .../sandbox/connection_create_params.rbi | 4 + .../sandbox/connection_create_response.rbi | 4 + .../connections/account_create_params.rbi | 3 + .../connections/account_create_response.rbi | 4 + .../connections/account_update_response.rbi | 4 + .../sandbox/directory_create_params.rbi | 44 +++++ .../sandbox/employment_update_params.rbi | 30 +++ .../sandbox/employment_update_response.rbi | 31 ++++ .../sandbox/individual_update_params.rbi | 15 ++ .../sandbox/individual_update_response.rbi | 16 ++ .../models/sandbox/job_create_params.rbi | 2 + .../models/sandbox/job_create_response.rbi | 4 + .../models/sandbox/payment_create_params.rbi | 43 +++++ .../sandbox/payment_create_response.rbi | 2 + rbi/lib/finch-api/models/webhook_event.rbi | 1 + rbi/lib/finch-api/pooled_net_requester.rbi | 6 + rbi/lib/finch-api/request_options.rbi | 21 +++ rbi/lib/finch-api/resources/access_tokens.rbi | 1 + rbi/lib/finch-api/resources/account.rbi | 2 + .../finch-api/resources/connect/sessions.rbi | 2 + rbi/lib/finch-api/resources/hris/benefits.rbi | 6 + .../resources/hris/benefits/individuals.rbi | 7 + rbi/lib/finch-api/resources/hris/company.rbi | 1 + .../finch-api/resources/hris/directory.rbi | 2 + .../finch-api/resources/hris/documents.rbi | 4 + .../finch-api/resources/hris/employments.rbi | 1 + .../finch-api/resources/hris/individuals.rbi | 1 + .../resources/hris/pay_statements.rbi | 4 + rbi/lib/finch-api/resources/hris/payments.rbi | 1 + .../finch-api/resources/jobs/automated.rbi | 18 ++ rbi/lib/finch-api/resources/jobs/manual.rbi | 2 + .../resources/payroll/pay_groups.rbi | 2 + rbi/lib/finch-api/resources/providers.rbi | 1 + .../resources/request_forwarding.rbi | 4 + .../finch-api/resources/sandbox/company.rbi | 1 + .../resources/sandbox/connections.rbi | 1 + .../sandbox/connections/accounts.rbi | 3 + .../finch-api/resources/sandbox/directory.rbi | 1 + .../resources/sandbox/employment.rbi | 1 + .../resources/sandbox/individual.rbi | 1 + rbi/lib/finch-api/resources/sandbox/jobs.rbi | 1 + .../resources/sandbox/jobs/configuration.rbi | 2 + .../finch-api/resources/sandbox/payment.rbi | 1 + rbi/lib/finch-api/util.rbi | 41 +++++ sig/finch-api/base_client.rbs | 2 +- test/finch-api/client_test.rb | 5 - 194 files changed, 1141 insertions(+), 402 deletions(-) diff --git a/.yardopts b/.yardopts index 29c933bc..c7c3301d 100644 --- a/.yardopts +++ b/.yardopts @@ -1 +1,3 @@ --markup markdown +--exclude /rbi +--exclude /sig diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index ae3620bf..a0139ba5 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -1,10 +1,9 @@ # frozen_string_literal: true module FinchAPI - # @private + # @api private # # @abstract - # class BaseClient # from whatwg fetch spec MAX_REDIRECTS = 20 @@ -21,12 +20,11 @@ class BaseClient # rubocop:enable Style/MutableConstant class << self - # @private + # @api private # # @param req [Hash{Symbol=>Object}] # # @raise [ArgumentError] - # def validate!(req) keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :stream, :model, :options] case req @@ -41,13 +39,12 @@ def validate!(req) end end - # @private + # @api private # # @param status [Integer] # @param headers [Hash{String=>String}, Net::HTTPHeader] # # @return [Boolean] - # def should_retry?(status, headers:) coerced = FinchAPI::Util.coerce_boolean(headers["x-should-retry"]) case [coerced, status] @@ -65,7 +62,7 @@ def should_retry?(status, headers:) end end - # @private + # @api private # # @param request [Hash{Symbol=>Object}] . # @@ -86,7 +83,6 @@ def should_retry?(status, headers:) # @param response_headers [Hash{String=>String}, Net::HTTPHeader] # # @return [Hash{Symbol=>Object}] - # def follow_redirect(request, status:, response_headers:) method, url, headers = request.fetch_values(:method, :url, :headers) location = @@ -130,12 +126,11 @@ def follow_redirect(request, status:, response_headers:) end end - # @private - # + # @api private # @return [FinchAPI::PooledNetRequester] attr_accessor :requester - # @private + # @api private # # @param base_url [String] # @param timeout [Float] @@ -144,7 +139,6 @@ def follow_redirect(request, status:, response_headers:) # @param max_retry_delay [Float] # @param headers [Hash{String=>String, Integer, Array, nil}] # @param idempotency_header [String, nil] - # def initialize( base_url:, timeout: 0.0, @@ -171,19 +165,17 @@ def initialize( @max_retry_delay = max_retry_delay end - # @private + # @api private # # @return [Hash{String=>String}] - # private def auth_headers = {} - # @private + # @api private # # @return [String] - # private def generate_idempotency_key = "stainless-ruby-retry-#{SecureRandom.uuid}" - # @private + # @api private # # @param req [Hash{Symbol=>Object}] . # @@ -220,7 +212,6 @@ def initialize( # @option opts [Float, nil] :timeout # # @return [Hash{Symbol=>Object}] - # private def build_request(req, opts) method, uninterpolated_path = req.fetch_values(:method, :path) @@ -271,13 +262,12 @@ def initialize( } end - # @private + # @api private # # @param headers [Hash{String=>String}] # @param retry_count [Integer] # # @return [Float] - # private def retry_delay(headers, retry_count:) # Non-standard extension span = Float(headers["retry-after-ms"], exception: false)&.then { _1 / 1000 } @@ -298,7 +288,7 @@ def initialize( (@initial_retry_delay * scale * jitter).clamp(0, @max_retry_delay) end - # @private + # @api private # # @param request [Hash{Symbol=>Object}] . # @@ -322,7 +312,6 @@ def initialize( # # @raise [FinchAPI::APIError] # @return [Array(Integer, Net::HTTPResponse, Enumerable)] - # private def send_request(request, redirect_count:, retry_count:, send_retry_header:) url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout) input = {**request.except(:timeout), deadline: FinchAPI::Util.monotonic_secs + timeout} @@ -424,7 +413,6 @@ def initialize( # # @raise [FinchAPI::APIError] # @return [Object] - # def request(req) self.class.validate!(req) model = req.fetch(:model) { FinchAPI::Unknown } @@ -455,7 +443,6 @@ def request(req) end # @return [String] - # def inspect # rubocop:disable Layout/LineLength base_url = FinchAPI::Util.unparse_uri(@base_url) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index e90812e5..b304958b 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -1,41 +1,37 @@ # frozen_string_literal: true module FinchAPI - # @private + # @api private # # @abstract - # module Converter # rubocop:disable Lint/UnusedMethodArgument - # @private + # @api private # # @param value [Object] # # @return [Object] - # def coerce(value) = value - # @private + # @api private # # @param value [Object] # # @return [Object] - # def dump(value) = value - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) = (raise NotImplementedError) # rubocop:enable Lint/UnusedMethodArgument class << self - # @private + # @api private # # @param spec [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] . # @@ -48,7 +44,6 @@ class << self # @option spec [Boolean] :"nil?" # # @return [Proc] - # def type_info(spec) case spec in Hash @@ -64,7 +59,7 @@ def type_info(spec) end end - # @private + # @api private # # Based on `target`, transform `value` into `target`, to the extent possible: # @@ -77,7 +72,6 @@ def type_info(spec) # @param value [Object] # # @return [Object] - # def coerce(target, value) case target in FinchAPI::Converter @@ -111,13 +105,12 @@ def coerce(target, value) end end - # @private + # @api private # # @param target [FinchAPI::Converter, Class] # @param value [Object] # # @return [Object] - # def dump(target, value) case target in FinchAPI::Converter @@ -127,7 +120,7 @@ def dump(target, value) end end - # @private + # @api private # # The underlying algorithm for computing maximal compatibility is subject to # future improvements. @@ -142,7 +135,6 @@ def dump(target, value) # @param value [Object] # # @return [Object] - # def try_strict_coerce(target, value) case target in FinchAPI::Converter @@ -182,7 +174,7 @@ def try_strict_coerce(target, value) end end - # @private + # @api private # # @abstract # @@ -197,40 +189,35 @@ class Unknown # @param other [Object] # # @return [Boolean] - # def self.===(other) = true # @param other [Object] # # @return [Boolean] - # def self.==(other) = other.is_a?(Class) && other <= FinchAPI::Unknown class << self # @!parse - # # @private + # # @api private # # # # @param value [Object] # # # # @return [Object] - # # # def coerce(value) = super # @!parse - # # @private + # # @api private # # # # @param value [Object] # # # # @return [Object] - # # # def dump(value) = super - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) # prevent unknown variant from being chosen during the first coercion pass [false, true, 0] @@ -240,7 +227,7 @@ def try_strict_coerce(value) # rubocop:enable Lint/UnusedMethodArgument end - # @private + # @api private # # @abstract # @@ -253,40 +240,35 @@ class BooleanModel # @param other [Object] # # @return [Boolean] - # def self.===(other) = other == true || other == false # @param other [Object] # # @return [Boolean] - # def self.==(other) = other.is_a?(Class) && other <= FinchAPI::BooleanModel class << self # @!parse - # # @private + # # @api private # # # # @param value [Boolean, Object] # # # # @return [Boolean, Object] - # # # def coerce(value) = super # @!parse - # # @private + # # @api private # # # # @param value [Boolean, Object] # # # # @return [Boolean, Object] - # # # def dump(value) = super - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) case value in true | false @@ -298,7 +280,7 @@ def try_strict_coerce(value) end end - # @private + # @api private # # @abstract # @@ -348,13 +330,11 @@ class << self # All of the valid Symbol values for this enum. # # @return [Array] - # def values = (@values ||= constants.map { const_get(_1) }) - # @private + # @api private # # Guard against thread safety issues by instantiating `@values`. - # private def finalize! = values end @@ -363,24 +343,21 @@ def values = (@values ||= constants.map { const_get(_1) }) # @param other [Object] # # @return [Boolean] - # def self.===(other) = values.include?(other) # @param other [Object] # # @return [Boolean] - # def self.==(other) other.is_a?(Class) && other <= FinchAPI::Enum && other.values.to_set == values.to_set end class << self - # @private + # @api private # # @param value [String, Symbol, Object] # # @return [Symbol, Object] - # def coerce(value) case value in Symbol | String if values.include?(val = value.to_sym) @@ -391,20 +368,18 @@ def coerce(value) end # @!parse - # # @private + # # @api private # # # # @param value [Symbol, Object] # # # # @return [Symbol, Object] - # # # def dump(value) = super - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) return [true, value, 1] if values.include?(value) @@ -423,7 +398,7 @@ def try_strict_coerce(value) end end - # @private + # @api private # # @abstract # @@ -455,28 +430,25 @@ class Union extend FinchAPI::Converter class << self - # @private + # @api private # # All of the specified variant info for this union. # # @return [Array] - # private def known_variants = (@known_variants ||= []) - # @private + # @api private # # All of the specified variants for this union. # # @return [Array] - # protected def variants @known_variants.map { |key, variant_fn| [key, variant_fn.call] } end - # @private + # @api private # # @param property [Symbol] - # private def discriminator(property) case property in Symbol @@ -484,7 +456,7 @@ class << self end end - # @private + # @api private # # @param key [Symbol, Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] # @@ -497,7 +469,6 @@ class << self # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" - # private def variant(key, spec = nil) variant_info = case key @@ -510,12 +481,11 @@ class << self known_variants << variant_info end - # @private + # @api private # # @param value [Object] # # @return [FinchAPI::Converter, Class, nil] - # private def resolve_variant(value) case [@discriminator, value] in [_, FinchAPI::BaseModel] @@ -545,7 +515,6 @@ class << self # @param other [Object] # # @return [Boolean] - # def self.===(other) known_variants.any? do |_, variant_fn| variant_fn.call === other @@ -555,18 +524,16 @@ def self.===(other) # @param other [Object] # # @return [Boolean] - # def self.==(other) other.is_a?(Class) && other <= FinchAPI::Union && other.variants == variants end class << self - # @private + # @api private # # @param value [Object] # # @return [Object] - # def coerce(value) if (variant = resolve_variant(value)) return FinchAPI::Converter.coerce(variant, value) @@ -591,12 +558,11 @@ def coerce(value) variant.nil? ? value : FinchAPI::Converter.coerce(variant, value) end - # @private + # @api private # # @param value [Object] # # @return [Object] - # def dump(value) if (variant = resolve_variant(value)) return FinchAPI::Converter.dump(variant, value) @@ -611,12 +577,11 @@ def dump(value) value end - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) # TODO(ruby) this will result in super linear decoding behaviour for nested unions # follow up with a decoding context that captures current strictness levels @@ -649,7 +614,7 @@ def try_strict_coerce(value) # rubocop:enable Style/HashEachMethods end - # @private + # @api private # # @abstract # @@ -664,7 +629,6 @@ def self.[](...) = new(...) # @param other [Object] # # @return [Boolean] - # def ===(other) type = item_type case other @@ -680,15 +644,13 @@ def ===(other) # @param other [Object] # # @return [Boolean] - # def ==(other) = other.is_a?(FinchAPI::ArrayOf) && other.item_type == item_type - # @private + # @api private # # @param value [Enumerable, Object] # # @return [Array, Object] - # def coerce(value) type = item_type case value @@ -699,12 +661,11 @@ def coerce(value) end end - # @private + # @api private # # @param value [Enumerable, Object] # # @return [Array, Object] - # def dump(value) type = item_type case value @@ -715,12 +676,11 @@ def dump(value) end end - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) case value in Array @@ -754,13 +714,12 @@ def try_strict_coerce(value) end end - # @private + # @api private # # @return [FinchAPI::Converter, Class] - # protected def item_type = @item_type_fn.call - # @private + # @api private # # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] # @@ -773,13 +732,12 @@ def try_strict_coerce(value) # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" - # def initialize(type_info, spec = {}) @item_type_fn = FinchAPI::Converter.type_info(type_info || spec) end end - # @private + # @api private # # @abstract # @@ -794,7 +752,6 @@ def self.[](...) = new(...) # @param other [Object] # # @return [Boolean] - # def ===(other) type = item_type case other @@ -815,15 +772,13 @@ def ===(other) # @param other [Object] # # @return [Boolean] - # def ==(other) = other.is_a?(FinchAPI::HashOf) && other.item_type == item_type - # @private + # @api private # # @param value [Hash{Object=>Object}, Object] # # @return [Hash{Symbol=>Object}, Object] - # def coerce(value) type = item_type case value @@ -837,12 +792,11 @@ def coerce(value) end end - # @private + # @api private # # @param value [Hash{Object=>Object}, Object] # # @return [Hash{Symbol=>Object}, Object] - # def dump(value) type = item_type case value @@ -855,12 +809,11 @@ def dump(value) end end - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) case value in Hash @@ -894,13 +847,12 @@ def try_strict_coerce(value) end end - # @private + # @api private # # @return [FinchAPI::Converter, Class] - # protected def item_type = @item_type_fn.call - # @private + # @api private # # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] # @@ -913,13 +865,12 @@ def try_strict_coerce(value) # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" - # def initialize(type_info, spec = {}) @item_type_fn = FinchAPI::Converter.type_info(type_info || spec) end end - # @private + # @api private # # @abstract # @@ -936,32 +887,29 @@ class BaseModel extend FinchAPI::Converter class << self - # @private + # @api private # # Assumes superclass fields are totally defined before fields are accessed / # defined on subclasses. # # @return [Hash{Symbol=>Hash{Symbol=>Object}}] - # def known_fields @known_fields ||= (self < FinchAPI::BaseModel ? superclass.known_fields.dup : {}) end # @return [Hash{Symbol=>Hash{Symbol=>Object}}] - # def fields known_fields.transform_values do |field| {**field.except(:type_fn), type: field.fetch(:type_fn).call} end end - # @private + # @api private # # @return [Hash{Symbol=>Proc}] - # def defaults = (@defaults ||= {}) - # @private + # @api private # # @param name_sym [Symbol] # @@ -978,7 +926,6 @@ def defaults = (@defaults ||= {}) # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" - # private def add_field(name_sym, required:, type_info:, spec:) type_fn, info = case type_info @@ -1017,7 +964,7 @@ def defaults = (@defaults ||= {}) end end - # @private + # @api private # # @param name_sym [Symbol] # @@ -1032,12 +979,11 @@ def defaults = (@defaults ||= {}) # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" - # def required(name_sym, type_info, spec = {}) add_field(name_sym, required: true, type_info: type_info, spec: spec) end - # @private + # @api private # # @param name_sym [Symbol] # @@ -1052,18 +998,16 @@ def required(name_sym, type_info, spec = {}) # @option spec [Proc] :union # # @option spec [Boolean] :"nil?" - # def optional(name_sym, type_info, spec = {}) add_field(name_sym, required: false, type_info: type_info, spec: spec) end - # @private + # @api private # # `request_only` attributes not excluded from `.#coerce` when receiving responses # even if well behaved servers should not send them # # @param blk [Proc] - # private def request_only(&blk) @mode = :dump blk.call @@ -1071,12 +1015,11 @@ def optional(name_sym, type_info, spec = {}) @mode = nil end - # @private + # @api private # # `response_only` attributes are omitted from `.#dump` when making requests # # @param blk [Proc] - # private def response_only(&blk) @mode = :coerce blk.call @@ -1088,7 +1031,6 @@ def optional(name_sym, type_info, spec = {}) # @param other [Object] # # @return [Boolean] - # def ==(other) case other in FinchAPI::BaseModel @@ -1099,12 +1041,11 @@ def ==(other) end class << self - # @private + # @api private # # @param value [FinchAPI::BaseModel, Hash{Object=>Object}, Object] # # @return [FinchAPI::BaseModel, Object] - # def coerce(value) case FinchAPI::Util.coerce_hash(value) in Hash => coerced @@ -1114,12 +1055,11 @@ def coerce(value) end end - # @private + # @api private # # @param value [FinchAPI::BaseModel, Object] # # @return [Hash{Object=>Object}, Object] - # def dump(value) unless (coerced = FinchAPI::Util.coerce_hash(value)).is_a?(Hash) return value @@ -1151,12 +1091,11 @@ def dump(value) values end - # @private + # @api private # # @param value [Object] # # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - # def try_strict_coerce(value) case value in Hash | FinchAPI::BaseModel @@ -1214,7 +1153,6 @@ def try_strict_coerce(value) # @param key [Symbol] # # @return [Object, nil] - # def [](key) unless key.instance_of?(Symbol) raise ArgumentError.new("Expected symbol key for lookup, got #{key.inspect}") @@ -1233,7 +1171,6 @@ def [](key) # should not be mutated. # # @return [Hash{Symbol=>Object}] - # def to_h = @data alias_method :to_hash, :to_h @@ -1241,7 +1178,6 @@ def to_h = @data # @param keys [Array, nil] # # @return [Hash{Symbol=>Object}] - # def deconstruct_keys(keys) (keys || self.class.known_fields.keys).filter_map do |k| unless self.class.known_fields.key?(k) @@ -1256,7 +1192,6 @@ def deconstruct_keys(keys) # Create a new instance of a model. # # @param data [Hash{Symbol=>Object}, FinchAPI::BaseModel] - # def initialize(data = {}) case FinchAPI::Util.coerce_hash(data) in Hash => coerced @@ -1267,11 +1202,9 @@ def initialize(data = {}) end # @return [String] - # def to_s = @data.to_s # @return [String] - # def inspect "#<#{self.class.name}:0x#{object_id.to_s(16)} #{deconstruct_keys(nil).map do |k, v| "#{k}=#{v.inspect}" diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index 23fb80fd..2bcd569e 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module FinchAPI - # @private + # @api private # # @abstract # @@ -27,33 +27,28 @@ module FinchAPI # ``` module BasePage # @return [Boolean] - # def next_page? = (raise NotImplementedError) # @raise [FinchAPI::APIError] # @return [FinchAPI::BasePage] - # def next_page = (raise NotImplementedError) # @param blk [Proc] # # @return [void] - # def auto_paging_each(&) = (raise NotImplementedError) # @return [Enumerable] - # def to_enum = super(:auto_paging_each) alias_method :enum_for, :to_enum - # @private + # @api private # # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param page_data [Object] - # def initialize(client:, req:, headers:, page_data:) @client = client @req = req diff --git a/lib/finch-api/client.rb b/lib/finch-api/client.rb index 5ed0209d..78220550 100644 --- a/lib/finch-api/client.rb +++ b/lib/finch-api/client.rb @@ -54,28 +54,25 @@ class Client < FinchAPI::BaseClient # @return [FinchAPI::Resources::Connect] attr_reader :connect - # @private + # @api private # # @return [Hash{String=>String}] - # private def auth_headers {**bearer_auth, **basic_auth} end - # @private + # @api private # # @return [Hash{String=>String}] - # private def bearer_auth return {} if @access_token.nil? {"authorization" => "Bearer #{@access_token}"} end - # @private + # @api private # # @return [Hash{String=>String}] - # private def basic_auth return {} if @client_id.nil? || @client_secret.nil? @@ -100,7 +97,6 @@ class Client < FinchAPI::BaseClient # @param initial_retry_delay [Float] # # @param max_retry_delay [Float] - # def initialize( base_url: nil, access_token: nil, diff --git a/lib/finch-api/errors.rb b/lib/finch-api/errors.rb index fd627339..3cf58894 100644 --- a/lib/finch-api/errors.rb +++ b/lib/finch-api/errors.rb @@ -20,7 +20,7 @@ class APIError < FinchAPI::Error # @return [Object, nil] attr_reader :body - # @private + # @api private # # @param url [URI::Generic] # @param status [Integer, nil] @@ -28,7 +28,6 @@ class APIError < FinchAPI::Error # @param request [nil] # @param response [nil] # @param message [String, nil] - # def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil) @url = url @status = status @@ -48,7 +47,7 @@ class APIConnectionError < FinchAPI::APIError # # @return [nil] # attr_reader :body - # @private + # @api private # # @param url [URI::Generic] # @param status [nil] @@ -56,7 +55,6 @@ class APIConnectionError < FinchAPI::APIError # @param request [nil] # @param response [nil] # @param message [String, nil] - # def initialize( url:, status: nil, @@ -70,7 +68,7 @@ def initialize( end class APITimeoutError < FinchAPI::APIConnectionError - # @private + # @api private # # @param url [URI::Generic] # @param status [nil] @@ -78,7 +76,6 @@ class APITimeoutError < FinchAPI::APIConnectionError # @param request [nil] # @param response [nil] # @param message [String, nil] - # def initialize( url:, status: nil, @@ -92,7 +89,7 @@ def initialize( end class APIStatusError < FinchAPI::APIError - # @private + # @api private # # @param url [URI::Generic] # @param status [Integer] @@ -102,7 +99,6 @@ class APIStatusError < FinchAPI::APIError # @param message [String, nil] # # @return [FinchAPI::APIStatusError] - # def self.for(url:, status:, body:, request:, response:, message: nil) kwargs = {url: url, status: status, body: body, request: request, response: response, message: message} @@ -132,7 +128,7 @@ def self.for(url:, status:, body:, request:, response:, message: nil) # # @return [Integer] # attr_reader :status - # @private + # @api private # # @param url [URI::Generic] # @param status [Integer] @@ -140,7 +136,6 @@ def self.for(url:, status:, body:, request:, response:, message: nil) # @param request [nil] # @param response [nil] # @param message [String, nil] - # def initialize(url:, status:, body:, request:, response:, message: nil) message ||= {url: url.to_s, status: status, body: body} super( diff --git a/lib/finch-api/extern.rb b/lib/finch-api/extern.rb index 8ab900bc..b308b801 100644 --- a/lib/finch-api/extern.rb +++ b/lib/finch-api/extern.rb @@ -1,10 +1,9 @@ # frozen_string_literal: true module FinchAPI - # @private + # @api private # # @abstract - # module Extern end end diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index fd871aff..fa282971 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -30,13 +30,12 @@ class IndividualsPage # @return [FinchAPI::Models::Paging] attr_accessor :paging - # @private + # @api private # # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param page_data [Hash{Symbol=>Object}] - # def initialize(client:, req:, headers:, page_data:) super model = req.fetch(:model) @@ -61,7 +60,6 @@ def next_page? # @raise [FinchAPI::HTTP::Error] # @return [FinchAPI::IndividualsPage] - # def next_page unless next_page? raise RuntimeError.new("No more pages available. Please check #next_page? before calling ##{__method__}") @@ -72,7 +70,6 @@ def next_page end # @param blk [Proc] - # def auto_paging_each(&blk) unless block_given? raise ArgumentError.new("A block must be given to ##{__method__}") @@ -86,7 +83,6 @@ def auto_paging_each(&blk) end # @return [String] - # def inspect "#<#{self.class}:0x#{object_id.to_s(16)} individuals=#{individuals.inspect} paging=#{paging.inspect}>" end diff --git a/lib/finch-api/models/account_update_event.rb b/lib/finch-api/models/account_update_event.rb index 5874bf66..caf4c725 100644 --- a/lib/finch-api/models/account_update_event.rb +++ b/lib/finch-api/models/account_update_event.rb @@ -1934,7 +1934,6 @@ class Type < FinchAPI::Enum end # @abstract - # class EventType < FinchAPI::Enum ACCOUNT_UPDATED = :"account.updated" diff --git a/lib/finch-api/models/company_event.rb b/lib/finch-api/models/company_event.rb index 738ec6db..ab4f1190 100644 --- a/lib/finch-api/models/company_event.rb +++ b/lib/finch-api/models/company_event.rb @@ -26,7 +26,6 @@ class CompanyEvent < FinchAPI::Models::BaseWebhookEvent # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class EventType < FinchAPI::Enum COMPANY_UPDATED = :"company.updated" diff --git a/lib/finch-api/models/connect/session_new_params.rb b/lib/finch-api/models/connect/session_new_params.rb index c3925389..06e5fb3a 100644 --- a/lib/finch-api/models/connect/session_new_params.rb +++ b/lib/finch-api/models/connect/session_new_params.rb @@ -123,7 +123,6 @@ class Integration < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class AuthMethod < FinchAPI::Enum ASSISTED = :assisted CREDENTIAL = :credential @@ -135,7 +134,6 @@ class AuthMethod < FinchAPI::Enum end # @abstract - # class Sandbox < FinchAPI::Enum FINCH = :finch PROVIDER = :provider diff --git a/lib/finch-api/models/connection_status_type.rb b/lib/finch-api/models/connection_status_type.rb index 4d2215eb..71d7aff6 100644 --- a/lib/finch-api/models/connection_status_type.rb +++ b/lib/finch-api/models/connection_status_type.rb @@ -3,7 +3,6 @@ module FinchAPI module Models # @abstract - # class ConnectionStatusType < FinchAPI::Enum PENDING = :pending PROCESSING = :processing diff --git a/lib/finch-api/models/directory_event.rb b/lib/finch-api/models/directory_event.rb index 30479a27..d2901729 100644 --- a/lib/finch-api/models/directory_event.rb +++ b/lib/finch-api/models/directory_event.rb @@ -49,7 +49,6 @@ class Data < FinchAPI::BaseModel end # @abstract - # class EventType < FinchAPI::Enum DIRECTORY_CREATED = :"directory.created" DIRECTORY_UPDATED = :"directory.updated" diff --git a/lib/finch-api/models/employment_event.rb b/lib/finch-api/models/employment_event.rb index a691d012..6b5f3dd6 100644 --- a/lib/finch-api/models/employment_event.rb +++ b/lib/finch-api/models/employment_event.rb @@ -49,7 +49,6 @@ class Data < FinchAPI::BaseModel end # @abstract - # class EventType < FinchAPI::Enum EMPLOYMENT_CREATED = :"employment.created" EMPLOYMENT_UPDATED = :"employment.updated" diff --git a/lib/finch-api/models/hris/benefit_features_and_operations.rb b/lib/finch-api/models/hris/benefit_features_and_operations.rb index 030ae9fb..156eed1c 100644 --- a/lib/finch-api/models/hris/benefit_features_and_operations.rb +++ b/lib/finch-api/models/hris/benefit_features_and_operations.rb @@ -125,7 +125,6 @@ class SupportedFeatures < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class CompanyContribution < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -134,7 +133,6 @@ class CompanyContribution < FinchAPI::Enum end # @abstract - # class EmployeeDeduction < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -143,7 +141,6 @@ class EmployeeDeduction < FinchAPI::Enum end # @abstract - # class HsaContributionLimit < FinchAPI::Enum INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/hris/benefit_frequency.rb b/lib/finch-api/models/hris/benefit_frequency.rb index de52d30c..509a3657 100644 --- a/lib/finch-api/models/hris/benefit_frequency.rb +++ b/lib/finch-api/models/hris/benefit_frequency.rb @@ -4,7 +4,6 @@ module FinchAPI module Models module HRIS # @abstract - # class BenefitFrequency < FinchAPI::Enum ONE_TIME = :one_time EVERY_PAYCHECK = :every_paycheck diff --git a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb index cabd80f7..82dc6b95 100644 --- a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +++ b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb @@ -168,7 +168,6 @@ class CompanyContribution < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -208,7 +207,6 @@ class EmployeeDeduction < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum FIXED = :fixed PERCENT = :percent diff --git a/lib/finch-api/models/hris/document_list_params.rb b/lib/finch-api/models/hris/document_list_params.rb index e175a22d..211ed785 100644 --- a/lib/finch-api/models/hris/document_list_params.rb +++ b/lib/finch-api/models/hris/document_list_params.rb @@ -62,7 +62,6 @@ class DocumentListParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum W4_2020 = :w4_2020 W4_2005 = :w4_2005 diff --git a/lib/finch-api/models/hris/individual.rb b/lib/finch-api/models/hris/individual.rb index 6eecfd85..4f0c37b0 100644 --- a/lib/finch-api/models/hris/individual.rb +++ b/lib/finch-api/models/hris/individual.rb @@ -149,7 +149,6 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -206,7 +205,6 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/hris/payment.rb b/lib/finch-api/models/hris/payment.rb index b2f06c0e..38da06af 100644 --- a/lib/finch-api/models/hris/payment.rb +++ b/lib/finch-api/models/hris/payment.rb @@ -110,7 +110,6 @@ class Payment < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class PayFrequency < FinchAPI::Enum ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually diff --git a/lib/finch-api/models/hris/supported_benefit.rb b/lib/finch-api/models/hris/supported_benefit.rb index 64d1122d..d7595191 100644 --- a/lib/finch-api/models/hris/supported_benefit.rb +++ b/lib/finch-api/models/hris/supported_benefit.rb @@ -93,7 +93,6 @@ class SupportedBenefit < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class CompanyContribution < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -102,7 +101,6 @@ class CompanyContribution < FinchAPI::Enum end # @abstract - # class EmployeeDeduction < FinchAPI::Enum FIXED = :fixed PERCENT = :percent @@ -111,7 +109,6 @@ class EmployeeDeduction < FinchAPI::Enum end # @abstract - # class HsaContributionLimit < FinchAPI::Enum INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/individual_event.rb b/lib/finch-api/models/individual_event.rb index 907d9860..224b1fd3 100644 --- a/lib/finch-api/models/individual_event.rb +++ b/lib/finch-api/models/individual_event.rb @@ -49,7 +49,6 @@ class Data < FinchAPI::BaseModel end # @abstract - # class EventType < FinchAPI::Enum INDIVIDUAL_CREATED = :"individual.created" INDIVIDUAL_UPDATED = :"individual.updated" diff --git a/lib/finch-api/models/job_completion_event.rb b/lib/finch-api/models/job_completion_event.rb index 25497d6c..2bcb7d0a 100644 --- a/lib/finch-api/models/job_completion_event.rb +++ b/lib/finch-api/models/job_completion_event.rb @@ -52,7 +52,6 @@ class Data < FinchAPI::BaseModel end # @abstract - # class EventType < FinchAPI::Enum JOB_BENEFIT_CREATE_COMPLETED = :"job.benefit_create.completed" JOB_BENEFIT_ENROLL_COMPLETED = :"job.benefit_enroll.completed" diff --git a/lib/finch-api/models/jobs/automated_async_job.rb b/lib/finch-api/models/jobs/automated_async_job.rb index a96ecad9..02543989 100644 --- a/lib/finch-api/models/jobs/automated_async_job.rb +++ b/lib/finch-api/models/jobs/automated_async_job.rb @@ -98,7 +98,6 @@ class Params < FinchAPI::BaseModel end # @abstract - # class Status < FinchAPI::Enum PENDING = :pending IN_PROGRESS = :in_progress diff --git a/lib/finch-api/models/jobs/manual_async_job.rb b/lib/finch-api/models/jobs/manual_async_job.rb index 456ed29e..3707ffca 100644 --- a/lib/finch-api/models/jobs/manual_async_job.rb +++ b/lib/finch-api/models/jobs/manual_async_job.rb @@ -30,7 +30,6 @@ class ManualAsyncJob < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Status < FinchAPI::Enum PENDING = :pending IN_PROGRESS = :in_progress diff --git a/lib/finch-api/models/pay_statement_event.rb b/lib/finch-api/models/pay_statement_event.rb index 713e44ca..84749bee 100644 --- a/lib/finch-api/models/pay_statement_event.rb +++ b/lib/finch-api/models/pay_statement_event.rb @@ -60,7 +60,6 @@ class Data < FinchAPI::BaseModel end # @abstract - # class EventType < FinchAPI::Enum PAY_STATEMENT_CREATED = :"pay_statement.created" PAY_STATEMENT_UPDATED = :"pay_statement.updated" diff --git a/lib/finch-api/models/payment_event.rb b/lib/finch-api/models/payment_event.rb index 6cd5bb8a..3b1347cc 100644 --- a/lib/finch-api/models/payment_event.rb +++ b/lib/finch-api/models/payment_event.rb @@ -52,7 +52,6 @@ class Data < FinchAPI::BaseModel end # @abstract - # class EventType < FinchAPI::Enum PAYMENT_CREATED = :"payment.created" PAYMENT_UPDATED = :"payment.updated" diff --git a/lib/finch-api/models/payroll/pay_group_list_response.rb b/lib/finch-api/models/payroll/pay_group_list_response.rb index c87f079d..d600cf7a 100644 --- a/lib/finch-api/models/payroll/pay_group_list_response.rb +++ b/lib/finch-api/models/payroll/pay_group_list_response.rb @@ -45,7 +45,6 @@ class PayGroupListResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class PayFrequency < FinchAPI::Enum ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually diff --git a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb index 5c32f802..7009abab 100644 --- a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +++ b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb @@ -39,7 +39,6 @@ class PayGroupRetrieveResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class PayFrequency < FinchAPI::Enum ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually diff --git a/lib/finch-api/models/sandbox/connection_create_params.rb b/lib/finch-api/models/sandbox/connection_create_params.rb index 8cc58932..8aa4bd98 100644 --- a/lib/finch-api/models/sandbox/connection_create_params.rb +++ b/lib/finch-api/models/sandbox/connection_create_params.rb @@ -57,7 +57,6 @@ class ConnectionCreateParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connection_create_response.rb b/lib/finch-api/models/sandbox/connection_create_response.rb index 3029b6d2..9248c964 100644 --- a/lib/finch-api/models/sandbox/connection_create_response.rb +++ b/lib/finch-api/models/sandbox/connection_create_response.rb @@ -80,7 +80,6 @@ class ConnectionCreateResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connections/account_create_params.rb b/lib/finch-api/models/sandbox/connections/account_create_params.rb index c273c416..8d1fd510 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_params.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_params.rb @@ -53,7 +53,6 @@ class AccountCreateParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connections/account_create_response.rb b/lib/finch-api/models/sandbox/connections/account_create_response.rb index 8e6672ca..967b79c3 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_response.rb @@ -59,7 +59,6 @@ class AccountCreateResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/connections/account_update_response.rb b/lib/finch-api/models/sandbox/connections/account_update_response.rb index fe37714d..34b7892d 100644 --- a/lib/finch-api/models/sandbox/connections/account_update_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_update_response.rb @@ -57,7 +57,6 @@ class AccountUpdateResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class AuthenticationType < FinchAPI::Enum CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/directory_create_params.rb b/lib/finch-api/models/sandbox/directory_create_params.rb index adeb1d50..e187b88c 100644 --- a/lib/finch-api/models/sandbox/directory_create_params.rb +++ b/lib/finch-api/models/sandbox/directory_create_params.rb @@ -343,7 +343,6 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -496,7 +495,6 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/individual_update_params.rb b/lib/finch-api/models/sandbox/individual_update_params.rb index 4d6de34c..c72390ef 100644 --- a/lib/finch-api/models/sandbox/individual_update_params.rb +++ b/lib/finch-api/models/sandbox/individual_update_params.rb @@ -145,7 +145,6 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -208,7 +207,6 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/individual_update_response.rb b/lib/finch-api/models/sandbox/individual_update_response.rb index b91ba2d9..da3119dd 100644 --- a/lib/finch-api/models/sandbox/individual_update_response.rb +++ b/lib/finch-api/models/sandbox/individual_update_response.rb @@ -153,7 +153,6 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal @@ -216,7 +215,6 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class Type < FinchAPI::Enum WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb index 1516f2b8..38f5d652 100644 --- a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +++ b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb @@ -25,7 +25,6 @@ class SandboxJobConfiguration < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void # @abstract - # class CompletionStatus < FinchAPI::Enum COMPLETE = :complete REAUTH_ERROR = :reauth_error @@ -36,7 +35,6 @@ class CompletionStatus < FinchAPI::Enum end # @abstract - # class Type < FinchAPI::Enum DATA_SYNC_ALL = :data_sync_all diff --git a/lib/finch-api/models/webhook_event.rb b/lib/finch-api/models/webhook_event.rb index ee9d49c0..2926dc34 100644 --- a/lib/finch-api/models/webhook_event.rb +++ b/lib/finch-api/models/webhook_event.rb @@ -3,7 +3,6 @@ module FinchAPI module Models # @abstract - # class WebhookEvent < FinchAPI::Union discriminator :event_type diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index 955f34ae..c03612f1 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -30,13 +30,12 @@ class Page # @return [FinchAPI::Models::Paging] attr_accessor :paging - # @private + # @api private # # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param page_data [Hash{Symbol=>Object}] - # def initialize(client:, req:, headers:, page_data:) super model = req.fetch(:model) @@ -61,7 +60,6 @@ def next_page? # @raise [FinchAPI::HTTP::Error] # @return [FinchAPI::Page] - # def next_page unless next_page? raise RuntimeError.new("No more pages available. Please check #next_page? before calling ##{__method__}") @@ -72,7 +70,6 @@ def next_page end # @param blk [Proc] - # def auto_paging_each(&blk) unless block_given? raise ArgumentError.new("A block must be given to ##{__method__}") @@ -86,7 +83,6 @@ def auto_paging_each(&blk) end # @return [String] - # def inspect "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} paging=#{paging.inspect}>" end diff --git a/lib/finch-api/pooled_net_requester.rb b/lib/finch-api/pooled_net_requester.rb index 7c33d507..b5c649f9 100644 --- a/lib/finch-api/pooled_net_requester.rb +++ b/lib/finch-api/pooled_net_requester.rb @@ -1,16 +1,14 @@ # frozen_string_literal: true module FinchAPI - # @private - # + # @api private class PooledNetRequester class << self - # @private + # @api private # # @param url [URI::Generic] # # @return [Net::HTTP] - # def connect(url) port = case [url.port, url.scheme] @@ -28,17 +26,16 @@ def connect(url) end end - # @private + # @api private # # @param conn [Net::HTTP] # @param deadline [Float] - # def calibrate_socket_timeout(conn, deadline) timeout = deadline - FinchAPI::Util.monotonic_secs conn.open_timeout = conn.read_timeout = conn.write_timeout = conn.continue_timeout = timeout end - # @private + # @api private # # @param request [Hash{Symbol=>Object}] . # @@ -51,7 +48,6 @@ def calibrate_socket_timeout(conn, deadline) # @param blk [Proc] # # @return [Net::HTTPGenericRequest] - # def build_request(request, &) method, url, headers, body = request.fetch_values(:method, :url, :headers, :body) req = Net::HTTPGenericRequest.new( @@ -80,11 +76,10 @@ def build_request(request, &) end end - # @private + # @api private # # @param url [URI::Generic] # @param blk [Proc] - # private def with_pool(url, &) origin = FinchAPI::Util.uri_origin(url) pool = @@ -97,7 +92,7 @@ def build_request(request, &) pool.with(&) end - # @private + # @api private # # @param request [Hash{Symbol=>Object}] . # @@ -112,7 +107,6 @@ def build_request(request, &) # @option request [Float] :deadline # # @return [Array(Net::HTTPResponse, Enumerable)] - # def execute(request) url, deadline = request.fetch_values(:url, :deadline) @@ -158,10 +152,9 @@ def execute(request) [response, (response.body = body)] end - # @private + # @api private # # @param size [Integer] - # def initialize(size: Etc.nprocessors) @mutex = Mutex.new @size = size diff --git a/lib/finch-api/request_options.rb b/lib/finch-api/request_options.rb index 2bb2b387..2d080426 100644 --- a/lib/finch-api/request_options.rb +++ b/lib/finch-api/request_options.rb @@ -1,10 +1,9 @@ # frozen_string_literal: true module FinchAPI - # @private + # @api private # # @abstract - # module RequestParameters # @!parse # # Options to specify HTTP behaviour for this request. @@ -12,7 +11,6 @@ module RequestParameters # attr_accessor :request_options # @param mod [Module] - # def self.included(mod) return unless mod <= FinchAPI::BaseModel @@ -20,15 +18,13 @@ def self.included(mod) mod.optional(:request_options, FinchAPI::RequestOptions) end - # @private - # + # @api private module Converter - # @private + # @api private # # @param params [Object] # # @return [Array(Object, Hash{Symbol=>Object})] - # def dump_request(params) case (dumped = dump(params)) in Hash @@ -46,12 +42,11 @@ def dump_request(params) # When making a request, you can pass an actual {RequestOptions} instance, or # simply pass a Hash with symbol keys matching the attributes on this class. class RequestOptions < FinchAPI::BaseModel - # @private + # @api private # # @param opts [FinchAPI::RequestOptions, Hash{Symbol=>Object}] # # @raise [ArgumentError] - # def self.validate!(opts) case opts in FinchAPI::RequestOptions | Hash diff --git a/lib/finch-api/resources/access_tokens.rb b/lib/finch-api/resources/access_tokens.rb index d760f881..4a840cc6 100644 --- a/lib/finch-api/resources/access_tokens.rb +++ b/lib/finch-api/resources/access_tokens.rb @@ -18,7 +18,6 @@ class AccessTokens # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::CreateAccessTokenResponse] - # def create(params) parsed, options = FinchAPI::Models::AccessTokenCreateParams.dump_request(params) @client.request( @@ -31,7 +30,6 @@ def create(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/account.rb b/lib/finch-api/resources/account.rb index 8f7e3f6a..3d1fcd12 100644 --- a/lib/finch-api/resources/account.rb +++ b/lib/finch-api/resources/account.rb @@ -10,7 +10,6 @@ class Account # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::DisconnectResponse] - # def disconnect(params = {}) @client.request( method: :post, @@ -27,7 +26,6 @@ def disconnect(params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Introspection] - # def introspect(params = {}) @client.request( method: :get, @@ -38,7 +36,6 @@ def introspect(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/connect.rb b/lib/finch-api/resources/connect.rb index 538d30a8..ba71f94c 100644 --- a/lib/finch-api/resources/connect.rb +++ b/lib/finch-api/resources/connect.rb @@ -7,7 +7,6 @@ class Connect attr_reader :sessions # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @sessions = FinchAPI::Resources::Connect::Sessions.new(client: client) diff --git a/lib/finch-api/resources/connect/sessions.rb b/lib/finch-api/resources/connect/sessions.rb index f490b350..40b84600 100644 --- a/lib/finch-api/resources/connect/sessions.rb +++ b/lib/finch-api/resources/connect/sessions.rb @@ -30,7 +30,6 @@ class Sessions # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Connect::SessionNewResponse] - # def new(params) parsed, options = FinchAPI::Models::Connect::SessionNewParams.dump_request(params) @client.request( @@ -58,7 +57,6 @@ def new(params) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Connect::SessionReauthenticateResponse] - # def reauthenticate(params) parsed, options = FinchAPI::Models::Connect::SessionReauthenticateParams.dump_request(params) @client.request( @@ -71,7 +69,6 @@ def reauthenticate(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris.rb b/lib/finch-api/resources/hris.rb index 635afd0a..34b46404 100644 --- a/lib/finch-api/resources/hris.rb +++ b/lib/finch-api/resources/hris.rb @@ -28,7 +28,6 @@ class HRIS attr_reader :benefits # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @company = FinchAPI::Resources::HRIS::Company.new(client: client) diff --git a/lib/finch-api/resources/hris/benefits.rb b/lib/finch-api/resources/hris/benefits.rb index 6db28fd4..c7561451 100644 --- a/lib/finch-api/resources/hris/benefits.rb +++ b/lib/finch-api/resources/hris/benefits.rb @@ -23,7 +23,6 @@ class Benefits # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse] - # def create(params = {}) parsed, options = FinchAPI::Models::HRIS::BenefitCreateParams.dump_request(params) @client.request( @@ -44,7 +43,6 @@ def create(params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::HRIS::CompanyBenefit] - # def retrieve(benefit_id, params = {}) @client.request( method: :get, @@ -65,7 +63,6 @@ def retrieve(benefit_id, params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse] - # def update(benefit_id, params = {}) parsed, options = FinchAPI::Models::HRIS::BenefitUpdateParams.dump_request(params) @client.request( @@ -84,7 +81,6 @@ def update(benefit_id, params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def list(params = {}) @client.request( method: :get, @@ -102,7 +98,6 @@ def list(params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def list_supported_benefits(params = {}) @client.request( method: :get, @@ -114,7 +109,6 @@ def list_supported_benefits(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @individuals = FinchAPI::Resources::HRIS::Benefits::Individuals.new(client: client) diff --git a/lib/finch-api/resources/hris/benefits/individuals.rb b/lib/finch-api/resources/hris/benefits/individuals.rb index 81988f39..aa01453c 100644 --- a/lib/finch-api/resources/hris/benefits/individuals.rb +++ b/lib/finch-api/resources/hris/benefits/individuals.rb @@ -19,7 +19,6 @@ class Individuals # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def enroll_many(benefit_id, params = {}) parsed, options = FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams.dump_request(params) @client.request( @@ -41,7 +40,6 @@ def enroll_many(benefit_id, params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse] - # def enrolled_ids(benefit_id, params = {}) @client.request( method: :get, @@ -63,7 +61,6 @@ def enrolled_ids(benefit_id, params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def retrieve_many_benefits(benefit_id, params = {}) parsed, options = FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params) @client.request( @@ -87,7 +84,6 @@ def retrieve_many_benefits(benefit_id, params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def unenroll_many(benefit_id, params = {}) parsed, options = FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams.dump_request(params) @client.request( @@ -101,7 +97,6 @@ def unenroll_many(benefit_id, params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris/company.rb b/lib/finch-api/resources/hris/company.rb index c9901cfa..05f07846 100644 --- a/lib/finch-api/resources/hris/company.rb +++ b/lib/finch-api/resources/hris/company.rb @@ -11,7 +11,6 @@ class Company # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::HRIS::HRISCompany] - # def retrieve(params = {}) @client.request( method: :get, @@ -22,7 +21,6 @@ def retrieve(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris/directory.rb b/lib/finch-api/resources/hris/directory.rb index 6eb7a56a..051952f8 100644 --- a/lib/finch-api/resources/hris/directory.rb +++ b/lib/finch-api/resources/hris/directory.rb @@ -15,7 +15,6 @@ class Directory # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::IndividualsPage] - # def list(params = {}) parsed, options = FinchAPI::Models::HRIS::DirectoryListParams.dump_request(params) @client.request( @@ -34,7 +33,6 @@ def list(params = {}) alias_method :list_individuals, :list # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris/documents.rb b/lib/finch-api/resources/hris/documents.rb index 5a7aa50b..7ddc6506 100644 --- a/lib/finch-api/resources/hris/documents.rb +++ b/lib/finch-api/resources/hris/documents.rb @@ -22,7 +22,6 @@ class Documents # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::HRIS::DocumentListResponse] - # def list(params = {}) parsed, options = FinchAPI::Models::HRIS::DocumentListParams.dump_request(params) @client.request( @@ -44,7 +43,6 @@ def list(params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005] - # def retreive(document_id, params = {}) @client.request( method: :get, @@ -55,7 +53,6 @@ def retreive(document_id, params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris/employments.rb b/lib/finch-api/resources/hris/employments.rb index de3c9938..524377f0 100644 --- a/lib/finch-api/resources/hris/employments.rb +++ b/lib/finch-api/resources/hris/employments.rb @@ -13,7 +13,6 @@ class Employments # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::ResponsesPage] - # def retrieve_many(params) parsed, options = FinchAPI::Models::HRIS::EmploymentRetrieveManyParams.dump_request(params) @client.request( @@ -27,7 +26,6 @@ def retrieve_many(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris/individuals.rb b/lib/finch-api/resources/hris/individuals.rb index 336d2549..fc4bb17f 100644 --- a/lib/finch-api/resources/hris/individuals.rb +++ b/lib/finch-api/resources/hris/individuals.rb @@ -15,7 +15,6 @@ class Individuals # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::ResponsesPage] - # def retrieve_many(params = {}) parsed, options = FinchAPI::Models::HRIS::IndividualRetrieveManyParams.dump_request(params) @client.request( @@ -29,7 +28,6 @@ def retrieve_many(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris/pay_statements.rb b/lib/finch-api/resources/hris/pay_statements.rb index 963734af..309e6d3d 100644 --- a/lib/finch-api/resources/hris/pay_statements.rb +++ b/lib/finch-api/resources/hris/pay_statements.rb @@ -16,7 +16,6 @@ class PayStatements # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::ResponsesPage] - # def retrieve_many(params) parsed, options = FinchAPI::Models::HRIS::PayStatementRetrieveManyParams.dump_request(params) @client.request( @@ -30,7 +29,6 @@ def retrieve_many(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/hris/payments.rb b/lib/finch-api/resources/hris/payments.rb index 6bb93ed0..e54785ca 100644 --- a/lib/finch-api/resources/hris/payments.rb +++ b/lib/finch-api/resources/hris/payments.rb @@ -17,7 +17,6 @@ class Payments # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def list(params) parsed, options = FinchAPI::Models::HRIS::PaymentListParams.dump_request(params) @client.request( @@ -31,7 +30,6 @@ def list(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/jobs.rb b/lib/finch-api/resources/jobs.rb index ba33b43b..06d80494 100644 --- a/lib/finch-api/resources/jobs.rb +++ b/lib/finch-api/resources/jobs.rb @@ -10,7 +10,6 @@ class Jobs attr_reader :manual # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @automated = FinchAPI::Resources::Jobs::Automated.new(client: client) diff --git a/lib/finch-api/resources/jobs/automated.rb b/lib/finch-api/resources/jobs/automated.rb index 61d6d0cf..66d2b505 100644 --- a/lib/finch-api/resources/jobs/automated.rb +++ b/lib/finch-api/resources/jobs/automated.rb @@ -28,7 +28,6 @@ class Automated # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Jobs::AutomatedCreateResponse] - # def create(params) parsed, options = FinchAPI::Models::Jobs::AutomatedCreateParams.dump_request(params) @client.request( @@ -49,7 +48,6 @@ def create(params) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob] - # def retrieve(job_id, params = {}) @client.request( method: :get, @@ -72,7 +70,6 @@ def retrieve(job_id, params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Jobs::AutomatedListResponse] - # def list(params = {}) parsed, options = FinchAPI::Models::Jobs::AutomatedListParams.dump_request(params) @client.request( @@ -85,7 +82,6 @@ def list(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/jobs/manual.rb b/lib/finch-api/resources/jobs/manual.rb index bb9d7ac5..a6cdc88e 100644 --- a/lib/finch-api/resources/jobs/manual.rb +++ b/lib/finch-api/resources/jobs/manual.rb @@ -14,7 +14,6 @@ class Manual # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Jobs::ManualAsyncJob] - # def retrieve(job_id, params = {}) @client.request( method: :get, @@ -25,7 +24,6 @@ def retrieve(job_id, params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/payroll.rb b/lib/finch-api/resources/payroll.rb index 57884396..ae4d0c07 100644 --- a/lib/finch-api/resources/payroll.rb +++ b/lib/finch-api/resources/payroll.rb @@ -7,7 +7,6 @@ class Payroll attr_reader :pay_groups # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @pay_groups = FinchAPI::Resources::Payroll::PayGroups.new(client: client) diff --git a/lib/finch-api/resources/payroll/pay_groups.rb b/lib/finch-api/resources/payroll/pay_groups.rb index 4b792392..2c07d48e 100644 --- a/lib/finch-api/resources/payroll/pay_groups.rb +++ b/lib/finch-api/resources/payroll/pay_groups.rb @@ -13,7 +13,6 @@ class PayGroups # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Payroll::PayGroupRetrieveResponse] - # def retrieve(pay_group_id, params = {}) @client.request( method: :get, @@ -34,7 +33,6 @@ def retrieve(pay_group_id, params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def list(params = {}) parsed, options = FinchAPI::Models::Payroll::PayGroupListParams.dump_request(params) @client.request( @@ -48,7 +46,6 @@ def list(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/providers.rb b/lib/finch-api/resources/providers.rb index ce6daa52..3edff480 100644 --- a/lib/finch-api/resources/providers.rb +++ b/lib/finch-api/resources/providers.rb @@ -10,7 +10,6 @@ class Providers # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::SinglePage] - # def list(params = {}) @client.request( method: :get, @@ -22,7 +21,6 @@ def list(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/request_forwarding.rb b/lib/finch-api/resources/request_forwarding.rb index c41cd81a..cc0b573d 100644 --- a/lib/finch-api/resources/request_forwarding.rb +++ b/lib/finch-api/resources/request_forwarding.rb @@ -30,7 +30,6 @@ class RequestForwarding # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::RequestForwardingForwardResponse] - # def forward(params) parsed, options = FinchAPI::Models::RequestForwardingForwardParams.dump_request(params) @client.request( @@ -43,7 +42,6 @@ def forward(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/sandbox.rb b/lib/finch-api/resources/sandbox.rb index ebde5169..6e34091f 100644 --- a/lib/finch-api/resources/sandbox.rb +++ b/lib/finch-api/resources/sandbox.rb @@ -25,7 +25,6 @@ class Sandbox attr_reader :jobs # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @connections = FinchAPI::Resources::Sandbox::Connections.new(client: client) diff --git a/lib/finch-api/resources/sandbox/company.rb b/lib/finch-api/resources/sandbox/company.rb index 140a7b50..70c8df86 100644 --- a/lib/finch-api/resources/sandbox/company.rb +++ b/lib/finch-api/resources/sandbox/company.rb @@ -27,7 +27,6 @@ class Company # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse] - # def update(params) parsed, options = FinchAPI::Models::Sandbox::CompanyUpdateParams.dump_request(params) @client.request( @@ -40,7 +39,6 @@ def update(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/sandbox/connections.rb b/lib/finch-api/resources/sandbox/connections.rb index 80f00bc1..f1c1c117 100644 --- a/lib/finch-api/resources/sandbox/connections.rb +++ b/lib/finch-api/resources/sandbox/connections.rb @@ -24,7 +24,6 @@ class Connections # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::ConnectionCreateResponse] - # def create(params) parsed, options = FinchAPI::Models::Sandbox::ConnectionCreateParams.dump_request(params) @client.request( @@ -37,7 +36,6 @@ def create(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @accounts = FinchAPI::Resources::Sandbox::Connections::Accounts.new(client: client) diff --git a/lib/finch-api/resources/sandbox/connections/accounts.rb b/lib/finch-api/resources/sandbox/connections/accounts.rb index f3e7997a..e1589b6b 100644 --- a/lib/finch-api/resources/sandbox/connections/accounts.rb +++ b/lib/finch-api/resources/sandbox/connections/accounts.rb @@ -21,7 +21,6 @@ class Accounts # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::Connections::AccountCreateResponse] - # def create(params) parsed, options = FinchAPI::Models::Sandbox::Connections::AccountCreateParams.dump_request(params) @client.request( @@ -43,7 +42,6 @@ def create(params) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse] - # def update(params = {}) parsed, options = FinchAPI::Models::Sandbox::Connections::AccountUpdateParams.dump_request(params) @client.request( @@ -56,7 +54,6 @@ def update(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/sandbox/directory.rb b/lib/finch-api/resources/sandbox/directory.rb index 26fd4156..04e5e44d 100644 --- a/lib/finch-api/resources/sandbox/directory.rb +++ b/lib/finch-api/resources/sandbox/directory.rb @@ -14,7 +14,6 @@ class Directory # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Array] - # def create(params = {}) parsed, options = FinchAPI::Models::Sandbox::DirectoryCreateParams.dump_request(params) @client.request( @@ -27,7 +26,6 @@ def create(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/sandbox/employment.rb b/lib/finch-api/resources/sandbox/employment.rb index 3fc0520a..56efcbe0 100644 --- a/lib/finch-api/resources/sandbox/employment.rb +++ b/lib/finch-api/resources/sandbox/employment.rb @@ -53,7 +53,6 @@ class Employment # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::EmploymentUpdateResponse] - # def update(individual_id, params = {}) parsed, options = FinchAPI::Models::Sandbox::EmploymentUpdateParams.dump_request(params) @client.request( @@ -66,7 +65,6 @@ def update(individual_id, params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/sandbox/individual.rb b/lib/finch-api/resources/sandbox/individual.rb index 19065cfd..541489d7 100644 --- a/lib/finch-api/resources/sandbox/individual.rb +++ b/lib/finch-api/resources/sandbox/individual.rb @@ -42,7 +42,6 @@ class Individual # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::IndividualUpdateResponse] - # def update(individual_id, params = {}) parsed, options = FinchAPI::Models::Sandbox::IndividualUpdateParams.dump_request(params) @client.request( @@ -55,7 +54,6 @@ def update(individual_id, params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/sandbox/jobs.rb b/lib/finch-api/resources/sandbox/jobs.rb index 08859b39..f98aaf4e 100644 --- a/lib/finch-api/resources/sandbox/jobs.rb +++ b/lib/finch-api/resources/sandbox/jobs.rb @@ -16,7 +16,6 @@ class Jobs # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::JobCreateResponse] - # def create(params) parsed, options = FinchAPI::Models::Sandbox::JobCreateParams.dump_request(params) @client.request( @@ -29,7 +28,6 @@ def create(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client @configuration = FinchAPI::Resources::Sandbox::Jobs::Configuration.new(client: client) diff --git a/lib/finch-api/resources/sandbox/jobs/configuration.rb b/lib/finch-api/resources/sandbox/jobs/configuration.rb index cc8cb27f..c0464b09 100644 --- a/lib/finch-api/resources/sandbox/jobs/configuration.rb +++ b/lib/finch-api/resources/sandbox/jobs/configuration.rb @@ -12,7 +12,6 @@ class Configuration # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Array] - # def retrieve(params = {}) @client.request( method: :get, @@ -33,7 +32,6 @@ def retrieve(params = {}) # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration] - # def update(params) parsed, options = FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params) @client.request( @@ -46,7 +44,6 @@ def update(params) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/sandbox/payment.rb b/lib/finch-api/resources/sandbox/payment.rb index da0669ea..753ae9ac 100644 --- a/lib/finch-api/resources/sandbox/payment.rb +++ b/lib/finch-api/resources/sandbox/payment.rb @@ -17,7 +17,6 @@ class Payment # @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [FinchAPI::Models::Sandbox::PaymentCreateResponse] - # def create(params = {}) parsed, options = FinchAPI::Models::Sandbox::PaymentCreateParams.dump_request(params) @client.request( @@ -30,7 +29,6 @@ def create(params = {}) end # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/resources/webhooks.rb b/lib/finch-api/resources/webhooks.rb index 6a8781e0..c82af6c9 100644 --- a/lib/finch-api/resources/webhooks.rb +++ b/lib/finch-api/resources/webhooks.rb @@ -4,7 +4,6 @@ module FinchAPI module Resources class Webhooks # @param client [FinchAPI::Client] - # def initialize(client:) @client = client end diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index b50d12fb..771f4640 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -27,13 +27,12 @@ class ResponsesPage # @return [Array] attr_accessor :responses - # @private + # @api private # # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param page_data [Array] - # def initialize(client:, req:, headers:, page_data:) super model = req.fetch(:model) @@ -52,13 +51,11 @@ def next_page? # @raise [FinchAPI::HTTP::Error] # @return [FinchAPI::ResponsesPage] - # def next_page RuntimeError.new("No more pages available.") end # @param blk [Proc] - # def auto_paging_each(&blk) unless block_given? raise ArgumentError.new("A block must be given to ##{__method__}") @@ -72,7 +69,6 @@ def auto_paging_each(&blk) end # @return [String] - # def inspect "#<#{self.class}:0x#{object_id.to_s(16)} responses=#{responses.inspect}>" end diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index 1920206e..5dfebcd9 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -24,13 +24,12 @@ module FinchAPI class SinglePage < ::Array include FinchAPI::BasePage - # @private + # @api private # # @param client [FinchAPI::BaseClient] # @param req [Hash{Symbol=>Object}] # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param page_data [Array] - # def initialize(client:, req:, headers:, page_data:) super model = req.fetch(:model) @@ -49,13 +48,11 @@ def next_page? # @raise [FinchAPI::HTTP::Error] # @return [FinchAPI::SinglePage] - # def next_page RuntimeError.new("No more pages available.") end # @param blk [Proc] - # def auto_paging_each(&blk) unless block_given? raise ArgumentError.new("A block must be given to ##{__method__}") @@ -69,7 +66,6 @@ def auto_paging_each(&blk) end # @return [String] - # def inspect "#<#{self.class}:0x#{object_id.to_s(16)}>" end diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 72f9b5cd..8a3f7894 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -3,20 +3,17 @@ module FinchAPI # rubocop:disable Metrics/ModuleLength - # @private - # + # @api private module Util - # @private + # @api private # # @return [Float] - # def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC) class << self - # @private + # @api private # # @return [String] - # def arch case (arch = RbConfig::CONFIG["arch"])&.downcase in nil @@ -32,10 +29,9 @@ def arch end end - # @private + # @api private # # @return [String] - # def os case (host = RbConfig::CONFIG["host_os"])&.downcase in nil @@ -57,12 +53,11 @@ def os end class << self - # @private + # @api private # # @param input [Object] # # @return [Boolean, Object] - # def primitive?(input) case input in true | false | Integer | Float | Symbol | String @@ -72,12 +67,11 @@ def primitive?(input) end end - # @private + # @api private # # @param input [Object] # # @return [Boolean, Object] - # def coerce_boolean(input) case input.is_a?(String) ? input.downcase : input in Numeric @@ -91,13 +85,12 @@ def coerce_boolean(input) end end - # @private + # @api private # # @param input [Object] # # @raise [ArgumentError] # @return [Boolean, nil] - # def coerce_boolean!(input) case coerce_boolean(input) in true | false | nil => coerced @@ -107,12 +100,11 @@ def coerce_boolean!(input) end end - # @private + # @api private # # @param input [Object] # # @return [Integer, Object] - # def coerce_integer(input) case input in true @@ -124,12 +116,11 @@ def coerce_integer(input) end end - # @private + # @api private # # @param input [Object] # # @return [Float, Object] - # def coerce_float(input) case input in true @@ -141,12 +132,11 @@ def coerce_float(input) end end - # @private + # @api private # # @param input [Object] # # @return [Hash{Object=>Object}, Object] - # def coerce_hash(input) case input in NilClass | Array | Set | Enumerator @@ -165,14 +155,13 @@ def coerce_hash(input) OMIT = Object.new.freeze class << self - # @private + # @api private # # @param lhs [Object] # @param rhs [Object] # @param concat [Boolean] # # @return [Object] - # private def deep_merge_lr(lhs, rhs, concat: false) case [lhs, rhs, concat] in [Hash, Hash, _] @@ -191,7 +180,7 @@ class << self end end - # @private + # @api private # # Recursively merge one hash with another. If the values at a given key are not # both hashes, just take the new value. @@ -203,7 +192,6 @@ class << self # @param concat [Boolean] whether to merge sequences by concatenation. # # @return [Object] - # def deep_merge(*values, sentinel: nil, concat: false) case values in [value, *values] @@ -215,7 +203,7 @@ def deep_merge(*values, sentinel: nil, concat: false) end end - # @private + # @api private # # @param data [Hash{Symbol=>Object}, Array, Object] # @param pick [Symbol, Integer, Array, nil] @@ -223,7 +211,6 @@ def deep_merge(*values, sentinel: nil, concat: false) # @param blk [Proc, nil] # # @return [Object, nil] - # def dig(data, pick, sentinel = nil, &blk) case [data, pick, blk] in [_, nil, nil] @@ -248,22 +235,20 @@ def dig(data, pick, sentinel = nil, &blk) end class << self - # @private + # @api private # # @param uri [URI::Generic] # # @return [String] - # def uri_origin(uri) "#{uri.scheme}://#{uri.host}#{uri.port == uri.default_port ? '' : ":#{uri.port}"}" end - # @private + # @api private # # @param path [String, Array] # # @return [String] - # def interpolate_path(path) case path in String @@ -278,40 +263,37 @@ def interpolate_path(path) end class << self - # @private + # @api private # # @param query [String, nil] # # @return [Hash{String=>Array}] - # def decode_query(query) CGI.parse(query.to_s) end - # @private + # @api private # # @param query [Hash{String=>Array, String, nil}, nil] # # @return [String, nil] - # def encode_query(query) query.to_h.empty? ? nil : URI.encode_www_form(query) end end class << self - # @private + # @api private # # @param url [URI::Generic, String] # # @return [Hash{Symbol=>String, Integer, nil}] - # def parse_uri(url) parsed = URI::Generic.component.zip(URI.split(url)).to_h {**parsed, query: decode_query(parsed.fetch(:query))} end - # @private + # @api private # # @param parsed [Hash{Symbol=>String, Integer, nil}] . # @@ -326,12 +308,11 @@ def parse_uri(url) # @option parsed [Hash{String=>Array}] :query # # @return [URI::Generic] - # def unparse_uri(parsed) URI::Generic.build(**parsed, query: encode_query(parsed.fetch(:query))) end - # @private + # @api private # # @param lhs [Hash{Symbol=>String, Integer, nil}] . # @@ -358,7 +339,6 @@ def unparse_uri(parsed) # @option rhs [Hash{String=>Array}] :query # # @return [URI::Generic] - # def join_parsed_uri(lhs, rhs) base_path, base_query = lhs.fetch_values(:path, :query) slashed = base_path.end_with?("/") ? base_path : "#{base_path}/" @@ -380,12 +360,11 @@ def join_parsed_uri(lhs, rhs) end class << self - # @private + # @api private # # @param headers [Hash{String=>String, Integer, Array, nil}] # # @return [Hash{String=>String}] - # def normalized_headers(*headers) {}.merge(*headers.compact).to_h do |key, val| case val @@ -399,16 +378,15 @@ def normalized_headers(*headers) end end - # @private + # @api private # # An adapter that satisfies the IO interface required by `::IO.copy_stream` class ReadIOAdapter - # @private + # @api private # # @param max_len [Integer, nil] # # @return [String] - # private def read_enum(max_len) case max_len in nil @@ -422,13 +400,12 @@ class ReadIOAdapter @buf.slice!(0..) end - # @private + # @api private # # @param max_len [Integer, nil] # @param out_string [String, nil] # # @return [String, nil] - # def read(max_len = nil, out_string = nil) case @stream in nil @@ -447,11 +424,10 @@ def read(max_len = nil, out_string = nil) .tap(&@blk) end - # @private + # @api private # # @param stream [String, IO, StringIO, Enumerable] # @param blk [Proc] - # def initialize(stream, &blk) @stream = stream.is_a?(String) ? StringIO.new(stream) : stream @buf = String.new.b @@ -463,7 +439,6 @@ class << self # @param blk [Proc] # # @return [Enumerable] - # def string_io(&blk) Enumerator.new do |y| y.define_singleton_method(:write) do @@ -477,13 +452,12 @@ def string_io(&blk) end class << self - # @private + # @api private # # @param y [Enumerator::Yielder] # @param boundary [String] # @param key [Symbol, String] # @param val [Object] - # private def encode_multipart_formdata(y, boundary:, key:, val:) y << "--#{boundary}\r\n" y << "Content-Disposition: form-data" @@ -516,12 +490,11 @@ class << self y << "\r\n" end - # @private + # @api private # # @param body [Object] # # @return [Array(String, Enumerable)] - # private def encode_multipart_streaming(body) boundary = SecureRandom.urlsafe_base64(60) @@ -547,13 +520,12 @@ class << self [boundary, strio] end - # @private + # @api private # # @param headers [Hash{String=>String}] # @param body [Object] # # @return [Object] - # def encode_content(headers, body) content_type = headers["content-type"] case [content_type, body] @@ -572,7 +544,7 @@ def encode_content(headers, body) end end - # @private + # @api private # # @param headers [Hash{String=>String}, Net::HTTPHeader] # @param stream [Enumerable] @@ -580,7 +552,6 @@ def encode_content(headers, body) # # @raise [JSON::ParserError] # @return [Object] - # def decode_content(headers, stream:, suppress_error: false) case headers["content-type"] in %r{^application/(?:vnd\.api\+)?json} @@ -609,7 +580,7 @@ def decode_content(headers, stream:, suppress_error: false) end class << self - # @private + # @api private # # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html # @@ -618,7 +589,6 @@ class << self # @param close [Proc] # # @return [Enumerable] - # def fused_enum(enum, external: false, &close) fused = false iter = Enumerator.new do |y| @@ -642,10 +612,9 @@ def fused_enum(enum, external: false, &close) iter end - # @private + # @api private # # @param enum [Enumerable, nil] - # def close_fused!(enum) return unless enum.is_a?(Enumerator) @@ -654,11 +623,10 @@ def close_fused!(enum) # rubocop:enable Lint/UnreachableLoop end - # @private + # @api private # # @param enum [Enumerable, nil] # @param blk [Proc] - # def chain_fused(enum, &blk) iter = Enumerator.new { blk.call(_1) } fused_enum(iter) { close_fused!(enum) } @@ -666,12 +634,11 @@ def chain_fused(enum, &blk) end class << self - # @private + # @api private # # @param enum [Enumerable] # # @return [Enumerable] - # def decode_lines(enum) re = /(\r\n|\r|\n)/ buffer = String.new.b @@ -701,14 +668,13 @@ def decode_lines(enum) end end - # @private + # @api private # # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream # # @param lines [Enumerable] # # @return [Hash{Symbol=>Object}] - # def decode_sse(lines) # rubocop:disable Metrics/BlockLength chain_fused(lines) do |y| diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index e0384f35..a259092c 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -44,16 +44,19 @@ module FinchAPI PLATFORM_HEADERS = T::Hash[String, String] class << self + # @api private sig { params(req: FinchAPI::BaseClient::RequestComponentsShape).void } def validate!(req) end + # @api private sig do params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean) end def should_retry?(status, headers:) end + # @api private sig do params( request: FinchAPI::BaseClient::RequestInputShape, @@ -74,6 +77,7 @@ module FinchAPI def requester=(_) end + # @api private sig do params( base_url: String, @@ -98,14 +102,17 @@ module FinchAPI ) end + # @api private sig { overridable.returns(T::Hash[String, String]) } private def auth_headers end + # @api private sig { returns(String) } private def generate_idempotency_key end + # @api private sig do overridable .params(req: FinchAPI::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything]) @@ -114,10 +121,12 @@ module FinchAPI private def build_request(req, opts) end + # @api private sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) } private def retry_delay(headers, retry_count:) end + # @api private sig do params( request: FinchAPI::BaseClient::RequestInputShape, @@ -130,6 +139,8 @@ module FinchAPI private def send_request(request, redirect_count:, retry_count:, send_retry_header:) end + # Execute the request specified by `req`. This is the method that all resource + # methods call into. sig do params( method: Symbol, diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 011d1cef..9232581a 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -1,19 +1,23 @@ # typed: strong module FinchAPI + # @api private module Converter abstract! Input = T.type_alias { T.any(FinchAPI::Converter, T::Class[T.anything]) } + # @api private sig { overridable.params(value: T.anything).returns(T.anything) } def coerce(value) end + # @api private sig { overridable.params(value: T.anything).returns(T.anything) } def dump(value) end + # @api private sig do overridable .params(value: T.anything) @@ -23,6 +27,7 @@ module FinchAPI end class << self + # @api private sig do params( spec: T.any( @@ -40,20 +45,40 @@ module FinchAPI def self.type_info(spec) end + # @api private + # + # Based on `target`, transform `value` into `target`, to the extent possible: + # + # 1. if the given `value` conforms to `target` already, return the given `value` + # 2. if it's possible and safe to convert the given `value` to `target`, then the + # converted value + # 3. otherwise, the given `value` unaltered sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } def self.coerce(target, value) end + # @api private sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } def self.dump(target, value) end + # @api private + # + # The underlying algorithm for computing maximal compatibility is subject to + # future improvements. + # + # Similar to `#.coerce`, used to determine the best union variant to decode into. + # + # 1. determine if strict-ish coercion is possible + # 2. return either result of successful coercion or if loose coercion is possible + # 3. return a score for recursively tallied count for fields that can be coerced sig { params(target: FinchAPI::Converter::Input, value: T.anything).returns(T.anything) } def self.try_strict_coerce(target, value) end end end + # When we don't know what to expect for the value. class Unknown abstract! @@ -68,14 +93,17 @@ module FinchAPI end class << self + # @api private sig { override.params(value: T.anything).returns(T.anything) } def coerce(value) end + # @api private sig { override.params(value: T.anything).returns(T.anything) } def dump(value) end + # @api private sig do override .params(value: T.anything) @@ -86,6 +114,7 @@ module FinchAPI end end + # Ruby has no Boolean class; this is something for models to refer to. class BooleanModel abstract! @@ -100,14 +129,17 @@ module FinchAPI end class << self + # @api private sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } def coerce(value) end + # @api private sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } def dump(value) end + # @api private sig do override .params(value: T.anything) @@ -118,16 +150,30 @@ module FinchAPI end end + # A value from among a specified list of options. OpenAPI enum values map to Ruby + # values in the SDK as follows: + # + # 1. boolean => true | false + # 2. integer => Integer + # 3. float => Float + # 4. string => Symbol + # + # We can therefore convert string values to Symbols, but can't convert other + # values safely. class Enum abstract! extend FinchAPI::Converter class << self + # All of the valid Symbol values for this enum. sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } def values end + # @api private + # + # Guard against thread safety issues by instantiating `@values`. sig { void } private def finalize! end @@ -142,14 +188,17 @@ module FinchAPI end class << self + # @api private sig { override.params(value: T.any(String, Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } def coerce(value) end + # @api private sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } def dump(value) end + # @api private sig do override .params(value: T.anything) @@ -166,18 +215,26 @@ module FinchAPI extend FinchAPI::Converter class << self + # @api private + # + # All of the specified variant info for this union. sig { returns(T::Array[[T.nilable(Symbol), Proc]]) } private def known_variants end + # @api private + # + # All of the specified variants for this union. sig { overridable.returns(T::Array[[T.nilable(Symbol), T.anything]]) } protected def variants end + # @api private sig { params(property: Symbol).void } private def discriminator(property) end + # @api private sig do params( key: T.any( @@ -197,6 +254,7 @@ module FinchAPI private def variant(key, spec = nil) end + # @api private sig { params(value: T.anything).returns(T.nilable(FinchAPI::Converter::Input)) } private def resolve_variant(value) end @@ -211,14 +269,17 @@ module FinchAPI end class << self + # @api private sig { override.params(value: T.anything).returns(T.anything) } def coerce(value) end + # @api private sig { override.params(value: T.anything).returns(T.anything) } def dump(value) end + # @api private sig do override .params(value: T.anything) @@ -229,6 +290,7 @@ module FinchAPI end end + # Array of items of a given type. class ArrayOf abstract! @@ -242,6 +304,7 @@ module FinchAPI def ==(other) end + # @api private sig do override .params(value: T.any(T::Enumerable[T.anything], T.anything)) @@ -250,6 +313,7 @@ module FinchAPI def coerce(value) end + # @api private sig do override .params(value: T.any(T::Enumerable[T.anything], T.anything)) @@ -258,6 +322,7 @@ module FinchAPI def dump(value) end + # @api private sig do override .params(value: T.anything) @@ -266,10 +331,12 @@ module FinchAPI def try_strict_coerce(value) end + # @api private sig { returns(FinchAPI::Converter::Input) } protected def item_type end + # @api private sig do params( type_info: T.any( @@ -285,6 +352,7 @@ module FinchAPI end end + # Hash of items of a given type. class HashOf abstract! @@ -298,6 +366,7 @@ module FinchAPI def ==(other) end + # @api private sig do override .params(value: T.any(T::Hash[T.anything, T.anything], T.anything)) @@ -306,6 +375,7 @@ module FinchAPI def coerce(value) end + # @api private sig do override .params(value: T.any(T::Hash[T.anything, T.anything], T.anything)) @@ -314,6 +384,7 @@ module FinchAPI def dump(value) end + # @api private sig do override .params(value: T.anything) @@ -322,10 +393,12 @@ module FinchAPI def try_strict_coerce(value) end + # @api private sig { returns(FinchAPI::Converter::Input) } protected def item_type end + # @api private sig do params( type_info: T.any( @@ -349,6 +422,10 @@ module FinchAPI KnownFieldShape = T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean} } class << self + # @api private + # + # Assumes superclass fields are totally defined before fields are accessed / + # defined on subclasses. sig do returns( T::Hash[Symbol, @@ -370,10 +447,12 @@ module FinchAPI def fields end + # @api private sig { returns(T::Hash[Symbol, T.proc.returns(T::Class[T.anything])]) } def defaults end + # @api private sig do params( name_sym: Symbol, @@ -396,6 +475,7 @@ module FinchAPI private def add_field(name_sym, required:, type_info:, spec:) end + # @api private sig do params( name_sym: Symbol, @@ -411,6 +491,7 @@ module FinchAPI def required(name_sym, type_info, spec = {}) end + # @api private sig do params( name_sym: Symbol, @@ -426,10 +507,17 @@ module FinchAPI def optional(name_sym, type_info, spec = {}) end + # @api private + # + # `request_only` attributes not excluded from `.#coerce` when receiving responses + # even if well behaved servers should not send them sig { params(blk: T.proc.void).void } private def request_only(&blk) end + # @api private + # + # `response_only` attributes are omitted from `.#dump` when making requests sig { params(blk: T.proc.void).void } private def response_only(&blk) end @@ -440,6 +528,7 @@ module FinchAPI end class << self + # @api private sig do override .params(value: T.any(FinchAPI::BaseModel, T::Hash[T.anything, T.anything], T.anything)) @@ -448,6 +537,7 @@ module FinchAPI def coerce(value) end + # @api private sig do override .params(value: T.any(T.attached_class, T.anything)) @@ -456,6 +546,7 @@ module FinchAPI def dump(value) end + # @api private sig do override .params(value: T.anything) @@ -465,10 +556,24 @@ module FinchAPI end end + # Returns the raw value associated with the given key, if found. Otherwise, nil is + # returned. + # + # It is valid to lookup keys that are not in the API spec, for example to access + # undocumented features. This method does not parse response data into + # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. sig { params(key: Symbol).returns(T.nilable(T.anything)) } def [](key) end + # Returns a Hash of the data underlying this object. O(1) + # + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. + # + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. sig { overridable.returns(T::Hash[Symbol, T.anything]) } def to_h end @@ -479,6 +584,7 @@ module FinchAPI def deconstruct_keys(keys) end + # Create a new instance of a model. sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(T.attached_class) } def self.new(data = {}) end diff --git a/rbi/lib/finch-api/base_page.rbi b/rbi/lib/finch-api/base_page.rbi index be43acec..a4179591 100644 --- a/rbi/lib/finch-api/base_page.rbi +++ b/rbi/lib/finch-api/base_page.rbi @@ -1,6 +1,7 @@ # typed: strong module FinchAPI + # @api private module BasePage abstract! @@ -24,6 +25,7 @@ module FinchAPI alias_method :enum_for, :to_enum + # @api private sig do params( client: FinchAPI::BaseClient, diff --git a/rbi/lib/finch-api/client.rbi b/rbi/lib/finch-api/client.rbi index 5eb4a38f..354a6a68 100644 --- a/rbi/lib/finch-api/client.rbi +++ b/rbi/lib/finch-api/client.rbi @@ -62,18 +62,22 @@ module FinchAPI def connect end + # @api private sig { override.returns(T::Hash[String, String]) } private def auth_headers end + # @api private sig { returns(T::Hash[String, String]) } private def bearer_auth end + # @api private sig { returns(T::Hash[String, String]) } private def basic_auth end + # Creates and returns a new client for interacting with the API. sig do params( base_url: T.nilable(String), diff --git a/rbi/lib/finch-api/errors.rbi b/rbi/lib/finch-api/errors.rbi index 5e66d661..6d2fb306 100644 --- a/rbi/lib/finch-api/errors.rbi +++ b/rbi/lib/finch-api/errors.rbi @@ -23,6 +23,7 @@ module FinchAPI def body end + # @api private sig do params( url: URI::Generic, @@ -47,6 +48,7 @@ module FinchAPI def body end + # @api private sig do params( url: URI::Generic, @@ -63,6 +65,7 @@ module FinchAPI end class APITimeoutError < FinchAPI::APIConnectionError + # @api private sig do params( url: URI::Generic, @@ -79,6 +82,7 @@ module FinchAPI end class APIStatusError < FinchAPI::APIError + # @api private sig do params( url: URI::Generic, @@ -97,6 +101,7 @@ module FinchAPI def status end + # @api private sig do params( url: URI::Generic, diff --git a/rbi/lib/finch-api/extern.rbi b/rbi/lib/finch-api/extern.rbi index 2affab87..36a18dd5 100644 --- a/rbi/lib/finch-api/extern.rbi +++ b/rbi/lib/finch-api/extern.rbi @@ -1,6 +1,7 @@ # typed: strong module FinchAPI + # @api private module Extern abstract! end diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index 503fcb3e..9b88dc10 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -67,6 +67,8 @@ module FinchAPI end class AuthenticationMethod < FinchAPI::BaseModel + # Each benefit type and their supported features. If the benefit type is not + # supported, the property will be null sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) } def benefits_support end @@ -78,6 +80,7 @@ module FinchAPI def benefits_support=(_) end + # The supported data fields returned by our HR and payroll endpoints sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields)) } def supported_fields end @@ -89,6 +92,7 @@ module FinchAPI def supported_fields=(_) end + # The type of authentication method. sig { returns(T.nilable(Symbol)) } def type end @@ -227,6 +231,7 @@ module FinchAPI def payment=(_) end + # The supported data fields returned by our HR and payroll endpoints sig do params( company: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, @@ -2445,6 +2450,7 @@ module FinchAPI end end + # The type of authentication method. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/base_webhook_event.rbi b/rbi/lib/finch-api/models/base_webhook_event.rbi index e37f3e40..084ebe54 100644 --- a/rbi/lib/finch-api/models/base_webhook_event.rbi +++ b/rbi/lib/finch-api/models/base_webhook_event.rbi @@ -3,6 +3,9 @@ module FinchAPI module Models class BaseWebhookEvent < FinchAPI::BaseModel + # [DEPRECATED] Unique Finch ID of the employer account used to make this + # connection. Use `connection_id` instead to identify the connection associated + # with this event. sig { returns(String) } def account_id end @@ -11,6 +14,8 @@ module FinchAPI def account_id=(_) end + # [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use + # `connection_id` instead to identify the connection associated with this event. sig { returns(String) } def company_id end @@ -19,6 +24,7 @@ module FinchAPI def company_id=(_) end + # Unique Finch ID of the connection associated with the webhook event. sig { returns(T.nilable(String)) } def connection_id end diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 98f04cdb..aa355e5d 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -58,6 +58,8 @@ module FinchAPI def manual=(_) end + # The number of minutes until the session expires (defaults to 43,200, which is 30 + # days) sig { returns(T.nilable(Float)) } def minutes_to_expire end @@ -131,6 +133,7 @@ module FinchAPI def to_hash end + # The Finch products that can be requested during the Connect flow. class Product < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/connect/session_new_response.rbi b/rbi/lib/finch-api/models/connect/session_new_response.rbi index c22e5851..8b146c57 100644 --- a/rbi/lib/finch-api/models/connect/session_new_response.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Connect class SessionNewResponse < FinchAPI::BaseModel + # The Connect URL to redirect the user to for authentication sig { returns(String) } def connect_url end @@ -12,6 +13,7 @@ module FinchAPI def connect_url=(_) end + # The unique identifier for the created connect session sig { returns(String) } def session_id end diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 32f04917..0b19d358 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The ID of the existing connection to reauthenticate sig { returns(String) } def connection_id end @@ -15,6 +16,8 @@ module FinchAPI def connection_id=(_) end + # The number of minutes until the session expires (defaults to 43,200, which is 30 + # days) sig { returns(T.nilable(Integer)) } def minutes_to_expire end @@ -23,6 +26,7 @@ module FinchAPI def minutes_to_expire=(_) end + # The products to request access to (optional for reauthentication) sig { returns(T.nilable(T::Array[Symbol])) } def products end @@ -31,6 +35,7 @@ module FinchAPI def products=(_) end + # The URI to redirect to after the Connect flow is completed sig { returns(T.nilable(String)) } def redirect_uri end @@ -67,6 +72,7 @@ module FinchAPI def to_hash end + # The Finch products that can be requested during the Connect flow. class Product < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi index f7c2f733..7ef06a67 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Connect class SessionReauthenticateResponse < FinchAPI::BaseModel + # The Connect URL to redirect the user to for reauthentication sig { returns(String) } def connect_url end @@ -12,6 +13,7 @@ module FinchAPI def connect_url=(_) end + # The unique identifier for the created connect session sig { returns(String) } def session_id end diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index a3945ba9..bd6d0e86 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models class CreateAccessTokenResponse < FinchAPI::BaseModel + # The access token for the connection. sig { returns(String) } def access_token end @@ -11,6 +12,8 @@ module FinchAPI def access_token=(_) end + # [DEPRECATED] Use `connection_id` to identify the connection instead of this + # account ID. sig { returns(String) } def account_id end @@ -19,6 +22,7 @@ module FinchAPI def account_id=(_) end + # The type of application associated with a token. sig { returns(Symbol) } def client_type end @@ -27,6 +31,8 @@ module FinchAPI def client_type=(_) end + # [DEPRECATED] Use `connection_id` to identify the connection instead of this + # company ID. sig { returns(String) } def company_id end @@ -35,6 +41,7 @@ module FinchAPI def company_id=(_) end + # The Finch UUID of the connection associated with the `access_token`. sig { returns(String) } def connection_id end @@ -43,6 +50,10 @@ module FinchAPI def connection_id=(_) end + # The type of the connection associated with the token. + # + # - `provider` - connection to an external provider + # - `finch` - finch-generated data. sig { returns(Symbol) } def connection_type end @@ -51,6 +62,7 @@ module FinchAPI def connection_type=(_) end + # An array of the authorized products associated with the `access_token`. sig { returns(T::Array[String]) } def products end @@ -59,6 +71,7 @@ module FinchAPI def products=(_) end + # The ID of the provider associated with the `access_token`. sig { returns(String) } def provider_id end @@ -67,6 +80,8 @@ module FinchAPI def provider_id=(_) end + # The ID of your customer you provided to Finch when a connect session was created + # for this connection. sig { returns(T.nilable(String)) } def customer_id end @@ -75,6 +90,7 @@ module FinchAPI def customer_id=(_) end + # The RFC 8693 token type (Finch uses `bearer` tokens) sig { returns(T.nilable(String)) } def token_type end @@ -132,6 +148,7 @@ module FinchAPI def to_hash end + # The type of application associated with a token. class ClientType < FinchAPI::Enum abstract! @@ -146,6 +163,10 @@ module FinchAPI end end + # The type of the connection associated with the token. + # + # - `provider` - connection to an external provider + # - `finch` - finch-generated data. class ConnectionType < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index b9d57c97..e23a5127 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -28,6 +28,7 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # The ID of the individual related to the event. sig { returns(T.nilable(String)) } def individual_id end diff --git a/rbi/lib/finch-api/models/disconnect_response.rbi b/rbi/lib/finch-api/models/disconnect_response.rbi index fd0919b1..5b1ccc63 100644 --- a/rbi/lib/finch-api/models/disconnect_response.rbi +++ b/rbi/lib/finch-api/models/disconnect_response.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models class DisconnectResponse < FinchAPI::BaseModel + # If the request is successful, Finch will return “success” (HTTP 200 status). sig { returns(String) } def status end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index 9e8d92ac..8e333f49 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -28,6 +28,7 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # The ID of the individual related to the event. sig { returns(T.nilable(String)) } def individual_id end diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index 05db919f..d2748b07 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class BenefitContribution < FinchAPI::BaseModel + # Contribution amount in cents (if `fixed`) or basis points (if `percent`). sig { returns(T.nilable(Integer)) } def amount end @@ -12,6 +13,7 @@ module FinchAPI def amount=(_) end + # Contribution type. sig { returns(T.nilable(Symbol)) } def type end @@ -28,6 +30,7 @@ module FinchAPI def to_hash end + # Contribution type. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi index 8db9cd4f..adbb1584 100644 --- a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi @@ -7,6 +7,9 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # 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). sig { returns(T.nilable(String)) } def description end @@ -23,6 +26,7 @@ module FinchAPI def frequency=(_) end + # Type of benefit. sig { returns(T.nilable(Symbol)) } def type end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 51a97da6..e54d4249 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -49,6 +49,7 @@ module FinchAPI end class SupportedFeatures < FinchAPI::BaseModel + # Whether the provider supports an annual maximum for this benefit. sig { returns(T.nilable(T::Boolean)) } def annual_maximum end @@ -57,6 +58,8 @@ module FinchAPI def annual_maximum=(_) end + # Whether the provider supports catch up for this benefit. This field will only be + # true for retirement benefits. sig { returns(T.nilable(T::Boolean)) } def catch_up end @@ -65,6 +68,8 @@ module FinchAPI def catch_up=(_) end + # Supported contribution types. An empty array indicates contributions are not + # supported. sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def company_contribution end @@ -83,6 +88,8 @@ module FinchAPI def description=(_) end + # Supported deduction types. An empty array indicates deductions are not + # supported. sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def employee_deduction end @@ -93,6 +100,7 @@ module FinchAPI def employee_deduction=(_) end + # The list of frequencies supported by the provider for this benefit sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def frequencies end @@ -101,6 +109,8 @@ module FinchAPI def frequencies=(_) end + # Whether the provider supports HSA contribution limits. Empty if this feature is + # not supported for the benefit. This array only has values for HSA benefits. sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def hsa_contribution_limit end diff --git a/rbi/lib/finch-api/models/hris/benefit_type.rbi b/rbi/lib/finch-api/models/hris/benefit_type.rbi index 54cd8af9..b21dfd59 100644 --- a/rbi/lib/finch-api/models/hris/benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_type.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models module HRIS + # Type of benefit. class BenefitType < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi index f18a1660..99d5a3ca 100644 --- a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Updated name or description. sig { returns(T.nilable(String)) } def description end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index e196b50c..66bdb1fe 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -16,6 +16,7 @@ module FinchAPI def body=(_) end + # HTTP status code. Either 201 or 200 sig { returns(T.nilable(Integer)) } def code end @@ -53,6 +54,7 @@ module FinchAPI end class Body < FinchAPI::BaseModel + # A descriptive identifier for the response sig { returns(T.nilable(String)) } def finch_code end @@ -61,6 +63,7 @@ module FinchAPI def finch_code=(_) end + # Short description in English that provides more information about the response. sig { returns(T.nilable(String)) } def message end @@ -69,6 +72,7 @@ module FinchAPI def message=(_) end + # Identifier indicating whether the benefit was newly enrolled or updated. sig { returns(T.nilable(String)) } def name end @@ -97,6 +101,7 @@ module FinchAPI end end + # HTTP status code. Either 201 or 200 class Code < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index f33dff24..0e7a1acc 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -55,6 +55,7 @@ module FinchAPI end class Body < FinchAPI::BaseModel + # If the benefit supports annual maximum, the amount in cents for this individual. sig { returns(T.nilable(Integer)) } def annual_maximum end @@ -63,6 +64,8 @@ module FinchAPI def annual_maximum=(_) end + # If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled + # for this individual. sig { returns(T.nilable(T::Boolean)) } def catch_up end @@ -93,6 +96,7 @@ module FinchAPI def employee_deduction=(_) end + # Type for HSA contribution limit if the benefit is a HSA. sig { returns(T.nilable(Symbol)) } def hsa_contribution_limit end @@ -135,6 +139,7 @@ module FinchAPI def to_hash end + # Type for HSA contribution limit if the benefit is a HSA. class HsaContributionLimit < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index 7606de81..2b12fd07 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -8,6 +8,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Array of the individual_id to enroll and a configuration object. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual])) } def individuals end @@ -57,6 +58,7 @@ module FinchAPI def configuration=(_) end + # Finch id (uuidv4) for the individual to enroll sig { returns(T.nilable(String)) } def individual_id end @@ -88,6 +90,8 @@ module FinchAPI end class Configuration < FinchAPI::BaseModel + # For HSA benefits only - whether the contribution limit is for an individual or + # family sig { returns(T.nilable(Symbol)) } def annual_contribution_limit end @@ -96,6 +100,7 @@ module FinchAPI def annual_contribution_limit=(_) end + # Maximum annual amount in cents sig { returns(T.nilable(Integer)) } def annual_maximum end @@ -104,6 +109,7 @@ module FinchAPI def annual_maximum=(_) end + # For retirement benefits only - whether catch up contributions are enabled sig { returns(T.nilable(T::Boolean)) } def catch_up end @@ -188,6 +194,8 @@ module FinchAPI def to_hash end + # For HSA benefits only - whether the contribution limit is for an individual or + # family class AnnualContributionLimit < FinchAPI::Enum abstract! @@ -202,6 +210,8 @@ module FinchAPI end class CompanyContribution < FinchAPI::BaseModel + # Amount in cents for fixed type or basis points (1/100th of a percent) for + # percent type sig { returns(T.nilable(Integer)) } def amount end @@ -241,6 +251,8 @@ module FinchAPI end class EmployeeDeduction < FinchAPI::BaseModel + # Amount in cents for fixed type or basis points (1/100th of a percent) for + # percent type sig { returns(T.nilable(Integer)) } def amount end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi index 7260acb8..2753b624 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi @@ -8,6 +8,8 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # comma-delimited list of stable Finch uuids for each individual. If empty, + # defaults to all individuals sig { returns(T.nilable(String)) } def individual_ids end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi index 9cd88cf3..7c755396 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi @@ -8,6 +8,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Array of individual_ids to unenroll. sig { returns(T.nilable(T::Array[String])) } def individual_ids end diff --git a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi index a7449d81..06af9c86 100644 --- a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi @@ -16,6 +16,7 @@ module FinchAPI def body=(_) end + # HTTP status code sig { returns(T.nilable(Integer)) } def code end @@ -53,6 +54,7 @@ module FinchAPI end class Body < FinchAPI::BaseModel + # A descriptive identifier for the response. sig { returns(T.nilable(String)) } def finch_code end @@ -61,6 +63,7 @@ module FinchAPI def finch_code=(_) end + # Short description in English that provides more information about the response. sig { returns(T.nilable(String)) } def message end @@ -69,6 +72,7 @@ module FinchAPI def message=(_) end + # Identifier indicating whether the benefit was newly enrolled or updated. sig { returns(T.nilable(String)) } def name end diff --git a/rbi/lib/finch-api/models/hris/benefits_support.rbi b/rbi/lib/finch-api/models/hris/benefits_support.rbi index 8089dc9a..ee390de0 100644 --- a/rbi/lib/finch-api/models/hris/benefits_support.rbi +++ b/rbi/lib/finch-api/models/hris/benefits_support.rbi @@ -136,6 +136,8 @@ module FinchAPI def simple_ira=(_) end + # Each benefit type and their supported features. If the benefit type is not + # supported, the property will be null sig do params( commuter: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 520edb5d..a0ea14d8 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class HRISCompany < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for the company. sig { returns(String) } def id end @@ -12,6 +13,7 @@ module FinchAPI def id=(_) end + # An array of bank account objects associated with the payroll/HRIS system. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account])) } def accounts end @@ -23,6 +25,7 @@ module FinchAPI def accounts=(_) end + # The array of company departments. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)])) } def departments end @@ -34,6 +37,7 @@ module FinchAPI def departments=(_) end + # The employer identification number. sig { returns(T.nilable(String)) } def ein end @@ -42,6 +46,7 @@ module FinchAPI def ein=(_) end + # The entity type object. sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity)) } def entity end @@ -53,6 +58,7 @@ module FinchAPI def entity=(_) end + # The legal name of the company. sig { returns(T.nilable(String)) } def legal_name end @@ -72,6 +78,7 @@ module FinchAPI def locations=(_) end + # The email of the main administrator on the account. sig { returns(T.nilable(String)) } def primary_email end @@ -80,6 +87,7 @@ module FinchAPI def primary_email=(_) end + # The phone number of the main administrator on the account. Format: `XXXXXXXXXX` sig { returns(T.nilable(String)) } def primary_phone_number end @@ -135,6 +143,7 @@ module FinchAPI end class Account < FinchAPI::BaseModel + # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } def account_name end @@ -143,6 +152,7 @@ module FinchAPI def account_name=(_) end + # 10-12 digit number to specify the bank account sig { returns(T.nilable(String)) } def account_number end @@ -151,6 +161,7 @@ module FinchAPI def account_number=(_) end + # The type of bank account. sig { returns(T.nilable(Symbol)) } def account_type end @@ -159,6 +170,7 @@ module FinchAPI def account_type=(_) end + # Name of the banking institution. sig { returns(T.nilable(String)) } def institution_name end @@ -167,6 +179,8 @@ module FinchAPI def institution_name=(_) end + # A nine-digit code that's based on the U.S. Bank location where your account was + # opened. sig { returns(T.nilable(String)) } def routing_number end @@ -203,6 +217,7 @@ module FinchAPI def to_hash end + # The type of bank account. class AccountType < FinchAPI::Enum abstract! @@ -218,6 +233,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The department name. sig { returns(T.nilable(String)) } def name end @@ -226,6 +242,7 @@ module FinchAPI def name=(_) end + # The parent department, if present. sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)) } def parent end @@ -257,6 +274,7 @@ module FinchAPI end class Parent < FinchAPI::BaseModel + # The parent department's name. sig { returns(T.nilable(String)) } def name end @@ -265,6 +283,7 @@ module FinchAPI def name=(_) end + # The parent department, if present. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -276,6 +295,7 @@ module FinchAPI end class Entity < FinchAPI::BaseModel + # The tax payer subtype of the company. sig { returns(T.nilable(Symbol)) } def subtype end @@ -284,6 +304,7 @@ module FinchAPI def subtype=(_) end + # The tax payer type of the company. sig { returns(T.nilable(Symbol)) } def type end @@ -292,6 +313,7 @@ module FinchAPI def type=(_) end + # The entity type object. sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } def self.new(subtype: nil, type: nil) end @@ -300,6 +322,7 @@ module FinchAPI def to_hash end + # The tax payer subtype of the company. class Subtype < FinchAPI::Enum abstract! @@ -314,6 +337,7 @@ module FinchAPI end end + # The tax payer type of the company. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/company_benefit.rbi b/rbi/lib/finch-api/models/hris/company_benefit.rbi index 28058d3d..ae2345b9 100644 --- a/rbi/lib/finch-api/models/hris/company_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/company_benefit.rbi @@ -28,6 +28,7 @@ module FinchAPI def frequency=(_) end + # Type of benefit. sig { returns(T.nilable(Symbol)) } def type end diff --git a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi index 630e3552..8bf199b4 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Number of employees to return (defaults to all) sig { returns(T.nilable(Integer)) } def limit end @@ -15,6 +16,7 @@ module FinchAPI def limit=(_) end + # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } def offset end diff --git a/rbi/lib/finch-api/models/hris/directory_list_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_params.rbi index 014aaaba..e1477b5e 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Number of employees to return (defaults to all) sig { returns(T.nilable(Integer)) } def limit end @@ -15,6 +16,7 @@ module FinchAPI def limit=(_) end + # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } def offset end diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index 8eef50a0..ea07c343 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -7,6 +7,8 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Comma-delimited list of stable Finch uuids for each individual. If empty, + # defaults to all individuals sig { returns(T.nilable(T::Array[String])) } def individual_ids end @@ -15,6 +17,7 @@ module FinchAPI def individual_ids=(_) end + # Number of documents to return (defaults to all) sig { returns(T.nilable(Integer)) } def limit end @@ -23,6 +26,7 @@ module FinchAPI def limit=(_) end + # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } def offset end @@ -31,6 +35,8 @@ module FinchAPI def offset=(_) end + # Comma-delimited list of document types to filter on. If empty, defaults to all + # types sig { returns(T.nilable(T::Array[Symbol])) } def types end diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index 270f5dd7..c4e61675 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class DocumentResponse < FinchAPI::BaseModel + # A stable Finch id for the document. sig { returns(T.nilable(String)) } def id end @@ -12,6 +13,8 @@ module FinchAPI def id=(_) end + # The ID of the individual associated with the document. This will be null for + # employer-level documents. sig { returns(T.nilable(String)) } def individual_id end @@ -20,6 +23,7 @@ module FinchAPI def individual_id=(_) end + # The type of document. sig { returns(T.nilable(Symbol)) } def type end @@ -28,6 +32,8 @@ module FinchAPI def type=(_) end + # A URL to access the document. Format: + # `https://api.tryfinch.com/employer/documents/:document_id`. sig { returns(T.nilable(String)) } def url end @@ -36,6 +42,7 @@ module FinchAPI def url=(_) end + # The year the document applies to, if available. sig { returns(T.nilable(Float)) } def year end @@ -70,6 +77,7 @@ module FinchAPI def to_hash end + # The type of document. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index 20f15cef..43e83e17 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -3,10 +3,13 @@ module FinchAPI module Models module HRIS + # A 2020 version of the W-4 tax form containing information on an individual's + # filing status, dependents, and withholding details. class DocumentRetreiveResponse < FinchAPI::Union abstract! class << self + # @api private sig { override.returns([[Symbol, FinchAPI::Models::HRIS::W42020], [Symbol, FinchAPI::Models::HRIS::W42005]]) } private def variants end diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index 5bb0c4bc..72097a41 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class EmploymentData < FinchAPI::BaseModel + # string A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -12,6 +13,7 @@ module FinchAPI def id=(_) end + # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } def class_code end @@ -20,6 +22,8 @@ module FinchAPI def class_code=(_) end + # Custom fields for the individual. These are fields which are defined by the + # employer in the system. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField])) } def custom_fields end @@ -31,6 +35,7 @@ module FinchAPI def custom_fields=(_) end + # The department object. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department)) } def department end @@ -42,6 +47,7 @@ module FinchAPI def department=(_) end + # The employment object. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment)) } def employment end @@ -53,6 +59,8 @@ module FinchAPI def employment=(_) end + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. sig { returns(T.nilable(Symbol)) } def employment_status end @@ -69,6 +77,7 @@ module FinchAPI def end_date=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -77,6 +86,9 @@ module FinchAPI def first_name=(_) end + # The employee's income as reported by the provider. This may not always be + # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, + # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } def income end @@ -85,6 +97,7 @@ module FinchAPI def income=(_) end + # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } def income_history end @@ -96,6 +109,7 @@ module FinchAPI def income_history=(_) end + # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } def is_active end @@ -104,6 +118,7 @@ module FinchAPI def is_active=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -128,6 +143,7 @@ module FinchAPI def location=(_) end + # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Manager)) } def manager end @@ -139,6 +155,7 @@ module FinchAPI def manager=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -147,6 +164,7 @@ module FinchAPI def middle_name=(_) end + # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } def source_id end @@ -163,6 +181,7 @@ module FinchAPI def start_date=(_) end + # The current title of the individual. sig { returns(T.nilable(String)) } def title end @@ -171,6 +190,7 @@ module FinchAPI def title=(_) end + # This field is deprecated in favour of `source_id` sig { returns(T.nilable(String)) } def work_id end @@ -285,6 +305,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The name of the department associated with the individual. sig { returns(T.nilable(String)) } def name end @@ -293,6 +314,7 @@ module FinchAPI def name=(_) end + # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -303,6 +325,8 @@ module FinchAPI end class Employment < FinchAPI::BaseModel + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(Symbol)) } def subtype end @@ -311,6 +335,7 @@ module FinchAPI def subtype=(_) end + # The main employment type of the individual. sig { returns(T.nilable(Symbol)) } def type end @@ -319,6 +344,7 @@ module FinchAPI def type=(_) end + # The employment object. sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } def self.new(subtype: nil, type: nil) end @@ -327,6 +353,8 @@ module FinchAPI def to_hash end + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. class Subtype < FinchAPI::Enum abstract! @@ -344,6 +372,7 @@ module FinchAPI end end + # The main employment type of the individual. class Type < FinchAPI::Enum abstract! @@ -358,6 +387,8 @@ module FinchAPI end end + # The detailed employment status of the individual. Available options: `active`, + # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. class EmploymentStatus < FinchAPI::Enum abstract! @@ -377,6 +408,7 @@ module FinchAPI end class Manager < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -385,6 +417,7 @@ module FinchAPI def id=(_) end + # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } def self.new(id: nil) end diff --git a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi index 43596013..c0cdda5e 100644 --- a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The array of batch requests. sig { returns(T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]) } def requests end @@ -41,6 +42,9 @@ module FinchAPI end class Request < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. There is no + # limit to the number of `individual_id` to send per request. It is preferantial + # to send all ids in a single request for Finch to optimize provider rate-limits. sig { returns(String) } def individual_id end diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index a3885d51..d4efca5c 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class Individual < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -31,6 +32,9 @@ module FinchAPI def emails=(_) end + # Social Security Number of the individual in **encrypted** format. This field is + # only available with the `ssn` scope enabled and the + # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } def encrypted_ssn end @@ -39,6 +43,7 @@ module FinchAPI def encrypted_ssn=(_) end + # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(Symbol)) } def ethnicity end @@ -47,6 +52,7 @@ module FinchAPI def ethnicity=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -55,6 +61,7 @@ module FinchAPI def first_name=(_) end + # The gender of the individual. sig { returns(T.nilable(Symbol)) } def gender end @@ -63,6 +70,7 @@ module FinchAPI def gender=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -71,6 +79,7 @@ module FinchAPI def last_name=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -90,6 +99,7 @@ module FinchAPI def phone_numbers=(_) end + # The preferred name of the individual. sig { returns(T.nilable(String)) } def preferred_name end @@ -106,6 +116,10 @@ module FinchAPI def residence=(_) end + # Social Security Number of the individual. This field is only available with the + # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the + # body. + # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } def ssn end @@ -211,6 +225,7 @@ module FinchAPI end end + # The EEOC-defined ethnicity of the individual. class Ethnicity < FinchAPI::Enum abstract! @@ -230,6 +245,7 @@ module FinchAPI end end + # The gender of the individual. class Gender < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi index 1fabaa08..2b91a06e 100644 --- a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +++ b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class IndividualInDirectory < FinchAPI::BaseModel + # A stable Finch id (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -12,6 +13,7 @@ module FinchAPI def id=(_) end + # The department object. sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Department)) } def department end @@ -23,6 +25,7 @@ module FinchAPI def department=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -31,6 +34,7 @@ module FinchAPI def first_name=(_) end + # `true` if the individual is an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } def is_active end @@ -39,6 +43,7 @@ module FinchAPI def is_active=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -47,6 +52,7 @@ module FinchAPI def last_name=(_) end + # The manager object. sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager)) } def manager end @@ -58,6 +64,7 @@ module FinchAPI def manager=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -99,6 +106,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The name of the department. sig { returns(T.nilable(String)) } def name end @@ -107,6 +115,7 @@ module FinchAPI def name=(_) end + # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -117,6 +126,7 @@ module FinchAPI end class Manager < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -125,6 +135,7 @@ module FinchAPI def id=(_) end + # The manager object. sig { params(id: String).returns(T.attached_class) } def self.new(id: nil) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index a786da8f..9f8c02ff 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class PayStatement < FinchAPI::BaseModel + # The array of earnings objects associated with this pay statement sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)])) } def earnings end @@ -15,6 +16,7 @@ module FinchAPI def earnings=(_) end + # The array of deductions objects associated with this pay statement. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)])) } def employee_deductions end @@ -45,6 +47,7 @@ module FinchAPI def gross_pay=(_) end + # A stable Finch `id` (UUID v4) for an individual in the company sig { returns(T.nilable(String)) } def individual_id end @@ -61,6 +64,7 @@ module FinchAPI def net_pay=(_) end + # The payment method. sig { returns(T.nilable(Symbol)) } def payment_method end @@ -69,6 +73,7 @@ module FinchAPI def payment_method=(_) end + # The array of taxes objects associated with this pay statement. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)])) } def taxes end @@ -80,6 +85,7 @@ module FinchAPI def taxes=(_) end + # The number of hours worked for this pay period sig { returns(T.nilable(Float)) } def total_hours end @@ -88,6 +94,7 @@ module FinchAPI def total_hours=(_) end + # The type of the payment associated with the pay statement. sig { returns(T.nilable(Symbol)) } def type end @@ -146,6 +153,7 @@ module FinchAPI end class Earning < FinchAPI::BaseModel + # The earnings amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -165,6 +173,7 @@ module FinchAPI def attributes=(_) end + # The earnings currency code. sig { returns(T.nilable(String)) } def currency end @@ -173,6 +182,8 @@ module FinchAPI def currency=(_) end + # The number of hours associated with this earning. (For salaried employees, this + # could be hours per pay period, `0` or `null`, depending on the provider). sig { returns(T.nilable(Float)) } def hours end @@ -181,6 +192,7 @@ module FinchAPI def hours=(_) end + # The exact name of the deduction from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -189,6 +201,7 @@ module FinchAPI def name=(_) end + # The type of earning. sig { returns(T.nilable(Symbol)) } def type end @@ -251,6 +264,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -269,6 +285,7 @@ module FinchAPI end end + # The type of earning. class Type < FinchAPI::Enum abstract! @@ -295,6 +312,7 @@ module FinchAPI end class EmployeeDeduction < FinchAPI::BaseModel + # The deduction amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -314,6 +332,7 @@ module FinchAPI def attributes=(_) end + # The deduction currency. sig { returns(T.nilable(String)) } def currency end @@ -322,6 +341,7 @@ module FinchAPI def currency=(_) end + # The deduction name from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -330,6 +350,7 @@ module FinchAPI def name=(_) end + # Boolean indicating if the deduction is pre-tax. sig { returns(T.nilable(T::Boolean)) } def pre_tax end @@ -338,6 +359,7 @@ module FinchAPI def pre_tax=(_) end + # Type of benefit. sig { returns(T.nilable(Symbol)) } def type end @@ -402,6 +424,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -422,6 +447,7 @@ module FinchAPI end class EmployerContribution < FinchAPI::BaseModel + # The contribution amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -441,6 +467,7 @@ module FinchAPI def attributes=(_) end + # The contribution currency. sig { returns(T.nilable(String)) } def currency end @@ -449,6 +476,7 @@ module FinchAPI def currency=(_) end + # The contribution name from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -457,6 +485,7 @@ module FinchAPI def name=(_) end + # Type of benefit. sig { returns(T.nilable(Symbol)) } def type end @@ -520,6 +549,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -539,6 +571,7 @@ module FinchAPI end end + # The payment method. class PaymentMethod < FinchAPI::Enum abstract! @@ -553,6 +586,7 @@ module FinchAPI end class Tax < FinchAPI::BaseModel + # The tax amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -572,6 +606,7 @@ module FinchAPI def attributes=(_) end + # The currency code. sig { returns(T.nilable(String)) } def currency end @@ -580,6 +615,7 @@ module FinchAPI def currency=(_) end + # `true` if the amount is paid by the employers. sig { returns(T.nilable(T::Boolean)) } def employer end @@ -588,6 +624,7 @@ module FinchAPI def employer=(_) end + # The exact name of tax from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -596,6 +633,7 @@ module FinchAPI def name=(_) end + # The type of taxes. sig { returns(T.nilable(Symbol)) } def type end @@ -657,6 +695,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -675,6 +716,7 @@ module FinchAPI end end + # The type of taxes. class Type < FinchAPI::Enum abstract! @@ -691,6 +733,7 @@ module FinchAPI end end + # The type of the payment associated with the pay statement. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi index dc41c553..f820bc3f 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi @@ -12,6 +12,7 @@ module FinchAPI def paging=(_) end + # The array of pay statements for the current payment. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::PayStatement])) } def pay_statements end diff --git a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi index a899aa93..51f5c858 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The array of batch requests. sig { returns(T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]) } def requests end @@ -41,6 +42,7 @@ module FinchAPI end class Request < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for a payment. sig { returns(String) } def payment_id end @@ -49,6 +51,7 @@ module FinchAPI def payment_id=(_) end + # Number of pay statements to return (defaults to all). sig { returns(T.nilable(Integer)) } def limit end @@ -57,6 +60,7 @@ module FinchAPI def limit=(_) end + # Index to start from. sig { returns(T.nilable(Integer)) } def offset end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 48276262..00531c43 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class Payment < FinchAPI::BaseModel + # The unique id for the payment. sig { returns(T.nilable(String)) } def id end @@ -52,6 +53,7 @@ module FinchAPI def gross_pay=(_) end + # Array of every individual on this payment. sig { returns(T.nilable(T::Array[String])) } def individual_ids end @@ -76,6 +78,7 @@ module FinchAPI def pay_date=(_) end + # List of pay frequencies associated with this payment. sig { returns(T.nilable(T::Array[Symbol])) } def pay_frequencies end @@ -84,6 +87,7 @@ module FinchAPI def pay_frequencies=(_) end + # Array of the Finch id (uuidv4) of every pay group associated with this payment. sig { returns(T.nilable(T::Array[String])) } def pay_group_ids end @@ -92,6 +96,7 @@ module FinchAPI def pay_group_ids=(_) end + # The pay period object. sig { returns(T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)) } def pay_period end @@ -195,6 +200,7 @@ module FinchAPI def start_date=(_) end + # The pay period object. sig { params(end_date: T.nilable(String), start_date: T.nilable(String)).returns(T.attached_class) } def self.new(end_date: nil, start_date: nil) end diff --git a/rbi/lib/finch-api/models/hris/payment_list_params.rbi b/rbi/lib/finch-api/models/hris/payment_list_params.rbi index a7216211..8266baef 100644 --- a/rbi/lib/finch-api/models/hris/payment_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/payment_list_params.rbi @@ -7,6 +7,8 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` + # format. sig { returns(Date) } def end_date end @@ -15,6 +17,8 @@ module FinchAPI def end_date=(_) end + # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` + # format. sig { returns(Date) } def start_date end diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index aac3e406..1e6d5ebd 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class SupportedBenefit < FinchAPI::BaseModel + # Whether the provider supports an annual maximum for this benefit. sig { returns(T.nilable(T::Boolean)) } def annual_maximum end @@ -12,6 +13,8 @@ module FinchAPI def annual_maximum=(_) end + # Whether the provider supports catch up for this benefit. This field will only be + # true for retirement benefits. sig { returns(T.nilable(T::Boolean)) } def catch_up end @@ -20,6 +23,8 @@ module FinchAPI def catch_up=(_) end + # Supported contribution types. An empty array indicates contributions are not + # supported. sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def company_contribution end @@ -38,6 +43,8 @@ module FinchAPI def description=(_) end + # Supported deduction types. An empty array indicates deductions are not + # supported. sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def employee_deduction end @@ -48,6 +55,7 @@ module FinchAPI def employee_deduction=(_) end + # The list of frequencies supported by the provider for this benefit sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def frequencies end @@ -56,6 +64,8 @@ module FinchAPI def frequencies=(_) end + # Whether the provider supports HSA contribution limits. Empty if this feature is + # not supported for the benefit. This array only has values for HSA benefits. sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } def hsa_contribution_limit end @@ -66,6 +76,7 @@ module FinchAPI def hsa_contribution_limit=(_) end + # Type of benefit. sig { returns(T.nilable(Symbol)) } def type end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 1b1f016c..839cb1b4 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class W42005 < FinchAPI::BaseModel + # Detailed information specific to the 2005 W4 form. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data)) } def data end @@ -12,6 +13,7 @@ module FinchAPI def data=(_) end + # Specifies the form type, indicating that this document is a 2005 W4 form. sig { returns(T.nilable(Symbol)) } def type end @@ -20,6 +22,7 @@ module FinchAPI def type=(_) end + # The tax year this W4 document applies to. sig { returns(T.nilable(Float)) } def year end @@ -28,6 +31,8 @@ module FinchAPI def year=(_) end + # A 2005 version of the W-4 tax form containing information on an individual's + # filing status, dependents, and withholding details. sig do params(data: FinchAPI::Models::HRIS::W42005::Data, type: Symbol, year: T.nilable(Float)) .returns(T.attached_class) @@ -40,6 +45,7 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # Additional withholding amount (in cents). sig { returns(T.nilable(Integer)) } def additional_withholding end @@ -48,6 +54,7 @@ module FinchAPI def additional_withholding=(_) end + # Indicates exemption status from federal tax withholding. sig { returns(T.nilable(Symbol)) } def exemption end @@ -56,6 +63,7 @@ module FinchAPI def exemption=(_) end + # The individual's filing status for tax purposes. sig { returns(T.nilable(Symbol)) } def filing_status end @@ -64,6 +72,7 @@ module FinchAPI def filing_status=(_) end + # The unique identifier for the individual associated with this 2005 W4 form. sig { returns(T.nilable(String)) } def individual_id end @@ -72,6 +81,7 @@ module FinchAPI def individual_id=(_) end + # Total number of allowances claimed (in cents). sig { returns(T.nilable(Integer)) } def total_number_of_allowances end @@ -80,6 +90,7 @@ module FinchAPI def total_number_of_allowances=(_) end + # Detailed information specific to the 2005 W4 form. sig do params( additional_withholding: T.nilable(Integer), @@ -114,6 +125,7 @@ module FinchAPI def to_hash end + # Indicates exemption status from federal tax withholding. class Exemption < FinchAPI::Enum abstract! @@ -127,6 +139,7 @@ module FinchAPI end end + # The individual's filing status for tax purposes. class FilingStatus < FinchAPI::Enum abstract! @@ -142,6 +155,7 @@ module FinchAPI end end + # Specifies the form type, indicating that this document is a 2005 W4 form. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 1116cb72..ac3a01c7 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module HRIS class W42020 < FinchAPI::BaseModel + # Detailed information specific to the 2020 W4 form. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data)) } def data end @@ -12,6 +13,7 @@ module FinchAPI def data=(_) end + # Specifies the form type, indicating that this document is a 2020 W4 form. sig { returns(T.nilable(Symbol)) } def type end @@ -20,6 +22,7 @@ module FinchAPI def type=(_) end + # The tax year this W4 document applies to. sig { returns(T.nilable(Float)) } def year end @@ -28,6 +31,8 @@ module FinchAPI def year=(_) end + # A 2020 version of the W-4 tax form containing information on an individual's + # filing status, dependents, and withholding details. sig do params(data: FinchAPI::Models::HRIS::W42020::Data, type: Symbol, year: T.nilable(Float)) .returns(T.attached_class) @@ -40,6 +45,8 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # Amount claimed for dependents other than qualifying children under 17 (in + # cents). sig { returns(T.nilable(Integer)) } def amount_for_other_dependents end @@ -48,6 +55,7 @@ module FinchAPI def amount_for_other_dependents=(_) end + # Amount claimed for dependents under 17 years old (in cents). sig { returns(T.nilable(Integer)) } def amount_for_qualifying_children_under_17 end @@ -56,6 +64,7 @@ module FinchAPI def amount_for_qualifying_children_under_17=(_) end + # Deductible expenses (in cents). sig { returns(T.nilable(Integer)) } def deductions end @@ -64,6 +73,7 @@ module FinchAPI def deductions=(_) end + # Additional withholding amount (in cents). sig { returns(T.nilable(Integer)) } def extra_withholding end @@ -72,6 +82,7 @@ module FinchAPI def extra_withholding=(_) end + # The individual's filing status for tax purposes. sig { returns(T.nilable(Symbol)) } def filing_status end @@ -80,6 +91,7 @@ module FinchAPI def filing_status=(_) end + # The unique identifier for the individual associated with this document. sig { returns(T.nilable(String)) } def individual_id end @@ -88,6 +100,7 @@ module FinchAPI def individual_id=(_) end + # Additional income from sources outside of primary employment (in cents). sig { returns(T.nilable(Integer)) } def other_income end @@ -96,6 +109,7 @@ module FinchAPI def other_income=(_) end + # Total amount claimed for dependents and other credits (in cents). sig { returns(T.nilable(Integer)) } def total_claim_dependent_and_other_credits end @@ -104,6 +118,7 @@ module FinchAPI def total_claim_dependent_and_other_credits=(_) end + # Detailed information specific to the 2020 W4 form. sig do params( amount_for_other_dependents: T.nilable(Integer), @@ -147,6 +162,7 @@ module FinchAPI def to_hash end + # The individual's filing status for tax purposes. class FilingStatus < FinchAPI::Enum abstract! @@ -167,6 +183,7 @@ module FinchAPI end end + # Specifies the form type, indicating that this document is a 2020 W4 form. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index 38e2665d..3a2dae58 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models class Income < FinchAPI::BaseModel + # The income amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -11,6 +12,7 @@ module FinchAPI def amount=(_) end + # The currency code. sig { returns(T.nilable(String)) } def currency end @@ -19,6 +21,7 @@ module FinchAPI def currency=(_) end + # The date the income amount went into effect. sig { returns(T.nilable(String)) } def effective_date end @@ -27,6 +30,8 @@ module FinchAPI def effective_date=(_) end + # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, + # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. sig { returns(T.nilable(Symbol)) } def unit end @@ -35,6 +40,9 @@ module FinchAPI def unit=(_) end + # The employee's income as reported by the provider. This may not always be + # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, + # depending on what information the provider returns. sig do params( amount: T.nilable(Integer), @@ -61,6 +69,8 @@ module FinchAPI def to_hash end + # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, + # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. class Unit < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 90da97ed..e8705e22 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -28,6 +28,7 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # The ID of the individual related to the event. sig { returns(T.nilable(String)) } def individual_id end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index 5302ee33..dce5ff7d 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -3,6 +3,8 @@ module FinchAPI module Models class Introspection < FinchAPI::BaseModel + # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection + # instead of this account ID. sig { returns(String) } def account_id end @@ -22,6 +24,7 @@ module FinchAPI def authentication_methods=(_) end + # The client ID of the application associated with the `access_token`. sig { returns(String) } def client_id end @@ -30,6 +33,7 @@ module FinchAPI def client_id=(_) end + # The type of application associated with a token. sig { returns(Symbol) } def client_type end @@ -38,6 +42,8 @@ module FinchAPI def client_type=(_) end + # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection + # instead of this company ID. sig { returns(String) } def company_id end @@ -46,6 +52,7 @@ module FinchAPI def company_id=(_) end + # The Finch UUID of the connection associated with the `access_token`. sig { returns(String) } def connection_id end @@ -65,6 +72,10 @@ module FinchAPI def connection_status=(_) end + # The type of the connection associated with the token. + # + # - `provider` - connection to an external provider + # - `finch` - finch-generated data. sig { returns(Symbol) } def connection_type end @@ -73,6 +84,8 @@ module FinchAPI def connection_type=(_) end + # The email of your customer you provided to Finch when a connect session was + # created for this connection. sig { returns(T.nilable(String)) } def customer_email end @@ -81,6 +94,8 @@ module FinchAPI def customer_email=(_) end + # The ID of your customer you provided to Finch when a connect session was created + # for this connection. sig { returns(T.nilable(String)) } def customer_id end @@ -89,6 +104,8 @@ module FinchAPI def customer_id=(_) end + # The name of your customer you provided to Finch when a connect session was + # created for this connection. sig { returns(T.nilable(String)) } def customer_name end @@ -97,6 +114,9 @@ module FinchAPI def customer_name=(_) end + # Whether the connection associated with the `access_token` uses the Assisted + # Connect Flow. (`true` if using Assisted Connect, `false` if connection is + # automated) sig { returns(T::Boolean) } def manual end @@ -105,6 +125,8 @@ module FinchAPI def manual=(_) end + # [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll + # provider ID. sig { returns(String) } def payroll_provider_id end @@ -113,6 +135,7 @@ module FinchAPI def payroll_provider_id=(_) end + # An array of the authorized products associated with the `access_token`. sig { returns(T::Array[String]) } def products end @@ -121,6 +144,7 @@ module FinchAPI def products=(_) end + # The ID of the provider associated with the `access_token`. sig { returns(String) } def provider_id end @@ -129,6 +153,7 @@ module FinchAPI def provider_id=(_) end + # The account username used for login associated with the `access_token`. sig { returns(String) } def username end @@ -216,6 +241,7 @@ module FinchAPI def connection_status=(_) end + # An array of the authorized products associated with the `access_token`. sig { returns(T.nilable(T::Array[String])) } def products end @@ -224,6 +250,7 @@ module FinchAPI def products=(_) end + # The type of authentication method. sig { returns(T.nilable(Symbol)) } def type end @@ -282,6 +309,7 @@ module FinchAPI end end + # The type of authentication method. class Type < FinchAPI::Enum abstract! @@ -299,6 +327,7 @@ module FinchAPI end end + # The type of application associated with a token. class ClientType < FinchAPI::Enum abstract! @@ -339,6 +368,10 @@ module FinchAPI end end + # The type of the connection associated with the token. + # + # - `provider` - connection to an external provider + # - `finch` - finch-generated data. class ConnectionType < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index d682064f..b6f16a19 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -28,6 +28,7 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # The id of the job which has completed. sig { returns(String) } def job_id end @@ -36,6 +37,7 @@ module FinchAPI def job_id=(_) end + # The url to query the result of the job. sig { returns(String) } def job_url end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 63c9171c..050b4f1c 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Jobs class AutomatedAsyncJob < FinchAPI::BaseModel + # The datetime the job completed. sig { returns(T.nilable(Time)) } def completed_at end @@ -12,6 +13,9 @@ module FinchAPI def completed_at=(_) end + # The datetime when the job was created. for scheduled jobs, this will be the + # initial connection time. For ad-hoc jobs, this will be the time the creation + # request was received. sig { returns(Time) } def created_at end @@ -20,6 +24,7 @@ module FinchAPI def created_at=(_) end + # The id of the job that has been created. sig { returns(String) } def job_id end @@ -28,6 +33,7 @@ module FinchAPI def job_id=(_) end + # The url that can be used to retrieve the job status sig { returns(String) } def job_url end @@ -36,6 +42,7 @@ module FinchAPI def job_url=(_) end + # The input parameters for the job. sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params)) } def params end @@ -47,6 +54,9 @@ module FinchAPI def params=(_) end + # The datetime a job is scheduled to be run. For scheduled jobs, this datetime can + # be in the future if the job has not yet been enqueued. For ad-hoc jobs, this + # field will be null. sig { returns(T.nilable(Time)) } def scheduled_at end @@ -55,6 +65,7 @@ module FinchAPI def scheduled_at=(_) end + # The datetime a job entered into the job queue. sig { returns(T.nilable(Time)) } def started_at end @@ -71,6 +82,7 @@ module FinchAPI def status=(_) end + # The type of automated job sig { returns(Symbol) } def type end @@ -116,6 +128,7 @@ module FinchAPI end class Params < FinchAPI::BaseModel + # The ID of the individual that the job was completed for. sig { returns(T.nilable(String)) } def individual_id end @@ -124,6 +137,7 @@ module FinchAPI def individual_id=(_) end + # The input parameters for the job. sig { params(individual_id: String).returns(T.attached_class) } def self.new(individual_id: nil) end @@ -150,6 +164,7 @@ module FinchAPI end end + # The type of automated job class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index 52c7f57c..29c81e50 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The type of job to start. sig { returns(Symbol) } def type end @@ -50,6 +51,7 @@ module FinchAPI def to_hash end + # The type of job to start. class Type < FinchAPI::Enum abstract! @@ -63,6 +65,7 @@ module FinchAPI end class Params < FinchAPI::BaseModel + # The unique ID of the individual for W-4 data sync. sig { returns(String) } def individual_id end diff --git a/rbi/lib/finch-api/models/jobs/automated_create_response.rbi b/rbi/lib/finch-api/models/jobs/automated_create_response.rbi index 2b8574f8..08db7b27 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Jobs class AutomatedCreateResponse < FinchAPI::BaseModel + # The number of allowed refreshes per hour (per hour, fixed window) sig { returns(Integer) } def allowed_refreshes end @@ -12,6 +13,7 @@ module FinchAPI def allowed_refreshes=(_) end + # The id of the job that has been created. sig { returns(String) } def job_id end @@ -20,6 +22,7 @@ module FinchAPI def job_id=(_) end + # The url that can be used to retrieve the job status sig { returns(String) } def job_url end @@ -28,6 +31,7 @@ module FinchAPI def job_url=(_) end + # The number of remaining refreshes available (per hour, fixed window) sig { returns(Integer) } def remaining_refreshes end diff --git a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi index a43ad8a0..edda36b7 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Number of items to return sig { returns(T.nilable(Integer)) } def limit end @@ -15,6 +16,7 @@ module FinchAPI def limit=(_) end + # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } def offset end diff --git a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi index 455b4020..6c9c3f87 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi @@ -49,6 +49,10 @@ module FinchAPI end class Meta < FinchAPI::BaseModel + # Information about remaining quotas for this connection. Only applicable for + # customers opted in to use Finch's Data Sync Refresh endpoint + # (`POST /jobs/automated`). Please contact a Finch representative for more + # details. sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas)) } def quotas end @@ -80,6 +84,10 @@ module FinchAPI def data_sync_all=(_) end + # Information about remaining quotas for this connection. Only applicable for + # customers opted in to use Finch's Data Sync Refresh endpoint + # (`POST /jobs/automated`). Please contact a Finch representative for more + # details. sig do params(data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index dbd8d0b1..ab90a51b 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Jobs class ManualAsyncJob < FinchAPI::BaseModel + # Specific information about the job, such as individual statuses for batch jobs. sig { returns(T.nilable(T::Array[T.anything])) } def body end diff --git a/rbi/lib/finch-api/models/location.rbi b/rbi/lib/finch-api/models/location.rbi index 37d65c8b..363fa7cb 100644 --- a/rbi/lib/finch-api/models/location.rbi +++ b/rbi/lib/finch-api/models/location.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models class Location < FinchAPI::BaseModel + # City, district, suburb, town, or village. sig { returns(T.nilable(String)) } def city end @@ -11,6 +12,7 @@ module FinchAPI def city=(_) end + # The 2-letter ISO 3166 country code. sig { returns(T.nilable(String)) } def country end @@ -19,6 +21,7 @@ module FinchAPI def country=(_) end + # Street address or PO box. sig { returns(T.nilable(String)) } def line1 end @@ -27,6 +30,7 @@ module FinchAPI def line1=(_) end + # Apartment, suite, unit, or building. sig { returns(T.nilable(String)) } def line2 end @@ -43,6 +47,7 @@ module FinchAPI def name=(_) end + # The postal code or zip code. sig { returns(T.nilable(String)) } def postal_code end @@ -59,6 +64,7 @@ module FinchAPI def source_id=(_) end + # The state code. sig { returns(T.nilable(String)) } def state end diff --git a/rbi/lib/finch-api/models/money.rbi b/rbi/lib/finch-api/models/money.rbi index 08502d23..5309e3f2 100644 --- a/rbi/lib/finch-api/models/money.rbi +++ b/rbi/lib/finch-api/models/money.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models class Money < FinchAPI::BaseModel + # Amount for money object (in cents) sig { returns(T.nilable(Integer)) } def amount end diff --git a/rbi/lib/finch-api/models/operation_support.rbi b/rbi/lib/finch-api/models/operation_support.rbi index 332a51fa..f6b272a9 100644 --- a/rbi/lib/finch-api/models/operation_support.rbi +++ b/rbi/lib/finch-api/models/operation_support.rbi @@ -2,6 +2,13 @@ module FinchAPI module Models + # - `supported`: This operation is supported by both the provider and Finch + # - `not_supported_by_finch`: This operation is not supported by Finch but + # supported by the provider + # - `not_supported_by_provider`: This operation is not supported by the provider, + # so Finch cannot support + # - `client_access_only`: This behavior is supported by the provider, but only + # available to the client and not to Finch class OperationSupport < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/operation_support_matrix.rbi b/rbi/lib/finch-api/models/operation_support_matrix.rbi index ab902c92..1abc2138 100644 --- a/rbi/lib/finch-api/models/operation_support_matrix.rbi +++ b/rbi/lib/finch-api/models/operation_support_matrix.rbi @@ -3,6 +3,13 @@ module FinchAPI module Models class OperationSupportMatrix < FinchAPI::BaseModel + # - `supported`: This operation is supported by both the provider and Finch + # - `not_supported_by_finch`: This operation is not supported by Finch but + # supported by the provider + # - `not_supported_by_provider`: This operation is not supported by the provider, + # so Finch cannot support + # - `client_access_only`: This behavior is supported by the provider, but only + # available to the client and not to Finch sig { returns(T.nilable(Symbol)) } def create end @@ -11,6 +18,13 @@ module FinchAPI def create=(_) end + # - `supported`: This operation is supported by both the provider and Finch + # - `not_supported_by_finch`: This operation is not supported by Finch but + # supported by the provider + # - `not_supported_by_provider`: This operation is not supported by the provider, + # so Finch cannot support + # - `client_access_only`: This behavior is supported by the provider, but only + # available to the client and not to Finch sig { returns(T.nilable(Symbol)) } def delete end @@ -19,6 +33,13 @@ module FinchAPI def delete=(_) end + # - `supported`: This operation is supported by both the provider and Finch + # - `not_supported_by_finch`: This operation is not supported by Finch but + # supported by the provider + # - `not_supported_by_provider`: This operation is not supported by the provider, + # so Finch cannot support + # - `client_access_only`: This behavior is supported by the provider, but only + # available to the client and not to Finch sig { returns(T.nilable(Symbol)) } def read end @@ -27,6 +48,13 @@ module FinchAPI def read=(_) end + # - `supported`: This operation is supported by both the provider and Finch + # - `not_supported_by_finch`: This operation is not supported by Finch but + # supported by the provider + # - `not_supported_by_provider`: This operation is not supported by the provider, + # so Finch cannot support + # - `client_access_only`: This behavior is supported by the provider, but only + # available to the client and not to Finch sig { returns(T.nilable(Symbol)) } def update end diff --git a/rbi/lib/finch-api/models/paging.rbi b/rbi/lib/finch-api/models/paging.rbi index e25dd0b8..17f0de0f 100644 --- a/rbi/lib/finch-api/models/paging.rbi +++ b/rbi/lib/finch-api/models/paging.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models class Paging < FinchAPI::BaseModel + # The total number of elements for the entire query (not just the given page) sig { returns(T.nilable(Integer)) } def count end @@ -11,6 +12,7 @@ module FinchAPI def count=(_) end + # The current start index of the returned list of elements sig { returns(T.nilable(Integer)) } def offset end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index daee2039..4838210c 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -28,6 +28,7 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # The ID of the individual associated with the pay statement. sig { returns(T.nilable(String)) } def individual_id end @@ -36,6 +37,7 @@ module FinchAPI def individual_id=(_) end + # The ID of the payment associated with the pay statement. sig { returns(T.nilable(String)) } def payment_id end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index 0bee1654..bcf1b5ec 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -28,6 +28,7 @@ module FinchAPI end class Data < FinchAPI::BaseModel + # The date of the payment. sig { returns(String) } def pay_date end @@ -36,6 +37,7 @@ module FinchAPI def pay_date=(_) end + # The ID of the payment. sig { returns(String) } def payment_id end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index 72d3d5e1..6f19c0cc 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Payroll class PayGroupListResponse < FinchAPI::BaseModel + # Finch id (uuidv4) for the pay group sig { returns(T.nilable(String)) } def id end @@ -12,6 +13,7 @@ module FinchAPI def id=(_) end + # Name of the pay group sig { returns(T.nilable(String)) } def name end @@ -20,6 +22,7 @@ module FinchAPI def name=(_) end + # List of pay frequencies associated with this pay group sig { returns(T.nilable(T::Array[Symbol])) } def pay_frequencies end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index c9d4d00c..bee781c1 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Payroll class PayGroupRetrieveResponse < FinchAPI::BaseModel + # Finch id (uuidv4) for the pay group sig { returns(String) } def id end @@ -20,6 +21,7 @@ module FinchAPI def individual_ids=(_) end + # Name of the pay group sig { returns(String) } def name end @@ -28,6 +30,7 @@ module FinchAPI def name=(_) end + # List of pay frequencies associated with this pay group sig { returns(T::Array[Symbol]) } def pay_frequencies end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 34aa2f91..15ce1c40 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -3,6 +3,7 @@ module FinchAPI module Models class Provider < FinchAPI::BaseModel + # The id of the payroll provider used in Connect. sig { returns(T.nilable(String)) } def id end @@ -11,6 +12,7 @@ module FinchAPI def id=(_) end + # The list of authentication methods supported by the provider. sig { returns(T.nilable(T::Array[FinchAPI::Models::Provider::AuthenticationMethod])) } def authentication_methods end @@ -22,6 +24,7 @@ module FinchAPI def authentication_methods=(_) end + # `true` if the integration is in a beta state, `false` otherwise sig { returns(T.nilable(T::Boolean)) } def beta end @@ -30,6 +33,7 @@ module FinchAPI def beta=(_) end + # The display name of the payroll provider. sig { returns(T.nilable(String)) } def display_name end @@ -38,6 +42,7 @@ module FinchAPI def display_name=(_) end + # The url to the official icon of the payroll provider. sig { returns(T.nilable(String)) } def icon end @@ -46,6 +51,7 @@ module FinchAPI def icon=(_) end + # The url to the official logo of the payroll provider. sig { returns(T.nilable(String)) } def logo end @@ -54,6 +60,9 @@ module FinchAPI def logo=(_) end + # [DEPRECATED] Whether the Finch integration with this provider uses the Assisted + # Connect Flow by default. This field is now deprecated. Please check for a `type` + # of `assisted` in the `authentication_methods` field instead. sig { returns(T.nilable(T::Boolean)) } def manual end @@ -62,6 +71,7 @@ module FinchAPI def manual=(_) end + # whether MFA is required for the provider. sig { returns(T.nilable(T::Boolean)) } def mfa_required end @@ -70,6 +80,7 @@ module FinchAPI def mfa_required=(_) end + # The hex code for the primary color of the payroll provider. sig { returns(T.nilable(String)) } def primary_color end @@ -78,6 +89,7 @@ module FinchAPI def primary_color=(_) end + # The list of Finch products supported on this payroll provider. sig { returns(T.nilable(T::Array[String])) } def products end @@ -136,6 +148,8 @@ module FinchAPI end class AuthenticationMethod < FinchAPI::BaseModel + # Each benefit type and their supported features. If the benefit type is not + # supported, the property will be null sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) } def benefits_support end @@ -147,6 +161,7 @@ module FinchAPI def benefits_support=(_) end + # The supported data fields returned by our HR and payroll endpoints sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields)) } def supported_fields end @@ -158,6 +173,7 @@ module FinchAPI def supported_fields=(_) end + # The type of authentication method. sig { returns(T.nilable(Symbol)) } def type end @@ -268,6 +284,7 @@ module FinchAPI def payment=(_) end + # The supported data fields returned by our HR and payroll endpoints sig do params( company: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, @@ -2342,6 +2359,7 @@ module FinchAPI end end + # The type of authentication method. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi index f39a9f0f..c50eb830 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi @@ -6,6 +6,8 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The HTTP method for the forwarded request. Valid values include: `GET` , `POST` + # , `PUT` , `DELETE` , and `PATCH`. sig { returns(String) } def method_ end @@ -14,6 +16,9 @@ module FinchAPI def method_=(_) end + # The URL route path for the forwarded request. This value must begin with a + # forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and + # underscores. sig { returns(String) } def route end @@ -22,6 +27,8 @@ module FinchAPI def route=(_) end + # The body for the forwarded request. This value must be specified as either a + # string or a valid JSON object. sig { returns(T.nilable(String)) } def data end @@ -30,6 +37,9 @@ module FinchAPI def data=(_) end + # The HTTP headers to include on the forwarded request. This value must be + # specified as an object of key-value pairs. Example: + # `{"Content-Type": "application/xml", "X-API-Version": "v1" }` sig { returns(T.nilable(T.anything)) } def headers end @@ -38,6 +48,8 @@ module FinchAPI def headers=(_) end + # The query parameters for the forwarded request. This value must be specified as + # a valid JSON object rather than a query string. sig { returns(T.nilable(T.anything)) } def params end diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi index 2bce56b8..6ca5871c 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi @@ -3,6 +3,9 @@ module FinchAPI module Models class RequestForwardingForwardResponse < FinchAPI::BaseModel + # A string representation of the HTTP response body of the forwarded request’s + # response received from the underlying integration’s API. This field may be null + # in the case where the upstream system’s response is empty. sig { returns(T.nilable(String)) } def data end @@ -11,6 +14,8 @@ module FinchAPI def data=(_) end + # The HTTP headers of the forwarded request’s response, exactly as received from + # the underlying integration’s API. sig { returns(T.nilable(T.anything)) } def headers end @@ -19,6 +24,8 @@ module FinchAPI def headers=(_) end + # An object containing details of your original forwarded request, for your ease + # of reference. sig { returns(FinchAPI::Models::RequestForwardingForwardResponse::Request) } def request end @@ -30,6 +37,8 @@ module FinchAPI def request=(_) end + # The HTTP status code of the forwarded request’s response, exactly received from + # the underlying integration’s API. This value will be returned as an integer. sig { returns(Integer) } def status_code end @@ -65,6 +74,9 @@ module FinchAPI end class Request < FinchAPI::BaseModel + # The body that was specified for the forwarded request. If a value was not + # specified in the original request, this value will be returned as null ; + # otherwise, this value will always be returned as a string. sig { returns(T.nilable(String)) } def data end @@ -73,6 +85,8 @@ module FinchAPI def data=(_) end + # The specified HTTP headers that were included in the forwarded request. If no + # headers were specified, this will be returned as `null`. sig { returns(T.nilable(T.anything)) } def headers end @@ -81,6 +95,8 @@ module FinchAPI def headers=(_) end + # The HTTP method that was specified for the forwarded request. Valid values + # include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`. sig { returns(String) } def method_ end @@ -89,6 +105,8 @@ module FinchAPI def method_=(_) end + # The query parameters that were included in the forwarded request. If no query + # parameters were specified, this will be returned as `null`. sig { returns(T.nilable(T.anything)) } def params end @@ -97,6 +115,7 @@ module FinchAPI def params=(_) end + # The URL route path that was specified for the forwarded request. sig { returns(String) } def route end @@ -105,6 +124,8 @@ module FinchAPI def route=(_) end + # An object containing details of your original forwarded request, for your ease + # of reference. sig do params( data: T.nilable(String), diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index d2627782..d86ba728 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # An array of bank account objects associated with the payroll/HRIS system. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account])) } def accounts end @@ -18,6 +19,7 @@ module FinchAPI def accounts=(_) end + # The array of company departments. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)])) } def departments end @@ -29,6 +31,7 @@ module FinchAPI def departments=(_) end + # The employer identification number. sig { returns(T.nilable(String)) } def ein end @@ -37,6 +40,7 @@ module FinchAPI def ein=(_) end + # The entity type object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity)) } def entity end @@ -48,6 +52,7 @@ module FinchAPI def entity=(_) end + # The legal name of the company. sig { returns(T.nilable(String)) } def legal_name end @@ -67,6 +72,7 @@ module FinchAPI def locations=(_) end + # The email of the main administrator on the account. sig { returns(T.nilable(String)) } def primary_email end @@ -75,6 +81,7 @@ module FinchAPI def primary_email=(_) end + # The phone number of the main administrator on the account. Format: `XXXXXXXXXX` sig { returns(T.nilable(String)) } def primary_phone_number end @@ -130,6 +137,7 @@ module FinchAPI end class Account < FinchAPI::BaseModel + # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } def account_name end @@ -138,6 +146,7 @@ module FinchAPI def account_name=(_) end + # 10-12 digit number to specify the bank account sig { returns(T.nilable(String)) } def account_number end @@ -146,6 +155,7 @@ module FinchAPI def account_number=(_) end + # The type of bank account. sig { returns(T.nilable(Symbol)) } def account_type end @@ -154,6 +164,7 @@ module FinchAPI def account_type=(_) end + # Name of the banking institution. sig { returns(T.nilable(String)) } def institution_name end @@ -162,6 +173,8 @@ module FinchAPI def institution_name=(_) end + # A nine-digit code that's based on the U.S. Bank location where your account was + # opened. sig { returns(T.nilable(String)) } def routing_number end @@ -198,6 +211,7 @@ module FinchAPI def to_hash end + # The type of bank account. class AccountType < FinchAPI::Enum abstract! @@ -213,6 +227,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The department name. sig { returns(T.nilable(String)) } def name end @@ -221,6 +236,7 @@ module FinchAPI def name=(_) end + # The parent department, if present. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent)) } def parent end @@ -255,6 +271,7 @@ module FinchAPI end class Parent < FinchAPI::BaseModel + # The parent department's name. sig { returns(T.nilable(String)) } def name end @@ -263,6 +280,7 @@ module FinchAPI def name=(_) end + # The parent department, if present. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -274,6 +292,7 @@ module FinchAPI end class Entity < FinchAPI::BaseModel + # The tax payer subtype of the company. sig { returns(T.nilable(Symbol)) } def subtype end @@ -282,6 +301,7 @@ module FinchAPI def subtype=(_) end + # The tax payer type of the company. sig { returns(T.nilable(Symbol)) } def type end @@ -290,6 +310,7 @@ module FinchAPI def type=(_) end + # The entity type object. sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } def self.new(subtype: nil, type: nil) end @@ -298,6 +319,7 @@ module FinchAPI def to_hash end + # The tax payer subtype of the company. class Subtype < FinchAPI::Enum abstract! @@ -312,6 +334,7 @@ module FinchAPI end end + # The tax payer type of the company. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index 9b69794f..56a25f3d 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Sandbox class CompanyUpdateResponse < FinchAPI::BaseModel + # An array of bank account objects associated with the payroll/HRIS system. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account])) } def accounts end @@ -15,6 +16,7 @@ module FinchAPI def accounts=(_) end + # The array of company departments. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department)])) } def departments end @@ -26,6 +28,7 @@ module FinchAPI def departments=(_) end + # The employer identification number. sig { returns(T.nilable(String)) } def ein end @@ -34,6 +37,7 @@ module FinchAPI def ein=(_) end + # The entity type object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity)) } def entity end @@ -45,6 +49,7 @@ module FinchAPI def entity=(_) end + # The legal name of the company. sig { returns(T.nilable(String)) } def legal_name end @@ -64,6 +69,7 @@ module FinchAPI def locations=(_) end + # The email of the main administrator on the account. sig { returns(T.nilable(String)) } def primary_email end @@ -72,6 +78,7 @@ module FinchAPI def primary_email=(_) end + # The phone number of the main administrator on the account. Format: `XXXXXXXXXX` sig { returns(T.nilable(String)) } def primary_phone_number end @@ -115,6 +122,7 @@ module FinchAPI end class Account < FinchAPI::BaseModel + # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } def account_name end @@ -123,6 +131,7 @@ module FinchAPI def account_name=(_) end + # 10-12 digit number to specify the bank account sig { returns(T.nilable(String)) } def account_number end @@ -131,6 +140,7 @@ module FinchAPI def account_number=(_) end + # The type of bank account. sig { returns(T.nilable(Symbol)) } def account_type end @@ -139,6 +149,7 @@ module FinchAPI def account_type=(_) end + # Name of the banking institution. sig { returns(T.nilable(String)) } def institution_name end @@ -147,6 +158,8 @@ module FinchAPI def institution_name=(_) end + # A nine-digit code that's based on the U.S. Bank location where your account was + # opened. sig { returns(T.nilable(String)) } def routing_number end @@ -183,6 +196,7 @@ module FinchAPI def to_hash end + # The type of bank account. class AccountType < FinchAPI::Enum abstract! @@ -198,6 +212,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The department name. sig { returns(T.nilable(String)) } def name end @@ -206,6 +221,7 @@ module FinchAPI def name=(_) end + # The parent department, if present. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent)) } def parent end @@ -240,6 +256,7 @@ module FinchAPI end class Parent < FinchAPI::BaseModel + # The parent department's name. sig { returns(T.nilable(String)) } def name end @@ -248,6 +265,7 @@ module FinchAPI def name=(_) end + # The parent department, if present. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -259,6 +277,7 @@ module FinchAPI end class Entity < FinchAPI::BaseModel + # The tax payer subtype of the company. sig { returns(T.nilable(Symbol)) } def subtype end @@ -267,6 +286,7 @@ module FinchAPI def subtype=(_) end + # The tax payer type of the company. sig { returns(T.nilable(Symbol)) } def type end @@ -275,6 +295,7 @@ module FinchAPI def type=(_) end + # The entity type object. sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } def self.new(subtype: nil, type: nil) end @@ -283,6 +304,7 @@ module FinchAPI def to_hash end + # The tax payer subtype of the company. class Subtype < FinchAPI::Enum abstract! @@ -297,6 +319,7 @@ module FinchAPI end end + # The tax payer type of the company. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index a03664c8..9c54c06f 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The provider associated with the connection sig { returns(String) } def provider_id end @@ -23,6 +24,9 @@ module FinchAPI def authentication_type=(_) end + # Optional: the size of the employer to be created with this connection. Defaults + # to 20. Note that if this is higher than 100, historical payroll data will not be + # generated, and instead only one pay period will be created. sig { returns(T.nilable(Integer)) } def employee_size end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index 45946c5f..3e518f59 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -12,6 +12,7 @@ module FinchAPI def access_token=(_) end + # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } def account_id end @@ -28,6 +29,7 @@ module FinchAPI def authentication_type=(_) end + # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } def company_id end @@ -36,6 +38,7 @@ module FinchAPI def company_id=(_) end + # The ID of the new connection sig { returns(String) } def connection_id end @@ -52,6 +55,7 @@ module FinchAPI def products=(_) end + # The ID of the provider associated with the `access_token`. sig { returns(String) } def provider_id end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index 37cac0c3..b6c07650 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -16,6 +16,7 @@ module FinchAPI def company_id=(_) end + # The provider associated with the `access_token` sig { returns(String) } def provider_id end @@ -32,6 +33,8 @@ module FinchAPI def authentication_type=(_) end + # Optional, defaults to Organization products (`company`, `directory`, + # `employment`, `individual`) sig { returns(T.nilable(T::Array[String])) } def products end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index 43e2b4c0..163d6752 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -13,6 +13,7 @@ module FinchAPI def access_token=(_) end + # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } def account_id end @@ -29,6 +30,7 @@ module FinchAPI def authentication_type=(_) end + # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } def company_id end @@ -37,6 +39,7 @@ module FinchAPI def company_id=(_) end + # The ID of the new connection sig { returns(String) } def connection_id end @@ -53,6 +56,7 @@ module FinchAPI def products=(_) end + # The ID of the provider associated with the `access_token` sig { returns(String) } def provider_id end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index d3798128..a0c5ab71 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -5,6 +5,7 @@ module FinchAPI module Sandbox module Connections class AccountUpdateResponse < FinchAPI::BaseModel + # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } def account_id end @@ -21,6 +22,7 @@ module FinchAPI def authentication_type=(_) end + # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } def company_id end @@ -37,6 +39,7 @@ module FinchAPI def products=(_) end + # The ID of the provider associated with the `access_token` sig { returns(String) } def provider_id end @@ -45,6 +48,7 @@ module FinchAPI def provider_id=(_) end + # The ID of the new connection sig { returns(T.nilable(String)) } def connection_id end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index fd4b4097..ab5615e0 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -7,6 +7,8 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Array of individuals to create. Takes all combined fields from `/individual` and + # `/employment` endpoints. All fields are optional. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body])) } def body end @@ -41,6 +43,7 @@ module FinchAPI end class Body < FinchAPI::BaseModel + # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } def class_code end @@ -49,6 +52,9 @@ module FinchAPI def class_code=(_) end + # 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. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField])) } def custom_fields end @@ -60,6 +66,7 @@ module FinchAPI def custom_fields=(_) end + # The department object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department)) } def department end @@ -90,6 +97,7 @@ module FinchAPI def emails=(_) end + # The employment object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment)) } def employment end @@ -101,6 +109,7 @@ module FinchAPI def employment=(_) end + # The detailed employment status of the individual. sig { returns(T.nilable(Symbol)) } def employment_status end @@ -109,6 +118,9 @@ module FinchAPI def employment_status=(_) end + # Social Security Number of the individual in **encrypted** format. This field is + # only available with the `ssn` scope enabled and the + # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } def encrypted_ssn end @@ -125,6 +137,7 @@ module FinchAPI def end_date=(_) end + # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(Symbol)) } def ethnicity end @@ -133,6 +146,7 @@ module FinchAPI def ethnicity=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -141,6 +155,7 @@ module FinchAPI def first_name=(_) end + # The gender of the individual. sig { returns(T.nilable(Symbol)) } def gender end @@ -149,6 +164,9 @@ module FinchAPI def gender=(_) end + # The employee's income as reported by the provider. This may not always be + # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, + # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } def income end @@ -157,6 +175,7 @@ module FinchAPI def income=(_) end + # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } def income_history end @@ -168,6 +187,7 @@ module FinchAPI def income_history=(_) end + # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } def is_active end @@ -176,6 +196,7 @@ module FinchAPI def is_active=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -200,6 +221,7 @@ module FinchAPI def location=(_) end + # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager)) } def manager end @@ -211,6 +233,7 @@ module FinchAPI def manager=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -238,6 +261,7 @@ module FinchAPI def phone_numbers=(_) end + # The preferred name of the individual. sig { returns(T.nilable(String)) } def preferred_name end @@ -254,6 +278,7 @@ module FinchAPI def residence=(_) end + # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } def source_id end @@ -262,6 +287,10 @@ module FinchAPI def source_id=(_) end + # Social Security Number of the individual. This field is only available with the + # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the + # body. + # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } def ssn end @@ -278,6 +307,7 @@ module FinchAPI def start_date=(_) end + # The current title of the individual. sig { returns(T.nilable(String)) } def title end @@ -413,6 +443,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The name of the department associated with the individual. sig { returns(T.nilable(String)) } def name end @@ -421,6 +452,7 @@ module FinchAPI def name=(_) end + # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -470,6 +502,8 @@ module FinchAPI end class Employment < FinchAPI::BaseModel + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(Symbol)) } def subtype end @@ -478,6 +512,7 @@ module FinchAPI def subtype=(_) end + # The main employment type of the individual. sig { returns(T.nilable(Symbol)) } def type end @@ -486,6 +521,7 @@ module FinchAPI def type=(_) end + # The employment object. sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } def self.new(subtype: nil, type: nil) end @@ -494,6 +530,8 @@ module FinchAPI def to_hash end + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. class Subtype < FinchAPI::Enum abstract! @@ -511,6 +549,7 @@ module FinchAPI end end + # The main employment type of the individual. class Type < FinchAPI::Enum abstract! @@ -525,6 +564,7 @@ module FinchAPI end end + # The detailed employment status of the individual. class EmploymentStatus < FinchAPI::Enum abstract! @@ -543,6 +583,7 @@ module FinchAPI end end + # The EEOC-defined ethnicity of the individual. class Ethnicity < FinchAPI::Enum abstract! @@ -565,6 +606,7 @@ module FinchAPI end end + # The gender of the individual. class Gender < FinchAPI::Enum abstract! @@ -581,6 +623,7 @@ module FinchAPI end class Manager < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -589,6 +632,7 @@ module FinchAPI def id=(_) end + # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } def self.new(id: nil) end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index 19fe6272..c84f014d 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } def class_code end @@ -15,6 +16,9 @@ module FinchAPI def class_code=(_) end + # 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. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField])) } def custom_fields end @@ -26,6 +30,7 @@ module FinchAPI def custom_fields=(_) end + # The department object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department)) } def department end @@ -37,6 +42,7 @@ module FinchAPI def department=(_) end + # The employment object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment)) } def employment end @@ -48,6 +54,7 @@ module FinchAPI def employment=(_) end + # The detailed employment status of the individual. sig { returns(T.nilable(Symbol)) } def employment_status end @@ -64,6 +71,7 @@ module FinchAPI def end_date=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -72,6 +80,9 @@ module FinchAPI def first_name=(_) end + # The employee's income as reported by the provider. This may not always be + # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, + # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } def income end @@ -80,6 +91,7 @@ module FinchAPI def income=(_) end + # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } def income_history end @@ -91,6 +103,7 @@ module FinchAPI def income_history=(_) end + # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } def is_active end @@ -99,6 +112,7 @@ module FinchAPI def is_active=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -123,6 +137,7 @@ module FinchAPI def location=(_) end + # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager)) } def manager end @@ -134,6 +149,7 @@ module FinchAPI def manager=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -142,6 +158,7 @@ module FinchAPI def middle_name=(_) end + # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } def source_id end @@ -158,6 +175,7 @@ module FinchAPI def start_date=(_) end + # The current title of the individual. sig { returns(T.nilable(String)) } def title end @@ -269,6 +287,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The name of the department associated with the individual. sig { returns(T.nilable(String)) } def name end @@ -277,6 +296,7 @@ module FinchAPI def name=(_) end + # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -287,6 +307,8 @@ module FinchAPI end class Employment < FinchAPI::BaseModel + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(Symbol)) } def subtype end @@ -295,6 +317,7 @@ module FinchAPI def subtype=(_) end + # The main employment type of the individual. sig { returns(T.nilable(Symbol)) } def type end @@ -303,6 +326,7 @@ module FinchAPI def type=(_) end + # The employment object. sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } def self.new(subtype: nil, type: nil) end @@ -311,6 +335,8 @@ module FinchAPI def to_hash end + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. class Subtype < FinchAPI::Enum abstract! @@ -328,6 +354,7 @@ module FinchAPI end end + # The main employment type of the individual. class Type < FinchAPI::Enum abstract! @@ -342,6 +369,7 @@ module FinchAPI end end + # The detailed employment status of the individual. class EmploymentStatus < FinchAPI::Enum abstract! @@ -361,6 +389,7 @@ module FinchAPI end class Manager < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -369,6 +398,7 @@ module FinchAPI def id=(_) end + # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } def self.new(id: nil) end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 318003c9..9ed651be 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Sandbox class EmploymentUpdateResponse < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -12,6 +13,7 @@ module FinchAPI def id=(_) end + # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } def class_code end @@ -20,6 +22,9 @@ module FinchAPI def class_code=(_) end + # 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. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField])) } def custom_fields end @@ -31,6 +36,7 @@ module FinchAPI def custom_fields=(_) end + # The department object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department)) } def department end @@ -42,6 +48,7 @@ module FinchAPI def department=(_) end + # The employment object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment)) } def employment end @@ -53,6 +60,7 @@ module FinchAPI def employment=(_) end + # The detailed employment status of the individual. sig { returns(T.nilable(Symbol)) } def employment_status end @@ -69,6 +77,7 @@ module FinchAPI def end_date=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -77,6 +86,9 @@ module FinchAPI def first_name=(_) end + # The employee's income as reported by the provider. This may not always be + # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, + # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } def income end @@ -85,6 +97,7 @@ module FinchAPI def income=(_) end + # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } def income_history end @@ -96,6 +109,7 @@ module FinchAPI def income_history=(_) end + # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } def is_active end @@ -104,6 +118,7 @@ module FinchAPI def is_active=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -128,6 +143,7 @@ module FinchAPI def location=(_) end + # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager)) } def manager end @@ -139,6 +155,7 @@ module FinchAPI def manager=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -147,6 +164,7 @@ module FinchAPI def middle_name=(_) end + # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } def source_id end @@ -163,6 +181,7 @@ module FinchAPI def start_date=(_) end + # The current title of the individual. sig { returns(T.nilable(String)) } def title end @@ -274,6 +293,7 @@ module FinchAPI end class Department < FinchAPI::BaseModel + # The name of the department associated with the individual. sig { returns(T.nilable(String)) } def name end @@ -282,6 +302,7 @@ module FinchAPI def name=(_) end + # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } def self.new(name: nil) end @@ -292,6 +313,8 @@ module FinchAPI end class Employment < FinchAPI::BaseModel + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(Symbol)) } def subtype end @@ -300,6 +323,7 @@ module FinchAPI def subtype=(_) end + # The main employment type of the individual. sig { returns(T.nilable(Symbol)) } def type end @@ -308,6 +332,7 @@ module FinchAPI def type=(_) end + # The employment object. sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } def self.new(subtype: nil, type: nil) end @@ -316,6 +341,8 @@ module FinchAPI def to_hash end + # The secondary employment type of the individual. Options: `full_time`, + # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. class Subtype < FinchAPI::Enum abstract! @@ -333,6 +360,7 @@ module FinchAPI end end + # The main employment type of the individual. class Type < FinchAPI::Enum abstract! @@ -347,6 +375,7 @@ module FinchAPI end end + # The detailed employment status of the individual. class EmploymentStatus < FinchAPI::Enum abstract! @@ -366,6 +395,7 @@ module FinchAPI end class Manager < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -374,6 +404,7 @@ module FinchAPI def id=(_) end + # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } def self.new(id: nil) end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index 9784ddac..dda1d58f 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -26,6 +26,9 @@ module FinchAPI def emails=(_) end + # Social Security Number of the individual in **encrypted** format. This field is + # only available with the `ssn` scope enabled and the + # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } def encrypted_ssn end @@ -34,6 +37,7 @@ module FinchAPI def encrypted_ssn=(_) end + # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(Symbol)) } def ethnicity end @@ -42,6 +46,7 @@ module FinchAPI def ethnicity=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -50,6 +55,7 @@ module FinchAPI def first_name=(_) end + # The gender of the individual. sig { returns(T.nilable(Symbol)) } def gender end @@ -58,6 +64,7 @@ module FinchAPI def gender=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -66,6 +73,7 @@ module FinchAPI def last_name=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -85,6 +93,7 @@ module FinchAPI def phone_numbers=(_) end + # The preferred name of the individual. sig { returns(T.nilable(String)) } def preferred_name end @@ -101,6 +110,10 @@ module FinchAPI def residence=(_) end + # Social Security Number of the individual. This field is only available with the + # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the + # body. + # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } def ssn end @@ -206,6 +219,7 @@ module FinchAPI end end + # The EEOC-defined ethnicity of the individual. class Ethnicity < FinchAPI::Enum abstract! @@ -225,6 +239,7 @@ module FinchAPI end end + # The gender of the individual. class Gender < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index d46fb531..13364766 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Sandbox class IndividualUpdateResponse < FinchAPI::BaseModel + # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } def id end @@ -31,6 +32,9 @@ module FinchAPI def emails=(_) end + # Social Security Number of the individual in **encrypted** format. This field is + # only available with the `ssn` scope enabled and the + # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } def encrypted_ssn end @@ -39,6 +43,7 @@ module FinchAPI def encrypted_ssn=(_) end + # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(Symbol)) } def ethnicity end @@ -47,6 +52,7 @@ module FinchAPI def ethnicity=(_) end + # The legal first name of the individual. sig { returns(T.nilable(String)) } def first_name end @@ -55,6 +61,7 @@ module FinchAPI def first_name=(_) end + # The gender of the individual. sig { returns(T.nilable(Symbol)) } def gender end @@ -63,6 +70,7 @@ module FinchAPI def gender=(_) end + # The legal last name of the individual. sig { returns(T.nilable(String)) } def last_name end @@ -71,6 +79,7 @@ module FinchAPI def last_name=(_) end + # The legal middle name of the individual. sig { returns(T.nilable(String)) } def middle_name end @@ -92,6 +101,7 @@ module FinchAPI def phone_numbers=(_) end + # The preferred name of the individual. sig { returns(T.nilable(String)) } def preferred_name end @@ -108,6 +118,10 @@ module FinchAPI def residence=(_) end + # Social Security Number of the individual. This field is only available with the + # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the + # body. + # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } def ssn end @@ -213,6 +227,7 @@ module FinchAPI end end + # The EEOC-defined ethnicity of the individual. class Ethnicity < FinchAPI::Enum abstract! @@ -232,6 +247,7 @@ module FinchAPI end end + # The gender of the individual. class Gender < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index 66f566b5..ca0da56f 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -7,6 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters + # The type of job to start. Currently the only supported type is `data_sync_all` sig { returns(Symbol) } def type end @@ -26,6 +27,7 @@ module FinchAPI def to_hash end + # The type of job to start. Currently the only supported type is `data_sync_all` class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/sandbox/job_create_response.rbi b/rbi/lib/finch-api/models/sandbox/job_create_response.rbi index ee774705..2b504245 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Sandbox class JobCreateResponse < FinchAPI::BaseModel + # The number of allowed refreshes per hour (per hour, fixed window) sig { returns(Integer) } def allowed_refreshes end @@ -12,6 +13,7 @@ module FinchAPI def allowed_refreshes=(_) end + # The id of the job that has been created. sig { returns(String) } def job_id end @@ -20,6 +22,7 @@ module FinchAPI def job_id=(_) end + # The url that can be used to retrieve the job status sig { returns(String) } def job_url end @@ -28,6 +31,7 @@ module FinchAPI def job_url=(_) end + # The number of remaining refreshes available (per hour, fixed window) sig { returns(Integer) } def remaining_refreshes end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index 205e885e..80f89445 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -61,6 +61,7 @@ module FinchAPI end class PayStatement < FinchAPI::BaseModel + # The array of earnings objects associated with this pay statement sig do returns( T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)]) @@ -80,6 +81,7 @@ module FinchAPI def earnings=(_) end + # The array of deductions objects associated with this pay statement. sig do returns( T.nilable( @@ -138,6 +140,7 @@ module FinchAPI def gross_pay=(_) end + # A stable Finch `id` (UUID v4) for an individual in the company sig { returns(T.nilable(String)) } def individual_id end @@ -154,6 +157,7 @@ module FinchAPI def net_pay=(_) end + # The payment method. sig { returns(T.nilable(Symbol)) } def payment_method end @@ -162,6 +166,7 @@ module FinchAPI def payment_method=(_) end + # The array of taxes objects associated with this pay statement. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)])) } def taxes end @@ -175,6 +180,7 @@ module FinchAPI def taxes=(_) end + # The number of hours worked for this pay period sig { returns(T.nilable(Float)) } def total_hours end @@ -183,6 +189,7 @@ module FinchAPI def total_hours=(_) end + # The type of the payment associated with the pay statement. sig { returns(T.nilable(Symbol)) } def type end @@ -249,6 +256,7 @@ module FinchAPI end class Earning < FinchAPI::BaseModel + # The earnings amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -268,6 +276,7 @@ module FinchAPI def attributes=(_) end + # The earnings currency code. sig { returns(T.nilable(String)) } def currency end @@ -276,6 +285,8 @@ module FinchAPI def currency=(_) end + # The number of hours associated with this earning. (For salaried employees, this + # could be hours per pay period, `0` or `null`, depending on the provider). sig { returns(T.nilable(Float)) } def hours end @@ -284,6 +295,7 @@ module FinchAPI def hours=(_) end + # The exact name of the deduction from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -292,6 +304,7 @@ module FinchAPI def name=(_) end + # The type of earning. sig { returns(T.nilable(Symbol)) } def type end @@ -365,6 +378,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -383,6 +399,7 @@ module FinchAPI end end + # The type of earning. class Type < FinchAPI::Enum abstract! @@ -409,6 +426,7 @@ module FinchAPI end class EmployeeDeduction < FinchAPI::BaseModel + # The deduction amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -436,6 +454,7 @@ module FinchAPI def attributes=(_) end + # The deduction currency. sig { returns(T.nilable(String)) } def currency end @@ -444,6 +463,7 @@ module FinchAPI def currency=(_) end + # The deduction name from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -452,6 +472,7 @@ module FinchAPI def name=(_) end + # Boolean indicating if the deduction is pre-tax. sig { returns(T.nilable(T::Boolean)) } def pre_tax end @@ -460,6 +481,7 @@ module FinchAPI def pre_tax=(_) end + # Type of benefit. sig { returns(T.nilable(Symbol)) } def type end @@ -541,6 +563,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -561,6 +586,7 @@ module FinchAPI end class EmployerContribution < FinchAPI::BaseModel + # The contribution amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -588,6 +614,7 @@ module FinchAPI def attributes=(_) end + # The contribution currency. sig { returns(T.nilable(String)) } def currency end @@ -596,6 +623,7 @@ module FinchAPI def currency=(_) end + # The contribution name from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -604,6 +632,7 @@ module FinchAPI def name=(_) end + # Type of benefit. sig { returns(T.nilable(Symbol)) } def type end @@ -683,6 +712,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -702,6 +734,7 @@ module FinchAPI end end + # The payment method. class PaymentMethod < FinchAPI::Enum abstract! @@ -716,6 +749,7 @@ module FinchAPI end class Tax < FinchAPI::BaseModel + # The tax amount in cents. sig { returns(T.nilable(Integer)) } def amount end @@ -735,6 +769,7 @@ module FinchAPI def attributes=(_) end + # The currency code. sig { returns(T.nilable(String)) } def currency end @@ -743,6 +778,7 @@ module FinchAPI def currency=(_) end + # `true` if the amount is paid by the employers. sig { returns(T.nilable(T::Boolean)) } def employer end @@ -751,6 +787,7 @@ module FinchAPI def employer=(_) end + # The exact name of tax from the pay statement. sig { returns(T.nilable(String)) } def name end @@ -759,6 +796,7 @@ module FinchAPI def name=(_) end + # The type of taxes. sig { returns(T.nilable(Symbol)) } def type end @@ -830,6 +868,9 @@ module FinchAPI end class Metadata < FinchAPI::BaseModel + # The metadata to be attached to the entity by existing rules. It is a key-value + # pairs where the values can be of any type (string, number, boolean, object, + # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def metadata end @@ -848,6 +889,7 @@ module FinchAPI end end + # The type of taxes. class Type < FinchAPI::Enum abstract! @@ -864,6 +906,7 @@ module FinchAPI end end + # The type of the payment associated with the pay statement. class Type < FinchAPI::Enum abstract! diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi index 36cb3cc9..f591b997 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi @@ -4,6 +4,7 @@ module FinchAPI module Models module Sandbox class PaymentCreateResponse < FinchAPI::BaseModel + # The date of the payment. sig { returns(String) } def pay_date end @@ -12,6 +13,7 @@ module FinchAPI def pay_date=(_) end + # The ID of the payment. sig { returns(String) } def payment_id end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index c325459e..35292731 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -6,6 +6,7 @@ module FinchAPI abstract! class << self + # @api private sig do override .returns( diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index 5f90cab1..622bfc11 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -7,14 +7,17 @@ module FinchAPI end class << self + # @api private sig { params(url: URI::Generic).returns(Net::HTTP) } def connect(url) end + # @api private sig { params(conn: Net::HTTP, deadline: Float).void } def calibrate_socket_timeout(conn, deadline) end + # @api private sig do params(request: FinchAPI::PooledNetRequester::RequestShape, blk: T.proc.params(arg0: String).void) .returns(Net::HTTPGenericRequest) @@ -23,10 +26,12 @@ module FinchAPI end end + # @api private sig { params(url: URI::Generic, blk: T.proc.params(arg0: Net::HTTP).void).void } private def with_pool(url, &blk) end + # @api private sig do params(request: FinchAPI::PooledNetRequester::RequestShape) .returns([Net::HTTPResponse, T::Enumerable[String]]) @@ -34,6 +39,7 @@ module FinchAPI def execute(request) end + # @api private sig { params(size: Integer).returns(T.attached_class) } def self.new(size: Etc.nprocessors) end diff --git a/rbi/lib/finch-api/request_options.rbi b/rbi/lib/finch-api/request_options.rbi index 8d9d8be5..601763da 100644 --- a/rbi/lib/finch-api/request_options.rbi +++ b/rbi/lib/finch-api/request_options.rbi @@ -1,9 +1,11 @@ # typed: strong module FinchAPI + # @api private module RequestParameters abstract! + # Options to specify HTTP behaviour for this request. sig { returns(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) } def request_options end @@ -15,18 +17,28 @@ module FinchAPI def request_options=(_) end + # @api private module Converter + # @api private sig { params(params: T.anything).returns([T.anything, T::Hash[Symbol, T.anything]]) } def dump_request(params) end end end + # Specify HTTP behaviour to use for a specific request. These options supplement + # or override those provided at the client level. + # + # When making a request, you can pass an actual {RequestOptions} instance, or + # simply pass a Hash with symbol keys matching the attributes on this class. class RequestOptions < FinchAPI::BaseModel + # @api private sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void } def self.validate!(opts) end + # Idempotency key to send with request and all associated retries. Will only be + # sent for write requests. sig { returns(T.nilable(String)) } def idempotency_key end @@ -35,6 +47,8 @@ module FinchAPI def idempotency_key=(_) end + # Extra query params to send with the request. These are `.merge`’d into any + # `query` given at the client level. sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) } def extra_query end @@ -46,6 +60,8 @@ module FinchAPI def extra_query=(_) end + # Extra headers to send with the request. These are `.merged`’d into any + # `extra_headers` given at the client level. sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) } def extra_headers end @@ -57,6 +73,8 @@ module FinchAPI def extra_headers=(_) end + # Extra data to send with the request. These are deep merged into any data + # generated as part of the normal request. sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } def extra_body end @@ -65,6 +83,7 @@ module FinchAPI def extra_body=(_) end + # Maximum number of retries to attempt after a failed initial request. sig { returns(T.nilable(Integer)) } def max_retries end @@ -73,6 +92,7 @@ module FinchAPI def max_retries=(_) end + # Request timeout in seconds. sig { returns(T.nilable(Float)) } def timeout end @@ -81,6 +101,7 @@ module FinchAPI def timeout=(_) end + # Returns a new instance of RequestOptions. sig { params(values: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(values = {}) end diff --git a/rbi/lib/finch-api/resources/access_tokens.rbi b/rbi/lib/finch-api/resources/access_tokens.rbi index aab817aa..8d154b5b 100644 --- a/rbi/lib/finch-api/resources/access_tokens.rbi +++ b/rbi/lib/finch-api/resources/access_tokens.rbi @@ -3,6 +3,7 @@ module FinchAPI module Resources class AccessTokens + # Exchange the authorization code for an access token sig do params( code: String, diff --git a/rbi/lib/finch-api/resources/account.rbi b/rbi/lib/finch-api/resources/account.rbi index 102bdc47..501f7043 100644 --- a/rbi/lib/finch-api/resources/account.rbi +++ b/rbi/lib/finch-api/resources/account.rbi @@ -3,6 +3,7 @@ module FinchAPI module Resources class Account + # Disconnect one or more `access_token`s from your application. sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) .returns(FinchAPI::Models::DisconnectResponse) @@ -10,6 +11,7 @@ module FinchAPI def disconnect(request_options: {}) end + # Read account information associated with an `access_token` sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) .returns(FinchAPI::Models::Introspection) diff --git a/rbi/lib/finch-api/resources/connect/sessions.rbi b/rbi/lib/finch-api/resources/connect/sessions.rbi index c64f9418..e493cdf7 100644 --- a/rbi/lib/finch-api/resources/connect/sessions.rbi +++ b/rbi/lib/finch-api/resources/connect/sessions.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class Connect class Sessions + # Create a new connect session for an employer sig do params( customer_id: String, @@ -33,6 +34,7 @@ module FinchAPI ) end + # Create a new Connect session for reauthenticating an existing connection sig do params( connection_id: String, diff --git a/rbi/lib/finch-api/resources/hris/benefits.rbi b/rbi/lib/finch-api/resources/hris/benefits.rbi index 45323dee..bff069a3 100644 --- a/rbi/lib/finch-api/resources/hris/benefits.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits.rbi @@ -8,6 +8,8 @@ module FinchAPI def individuals end + # Creates a new company-wide deduction or contribution. Please use the + # `/providers` endpoint to view available types for each provider. sig do params( description: String, @@ -20,6 +22,7 @@ module FinchAPI def create(description: nil, frequency: nil, type: nil, request_options: {}) end + # Lists deductions and contributions information for a given item sig do params( benefit_id: String, @@ -30,6 +33,7 @@ module FinchAPI def retrieve(benefit_id, request_options: {}) end + # Updates an existing company-wide deduction or contribution sig do params( benefit_id: String, @@ -41,6 +45,7 @@ module FinchAPI def update(benefit_id, description: nil, request_options: {}) end + # List all company-wide deductions and contributions. sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit]) @@ -48,6 +53,7 @@ module FinchAPI def list(request_options: {}) end + # Get deductions metadata sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit]) diff --git a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi index 68d08dd5..0b0d5972 100644 --- a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi @@ -5,6 +5,10 @@ module FinchAPI class HRIS class Benefits class Individuals + # Enroll an individual into a deduction or contribution. This is an overwrite + # operation. If the employee is already enrolled, the enrollment amounts will be + # adjusted. Making the same request multiple times will not create new + # enrollments, but will continue to set the state of the existing enrollment. sig do params( benefit_id: String, @@ -16,6 +20,7 @@ module FinchAPI def enroll_many(benefit_id, individuals: nil, request_options: {}) end + # Lists individuals currently enrolled in a given deduction. sig do params( benefit_id: String, @@ -26,6 +31,7 @@ module FinchAPI def enrolled_ids(benefit_id, request_options: {}) end + # Get enrollment information for the given individuals. sig do params( benefit_id: String, @@ -37,6 +43,7 @@ module FinchAPI def retrieve_many_benefits(benefit_id, individual_ids: nil, request_options: {}) end + # Unenroll individuals from a deduction or contribution sig do params( benefit_id: String, diff --git a/rbi/lib/finch-api/resources/hris/company.rbi b/rbi/lib/finch-api/resources/hris/company.rbi index 48172364..f8e81ef2 100644 --- a/rbi/lib/finch-api/resources/hris/company.rbi +++ b/rbi/lib/finch-api/resources/hris/company.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class HRIS class Company + # Read basic company data sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) .returns(FinchAPI::Models::HRIS::HRISCompany) diff --git a/rbi/lib/finch-api/resources/hris/directory.rbi b/rbi/lib/finch-api/resources/hris/directory.rbi index f442315c..fe731bd0 100644 --- a/rbi/lib/finch-api/resources/hris/directory.rbi +++ b/rbi/lib/finch-api/resources/hris/directory.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class HRIS class Directory + # Read company directory and organization structure sig do params( limit: Integer, @@ -15,6 +16,7 @@ module FinchAPI def list(limit: nil, offset: nil, request_options: {}) end + # Read company directory and organization structure alias_method :list_individuals, :list sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/hris/documents.rbi b/rbi/lib/finch-api/resources/hris/documents.rbi index 1f807e4f..8dca715c 100644 --- a/rbi/lib/finch-api/resources/hris/documents.rbi +++ b/rbi/lib/finch-api/resources/hris/documents.rbi @@ -4,6 +4,8 @@ module FinchAPI module Resources class HRIS class Documents + # **Beta:** This endpoint is in beta and may change. + # Retrieve a list of company-wide documents. sig do params( individual_ids: T::Array[String], @@ -17,6 +19,8 @@ module FinchAPI def list(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) end + # **Beta:** This endpoint is in beta and may change. + # Retrieve details of a specific document by its ID. sig do params( document_id: String, diff --git a/rbi/lib/finch-api/resources/hris/employments.rbi b/rbi/lib/finch-api/resources/hris/employments.rbi index 1d6dd04d..b99511e7 100644 --- a/rbi/lib/finch-api/resources/hris/employments.rbi +++ b/rbi/lib/finch-api/resources/hris/employments.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class HRIS class Employments + # Read individual employment and income data sig do params( requests: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], diff --git a/rbi/lib/finch-api/resources/hris/individuals.rbi b/rbi/lib/finch-api/resources/hris/individuals.rbi index 156041f6..96b38afd 100644 --- a/rbi/lib/finch-api/resources/hris/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/individuals.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class HRIS class Individuals + # Read individual data, excluding income and employment data sig do params( options: T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options), diff --git a/rbi/lib/finch-api/resources/hris/pay_statements.rbi b/rbi/lib/finch-api/resources/hris/pay_statements.rbi index 2383e1a5..b7fc37ec 100644 --- a/rbi/lib/finch-api/resources/hris/pay_statements.rbi +++ b/rbi/lib/finch-api/resources/hris/pay_statements.rbi @@ -4,6 +4,10 @@ module FinchAPI module Resources class HRIS class PayStatements + # Read detailed pay statements for each individual. + # + # Deduction and contribution types are supported by the payroll systems that + # supports Benefits. sig do params( requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], diff --git a/rbi/lib/finch-api/resources/hris/payments.rbi b/rbi/lib/finch-api/resources/hris/payments.rbi index 5652b236..2c16fc05 100644 --- a/rbi/lib/finch-api/resources/hris/payments.rbi +++ b/rbi/lib/finch-api/resources/hris/payments.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class HRIS class Payments + # Read payroll and contractor related payments by the company. sig do params( end_date: Date, diff --git a/rbi/lib/finch-api/resources/jobs/automated.rbi b/rbi/lib/finch-api/resources/jobs/automated.rbi index 58d66ba3..9f54a741 100644 --- a/rbi/lib/finch-api/resources/jobs/automated.rbi +++ b/rbi/lib/finch-api/resources/jobs/automated.rbi @@ -4,6 +4,20 @@ module FinchAPI module Resources class Jobs class Automated + # Enqueue an automated job. + # + # `data_sync_all`: Enqueue a job to re-sync all data for a connection. + # `data_sync_all` has a concurrency limit of 1 job at a time per connection. This + # means that if this endpoint is called while a job is already in progress for + # this connection, Finch will return the `job_id` of the job that is currently in + # progress. Finch allows a fixed window rate limit of 1 forced refresh per hour + # per connection. + # + # `w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular + # individual, identified by `individual_id`. This feature is currently in beta. + # + # This endpoint is available for _Scale_ tier customers as an add-on. To request + # access to this endpoint, please contact your Finch account manager. sig do params( type: Symbol, @@ -15,6 +29,7 @@ module FinchAPI def create(type:, params:, request_options: {}) end + # Get an automated job by `job_id`. sig do params( job_id: String, @@ -25,6 +40,9 @@ module FinchAPI def retrieve(job_id, request_options: {}) end + # Get all automated jobs. Automated jobs are completed by a machine. By default, + # jobs are sorted in descending order by submission time. For scheduled jobs such + # as data syncs, only the next scheduled job is shown. sig do params( limit: Integer, diff --git a/rbi/lib/finch-api/resources/jobs/manual.rbi b/rbi/lib/finch-api/resources/jobs/manual.rbi index 9ed53f9c..2c65d526 100644 --- a/rbi/lib/finch-api/resources/jobs/manual.rbi +++ b/rbi/lib/finch-api/resources/jobs/manual.rbi @@ -4,6 +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. sig do params( job_id: String, diff --git a/rbi/lib/finch-api/resources/payroll/pay_groups.rbi b/rbi/lib/finch-api/resources/payroll/pay_groups.rbi index edf16ebc..ecd6e80c 100644 --- a/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +++ b/rbi/lib/finch-api/resources/payroll/pay_groups.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class Payroll class PayGroups + # Read information from a single pay group sig do params( pay_group_id: String, @@ -14,6 +15,7 @@ module FinchAPI def retrieve(pay_group_id, request_options: {}) end + # Read company pay groups and frequencies sig do params( individual_id: String, diff --git a/rbi/lib/finch-api/resources/providers.rbi b/rbi/lib/finch-api/resources/providers.rbi index 71cad80d..c2333724 100644 --- a/rbi/lib/finch-api/resources/providers.rbi +++ b/rbi/lib/finch-api/resources/providers.rbi @@ -3,6 +3,7 @@ module FinchAPI module Resources class Providers + # Return details on all available payroll and HR systems. sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) .returns(FinchAPI::SinglePage[FinchAPI::Models::Provider]) diff --git a/rbi/lib/finch-api/resources/request_forwarding.rbi b/rbi/lib/finch-api/resources/request_forwarding.rbi index e842f8e7..f8b4f69b 100644 --- a/rbi/lib/finch-api/resources/request_forwarding.rbi +++ b/rbi/lib/finch-api/resources/request_forwarding.rbi @@ -3,6 +3,10 @@ module FinchAPI module Resources class RequestForwarding + # The Forward API allows you to make direct requests to an employment system. If + # Finch’s unified API doesn’t have a data model that cleanly fits your needs, then + # Forward allows you to push or pull data models directly against an integration’s + # API. sig do params( method_: String, diff --git a/rbi/lib/finch-api/resources/sandbox/company.rbi b/rbi/lib/finch-api/resources/sandbox/company.rbi index 6225cc28..a7d77abf 100644 --- a/rbi/lib/finch-api/resources/sandbox/company.rbi +++ b/rbi/lib/finch-api/resources/sandbox/company.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class Sandbox class Company + # Update a sandbox company's data sig do params( accounts: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]), diff --git a/rbi/lib/finch-api/resources/sandbox/connections.rbi b/rbi/lib/finch-api/resources/sandbox/connections.rbi index ad284bcd..73bc3b5e 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections.rbi @@ -8,6 +8,7 @@ module FinchAPI def accounts end + # Create a new connection (new company/provider pair) with a new account sig do params( provider_id: String, diff --git a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi index c43d4368..8f57c697 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi @@ -5,6 +5,7 @@ module FinchAPI class Sandbox class Connections class Accounts + # Create a new account for an existing connection (company/provider pair) sig do params( company_id: String, @@ -18,6 +19,8 @@ module FinchAPI def create(company_id:, provider_id:, authentication_type: nil, products: nil, request_options: {}) end + # Update an existing sandbox account. Change the connection status to understand + # how the Finch API responds. sig do params( connection_status: Symbol, diff --git a/rbi/lib/finch-api/resources/sandbox/directory.rbi b/rbi/lib/finch-api/resources/sandbox/directory.rbi index 69be3b59..e758bc3d 100644 --- a/rbi/lib/finch-api/resources/sandbox/directory.rbi +++ b/rbi/lib/finch-api/resources/sandbox/directory.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class Sandbox class Directory + # Add new individuals to a sandbox company sig do params( body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], diff --git a/rbi/lib/finch-api/resources/sandbox/employment.rbi b/rbi/lib/finch-api/resources/sandbox/employment.rbi index 0a2a7901..0415dcac 100644 --- a/rbi/lib/finch-api/resources/sandbox/employment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/employment.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class Sandbox class Employment + # Update sandbox employment sig do params( individual_id: String, diff --git a/rbi/lib/finch-api/resources/sandbox/individual.rbi b/rbi/lib/finch-api/resources/sandbox/individual.rbi index ed859405..0ae47538 100644 --- a/rbi/lib/finch-api/resources/sandbox/individual.rbi +++ b/rbi/lib/finch-api/resources/sandbox/individual.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class Sandbox class Individual + # Update sandbox individual sig do params( individual_id: String, diff --git a/rbi/lib/finch-api/resources/sandbox/jobs.rbi b/rbi/lib/finch-api/resources/sandbox/jobs.rbi index 0fa85d95..daccd9bc 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs.rbi @@ -8,6 +8,7 @@ module FinchAPI def configuration end + # Enqueue a new sandbox job sig do params( type: Symbol, diff --git a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi index 946788e7..1e27f7dd 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi @@ -5,6 +5,7 @@ module FinchAPI class Sandbox class Jobs class Configuration + # Get configurations for sandbox jobs sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) .returns(FinchAPI::Models::Sandbox::Jobs::ConfigurationRetrieveResponse) @@ -12,6 +13,7 @@ module FinchAPI def retrieve(request_options: {}) end + # Update configurations for sandbox jobs sig do params( completion_status: Symbol, diff --git a/rbi/lib/finch-api/resources/sandbox/payment.rbi b/rbi/lib/finch-api/resources/sandbox/payment.rbi index d4f7c2d0..28b80658 100644 --- a/rbi/lib/finch-api/resources/sandbox/payment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/payment.rbi @@ -4,6 +4,7 @@ module FinchAPI module Resources class Sandbox class Payment + # Add a new sandbox payment sig do params( end_date: String, diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 4e48c0bc..7c7534a4 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -1,42 +1,52 @@ # typed: strong module FinchAPI + # @api private module Util + # @api private sig { returns(Float) } def self.monotonic_secs end class << self + # @api private sig { returns(String) } def arch end + # @api private sig { returns(String) } def os end end class << self + # @api private sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) } def primitive?(input) end + # @api private sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) } def coerce_boolean(input) end + # @api private sig { params(input: T.anything).returns(T.nilable(T::Boolean)) } def coerce_boolean!(input) end + # @api private sig { params(input: T.anything).returns(T.any(Integer, T.anything)) } def coerce_integer(input) end + # @api private sig { params(input: T.anything).returns(T.any(Float, T.anything)) } def coerce_float(input) end + # @api private sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) } def coerce_hash(input) end @@ -45,10 +55,15 @@ module FinchAPI OMIT = T.let(T.anything, T.anything) class << self + # @api private sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) } private def deep_merge_lr(lhs, rhs, concat: false) end + # @api private + # + # Recursively merge one hash with another. If the values at a given key are not + # both hashes, just take the new value. sig do params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean) .returns(T.anything) @@ -56,6 +71,7 @@ module FinchAPI def deep_merge(*values, sentinel: nil, concat: false) end + # @api private sig do params( data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything), @@ -70,20 +86,24 @@ module FinchAPI end class << self + # @api private sig { params(uri: URI::Generic).returns(String) } def uri_origin(uri) end + # @api private sig { params(path: T.any(String, T::Array[String])).returns(String) } def interpolate_path(path) end end class << self + # @api private sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) } def decode_query(query) end + # @api private sig do params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) .returns(T.nilable(String)) @@ -103,14 +123,17 @@ module FinchAPI end class << self + # @api private sig { params(url: T.any(URI::Generic, String)).returns(FinchAPI::Util::ParsedUriShape) } def parse_uri(url) end + # @api private sig { params(parsed: FinchAPI::Util::ParsedUriShape).returns(URI::Generic) } def unparse_uri(parsed) end + # @api private sig do params(lhs: FinchAPI::Util::ParsedUriShape, rhs: FinchAPI::Util::ParsedUriShape).returns(URI::Generic) end @@ -119,6 +142,7 @@ module FinchAPI end class << self + # @api private sig do params( headers: T::Hash[String, @@ -130,15 +154,19 @@ module FinchAPI end end + # An adapter that satisfies the IO interface required by `::IO.copy_stream` class ReadIOAdapter + # @api private sig { params(max_len: T.nilable(Integer)).returns(String) } private def read_enum(max_len) end + # @api private sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) } def read(max_len = nil, out_string = nil) end + # @api private sig do params( stream: T.any(String, IO, StringIO, T::Enumerable[String]), @@ -157,20 +185,24 @@ module FinchAPI end class << self + # @api private sig do params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void end private def encode_multipart_formdata(y, boundary:, key:, val:) end + # @api private sig { params(body: T.anything).returns([String, T::Enumerable[String]]) } private def encode_multipart_streaming(body) end + # @api private sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) } def encode_content(headers, body) end + # @api private sig do params( headers: T.any(T::Hash[String, String], Net::HTTPHeader), @@ -184,6 +216,9 @@ module FinchAPI end class << self + # @api private + # + # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html sig do params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void) .returns(T::Enumerable[T.anything]) @@ -191,10 +226,12 @@ module FinchAPI def fused_enum(enum, external: false, &close) end + # @api private sig { params(enum: T.nilable(T::Enumerable[T.anything])).void } def close_fused!(enum) end + # @api private sig do params( enum: T.nilable(T::Enumerable[T.anything]), @@ -210,10 +247,14 @@ module FinchAPI end class << self + # @api private sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) } def decode_lines(enum) end + # @api private + # + # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream sig { params(lines: T::Enumerable[String]).returns(FinchAPI::Util::ServerSentEvent) } def decode_sse(lines) end diff --git a/sig/finch-api/base_client.rbs b/sig/finch-api/base_client.rbs index f6581c39..5e504932 100644 --- a/sig/finch-api/base_client.rbs +++ b/sig/finch-api/base_client.rbs @@ -43,7 +43,7 @@ module FinchAPI response_headers: ::Hash[String, String] ) -> FinchAPI::BaseClient::request_input - # @private + # @api private attr_accessor requester: top def initialize: ( diff --git a/test/finch-api/client_test.rb b/test/finch-api/client_test.rb index 4f8f5268..6ff63ce4 100644 --- a/test/finch-api/client_test.rb +++ b/test/finch-api/client_test.rb @@ -17,7 +17,6 @@ class MockResponse # @param code [Integer] # @param headers [Hash{String=>String}] - # def initialize(code, headers) @code = code @headers = {"content-type" => "application/json", **headers} @@ -26,7 +25,6 @@ def initialize(code, headers) # @param header [String] # # @return [String, nil] - # def [](header) @headers[header] end @@ -34,7 +32,6 @@ def [](header) # @param header [String] # # @return [Boolean] - # def key?(header) @headers.key?(header) end @@ -56,7 +53,6 @@ class MockRequester # @param response_code [Integer] # @param response_headers [Hash{String=>String}] # @param response_data [Object] - # def initialize(response_code, response_headers, response_data) @response_code = response_code @response_headers = response_headers @@ -65,7 +61,6 @@ def initialize(response_code, response_headers, response_data) end # @param req [Hash{Symbol=>Object}] - # def execute(req) # Deep copy the request because it is mutated on each retry. attempts.push(Marshal.load(Marshal.dump(req))) From a592cdf6fea4bab81c60e25ea1149a38b3e2ad75 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 14 Mar 2025 08:56:33 +0000 Subject: [PATCH 31/67] chore: ensure doc strings for rbi method arguments (#34) --- lib/finch-api/base_model.rb | 4 ++-- lib/finch-api/base_page.rb | 2 -- rbi/lib/finch-api/base_model.rbi | 1 + rbi/lib/finch-api/base_page.rbi | 1 - rbi/lib/finch-api/client.rbi | 4 ++++ .../finch-api/resources/connect/sessions.rbi | 7 ++++++ rbi/lib/finch-api/resources/hris/benefits.rbi | 18 +++++++++++++-- .../resources/hris/benefits/individuals.rbi | 22 ++++++++++++++++--- .../finch-api/resources/hris/directory.rbi | 8 ++++++- .../finch-api/resources/hris/documents.rbi | 20 +++++++++++++++-- .../finch-api/resources/hris/employments.rbi | 6 ++++- .../resources/hris/pay_statements.rbi | 6 ++++- rbi/lib/finch-api/resources/hris/payments.rbi | 10 ++++++++- .../finch-api/resources/jobs/automated.rbi | 15 +++++++++++-- .../resources/request_forwarding.rbi | 21 +++++++++++++++++- .../finch-api/resources/sandbox/company.rbi | 7 ++++++ .../resources/sandbox/connections.rbi | 4 ++++ .../sandbox/connections/accounts.rbi | 11 +++++++++- .../finch-api/resources/sandbox/directory.rbi | 7 +++++- .../resources/sandbox/employment.rbi | 18 +++++++++++++++ .../resources/sandbox/individual.rbi | 13 +++++++++++ rbi/lib/finch-api/resources/sandbox/jobs.rbi | 6 ++++- rbi/lib/finch-api/util.rbi | 8 ++++++- 23 files changed, 196 insertions(+), 23 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index b304958b..ec4961c0 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -870,8 +870,6 @@ def initialize(type_info, spec = {}) end end - # @api private - # # @abstract # # @example @@ -897,6 +895,8 @@ def known_fields @known_fields ||= (self < FinchAPI::BaseModel ? superclass.known_fields.dup : {}) end + # @api private + # # @return [Hash{Symbol=>Hash{Symbol=>Object}}] def fields known_fields.transform_values do |field| diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index 2bcd569e..cbcefd3a 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -1,8 +1,6 @@ # frozen_string_literal: true module FinchAPI - # @api private - # # @abstract # # @example diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 9232581a..5495f440 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -438,6 +438,7 @@ module FinchAPI def known_fields end + # @api private sig do returns( T::Hash[Symbol, diff --git a/rbi/lib/finch-api/base_page.rbi b/rbi/lib/finch-api/base_page.rbi index a4179591..85231cb2 100644 --- a/rbi/lib/finch-api/base_page.rbi +++ b/rbi/lib/finch-api/base_page.rbi @@ -1,7 +1,6 @@ # typed: strong module FinchAPI - # @api private module BasePage abstract! diff --git a/rbi/lib/finch-api/client.rbi b/rbi/lib/finch-api/client.rbi index 354a6a68..a62abb94 100644 --- a/rbi/lib/finch-api/client.rbi +++ b/rbi/lib/finch-api/client.rbi @@ -92,10 +92,14 @@ module FinchAPI .returns(T.attached_class) end def self.new( + # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"` base_url: nil, access_token: nil, + # Defaults to `ENV["FINCH_CLIENT_ID"]` client_id: ENV["FINCH_CLIENT_ID"], + # Defaults to `ENV["FINCH_CLIENT_SECRET"]` client_secret: ENV["FINCH_CLIENT_SECRET"], + # Max number of retries to attempt after a failed retryable request. max_retries: DEFAULT_MAX_RETRIES, timeout: DEFAULT_TIMEOUT_IN_SECONDS, initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY, diff --git a/rbi/lib/finch-api/resources/connect/sessions.rbi b/rbi/lib/finch-api/resources/connect/sessions.rbi index e493cdf7..2ebdb716 100644 --- a/rbi/lib/finch-api/resources/connect/sessions.rbi +++ b/rbi/lib/finch-api/resources/connect/sessions.rbi @@ -27,6 +27,8 @@ module FinchAPI customer_email: nil, integration: nil, manual: nil, + # The number of minutes until the session expires (defaults to 43,200, which is 30 + # days) minutes_to_expire: nil, redirect_uri: nil, sandbox: nil, @@ -46,9 +48,14 @@ module FinchAPI .returns(FinchAPI::Models::Connect::SessionReauthenticateResponse) end def reauthenticate( + # The ID of the existing connection to reauthenticate connection_id:, + # The number of minutes until the session expires (defaults to 43,200, which is 30 + # days) minutes_to_expire: nil, + # The products to request access to (optional for reauthentication) products: nil, + # The URI to redirect to after the Connect flow is completed redirect_uri: nil, request_options: {} ) diff --git a/rbi/lib/finch-api/resources/hris/benefits.rbi b/rbi/lib/finch-api/resources/hris/benefits.rbi index bff069a3..d8a3dbc4 100644 --- a/rbi/lib/finch-api/resources/hris/benefits.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits.rbi @@ -19,7 +19,16 @@ module FinchAPI ) .returns(FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse) end - def create(description: nil, frequency: nil, type: nil, request_options: {}) + def create( + # 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, + frequency: nil, + # Type of benefit. + type: nil, + request_options: {} + ) end # Lists deductions and contributions information for a given item @@ -42,7 +51,12 @@ module FinchAPI ) .returns(FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse) end - def update(benefit_id, description: nil, request_options: {}) + def update( + benefit_id, + # Updated name or description. + description: nil, + request_options: {} + ) end # List all company-wide deductions and contributions. diff --git a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi index 0b0d5972..0cd31c7d 100644 --- a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi @@ -17,7 +17,12 @@ module FinchAPI ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual]) end - def enroll_many(benefit_id, individuals: nil, request_options: {}) + def enroll_many( + benefit_id, + # Array of the individual_id to enroll and a configuration object. + individuals: nil, + request_options: {} + ) end # Lists individuals currently enrolled in a given deduction. @@ -40,7 +45,13 @@ module FinchAPI ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit]) end - def retrieve_many_benefits(benefit_id, individual_ids: nil, request_options: {}) + def retrieve_many_benefits( + benefit_id, + # comma-delimited list of stable Finch uuids for each individual. If empty, + # defaults to all individuals + individual_ids: nil, + request_options: {} + ) end # Unenroll individuals from a deduction or contribution @@ -52,7 +63,12 @@ module FinchAPI ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual]) end - def unenroll_many(benefit_id, individual_ids: nil, request_options: {}) + def unenroll_many( + benefit_id, + # Array of individual_ids to unenroll. + individual_ids: nil, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/hris/directory.rbi b/rbi/lib/finch-api/resources/hris/directory.rbi index fe731bd0..40a4c9d7 100644 --- a/rbi/lib/finch-api/resources/hris/directory.rbi +++ b/rbi/lib/finch-api/resources/hris/directory.rbi @@ -13,7 +13,13 @@ module FinchAPI ) .returns(FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory]) end - def list(limit: nil, offset: nil, request_options: {}) + def list( + # Number of employees to return (defaults to all) + limit: nil, + # Index to start from (defaults to 0) + offset: nil, + request_options: {} + ) end # Read company directory and organization structure diff --git a/rbi/lib/finch-api/resources/hris/documents.rbi b/rbi/lib/finch-api/resources/hris/documents.rbi index 8dca715c..297bfc2c 100644 --- a/rbi/lib/finch-api/resources/hris/documents.rbi +++ b/rbi/lib/finch-api/resources/hris/documents.rbi @@ -16,7 +16,19 @@ module FinchAPI ) .returns(FinchAPI::Models::HRIS::DocumentListResponse) end - def list(individual_ids: nil, limit: nil, offset: nil, types: nil, request_options: {}) + def list( + # Comma-delimited list of stable Finch uuids for each individual. If empty, + # defaults to all individuals + individual_ids: nil, + # Number of documents to return (defaults to all) + limit: nil, + # Index to start from (defaults to 0) + offset: nil, + # Comma-delimited list of document types to filter on. If empty, defaults to all + # types + types: nil, + request_options: {} + ) end # **Beta:** This endpoint is in beta and may change. @@ -28,7 +40,11 @@ module FinchAPI ) .returns(T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)) end - def retreive(document_id, request_options: {}) + def retreive( + # The unique identifier of the document. + document_id, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/hris/employments.rbi b/rbi/lib/finch-api/resources/hris/employments.rbi index b99511e7..2b264c28 100644 --- a/rbi/lib/finch-api/resources/hris/employments.rbi +++ b/rbi/lib/finch-api/resources/hris/employments.rbi @@ -12,7 +12,11 @@ module FinchAPI ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse]) end - def retrieve_many(requests:, request_options: {}) + def retrieve_many( + # The array of batch requests. + requests:, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/hris/pay_statements.rbi b/rbi/lib/finch-api/resources/hris/pay_statements.rbi index b7fc37ec..dbcd8fd6 100644 --- a/rbi/lib/finch-api/resources/hris/pay_statements.rbi +++ b/rbi/lib/finch-api/resources/hris/pay_statements.rbi @@ -15,7 +15,11 @@ module FinchAPI ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse]) end - def retrieve_many(requests:, request_options: {}) + def retrieve_many( + # The array of batch requests. + requests:, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/hris/payments.rbi b/rbi/lib/finch-api/resources/hris/payments.rbi index 2c16fc05..0bf750fd 100644 --- a/rbi/lib/finch-api/resources/hris/payments.rbi +++ b/rbi/lib/finch-api/resources/hris/payments.rbi @@ -13,7 +13,15 @@ module FinchAPI ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Payment]) end - def list(end_date:, start_date:, request_options: {}) + def list( + # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` + # format. + end_date:, + # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` + # format. + start_date:, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/jobs/automated.rbi b/rbi/lib/finch-api/resources/jobs/automated.rbi index 9f54a741..dd8d5cbb 100644 --- a/rbi/lib/finch-api/resources/jobs/automated.rbi +++ b/rbi/lib/finch-api/resources/jobs/automated.rbi @@ -26,7 +26,12 @@ module FinchAPI ) .returns(FinchAPI::Models::Jobs::AutomatedCreateResponse) end - def create(type:, params:, request_options: {}) + def create( + # The type of job to start. + type:, + params:, + request_options: {} + ) end # Get an automated job by `job_id`. @@ -51,7 +56,13 @@ module FinchAPI ) .returns(FinchAPI::Models::Jobs::AutomatedListResponse) end - def list(limit: nil, offset: nil, request_options: {}) + def list( + # Number of items to return + limit: nil, + # Index to start from (defaults to 0) + offset: nil, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/request_forwarding.rbi b/rbi/lib/finch-api/resources/request_forwarding.rbi index f8b4f69b..ee1ab755 100644 --- a/rbi/lib/finch-api/resources/request_forwarding.rbi +++ b/rbi/lib/finch-api/resources/request_forwarding.rbi @@ -18,7 +18,26 @@ module FinchAPI ) .returns(FinchAPI::Models::RequestForwardingForwardResponse) end - def forward(method_:, route:, data: nil, headers: nil, params: nil, request_options: {}) + def forward( + # The HTTP method for the forwarded request. Valid values include: `GET` , `POST` + # , `PUT` , `DELETE` , and `PATCH`. + method_:, + # The URL route path for the forwarded request. This value must begin with a + # forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and + # underscores. + route:, + # The body for the forwarded request. This value must be specified as either a + # string or a valid JSON object. + data: nil, + # The HTTP headers to include on the forwarded request. This value must be + # specified as an object of key-value pairs. Example: + # `{"Content-Type": "application/xml", "X-API-Version": "v1" }` + headers: nil, + # The query parameters for the forwarded request. This value must be specified as + # a valid JSON object rather than a query string. + params: nil, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/sandbox/company.rbi b/rbi/lib/finch-api/resources/sandbox/company.rbi index a7d77abf..3b19708a 100644 --- a/rbi/lib/finch-api/resources/sandbox/company.rbi +++ b/rbi/lib/finch-api/resources/sandbox/company.rbi @@ -20,13 +20,20 @@ module FinchAPI .returns(FinchAPI::Models::Sandbox::CompanyUpdateResponse) end def update( + # An array of bank account objects associated with the payroll/HRIS system. accounts:, + # The array of company departments. departments:, + # The employer identification number. ein:, + # The entity type object. entity:, + # The legal name of the company. legal_name:, locations:, + # The email of the main administrator on the account. primary_email:, + # The phone number of the main administrator on the account. Format: `XXXXXXXXXX` primary_phone_number:, request_options: {} ) diff --git a/rbi/lib/finch-api/resources/sandbox/connections.rbi b/rbi/lib/finch-api/resources/sandbox/connections.rbi index 73bc3b5e..50d44fb3 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections.rbi @@ -20,8 +20,12 @@ module FinchAPI .returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse) end def create( + # The provider associated with the connection provider_id:, authentication_type: nil, + # Optional: the size of the employer to be created with this connection. Defaults + # to 20. Note that if this is higher than 100, historical payroll data will not be + # generated, and instead only one pay period will be created. employee_size: nil, products: nil, request_options: {} diff --git a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi index 8f57c697..dd3b3bb5 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi @@ -16,7 +16,16 @@ module FinchAPI ) .returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse) end - def create(company_id:, provider_id:, authentication_type: nil, products: nil, request_options: {}) + def create( + company_id:, + # The provider associated with the `access_token` + provider_id:, + authentication_type: nil, + # Optional, defaults to Organization products (`company`, `directory`, + # `employment`, `individual`) + products: nil, + request_options: {} + ) end # Update an existing sandbox account. Change the connection status to understand diff --git a/rbi/lib/finch-api/resources/sandbox/directory.rbi b/rbi/lib/finch-api/resources/sandbox/directory.rbi index e758bc3d..080c750f 100644 --- a/rbi/lib/finch-api/resources/sandbox/directory.rbi +++ b/rbi/lib/finch-api/resources/sandbox/directory.rbi @@ -12,7 +12,12 @@ module FinchAPI ) .returns(FinchAPI::Models::Sandbox::DirectoryCreateResponse) end - def create(body: nil, request_options: {}) + def create( + # Array of individuals to create. Takes all combined fields from `/individual` and + # `/employment` endpoints. All fields are optional. + body: nil, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/sandbox/employment.rbi b/rbi/lib/finch-api/resources/sandbox/employment.rbi index 0415dcac..369aa1d6 100644 --- a/rbi/lib/finch-api/resources/sandbox/employment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/employment.rbi @@ -32,23 +32,41 @@ module FinchAPI end def update( individual_id, + # Worker's compensation classification code for this employee class_code: nil, + # 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. custom_fields: nil, + # The department object. department: nil, + # The employment object. employment: nil, + # The detailed employment status of the individual. employment_status: nil, end_date: nil, + # The legal first name of the individual. first_name: nil, + # The employee's income as reported by the provider. This may not always be + # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, + # depending on what information the provider returns. income: nil, + # The array of income history. income_history: nil, + # `true` if the individual an an active employee or contractor at the company. is_active: nil, + # The legal last name of the individual. last_name: nil, latest_rehire_date: nil, location: nil, + # The manager object representing the manager of the individual within the org. manager: nil, + # The legal middle name of the individual. middle_name: nil, + # The source system's unique employment identifier for this individual source_id: nil, start_date: nil, + # The current title of the individual. title: nil, request_options: {} ) diff --git a/rbi/lib/finch-api/resources/sandbox/individual.rbi b/rbi/lib/finch-api/resources/sandbox/individual.rbi index 0ae47538..85fe369a 100644 --- a/rbi/lib/finch-api/resources/sandbox/individual.rbi +++ b/rbi/lib/finch-api/resources/sandbox/individual.rbi @@ -28,15 +28,28 @@ module FinchAPI individual_id, dob: nil, emails: nil, + # Social Security Number of the individual in **encrypted** format. This field is + # only available with the `ssn` scope enabled and the + # `options: { include: ['ssn'] }` param set in the body. encrypted_ssn: nil, + # The EEOC-defined ethnicity of the individual. ethnicity: nil, + # The legal first name of the individual. first_name: nil, + # The gender of the individual. gender: nil, + # The legal last name of the individual. last_name: nil, + # The legal middle name of the individual. middle_name: nil, phone_numbers: nil, + # The preferred name of the individual. preferred_name: nil, residence: nil, + # Social Security Number of the individual. This field is only available with the + # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the + # body. + # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). ssn: nil, request_options: {} ) diff --git a/rbi/lib/finch-api/resources/sandbox/jobs.rbi b/rbi/lib/finch-api/resources/sandbox/jobs.rbi index daccd9bc..7a860120 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs.rbi @@ -16,7 +16,11 @@ module FinchAPI ) .returns(FinchAPI::Models::Sandbox::JobCreateResponse) end - def create(type:, request_options: {}) + def create( + # The type of job to start. Currently the only supported type is `data_sync_all` + type:, + request_options: {} + ) end sig { params(client: FinchAPI::Client).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 7c7534a4..4b22187a 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -68,7 +68,13 @@ module FinchAPI params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean) .returns(T.anything) end - def deep_merge(*values, sentinel: nil, concat: false) + def deep_merge( + *values, + # the value to return if no values are provided. + sentinel: nil, + # whether to merge sequences by concatenation. + concat: false + ) end # @api private From f17f349ca92249203baa08738ed0f6100c280f6c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 14 Mar 2025 09:01:00 +0000 Subject: [PATCH 32/67] chore: touch up sdk usage examples (#35) --- lib/finch-api/base_model.rb | 16 ++++++++-------- lib/finch-api/base_page.rb | 8 +++++++- lib/finch-api/individuals_page.rb | 8 +++++++- lib/finch-api/page.rb | 8 +++++++- lib/finch-api/responses_page.rb | 8 +++++++- lib/finch-api/single_page.rb | 8 +++++++- 6 files changed, 43 insertions(+), 13 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index ec4961c0..be3158ae 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -306,7 +306,7 @@ def try_strict_coerce(value) # when FinchAPI::Models::ConnectionStatusType::CONNECTED # # ... # else - # # ... + # puts(connection_status_type) # end # ``` # @@ -320,7 +320,7 @@ def try_strict_coerce(value) # in :connected # # ... # else - # # ... + # puts(connection_status_type) # end # ``` class Enum @@ -407,11 +407,11 @@ def try_strict_coerce(value) # # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse` # case document_retreive_response # when FinchAPI::Models::HRIS::W42020 - # # ... + # puts(document_retreive_response.data) # when FinchAPI::Models::HRIS::W42005 - # # ... + # puts(document_retreive_response.type) # else - # # ... + # puts(document_retreive_response) # end # ``` # @@ -419,11 +419,11 @@ def try_strict_coerce(value) # ```ruby # case document_retreive_response # in {type: :w4_2020, data: data, year: year} - # # ... + # puts(data) # in {type: :w4_2005, data: data, year: year} - # # ... + # puts(year) # else - # # ... + # puts(document_retreive_response) # end # ``` class Union diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index cbcefd3a..ccfd1aba 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -19,7 +19,13 @@ module FinchAPI # # @example # ```ruby - # access_tokens = page.to_enum.take(2) + # access_tokens = page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # # access_tokens => Array # ``` diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index fa282971..bc1227af 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -17,7 +17,13 @@ module FinchAPI # # @example # ```ruby - # directories = individuals_page.to_enum.take(2) + # directories = individuals_page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # # directories => Array # ``` diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index c03612f1..e36e01d7 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -17,7 +17,13 @@ module FinchAPI # # @example # ```ruby - # items = page.to_enum.take(2) + # items = page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # # items => Array # ``` diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index 771f4640..df6cb904 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -17,7 +17,13 @@ module FinchAPI # # @example # ```ruby - # individuals = responses_page.to_enum.take(2) + # individuals = responses_page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # # individuals => Array # ``` diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index 5dfebcd9..79fbb681 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -17,7 +17,13 @@ module FinchAPI # # @example # ```ruby - # payments = single_page.to_enum.take(2) + # payments = single_page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # # payments => Array # ``` From 99d43196e06882dfc973a70a2e5294cd5d2c28dc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 14 Mar 2025 09:07:58 +0000 Subject: [PATCH 33/67] chore: error fields are now mutable in keeping with rest of SDK (#36) --- lib/finch-api/errors.rb | 14 ++++++------- lib/finch-api/individuals_page.rb | 2 +- lib/finch-api/page.rb | 2 +- lib/finch-api/responses_page.rb | 2 +- rbi/lib/finch-api/errors.rbi | 28 ++++++++++++++++++++++++++ rbi/lib/finch-api/individuals_page.rbi | 4 ++-- rbi/lib/finch-api/page.rbi | 4 ++-- rbi/lib/finch-api/responses_page.rbi | 4 ++-- sig/finch-api/errors.rbs | 8 ++++---- sig/finch-api/individuals_page.rbs | 2 +- sig/finch-api/page.rbs | 2 +- sig/finch-api/responses_page.rbs | 2 +- 12 files changed, 51 insertions(+), 23 deletions(-) diff --git a/lib/finch-api/errors.rb b/lib/finch-api/errors.rb index 3cf58894..48e69e6f 100644 --- a/lib/finch-api/errors.rb +++ b/lib/finch-api/errors.rb @@ -4,7 +4,7 @@ module FinchAPI class Error < StandardError # @!parse # # @return [StandardError, nil] - # attr_reader :cause + # attr_accessor :cause end class ConversionError < FinchAPI::Error @@ -12,13 +12,13 @@ class ConversionError < FinchAPI::Error class APIError < FinchAPI::Error # @return [URI::Generic] - attr_reader :url + attr_accessor :url # @return [Integer, nil] - attr_reader :status + attr_accessor :status # @return [Object, nil] - attr_reader :body + attr_accessor :body # @api private # @@ -41,11 +41,11 @@ def initialize(url:, status: nil, body: nil, request: nil, response: nil, messag class APIConnectionError < FinchAPI::APIError # @!parse # # @return [nil] - # attr_reader :status + # attr_accessor :status # @!parse # # @return [nil] - # attr_reader :body + # attr_accessor :body # @api private # @@ -126,7 +126,7 @@ def self.for(url:, status:, body:, request:, response:, message: nil) # @!parse # # @return [Integer] - # attr_reader :status + # attr_accessor :status # @api private # diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index bc1227af..e6f45542 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -30,7 +30,7 @@ module FinchAPI class IndividualsPage include FinchAPI::BasePage - # @return [Array] + # @return [Array, nil] attr_accessor :individuals # @return [FinchAPI::Models::Paging] diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index e36e01d7..46df3fd5 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -30,7 +30,7 @@ module FinchAPI class Page include FinchAPI::BasePage - # @return [Array] + # @return [Array, nil] attr_accessor :data # @return [FinchAPI::Models::Paging] diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index df6cb904..c906c80a 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -30,7 +30,7 @@ module FinchAPI class ResponsesPage include FinchAPI::BasePage - # @return [Array] + # @return [Array, nil] attr_accessor :responses # @api private diff --git a/rbi/lib/finch-api/errors.rbi b/rbi/lib/finch-api/errors.rbi index 6d2fb306..a8c4129b 100644 --- a/rbi/lib/finch-api/errors.rbi +++ b/rbi/lib/finch-api/errors.rbi @@ -5,6 +5,10 @@ module FinchAPI sig { returns(T.nilable(StandardError)) } def cause end + + sig { params(_: T.nilable(StandardError)).returns(T.nilable(StandardError)) } + def cause=(_) + end end class ConversionError < FinchAPI::Error @@ -15,14 +19,26 @@ module FinchAPI def url end + sig { params(_: URI::Generic).returns(URI::Generic) } + def url=(_) + end + sig { returns(T.nilable(Integer)) } def status end + sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } + def status=(_) + end + sig { returns(T.nilable(T.anything)) } def body end + sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } + def body=(_) + end + # @api private sig do params( @@ -44,10 +60,18 @@ module FinchAPI def status end + sig { params(_: NilClass).void } + def status=(_) + end + sig { void } def body end + sig { params(_: NilClass).void } + def body=(_) + end + # @api private sig do params( @@ -101,6 +125,10 @@ module FinchAPI def status end + sig { params(_: Integer).returns(Integer) } + def status=(_) + end + # @api private sig do params( diff --git a/rbi/lib/finch-api/individuals_page.rbi b/rbi/lib/finch-api/individuals_page.rbi index be04110a..068258b8 100644 --- a/rbi/lib/finch-api/individuals_page.rbi +++ b/rbi/lib/finch-api/individuals_page.rbi @@ -6,11 +6,11 @@ module FinchAPI Elem = type_member - sig { returns(T::Array[Elem]) } + sig { returns(T.nilable(T::Array[Elem])) } def individuals end - sig { params(_: T::Array[Elem]).returns(T::Array[Elem]) } + sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) } def individuals=(_) end diff --git a/rbi/lib/finch-api/page.rbi b/rbi/lib/finch-api/page.rbi index 4edca1be..f1a99b06 100644 --- a/rbi/lib/finch-api/page.rbi +++ b/rbi/lib/finch-api/page.rbi @@ -6,11 +6,11 @@ module FinchAPI Elem = type_member - sig { returns(T::Array[Elem]) } + sig { returns(T.nilable(T::Array[Elem])) } def data end - sig { params(_: T::Array[Elem]).returns(T::Array[Elem]) } + sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) } def data=(_) end diff --git a/rbi/lib/finch-api/responses_page.rbi b/rbi/lib/finch-api/responses_page.rbi index 7fbdd9e0..28e76f9f 100644 --- a/rbi/lib/finch-api/responses_page.rbi +++ b/rbi/lib/finch-api/responses_page.rbi @@ -6,11 +6,11 @@ module FinchAPI Elem = type_member - sig { returns(T::Array[Elem]) } + sig { returns(T.nilable(T::Array[Elem])) } def responses end - sig { params(_: T::Array[Elem]).returns(T::Array[Elem]) } + sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) } def responses=(_) end end diff --git a/sig/finch-api/errors.rbs b/sig/finch-api/errors.rbs index 933a0b2d..0c5a195f 100644 --- a/sig/finch-api/errors.rbs +++ b/sig/finch-api/errors.rbs @@ -1,17 +1,17 @@ module FinchAPI class Error < StandardError - attr_reader cause: StandardError? + attr_accessor cause: StandardError? end class ConversionError < FinchAPI::Error end class APIError < FinchAPI::Error - attr_reader url: URI::Generic + attr_accessor url: URI::Generic - attr_reader status: Integer? + attr_accessor status: Integer? - attr_reader body: top? + attr_accessor body: top? def initialize: ( url: URI::Generic, diff --git a/sig/finch-api/individuals_page.rbs b/sig/finch-api/individuals_page.rbs index f969517f..9511ea73 100644 --- a/sig/finch-api/individuals_page.rbs +++ b/sig/finch-api/individuals_page.rbs @@ -2,7 +2,7 @@ module FinchAPI class IndividualsPage[Elem] include FinchAPI::BasePage[Elem] - attr_accessor individuals: ::Array[Elem] + attr_accessor individuals: ::Array[Elem]? attr_accessor paging: FinchAPI::Models::Paging end diff --git a/sig/finch-api/page.rbs b/sig/finch-api/page.rbs index a4bb2473..6f0d3d18 100644 --- a/sig/finch-api/page.rbs +++ b/sig/finch-api/page.rbs @@ -2,7 +2,7 @@ module FinchAPI class Page[Elem] include FinchAPI::BasePage[Elem] - attr_accessor data: ::Array[Elem] + attr_accessor data: ::Array[Elem]? attr_accessor paging: FinchAPI::Models::Paging end diff --git a/sig/finch-api/responses_page.rbs b/sig/finch-api/responses_page.rbs index b68444a4..9c7bf073 100644 --- a/sig/finch-api/responses_page.rbs +++ b/sig/finch-api/responses_page.rbs @@ -2,6 +2,6 @@ module FinchAPI class ResponsesPage[Elem] include FinchAPI::BasePage[Elem] - attr_accessor responses: ::Array[Elem] + attr_accessor responses: ::Array[Elem]? end end From 623ce8130371bb406cd138fb07757932a2522464 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 14 Mar 2025 09:09:52 +0000 Subject: [PATCH 34/67] chore: document union variants in yard doc (#37) --- lib/finch-api/base_model.rb | 13 +++++++++---- .../models/hris/document_retreive_response.rb | 6 ++++++ lib/finch-api/models/webhook_event.rb | 6 ++++++ lib/finch-api/single_page.rb | 2 +- rbi/lib/finch-api/base_model.rbi | 9 ++++++--- .../models/hris/document_retreive_response.rbi | 5 ++--- rbi/lib/finch-api/models/webhook_event.rbi | 5 ++--- sig/finch-api/base_model.rbs | 4 +++- .../models/hris/document_retreive_response.rbs | 2 +- sig/finch-api/models/webhook_event.rbs | 2 +- 10 files changed, 37 insertions(+), 17 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index be3158ae..4511a3aa 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -439,13 +439,18 @@ class << self # @api private # - # All of the specified variants for this union. - # # @return [Array] - protected def variants + protected def derefed_variants @known_variants.map { |key, variant_fn| [key, variant_fn.call] } end + # All of the specified variants for this union. + # + # @return [Array] + def variants + derefed_variants.map(&:last) + end + # @api private # # @param property [Symbol] @@ -525,7 +530,7 @@ def self.===(other) # # @return [Boolean] def self.==(other) - other.is_a?(Class) && other <= FinchAPI::Union && other.variants == variants + other.is_a?(Class) && other <= FinchAPI::Union && other.derefed_variants == derefed_variants end class << self diff --git a/lib/finch-api/models/hris/document_retreive_response.rb b/lib/finch-api/models/hris/document_retreive_response.rb index 40720f8d..b5d98436 100644 --- a/lib/finch-api/models/hris/document_retreive_response.rb +++ b/lib/finch-api/models/hris/document_retreive_response.rb @@ -15,6 +15,12 @@ class DocumentRetreiveResponse < FinchAPI::Union # A 2005 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details. variant :w4_2005, -> { FinchAPI::Models::HRIS::W42005 } + + # @!parse + # class << self + # # @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)] + # def variants; end + # end end end end diff --git a/lib/finch-api/models/webhook_event.rb b/lib/finch-api/models/webhook_event.rb index 2926dc34..aa3548a2 100644 --- a/lib/finch-api/models/webhook_event.rb +++ b/lib/finch-api/models/webhook_event.rb @@ -21,6 +21,12 @@ class WebhookEvent < FinchAPI::Union variant -> { FinchAPI::Models::PaymentEvent } variant -> { FinchAPI::Models::PayStatementEvent } + + # @!parse + # class << self + # # @return [Array(FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent)] + # def variants; end + # end end end end diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index 79fbb681..f9b5e5e4 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -42,7 +42,7 @@ def initialize(client:, req:, headers:, page_data:) case page_data in Array - replace(page_data&.map { model.coerce(_1) }) + replace(page_data.map { model.coerce(_1) }) else end end diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 5495f440..5de2dac6 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -223,10 +223,13 @@ module FinchAPI end # @api private - # + sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) } + protected def derefed_variants + end + # All of the specified variants for this union. - sig { overridable.returns(T::Array[[T.nilable(Symbol), T.anything]]) } - protected def variants + sig { overridable.returns(T::Array[T.anything]) } + def variants end # @api private diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index 43e83e17..267d4b82 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -9,9 +9,8 @@ module FinchAPI abstract! class << self - # @api private - sig { override.returns([[Symbol, FinchAPI::Models::HRIS::W42020], [Symbol, FinchAPI::Models::HRIS::W42005]]) } - private def variants + sig { override.returns([FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]) } + def variants end end end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index 35292731..0e230f35 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -6,14 +6,13 @@ module FinchAPI abstract! class << self - # @api private sig do override .returns( - [[Symbol, FinchAPI::Models::AccountUpdateEvent], [Symbol, FinchAPI::Models::CompanyEvent], [NilClass, FinchAPI::Models::JobCompletionEvent], [NilClass, FinchAPI::Models::DirectoryEvent], [NilClass, FinchAPI::Models::EmploymentEvent], [NilClass, FinchAPI::Models::IndividualEvent], [NilClass, FinchAPI::Models::PaymentEvent], [NilClass, FinchAPI::Models::PayStatementEvent]] + [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] ) end - private def variants + def variants end end end diff --git a/sig/finch-api/base_model.rbs b/sig/finch-api/base_model.rbs index a535259c..f3009549 100644 --- a/sig/finch-api/base_model.rbs +++ b/sig/finch-api/base_model.rbs @@ -87,7 +87,9 @@ module FinchAPI private def self.known_variants: -> ::Array[[Symbol?, Proc]] - def self.variants: -> ::Array[[Symbol?, top]] + def self.derefed_variants: -> ::Array[[Symbol?, top]] + + def self.variants: -> ::Array[top] private def self.discriminator: (Symbol property) -> void diff --git a/sig/finch-api/models/hris/document_retreive_response.rbs b/sig/finch-api/models/hris/document_retreive_response.rbs index 4a429ff9..66ffdfae 100644 --- a/sig/finch-api/models/hris/document_retreive_response.rbs +++ b/sig/finch-api/models/hris/document_retreive_response.rbs @@ -5,7 +5,7 @@ module FinchAPI FinchAPI::Models::HRIS::W42020 | FinchAPI::Models::HRIS::W42005 class DocumentRetreiveResponse < FinchAPI::Union - private def self.variants: -> [[:w4_2020, FinchAPI::Models::HRIS::W42020], [:w4_2005, FinchAPI::Models::HRIS::W42005]] + def self.variants: -> [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005] end end end diff --git a/sig/finch-api/models/webhook_event.rbs b/sig/finch-api/models/webhook_event.rbs index 79c08e7b..b52eb4c4 100644 --- a/sig/finch-api/models/webhook_event.rbs +++ b/sig/finch-api/models/webhook_event.rbs @@ -11,7 +11,7 @@ module FinchAPI | FinchAPI::Models::PayStatementEvent class WebhookEvent < FinchAPI::Union - private def self.variants: -> [[:"account.updated", FinchAPI::Models::AccountUpdateEvent], [:"company.updated", FinchAPI::Models::CompanyEvent], [nil, FinchAPI::Models::JobCompletionEvent], [nil, FinchAPI::Models::DirectoryEvent], [nil, FinchAPI::Models::EmploymentEvent], [nil, FinchAPI::Models::IndividualEvent], [nil, FinchAPI::Models::PaymentEvent], [nil, FinchAPI::Models::PayStatementEvent]] + def self.variants: -> [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] end end end From cf75aa6659727bf0f0c429df3e2cdb51ccb49541 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 14 Mar 2025 18:01:08 +0000 Subject: [PATCH 35/67] chore: slightly more consistent type definition layout (#38) --- rbi/lib/finch-api/base_model.rbi | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 5de2dac6..047e75ef 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -80,10 +80,10 @@ module FinchAPI # When we don't know what to expect for the value. class Unknown - abstract! - extend FinchAPI::Converter + abstract! + sig { params(other: T.anything).returns(T::Boolean) } def self.===(other) end @@ -116,10 +116,10 @@ module FinchAPI # Ruby has no Boolean class; this is something for models to refer to. class BooleanModel - abstract! - extend FinchAPI::Converter + abstract! + sig { params(other: T.anything).returns(T::Boolean) } def self.===(other) end @@ -161,10 +161,10 @@ module FinchAPI # We can therefore convert string values to Symbols, but can't convert other # values safely. class Enum - abstract! - extend FinchAPI::Converter + abstract! + class << self # All of the valid Symbol values for this enum. sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } @@ -210,10 +210,10 @@ module FinchAPI end class Union - abstract! - extend FinchAPI::Converter + abstract! + class << self # @api private # @@ -295,10 +295,10 @@ module FinchAPI # Array of items of a given type. class ArrayOf - abstract! - include FinchAPI::Converter + abstract! + sig { params(other: T.anything).returns(T::Boolean) } def ===(other) end @@ -357,10 +357,10 @@ module FinchAPI # Hash of items of a given type. class HashOf - abstract! - include FinchAPI::Converter + abstract! + sig { params(other: T.anything).returns(T::Boolean) } def ===(other) end @@ -418,10 +418,10 @@ module FinchAPI end class BaseModel - abstract! - extend FinchAPI::Converter + abstract! + KnownFieldShape = T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean} } class << self From 69bb3a3c0831b8940709dd3b14115fefbcc7508e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 15 Mar 2025 01:26:13 +0000 Subject: [PATCH 36/67] chore: mark non-inheritable SDK internal classes as final (#39) --- rbi/lib/finch-api/base_model.rbi | 56 ++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 24 deletions(-) diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 047e75ef..2b3132a2 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -83,28 +83,29 @@ module FinchAPI extend FinchAPI::Converter abstract! + final! - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def self.===(other) end - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def self.==(other) end class << self # @api private - sig { override.params(value: T.anything).returns(T.anything) } + sig(:final) { override.params(value: T.anything).returns(T.anything) } def coerce(value) end # @api private - sig { override.params(value: T.anything).returns(T.anything) } + sig(:final) { override.params(value: T.anything).returns(T.anything) } def dump(value) end # @api private - sig do + sig(:final) do override .params(value: T.anything) .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) @@ -119,28 +120,33 @@ module FinchAPI extend FinchAPI::Converter abstract! + final! - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def self.===(other) end - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def self.==(other) end class << self # @api private - sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } + sig(:final) do + override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) + end def coerce(value) end # @api private - sig { override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) } + sig(:final) do + override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) + end def dump(value) end # @api private - sig do + sig(:final) do override .params(value: T.anything) .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) @@ -298,17 +304,18 @@ module FinchAPI include FinchAPI::Converter abstract! + final! - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ===(other) end - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ==(other) end # @api private - sig do + sig(:final) do override .params(value: T.any(T::Enumerable[T.anything], T.anything)) .returns(T.any(T::Array[T.anything], T.anything)) @@ -317,7 +324,7 @@ module FinchAPI end # @api private - sig do + sig(:final) do override .params(value: T.any(T::Enumerable[T.anything], T.anything)) .returns(T.any(T::Array[T.anything], T.anything)) @@ -326,7 +333,7 @@ module FinchAPI end # @api private - sig do + sig(:final) do override .params(value: T.anything) .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) @@ -335,12 +342,12 @@ module FinchAPI end # @api private - sig { returns(FinchAPI::Converter::Input) } + sig(:final) { returns(FinchAPI::Converter::Input) } protected def item_type end # @api private - sig do + sig(:final) do params( type_info: T.any( T::Hash[Symbol, T.anything], @@ -360,17 +367,18 @@ module FinchAPI include FinchAPI::Converter abstract! + final! - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ===(other) end - sig { params(other: T.anything).returns(T::Boolean) } + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ==(other) end # @api private - sig do + sig(:final) do override .params(value: T.any(T::Hash[T.anything, T.anything], T.anything)) .returns(T.any(T::Hash[Symbol, T.anything], T.anything)) @@ -379,7 +387,7 @@ module FinchAPI end # @api private - sig do + sig(:final) do override .params(value: T.any(T::Hash[T.anything, T.anything], T.anything)) .returns(T.any(T::Hash[Symbol, T.anything], T.anything)) @@ -388,7 +396,7 @@ module FinchAPI end # @api private - sig do + sig(:final) do override .params(value: T.anything) .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) @@ -397,12 +405,12 @@ module FinchAPI end # @api private - sig { returns(FinchAPI::Converter::Input) } + sig(:final) { returns(FinchAPI::Converter::Input) } protected def item_type end # @api private - sig do + sig(:final) do params( type_info: T.any( T::Hash[Symbol, T.anything], From e8e32c72394607c86788de884fa2ed8335e4d8bf Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 16 Mar 2025 00:01:32 +0000 Subject: [PATCH 37/67] chore: use generics instead of overloading for sorbet type definitions (#40) --- rbi/lib/finch-api/base_model.rbi | 18 ++- .../finch-api/models/account_update_event.rbi | 16 +-- rbi/lib/finch-api/models/company_event.rbi | 8 +- .../models/connect/session_new_params.rbi | 32 ++---- .../connect/session_reauthenticate_params.rbi | 8 +- .../models/connection_status_type.rbi | 8 +- .../models/create_access_token_response.rbi | 16 +-- rbi/lib/finch-api/models/directory_event.rbi | 8 +- rbi/lib/finch-api/models/employment_event.rbi | 8 +- .../models/hris/benefit_contribution.rbi | 12 +- .../hris/benefit_features_and_operations.rbi | 30 ++--- .../models/hris/benefit_frequency.rbi | 12 +- .../finch-api/models/hris/benefit_type.rbi | 44 ++++--- .../hris/benefits/enrolled_individual.rbi | 8 +- .../hris/benefits/individual_benefit.rbi | 12 +- .../individual_enroll_many_params.rbi | 24 +--- rbi/lib/finch-api/models/hris/company.rbi | 44 +++---- .../models/hris/document_list_params.rbi | 8 +- .../models/hris/document_response.rbi | 8 +- .../hris/document_retreive_response.rbi | 6 +- .../finch-api/models/hris/employment_data.rbi | 52 ++++----- rbi/lib/finch-api/models/hris/individual.rbi | 60 ++++------ .../finch-api/models/hris/pay_statement.rbi | 70 +++++------- rbi/lib/finch-api/models/hris/payment.rbi | 8 +- .../models/hris/supported_benefit.rbi | 30 ++--- rbi/lib/finch-api/models/hris/w42005.rbi | 24 +--- rbi/lib/finch-api/models/hris/w42020.rbi | 25 +--- rbi/lib/finch-api/models/income.rbi | 24 ++-- rbi/lib/finch-api/models/individual_event.rbi | 8 +- rbi/lib/finch-api/models/introspection.rbi | 24 +--- .../finch-api/models/job_completion_event.rbi | 8 +- .../models/jobs/automated_async_job.rbi | 16 +-- .../models/jobs/automated_create_params.rbi | 8 +- .../models/jobs/manual_async_job.rbi | 8 +- .../finch-api/models/operation_support.rbi | 8 +- .../finch-api/models/pay_statement_event.rbi | 8 +- rbi/lib/finch-api/models/payment_event.rbi | 8 +- .../payroll/pay_group_list_response.rbi | 8 +- .../payroll/pay_group_retrieve_response.rbi | 8 +- rbi/lib/finch-api/models/provider.rbi | 8 +- .../models/sandbox/company_update_params.rbi | 44 +++---- .../sandbox/company_update_response.rbi | 44 +++---- .../sandbox/connection_create_params.rbi | 8 +- .../sandbox/connection_create_response.rbi | 8 +- .../connections/account_create_params.rbi | 8 +- .../connections/account_create_response.rbi | 8 +- .../connections/account_update_response.rbi | 8 +- .../sandbox/directory_create_params.rbi | 107 +++++++----------- .../sandbox/employment_update_params.rbi | 52 ++++----- .../sandbox/employment_update_response.rbi | 52 ++++----- .../sandbox/individual_update_params.rbi | 60 ++++------ .../sandbox/individual_update_response.rbi | 60 ++++------ .../models/sandbox/job_create_params.rbi | 8 +- .../jobs/sandbox_job_configuration.rbi | 16 +-- .../models/sandbox/payment_create_params.rbi | 70 +++++------- rbi/lib/finch-api/models/webhook_event.rbi | 22 ++-- sig/finch-api/base_model.rbs | 8 +- 57 files changed, 457 insertions(+), 869 deletions(-) diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 2b3132a2..b6fe9afe 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -171,9 +171,11 @@ module FinchAPI abstract! + Value = type_template(:out) + class << self # All of the valid Symbol values for this enum. - sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } + sig { overridable.returns(T::Array[Value]) } def values end @@ -220,6 +222,8 @@ module FinchAPI abstract! + Variants = type_template(:out) + class << self # @api private # @@ -229,12 +233,12 @@ module FinchAPI end # @api private - sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) } + sig { returns(T::Array[[T.nilable(Symbol), Variants]]) } protected def derefed_variants end # All of the specified variants for this union. - sig { overridable.returns(T::Array[T.anything]) } + sig { overridable.returns(T::Array[Variants]) } def variants end @@ -306,6 +310,8 @@ module FinchAPI abstract! final! + Elem = type_member(:out) + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ===(other) end @@ -342,7 +348,7 @@ module FinchAPI end # @api private - sig(:final) { returns(FinchAPI::Converter::Input) } + sig(:final) { returns(Elem) } protected def item_type end @@ -369,6 +375,8 @@ module FinchAPI abstract! final! + Elem = type_member(:out) + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ===(other) end @@ -405,7 +413,7 @@ module FinchAPI end # @api private - sig(:final) { returns(FinchAPI::Converter::Input) } + sig(:final) { returns(Elem) } protected def item_type end diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index 9b88dc10..cff9539a 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -2454,17 +2454,13 @@ module FinchAPI class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + ASSISTED = :assisted CREDENTIAL = :credential API_TOKEN = :api_token API_CREDENTIAL = :api_credential OAUTH = :oauth - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end @@ -2472,13 +2468,9 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! - ACCOUNT_UPDATED = :"account.updated" + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + ACCOUNT_UPDATED = :"account.updated" end end end diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index 5096e2e0..d09d176f 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -34,13 +34,9 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! - COMPANY_UPDATED = :"company.updated" + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + COMPANY_UPDATED = :"company.updated" end end end diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index aa355e5d..17b6467d 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -137,6 +137,8 @@ module FinchAPI class Product < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + COMPANY = :company DIRECTORY = :directory INDIVIDUAL = :individual @@ -145,12 +147,6 @@ module FinchAPI PAY_STATEMENT = :pay_statement BENEFITS = :benefits SSN = :ssn - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end class Integration < FinchAPI::BaseModel @@ -183,30 +179,22 @@ module FinchAPI class AuthMethod < FinchAPI::Enum abstract! - ASSISTED = T.let(:assisted, T.nilable(Symbol)) - CREDENTIAL = T.let(:credential, T.nilable(Symbol)) - OAUTH = T.let(:oauth, T.nilable(Symbol)) - API_TOKEN = T.let(:api_token, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + ASSISTED = :assisted + CREDENTIAL = :credential + OAUTH = :oauth + API_TOKEN = :api_token end end class Sandbox < FinchAPI::Enum abstract! - FINCH = T.let(:finch, T.nilable(Symbol)) - PROVIDER = T.let(:provider, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FINCH = :finch + PROVIDER = :provider end end end diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 0b19d358..86486f1f 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -76,6 +76,8 @@ module FinchAPI class Product < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + COMPANY = :company DIRECTORY = :directory INDIVIDUAL = :individual @@ -84,12 +86,6 @@ module FinchAPI PAY_STATEMENT = :pay_statement BENEFITS = :benefits SSN = :ssn - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/connection_status_type.rbi b/rbi/lib/finch-api/models/connection_status_type.rbi index 4669a5ce..61e4f310 100644 --- a/rbi/lib/finch-api/models/connection_status_type.rbi +++ b/rbi/lib/finch-api/models/connection_status_type.rbi @@ -5,18 +5,14 @@ module FinchAPI class ConnectionStatusType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PENDING = :pending PROCESSING = :processing CONNECTED = :connected ERROR_NO_ACCOUNT_SETUP = :error_no_account_setup ERROR_PERMISSIONS = :error_permissions REAUTH = :reauth - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index bd6d0e86..ad572fc6 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -152,15 +152,11 @@ module FinchAPI class ClientType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PRODUCTION = :production DEVELOPMENT = :development SANDBOX = :sandbox - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end # The type of the connection associated with the token. @@ -170,14 +166,10 @@ module FinchAPI class ConnectionType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PROVIDER = :provider FINCH = :finch - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index e23a5127..d5029718 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -49,15 +49,11 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + DIRECTORY_CREATED = :"directory.created" DIRECTORY_UPDATED = :"directory.updated" DIRECTORY_DELETED = :"directory.deleted" - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index 8e333f49..be60a3e9 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -49,15 +49,11 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + EMPLOYMENT_CREATED = :"employment.created" EMPLOYMENT_UPDATED = :"employment.updated" EMPLOYMENT_DELETED = :"employment.deleted" - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index d2748b07..fd94c3c2 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -34,14 +34,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - FIXED = T.let(:fixed, T.nilable(Symbol)) - PERCENT = T.let(:percent, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + FIXED = :fixed + PERCENT = :percent end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index e54d4249..7d4f9f33 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -164,40 +164,28 @@ module FinchAPI class CompanyContribution < FinchAPI::Enum abstract! - FIXED = T.let(:fixed, T.nilable(Symbol)) - PERCENT = T.let(:percent, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FIXED = :fixed + PERCENT = :percent end class EmployeeDeduction < FinchAPI::Enum abstract! - FIXED = T.let(:fixed, T.nilable(Symbol)) - PERCENT = T.let(:percent, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FIXED = :fixed + PERCENT = :percent end class HsaContributionLimit < FinchAPI::Enum abstract! - INDIVIDUAL = T.let(:individual, T.nilable(Symbol)) - FAMILY = T.let(:family, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + INDIVIDUAL = :individual + FAMILY = :family end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi index 8daa0206..b99b72a6 100644 --- a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi @@ -6,15 +6,11 @@ module FinchAPI class BenefitFrequency < FinchAPI::Enum abstract! - ONE_TIME = T.let(:one_time, T.nilable(Symbol)) - EVERY_PAYCHECK = T.let(:every_paycheck, T.nilable(Symbol)) - MONTHLY = T.let(:monthly, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + ONE_TIME = :one_time + EVERY_PAYCHECK = :every_paycheck + MONTHLY = :monthly end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_type.rbi b/rbi/lib/finch-api/models/hris/benefit_type.rbi index b21dfd59..d07eba9d 100644 --- a/rbi/lib/finch-api/models/hris/benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_type.rbi @@ -7,31 +7,27 @@ module FinchAPI class BenefitType < FinchAPI::Enum abstract! - NUMBER_401K = T.let(:"401k", T.nilable(Symbol)) - NUMBER_401K_ROTH = T.let(:"401k_roth", T.nilable(Symbol)) - NUMBER_401K_LOAN = T.let(:"401k_loan", T.nilable(Symbol)) - NUMBER_403B = T.let(:"403b", T.nilable(Symbol)) - NUMBER_403B_ROTH = T.let(:"403b_roth", T.nilable(Symbol)) - NUMBER_457 = T.let(:"457", T.nilable(Symbol)) - NUMBER_457_ROTH = T.let(:"457_roth", T.nilable(Symbol)) - S125_MEDICAL = T.let(:s125_medical, T.nilable(Symbol)) - S125_DENTAL = T.let(:s125_dental, T.nilable(Symbol)) - S125_VISION = T.let(:s125_vision, T.nilable(Symbol)) - HSA_PRE = T.let(:hsa_pre, T.nilable(Symbol)) - HSA_POST = T.let(:hsa_post, T.nilable(Symbol)) - FSA_MEDICAL = T.let(:fsa_medical, T.nilable(Symbol)) - FSA_DEPENDENT_CARE = T.let(:fsa_dependent_care, T.nilable(Symbol)) - SIMPLE_IRA = T.let(:simple_ira, T.nilable(Symbol)) - SIMPLE = T.let(:simple, T.nilable(Symbol)) - COMMUTER = T.let(:commuter, T.nilable(Symbol)) - CUSTOM_POST_TAX = T.let(:custom_post_tax, T.nilable(Symbol)) - CUSTOM_PRE_TAX = T.let(:custom_pre_tax, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + NUMBER_401K = :"401k" + NUMBER_401K_ROTH = :"401k_roth" + NUMBER_401K_LOAN = :"401k_loan" + NUMBER_403B = :"403b" + NUMBER_403B_ROTH = :"403b_roth" + NUMBER_457 = :"457" + NUMBER_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 end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index 66bdb1fe..286412d5 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -105,16 +105,12 @@ module FinchAPI class Code < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Integer} } + OK = 200 CREATED = 201 NOT_FOUND = 404 FORBIDDEN = 403 - - class << self - sig { override.returns(T::Array[Integer]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index 0e7a1acc..a85922d7 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -143,14 +143,10 @@ module FinchAPI class HsaContributionLimit < FinchAPI::Enum abstract! - INDIVIDUAL = T.let(:individual, T.nilable(Symbol)) - FAMILY = T.let(:family, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + INDIVIDUAL = :individual + FAMILY = :family end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index 2b12fd07..c191d936 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -199,14 +199,10 @@ module FinchAPI class AnnualContributionLimit < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + INDIVIDUAL = :individual FAMILY = :family - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end class CompanyContribution < FinchAPI::BaseModel @@ -239,14 +235,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + FIXED = :fixed PERCENT = :percent - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end @@ -280,14 +272,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + FIXED = :fixed PERCENT = :percent - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index a0ea14d8..a2296983 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -221,14 +221,10 @@ module FinchAPI class AccountType < FinchAPI::Enum abstract! - CHECKING = T.let(:checking, T.nilable(Symbol)) - SAVINGS = T.let(:savings, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + CHECKING = :checking + SAVINGS = :savings end end @@ -326,34 +322,26 @@ module FinchAPI class Subtype < FinchAPI::Enum abstract! - S_CORPORATION = T.let(:s_corporation, T.nilable(Symbol)) - C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol)) - B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + S_CORPORATION = :s_corporation + C_CORPORATION = :c_corporation + B_CORPORATION = :b_corporation end # The tax payer type of the company. class Type < FinchAPI::Enum abstract! - LLC = T.let(:llc, T.nilable(Symbol)) - LP = T.let(:lp, T.nilable(Symbol)) - CORPORATION = T.let(:corporation, T.nilable(Symbol)) - SOLE_PROPRIETOR = T.let(:sole_proprietor, T.nilable(Symbol)) - NON_PROFIT = T.let(:non_profit, T.nilable(Symbol)) - PARTNERSHIP = T.let(:partnership, T.nilable(Symbol)) - COOPERATIVE = T.let(:cooperative, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + LLC = :llc + LP = :lp + CORPORATION = :corporation + SOLE_PROPRIETOR = :sole_proprietor + NON_PROFIT = :non_profit + PARTNERSHIP = :partnership + COOPERATIVE = :cooperative end end end diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index ea07c343..fbc736cc 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -76,14 +76,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + W4_2020 = :w4_2020 W4_2005 = :w4_2005 - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index c4e61675..23034dfa 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -81,14 +81,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + W4_2020 = :w4_2020 W4_2005 = :w4_2005 - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index 267d4b82..ef331e0d 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -8,11 +8,7 @@ module FinchAPI class DocumentRetreiveResponse < FinchAPI::Union abstract! - class << self - sig { override.returns([FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]) } - def variants - end - end + Variants = type_template(:out) { {fixed: T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)} } end end end diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index 72097a41..13e1fe84 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -358,32 +358,24 @@ module FinchAPI class Subtype < FinchAPI::Enum abstract! - FULL_TIME = T.let(:full_time, T.nilable(Symbol)) - INTERN = T.let(:intern, T.nilable(Symbol)) - PART_TIME = T.let(:part_time, T.nilable(Symbol)) - TEMP = T.let(:temp, T.nilable(Symbol)) - SEASONAL = T.let(:seasonal, T.nilable(Symbol)) - INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + FULL_TIME = :full_time + INTERN = :intern + PART_TIME = :part_time + TEMP = :temp + SEASONAL = :seasonal + INDIVIDUAL_CONTRACTOR = :individual_contractor end # The main employment type of the individual. class Type < FinchAPI::Enum abstract! - EMPLOYEE = T.let(:employee, T.nilable(Symbol)) - CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + EMPLOYEE = :employee + CONTRACTOR = :contractor end end @@ -392,19 +384,15 @@ module FinchAPI class EmploymentStatus < FinchAPI::Enum abstract! - ACTIVE = T.let(:active, T.nilable(Symbol)) - DECEASED = T.let(:deceased, T.nilable(Symbol)) - LEAVE = T.let(:leave, T.nilable(Symbol)) - ONBOARDING = T.let(:onboarding, T.nilable(Symbol)) - PREHIRE = T.let(:prehire, T.nilable(Symbol)) - RETIRED = T.let(:retired, T.nilable(Symbol)) - TERMINATED = T.let(:terminated, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + ACTIVE = :active + DECEASED = :deceased + LEAVE = :leave + ONBOARDING = :onboarding + PREHIRE = :prehire + RETIRED = :retired + TERMINATED = :terminated end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index d4efca5c..8a1577d9 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -214,14 +214,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + WORK = :work + PERSONAL = :personal end end @@ -229,36 +225,28 @@ module FinchAPI class Ethnicity < FinchAPI::Enum abstract! - ASIAN = T.let(:asian, T.nilable(Symbol)) - WHITE = T.let(:white, T.nilable(Symbol)) - BLACK_OR_AFRICAN_AMERICAN = T.let(:black_or_african_american, T.nilable(Symbol)) - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let(:native_hawaiian_or_pacific_islander, T.nilable(Symbol)) - AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let(:american_indian_or_alaska_native, T.nilable(Symbol)) - HISPANIC_OR_LATINO = T.let(:hispanic_or_latino, T.nilable(Symbol)) - TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + ASIAN = :asian + WHITE = :white + BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander + AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native + HISPANIC_OR_LATINO = :hispanic_or_latino + TWO_OR_MORE_RACES = :two_or_more_races + DECLINE_TO_SPECIFY = :decline_to_specify end # The gender of the individual. class Gender < FinchAPI::Enum abstract! - FEMALE = T.let(:female, T.nilable(Symbol)) - MALE = T.let(:male, T.nilable(Symbol)) - OTHER = T.let(:other, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FEMALE = :female + MALE = :male + OTHER = :other + DECLINE_TO_SPECIFY = :decline_to_specify end class PhoneNumber < FinchAPI::BaseModel @@ -289,14 +277,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + WORK = :work + PERSONAL = :personal end end end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 9f8c02ff..44308358 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -289,25 +289,21 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - SALARY = T.let(:salary, T.nilable(Symbol)) - WAGE = T.let(:wage, T.nilable(Symbol)) - REIMBURSEMENT = T.let(:reimbursement, T.nilable(Symbol)) - OVERTIME = T.let(:overtime, T.nilable(Symbol)) - SEVERANCE = T.let(:severance, T.nilable(Symbol)) - DOUBLE_OVERTIME = T.let(:double_overtime, T.nilable(Symbol)) - PTO = T.let(:pto, T.nilable(Symbol)) - SICK = T.let(:sick, T.nilable(Symbol)) - BONUS = T.let(:bonus, T.nilable(Symbol)) - COMMISSION = T.let(:commission, T.nilable(Symbol)) - TIPS = T.let(:tips, T.nilable(Symbol)) - NUMBER_1099 = T.let(:"1099", T.nilable(Symbol)) - OTHER = T.let(:other, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + SALARY = :salary + WAGE = :wage + REIMBURSEMENT = :reimbursement + OVERTIME = :overtime + SEVERANCE = :severance + DOUBLE_OVERTIME = :double_overtime + PTO = :pto + SICK = :sick + BONUS = :bonus + COMMISSION = :commission + TIPS = :tips + NUMBER_1099 = :"1099" + OTHER = :other end end @@ -575,14 +571,10 @@ module FinchAPI class PaymentMethod < FinchAPI::Enum abstract! - CHECK = T.let(:check, T.nilable(Symbol)) - DIRECT_DEPOSIT = T.let(:direct_deposit, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + CHECK = :check + DIRECT_DEPOSIT = :direct_deposit end class Tax < FinchAPI::BaseModel @@ -720,16 +712,12 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - STATE = T.let(:state, T.nilable(Symbol)) - FEDERAL = T.let(:federal, T.nilable(Symbol)) - LOCAL = T.let(:local, T.nilable(Symbol)) - FICA = T.let(:fica, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + STATE = :state + FEDERAL = :federal + LOCAL = :local + FICA = :fica end end @@ -737,15 +725,11 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - REGULAR_PAYROLL = T.let(:regular_payroll, T.nilable(Symbol)) - OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, T.nilable(Symbol)) - ONE_TIME_PAYMENT = T.let(:one_time_payment, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + REGULAR_PAYROLL = :regular_payroll + OFF_CYCLE_PAYROLL = :off_cycle_payroll + ONE_TIME_PAYMENT = :one_time_payment end end end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 00531c43..3c4ff9de 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -166,6 +166,8 @@ module FinchAPI class PayFrequency < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually QUARTERLY = :quarterly @@ -175,12 +177,6 @@ module FinchAPI WEEKLY = :weekly DAILY = :daily OTHER = :other - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end class PayPeriod < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index 1e6d5ebd..175f700a 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -131,40 +131,28 @@ module FinchAPI class CompanyContribution < FinchAPI::Enum abstract! - FIXED = T.let(:fixed, T.nilable(Symbol)) - PERCENT = T.let(:percent, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FIXED = :fixed + PERCENT = :percent end class EmployeeDeduction < FinchAPI::Enum abstract! - FIXED = T.let(:fixed, T.nilable(Symbol)) - PERCENT = T.let(:percent, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FIXED = :fixed + PERCENT = :percent end class HsaContributionLimit < FinchAPI::Enum abstract! - INDIVIDUAL = T.let(:individual, T.nilable(Symbol)) - FAMILY = T.let(:family, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + INDIVIDUAL = :individual + FAMILY = :family end end end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 839cb1b4..875e22f0 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -129,29 +129,21 @@ module FinchAPI class Exemption < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + EXEMPT = :exempt NON_EXEMPT = :non_exempt - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end # The individual's filing status for tax purposes. class FilingStatus < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + MARRIED = :married MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate SINGLE = :single - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end @@ -159,13 +151,9 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - W4_2005 = :w4_2005 + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + W4_2005 = :w4_2005 end end end diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index ac3a01c7..092c7dd6 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -166,20 +166,11 @@ module FinchAPI class FilingStatus < FinchAPI::Enum abstract! - HEAD_OF_HOUSEHOLD = T.let(:head_of_household, T.nilable(Symbol)) - MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = T.let( - :married_filing_jointly_or_qualifying_surviving_spouse, T.nilable(Symbol) - ) - SINGLE_OR_MARRIED_FILING_SEPARATELY = T.let( - :single_or_married_filing_separately, - T.nilable(Symbol) - ) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + HEAD_OF_HOUSEHOLD = :head_of_household + MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = :married_filing_jointly_or_qualifying_surviving_spouse + SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately end end @@ -187,13 +178,9 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - W4_2020 = :w4_2020 + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + W4_2020 = :w4_2020 end end end diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index 3a2dae58..6adb36b2 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -74,21 +74,17 @@ module FinchAPI class Unit < FinchAPI::Enum abstract! - YEARLY = T.let(:yearly, T.nilable(Symbol)) - QUARTERLY = T.let(:quarterly, T.nilable(Symbol)) - MONTHLY = T.let(:monthly, T.nilable(Symbol)) - SEMI_MONTHLY = T.let(:semi_monthly, T.nilable(Symbol)) - BI_WEEKLY = T.let(:bi_weekly, T.nilable(Symbol)) - WEEKLY = T.let(:weekly, T.nilable(Symbol)) - DAILY = T.let(:daily, T.nilable(Symbol)) - HOURLY = T.let(:hourly, T.nilable(Symbol)) - FIXED = T.let(:fixed, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + YEARLY = :yearly + QUARTERLY = :quarterly + MONTHLY = :monthly + SEMI_MONTHLY = :semi_monthly + BI_WEEKLY = :bi_weekly + WEEKLY = :weekly + DAILY = :daily + HOURLY = :hourly + FIXED = :fixed end end end diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index e8705e22..44b8c05e 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -49,15 +49,11 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + INDIVIDUAL_CREATED = :"individual.created" INDIVIDUAL_UPDATED = :"individual.updated" INDIVIDUAL_DELETED = :"individual.deleted" - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index dce5ff7d..4af48c1c 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -313,17 +313,13 @@ module FinchAPI class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + ASSISTED = :assisted CREDENTIAL = :credential API_TOKEN = :api_token API_CREDENTIAL = :api_credential OAUTH = :oauth - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end @@ -331,15 +327,11 @@ module FinchAPI class ClientType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PRODUCTION = :production DEVELOPMENT = :development SANDBOX = :sandbox - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end class ConnectionStatus < FinchAPI::BaseModel @@ -375,14 +367,10 @@ module FinchAPI class ConnectionType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PROVIDER = :provider FINCH = :finch - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index b6f16a19..1b3faa8f 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -58,18 +58,14 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + JOB_BENEFIT_CREATE_COMPLETED = :"job.benefit_create.completed" JOB_BENEFIT_ENROLL_COMPLETED = :"job.benefit_enroll.completed" JOB_BENEFIT_REGISTER_COMPLETED = :"job.benefit_register.completed" JOB_BENEFIT_UNENROLL_COMPLETED = :"job.benefit_unenroll.completed" JOB_BENEFIT_UPDATE_COMPLETED = :"job.benefit_update.completed" JOB_DATA_SYNC_ALL_COMPLETED = :"job.data_sync_all.completed" - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 050b4f1c..2eb3743a 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -150,32 +150,24 @@ module FinchAPI class Status < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PENDING = :pending IN_PROGRESS = :in_progress COMPLETE = :complete ERROR = :error REAUTH_ERROR = :reauth_error PERMISSIONS_ERROR = :permissions_error - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end # The type of automated job class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + DATA_SYNC_ALL = :data_sync_all W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index 29c81e50..fd61d703 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -55,13 +55,9 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync end class Params < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index ab90a51b..6368e540 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -46,16 +46,12 @@ module FinchAPI class Status < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PENDING = :pending IN_PROGRESS = :in_progress ERROR = :error COMPLETE = :complete - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/operation_support.rbi b/rbi/lib/finch-api/models/operation_support.rbi index f6b272a9..d3f7924d 100644 --- a/rbi/lib/finch-api/models/operation_support.rbi +++ b/rbi/lib/finch-api/models/operation_support.rbi @@ -12,16 +12,12 @@ module FinchAPI class OperationSupport < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + SUPPORTED = :supported NOT_SUPPORTED_BY_FINCH = :not_supported_by_finch NOT_SUPPORTED_BY_PROVIDER = :not_supported_by_provider CLIENT_ACCESS_ONLY = :client_access_only - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 4838210c..e3fa9d31 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -58,15 +58,11 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PAY_STATEMENT_CREATED = :"pay_statement.created" PAY_STATEMENT_UPDATED = :"pay_statement.updated" PAY_STATEMENT_DELETED = :"pay_statement.deleted" - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index bcf1b5ec..65c1402f 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -58,15 +58,11 @@ module FinchAPI class EventType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + PAYMENT_CREATED = :"payment.created" PAYMENT_UPDATED = :"payment.updated" PAYMENT_DELETED = :"payment.deleted" - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index 6f19c0cc..f53f82a8 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -42,6 +42,8 @@ module FinchAPI class PayFrequency < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually QUARTERLY = :quarterly @@ -51,12 +53,6 @@ module FinchAPI WEEKLY = :weekly DAILY = :daily OTHER = :other - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index bee781c1..3d81e580 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -66,6 +66,8 @@ module FinchAPI class PayFrequency < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually QUARTERLY = :quarterly @@ -75,12 +77,6 @@ module FinchAPI WEEKLY = :weekly DAILY = :daily OTHER = :other - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 15ce1c40..69905d02 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -2363,17 +2363,13 @@ module FinchAPI class Type < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + ASSISTED = :assisted CREDENTIAL = :credential API_TOKEN = :api_token API_CREDENTIAL = :api_credential OAUTH = :oauth - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index d86ba728..8983cd1d 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -215,14 +215,10 @@ module FinchAPI class AccountType < FinchAPI::Enum abstract! - CHECKING = T.let(:checking, T.nilable(Symbol)) - SAVINGS = T.let(:savings, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + CHECKING = :checking + SAVINGS = :savings end end @@ -323,34 +319,26 @@ module FinchAPI class Subtype < FinchAPI::Enum abstract! - S_CORPORATION = T.let(:s_corporation, T.nilable(Symbol)) - C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol)) - B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + S_CORPORATION = :s_corporation + C_CORPORATION = :c_corporation + B_CORPORATION = :b_corporation end # The tax payer type of the company. class Type < FinchAPI::Enum abstract! - LLC = T.let(:llc, T.nilable(Symbol)) - LP = T.let(:lp, T.nilable(Symbol)) - CORPORATION = T.let(:corporation, T.nilable(Symbol)) - SOLE_PROPRIETOR = T.let(:sole_proprietor, T.nilable(Symbol)) - NON_PROFIT = T.let(:non_profit, T.nilable(Symbol)) - PARTNERSHIP = T.let(:partnership, T.nilable(Symbol)) - COOPERATIVE = T.let(:cooperative, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + LLC = :llc + LP = :lp + CORPORATION = :corporation + SOLE_PROPRIETOR = :sole_proprietor + NON_PROFIT = :non_profit + PARTNERSHIP = :partnership + COOPERATIVE = :cooperative end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index 56a25f3d..e22fe115 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -200,14 +200,10 @@ module FinchAPI class AccountType < FinchAPI::Enum abstract! - CHECKING = T.let(:checking, T.nilable(Symbol)) - SAVINGS = T.let(:savings, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + CHECKING = :checking + SAVINGS = :savings end end @@ -308,34 +304,26 @@ module FinchAPI class Subtype < FinchAPI::Enum abstract! - S_CORPORATION = T.let(:s_corporation, T.nilable(Symbol)) - C_CORPORATION = T.let(:c_corporation, T.nilable(Symbol)) - B_CORPORATION = T.let(:b_corporation, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + S_CORPORATION = :s_corporation + C_CORPORATION = :c_corporation + B_CORPORATION = :b_corporation end # The tax payer type of the company. class Type < FinchAPI::Enum abstract! - LLC = T.let(:llc, T.nilable(Symbol)) - LP = T.let(:lp, T.nilable(Symbol)) - CORPORATION = T.let(:corporation, T.nilable(Symbol)) - SOLE_PROPRIETOR = T.let(:sole_proprietor, T.nilable(Symbol)) - NON_PROFIT = T.let(:non_profit, T.nilable(Symbol)) - PARTNERSHIP = T.let(:partnership, T.nilable(Symbol)) - COOPERATIVE = T.let(:cooperative, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + LLC = :llc + LP = :lp + CORPORATION = :corporation + SOLE_PROPRIETOR = :sole_proprietor + NON_PROFIT = :non_profit + PARTNERSHIP = :partnership + COOPERATIVE = :cooperative end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 9c54c06f..1357796c 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -74,16 +74,12 @@ module FinchAPI class AuthenticationType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth ASSISTED = :assisted - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index 3e518f59..e52b4363 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -118,16 +118,12 @@ module FinchAPI class AuthenticationType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth ASSISTED = :assisted - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index b6c07650..ce09705f 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -74,16 +74,12 @@ module FinchAPI class AuthenticationType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth ASSISTED = :assisted - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index 163d6752..b0533821 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -100,16 +100,12 @@ module FinchAPI class AuthenticationType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth ASSISTED = :assisted - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index a0c5ab71..608f54bb 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -90,16 +90,12 @@ module FinchAPI class AuthenticationType < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth ASSISTED = :assisted - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end end end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index ab5615e0..507ff6f0 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -490,14 +490,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + WORK = :work + PERSONAL = :personal end end @@ -535,32 +531,24 @@ module FinchAPI class Subtype < FinchAPI::Enum abstract! - FULL_TIME = T.let(:full_time, T.nilable(Symbol)) - INTERN = T.let(:intern, T.nilable(Symbol)) - PART_TIME = T.let(:part_time, T.nilable(Symbol)) - TEMP = T.let(:temp, T.nilable(Symbol)) - SEASONAL = T.let(:seasonal, T.nilable(Symbol)) - INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FULL_TIME = :full_time + INTERN = :intern + PART_TIME = :part_time + TEMP = :temp + SEASONAL = :seasonal + INDIVIDUAL_CONTRACTOR = :individual_contractor end # The main employment type of the individual. class Type < FinchAPI::Enum abstract! - EMPLOYEE = T.let(:employee, T.nilable(Symbol)) - CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + EMPLOYEE = :employee + CONTRACTOR = :contractor end end @@ -568,58 +556,43 @@ module FinchAPI class EmploymentStatus < FinchAPI::Enum abstract! - ACTIVE = T.let(:active, T.nilable(Symbol)) - DECEASED = T.let(:deceased, T.nilable(Symbol)) - LEAVE = T.let(:leave, T.nilable(Symbol)) - ONBOARDING = T.let(:onboarding, T.nilable(Symbol)) - PREHIRE = T.let(:prehire, T.nilable(Symbol)) - RETIRED = T.let(:retired, T.nilable(Symbol)) - TERMINATED = T.let(:terminated, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + ACTIVE = :active + DECEASED = :deceased + LEAVE = :leave + ONBOARDING = :onboarding + PREHIRE = :prehire + RETIRED = :retired + TERMINATED = :terminated end # The EEOC-defined ethnicity of the individual. class Ethnicity < FinchAPI::Enum abstract! - ASIAN = T.let(:asian, T.nilable(Symbol)) - WHITE = T.let(:white, T.nilable(Symbol)) - BLACK_OR_AFRICAN_AMERICAN = T.let(:black_or_african_american, T.nilable(Symbol)) - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let( - :native_hawaiian_or_pacific_islander, - T.nilable(Symbol) - ) - AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let(:american_indian_or_alaska_native, T.nilable(Symbol)) - HISPANIC_OR_LATINO = T.let(:hispanic_or_latino, T.nilable(Symbol)) - TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + ASIAN = :asian + WHITE = :white + BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander + AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native + HISPANIC_OR_LATINO = :hispanic_or_latino + TWO_OR_MORE_RACES = :two_or_more_races + DECLINE_TO_SPECIFY = :decline_to_specify end # The gender of the individual. class Gender < FinchAPI::Enum abstract! - FEMALE = T.let(:female, T.nilable(Symbol)) - MALE = T.let(:male, T.nilable(Symbol)) - OTHER = T.let(:other, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FEMALE = :female + MALE = :male + OTHER = :other + DECLINE_TO_SPECIFY = :decline_to_specify end class Manager < FinchAPI::BaseModel @@ -670,14 +643,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + WORK = :work + PERSONAL = :personal end end end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index c84f014d..defcb492 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -340,32 +340,24 @@ module FinchAPI class Subtype < FinchAPI::Enum abstract! - FULL_TIME = T.let(:full_time, T.nilable(Symbol)) - INTERN = T.let(:intern, T.nilable(Symbol)) - PART_TIME = T.let(:part_time, T.nilable(Symbol)) - TEMP = T.let(:temp, T.nilable(Symbol)) - SEASONAL = T.let(:seasonal, T.nilable(Symbol)) - INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + FULL_TIME = :full_time + INTERN = :intern + PART_TIME = :part_time + TEMP = :temp + SEASONAL = :seasonal + INDIVIDUAL_CONTRACTOR = :individual_contractor end # The main employment type of the individual. class Type < FinchAPI::Enum abstract! - EMPLOYEE = T.let(:employee, T.nilable(Symbol)) - CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + EMPLOYEE = :employee + CONTRACTOR = :contractor end end @@ -373,19 +365,15 @@ module FinchAPI class EmploymentStatus < FinchAPI::Enum abstract! - ACTIVE = T.let(:active, T.nilable(Symbol)) - DECEASED = T.let(:deceased, T.nilable(Symbol)) - LEAVE = T.let(:leave, T.nilable(Symbol)) - ONBOARDING = T.let(:onboarding, T.nilable(Symbol)) - PREHIRE = T.let(:prehire, T.nilable(Symbol)) - RETIRED = T.let(:retired, T.nilable(Symbol)) - TERMINATED = T.let(:terminated, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + ACTIVE = :active + DECEASED = :deceased + LEAVE = :leave + ONBOARDING = :onboarding + PREHIRE = :prehire + RETIRED = :retired + TERMINATED = :terminated end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 9ed651be..62eb953e 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -346,32 +346,24 @@ module FinchAPI class Subtype < FinchAPI::Enum abstract! - FULL_TIME = T.let(:full_time, T.nilable(Symbol)) - INTERN = T.let(:intern, T.nilable(Symbol)) - PART_TIME = T.let(:part_time, T.nilable(Symbol)) - TEMP = T.let(:temp, T.nilable(Symbol)) - SEASONAL = T.let(:seasonal, T.nilable(Symbol)) - INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + FULL_TIME = :full_time + INTERN = :intern + PART_TIME = :part_time + TEMP = :temp + SEASONAL = :seasonal + INDIVIDUAL_CONTRACTOR = :individual_contractor end # The main employment type of the individual. class Type < FinchAPI::Enum abstract! - EMPLOYEE = T.let(:employee, T.nilable(Symbol)) - CONTRACTOR = T.let(:contractor, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + EMPLOYEE = :employee + CONTRACTOR = :contractor end end @@ -379,19 +371,15 @@ module FinchAPI class EmploymentStatus < FinchAPI::Enum abstract! - ACTIVE = T.let(:active, T.nilable(Symbol)) - DECEASED = T.let(:deceased, T.nilable(Symbol)) - LEAVE = T.let(:leave, T.nilable(Symbol)) - ONBOARDING = T.let(:onboarding, T.nilable(Symbol)) - PREHIRE = T.let(:prehire, T.nilable(Symbol)) - RETIRED = T.let(:retired, T.nilable(Symbol)) - TERMINATED = T.let(:terminated, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + ACTIVE = :active + DECEASED = :deceased + LEAVE = :leave + ONBOARDING = :onboarding + PREHIRE = :prehire + RETIRED = :retired + TERMINATED = :terminated end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index dda1d58f..85fa27de 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -208,14 +208,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + WORK = :work + PERSONAL = :personal end end @@ -223,36 +219,28 @@ module FinchAPI class Ethnicity < FinchAPI::Enum abstract! - ASIAN = T.let(:asian, T.nilable(Symbol)) - WHITE = T.let(:white, T.nilable(Symbol)) - BLACK_OR_AFRICAN_AMERICAN = T.let(:black_or_african_american, T.nilable(Symbol)) - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let(:native_hawaiian_or_pacific_islander, T.nilable(Symbol)) - AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let(:american_indian_or_alaska_native, T.nilable(Symbol)) - HISPANIC_OR_LATINO = T.let(:hispanic_or_latino, T.nilable(Symbol)) - TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + ASIAN = :asian + WHITE = :white + BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander + AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native + HISPANIC_OR_LATINO = :hispanic_or_latino + TWO_OR_MORE_RACES = :two_or_more_races + DECLINE_TO_SPECIFY = :decline_to_specify end # The gender of the individual. class Gender < FinchAPI::Enum abstract! - FEMALE = T.let(:female, T.nilable(Symbol)) - MALE = T.let(:male, T.nilable(Symbol)) - OTHER = T.let(:other, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FEMALE = :female + MALE = :male + OTHER = :other + DECLINE_TO_SPECIFY = :decline_to_specify end class PhoneNumber < FinchAPI::BaseModel @@ -283,14 +271,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + WORK = :work + PERSONAL = :personal end end end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index 13364766..b791a544 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -216,14 +216,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + WORK = :work + PERSONAL = :personal end end @@ -231,36 +227,28 @@ module FinchAPI class Ethnicity < FinchAPI::Enum abstract! - ASIAN = T.let(:asian, T.nilable(Symbol)) - WHITE = T.let(:white, T.nilable(Symbol)) - BLACK_OR_AFRICAN_AMERICAN = T.let(:black_or_african_american, T.nilable(Symbol)) - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let(:native_hawaiian_or_pacific_islander, T.nilable(Symbol)) - AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let(:american_indian_or_alaska_native, T.nilable(Symbol)) - HISPANIC_OR_LATINO = T.let(:hispanic_or_latino, T.nilable(Symbol)) - TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + ASIAN = :asian + WHITE = :white + BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander + AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native + HISPANIC_OR_LATINO = :hispanic_or_latino + TWO_OR_MORE_RACES = :two_or_more_races + DECLINE_TO_SPECIFY = :decline_to_specify end # The gender of the individual. class Gender < FinchAPI::Enum abstract! - FEMALE = T.let(:female, T.nilable(Symbol)) - MALE = T.let(:male, T.nilable(Symbol)) - OTHER = T.let(:other, T.nilable(Symbol)) - DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + FEMALE = :female + MALE = :male + OTHER = :other + DECLINE_TO_SPECIFY = :decline_to_specify end class PhoneNumber < FinchAPI::BaseModel @@ -291,14 +279,10 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - WORK = T.let(:work, T.nilable(Symbol)) - PERSONAL = T.let(:personal, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + WORK = :work + PERSONAL = :personal end end end diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index ca0da56f..341df379 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -31,13 +31,9 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - DATA_SYNC_ALL = :data_sync_all + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + DATA_SYNC_ALL = :data_sync_all end end end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index 578a1801..7ea67cc0 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -32,28 +32,20 @@ module FinchAPI class CompletionStatus < FinchAPI::Enum abstract! + Value = type_template(:out) { {fixed: Symbol} } + COMPLETE = :complete REAUTH_ERROR = :reauth_error PERMISSIONS_ERROR = :permissions_error ERROR = :error - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end end class Type < FinchAPI::Enum abstract! - DATA_SYNC_ALL = :data_sync_all + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + DATA_SYNC_ALL = :data_sync_all end end end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index 80f89445..e68e454b 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -403,25 +403,21 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - SALARY = T.let(:salary, T.nilable(Symbol)) - WAGE = T.let(:wage, T.nilable(Symbol)) - REIMBURSEMENT = T.let(:reimbursement, T.nilable(Symbol)) - OVERTIME = T.let(:overtime, T.nilable(Symbol)) - SEVERANCE = T.let(:severance, T.nilable(Symbol)) - DOUBLE_OVERTIME = T.let(:double_overtime, T.nilable(Symbol)) - PTO = T.let(:pto, T.nilable(Symbol)) - SICK = T.let(:sick, T.nilable(Symbol)) - BONUS = T.let(:bonus, T.nilable(Symbol)) - COMMISSION = T.let(:commission, T.nilable(Symbol)) - TIPS = T.let(:tips, T.nilable(Symbol)) - NUMBER_1099 = T.let(:"1099", T.nilable(Symbol)) - OTHER = T.let(:other, T.nilable(Symbol)) - - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + Value = type_template(:out) { {fixed: Symbol} } + + SALARY = :salary + WAGE = :wage + REIMBURSEMENT = :reimbursement + OVERTIME = :overtime + SEVERANCE = :severance + DOUBLE_OVERTIME = :double_overtime + PTO = :pto + SICK = :sick + BONUS = :bonus + COMMISSION = :commission + TIPS = :tips + NUMBER_1099 = :"1099" + OTHER = :other end end @@ -738,14 +734,10 @@ module FinchAPI class PaymentMethod < FinchAPI::Enum abstract! - CHECK = T.let(:check, T.nilable(Symbol)) - DIRECT_DEPOSIT = T.let(:direct_deposit, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + CHECK = :check + DIRECT_DEPOSIT = :direct_deposit end class Tax < FinchAPI::BaseModel @@ -893,16 +885,12 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - STATE = T.let(:state, T.nilable(Symbol)) - FEDERAL = T.let(:federal, T.nilable(Symbol)) - LOCAL = T.let(:local, T.nilable(Symbol)) - FICA = T.let(:fica, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + STATE = :state + FEDERAL = :federal + LOCAL = :local + FICA = :fica end end @@ -910,15 +898,11 @@ module FinchAPI class Type < FinchAPI::Enum abstract! - REGULAR_PAYROLL = T.let(:regular_payroll, T.nilable(Symbol)) - OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, T.nilable(Symbol)) - ONE_TIME_PAYMENT = T.let(:one_time_payment, T.nilable(Symbol)) + Value = type_template(:out) { {fixed: Symbol} } - class << self - sig { override.returns(T::Array[Symbol]) } - def values - end - end + REGULAR_PAYROLL = :regular_payroll + OFF_CYCLE_PAYROLL = :off_cycle_payroll + ONE_TIME_PAYMENT = :one_time_payment end end end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index 0e230f35..b1a4436a 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -5,15 +5,19 @@ module FinchAPI class WebhookEvent < FinchAPI::Union abstract! - class << self - sig do - override - .returns( - [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] - ) - end - def variants - end + Variants = type_template(:out) do + { + fixed: T.any( + FinchAPI::Models::AccountUpdateEvent, + FinchAPI::Models::CompanyEvent, + FinchAPI::Models::JobCompletionEvent, + FinchAPI::Models::DirectoryEvent, + FinchAPI::Models::EmploymentEvent, + FinchAPI::Models::IndividualEvent, + FinchAPI::Models::PaymentEvent, + FinchAPI::Models::PayStatementEvent + ) + } end end end diff --git a/sig/finch-api/base_model.rbs b/sig/finch-api/base_model.rbs index f3009549..a6674a96 100644 --- a/sig/finch-api/base_model.rbs +++ b/sig/finch-api/base_model.rbs @@ -118,7 +118,7 @@ module FinchAPI ) -> ([true, top, nil] | [false, bool, Integer]) end - class ArrayOf + class ArrayOf[Elem] include FinchAPI::Converter def ===: (top other) -> bool @@ -133,7 +133,7 @@ module FinchAPI top value ) -> ([true, top, nil] | [false, bool, Integer]) - def item_type: -> FinchAPI::Converter::input + def item_type: -> Elem def initialize: ( ::Hash[Symbol, top] @@ -143,7 +143,7 @@ module FinchAPI ) -> void end - class HashOf + class HashOf[Elem] include FinchAPI::Converter def ===: (top other) -> bool @@ -158,7 +158,7 @@ module FinchAPI top value ) -> ([true, top, nil] | [false, bool, Integer]) - def item_type: -> FinchAPI::Converter::input + def item_type: -> Elem def initialize: ( ::Hash[Symbol, top] From a0e8fe940fbeab06cfd62c3faea8b32b93500234 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 16 Mar 2025 03:23:23 +0000 Subject: [PATCH 38/67] chore: sdk client internal refactoring (#41) --- lib/finch-api/base_client.rb | 47 ++++++++++++---------- lib/finch-api/individuals_page.rb | 3 +- lib/finch-api/page.rb | 3 +- lib/finch-api/pooled_net_requester.rb | 19 +++++---- lib/finch-api/util.rb | 4 +- rbi/lib/finch-api/base_client.rbi | 10 +++++ rbi/lib/finch-api/base_model.rbi | 17 ++------ rbi/lib/finch-api/pooled_net_requester.rbi | 6 +-- rbi/lib/finch-api/util.rbi | 8 ++-- sig/finch-api/base_client.rbs | 5 +++ sig/finch-api/base_model.rbs | 2 +- sig/finch-api/pooled_net_requester.rbs | 9 ++++- sig/finch-api/util.rbs | 4 +- test/finch-api/client_test.rb | 29 +------------ test/finch-api/util_test.rb | 4 ++ 15 files changed, 85 insertions(+), 85 deletions(-) diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index a0139ba5..ffb87ccc 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -124,6 +124,20 @@ def follow_redirect(request, status:, response_headers:) request end + + # @api private + # + # @param status [Integer, FinchAPI::APIConnectionError] + # @param stream [Enumerable, nil] + def reap_connection!(status, stream:) + case status + in (..199) | (300..499) + stream&.each { next } + in FinchAPI::APIConnectionError | (500..) + FinchAPI::Util.close_fused!(stream) + else + end + end end # @api private @@ -321,28 +335,23 @@ def initialize( end begin - response, stream = @requester.execute(input) - status = Integer(response.code) + status, response, stream = @requester.execute(input) rescue FinchAPI::APIConnectionError => e status = e end - # normally we want to drain the response body and reuse the HTTP session by clearing the socket buffers - # unless we hit a server error - srv_fault = (500...).include?(status) - case status in ..299 [status, response, stream] in 300..399 if redirect_count >= self.class::MAX_REDIRECTS - message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects." + self.class.reap_connection!(status, stream: stream) - stream.each { next } + message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects." raise FinchAPI::APIConnectionError.new(url: url, message: message) in 300..399 - request = self.class.follow_redirect(request, status: status, response_headers: response) + self.class.reap_connection!(status, stream: stream) - stream.each { next } + request = self.class.follow_redirect(request, status: status, response_headers: response) send_request( request, redirect_count: redirect_count + 1, @@ -352,12 +361,10 @@ def initialize( in FinchAPI::APIConnectionError if retry_count >= max_retries raise status in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response) - decoded = FinchAPI::Util.decode_content(response, stream: stream, suppress_error: true) - - if srv_fault - FinchAPI::Util.close_fused!(stream) - else - stream.each { next } + decoded = Kernel.then do + FinchAPI::Util.decode_content(response, stream: stream, suppress_error: true) + ensure + self.class.reap_connection!(status, stream: stream) end raise FinchAPI::APIStatusError.for( @@ -368,13 +375,9 @@ def initialize( response: response ) in (400..) | FinchAPI::APIConnectionError - delay = retry_delay(response, retry_count: retry_count) + self.class.reap_connection!(status, stream: stream) - if srv_fault - FinchAPI::Util.close_fused!(stream) - else - stream&.each { next } - end + delay = retry_delay(response, retry_count: retry_count) sleep(delay) send_request( diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index e6f45542..71f8ca4c 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -68,7 +68,8 @@ def next_page? # @return [FinchAPI::IndividualsPage] def next_page unless next_page? - raise RuntimeError.new("No more pages available. Please check #next_page? before calling ##{__method__}") + message = "No more pages available. Please check #next_page? before calling ##{__method__}" + raise RuntimeError.new(message) end req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + individuals.to_a.size}}) diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index 46df3fd5..20265698 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -68,7 +68,8 @@ def next_page? # @return [FinchAPI::Page] def next_page unless next_page? - raise RuntimeError.new("No more pages available. Please check #next_page? before calling ##{__method__}") + message = "No more pages available. Please check #next_page? before calling ##{__method__}" + raise RuntimeError.new(message) end req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + data.to_a.size}}) diff --git a/lib/finch-api/pooled_net_requester.rb b/lib/finch-api/pooled_net_requester.rb index b5c649f9..b9d9d1ca 100644 --- a/lib/finch-api/pooled_net_requester.rb +++ b/lib/finch-api/pooled_net_requester.rb @@ -61,6 +61,7 @@ def build_request(request, &) case body in nil + nil in String req["content-length"] ||= body.bytesize.to_s unless req["transfer-encoding"] req.body_stream = FinchAPI::Util::ReadIOAdapter.new(body, &) @@ -79,9 +80,11 @@ def build_request(request, &) # @api private # # @param url [URI::Generic] + # @param deadline [Float] # @param blk [Proc] - private def with_pool(url, &) + private def with_pool(url, deadline:, &blk) origin = FinchAPI::Util.uri_origin(url) + timeout = deadline - FinchAPI::Util.monotonic_secs pool = @mutex.synchronize do @pools[origin] ||= ConnectionPool.new(size: @size) do @@ -89,7 +92,7 @@ def build_request(request, &) end end - pool.with(&) + pool.with(timeout: timeout, &blk) end # @api private @@ -106,14 +109,14 @@ def build_request(request, &) # # @option request [Float] :deadline # - # @return [Array(Net::HTTPResponse, Enumerable)] + # @return [Array(Integer, Net::HTTPResponse, Enumerable)] def execute(request) url, deadline = request.fetch_values(:url, :deadline) eof = false finished = false enum = Enumerator.new do |y| - with_pool(url) do |conn| + with_pool(url, deadline: deadline) do |conn| next if finished req = self.class.build_request(request) do @@ -125,7 +128,7 @@ def execute(request) self.class.calibrate_socket_timeout(conn, deadline) conn.request(req) do |rsp| - y << [conn, rsp] + y << [conn, req, rsp] break if finished rsp.read_body do |bytes| @@ -137,9 +140,11 @@ def execute(request) eof = true end end + rescue Timeout::Error + raise FinchAPI::APITimeoutError end - conn, response = enum.next + conn, _, response = enum.next body = FinchAPI::Util.fused_enum(enum, external: true) do finished = true tap do @@ -149,7 +154,7 @@ def execute(request) end conn.finish if !eof && conn&.started? end - [response, (response.body = body)] + [Integer(response.code), response, (response.body = body)] end # @api private diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 8a3f7894..1c993223 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -57,7 +57,7 @@ class << self # # @param input [Object] # - # @return [Boolean, Object] + # @return [Boolean] def primitive?(input) case input in true | false | Integer | Float | Symbol | String @@ -627,6 +627,8 @@ def close_fused!(enum) # # @param enum [Enumerable, nil] # @param blk [Proc] + # + # @return [Enumerable] def chain_fused(enum, &blk) iter = Enumerator.new { blk.call(_1) } fused_enum(iter) { close_fused!(enum) } diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index a259092c..29ea6ebf 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -67,6 +67,16 @@ module FinchAPI end def follow_redirect(request, status:, response_headers:) end + + # @api private + sig do + params( + status: T.any(Integer, FinchAPI::APIConnectionError), + stream: T.nilable(T::Enumerable[String]) + ).void + end + def reap_connection!(status, stream:) + end end sig { returns(T.anything) } diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index b6fe9afe..383334ef 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -228,7 +228,7 @@ module FinchAPI # @api private # # All of the specified variant info for this union. - sig { returns(T::Array[[T.nilable(Symbol), Proc]]) } + sig { returns(T::Array[[T.nilable(Symbol), T.proc.returns(Variants)]]) } private def known_variants end @@ -250,17 +250,8 @@ module FinchAPI # @api private sig do params( - key: T.any( - Symbol, - T::Hash[Symbol, T.anything], - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input - ), - spec: T.any( - T::Hash[Symbol, T.anything], - T.proc.returns(FinchAPI::Converter::Input), - FinchAPI::Converter::Input - ) + key: T.any(Symbol, T::Hash[Symbol, T.anything], T.proc.returns(Variants), Variants), + spec: T.any(T::Hash[Symbol, T.anything], T.proc.returns(Variants), Variants) ) .void end @@ -268,7 +259,7 @@ module FinchAPI end # @api private - sig { params(value: T.anything).returns(T.nilable(FinchAPI::Converter::Input)) } + sig { params(value: T.anything).returns(T.nilable(Variants)) } private def resolve_variant(value) end end diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index 622bfc11..a79144a3 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -27,14 +27,14 @@ module FinchAPI end # @api private - sig { params(url: URI::Generic, blk: T.proc.params(arg0: Net::HTTP).void).void } - private def with_pool(url, &blk) + sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void } + private def with_pool(url, deadline:, &blk) end # @api private sig do params(request: FinchAPI::PooledNetRequester::RequestShape) - .returns([Net::HTTPResponse, T::Enumerable[String]]) + .returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) end def execute(request) end diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 4b22187a..70e7d16a 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -22,7 +22,7 @@ module FinchAPI class << self # @api private - sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) } + sig { params(input: T.anything).returns(T::Boolean) } def primitive?(input) end @@ -239,10 +239,8 @@ module FinchAPI # @api private sig do - params( - enum: T.nilable(T::Enumerable[T.anything]), - blk: T.proc.params(arg0: Enumerator::Yielder).void - ).void + params(enum: T.nilable(T::Enumerable[T.anything]), blk: T.proc.params(arg0: Enumerator::Yielder).void) + .returns(T::Enumerable[T.anything]) end def chain_fused(enum, &blk) end diff --git a/sig/finch-api/base_client.rbs b/sig/finch-api/base_client.rbs index 5e504932..5d7182e6 100644 --- a/sig/finch-api/base_client.rbs +++ b/sig/finch-api/base_client.rbs @@ -43,6 +43,11 @@ module FinchAPI response_headers: ::Hash[String, String] ) -> FinchAPI::BaseClient::request_input + def self.reap_connection!: ( + Integer | FinchAPI::APIConnectionError status, + stream: Enumerable[String]? + ) -> void + # @api private attr_accessor requester: top diff --git a/sig/finch-api/base_model.rbs b/sig/finch-api/base_model.rbs index a6674a96..fd2addd3 100644 --- a/sig/finch-api/base_model.rbs +++ b/sig/finch-api/base_model.rbs @@ -85,7 +85,7 @@ module FinchAPI class Union extend FinchAPI::Converter - private def self.known_variants: -> ::Array[[Symbol?, Proc]] + private def self.known_variants: -> ::Array[[Symbol?, (^-> FinchAPI::Converter::input)]] def self.derefed_variants: -> ::Array[[Symbol?, top]] diff --git a/sig/finch-api/pooled_net_requester.rbs b/sig/finch-api/pooled_net_requester.rbs index 71660d52..97041ff3 100644 --- a/sig/finch-api/pooled_net_requester.rbs +++ b/sig/finch-api/pooled_net_requester.rbs @@ -19,11 +19,16 @@ module FinchAPI (String arg0) -> void } -> top - private def with_pool: (URI::Generic url) { (top arg0) -> void } -> void + private def with_pool: ( + URI::Generic url, + deadline: Float + ) { + (top arg0) -> void + } -> void def execute: ( FinchAPI::PooledNetRequester::request request - ) -> [top, Enumerable[String]] + ) -> [Integer, top, Enumerable[String]] def initialize: (size: Integer) -> void end diff --git a/sig/finch-api/util.rbs b/sig/finch-api/util.rbs index ed376006..aac98696 100644 --- a/sig/finch-api/util.rbs +++ b/sig/finch-api/util.rbs @@ -6,7 +6,7 @@ module FinchAPI def self?.os: -> String - def self?.primitive?: (top input) -> (bool | top) + def self?.primitive?: (top input) -> bool def self?.coerce_boolean: (top input) -> (bool | top) @@ -120,7 +120,7 @@ module FinchAPI Enumerable[top]? enum ) { (Enumerator::Yielder arg0) -> void - } -> void + } -> Enumerable[top] type server_sent_event = { event: String?, data: String?, id: String?, retry: Integer? } diff --git a/test/finch-api/client_test.rb b/test/finch-api/client_test.rb index 6ff63ce4..98dc5e4c 100644 --- a/test/finch-api/client_test.rb +++ b/test/finch-api/client_test.rb @@ -11,32 +11,6 @@ def teardown Thread.current.thread_variable_set(:mock_sleep, nil) end - class MockResponse - # @return [Integer] - attr_reader :code - - # @param code [Integer] - # @param headers [Hash{String=>String}] - def initialize(code, headers) - @code = code - @headers = {"content-type" => "application/json", **headers} - end - - # @param header [String] - # - # @return [String, nil] - def [](header) - @headers[header] - end - - # @param header [String] - # - # @return [Boolean] - def key?(header) - @headers.key?(header) - end - end - class MockRequester # @return [Integer] attr_reader :response_code @@ -64,7 +38,8 @@ def initialize(response_code, response_headers, response_data) def execute(req) # Deep copy the request because it is mutated on each retry. attempts.push(Marshal.load(Marshal.dump(req))) - [MockResponse.new(response_code, response_headers), response_data.grapheme_clusters] + headers = {"content-type" => "application/json", **response_headers} + [response_code, headers, response_data.grapheme_clusters] end end diff --git a/test/finch-api/util_test.rb b/test/finch-api/util_test.rb index 8a647c91..969d487e 100644 --- a/test/finch-api/util_test.rb +++ b/test/finch-api/util_test.rb @@ -161,7 +161,9 @@ class FinchAPI::Test::UtilFormDataEncodingTest < Minitest::Test class FakeCGI < CGI def initialize(headers, io) @ctype = headers["content-type"] + # rubocop:disable Lint/EmptyBlock @io = FinchAPI::Util::ReadIOAdapter.new(io) {} + # rubocop:enable Lint/EmptyBlock @c_len = io.to_a.join.bytesize.to_s super() end @@ -217,7 +219,9 @@ def test_copy_read } cases.each do |input, expected| io = StringIO.new + # rubocop:disable Lint/EmptyBlock adapter = FinchAPI::Util::ReadIOAdapter.new(input) {} + # rubocop:enable Lint/EmptyBlock IO.copy_stream(adapter, io) assert_equal(expected, io.string) end From f99868b7b10d354a735276e8f2d5dba226daf35c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 16 Mar 2025 14:28:28 +0000 Subject: [PATCH 39/67] chore: do not label modules as abstract (#42) --- .rubocop.yml | 5 +++++ lib/finch-api/base_model.rb | 2 -- lib/finch-api/base_page.rb | 2 -- lib/finch-api/extern.rb | 2 -- lib/finch-api/request_options.rb | 2 -- rbi/lib/finch-api/base_client.rbi | 1 + rbi/lib/finch-api/base_model.rbi | 13 +++++++++++-- rbi/lib/finch-api/base_page.rbi | 2 -- rbi/lib/finch-api/extern.rbi | 1 - rbi/lib/finch-api/pooled_net_requester.rbi | 1 + rbi/lib/finch-api/request_options.rbi | 2 -- rbi/lib/finch-api/util.rbi | 2 ++ 12 files changed, 20 insertions(+), 15 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 216938a5..78cef3d9 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -58,6 +58,11 @@ Layout/MultilineMethodParameterLineBreaks: Layout/SpaceInsideHashLiteralBraces: EnforcedStyle: no_space +# This option occasionally mangles identifier names +Lint/DeprecatedConstants: + Exclude: + - "**/*.rbi" + # Fairly useful in tests for pattern assertions. Lint/EmptyInPattern: Exclude: diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index 4511a3aa..2526012e 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -2,8 +2,6 @@ module FinchAPI # @api private - # - # @abstract module Converter # rubocop:disable Lint/UnusedMethodArgument diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index ccfd1aba..d3f8bfe2 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -1,8 +1,6 @@ # frozen_string_literal: true module FinchAPI - # @abstract - # # @example # ```ruby # if page.has_next? diff --git a/lib/finch-api/extern.rb b/lib/finch-api/extern.rb index b308b801..ec4b0ef7 100644 --- a/lib/finch-api/extern.rb +++ b/lib/finch-api/extern.rb @@ -2,8 +2,6 @@ module FinchAPI # @api private - # - # @abstract module Extern end end diff --git a/lib/finch-api/request_options.rb b/lib/finch-api/request_options.rb index 2d080426..5488ce4e 100644 --- a/lib/finch-api/request_options.rb +++ b/lib/finch-api/request_options.rb @@ -2,8 +2,6 @@ module FinchAPI # @api private - # - # @abstract module RequestParameters # @!parse # # Options to specify HTTP behaviour for this request. diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index 29ea6ebf..1a84a208 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -1,6 +1,7 @@ # typed: strong module FinchAPI + # @api private class BaseClient abstract! diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 383334ef..cdf51028 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -3,8 +3,6 @@ module FinchAPI # @api private module Converter - abstract! - Input = T.type_alias { T.any(FinchAPI::Converter, T::Class[T.anything]) } # @api private @@ -78,6 +76,8 @@ module FinchAPI end end + # @api private + # # When we don't know what to expect for the value. class Unknown extend FinchAPI::Converter @@ -115,6 +115,8 @@ module FinchAPI end end + # @api private + # # Ruby has no Boolean class; this is something for models to refer to. class BooleanModel extend FinchAPI::Converter @@ -156,6 +158,8 @@ module FinchAPI end end + # @api private + # # A value from among a specified list of options. OpenAPI enum values map to Ruby # values in the SDK as follows: # @@ -217,6 +221,7 @@ module FinchAPI end end + # @api private class Union extend FinchAPI::Converter @@ -294,6 +299,8 @@ module FinchAPI end end + # @api private + # # Array of items of a given type. class ArrayOf include FinchAPI::Converter @@ -359,6 +366,8 @@ module FinchAPI end end + # @api private + # # Hash of items of a given type. class HashOf include FinchAPI::Converter diff --git a/rbi/lib/finch-api/base_page.rbi b/rbi/lib/finch-api/base_page.rbi index 85231cb2..3179fb7e 100644 --- a/rbi/lib/finch-api/base_page.rbi +++ b/rbi/lib/finch-api/base_page.rbi @@ -2,8 +2,6 @@ module FinchAPI module BasePage - abstract! - Elem = type_member(:out) sig { overridable.returns(T::Boolean) } diff --git a/rbi/lib/finch-api/extern.rbi b/rbi/lib/finch-api/extern.rbi index 36a18dd5..f57af343 100644 --- a/rbi/lib/finch-api/extern.rbi +++ b/rbi/lib/finch-api/extern.rbi @@ -3,6 +3,5 @@ module FinchAPI # @api private module Extern - abstract! end end diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index a79144a3..959df620 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -1,6 +1,7 @@ # typed: strong module FinchAPI + # @api private class PooledNetRequester RequestShape = T.type_alias do {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} diff --git a/rbi/lib/finch-api/request_options.rbi b/rbi/lib/finch-api/request_options.rbi index 601763da..57022054 100644 --- a/rbi/lib/finch-api/request_options.rbi +++ b/rbi/lib/finch-api/request_options.rbi @@ -3,8 +3,6 @@ module FinchAPI # @api private module RequestParameters - abstract! - # Options to specify HTTP behaviour for this request. sig { returns(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) } def request_options diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 70e7d16a..8524a5a9 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -160,6 +160,8 @@ module FinchAPI end end + # @api private + # # An adapter that satisfies the IO interface required by `::IO.copy_stream` class ReadIOAdapter # @api private From 10c313ffd786e8640c6dfb1665664157ea9a32a9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 17 Mar 2025 23:46:00 +0000 Subject: [PATCH 40/67] fix: bad documentation url for gemdocs.org (#43) --- README.md | 4 +++- finch-api.gemspec | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c0604ca7..06b45db6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ It is generated with [Stainless](https://www.stainless.com/). ## Documentation -Documentation for the most recent release of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api/latest). +Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api). The underlying REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). @@ -134,6 +134,8 @@ What this means is that while you can use Sorbet to type check your code statica Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `FinchAPI::BaseModel` class, you will need to use the `**` splat operator to pass the arguments: +Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience. + ```ruby model = DirectoryListParams.new diff --git a/finch-api.gemspec b/finch-api.gemspec index 6ab22ac2..36e32e34 100644 --- a/finch-api.gemspec +++ b/finch-api.gemspec @@ -12,7 +12,7 @@ Gem::Specification.new do |s| s.extra_rdoc_files = ["README.md"] s.required_ruby_version = ">= 3.0.0" s.add_dependency "connection_pool" - s.homepage = "https://gemdocs.org/gems/finch-api/latest" + s.homepage = "https://gemdocs.org/gems/finch-api" s.metadata["homepage_uri"] = s.homepage s.metadata["source_code_uri"] = "https://github.com/Finch-API/finch-api-ruby" s.metadata["rubygems_mfa_required"] = "false" From 5b67ef6d68c5d9729c5e1b44dd2b00a05a987342 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 16:32:25 +0000 Subject: [PATCH 41/67] fix(model)!: base model should recursively store coerced base models (#44) --- lib/finch-api/base_model.rb | 25 +++++++++++++++++++++++-- rbi/lib/finch-api/base_model.rbi | 5 +++++ sig/finch-api/base_model.rbs | 2 ++ test/finch-api/base_model_test.rb | 14 ++++++++++++++ 4 files changed, 44 insertions(+), 2 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index 2526012e..eab7fd63 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -898,6 +898,13 @@ def known_fields @known_fields ||= (self < FinchAPI::BaseModel ? superclass.known_fields.dup : {}) end + # @api private + # + # @return [Hash{Symbol=>Symbol}] + def reverse_map + @reverse_map ||= (self < FinchAPI::BaseModel ? superclass.reverse_map.dup : {}) + end + # @api private # # @return [Hash{Symbol=>Hash{Symbol=>Object}}] @@ -941,7 +948,7 @@ def defaults = (@defaults ||= {}) fallback = info[:const] defaults[name_sym] = fallback if required && !info[:nil?] && info.key?(:const) - key = info.fetch(:api_name, name_sym) + key = info[:api_name]&.tap { reverse_map[_1] = name_sym } || name_sym setter = "#{name_sym}=" if known_fields.key?(name_sym) @@ -1198,7 +1205,21 @@ def deconstruct_keys(keys) def initialize(data = {}) case FinchAPI::Util.coerce_hash(data) in Hash => coerced - @data = coerced.transform_keys(&:to_sym) + @data = coerced.to_h do |key, value| + name = key.to_sym + mapped = self.class.reverse_map.fetch(name, name) + type = self.class.fields[mapped]&.fetch(:type) + stored = + case [type, value] + in [Class, Hash] if type <= FinchAPI::BaseModel + type.new(value) + in [FinchAPI::ArrayOf, Array] | [FinchAPI::HashOf, Hash] + type.coerce(value) + else + value + end + [name, stored] + end else raise ArgumentError.new("Expected a #{Hash} or #{FinchAPI::BaseModel}, got #{data.inspect}") end diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index cdf51028..9df4f133 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -457,6 +457,11 @@ module FinchAPI def known_fields end + # @api private + sig { returns(T::Hash[Symbol, Symbol]) } + def reverse_map + end + # @api private sig do returns( diff --git a/sig/finch-api/base_model.rbs b/sig/finch-api/base_model.rbs index fd2addd3..8fff8b16 100644 --- a/sig/finch-api/base_model.rbs +++ b/sig/finch-api/base_model.rbs @@ -176,6 +176,8 @@ module FinchAPI def self.known_fields: -> ::Hash[Symbol, (FinchAPI::BaseModel::known_field & { type_fn: (^-> FinchAPI::Converter::input) })] + def self.reverse_map: -> ::Hash[Symbol, Symbol] + def self.fields: -> ::Hash[Symbol, (FinchAPI::BaseModel::known_field & { type: FinchAPI::Converter::input })] diff --git a/test/finch-api/base_model_test.rb b/test/finch-api/base_model_test.rb index a95f1c32..79633c7a 100644 --- a/test/finch-api/base_model_test.rb +++ b/test/finch-api/base_model_test.rb @@ -222,6 +222,20 @@ def test_nested_model_dump end end + class M4 < M2 + required :c, M1 + required :d, FinchAPI::ArrayOf[M4] + required :e, M2, api_name: :f + end + + def test_model_to_h + model = M4.new(a: "wow", c: {}, d: [{}, 2, {c: {}}], f: {}) + assert_pattern do + model.to_h => {a: "wow", c: M1, d: [M4, 2, M4 => child], f: M2} + assert_equal({c: M1.new}, child.to_h) + end + end + A3 = FinchAPI::ArrayOf[A1] class M3 < M1 From 2dce5e92fca8b7a9f70ddee082390d0fbb470d21 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 19:21:49 +0000 Subject: [PATCH 42/67] chore: ignore some spurious linter warnings and formatting changes (#45) --- .rubocop.yml | 4 +++ finch-api.gemspec | 2 +- lib/finch-api/base_page.rb | 4 +++ lib/finch-api/util.rb | 2 ++ rbi/lib/finch-api/base_model.rbi | 36 +++++++++++++++++++++++--- rbi/lib/finch-api/individuals_page.rbi | 4 +++ rbi/lib/finch-api/page.rbi | 4 +++ rbi/lib/finch-api/responses_page.rbi | 4 +++ rbi/lib/finch-api/single_page.rbi | 4 +++ sig/finch-api/base_model.rbs | 14 ++++++++++ sig/finch-api/individuals_page.rbs | 2 ++ sig/finch-api/page.rbs | 2 ++ sig/finch-api/responses_page.rbs | 2 ++ sig/finch-api/single_page.rbs | 2 ++ 14 files changed, 81 insertions(+), 5 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 78cef3d9..be0f4daa 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -10,6 +10,10 @@ AllCops: SuggestExtensions: false TargetRubyVersion: 3.1.0 +# Whether MFA is required or not should be left to the token configuration +Gemspec/RequireMFA: + Enabled: false + # Don't require this extra line break, it can be excessive. Layout/EmptyLineAfterGuardClause: Enabled: false diff --git a/finch-api.gemspec b/finch-api.gemspec index 36e32e34..e3cc699a 100644 --- a/finch-api.gemspec +++ b/finch-api.gemspec @@ -15,5 +15,5 @@ Gem::Specification.new do |s| s.homepage = "https://gemdocs.org/gems/finch-api" s.metadata["homepage_uri"] = s.homepage s.metadata["source_code_uri"] = "https://github.com/Finch-API/finch-api-ruby" - s.metadata["rubygems_mfa_required"] = "false" + s.metadata["rubygems_mfa_required"] = false.to_s end diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index d3f8bfe2..5605647e 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -28,6 +28,8 @@ module FinchAPI # access_tokens => Array # ``` module BasePage + # rubocop:disable Lint/UnusedMethodArgument + # @return [Boolean] def next_page? = (raise NotImplementedError) @@ -56,5 +58,7 @@ def initialize(client:, req:, headers:, page_data:) @req = req super() end + + # rubocop:enable Lint/UnusedMethodArgument end end diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 1c993223..5f5e48af 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -452,6 +452,7 @@ def string_io(&blk) end class << self + # rubocop:disable Naming/MethodParameterName # @api private # # @param y [Enumerator::Yielder] @@ -489,6 +490,7 @@ class << self end y << "\r\n" end + # rubocop:enable Naming/MethodParameterName # @api private # diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 9df4f133..8f9ae6a8 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -310,6 +310,20 @@ module FinchAPI Elem = type_member(:out) + sig(:final) do + params( + type_info: T.any( + T::Hash[Symbol, T.anything], + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ), + spec: T::Hash[Symbol, T.anything] + ) + .returns(T.attached_class) + end + def self.[](type_info, spec = {}) + end + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ===(other) end @@ -360,9 +374,9 @@ module FinchAPI ), spec: T::Hash[Symbol, T.anything] ) - .returns(T.attached_class) + .void end - def self.new(type_info, spec = {}) + def initialize(type_info, spec = {}) end end @@ -377,6 +391,20 @@ module FinchAPI Elem = type_member(:out) + sig(:final) do + params( + type_info: T.any( + T::Hash[Symbol, T.anything], + T.proc.returns(FinchAPI::Converter::Input), + FinchAPI::Converter::Input + ), + spec: T::Hash[Symbol, T.anything] + ) + .returns(T.attached_class) + end + def self.[](type_info, spec = {}) + end + sig(:final) { params(other: T.anything).returns(T::Boolean) } def ===(other) end @@ -427,9 +455,9 @@ module FinchAPI ), spec: T::Hash[Symbol, T.anything] ) - .returns(T.attached_class) + .void end - def self.new(type_info, spec = {}) + def initialize(type_info, spec = {}) end end diff --git a/rbi/lib/finch-api/individuals_page.rbi b/rbi/lib/finch-api/individuals_page.rbi index 068258b8..20ebcd03 100644 --- a/rbi/lib/finch-api/individuals_page.rbi +++ b/rbi/lib/finch-api/individuals_page.rbi @@ -21,5 +21,9 @@ module FinchAPI sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } def paging=(_) end + + sig { returns(String) } + def inspect + end end end diff --git a/rbi/lib/finch-api/page.rbi b/rbi/lib/finch-api/page.rbi index f1a99b06..b759ab95 100644 --- a/rbi/lib/finch-api/page.rbi +++ b/rbi/lib/finch-api/page.rbi @@ -21,5 +21,9 @@ module FinchAPI sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } def paging=(_) end + + sig { returns(String) } + def inspect + end end end diff --git a/rbi/lib/finch-api/responses_page.rbi b/rbi/lib/finch-api/responses_page.rbi index 28e76f9f..9976226d 100644 --- a/rbi/lib/finch-api/responses_page.rbi +++ b/rbi/lib/finch-api/responses_page.rbi @@ -13,5 +13,9 @@ module FinchAPI sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) } def responses=(_) end + + sig { returns(String) } + def inspect + end end end diff --git a/rbi/lib/finch-api/single_page.rbi b/rbi/lib/finch-api/single_page.rbi index 54ae37cb..cc98a43f 100644 --- a/rbi/lib/finch-api/single_page.rbi +++ b/rbi/lib/finch-api/single_page.rbi @@ -17,5 +17,9 @@ module FinchAPI sig { override.params(blk: T.proc.params(arg0: Elem).void).void } def auto_paging_each(&blk) end + + sig { returns(String) } + def inspect + end end end diff --git a/sig/finch-api/base_model.rbs b/sig/finch-api/base_model.rbs index 8fff8b16..d352b36b 100644 --- a/sig/finch-api/base_model.rbs +++ b/sig/finch-api/base_model.rbs @@ -121,6 +121,13 @@ module FinchAPI class ArrayOf[Elem] include FinchAPI::Converter + def self.[]: ( + ::Hash[Symbol, top] + | ^-> FinchAPI::Converter::input + | FinchAPI::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> instance + def ===: (top other) -> bool def ==: (top other) -> bool @@ -146,6 +153,13 @@ module FinchAPI class HashOf[Elem] include FinchAPI::Converter + def self.[]: ( + ::Hash[Symbol, top] + | ^-> FinchAPI::Converter::input + | FinchAPI::Converter::input type_info, + ?::Hash[Symbol, top] spec + ) -> instance + def ===: (top other) -> bool def ==: (top other) -> bool diff --git a/sig/finch-api/individuals_page.rbs b/sig/finch-api/individuals_page.rbs index 9511ea73..410416e8 100644 --- a/sig/finch-api/individuals_page.rbs +++ b/sig/finch-api/individuals_page.rbs @@ -5,5 +5,7 @@ module FinchAPI attr_accessor individuals: ::Array[Elem]? attr_accessor paging: FinchAPI::Models::Paging + + def inspect: -> String end end diff --git a/sig/finch-api/page.rbs b/sig/finch-api/page.rbs index 6f0d3d18..4da9a16c 100644 --- a/sig/finch-api/page.rbs +++ b/sig/finch-api/page.rbs @@ -5,5 +5,7 @@ module FinchAPI attr_accessor data: ::Array[Elem]? attr_accessor paging: FinchAPI::Models::Paging + + def inspect: -> String end end diff --git a/sig/finch-api/responses_page.rbs b/sig/finch-api/responses_page.rbs index 9c7bf073..ed66e5c0 100644 --- a/sig/finch-api/responses_page.rbs +++ b/sig/finch-api/responses_page.rbs @@ -3,5 +3,7 @@ module FinchAPI include FinchAPI::BasePage[Elem] attr_accessor responses: ::Array[Elem]? + + def inspect: -> String end end diff --git a/sig/finch-api/single_page.rbs b/sig/finch-api/single_page.rbs index 8db70e39..80e999db 100644 --- a/sig/finch-api/single_page.rbs +++ b/sig/finch-api/single_page.rbs @@ -7,5 +7,7 @@ module FinchAPI def next_page: -> self def auto_paging_each: { (Elem arg0) -> void } -> void + + def inspect: -> String end end From 24aba192cb119c823905ee9296f65870ce697aa5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 20:24:40 +0000 Subject: [PATCH 43/67] chore: document Client's concurrency capability (#46) --- README.md | 12 ++++++++++++ lib/finch-api/pooled_net_requester.rb | 9 ++++++++- lib/finch-api/util.rb | 17 ++++++++++------- rbi/lib/finch-api/base_client.rbi | 1 + rbi/lib/finch-api/pooled_net_requester.rbi | 4 ++++ rbi/lib/finch-api/util.rbi | 5 +++++ sig/finch-api/pooled_net_requester.rbs | 2 ++ 7 files changed, 42 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 06b45db6..ad7e0ad9 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,18 @@ model = DirectoryListParams.new finch.hris.directory.list(**model) ``` +## Advanced + +### Concurrency & Connection Pooling + +The `FinchAPI::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count. + +When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout. + +Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure. + +Currently, `FinchAPI::Client` instances are only fork-safe if there are no in-flight HTTP requests. + ## Versioning This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time. diff --git a/lib/finch-api/pooled_net_requester.rb b/lib/finch-api/pooled_net_requester.rb index b9d9d1ca..e22138f2 100644 --- a/lib/finch-api/pooled_net_requester.rb +++ b/lib/finch-api/pooled_net_requester.rb @@ -3,6 +3,10 @@ module FinchAPI # @api private class PooledNetRequester + # from the golang stdlib + # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 + KEEP_ALIVE_TIMEOUT = 30 + class << self # @api private # @@ -124,7 +128,10 @@ def execute(request) end self.class.calibrate_socket_timeout(conn, deadline) - conn.start unless conn.started? + unless conn.started? + conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT + conn.start + end self.class.calibrate_socket_timeout(conn, deadline) conn.request(req) do |rsp| diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 5f5e48af..2cbbaf02 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -367,13 +367,14 @@ class << self # @return [Hash{String=>String}] def normalized_headers(*headers) {}.merge(*headers.compact).to_h do |key, val| - case val - in Array - val.map { _1.to_s.strip }.join(", ") - else - val&.to_s&.strip - end - [key.downcase, val] + value = + case val + in Array + val.map { _1.to_s.strip }.join(", ") + else + val&.to_s&.strip + end + [key.downcase, value] end end end @@ -453,6 +454,7 @@ def string_io(&blk) class << self # rubocop:disable Naming/MethodParameterName + # @api private # # @param y [Enumerator::Yielder] @@ -490,6 +492,7 @@ class << self end y << "\r\n" end + # rubocop:enable Naming/MethodParameterName # @api private diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index 1a84a208..bb2ee6c7 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -40,6 +40,7 @@ module FinchAPI } end + # from whatwg fetch spec MAX_REDIRECTS = 20 PLATFORM_HEADERS = T::Hash[String, String] diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index 959df620..d40190e3 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -7,6 +7,10 @@ module FinchAPI {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} end + # from the golang stdlib + # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 + KEEP_ALIVE_TIMEOUT = 30 + class << self # @api private sig { params(url: URI::Generic).returns(Net::HTTP) } diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 8524a5a9..f1c4ffc3 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -52,6 +52,11 @@ module FinchAPI end end + # Use this to indicate that a value should be explicitly removed from a data + # structure when using `FinchAPI::Util.deep_merge`. + # + # e.g. merging `{a: 1}` and `{a: OMIT}` should produce `{}`, where merging + # `{a: 1}` and `{}` would produce `{a: 1}`. OMIT = T.let(T.anything, T.anything) class << self diff --git a/sig/finch-api/pooled_net_requester.rbs b/sig/finch-api/pooled_net_requester.rbs index 97041ff3..5b786695 100644 --- a/sig/finch-api/pooled_net_requester.rbs +++ b/sig/finch-api/pooled_net_requester.rbs @@ -9,6 +9,8 @@ module FinchAPI deadline: Float } + KEEP_ALIVE_TIMEOUT: 30 + def self.connect: (URI::Generic url) -> top def self.calibrate_socket_timeout: (top conn, Float deadline) -> void From 50e9efea70eb91f9cb8fb1e39205ca16009fefcc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 22:59:21 +0000 Subject: [PATCH 44/67] chore: disable unnecessary linter rules for sorbet manifests (#47) --- .rubocop.yml | 18 ++++++++++++++++++ sig/finch-api/models/account_update_event.rbs | 8 ++++---- sig/finch-api/models/company_event.rbs | 8 +++++--- sig/finch-api/models/directory_event.rbs | 8 ++++---- sig/finch-api/models/employment_event.rbs | 8 ++++---- sig/finch-api/models/individual_event.rbs | 8 ++++---- sig/finch-api/models/job_completion_event.rbs | 8 ++++---- sig/finch-api/models/pay_statement_event.rbs | 8 ++++---- sig/finch-api/models/payment_event.rbs | 8 ++++---- 9 files changed, 51 insertions(+), 31 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index be0f4daa..0ef8802a 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -83,6 +83,12 @@ Lint/UnusedMethodArgument: Metrics/AbcSize: Enabled: false +Metrics/BlockLength: + AllowedPatterns: + - assert_pattern + Exclude: + - "**/*.rbi" + Metrics/ClassLength: Enabled: false @@ -92,6 +98,10 @@ Metrics/CyclomaticComplexity: Metrics/MethodLength: Enabled: false +Metrics/ModuleLength: + Exclude: + - "**/*.rbi" + Metrics/ParameterLists: Enabled: false @@ -102,10 +112,18 @@ Naming/BlockForwarding: Exclude: - "**/*.rbi" +Naming/ClassAndModuleCamelCase: + Exclude: + - "**/*.rbi" + Naming/MethodParameterName: Exclude: - "**/*.rbi" +Naming/PredicateName: + Exclude: + - "**/*.rbi" + Naming/VariableNumber: Enabled: false diff --git a/sig/finch-api/models/account_update_event.rbs b/sig/finch-api/models/account_update_event.rbs index 9e10be9e..938ff57e 100644 --- a/sig/finch-api/models/account_update_event.rbs +++ b/sig/finch-api/models/account_update_event.rbs @@ -7,16 +7,16 @@ module FinchAPI } class AccountUpdateEvent < FinchAPI::Models::BaseWebhookEvent - attr_reader data: FinchAPI::Models::AccountUpdateEvent::Data? + def data: -> FinchAPI::Models::AccountUpdateEvent::Data? def data=: ( - FinchAPI::Models::AccountUpdateEvent::Data + FinchAPI::Models::AccountUpdateEvent::Data _ ) -> FinchAPI::Models::AccountUpdateEvent::Data - attr_reader event_type: FinchAPI::Models::AccountUpdateEvent::event_type? + def event_type: -> FinchAPI::Models::AccountUpdateEvent::event_type? def event_type=: ( - FinchAPI::Models::AccountUpdateEvent::event_type + FinchAPI::Models::AccountUpdateEvent::event_type _ ) -> FinchAPI::Models::AccountUpdateEvent::event_type def initialize: diff --git a/sig/finch-api/models/company_event.rbs b/sig/finch-api/models/company_event.rbs index 508fd63f..f755caf0 100644 --- a/sig/finch-api/models/company_event.rbs +++ b/sig/finch-api/models/company_event.rbs @@ -7,12 +7,14 @@ module FinchAPI } class CompanyEvent < FinchAPI::Models::BaseWebhookEvent - attr_accessor data: ::Hash[Symbol, top]? + def data: -> ::Hash[Symbol, top]? - attr_reader event_type: FinchAPI::Models::CompanyEvent::event_type? + def data=: (::Hash[Symbol, top]? _) -> ::Hash[Symbol, top]? + + def event_type: -> FinchAPI::Models::CompanyEvent::event_type? def event_type=: ( - FinchAPI::Models::CompanyEvent::event_type + FinchAPI::Models::CompanyEvent::event_type _ ) -> FinchAPI::Models::CompanyEvent::event_type def initialize: diff --git a/sig/finch-api/models/directory_event.rbs b/sig/finch-api/models/directory_event.rbs index 47f64336..c4de39ea 100644 --- a/sig/finch-api/models/directory_event.rbs +++ b/sig/finch-api/models/directory_event.rbs @@ -7,16 +7,16 @@ module FinchAPI } class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent - attr_reader data: FinchAPI::Models::DirectoryEvent::Data? + def data: -> FinchAPI::Models::DirectoryEvent::Data? def data=: ( - FinchAPI::Models::DirectoryEvent::Data + FinchAPI::Models::DirectoryEvent::Data _ ) -> FinchAPI::Models::DirectoryEvent::Data - attr_reader event_type: FinchAPI::Models::DirectoryEvent::event_type? + def event_type: -> FinchAPI::Models::DirectoryEvent::event_type? def event_type=: ( - FinchAPI::Models::DirectoryEvent::event_type + FinchAPI::Models::DirectoryEvent::event_type _ ) -> FinchAPI::Models::DirectoryEvent::event_type def initialize: diff --git a/sig/finch-api/models/employment_event.rbs b/sig/finch-api/models/employment_event.rbs index 5417368d..f2eb986f 100644 --- a/sig/finch-api/models/employment_event.rbs +++ b/sig/finch-api/models/employment_event.rbs @@ -7,16 +7,16 @@ module FinchAPI } class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent - attr_reader data: FinchAPI::Models::EmploymentEvent::Data? + def data: -> FinchAPI::Models::EmploymentEvent::Data? def data=: ( - FinchAPI::Models::EmploymentEvent::Data + FinchAPI::Models::EmploymentEvent::Data _ ) -> FinchAPI::Models::EmploymentEvent::Data - attr_reader event_type: FinchAPI::Models::EmploymentEvent::event_type? + def event_type: -> FinchAPI::Models::EmploymentEvent::event_type? def event_type=: ( - FinchAPI::Models::EmploymentEvent::event_type + FinchAPI::Models::EmploymentEvent::event_type _ ) -> FinchAPI::Models::EmploymentEvent::event_type def initialize: diff --git a/sig/finch-api/models/individual_event.rbs b/sig/finch-api/models/individual_event.rbs index 3a765997..342810c5 100644 --- a/sig/finch-api/models/individual_event.rbs +++ b/sig/finch-api/models/individual_event.rbs @@ -7,16 +7,16 @@ module FinchAPI } class IndividualEvent < FinchAPI::Models::BaseWebhookEvent - attr_reader data: FinchAPI::Models::IndividualEvent::Data? + def data: -> FinchAPI::Models::IndividualEvent::Data? def data=: ( - FinchAPI::Models::IndividualEvent::Data + FinchAPI::Models::IndividualEvent::Data _ ) -> FinchAPI::Models::IndividualEvent::Data - attr_reader event_type: FinchAPI::Models::IndividualEvent::event_type? + def event_type: -> FinchAPI::Models::IndividualEvent::event_type? def event_type=: ( - FinchAPI::Models::IndividualEvent::event_type + FinchAPI::Models::IndividualEvent::event_type _ ) -> FinchAPI::Models::IndividualEvent::event_type def initialize: diff --git a/sig/finch-api/models/job_completion_event.rbs b/sig/finch-api/models/job_completion_event.rbs index fd27ee8a..8d5985bc 100644 --- a/sig/finch-api/models/job_completion_event.rbs +++ b/sig/finch-api/models/job_completion_event.rbs @@ -7,16 +7,16 @@ module FinchAPI } class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent - attr_reader data: FinchAPI::Models::JobCompletionEvent::Data? + def data: -> FinchAPI::Models::JobCompletionEvent::Data? def data=: ( - FinchAPI::Models::JobCompletionEvent::Data + FinchAPI::Models::JobCompletionEvent::Data _ ) -> FinchAPI::Models::JobCompletionEvent::Data - attr_reader event_type: FinchAPI::Models::JobCompletionEvent::event_type? + def event_type: -> FinchAPI::Models::JobCompletionEvent::event_type? def event_type=: ( - FinchAPI::Models::JobCompletionEvent::event_type + FinchAPI::Models::JobCompletionEvent::event_type _ ) -> FinchAPI::Models::JobCompletionEvent::event_type def initialize: diff --git a/sig/finch-api/models/pay_statement_event.rbs b/sig/finch-api/models/pay_statement_event.rbs index d63c7ee0..af41866d 100644 --- a/sig/finch-api/models/pay_statement_event.rbs +++ b/sig/finch-api/models/pay_statement_event.rbs @@ -7,16 +7,16 @@ module FinchAPI } class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent - attr_reader data: FinchAPI::Models::PayStatementEvent::Data? + def data: -> FinchAPI::Models::PayStatementEvent::Data? def data=: ( - FinchAPI::Models::PayStatementEvent::Data + FinchAPI::Models::PayStatementEvent::Data _ ) -> FinchAPI::Models::PayStatementEvent::Data - attr_reader event_type: FinchAPI::Models::PayStatementEvent::event_type? + def event_type: -> FinchAPI::Models::PayStatementEvent::event_type? def event_type=: ( - FinchAPI::Models::PayStatementEvent::event_type + FinchAPI::Models::PayStatementEvent::event_type _ ) -> FinchAPI::Models::PayStatementEvent::event_type def initialize: diff --git a/sig/finch-api/models/payment_event.rbs b/sig/finch-api/models/payment_event.rbs index cd15675a..01042f53 100644 --- a/sig/finch-api/models/payment_event.rbs +++ b/sig/finch-api/models/payment_event.rbs @@ -7,16 +7,16 @@ module FinchAPI } class PaymentEvent < FinchAPI::Models::BaseWebhookEvent - attr_reader data: FinchAPI::Models::PaymentEvent::Data? + def data: -> FinchAPI::Models::PaymentEvent::Data? def data=: ( - FinchAPI::Models::PaymentEvent::Data + FinchAPI::Models::PaymentEvent::Data _ ) -> FinchAPI::Models::PaymentEvent::Data - attr_reader event_type: FinchAPI::Models::PaymentEvent::event_type? + def event_type: -> FinchAPI::Models::PaymentEvent::event_type? def event_type=: ( - FinchAPI::Models::PaymentEvent::event_type + FinchAPI::Models::PaymentEvent::event_type _ ) -> FinchAPI::Models::PaymentEvent::event_type def initialize: From 07be5719c8710e6b876ae13593daf13d744800ee Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 18 Mar 2025 23:19:32 +0000 Subject: [PATCH 45/67] chore: add `@yieldparam` to yard doc (#48) --- lib/finch-api/pooled_net_requester.rb | 4 ++++ lib/finch-api/util.rb | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/lib/finch-api/pooled_net_requester.rb b/lib/finch-api/pooled_net_requester.rb index e22138f2..b0f9134e 100644 --- a/lib/finch-api/pooled_net_requester.rb +++ b/lib/finch-api/pooled_net_requester.rb @@ -51,6 +51,7 @@ def calibrate_socket_timeout(conn, deadline) # # @param blk [Proc] # + # @yieldparam [String] # @return [Net::HTTPGenericRequest] def build_request(request, &) method, url, headers, body = request.fetch_values(:method, :url, :headers, :body) @@ -86,6 +87,9 @@ def build_request(request, &) # @param url [URI::Generic] # @param deadline [Float] # @param blk [Proc] + # + # @raise [Timeout::Error] + # @yieldparam [Net::HTTP] private def with_pool(url, deadline:, &blk) origin = FinchAPI::Util.uri_origin(url) timeout = deadline - FinchAPI::Util.monotonic_secs diff --git a/lib/finch-api/util.rb b/lib/finch-api/util.rb index 2cbbaf02..ae602709 100644 --- a/lib/finch-api/util.rb +++ b/lib/finch-api/util.rb @@ -429,6 +429,8 @@ def read(max_len = nil, out_string = nil) # # @param stream [String, IO, StringIO, Enumerable] # @param blk [Proc] + # + # @yieldparam [String] def initialize(stream, &blk) @stream = stream.is_a?(String) ? StringIO.new(stream) : stream @buf = String.new.b @@ -439,6 +441,7 @@ def initialize(stream, &blk) class << self # @param blk [Proc] # + # @yieldparam [Enumerator::Yielder] # @return [Enumerable] def string_io(&blk) Enumerator.new do |y| @@ -633,6 +636,7 @@ def close_fused!(enum) # @param enum [Enumerable, nil] # @param blk [Proc] # + # @yieldparam [Enumerator::Yielder] # @return [Enumerable] def chain_fused(enum, &blk) iter = Enumerator.new { blk.call(_1) } From 96c2c73fa1e7994dffdbeabafee3c8dc93c0a46d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 00:05:51 +0000 Subject: [PATCH 46/67] chore: use multi-line formatting style for really long lines (#49) --- lib/finch-api/base_client.rb | 17 ++--- lib/finch-api/base_page.rb | 3 +- lib/finch-api/individuals_page.rb | 3 +- lib/finch-api/models/hris/w42020.rb | 3 +- .../jobs/configuration_retrieve_response.rb | 3 +- lib/finch-api/page.rb | 3 +- .../resources/hris/benefits/individuals.rb | 3 +- lib/finch-api/responses_page.rb | 3 +- lib/finch-api/single_page.rb | 3 +- rbi/lib/finch-api/base_client.rbi | 68 ++++++++++--------- .../hris/document_retreive_response.rbi | 3 +- rbi/lib/finch-api/models/hris/w42020.rbi | 3 +- .../jobs/configuration_retrieve_response.rbi | 3 +- rbi/lib/finch-api/models/webhook_event.rbi | 29 ++++---- rbi/lib/finch-api/pooled_net_requester.rbi | 13 +++- rbi/lib/finch-api/util.rbi | 26 +++---- test/finch-api/client_test.rb | 35 +++------- .../resources/jobs/automated_test.rb | 6 +- .../resources/sandbox/company_test.rb | 21 +++--- .../sandbox/connections/accounts_test.rb | 9 +-- 20 files changed, 133 insertions(+), 124 deletions(-) diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index ffb87ccc..be06074a 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -9,14 +9,15 @@ class BaseClient MAX_REDIRECTS = 20 # rubocop:disable Style/MutableConstant - PLATFORM_HEADERS = { - "x-stainless-arch" => FinchAPI::Util.arch, - "x-stainless-lang" => "ruby", - "x-stainless-os" => FinchAPI::Util.os, - "x-stainless-package-version" => FinchAPI::VERSION, - "x-stainless-runtime" => ::RUBY_ENGINE, - "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION - } + PLATFORM_HEADERS = + { + "x-stainless-arch" => FinchAPI::Util.arch, + "x-stainless-lang" => "ruby", + "x-stainless-os" => FinchAPI::Util.os, + "x-stainless-package-version" => FinchAPI::VERSION, + "x-stainless-runtime" => ::RUBY_ENGINE, + "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION + } # rubocop:enable Style/MutableConstant class << self diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index 5605647e..751dbb94 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -17,7 +17,8 @@ module FinchAPI # # @example # ```ruby - # access_tokens = page + # access_tokens = + # page # .to_enum # .lazy # .select { _1.object_id.even? } diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index 71f8ca4c..0fde1397 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -17,7 +17,8 @@ module FinchAPI # # @example # ```ruby - # directories = individuals_page + # directories = + # individuals_page # .to_enum # .lazy # .select { _1.object_id.even? } diff --git a/lib/finch-api/models/hris/w42020.rb b/lib/finch-api/models/hris/w42020.rb index 7f0e1926..961f0085 100644 --- a/lib/finch-api/models/hris/w42020.rb +++ b/lib/finch-api/models/hris/w42020.rb @@ -129,7 +129,8 @@ class Data < FinchAPI::BaseModel # The individual's filing status for tax purposes. class FilingStatus < FinchAPI::Enum HEAD_OF_HOUSEHOLD = :head_of_household - MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = :married_filing_jointly_or_qualifying_surviving_spouse + MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = + :married_filing_jointly_or_qualifying_surviving_spouse SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately finalize! diff --git a/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb b/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb index bb2a4b46..185c59dd 100644 --- a/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb +++ b/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rb @@ -4,7 +4,8 @@ module FinchAPI module Models module Sandbox module Jobs - ConfigurationRetrieveResponse = FinchAPI::ArrayOf[-> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration }] + ConfigurationRetrieveResponse = + FinchAPI::ArrayOf[-> { FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration }] end end end diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index 20265698..775f7e60 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -17,7 +17,8 @@ module FinchAPI # # @example # ```ruby - # items = page + # items = + # page # .to_enum # .lazy # .select { _1.object_id.even? } diff --git a/lib/finch-api/resources/hris/benefits/individuals.rb b/lib/finch-api/resources/hris/benefits/individuals.rb index aa01453c..fd91aaee 100644 --- a/lib/finch-api/resources/hris/benefits/individuals.rb +++ b/lib/finch-api/resources/hris/benefits/individuals.rb @@ -62,7 +62,8 @@ def enrolled_ids(benefit_id, params = {}) # # @return [FinchAPI::SinglePage] def retrieve_many_benefits(benefit_id, params = {}) - parsed, options = FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params) + parsed, options = + FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams.dump_request(params) @client.request( method: :get, path: ["employer/benefits/%0s/individuals", benefit_id], diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index c906c80a..74d58fcb 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -17,7 +17,8 @@ module FinchAPI # # @example # ```ruby - # individuals = responses_page + # individuals = + # responses_page # .to_enum # .lazy # .select { _1.object_id.even? } diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index f9b5e5e4..f9c3f98d 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -17,7 +17,8 @@ module FinchAPI # # @example # ```ruby - # payments = single_page + # payments = + # single_page # .to_enum # .lazy # .select { _1.object_id.even? } diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index bb2ee6c7..f551692c 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -5,40 +5,42 @@ module FinchAPI class BaseClient abstract! - RequestComponentsShape = T.type_alias do - { - method: Symbol, - path: T.any(String, T::Array[String]), - query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]), - headers: T.nilable( - T::Hash[String, - T.nilable( - T.any( - String, - Integer, - T::Array[T.nilable(T.any(String, Integer))] - ) - )] - ), - body: T.nilable(T.anything), - unwrap: T.nilable(Symbol), - page: T.nilable(T::Class[FinchAPI::BasePage[FinchAPI::BaseModel]]), - stream: T.nilable(T::Class[T.anything]), - model: T.nilable(FinchAPI::Converter::Input), - options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - } - end + RequestComponentsShape = + T.type_alias do + { + method: Symbol, + path: T.any(String, T::Array[String]), + query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]), + headers: T.nilable( + T::Hash[String, + T.nilable( + T.any( + String, + Integer, + T::Array[T.nilable(T.any(String, Integer))] + ) + )] + ), + body: T.nilable(T.anything), + unwrap: T.nilable(Symbol), + page: T.nilable(T::Class[FinchAPI::BasePage[FinchAPI::BaseModel]]), + stream: T.nilable(T::Class[T.anything]), + model: T.nilable(FinchAPI::Converter::Input), + options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + } + end - RequestInputShape = T.type_alias do - { - method: Symbol, - url: URI::Generic, - headers: T::Hash[String, String], - body: T.anything, - max_retries: Integer, - timeout: Float - } - end + RequestInputShape = + T.type_alias do + { + method: Symbol, + url: URI::Generic, + headers: T::Hash[String, String], + body: T.anything, + max_retries: Integer, + timeout: Float + } + end # from whatwg fetch spec MAX_REDIRECTS = 20 diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index ef331e0d..9335209d 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -8,7 +8,8 @@ module FinchAPI class DocumentRetreiveResponse < FinchAPI::Union abstract! - Variants = type_template(:out) { {fixed: T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)} } + Variants = + type_template(:out) { {fixed: T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)} } end end end diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 092c7dd6..24bc47a8 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -169,7 +169,8 @@ module FinchAPI Value = type_template(:out) { {fixed: Symbol} } HEAD_OF_HOUSEHOLD = :head_of_household - MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = :married_filing_jointly_or_qualifying_surviving_spouse + MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = + :married_filing_jointly_or_qualifying_surviving_spouse SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately end end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi index 98458307..16015f80 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi @@ -4,7 +4,8 @@ module FinchAPI module Models module Sandbox module Jobs - ConfigurationRetrieveResponse = T.type_alias { T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration] } + ConfigurationRetrieveResponse = + T.type_alias { T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration] } end end end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index b1a4436a..223b2172 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -5,20 +5,21 @@ module FinchAPI class WebhookEvent < FinchAPI::Union abstract! - Variants = type_template(:out) do - { - fixed: T.any( - FinchAPI::Models::AccountUpdateEvent, - FinchAPI::Models::CompanyEvent, - FinchAPI::Models::JobCompletionEvent, - FinchAPI::Models::DirectoryEvent, - FinchAPI::Models::EmploymentEvent, - FinchAPI::Models::IndividualEvent, - FinchAPI::Models::PaymentEvent, - FinchAPI::Models::PayStatementEvent - ) - } - end + Variants = + type_template(:out) do + { + fixed: T.any( + FinchAPI::Models::AccountUpdateEvent, + FinchAPI::Models::CompanyEvent, + FinchAPI::Models::JobCompletionEvent, + FinchAPI::Models::DirectoryEvent, + FinchAPI::Models::EmploymentEvent, + FinchAPI::Models::IndividualEvent, + FinchAPI::Models::PaymentEvent, + FinchAPI::Models::PayStatementEvent + ) + } + end end end end diff --git a/rbi/lib/finch-api/pooled_net_requester.rbi b/rbi/lib/finch-api/pooled_net_requester.rbi index d40190e3..5ec8a478 100644 --- a/rbi/lib/finch-api/pooled_net_requester.rbi +++ b/rbi/lib/finch-api/pooled_net_requester.rbi @@ -3,9 +3,16 @@ module FinchAPI # @api private class PooledNetRequester - RequestShape = T.type_alias do - {method: Symbol, url: URI::Generic, headers: T::Hash[String, String], body: T.anything, deadline: Float} - end + RequestShape = + T.type_alias do + { + method: Symbol, + url: URI::Generic, + headers: T::Hash[String, String], + body: T.anything, + deadline: Float + } + end # from the golang stdlib # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index f1c4ffc3..4281805b 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -123,15 +123,16 @@ module FinchAPI end end - ParsedUriShape = T.type_alias do - { - scheme: T.nilable(String), - host: T.nilable(String), - port: T.nilable(Integer), - path: T.nilable(String), - query: T::Hash[String, T::Array[String]] - } - end + ParsedUriShape = + T.type_alias do + { + scheme: T.nilable(String), + host: T.nilable(String), + port: T.nilable(Integer), + path: T.nilable(String), + query: T::Hash[String, T::Array[String]] + } + end class << self # @api private @@ -253,9 +254,10 @@ module FinchAPI end end - ServerSentEvent = T.type_alias do - {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)} - end + ServerSentEvent = + T.type_alias do + {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)} + end class << self # @api private diff --git a/test/finch-api/client_test.rb b/test/finch-api/client_test.rb index 98dc5e4c..f8776415 100644 --- a/test/finch-api/client_test.rb +++ b/test/finch-api/client_test.rb @@ -56,11 +56,8 @@ def test_client_default_request_default_retry_attempts end def test_client_given_request_default_retry_attempts - finch = FinchAPI::Client.new( - base_url: "http://localhost:4010", - access_token: "My Access Token", - max_retries: 3 - ) + finch = + FinchAPI::Client.new(base_url: "http://localhost:4010", access_token: "My Access Token", max_retries: 3) requester = MockRequester.new(500, {}, {}) finch.requester = requester @@ -84,11 +81,8 @@ def test_client_default_request_given_retry_attempts end def test_client_given_request_given_retry_attempts - finch = FinchAPI::Client.new( - base_url: "http://localhost:4010", - access_token: "My Access Token", - max_retries: 3 - ) + finch = + FinchAPI::Client.new(base_url: "http://localhost:4010", access_token: "My Access Token", max_retries: 3) requester = MockRequester.new(500, {}, {}) finch.requester = requester @@ -100,11 +94,8 @@ def test_client_given_request_given_retry_attempts end def test_client_retry_after_seconds - finch = FinchAPI::Client.new( - base_url: "http://localhost:4010", - access_token: "My Access Token", - max_retries: 1 - ) + finch = + FinchAPI::Client.new(base_url: "http://localhost:4010", access_token: "My Access Token", max_retries: 1) requester = MockRequester.new(500, {"retry-after" => "1.3"}, {}) finch.requester = requester @@ -117,11 +108,8 @@ def test_client_retry_after_seconds end def test_client_retry_after_date - finch = FinchAPI::Client.new( - base_url: "http://localhost:4010", - access_token: "My Access Token", - max_retries: 1 - ) + finch = + FinchAPI::Client.new(base_url: "http://localhost:4010", access_token: "My Access Token", max_retries: 1) requester = MockRequester.new(500, {"retry-after" => (Time.now + 10).httpdate}, {}) finch.requester = requester @@ -136,11 +124,8 @@ def test_client_retry_after_date end def test_client_retry_after_ms - finch = FinchAPI::Client.new( - base_url: "http://localhost:4010", - access_token: "My Access Token", - max_retries: 1 - ) + finch = + FinchAPI::Client.new(base_url: "http://localhost:4010", access_token: "My Access Token", max_retries: 1) requester = MockRequester.new(500, {"retry-after-ms" => "1300"}, {}) finch.requester = requester diff --git a/test/finch-api/resources/jobs/automated_test.rb b/test/finch-api/resources/jobs/automated_test.rb index a7b47234..22538498 100644 --- a/test/finch-api/resources/jobs/automated_test.rb +++ b/test/finch-api/resources/jobs/automated_test.rb @@ -4,10 +4,8 @@ class FinchAPI::Test::Resources::Jobs::AutomatedTest < FinchAPI::Test::ResourceTest def test_create_required_params - response = @finch.jobs.automated.create( - params: {individual_id: "individual_id"}, - type: :w4_form_employee_sync - ) + response = + @finch.jobs.automated.create(params: {individual_id: "individual_id"}, type: :w4_form_employee_sync) assert_pattern do response => FinchAPI::Models::Jobs::AutomatedCreateResponse diff --git a/test/finch-api/resources/sandbox/company_test.rb b/test/finch-api/resources/sandbox/company_test.rb index 3727b65f..cc9980ef 100644 --- a/test/finch-api/resources/sandbox/company_test.rb +++ b/test/finch-api/resources/sandbox/company_test.rb @@ -4,16 +4,17 @@ class FinchAPI::Test::Resources::Sandbox::CompanyTest < FinchAPI::Test::ResourceTest def test_update_required_params - response = @finch.sandbox.company.update( - accounts: [{}], - departments: [{}], - ein: "ein", - entity: {}, - legal_name: "legal_name", - locations: [{}], - primary_email: "primary_email", - primary_phone_number: "primary_phone_number" - ) + response = + @finch.sandbox.company.update( + accounts: [{}], + departments: [{}], + ein: "ein", + entity: {}, + legal_name: "legal_name", + locations: [{}], + primary_email: "primary_email", + primary_phone_number: "primary_phone_number" + ) assert_pattern do response => FinchAPI::Models::Sandbox::CompanyUpdateResponse diff --git a/test/finch-api/resources/sandbox/connections/accounts_test.rb b/test/finch-api/resources/sandbox/connections/accounts_test.rb index 16ed49d7..7f92b645 100644 --- a/test/finch-api/resources/sandbox/connections/accounts_test.rb +++ b/test/finch-api/resources/sandbox/connections/accounts_test.rb @@ -4,10 +4,11 @@ class FinchAPI::Test::Resources::Sandbox::Connections::AccountsTest < FinchAPI::Test::ResourceTest def test_create_required_params - response = @finch.sandbox.connections.accounts.create( - company_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", - provider_id: "provider_id" - ) + response = + @finch.sandbox.connections.accounts.create( + company_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", + provider_id: "provider_id" + ) assert_pattern do response => FinchAPI::Models::Sandbox::Connections::AccountCreateResponse From bb6381194d39b2794921cea5c885be5157bd1163 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 01:52:54 +0000 Subject: [PATCH 47/67] chore(internal): add sorbet config for SDK local development (#50) --- .gitignore | 9 +++++---- .solargraph.yml | 9 +++++++++ Rakefile | 2 +- sorbet/config | 2 ++ 4 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 .solargraph.yml create mode 100644 sorbet/config diff --git a/.gitignore b/.gitignore index 1ef280e1..8b1228a8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,10 @@ -.prism.log +*.gem .idea/ +.prism.log .ruby-lsp/ .yardoc/ -doc/ -sorbet/ Brewfile.lock.json bin/tapioca -*.gem +doc/ +sorbet/* +!/sorbet/config diff --git a/.solargraph.yml b/.solargraph.yml new file mode 100644 index 00000000..a3c55228 --- /dev/null +++ b/.solargraph.yml @@ -0,0 +1,9 @@ +--- +max_files: 0 +include: + - '*.gemspec' + - '/test/finch-api/test_helper.rb' + - 'Rakefile' + - 'lib/**/*.rb' +exclude: + - 'rbi/**/*' diff --git a/Rakefile b/Rakefile index 062fd055..109f6750 100644 --- a/Rakefile +++ b/Rakefile @@ -70,7 +70,7 @@ multitask(:steep) do end multitask(:sorbet) do - sh(*%w[srb typecheck -- .], chdir: "./rbi") + sh(*%w[srb typecheck]) end file("sorbet/tapioca") do diff --git a/sorbet/config b/sorbet/config new file mode 100644 index 00000000..538c1528 --- /dev/null +++ b/sorbet/config @@ -0,0 +1,2 @@ +--dir=rbi +--ignore=test/ From f7dbdf7c341bd6622b5caa66abc010218ff7669b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 17:15:49 +0000 Subject: [PATCH 48/67] chore: add example directory (#51) --- .rubocop.yml | 11 ++++++++++- .solargraph.yml | 3 ++- examples/.keep | 4 ++++ 3 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 examples/.keep diff --git a/.rubocop.yml b/.rubocop.yml index 0ef8802a..1eec67fd 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -10,7 +10,7 @@ AllCops: SuggestExtensions: false TargetRubyVersion: 3.1.0 -# Whether MFA is required or not should be left to the token configuration +# Whether MFA is required or not should be left to the token configuration. Gemspec/RequireMFA: Enabled: false @@ -72,6 +72,10 @@ Lint/EmptyInPattern: Exclude: - "test/**/*" +Lint/MissingCopEnableDirective: + Exclude: + - "examples/**/*.rb" + Lint/MissingSuper: Exclude: - "**/*.rbi" @@ -237,3 +241,8 @@ Style/StringLiterals: # Prefer explicit symbols for clarity; you can search for `:the_symbol`. Style/SymbolArray: EnforcedStyle: brackets + +# This option makes examples harder to read for ruby novices. +Style/SymbolProc: + Exclude: + - "examples/**/*.rb" diff --git a/.solargraph.yml b/.solargraph.yml index a3c55228..21a04d80 100644 --- a/.solargraph.yml +++ b/.solargraph.yml @@ -2,8 +2,9 @@ max_files: 0 include: - '*.gemspec' - - '/test/finch-api/test_helper.rb' - 'Rakefile' + - 'examples/**/*.rb' - 'lib/**/*.rb' + - 'test/finch-api/test_helper.rb' exclude: - 'rbi/**/*' diff --git a/examples/.keep b/examples/.keep new file mode 100644 index 00000000..d8c73e93 --- /dev/null +++ b/examples/.keep @@ -0,0 +1,4 @@ +File generated from our OpenAPI spec by Stainless. + +This directory can be used to store example files demonstrating usage of this SDK. +It is ignored by Stainless code generation and its content (other than this keep file) won't be touched. \ No newline at end of file From f2abbe9fb129d81f6b345f522af1ff36a0044786 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 17:25:11 +0000 Subject: [PATCH 49/67] fix: sorbet class aliases are not type aliases (#52) --- rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi | 4 ++-- rbi/lib/finch-api/models/hris/benfit_contribution.rbi | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index a85922d7..5750f265 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -3,8 +3,6 @@ module FinchAPI module Models module HRIS - IndividualBenefit = T.type_alias { Benefits::IndividualBenefit } - module Benefits class IndividualBenefit < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body)) } @@ -151,6 +149,8 @@ module FinchAPI end end end + + IndividualBenefit = Benefits::IndividualBenefit end end end diff --git a/rbi/lib/finch-api/models/hris/benfit_contribution.rbi b/rbi/lib/finch-api/models/hris/benfit_contribution.rbi index 19833876..29f3346f 100644 --- a/rbi/lib/finch-api/models/hris/benfit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benfit_contribution.rbi @@ -3,7 +3,7 @@ module FinchAPI module Models module HRIS - BenfitContribution = T.type_alias { FinchAPI::Models::HRIS::BenefitContribution } + BenfitContribution = FinchAPI::Models::HRIS::BenefitContribution end end end From 66ba5968ed917bc848cb3cb79223cb3f0eb5489a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 17:31:25 +0000 Subject: [PATCH 50/67] fix: label optional keyword arguments in *.rbs type definitions (#53) --- sig/finch-api/base_client.rbs | 28 +- sig/finch-api/client.rbs | 16 +- sig/finch-api/errors.rbs | 34 +- .../models/access_token_create_params.rbs | 8 +- .../models/account_disconnect_params.rbs | 2 +- .../models/account_introspect_params.rbs | 2 +- sig/finch-api/models/account_update_event.rbs | 278 ++++++++--------- sig/finch-api/models/base_webhook_event.rbs | 2 +- sig/finch-api/models/company_event.rbs | 4 +- .../models/connect/session_new_params.rbs | 18 +- .../connect/session_reauthenticate_params.rbs | 8 +- .../models/create_access_token_response.rbs | 4 +- sig/finch-api/models/directory_event.rbs | 6 +- sig/finch-api/models/employment_event.rbs | 6 +- .../models/hris/benefit_contribution.rbs | 4 +- .../models/hris/benefit_create_params.rbs | 8 +- .../hris/benefit_features_and_operations.rbs | 18 +- .../models/hris/benefit_list_params.rbs | 2 +- ...benefit_list_supported_benefits_params.rbs | 2 +- .../models/hris/benefit_retrieve_params.rbs | 2 +- .../models/hris/benefit_update_params.rbs | 5 +- .../hris/benefits/enrolled_individual.rbs | 8 +- .../hris/benefits/individual_benefit.rbs | 16 +- .../individual_enroll_many_params.rbs | 26 +- .../individual_enrolled_ids_params.rbs | 2 +- ...dividual_retrieve_many_benefits_params.rbs | 4 +- .../individual_unenroll_many_params.rbs | 4 +- .../hris/benefits/unenrolled_individual.rbs | 8 +- .../models/hris/benefits_support.rbs | 24 +- sig/finch-api/models/hris/company.rbs | 20 +- .../models/hris/company_retrieve_params.rbs | 2 +- .../directory_list_individuals_params.rbs | 6 +- .../models/hris/directory_list_params.rbs | 6 +- .../models/hris/document_list_params.rbs | 10 +- .../models/hris/document_response.rbs | 10 +- .../models/hris/document_retreive_params.rbs | 2 +- sig/finch-api/models/hris/employment_data.rbs | 50 +-- .../models/hris/employment_data_response.rbs | 6 +- .../hris/employment_retrieve_many_params.rbs | 2 +- sig/finch-api/models/hris/individual.rbs | 34 +- .../models/hris/individual_in_directory.rbs | 18 +- .../models/hris/individual_response.rbs | 6 +- .../hris/individual_retrieve_many_params.rbs | 10 +- sig/finch-api/models/hris/pay_statement.rbs | 82 ++--- .../models/hris/pay_statement_response.rbs | 6 +- .../hris/pay_statement_response_body.rbs | 4 +- .../pay_statement_retrieve_many_params.rbs | 4 +- sig/finch-api/models/hris/payment.rbs | 26 +- .../models/hris/payment_list_params.rbs | 2 +- .../models/hris/support_per_benefit_type.rbs | 4 +- .../models/hris/supported_benefit.rbs | 16 +- sig/finch-api/models/hris/w42005.rbs | 16 +- sig/finch-api/models/hris/w42020.rbs | 22 +- sig/finch-api/models/income.rbs | 8 +- sig/finch-api/models/individual_event.rbs | 6 +- sig/finch-api/models/introspection.rbs | 14 +- sig/finch-api/models/job_completion_event.rbs | 4 +- .../models/jobs/automated_async_job.rbs | 2 +- .../models/jobs/automated_create_params.rbs | 2 +- .../models/jobs/automated_list_params.rbs | 6 +- .../models/jobs/automated_list_response.rbs | 8 +- .../models/jobs/automated_retrieve_params.rbs | 2 +- .../models/jobs/manual_retrieve_params.rbs | 2 +- sig/finch-api/models/location.rbs | 16 +- sig/finch-api/models/money.rbs | 2 +- .../models/operation_support_matrix.rbs | 8 +- sig/finch-api/models/paging.rbs | 2 +- sig/finch-api/models/pay_statement_event.rbs | 6 +- sig/finch-api/models/payment_event.rbs | 4 +- .../models/payroll/pay_group_list_params.rbs | 6 +- .../payroll/pay_group_list_response.rbs | 6 +- .../payroll/pay_group_retrieve_params.rbs | 2 +- sig/finch-api/models/provider.rbs | 293 +++++++++--------- sig/finch-api/models/provider_list_params.rbs | 2 +- .../request_forwarding_forward_params.rbs | 8 +- .../models/sandbox/company_update_params.rbs | 22 +- .../sandbox/company_update_response.rbs | 20 +- .../sandbox/connection_create_params.rbs | 8 +- .../sandbox/connection_create_response.rbs | 2 +- .../connections/account_create_params.rbs | 6 +- .../connections/account_update_params.rbs | 4 +- .../connections/account_update_response.rbs | 2 +- .../sandbox/directory_create_params.rbs | 76 ++--- .../sandbox/employment_update_params.rbs | 48 +-- .../sandbox/employment_update_response.rbs | 48 +-- .../sandbox/individual_update_params.rbs | 34 +- .../sandbox/individual_update_response.rbs | 34 +- .../models/sandbox/job_create_params.rbs | 2 +- .../jobs/configuration_retrieve_params.rbs | 2 +- .../jobs/configuration_update_params.rbs | 2 +- .../models/sandbox/payment_create_params.rbs | 90 +++--- sig/finch-api/pooled_net_requester.rbs | 2 +- sig/finch-api/resources/access_tokens.rbs | 8 +- sig/finch-api/resources/account.rbs | 4 +- sig/finch-api/resources/connect/sessions.rbs | 22 +- sig/finch-api/resources/hris/benefits.rbs | 18 +- .../resources/hris/benefits/individuals.rbs | 14 +- sig/finch-api/resources/hris/company.rbs | 2 +- sig/finch-api/resources/hris/directory.rbs | 6 +- sig/finch-api/resources/hris/documents.rbs | 12 +- sig/finch-api/resources/hris/employments.rbs | 2 +- sig/finch-api/resources/hris/individuals.rbs | 6 +- .../resources/hris/pay_statements.rbs | 2 +- sig/finch-api/resources/hris/payments.rbs | 2 +- sig/finch-api/resources/jobs/automated.rbs | 10 +- sig/finch-api/resources/jobs/manual.rbs | 2 +- .../resources/payroll/pay_groups.rbs | 8 +- sig/finch-api/resources/providers.rbs | 2 +- .../resources/request_forwarding.rbs | 8 +- sig/finch-api/resources/sandbox/company.rbs | 2 +- .../resources/sandbox/connections.rbs | 8 +- .../sandbox/connections/accounts.rbs | 10 +- sig/finch-api/resources/sandbox/directory.rbs | 4 +- .../resources/sandbox/employment.rbs | 38 +-- .../resources/sandbox/individual.rbs | 26 +- sig/finch-api/resources/sandbox/jobs.rbs | 2 +- .../resources/sandbox/jobs/configuration.rbs | 4 +- sig/finch-api/resources/sandbox/payment.rbs | 8 +- sig/finch-api/util.rbs | 10 +- 119 files changed, 986 insertions(+), 978 deletions(-) diff --git a/sig/finch-api/base_client.rbs b/sig/finch-api/base_client.rbs index 5d7182e6..d63a83c0 100644 --- a/sig/finch-api/base_client.rbs +++ b/sig/finch-api/base_client.rbs @@ -53,14 +53,14 @@ module FinchAPI def initialize: ( base_url: String, - timeout: Float, - max_retries: Integer, - initial_retry_delay: Float, - max_retry_delay: Float, - headers: ::Hash[String, (String + ?timeout: Float, + ?max_retries: Integer, + ?initial_retry_delay: Float, + ?max_retry_delay: Float, + ?headers: ::Hash[String, (String | Integer | ::Array[(String | Integer)?])?], - idempotency_header: String? + ?idempotency_header: String? ) -> void private def auth_headers: -> ::Hash[String, String] @@ -88,16 +88,16 @@ module FinchAPI ( Symbol method, String | ::Array[String] path, - query: ::Hash[String, (::Array[String] | String)?]?, - headers: ::Hash[String, (String + ?query: ::Hash[String, (::Array[String] | String)?]?, + ?headers: ::Hash[String, (String | Integer | ::Array[(String | Integer)?])?]?, - body: top?, - unwrap: Symbol?, - page: Class?, - stream: Class?, - model: FinchAPI::Converter::input?, - options: FinchAPI::request_opts? + ?body: top?, + ?unwrap: Symbol?, + ?page: Class?, + ?stream: Class?, + ?model: FinchAPI::Converter::input?, + ?options: FinchAPI::request_opts? ) -> top | (FinchAPI::BaseClient::request_components req) -> top diff --git a/sig/finch-api/client.rbs b/sig/finch-api/client.rbs index 48cde6a1..cb5dfcfe 100644 --- a/sig/finch-api/client.rbs +++ b/sig/finch-api/client.rbs @@ -41,14 +41,14 @@ module FinchAPI private def basic_auth: -> ::Hash[String, String] def initialize: ( - base_url: String?, - access_token: String?, - client_id: String?, - client_secret: String?, - max_retries: Integer, - timeout: Float, - initial_retry_delay: Float, - max_retry_delay: Float + ?base_url: String?, + ?access_token: String?, + ?client_id: String?, + ?client_secret: String?, + ?max_retries: Integer, + ?timeout: Float, + ?initial_retry_delay: Float, + ?max_retry_delay: Float ) -> void end end diff --git a/sig/finch-api/errors.rbs b/sig/finch-api/errors.rbs index 0c5a195f..41e363d8 100644 --- a/sig/finch-api/errors.rbs +++ b/sig/finch-api/errors.rbs @@ -15,33 +15,33 @@ module FinchAPI def initialize: ( url: URI::Generic, - status: Integer?, - body: Object?, - request: nil, - response: nil, - message: String? + ?status: Integer?, + ?body: Object?, + ?request: nil, + ?response: nil, + ?message: String? ) -> void end class APIConnectionError < FinchAPI::APIError def initialize: ( url: URI::Generic, - status: nil, - body: nil, - request: nil, - response: nil, - message: String? + ?status: nil, + ?body: nil, + ?request: nil, + ?response: nil, + ?message: String? ) -> void end class APITimeoutError < FinchAPI::APIConnectionError def initialize: ( url: URI::Generic, - status: nil, - body: nil, - request: nil, - response: nil, - message: String? + ?status: nil, + ?body: nil, + ?request: nil, + ?response: nil, + ?message: String? ) -> void end @@ -52,7 +52,7 @@ module FinchAPI body: Object?, request: nil, response: nil, - message: String? + ?message: String? ) -> instance def initialize: ( @@ -61,7 +61,7 @@ module FinchAPI body: Object?, request: nil, response: nil, - message: String? + ?message: String? ) -> void end diff --git a/sig/finch-api/models/access_token_create_params.rbs b/sig/finch-api/models/access_token_create_params.rbs index 8a2d5ac9..aecbacee 100644 --- a/sig/finch-api/models/access_token_create_params.rbs +++ b/sig/finch-api/models/access_token_create_params.rbs @@ -30,10 +30,10 @@ module FinchAPI def initialize: ( code: String, - client_id: String, - client_secret: String, - redirect_uri: String, - request_options: FinchAPI::request_opts + ?client_id: String, + ?client_secret: String, + ?redirect_uri: String, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::access_token_create_params diff --git a/sig/finch-api/models/account_disconnect_params.rbs b/sig/finch-api/models/account_disconnect_params.rbs index 58661542..10ba6015 100644 --- a/sig/finch-api/models/account_disconnect_params.rbs +++ b/sig/finch-api/models/account_disconnect_params.rbs @@ -7,7 +7,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::account_disconnect_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/account_introspect_params.rbs b/sig/finch-api/models/account_introspect_params.rbs index 278c1428..0b796bbe 100644 --- a/sig/finch-api/models/account_introspect_params.rbs +++ b/sig/finch-api/models/account_introspect_params.rbs @@ -7,7 +7,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::account_introspect_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/account_update_event.rbs b/sig/finch-api/models/account_update_event.rbs index 938ff57e..f8bf6dfa 100644 --- a/sig/finch-api/models/account_update_event.rbs +++ b/sig/finch-api/models/account_update_event.rbs @@ -21,8 +21,8 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::AccountUpdateEvent::Data, - event_type: FinchAPI::Models::AccountUpdateEvent::event_type + ?data: FinchAPI::Models::AccountUpdateEvent::Data, + ?event_type: FinchAPI::Models::AccountUpdateEvent::event_type ) -> void | ( ?FinchAPI::Models::account_update_event | FinchAPI::BaseModel data @@ -73,9 +73,9 @@ module FinchAPI def initialize: ( - benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, - supported_fields: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields?, - type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ + ?benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, + ?supported_fields: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields?, + ?type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::authentication_method @@ -140,13 +140,13 @@ module FinchAPI def initialize: ( - company: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, - directory: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, - employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, - individual: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, - pay_group: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, - pay_statement: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, - payment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment + ?company: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + ?directory: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + ?employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + ?individual: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + ?pay_group: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + ?pay_statement: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + ?payment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::supported_fields @@ -215,15 +215,15 @@ module FinchAPI def initialize: ( - id: bool, - accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, - ein: bool, - entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, - legal_name: bool, - locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, - primary_email: bool, - primary_phone_number: bool + ?id: bool, + ?accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + ?departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + ?ein: bool, + ?entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + ?legal_name: bool, + ?locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + ?primary_email: bool, + ?primary_phone_number: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::company @@ -264,11 +264,11 @@ module FinchAPI def initialize: ( - account_name: bool, - account_number: bool, - account_type: bool, - institution_name: bool, - routing_number: bool + ?account_name: bool, + ?account_number: bool, + ?account_type: bool, + ?institution_name: bool, + ?routing_number: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::accounts @@ -297,8 +297,8 @@ module FinchAPI def initialize: ( - name: bool, - parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ?name: bool, + ?parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::departments @@ -315,7 +315,7 @@ module FinchAPI def name=: (bool) -> bool def initialize: - (name: bool) -> void + (?name: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::parent | FinchAPI::BaseModel data @@ -337,7 +337,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (subtype: bool, type: bool) -> void + (?subtype: bool, ?type: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::entity | FinchAPI::BaseModel data @@ -383,12 +383,12 @@ module FinchAPI def initialize: ( - city: bool, - country: bool, - line1: bool, - line2: bool, - postal_code: bool, - state: bool + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::locations @@ -420,8 +420,8 @@ module FinchAPI def initialize: ( - individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + ?individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + ?paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::directory @@ -474,13 +474,13 @@ module FinchAPI def initialize: ( - id: bool, - department: bool, - first_name: bool, - is_active: bool, - last_name: bool, - manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - middle_name: bool + ?id: bool, + ?department: bool, + ?first_name: bool, + ?is_active: bool, + ?last_name: bool, + ?manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + ?middle_name: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::individuals @@ -497,7 +497,7 @@ module FinchAPI def id=: (bool) -> bool def initialize: - (id: bool) -> void + (?id: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::manager | FinchAPI::BaseModel data @@ -519,7 +519,7 @@ module FinchAPI def offset=: (bool) -> bool def initialize: - (count: bool, offset: bool) -> void + (?count: bool, ?offset: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::paging | FinchAPI::BaseModel data @@ -631,23 +631,23 @@ module FinchAPI def initialize: ( - id: bool, - class_code: bool, - custom_fields: bool, - department: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, - employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, - employment_status: bool, - end_date: bool, - first_name: bool, - income: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, - income_history: bool, - is_active: bool, - last_name: bool, - location: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, - manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, - middle_name: bool, - start_date: bool, - title: bool + ?id: bool, + ?class_code: bool, + ?custom_fields: bool, + ?department: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + ?employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, + ?employment_status: bool, + ?end_date: bool, + ?first_name: bool, + ?income: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, + ?income_history: bool, + ?is_active: bool, + ?last_name: bool, + ?location: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + ?manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, + ?middle_name: bool, + ?start_date: bool, + ?title: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::employment @@ -664,7 +664,7 @@ module FinchAPI def name=: (bool) -> bool def initialize: - (name: bool) -> void + (?name: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::department | FinchAPI::BaseModel data @@ -685,7 +685,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (subtype: bool, type: bool) -> void + (?subtype: bool, ?type: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::employment | FinchAPI::BaseModel data @@ -710,7 +710,7 @@ module FinchAPI def unit=: (bool) -> bool def initialize: - (amount: bool, currency: bool, unit: bool) -> void + (?amount: bool, ?currency: bool, ?unit: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::income | FinchAPI::BaseModel data @@ -756,12 +756,12 @@ module FinchAPI def initialize: ( - city: bool, - country: bool, - line1: bool, - line2: bool, - postal_code: bool, - state: bool + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::location @@ -779,7 +779,7 @@ module FinchAPI def id=: (bool) -> bool def initialize: - (id: bool) -> void + (?id: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::manager | FinchAPI::BaseModel data @@ -867,19 +867,19 @@ module FinchAPI def initialize: ( - id: bool, - dob: bool, - emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, - encrypted_ssn: bool, - ethnicity: bool, - first_name: bool, - gender: bool, - last_name: bool, - middle_name: bool, - phone_numbers: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - preferred_name: bool, - residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, - ssn: bool + ?id: bool, + ?dob: bool, + ?emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + ?encrypted_ssn: bool, + ?ethnicity: bool, + ?first_name: bool, + ?gender: bool, + ?last_name: bool, + ?middle_name: bool, + ?phone_numbers: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + ?preferred_name: bool, + ?residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + ?ssn: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::individual @@ -900,7 +900,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (data: bool, type: bool) -> void + (?data: bool, ?type: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::emails | FinchAPI::BaseModel data @@ -921,7 +921,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (data: bool, type: bool) -> void + (?data: bool, ?type: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::phone_numbers | FinchAPI::BaseModel data @@ -967,12 +967,12 @@ module FinchAPI def initialize: ( - city: bool, - country: bool, - line1: bool, - line2: bool, - postal_code: bool, - state: bool + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::residence @@ -1010,10 +1010,10 @@ module FinchAPI def initialize: ( - id: bool, - individual_ids: bool, - name: bool, - pay_frequencies: bool + ?id: bool, + ?individual_ids: bool, + ?name: bool, + ?pay_frequencies: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_group @@ -1044,8 +1044,8 @@ module FinchAPI def initialize: ( - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ?paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + ?pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_statement @@ -1136,16 +1136,16 @@ module FinchAPI def initialize: ( - earnings: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - employee_deductions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - employer_contributions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - gross_pay: bool, - individual_id: bool, - net_pay: bool, - payment_method: bool, - taxes: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - total_hours: bool, - type: bool + ?earnings: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + ?employee_deductions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + ?employer_contributions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + ?gross_pay: bool, + ?individual_id: bool, + ?net_pay: bool, + ?payment_method: bool, + ?taxes: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + ?total_hours: bool, + ?type: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::pay_statements @@ -1176,10 +1176,10 @@ module FinchAPI def initialize: ( - amount: bool, - currency: bool, - name: bool, - type: bool + ?amount: bool, + ?currency: bool, + ?name: bool, + ?type: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings @@ -1221,11 +1221,11 @@ module FinchAPI def initialize: ( - amount: bool, - currency: bool, - name: bool, - pre_tax: bool, - type: bool + ?amount: bool, + ?currency: bool, + ?name: bool, + ?pre_tax: bool, + ?type: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions @@ -1252,7 +1252,7 @@ module FinchAPI def name=: (bool) -> bool def initialize: - (amount: bool, currency: bool, name: bool) -> void + (?amount: bool, ?currency: bool, ?name: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions | FinchAPI::BaseModel data @@ -1293,11 +1293,11 @@ module FinchAPI def initialize: ( - amount: bool, - currency: bool, - employer: bool, - name: bool, - type: bool + ?amount: bool, + ?currency: bool, + ?employer: bool, + ?name: bool, + ?type: bool ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes @@ -1378,18 +1378,18 @@ module FinchAPI def initialize: ( - id: bool, - company_debit: bool, - debit_date: bool, - employee_taxes: bool, - employer_taxes: bool, - gross_pay: bool, - individual_ids: bool, - net_pay: bool, - pay_date: bool, - pay_frequencies: bool, - pay_group_ids: bool, - pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ?id: bool, + ?company_debit: bool, + ?debit_date: bool, + ?employee_taxes: bool, + ?employer_taxes: bool, + ?gross_pay: bool, + ?individual_ids: bool, + ?net_pay: bool, + ?pay_date: bool, + ?pay_frequencies: bool, + ?pay_group_ids: bool, + ?pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::payment @@ -1410,7 +1410,7 @@ module FinchAPI def start_date=: (bool) -> bool def initialize: - (end_date: bool, start_date: bool) -> void + (?end_date: bool, ?start_date: bool) -> void | ( ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::pay_period | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/base_webhook_event.rbs b/sig/finch-api/models/base_webhook_event.rbs index a7d4c2b9..2f2168cf 100644 --- a/sig/finch-api/models/base_webhook_event.rbs +++ b/sig/finch-api/models/base_webhook_event.rbs @@ -13,7 +13,7 @@ module FinchAPI def connection_id=: (String) -> String def initialize: - (account_id: String, company_id: String, connection_id: String) -> void + (account_id: String, company_id: String, ?connection_id: String) -> void | ( ?FinchAPI::Models::base_webhook_event | FinchAPI::BaseModel data ) -> void diff --git a/sig/finch-api/models/company_event.rbs b/sig/finch-api/models/company_event.rbs index f755caf0..1c2622b9 100644 --- a/sig/finch-api/models/company_event.rbs +++ b/sig/finch-api/models/company_event.rbs @@ -19,8 +19,8 @@ module FinchAPI def initialize: ( - data: ::Hash[Symbol, top]?, - event_type: FinchAPI::Models::CompanyEvent::event_type + ?data: ::Hash[Symbol, top]?, + ?event_type: FinchAPI::Models::CompanyEvent::event_type ) -> void | (?FinchAPI::Models::company_event | FinchAPI::BaseModel data) -> void diff --git a/sig/finch-api/models/connect/session_new_params.rbs b/sig/finch-api/models/connect/session_new_params.rbs index dc87fe43..ef5806b9 100644 --- a/sig/finch-api/models/connect/session_new_params.rbs +++ b/sig/finch-api/models/connect/session_new_params.rbs @@ -42,13 +42,13 @@ module FinchAPI customer_id: String, customer_name: String, products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], - customer_email: String?, - integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, - manual: bool?, - minutes_to_expire: Float?, - redirect_uri: String?, - sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, - request_options: FinchAPI::request_opts + ?customer_email: String?, + ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, + ?manual: bool?, + ?minutes_to_expire: Float?, + ?redirect_uri: String?, + ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Connect::session_new_params @@ -93,8 +93,8 @@ module FinchAPI def initialize: ( - auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?, - provider: String? + ?auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?, + ?provider: String? ) -> void | ( ?FinchAPI::Models::Connect::SessionNewParams::integration diff --git a/sig/finch-api/models/connect/session_reauthenticate_params.rbs b/sig/finch-api/models/connect/session_reauthenticate_params.rbs index bedefb51..efcd0067 100644 --- a/sig/finch-api/models/connect/session_reauthenticate_params.rbs +++ b/sig/finch-api/models/connect/session_reauthenticate_params.rbs @@ -25,10 +25,10 @@ module FinchAPI def initialize: ( connection_id: String, - minutes_to_expire: Integer?, - products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, - redirect_uri: String?, - request_options: FinchAPI::request_opts + ?minutes_to_expire: Integer?, + ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, + ?redirect_uri: String?, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Connect::session_reauthenticate_params diff --git a/sig/finch-api/models/create_access_token_response.rbs b/sig/finch-api/models/create_access_token_response.rbs index d35b63b9..ce7bc367 100644 --- a/sig/finch-api/models/create_access_token_response.rbs +++ b/sig/finch-api/models/create_access_token_response.rbs @@ -47,8 +47,8 @@ module FinchAPI connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type, products: ::Array[String], provider_id: String, - customer_id: String?, - token_type: String + ?customer_id: String?, + ?token_type: String ) -> void | ( ?FinchAPI::Models::create_access_token_response diff --git a/sig/finch-api/models/directory_event.rbs b/sig/finch-api/models/directory_event.rbs index c4de39ea..b3739934 100644 --- a/sig/finch-api/models/directory_event.rbs +++ b/sig/finch-api/models/directory_event.rbs @@ -21,8 +21,8 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::DirectoryEvent::Data, - event_type: FinchAPI::Models::DirectoryEvent::event_type + ?data: FinchAPI::Models::DirectoryEvent::Data, + ?event_type: FinchAPI::Models::DirectoryEvent::event_type ) -> void | ( ?FinchAPI::Models::directory_event | FinchAPI::BaseModel data @@ -38,7 +38,7 @@ module FinchAPI def individual_id=: (String) -> String def initialize: - (individual_id: String) -> void + (?individual_id: String) -> void | ( ?FinchAPI::Models::DirectoryEvent::data | FinchAPI::BaseModel data ) -> void diff --git a/sig/finch-api/models/employment_event.rbs b/sig/finch-api/models/employment_event.rbs index f2eb986f..183fecaf 100644 --- a/sig/finch-api/models/employment_event.rbs +++ b/sig/finch-api/models/employment_event.rbs @@ -21,8 +21,8 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::EmploymentEvent::Data, - event_type: FinchAPI::Models::EmploymentEvent::event_type + ?data: FinchAPI::Models::EmploymentEvent::Data, + ?event_type: FinchAPI::Models::EmploymentEvent::event_type ) -> void | ( ?FinchAPI::Models::employment_event | FinchAPI::BaseModel data @@ -38,7 +38,7 @@ module FinchAPI def individual_id=: (String) -> String def initialize: - (individual_id: String) -> void + (?individual_id: String) -> void | ( ?FinchAPI::Models::EmploymentEvent::data | FinchAPI::BaseModel data ) -> void diff --git a/sig/finch-api/models/hris/benefit_contribution.rbs b/sig/finch-api/models/hris/benefit_contribution.rbs index e1a06a2e..2f4458ab 100644 --- a/sig/finch-api/models/hris/benefit_contribution.rbs +++ b/sig/finch-api/models/hris/benefit_contribution.rbs @@ -14,8 +14,8 @@ module FinchAPI def initialize: ( - amount: Integer?, - type: FinchAPI::Models::HRIS::BenefitContribution::type_? + ?amount: Integer?, + ?type: FinchAPI::Models::HRIS::BenefitContribution::type_? ) -> void | ( ?FinchAPI::Models::HRIS::benefit_contribution diff --git a/sig/finch-api/models/hris/benefit_create_params.rbs b/sig/finch-api/models/hris/benefit_create_params.rbs index eb2e7630..8d6c607c 100644 --- a/sig/finch-api/models/hris/benefit_create_params.rbs +++ b/sig/finch-api/models/hris/benefit_create_params.rbs @@ -23,10 +23,10 @@ module FinchAPI def initialize: ( - description: String, - frequency: FinchAPI::Models::HRIS::benefit_frequency?, - type: FinchAPI::Models::HRIS::benefit_type?, - request_options: FinchAPI::request_opts + ?description: String, + ?frequency: FinchAPI::Models::HRIS::benefit_frequency?, + ?type: FinchAPI::Models::HRIS::benefit_type?, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::benefit_create_params diff --git a/sig/finch-api/models/hris/benefit_features_and_operations.rbs b/sig/finch-api/models/hris/benefit_features_and_operations.rbs index 0e4cbf01..bf8b9a52 100644 --- a/sig/finch-api/models/hris/benefit_features_and_operations.rbs +++ b/sig/finch-api/models/hris/benefit_features_and_operations.rbs @@ -22,8 +22,8 @@ module FinchAPI def initialize: ( - supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType + ?supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, + ?supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType ) -> void | ( ?FinchAPI::Models::HRIS::benefit_features_and_operations @@ -64,13 +64,13 @@ module FinchAPI def initialize: ( - annual_maximum: bool?, - catch_up: bool?, - company_contribution: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, - description: String?, - employee_deduction: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, - frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? + ?annual_maximum: bool?, + ?catch_up: bool?, + ?company_contribution: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, + ?description: String?, + ?employee_deduction: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, + ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], + ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? ) -> void | ( ?FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::supported_features diff --git a/sig/finch-api/models/hris/benefit_list_params.rbs b/sig/finch-api/models/hris/benefit_list_params.rbs index 1f1704f1..cf601eaa 100644 --- a/sig/finch-api/models/hris/benefit_list_params.rbs +++ b/sig/finch-api/models/hris/benefit_list_params.rbs @@ -8,7 +8,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::HRIS::benefit_list_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs b/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs index 7db1f506..32103c70 100644 --- a/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +++ b/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs @@ -9,7 +9,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::HRIS::benefit_list_supported_benefits_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/benefit_retrieve_params.rbs b/sig/finch-api/models/hris/benefit_retrieve_params.rbs index 889acf32..a5611080 100644 --- a/sig/finch-api/models/hris/benefit_retrieve_params.rbs +++ b/sig/finch-api/models/hris/benefit_retrieve_params.rbs @@ -8,7 +8,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::HRIS::benefit_retrieve_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/benefit_update_params.rbs b/sig/finch-api/models/hris/benefit_update_params.rbs index 5cbc2d80..39c2ad01 100644 --- a/sig/finch-api/models/hris/benefit_update_params.rbs +++ b/sig/finch-api/models/hris/benefit_update_params.rbs @@ -13,7 +13,10 @@ module FinchAPI def description=: (String) -> String def initialize: - (description: String, request_options: FinchAPI::request_opts) -> void + ( + ?description: String, + ?request_options: FinchAPI::request_opts + ) -> void | ( ?FinchAPI::Models::HRIS::benefit_update_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs index 7c2dcc61..d7b1b7c1 100644 --- a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +++ b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs @@ -28,9 +28,9 @@ module FinchAPI def initialize: ( - body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, - code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::code, - individual_id: String + ?body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, + ?code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::code, + ?individual_id: String ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::enrolled_individual @@ -49,7 +49,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (finch_code: String?, message: String?, name: String?) -> void + (?finch_code: String?, ?message: String?, ?name: String?) -> void | ( ?FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::body | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/benefits/individual_benefit.rbs b/sig/finch-api/models/hris/benefits/individual_benefit.rbs index f2a37288..fd9fab54 100644 --- a/sig/finch-api/models/hris/benefits/individual_benefit.rbs +++ b/sig/finch-api/models/hris/benefits/individual_benefit.rbs @@ -29,9 +29,9 @@ module FinchAPI def initialize: ( - body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, - code: Integer, - individual_id: String + ?body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, + ?code: Integer, + ?individual_id: String ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::individual_benefit @@ -62,11 +62,11 @@ module FinchAPI def initialize: ( - annual_maximum: Integer?, - catch_up: bool?, - company_contribution: FinchAPI::Models::HRIS::BenefitContribution?, - employee_deduction: FinchAPI::Models::HRIS::BenefitContribution?, - hsa_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? + ?annual_maximum: Integer?, + ?catch_up: bool?, + ?company_contribution: FinchAPI::Models::HRIS::BenefitContribution?, + ?employee_deduction: FinchAPI::Models::HRIS::BenefitContribution?, + ?hsa_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::IndividualBenefit::body diff --git a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs index a2e16d68..64ec016a 100644 --- a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs @@ -20,8 +20,8 @@ module FinchAPI def initialize: ( - individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], - request_options: FinchAPI::request_opts + ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::individual_enroll_many_params @@ -49,8 +49,8 @@ module FinchAPI def initialize: ( - configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, - individual_id: String + ?configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + ?individual_id: String ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::individual @@ -95,11 +95,11 @@ module FinchAPI def initialize: ( - annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, - annual_maximum: Integer?, - catch_up: bool, - company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, - employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + ?annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, + ?annual_maximum: Integer?, + ?catch_up: bool, + ?company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + ?employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::configuration @@ -136,8 +136,8 @@ module FinchAPI def initialize: ( - amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ + ?amount: Integer, + ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::company_contribution @@ -175,8 +175,8 @@ module FinchAPI def initialize: ( - amount: Integer, - type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ + ?amount: Integer, + ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::employee_deduction diff --git a/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs b/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs index d75239d2..6bf41b3b 100644 --- a/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs @@ -10,7 +10,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs b/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs index 72be7af0..3753a1d6 100644 --- a/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs @@ -15,8 +15,8 @@ module FinchAPI def initialize: ( - individual_ids: String, - request_options: FinchAPI::request_opts + ?individual_ids: String, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::individual_retrieve_many_benefits_params diff --git a/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs b/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs index b4988cc8..6bcca155 100644 --- a/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs @@ -15,8 +15,8 @@ module FinchAPI def initialize: ( - individual_ids: ::Array[String], - request_options: FinchAPI::request_opts + ?individual_ids: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::individual_unenroll_many_params diff --git a/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs b/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs index d1edb58b..e6425739 100644 --- a/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +++ b/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs @@ -26,9 +26,9 @@ module FinchAPI def initialize: ( - body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, - code: Integer, - individual_id: String + ?body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, + ?code: Integer, + ?individual_id: String ) -> void | ( ?FinchAPI::Models::HRIS::Benefits::unenrolled_individual @@ -47,7 +47,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (finch_code: String?, message: String?, name: String?) -> void + (?finch_code: String?, ?message: String?, ?name: String?) -> void | ( ?FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::body | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/benefits_support.rbs b/sig/finch-api/models/hris/benefits_support.rbs index 8ee7e3e1..1869522d 100644 --- a/sig/finch-api/models/hris/benefits_support.rbs +++ b/sig/finch-api/models/hris/benefits_support.rbs @@ -44,18 +44,18 @@ module FinchAPI def initialize: ( - commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - s125_dental: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - s125_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - s125_vision: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + ?commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?s125_dental: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?s125_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?s125_vision: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? ) -> void | ( ?FinchAPI::Models::HRIS::benefits_support | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/company.rbs b/sig/finch-api/models/hris/company.rbs index e2a470b9..44544669 100644 --- a/sig/finch-api/models/hris/company.rbs +++ b/sig/finch-api/models/hris/company.rbs @@ -73,11 +73,11 @@ module FinchAPI def initialize: ( - account_name: String?, - account_number: String?, - account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?, - institution_name: String?, - routing_number: String? + ?account_name: String?, + ?account_number: String?, + ?account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?, + ?institution_name: String?, + ?routing_number: String? ) -> void | ( ?FinchAPI::Models::HRIS::HRISCompany::account @@ -109,8 +109,8 @@ module FinchAPI def initialize: ( - name: String?, - parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? + ?name: String?, + ?parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? ) -> void | ( ?FinchAPI::Models::HRIS::HRISCompany::department @@ -125,7 +125,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::HRIS::HRISCompany::Department::parent | FinchAPI::BaseModel data @@ -148,8 +148,8 @@ module FinchAPI def initialize: ( - subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?, - type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? + ?subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?, + ?type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? ) -> void | ( ?FinchAPI::Models::HRIS::HRISCompany::entity diff --git a/sig/finch-api/models/hris/company_retrieve_params.rbs b/sig/finch-api/models/hris/company_retrieve_params.rbs index 22edfeaa..842fd56a 100644 --- a/sig/finch-api/models/hris/company_retrieve_params.rbs +++ b/sig/finch-api/models/hris/company_retrieve_params.rbs @@ -8,7 +8,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::HRIS::company_retrieve_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/directory_list_individuals_params.rbs b/sig/finch-api/models/hris/directory_list_individuals_params.rbs index 8571ddaf..5e8e9df8 100644 --- a/sig/finch-api/models/hris/directory_list_individuals_params.rbs +++ b/sig/finch-api/models/hris/directory_list_individuals_params.rbs @@ -18,9 +18,9 @@ module FinchAPI def initialize: ( - limit: Integer, - offset: Integer, - request_options: FinchAPI::request_opts + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::directory_list_individuals_params diff --git a/sig/finch-api/models/hris/directory_list_params.rbs b/sig/finch-api/models/hris/directory_list_params.rbs index a24a1024..e795ac51 100644 --- a/sig/finch-api/models/hris/directory_list_params.rbs +++ b/sig/finch-api/models/hris/directory_list_params.rbs @@ -18,9 +18,9 @@ module FinchAPI def initialize: ( - limit: Integer, - offset: Integer, - request_options: FinchAPI::request_opts + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::directory_list_params diff --git a/sig/finch-api/models/hris/document_list_params.rbs b/sig/finch-api/models/hris/document_list_params.rbs index 58bd146d..d75cca90 100644 --- a/sig/finch-api/models/hris/document_list_params.rbs +++ b/sig/finch-api/models/hris/document_list_params.rbs @@ -34,11 +34,11 @@ module FinchAPI def initialize: ( - individual_ids: ::Array[String], - limit: Integer, - offset: Integer, - types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], - request_options: FinchAPI::request_opts + ?individual_ids: ::Array[String], + ?limit: Integer, + ?offset: Integer, + ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::document_list_params diff --git a/sig/finch-api/models/hris/document_response.rbs b/sig/finch-api/models/hris/document_response.rbs index 23489f8c..e3f6d7fb 100644 --- a/sig/finch-api/models/hris/document_response.rbs +++ b/sig/finch-api/models/hris/document_response.rbs @@ -31,11 +31,11 @@ module FinchAPI 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 | ( ?FinchAPI::Models::HRIS::document_response diff --git a/sig/finch-api/models/hris/document_retreive_params.rbs b/sig/finch-api/models/hris/document_retreive_params.rbs index a1ef05fb..3e13b479 100644 --- a/sig/finch-api/models/hris/document_retreive_params.rbs +++ b/sig/finch-api/models/hris/document_retreive_params.rbs @@ -8,7 +8,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::HRIS::document_retreive_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/employment_data.rbs b/sig/finch-api/models/hris/employment_data.rbs index d2344da3..c60f6928 100644 --- a/sig/finch-api/models/hris/employment_data.rbs +++ b/sig/finch-api/models/hris/employment_data.rbs @@ -70,26 +70,26 @@ module FinchAPI def initialize: ( - id: String, - class_code: String?, - custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]?, - department: FinchAPI::Models::HRIS::EmploymentData::Department?, - employment: FinchAPI::Models::HRIS::EmploymentData::Employment?, - employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status?, - end_date: String?, - first_name: String?, - income: FinchAPI::Models::Income?, - income_history: ::Array[FinchAPI::Models::Income?]?, - is_active: bool?, - last_name: String?, - latest_rehire_date: String?, - location: FinchAPI::Models::Location?, - manager: FinchAPI::Models::HRIS::EmploymentData::Manager?, - middle_name: String?, - source_id: String?, - start_date: String?, - title: String?, - work_id: String? + ?id: String, + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]?, + ?department: FinchAPI::Models::HRIS::EmploymentData::Department?, + ?employment: FinchAPI::Models::HRIS::EmploymentData::Employment?, + ?employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::HRIS::EmploymentData::Manager?, + ?middle_name: String?, + ?source_id: String?, + ?start_date: String?, + ?title: String?, + ?work_id: String? ) -> void | ( ?FinchAPI::Models::HRIS::employment_data | FinchAPI::BaseModel data @@ -109,7 +109,7 @@ module FinchAPI def value=: (top) -> top def initialize: - (name: String, value: top) -> void + (?name: String, ?value: top) -> void | ( ?FinchAPI::Models::HRIS::EmploymentData::custom_field | FinchAPI::BaseModel data @@ -124,7 +124,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::HRIS::EmploymentData::department | FinchAPI::BaseModel data @@ -146,8 +146,8 @@ module FinchAPI def initialize: ( - subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?, - type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? + ?subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?, + ?type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? ) -> void | ( ?FinchAPI::Models::HRIS::EmploymentData::employment @@ -214,7 +214,7 @@ module FinchAPI def id=: (String) -> String def initialize: - (id: String) -> void + (?id: String) -> void | ( ?FinchAPI::Models::HRIS::EmploymentData::manager | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/employment_data_response.rbs b/sig/finch-api/models/hris/employment_data_response.rbs index 48609ee5..d195ac77 100644 --- a/sig/finch-api/models/hris/employment_data_response.rbs +++ b/sig/finch-api/models/hris/employment_data_response.rbs @@ -25,9 +25,9 @@ module FinchAPI def initialize: ( - body: FinchAPI::Models::HRIS::EmploymentData, - code: Integer, - individual_id: String + ?body: FinchAPI::Models::HRIS::EmploymentData, + ?code: Integer, + ?individual_id: String ) -> void | ( ?FinchAPI::Models::HRIS::employment_data_response diff --git a/sig/finch-api/models/hris/employment_retrieve_many_params.rbs b/sig/finch-api/models/hris/employment_retrieve_many_params.rbs index 092825c1..b4276767 100644 --- a/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +++ b/sig/finch-api/models/hris/employment_retrieve_many_params.rbs @@ -16,7 +16,7 @@ module FinchAPI def initialize: ( requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::employment_retrieve_many_params diff --git a/sig/finch-api/models/hris/individual.rbs b/sig/finch-api/models/hris/individual.rbs index 74bec152..f6bb5418 100644 --- a/sig/finch-api/models/hris/individual.rbs +++ b/sig/finch-api/models/hris/individual.rbs @@ -49,19 +49,19 @@ module FinchAPI def initialize: ( - id: String, - dob: String?, - emails: ::Array[FinchAPI::Models::HRIS::Individual::Email]?, - encrypted_ssn: String?, - ethnicity: FinchAPI::Models::HRIS::Individual::ethnicity?, - first_name: String?, - gender: FinchAPI::Models::HRIS::Individual::gender?, - last_name: String?, - middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber?]?, - preferred_name: String?, - residence: FinchAPI::Models::Location?, - ssn: String? + ?id: String, + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::HRIS::Individual::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::HRIS::Individual::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::HRIS::Individual::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String? ) -> void | ( ?FinchAPI::Models::HRIS::individual | FinchAPI::BaseModel data @@ -84,8 +84,8 @@ module FinchAPI def initialize: ( - data: String, - type: FinchAPI::Models::HRIS::Individual::Email::type_? + ?data: String, + ?type: FinchAPI::Models::HRIS::Individual::Email::type_? ) -> void | ( ?FinchAPI::Models::HRIS::Individual::email @@ -151,8 +151,8 @@ module FinchAPI def initialize: ( - data: String?, - type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_? + ?data: String?, + ?type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_? ) -> void | ( ?FinchAPI::Models::HRIS::Individual::phone_number diff --git a/sig/finch-api/models/hris/individual_in_directory.rbs b/sig/finch-api/models/hris/individual_in_directory.rbs index 20b009fe..6a8db493 100644 --- a/sig/finch-api/models/hris/individual_in_directory.rbs +++ b/sig/finch-api/models/hris/individual_in_directory.rbs @@ -31,13 +31,13 @@ module FinchAPI def initialize: ( - id: String, - department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?, - first_name: String?, - is_active: bool?, - last_name: String?, - manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?, - middle_name: String? + ?id: String, + ?department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?, + ?first_name: String?, + ?is_active: bool?, + ?last_name: String?, + ?manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?, + ?middle_name: String? ) -> void | ( ?FinchAPI::Models::HRIS::individual_in_directory @@ -52,7 +52,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::HRIS::IndividualInDirectory::department | FinchAPI::BaseModel data @@ -69,7 +69,7 @@ module FinchAPI def id=: (String) -> String def initialize: - (id: String) -> void + (?id: String) -> void | ( ?FinchAPI::Models::HRIS::IndividualInDirectory::manager | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/individual_response.rbs b/sig/finch-api/models/hris/individual_response.rbs index 43c26e17..3e2dd4ad 100644 --- a/sig/finch-api/models/hris/individual_response.rbs +++ b/sig/finch-api/models/hris/individual_response.rbs @@ -25,9 +25,9 @@ module FinchAPI def initialize: ( - body: FinchAPI::Models::HRIS::Individual, - code: Integer, - individual_id: String + ?body: FinchAPI::Models::HRIS::Individual, + ?code: Integer, + ?individual_id: String ) -> void | ( ?FinchAPI::Models::HRIS::individual_response diff --git a/sig/finch-api/models/hris/individual_retrieve_many_params.rbs b/sig/finch-api/models/hris/individual_retrieve_many_params.rbs index dbc9ecba..dacf87c3 100644 --- a/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +++ b/sig/finch-api/models/hris/individual_retrieve_many_params.rbs @@ -22,9 +22,9 @@ module FinchAPI def initialize: ( - options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, - requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], - request_options: FinchAPI::request_opts + ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, + ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::individual_retrieve_many_params @@ -41,7 +41,7 @@ module FinchAPI def include=: (::Array[String]) -> ::Array[String] def initialize: - (include: ::Array[String]) -> void + (?include: ::Array[String]) -> void | ( ?FinchAPI::Models::HRIS::IndividualRetrieveManyParams::options | FinchAPI::BaseModel data @@ -58,7 +58,7 @@ module FinchAPI def individual_id=: (String) -> String def initialize: - (individual_id: String) -> void + (?individual_id: String) -> void | ( ?FinchAPI::Models::HRIS::IndividualRetrieveManyParams::request | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/pay_statement.rbs b/sig/finch-api/models/hris/pay_statement.rbs index 7880d31f..5ab57b3b 100644 --- a/sig/finch-api/models/hris/pay_statement.rbs +++ b/sig/finch-api/models/hris/pay_statement.rbs @@ -40,16 +40,16 @@ module FinchAPI def initialize: ( - earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]?, - employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]?, - employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]?, - gross_pay: FinchAPI::Models::Money?, - individual_id: String, - net_pay: FinchAPI::Models::Money?, - payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?, - taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?, - total_hours: Float?, - type: FinchAPI::Models::HRIS::PayStatement::type_? + ?earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]?, + ?employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]?, + ?employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]?, + ?gross_pay: FinchAPI::Models::Money?, + ?individual_id: String, + ?net_pay: FinchAPI::Models::Money?, + ?payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?, + ?taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?, + ?total_hours: Float?, + ?type: FinchAPI::Models::HRIS::PayStatement::type_? ) -> void | ( ?FinchAPI::Models::HRIS::pay_statement | FinchAPI::BaseModel data @@ -82,12 +82,12 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?, - currency: String?, - hours: Float?, - name: String?, - type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?, + ?currency: String?, + ?hours: Float?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::earning @@ -110,7 +110,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata + ?metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::Earning::attributes @@ -127,7 +127,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::metadata | FinchAPI::BaseModel data @@ -196,12 +196,12 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?, - currency: String?, - name: String?, - pre_tax: bool?, - type: FinchAPI::Models::HRIS::benefit_type? + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?, + ?currency: String?, + ?name: String?, + ?pre_tax: bool?, + ?type: FinchAPI::Models::HRIS::benefit_type? ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::employee_deduction @@ -224,7 +224,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata + ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::attributes @@ -241,7 +241,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::metadata | FinchAPI::BaseModel data @@ -274,11 +274,11 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?, - currency: String?, - name: String?, - type: FinchAPI::Models::HRIS::benefit_type? + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?, + ?currency: String?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::benefit_type? ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::employer_contribution @@ -301,7 +301,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::EmployerContribution::attributes @@ -318,7 +318,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::metadata | FinchAPI::BaseModel data @@ -363,12 +363,12 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?, - currency: String?, - employer: bool?, - name: String?, - type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?, + ?currency: String?, + ?employer: bool?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::tax @@ -391,7 +391,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata + ?metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::Tax::attributes @@ -408,7 +408,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::metadata | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/pay_statement_response.rbs b/sig/finch-api/models/hris/pay_statement_response.rbs index 71bcfaa1..9af9ca71 100644 --- a/sig/finch-api/models/hris/pay_statement_response.rbs +++ b/sig/finch-api/models/hris/pay_statement_response.rbs @@ -25,9 +25,9 @@ module FinchAPI def initialize: ( - body: FinchAPI::Models::HRIS::PayStatementResponseBody, - code: Integer, - payment_id: String + ?body: FinchAPI::Models::HRIS::PayStatementResponseBody, + ?code: Integer, + ?payment_id: String ) -> void | ( ?FinchAPI::Models::HRIS::pay_statement_response diff --git a/sig/finch-api/models/hris/pay_statement_response_body.rbs b/sig/finch-api/models/hris/pay_statement_response_body.rbs index cb7a710b..be78e09e 100644 --- a/sig/finch-api/models/hris/pay_statement_response_body.rbs +++ b/sig/finch-api/models/hris/pay_statement_response_body.rbs @@ -20,8 +20,8 @@ module FinchAPI def initialize: ( - paging: FinchAPI::Models::Paging, - pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement] + ?paging: FinchAPI::Models::Paging, + ?pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement] ) -> void | ( ?FinchAPI::Models::HRIS::pay_statement_response_body diff --git a/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs b/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs index 646aa19d..72ec24f1 100644 --- a/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +++ b/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs @@ -16,7 +16,7 @@ module FinchAPI def initialize: ( requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::pay_statement_retrieve_many_params @@ -39,7 +39,7 @@ module FinchAPI def offset=: (Integer) -> Integer def initialize: - (payment_id: String, limit: Integer, offset: Integer) -> void + (payment_id: String, ?limit: Integer, ?offset: Integer) -> void | ( ?FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::request | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/payment.rbs b/sig/finch-api/models/hris/payment.rbs index 30eaa5a5..c20f2431 100644 --- a/sig/finch-api/models/hris/payment.rbs +++ b/sig/finch-api/models/hris/payment.rbs @@ -46,18 +46,18 @@ module FinchAPI def initialize: ( - id: String, - company_debit: FinchAPI::Models::Money?, - debit_date: String?, - employee_taxes: FinchAPI::Models::Money?, - employer_taxes: FinchAPI::Models::Money?, - gross_pay: FinchAPI::Models::Money?, - individual_ids: ::Array[String]?, - net_pay: FinchAPI::Models::Money?, - pay_date: String?, - pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?, - pay_group_ids: ::Array[String]?, - pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? + ?id: String, + ?company_debit: FinchAPI::Models::Money?, + ?debit_date: String?, + ?employee_taxes: FinchAPI::Models::Money?, + ?employer_taxes: FinchAPI::Models::Money?, + ?gross_pay: FinchAPI::Models::Money?, + ?individual_ids: ::Array[String]?, + ?net_pay: FinchAPI::Models::Money?, + ?pay_date: String?, + ?pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?, + ?pay_group_ids: ::Array[String]?, + ?pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? ) -> void | ( ?FinchAPI::Models::HRIS::payment | FinchAPI::BaseModel data @@ -98,7 +98,7 @@ module FinchAPI attr_accessor start_date: String? def initialize: - (end_date: String?, start_date: String?) -> void + (?end_date: String?, ?start_date: String?) -> void | ( ?FinchAPI::Models::HRIS::Payment::pay_period | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/payment_list_params.rbs b/sig/finch-api/models/hris/payment_list_params.rbs index c4225a9f..4da21241 100644 --- a/sig/finch-api/models/hris/payment_list_params.rbs +++ b/sig/finch-api/models/hris/payment_list_params.rbs @@ -16,7 +16,7 @@ module FinchAPI ( end_date: Date, start_date: Date, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::HRIS::payment_list_params diff --git a/sig/finch-api/models/hris/support_per_benefit_type.rbs b/sig/finch-api/models/hris/support_per_benefit_type.rbs index 87dc360e..c15e407a 100644 --- a/sig/finch-api/models/hris/support_per_benefit_type.rbs +++ b/sig/finch-api/models/hris/support_per_benefit_type.rbs @@ -22,8 +22,8 @@ module FinchAPI def initialize: ( - company_benefits: FinchAPI::Models::OperationSupportMatrix, - individual_benefits: FinchAPI::Models::OperationSupportMatrix + ?company_benefits: FinchAPI::Models::OperationSupportMatrix, + ?individual_benefits: FinchAPI::Models::OperationSupportMatrix ) -> void | ( ?FinchAPI::Models::HRIS::support_per_benefit_type diff --git a/sig/finch-api/models/hris/supported_benefit.rbs b/sig/finch-api/models/hris/supported_benefit.rbs index d1e60b98..78dea239 100644 --- a/sig/finch-api/models/hris/supported_benefit.rbs +++ b/sig/finch-api/models/hris/supported_benefit.rbs @@ -36,14 +36,14 @@ module FinchAPI def initialize: ( - annual_maximum: bool?, - catch_up: bool?, - company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?, - description: String?, - employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?, - frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?, - type: FinchAPI::Models::HRIS::benefit_type? + ?annual_maximum: bool?, + ?catch_up: bool?, + ?company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?, + ?description: String?, + ?employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?, + ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], + ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?, + ?type: FinchAPI::Models::HRIS::benefit_type? ) -> void | ( ?FinchAPI::Models::HRIS::supported_benefit diff --git a/sig/finch-api/models/hris/w42005.rbs b/sig/finch-api/models/hris/w42005.rbs index 8390845d..cf4208bd 100644 --- a/sig/finch-api/models/hris/w42005.rbs +++ b/sig/finch-api/models/hris/w42005.rbs @@ -25,9 +25,9 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::HRIS::W42005::Data, - type: FinchAPI::Models::HRIS::W42005::type_, - year: Float? + ?data: FinchAPI::Models::HRIS::W42005::Data, + ?type: FinchAPI::Models::HRIS::W42005::type_, + ?year: Float? ) -> void | (?FinchAPI::Models::HRIS::w42005 | FinchAPI::BaseModel data) -> void @@ -65,11 +65,11 @@ module FinchAPI 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 | ( ?FinchAPI::Models::HRIS::W42005::data | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/hris/w42020.rbs b/sig/finch-api/models/hris/w42020.rbs index a7ef901f..27025ac5 100644 --- a/sig/finch-api/models/hris/w42020.rbs +++ b/sig/finch-api/models/hris/w42020.rbs @@ -25,9 +25,9 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::HRIS::W42020::Data, - type: FinchAPI::Models::HRIS::W42020::type_, - year: Float? + ?data: FinchAPI::Models::HRIS::W42020::Data, + ?type: FinchAPI::Models::HRIS::W42020::type_, + ?year: Float? ) -> void | (?FinchAPI::Models::HRIS::w42020 | FinchAPI::BaseModel data) -> void @@ -66,14 +66,14 @@ module FinchAPI 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 | ( ?FinchAPI::Models::HRIS::W42020::data | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/income.rbs b/sig/finch-api/models/income.rbs index 25c623b7..d8eddbf3 100644 --- a/sig/finch-api/models/income.rbs +++ b/sig/finch-api/models/income.rbs @@ -19,10 +19,10 @@ module FinchAPI def initialize: ( - amount: Integer?, - currency: String?, - effective_date: String?, - unit: FinchAPI::Models::Income::unit? + ?amount: Integer?, + ?currency: String?, + ?effective_date: String?, + ?unit: FinchAPI::Models::Income::unit? ) -> void | (?FinchAPI::Models::income | FinchAPI::BaseModel data) -> void diff --git a/sig/finch-api/models/individual_event.rbs b/sig/finch-api/models/individual_event.rbs index 342810c5..f985f76c 100644 --- a/sig/finch-api/models/individual_event.rbs +++ b/sig/finch-api/models/individual_event.rbs @@ -21,8 +21,8 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::IndividualEvent::Data, - event_type: FinchAPI::Models::IndividualEvent::event_type + ?data: FinchAPI::Models::IndividualEvent::Data, + ?event_type: FinchAPI::Models::IndividualEvent::event_type ) -> void | ( ?FinchAPI::Models::individual_event | FinchAPI::BaseModel data @@ -38,7 +38,7 @@ module FinchAPI def individual_id=: (String) -> String def initialize: - (individual_id: String) -> void + (?individual_id: String) -> void | ( ?FinchAPI::Models::IndividualEvent::data | FinchAPI::BaseModel data ) -> void diff --git a/sig/finch-api/models/introspection.rbs b/sig/finch-api/models/introspection.rbs index 2fdbb059..fdf4b9c2 100644 --- a/sig/finch-api/models/introspection.rbs +++ b/sig/finch-api/models/introspection.rbs @@ -102,9 +102,9 @@ module FinchAPI def initialize: ( - connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, - products: ::Array[String], - type: FinchAPI::Models::Introspection::AuthenticationMethod::type_ + ?connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, + ?products: ::Array[String], + ?type: FinchAPI::Models::Introspection::AuthenticationMethod::type_ ) -> void | ( ?FinchAPI::Models::Introspection::authentication_method @@ -129,8 +129,8 @@ module FinchAPI def initialize: ( - message: String, - status: FinchAPI::Models::connection_status_type + ?message: String, + ?status: FinchAPI::Models::connection_status_type ) -> void | ( ?FinchAPI::Models::Introspection::AuthenticationMethod::connection_status @@ -180,8 +180,8 @@ module FinchAPI def initialize: ( - message: String, - status: FinchAPI::Models::connection_status_type + ?message: String, + ?status: FinchAPI::Models::connection_status_type ) -> void | ( ?FinchAPI::Models::Introspection::connection_status diff --git a/sig/finch-api/models/job_completion_event.rbs b/sig/finch-api/models/job_completion_event.rbs index 8d5985bc..2f530d0e 100644 --- a/sig/finch-api/models/job_completion_event.rbs +++ b/sig/finch-api/models/job_completion_event.rbs @@ -21,8 +21,8 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::JobCompletionEvent::Data, - event_type: FinchAPI::Models::JobCompletionEvent::event_type + ?data: FinchAPI::Models::JobCompletionEvent::Data, + ?event_type: FinchAPI::Models::JobCompletionEvent::event_type ) -> void | ( ?FinchAPI::Models::job_completion_event | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/jobs/automated_async_job.rbs b/sig/finch-api/models/jobs/automated_async_job.rbs index f43c9400..6851d480 100644 --- a/sig/finch-api/models/jobs/automated_async_job.rbs +++ b/sig/finch-api/models/jobs/automated_async_job.rbs @@ -60,7 +60,7 @@ module FinchAPI def individual_id=: (String) -> String def initialize: - (individual_id: String) -> void + (?individual_id: String) -> void | ( ?FinchAPI::Models::Jobs::AutomatedAsyncJob::params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/jobs/automated_create_params.rbs b/sig/finch-api/models/jobs/automated_create_params.rbs index 9ffa5248..2d61e6e0 100644 --- a/sig/finch-api/models/jobs/automated_create_params.rbs +++ b/sig/finch-api/models/jobs/automated_create_params.rbs @@ -20,7 +20,7 @@ module FinchAPI ( type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Jobs::automated_create_params diff --git a/sig/finch-api/models/jobs/automated_list_params.rbs b/sig/finch-api/models/jobs/automated_list_params.rbs index 539995b5..86767b64 100644 --- a/sig/finch-api/models/jobs/automated_list_params.rbs +++ b/sig/finch-api/models/jobs/automated_list_params.rbs @@ -18,9 +18,9 @@ module FinchAPI def initialize: ( - limit: Integer, - offset: Integer, - request_options: FinchAPI::request_opts + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Jobs::automated_list_params diff --git a/sig/finch-api/models/jobs/automated_list_response.rbs b/sig/finch-api/models/jobs/automated_list_response.rbs index 417d88ce..6c57bc25 100644 --- a/sig/finch-api/models/jobs/automated_list_response.rbs +++ b/sig/finch-api/models/jobs/automated_list_response.rbs @@ -38,7 +38,7 @@ module FinchAPI def initialize: ( - quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + ?quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas ) -> void | ( ?FinchAPI::Models::Jobs::AutomatedListResponse::meta @@ -61,7 +61,7 @@ module FinchAPI def initialize: ( - data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll + ?data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll ) -> void | ( ?FinchAPI::Models::Jobs::AutomatedListResponse::Meta::quotas @@ -84,8 +84,8 @@ module FinchAPI def initialize: ( - allowed_refreshes: Integer, - remaining_refreshes: Integer + ?allowed_refreshes: Integer, + ?remaining_refreshes: Integer ) -> void | ( ?FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::data_sync_all diff --git a/sig/finch-api/models/jobs/automated_retrieve_params.rbs b/sig/finch-api/models/jobs/automated_retrieve_params.rbs index 0f4a887c..7f88d802 100644 --- a/sig/finch-api/models/jobs/automated_retrieve_params.rbs +++ b/sig/finch-api/models/jobs/automated_retrieve_params.rbs @@ -8,7 +8,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::Jobs::automated_retrieve_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/jobs/manual_retrieve_params.rbs b/sig/finch-api/models/jobs/manual_retrieve_params.rbs index 83f56492..2b56b6a5 100644 --- a/sig/finch-api/models/jobs/manual_retrieve_params.rbs +++ b/sig/finch-api/models/jobs/manual_retrieve_params.rbs @@ -8,7 +8,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::Jobs::manual_retrieve_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/location.rbs b/sig/finch-api/models/location.rbs index 861e5e81..11413bdc 100644 --- a/sig/finch-api/models/location.rbs +++ b/sig/finch-api/models/location.rbs @@ -31,14 +31,14 @@ module FinchAPI def initialize: ( - city: String?, - country: String?, - line1: String?, - line2: String?, - name: String?, - postal_code: String?, - source_id: String?, - state: String? + ?city: String?, + ?country: String?, + ?line1: String?, + ?line2: String?, + ?name: String?, + ?postal_code: String?, + ?source_id: String?, + ?state: String? ) -> void | (?FinchAPI::Models::location | FinchAPI::BaseModel data) -> void diff --git a/sig/finch-api/models/money.rbs b/sig/finch-api/models/money.rbs index 93ba9be1..33ea0236 100644 --- a/sig/finch-api/models/money.rbs +++ b/sig/finch-api/models/money.rbs @@ -10,7 +10,7 @@ module FinchAPI def currency=: (String) -> String def initialize: - (amount: Integer?, currency: String) -> void + (?amount: Integer?, ?currency: String) -> void | (?FinchAPI::Models::money | FinchAPI::BaseModel data) -> void def to_hash: -> FinchAPI::Models::money diff --git a/sig/finch-api/models/operation_support_matrix.rbs b/sig/finch-api/models/operation_support_matrix.rbs index 4de3319e..215d6784 100644 --- a/sig/finch-api/models/operation_support_matrix.rbs +++ b/sig/finch-api/models/operation_support_matrix.rbs @@ -35,10 +35,10 @@ module FinchAPI def initialize: ( - create: FinchAPI::Models::operation_support, - delete: FinchAPI::Models::operation_support, - read: FinchAPI::Models::operation_support, - update: FinchAPI::Models::operation_support + ?create: FinchAPI::Models::operation_support, + ?delete: FinchAPI::Models::operation_support, + ?read: FinchAPI::Models::operation_support, + ?update: FinchAPI::Models::operation_support ) -> void | ( ?FinchAPI::Models::operation_support_matrix | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/paging.rbs b/sig/finch-api/models/paging.rbs index 39a39337..12605589 100644 --- a/sig/finch-api/models/paging.rbs +++ b/sig/finch-api/models/paging.rbs @@ -12,7 +12,7 @@ module FinchAPI def offset=: (Integer) -> Integer def initialize: - (count: Integer, offset: Integer) -> void + (?count: Integer, ?offset: Integer) -> void | (?FinchAPI::Models::paging | FinchAPI::BaseModel data) -> void def to_hash: -> FinchAPI::Models::paging diff --git a/sig/finch-api/models/pay_statement_event.rbs b/sig/finch-api/models/pay_statement_event.rbs index af41866d..1eb71773 100644 --- a/sig/finch-api/models/pay_statement_event.rbs +++ b/sig/finch-api/models/pay_statement_event.rbs @@ -21,8 +21,8 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::PayStatementEvent::Data, - event_type: FinchAPI::Models::PayStatementEvent::event_type + ?data: FinchAPI::Models::PayStatementEvent::Data, + ?event_type: FinchAPI::Models::PayStatementEvent::event_type ) -> void | ( ?FinchAPI::Models::pay_statement_event | FinchAPI::BaseModel data @@ -42,7 +42,7 @@ module FinchAPI def payment_id=: (String) -> String def initialize: - (individual_id: String, payment_id: String) -> void + (?individual_id: String, ?payment_id: String) -> void | ( ?FinchAPI::Models::PayStatementEvent::data | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/payment_event.rbs b/sig/finch-api/models/payment_event.rbs index 01042f53..f3d2eeea 100644 --- a/sig/finch-api/models/payment_event.rbs +++ b/sig/finch-api/models/payment_event.rbs @@ -21,8 +21,8 @@ module FinchAPI def initialize: ( - data: FinchAPI::Models::PaymentEvent::Data, - event_type: FinchAPI::Models::PaymentEvent::event_type + ?data: FinchAPI::Models::PaymentEvent::Data, + ?event_type: FinchAPI::Models::PaymentEvent::event_type ) -> void | (?FinchAPI::Models::payment_event | FinchAPI::BaseModel data) -> void diff --git a/sig/finch-api/models/payroll/pay_group_list_params.rbs b/sig/finch-api/models/payroll/pay_group_list_params.rbs index 16422c5c..3d1f2dd1 100644 --- a/sig/finch-api/models/payroll/pay_group_list_params.rbs +++ b/sig/finch-api/models/payroll/pay_group_list_params.rbs @@ -19,9 +19,9 @@ module FinchAPI def initialize: ( - individual_id: String, - pay_frequencies: ::Array[String], - request_options: FinchAPI::request_opts + ?individual_id: String, + ?pay_frequencies: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Payroll::pay_group_list_params diff --git a/sig/finch-api/models/payroll/pay_group_list_response.rbs b/sig/finch-api/models/payroll/pay_group_list_response.rbs index b05254c2..d583c752 100644 --- a/sig/finch-api/models/payroll/pay_group_list_response.rbs +++ b/sig/finch-api/models/payroll/pay_group_list_response.rbs @@ -25,9 +25,9 @@ module FinchAPI def initialize: ( - id: String, - name: String, - pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] + ?id: String, + ?name: String, + ?pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] ) -> void | ( ?FinchAPI::Models::Payroll::pay_group_list_response diff --git a/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs b/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs index 73f7c953..ea331523 100644 --- a/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +++ b/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs @@ -8,7 +8,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::Payroll::pay_group_retrieve_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/provider.rbs b/sig/finch-api/models/provider.rbs index 7b923ce5..ab8af201 100644 --- a/sig/finch-api/models/provider.rbs +++ b/sig/finch-api/models/provider.rbs @@ -59,16 +59,16 @@ module FinchAPI def initialize: ( - id: String, - authentication_methods: ::Array[FinchAPI::Models::Provider::AuthenticationMethod], - beta: bool, - display_name: String, - icon: String, - logo: String, - manual: bool, - mfa_required: bool, - primary_color: String, - products: ::Array[String] + ?id: String, + ?authentication_methods: ::Array[FinchAPI::Models::Provider::AuthenticationMethod], + ?beta: bool, + ?display_name: String, + ?icon: String, + ?logo: String, + ?manual: bool, + ?mfa_required: bool, + ?primary_color: String, + ?products: ::Array[String] ) -> void | (?FinchAPI::Models::provider | FinchAPI::BaseModel data) -> void @@ -94,9 +94,9 @@ module FinchAPI def initialize: ( - benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, - supported_fields: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields?, - type: FinchAPI::Models::Provider::AuthenticationMethod::type_ + ?benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, + ?supported_fields: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields?, + ?type: FinchAPI::Models::Provider::AuthenticationMethod::type_ ) -> void | ( ?FinchAPI::Models::Provider::authentication_method @@ -161,13 +161,13 @@ module FinchAPI def initialize: ( - company: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, - directory: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, - employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, - individual: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, - pay_group: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, - pay_statement: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, - payment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment + ?company: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, + ?directory: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, + ?employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, + ?individual: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, + ?pay_group: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, + ?pay_statement: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, + ?payment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::supported_fields @@ -236,15 +236,15 @@ module FinchAPI def initialize: ( - id: bool, - accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, - ein: bool, - entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, - legal_name: bool, - locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, - primary_email: bool, - primary_phone_number: bool + ?id: bool, + ?accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + ?departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + ?ein: bool, + ?entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + ?legal_name: bool, + ?locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + ?primary_email: bool, + ?primary_phone_number: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::company @@ -285,11 +285,11 @@ module FinchAPI def initialize: ( - account_name: bool, - account_number: bool, - account_type: bool, - institution_name: bool, - routing_number: bool + ?account_name: bool, + ?account_number: bool, + ?account_type: bool, + ?institution_name: bool, + ?routing_number: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::accounts @@ -318,8 +318,8 @@ module FinchAPI def initialize: ( - name: bool, - parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ?name: bool, + ?parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::departments @@ -336,7 +336,7 @@ module FinchAPI def name=: (bool) -> bool def initialize: - (name: bool) -> void + (?name: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::parent | FinchAPI::BaseModel data @@ -358,7 +358,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (subtype: bool, type: bool) -> void + (?subtype: bool, ?type: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::entity | FinchAPI::BaseModel data @@ -404,12 +404,12 @@ module FinchAPI def initialize: ( - city: bool, - country: bool, - line1: bool, - line2: bool, - postal_code: bool, - state: bool + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::locations @@ -441,8 +441,8 @@ module FinchAPI def initialize: ( - individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + ?individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::directory @@ -495,13 +495,13 @@ module FinchAPI def initialize: ( - id: bool, - department: bool, - first_name: bool, - is_active: bool, - last_name: bool, - manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - middle_name: bool + ?id: bool, + ?department: bool, + ?first_name: bool, + ?is_active: bool, + ?last_name: bool, + ?manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + ?middle_name: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::individuals @@ -518,7 +518,7 @@ module FinchAPI def id=: (bool) -> bool def initialize: - (id: bool) -> void + (?id: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::manager | FinchAPI::BaseModel data @@ -540,7 +540,7 @@ module FinchAPI def offset=: (bool) -> bool def initialize: - (count: bool, offset: bool) -> void + (?count: bool, ?offset: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::paging | FinchAPI::BaseModel data @@ -652,23 +652,23 @@ module FinchAPI def initialize: ( - id: bool, - class_code: bool, - custom_fields: bool, - department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, - employment_status: bool, - end_date: bool, - first_name: bool, - income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, - income_history: bool, - is_active: bool, - last_name: bool, - location: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, - manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, - middle_name: bool, - start_date: bool, - title: bool + ?id: bool, + ?class_code: bool, + ?custom_fields: bool, + ?department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + ?employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + ?employment_status: bool, + ?end_date: bool, + ?first_name: bool, + ?income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + ?income_history: bool, + ?is_active: bool, + ?last_name: bool, + ?location: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + ?manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, + ?middle_name: bool, + ?start_date: bool, + ?title: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::employment @@ -685,7 +685,7 @@ module FinchAPI def name=: (bool) -> bool def initialize: - (name: bool) -> void + (?name: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::department | FinchAPI::BaseModel data @@ -706,7 +706,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (subtype: bool, type: bool) -> void + (?subtype: bool, ?type: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::employment | FinchAPI::BaseModel data @@ -731,7 +731,7 @@ module FinchAPI def unit=: (bool) -> bool def initialize: - (amount: bool, currency: bool, unit: bool) -> void + (?amount: bool, ?currency: bool, ?unit: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::income | FinchAPI::BaseModel data @@ -777,12 +777,12 @@ module FinchAPI def initialize: ( - city: bool, - country: bool, - line1: bool, - line2: bool, - postal_code: bool, - state: bool + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::location @@ -800,7 +800,7 @@ module FinchAPI def id=: (bool) -> bool def initialize: - (id: bool) -> void + (?id: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::manager | FinchAPI::BaseModel data @@ -888,19 +888,19 @@ module FinchAPI def initialize: ( - id: bool, - dob: bool, - emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, - encrypted_ssn: bool, - ethnicity: bool, - first_name: bool, - gender: bool, - last_name: bool, - middle_name: bool, - phone_numbers: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - preferred_name: bool, - residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, - ssn: bool + ?id: bool, + ?dob: bool, + ?emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + ?encrypted_ssn: bool, + ?ethnicity: bool, + ?first_name: bool, + ?gender: bool, + ?last_name: bool, + ?middle_name: bool, + ?phone_numbers: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + ?preferred_name: bool, + ?residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + ?ssn: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::individual @@ -921,7 +921,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (data: bool, type: bool) -> void + (?data: bool, ?type: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::emails | FinchAPI::BaseModel data @@ -942,7 +942,7 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (data: bool, type: bool) -> void + (?data: bool, ?type: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::phone_numbers | FinchAPI::BaseModel data @@ -988,12 +988,12 @@ module FinchAPI def initialize: ( - city: bool, - country: bool, - line1: bool, - line2: bool, - postal_code: bool, - state: bool + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::residence @@ -1031,10 +1031,10 @@ module FinchAPI def initialize: ( - id: bool, - individual_ids: bool, - name: bool, - pay_frequencies: bool + ?id: bool, + ?individual_ids: bool, + ?name: bool, + ?pay_frequencies: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_group @@ -1065,8 +1065,8 @@ module FinchAPI def initialize: ( - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + ?pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_statement @@ -1157,16 +1157,16 @@ module FinchAPI def initialize: ( - earnings: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - employee_deductions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - employer_contributions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - gross_pay: bool, - individual_id: bool, - net_pay: bool, - payment_method: bool, - taxes: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - total_hours: bool, - type: bool + ?earnings: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + ?employee_deductions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + ?employer_contributions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + ?gross_pay: bool, + ?individual_id: bool, + ?net_pay: bool, + ?payment_method: bool, + ?taxes: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + ?total_hours: bool, + ?type: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::pay_statements @@ -1196,7 +1196,12 @@ module FinchAPI def type=: (bool) -> bool def initialize: - (amount: bool, currency: bool, name: bool, type: bool) -> void + ( + ?amount: bool, + ?currency: bool, + ?name: bool, + ?type: bool + ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings | FinchAPI::BaseModel data @@ -1237,11 +1242,11 @@ module FinchAPI def initialize: ( - amount: bool, - currency: bool, - name: bool, - pre_tax: bool, - type: bool + ?amount: bool, + ?currency: bool, + ?name: bool, + ?pre_tax: bool, + ?type: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions @@ -1268,7 +1273,7 @@ module FinchAPI def name=: (bool) -> bool def initialize: - (amount: bool, currency: bool, name: bool) -> void + (?amount: bool, ?currency: bool, ?name: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions | FinchAPI::BaseModel data @@ -1309,11 +1314,11 @@ module FinchAPI def initialize: ( - amount: bool, - currency: bool, - employer: bool, - name: bool, - type: bool + ?amount: bool, + ?currency: bool, + ?employer: bool, + ?name: bool, + ?type: bool ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes @@ -1394,18 +1399,18 @@ module FinchAPI def initialize: ( - id: bool, - company_debit: bool, - debit_date: bool, - employee_taxes: bool, - employer_taxes: bool, - gross_pay: bool, - individual_ids: bool, - net_pay: bool, - pay_date: bool, - pay_frequencies: bool, - pay_group_ids: bool, - pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ?id: bool, + ?company_debit: bool, + ?debit_date: bool, + ?employee_taxes: bool, + ?employer_taxes: bool, + ?gross_pay: bool, + ?individual_ids: bool, + ?net_pay: bool, + ?pay_date: bool, + ?pay_frequencies: bool, + ?pay_group_ids: bool, + ?pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::payment @@ -1426,7 +1431,7 @@ module FinchAPI def start_date=: (bool) -> bool def initialize: - (end_date: bool, start_date: bool) -> void + (?end_date: bool, ?start_date: bool) -> void | ( ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::pay_period | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/provider_list_params.rbs b/sig/finch-api/models/provider_list_params.rbs index 13195874..234d91c4 100644 --- a/sig/finch-api/models/provider_list_params.rbs +++ b/sig/finch-api/models/provider_list_params.rbs @@ -7,7 +7,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::provider_list_params | FinchAPI::BaseModel data ) -> void diff --git a/sig/finch-api/models/request_forwarding_forward_params.rbs b/sig/finch-api/models/request_forwarding_forward_params.rbs index 22f59027..245a68f8 100644 --- a/sig/finch-api/models/request_forwarding_forward_params.rbs +++ b/sig/finch-api/models/request_forwarding_forward_params.rbs @@ -28,10 +28,10 @@ module FinchAPI ( method_: String, route: String, - data: String?, - headers: top?, - params: top?, - request_options: FinchAPI::request_opts + ?data: String?, + ?headers: top?, + ?params: top?, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::request_forwarding_forward_params diff --git a/sig/finch-api/models/sandbox/company_update_params.rbs b/sig/finch-api/models/sandbox/company_update_params.rbs index 4e1fbf00..f1ff0734 100644 --- a/sig/finch-api/models/sandbox/company_update_params.rbs +++ b/sig/finch-api/models/sandbox/company_update_params.rbs @@ -44,7 +44,7 @@ module FinchAPI locations: ::Array[FinchAPI::Models::Location?]?, primary_email: String?, primary_phone_number: String?, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::company_update_params @@ -75,11 +75,11 @@ module FinchAPI def initialize: ( - account_name: String?, - account_number: String?, - account_type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type?, - institution_name: String?, - routing_number: String? + ?account_name: String?, + ?account_number: String?, + ?account_type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type?, + ?institution_name: String?, + ?routing_number: String? ) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateParams::account @@ -111,8 +111,8 @@ module FinchAPI def initialize: ( - name: String?, - parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? + ?name: String?, + ?parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? ) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateParams::department @@ -127,7 +127,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::parent | FinchAPI::BaseModel data @@ -150,8 +150,8 @@ module FinchAPI def initialize: ( - subtype: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype?, - type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? + ?subtype: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype?, + ?type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateParams::entity diff --git a/sig/finch-api/models/sandbox/company_update_response.rbs b/sig/finch-api/models/sandbox/company_update_response.rbs index 09108745..f91c1677 100644 --- a/sig/finch-api/models/sandbox/company_update_response.rbs +++ b/sig/finch-api/models/sandbox/company_update_response.rbs @@ -70,11 +70,11 @@ module FinchAPI def initialize: ( - account_name: String?, - account_number: String?, - account_type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::account_type?, - institution_name: String?, - routing_number: String? + ?account_name: String?, + ?account_number: String?, + ?account_type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::account_type?, + ?institution_name: String?, + ?routing_number: String? ) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::account @@ -106,8 +106,8 @@ module FinchAPI def initialize: ( - name: String?, - parent: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent? + ?name: String?, + ?parent: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent? ) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::department @@ -122,7 +122,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::parent | FinchAPI::BaseModel data @@ -145,8 +145,8 @@ module FinchAPI def initialize: ( - subtype: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::subtype?, - type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_? + ?subtype: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::subtype?, + ?type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::entity diff --git a/sig/finch-api/models/sandbox/connection_create_params.rbs b/sig/finch-api/models/sandbox/connection_create_params.rbs index 9e0f18eb..2c426285 100644 --- a/sig/finch-api/models/sandbox/connection_create_params.rbs +++ b/sig/finch-api/models/sandbox/connection_create_params.rbs @@ -33,10 +33,10 @@ module FinchAPI def initialize: ( provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, - employee_size: Integer, - products: ::Array[String], - request_options: FinchAPI::request_opts + ?authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, + ?employee_size: Integer, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::connection_create_params diff --git a/sig/finch-api/models/sandbox/connection_create_response.rbs b/sig/finch-api/models/sandbox/connection_create_response.rbs index 9fb7be9d..d2fc7d88 100644 --- a/sig/finch-api/models/sandbox/connection_create_response.rbs +++ b/sig/finch-api/models/sandbox/connection_create_response.rbs @@ -41,7 +41,7 @@ module FinchAPI connection_id: String, products: ::Array[String], provider_id: String, - token_type: String + ?token_type: String ) -> void | ( ?FinchAPI::Models::Sandbox::connection_create_response diff --git a/sig/finch-api/models/sandbox/connections/account_create_params.rbs b/sig/finch-api/models/sandbox/connections/account_create_params.rbs index a8972f84..aed218ea 100644 --- a/sig/finch-api/models/sandbox/connections/account_create_params.rbs +++ b/sig/finch-api/models/sandbox/connections/account_create_params.rbs @@ -33,9 +33,9 @@ module FinchAPI ( company_id: String, provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, - products: ::Array[String], - request_options: FinchAPI::request_opts + ?authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::Connections::account_create_params diff --git a/sig/finch-api/models/sandbox/connections/account_update_params.rbs b/sig/finch-api/models/sandbox/connections/account_update_params.rbs index 0a957a3d..23203910 100644 --- a/sig/finch-api/models/sandbox/connections/account_update_params.rbs +++ b/sig/finch-api/models/sandbox/connections/account_update_params.rbs @@ -18,8 +18,8 @@ module FinchAPI def initialize: ( - connection_status: FinchAPI::Models::connection_status_type, - request_options: FinchAPI::request_opts + ?connection_status: FinchAPI::Models::connection_status_type, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::Connections::account_update_params diff --git a/sig/finch-api/models/sandbox/connections/account_update_response.rbs b/sig/finch-api/models/sandbox/connections/account_update_response.rbs index 7f5dc7d6..74388144 100644 --- a/sig/finch-api/models/sandbox/connections/account_update_response.rbs +++ b/sig/finch-api/models/sandbox/connections/account_update_response.rbs @@ -34,7 +34,7 @@ module FinchAPI company_id: String, products: ::Array[String], provider_id: String, - connection_id: String + ?connection_id: String ) -> void | ( ?FinchAPI::Models::Sandbox::Connections::account_update_response diff --git a/sig/finch-api/models/sandbox/directory_create_params.rbs b/sig/finch-api/models/sandbox/directory_create_params.rbs index b10a9b2a..1d672284 100644 --- a/sig/finch-api/models/sandbox/directory_create_params.rbs +++ b/sig/finch-api/models/sandbox/directory_create_params.rbs @@ -19,8 +19,8 @@ module FinchAPI def initialize: ( - body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], - request_options: FinchAPI::request_opts + ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::directory_create_params @@ -123,33 +123,33 @@ module FinchAPI def initialize: ( - class_code: String?, - custom_fields: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], - department: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department?, - dob: String?, - emails: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]?, - employment: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment?, - employment_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status?, - encrypted_ssn: String?, - end_date: String?, - ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?, - first_name: String?, - gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?, - income: FinchAPI::Models::Income?, - income_history: ::Array[FinchAPI::Models::Income?]?, - is_active: bool?, - last_name: String?, - latest_rehire_date: String?, - location: FinchAPI::Models::Location?, - manager: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager?, - middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, - preferred_name: String?, - residence: FinchAPI::Models::Location?, - source_id: String, - ssn: String?, - start_date: String?, - title: String? + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], + ?department: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department?, + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]?, + ?employment: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status?, + ?encrypted_ssn: String?, + ?end_date: String?, + ?ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?source_id: String, + ?ssn: String?, + ?start_date: String?, + ?title: String? ) -> void | ( ?FinchAPI::Models::Sandbox::DirectoryCreateParams::body @@ -168,7 +168,7 @@ module FinchAPI def value=: (top) -> top def initialize: - (name: String?, value: top) -> void + (?name: String?, ?value: top) -> void | ( ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::custom_field | FinchAPI::BaseModel data @@ -183,7 +183,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::department | FinchAPI::BaseModel data @@ -207,8 +207,8 @@ module FinchAPI def initialize: ( - data: String, - type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? + ?data: String, + ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::email @@ -240,8 +240,8 @@ module FinchAPI def initialize: ( - subtype: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, - type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? + ?subtype: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, + ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment @@ -342,7 +342,7 @@ module FinchAPI def id=: (String) -> String def initialize: - (id: String) -> void + (?id: String) -> void | ( ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::manager | FinchAPI::BaseModel data @@ -366,8 +366,8 @@ module FinchAPI def initialize: ( - data: String, - type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? + ?data: String, + ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::phone_number diff --git a/sig/finch-api/models/sandbox/employment_update_params.rbs b/sig/finch-api/models/sandbox/employment_update_params.rbs index 0e17c6c9..e0d6dc45 100644 --- a/sig/finch-api/models/sandbox/employment_update_params.rbs +++ b/sig/finch-api/models/sandbox/employment_update_params.rbs @@ -72,25 +72,25 @@ module FinchAPI def initialize: ( - class_code: String?, - custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], - department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, - employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, - employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, - end_date: String?, - first_name: String?, - income: FinchAPI::Models::Income?, - income_history: ::Array[FinchAPI::Models::Income?]?, - is_active: bool?, - last_name: String?, - latest_rehire_date: String?, - location: FinchAPI::Models::Location?, - manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, - middle_name: String?, - source_id: String, - start_date: String?, - title: String?, - request_options: FinchAPI::request_opts + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], + ?department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, + ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, + ?middle_name: String?, + ?source_id: String, + ?start_date: String?, + ?title: String?, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::employment_update_params @@ -109,7 +109,7 @@ module FinchAPI def value=: (top) -> top def initialize: - (name: String?, value: top) -> void + (?name: String?, ?value: top) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::custom_field | FinchAPI::BaseModel data @@ -124,7 +124,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::department | FinchAPI::BaseModel data @@ -146,8 +146,8 @@ module FinchAPI def initialize: ( - subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?, - type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? + ?subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?, + ?type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment @@ -214,7 +214,7 @@ module FinchAPI def id=: (String) -> String def initialize: - (id: String) -> void + (?id: String) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::manager | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/sandbox/employment_update_response.rbs b/sig/finch-api/models/sandbox/employment_update_response.rbs index a4091f01..8ef83f68 100644 --- a/sig/finch-api/models/sandbox/employment_update_response.rbs +++ b/sig/finch-api/models/sandbox/employment_update_response.rbs @@ -73,25 +73,25 @@ module FinchAPI def initialize: ( - id: String, - class_code: String?, - custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], - department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?, - employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?, - employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, - end_date: String?, - first_name: String?, - income: FinchAPI::Models::Income?, - income_history: ::Array[FinchAPI::Models::Income?]?, - is_active: bool?, - last_name: String?, - latest_rehire_date: String?, - location: FinchAPI::Models::Location?, - manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, - middle_name: String?, - source_id: String, - start_date: String?, - title: String? + ?id: String, + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], + ?department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?, + ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, + ?middle_name: String?, + ?source_id: String, + ?start_date: String?, + ?title: String? ) -> void | ( ?FinchAPI::Models::Sandbox::employment_update_response @@ -110,7 +110,7 @@ module FinchAPI def value=: (top) -> top def initialize: - (name: String?, value: top) -> void + (?name: String?, ?value: top) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::custom_field | FinchAPI::BaseModel data @@ -125,7 +125,7 @@ module FinchAPI attr_accessor name: String? def initialize: - (name: String?) -> void + (?name: String?) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::department | FinchAPI::BaseModel data @@ -147,8 +147,8 @@ module FinchAPI def initialize: ( - subtype: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype?, - type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_? + ?subtype: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype?, + ?type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment @@ -215,7 +215,7 @@ module FinchAPI def id=: (String) -> String def initialize: - (id: String) -> void + (?id: String) -> void | ( ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::manager | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/sandbox/individual_update_params.rbs b/sig/finch-api/models/sandbox/individual_update_params.rbs index a1806106..c577e8f3 100644 --- a/sig/finch-api/models/sandbox/individual_update_params.rbs +++ b/sig/finch-api/models/sandbox/individual_update_params.rbs @@ -48,19 +48,19 @@ module FinchAPI def initialize: ( - dob: String?, - emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, - encrypted_ssn: String?, - ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, - first_name: String?, - gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, - last_name: String?, - middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, - preferred_name: String?, - residence: FinchAPI::Models::Location?, - ssn: String?, - request_options: FinchAPI::request_opts + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String?, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::individual_update_params @@ -84,8 +84,8 @@ module FinchAPI def initialize: ( - data: String, - type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::IndividualUpdateParams::email @@ -153,8 +153,8 @@ module FinchAPI def initialize: ( - data: String, - type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::IndividualUpdateParams::phone_number diff --git a/sig/finch-api/models/sandbox/individual_update_response.rbs b/sig/finch-api/models/sandbox/individual_update_response.rbs index bee43ce3..9b16ce29 100644 --- a/sig/finch-api/models/sandbox/individual_update_response.rbs +++ b/sig/finch-api/models/sandbox/individual_update_response.rbs @@ -49,19 +49,19 @@ module FinchAPI def initialize: ( - id: String, - dob: String?, - emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]?, - encrypted_ssn: String?, - ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateResponse::ethnicity?, - first_name: String?, - gender: FinchAPI::Models::Sandbox::IndividualUpdateResponse::gender?, - last_name: String?, - middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber?]?, - preferred_name: String?, - residence: FinchAPI::Models::Location?, - ssn: String? + ?id: String, + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateResponse::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::IndividualUpdateResponse::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String? ) -> void | ( ?FinchAPI::Models::Sandbox::individual_update_response @@ -85,8 +85,8 @@ module FinchAPI def initialize: ( - data: String, - type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_? + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::IndividualUpdateResponse::email @@ -154,8 +154,8 @@ module FinchAPI def initialize: ( - data: String, - type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_? + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::IndividualUpdateResponse::phone_number diff --git a/sig/finch-api/models/sandbox/job_create_params.rbs b/sig/finch-api/models/sandbox/job_create_params.rbs index d631c377..6cbfa8d7 100644 --- a/sig/finch-api/models/sandbox/job_create_params.rbs +++ b/sig/finch-api/models/sandbox/job_create_params.rbs @@ -14,7 +14,7 @@ module FinchAPI def initialize: ( type: FinchAPI::Models::Sandbox::JobCreateParams::type_, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::job_create_params diff --git a/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs b/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs index f70d8c91..f82f1353 100644 --- a/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +++ b/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs @@ -9,7 +9,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs b/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs index c5390dc7..4a4fb42e 100644 --- a/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +++ b/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs @@ -9,7 +9,7 @@ module FinchAPI include FinchAPI::RequestParameters def initialize: - (request_options: FinchAPI::request_opts) -> void + (?request_options: FinchAPI::request_opts) -> void | ( ?FinchAPI::Models::Sandbox::Jobs::configuration_update_params | FinchAPI::BaseModel data diff --git a/sig/finch-api/models/sandbox/payment_create_params.rbs b/sig/finch-api/models/sandbox/payment_create_params.rbs index f33ec80f..05daae33 100644 --- a/sig/finch-api/models/sandbox/payment_create_params.rbs +++ b/sig/finch-api/models/sandbox/payment_create_params.rbs @@ -29,10 +29,10 @@ module FinchAPI def initialize: ( - end_date: String, - pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], - start_date: String, - request_options: FinchAPI::request_opts + ?end_date: String, + ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + ?start_date: String, + ?request_options: FinchAPI::request_opts ) -> void | ( ?FinchAPI::Models::Sandbox::payment_create_params @@ -80,16 +80,16 @@ module FinchAPI def initialize: ( - earnings: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning?]?, - employee_deductions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]?, - employer_contributions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]?, - gross_pay: FinchAPI::Models::Money?, - individual_id: String, - net_pay: FinchAPI::Models::Money?, - payment_method: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method?, - taxes: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax?]?, - total_hours: Float?, - type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? + ?earnings: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning?]?, + ?employee_deductions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]?, + ?employer_contributions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]?, + ?gross_pay: FinchAPI::Models::Money?, + ?individual_id: String, + ?net_pay: FinchAPI::Models::Money?, + ?payment_method: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method?, + ?taxes: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax?]?, + ?total_hours: Float?, + ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::pay_statement @@ -123,12 +123,12 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, - currency: String?, - hours: Float?, - name: String?, - type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, + ?currency: String?, + ?hours: Float?, + ?name: String?, + ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::earning @@ -151,7 +151,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::attributes @@ -168,7 +168,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::metadata | FinchAPI::BaseModel data @@ -237,12 +237,12 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes?, - currency: String?, - name: String?, - pre_tax: bool?, - type: FinchAPI::Models::HRIS::benefit_type? + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes?, + ?currency: String?, + ?name: String?, + ?pre_tax: bool?, + ?type: FinchAPI::Models::HRIS::benefit_type? ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::employee_deduction @@ -265,7 +265,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::attributes @@ -282,7 +282,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::metadata | FinchAPI::BaseModel data @@ -315,11 +315,11 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes?, - currency: String?, - name: String?, - type: FinchAPI::Models::HRIS::benefit_type? + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes?, + ?currency: String?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::benefit_type? ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::employer_contribution @@ -342,7 +342,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::attributes @@ -359,7 +359,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::metadata | FinchAPI::BaseModel data @@ -404,12 +404,12 @@ module FinchAPI def initialize: ( - amount: Integer?, - attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, - currency: String?, - employer: bool?, - name: String?, - type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, + ?currency: String?, + ?employer: bool?, + ?name: String?, + ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::tax @@ -432,7 +432,7 @@ module FinchAPI def initialize: ( - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata ) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::attributes @@ -449,7 +449,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] def initialize: - (metadata: ::Hash[Symbol, top]) -> void + (?metadata: ::Hash[Symbol, top]) -> void | ( ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::metadata | FinchAPI::BaseModel data diff --git a/sig/finch-api/pooled_net_requester.rbs b/sig/finch-api/pooled_net_requester.rbs index 5b786695..32ebb5b5 100644 --- a/sig/finch-api/pooled_net_requester.rbs +++ b/sig/finch-api/pooled_net_requester.rbs @@ -32,6 +32,6 @@ module FinchAPI FinchAPI::PooledNetRequester::request request ) -> [Integer, top, Enumerable[String]] - def initialize: (size: Integer) -> void + def initialize: (?size: Integer) -> void end end diff --git a/sig/finch-api/resources/access_tokens.rbs b/sig/finch-api/resources/access_tokens.rbs index a5f8e6ce..c1172620 100644 --- a/sig/finch-api/resources/access_tokens.rbs +++ b/sig/finch-api/resources/access_tokens.rbs @@ -7,10 +7,10 @@ module FinchAPI ) -> FinchAPI::Models::CreateAccessTokenResponse | ( code: String, - client_id: String, - client_secret: String, - redirect_uri: String, - request_options: FinchAPI::request_opts + ?client_id: String, + ?client_secret: String, + ?redirect_uri: String, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::CreateAccessTokenResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/account.rbs b/sig/finch-api/resources/account.rbs index 4731d4d7..1e079fc7 100644 --- a/sig/finch-api/resources/account.rbs +++ b/sig/finch-api/resources/account.rbs @@ -7,7 +7,7 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::DisconnectResponse | ( - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::DisconnectResponse def introspect: @@ -16,7 +16,7 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::Introspection | ( - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Introspection def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/connect/sessions.rbs b/sig/finch-api/resources/connect/sessions.rbs index ba88be0e..f609b4e5 100644 --- a/sig/finch-api/resources/connect/sessions.rbs +++ b/sig/finch-api/resources/connect/sessions.rbs @@ -11,13 +11,13 @@ module FinchAPI customer_id: String, customer_name: String, products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], - customer_email: String?, - integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, - manual: bool?, - minutes_to_expire: Float?, - redirect_uri: String?, - sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, - request_options: FinchAPI::request_opts + ?customer_email: String?, + ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, + ?manual: bool?, + ?minutes_to_expire: Float?, + ?redirect_uri: String?, + ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Connect::SessionNewResponse def reauthenticate: @@ -27,10 +27,10 @@ module FinchAPI ) -> FinchAPI::Models::Connect::SessionReauthenticateResponse | ( connection_id: String, - minutes_to_expire: Integer?, - products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, - redirect_uri: String?, - request_options: FinchAPI::request_opts + ?minutes_to_expire: Integer?, + ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, + ?redirect_uri: String?, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Connect::SessionReauthenticateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/benefits.rbs b/sig/finch-api/resources/hris/benefits.rbs index 8d95c109..9dd301aa 100644 --- a/sig/finch-api/resources/hris/benefits.rbs +++ b/sig/finch-api/resources/hris/benefits.rbs @@ -10,10 +10,10 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse | ( - description: String, - frequency: FinchAPI::Models::HRIS::benefit_frequency?, - type: FinchAPI::Models::HRIS::benefit_type?, - request_options: FinchAPI::request_opts + ?description: String, + ?frequency: FinchAPI::Models::HRIS::benefit_frequency?, + ?type: FinchAPI::Models::HRIS::benefit_type?, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse def retrieve: @@ -24,7 +24,7 @@ module FinchAPI ) -> FinchAPI::Models::HRIS::CompanyBenefit | ( String benefit_id, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::CompanyBenefit def update: @@ -35,8 +35,8 @@ module FinchAPI ) -> FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse | ( String benefit_id, - description: String, - request_options: FinchAPI::request_opts + ?description: String, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse def list: @@ -45,7 +45,7 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit] | ( - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit] def list_supported_benefits: @@ -54,7 +54,7 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit] | ( - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/benefits/individuals.rbs b/sig/finch-api/resources/hris/benefits/individuals.rbs index 465d2e76..97304583 100644 --- a/sig/finch-api/resources/hris/benefits/individuals.rbs +++ b/sig/finch-api/resources/hris/benefits/individuals.rbs @@ -11,8 +11,8 @@ module FinchAPI ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual] | ( String benefit_id, - individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], - request_options: FinchAPI::request_opts + ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual] def enrolled_ids: @@ -23,7 +23,7 @@ module FinchAPI ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse | ( String benefit_id, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse def retrieve_many_benefits: @@ -34,8 +34,8 @@ module FinchAPI ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit] | ( String benefit_id, - individual_ids: String, - request_options: FinchAPI::request_opts + ?individual_ids: String, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit] def unenroll_many: @@ -46,8 +46,8 @@ module FinchAPI ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual] | ( String benefit_id, - individual_ids: ::Array[String], - request_options: FinchAPI::request_opts + ?individual_ids: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/company.rbs b/sig/finch-api/resources/hris/company.rbs index 2bcf0434..f2d563db 100644 --- a/sig/finch-api/resources/hris/company.rbs +++ b/sig/finch-api/resources/hris/company.rbs @@ -8,7 +8,7 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::HRIS::HRISCompany | ( - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::HRISCompany def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/directory.rbs b/sig/finch-api/resources/hris/directory.rbs index c38e8eec..195346f4 100644 --- a/sig/finch-api/resources/hris/directory.rbs +++ b/sig/finch-api/resources/hris/directory.rbs @@ -8,9 +8,9 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] | ( - limit: Integer, - offset: Integer, - request_options: FinchAPI::request_opts + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] alias list_individuals list diff --git a/sig/finch-api/resources/hris/documents.rbs b/sig/finch-api/resources/hris/documents.rbs index 330be456..8ef02131 100644 --- a/sig/finch-api/resources/hris/documents.rbs +++ b/sig/finch-api/resources/hris/documents.rbs @@ -8,11 +8,11 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::HRIS::DocumentListResponse | ( - individual_ids: ::Array[String], - limit: Integer, - offset: Integer, - types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], - request_options: FinchAPI::request_opts + ?individual_ids: ::Array[String], + ?limit: Integer, + ?offset: Integer, + ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::DocumentListResponse def retreive: @@ -23,7 +23,7 @@ module FinchAPI ) -> FinchAPI::Models::HRIS::document_retreive_response | ( String document_id, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::HRIS::document_retreive_response def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/employments.rbs b/sig/finch-api/resources/hris/employments.rbs index 81511729..25e71a0e 100644 --- a/sig/finch-api/resources/hris/employments.rbs +++ b/sig/finch-api/resources/hris/employments.rbs @@ -9,7 +9,7 @@ module FinchAPI ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse] | ( requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/individuals.rbs b/sig/finch-api/resources/hris/individuals.rbs index a7880ccd..b5d9ba9b 100644 --- a/sig/finch-api/resources/hris/individuals.rbs +++ b/sig/finch-api/resources/hris/individuals.rbs @@ -8,9 +8,9 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse] | ( - options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, - requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], - request_options: FinchAPI::request_opts + ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, + ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/pay_statements.rbs b/sig/finch-api/resources/hris/pay_statements.rbs index 310292ca..ebc9d193 100644 --- a/sig/finch-api/resources/hris/pay_statements.rbs +++ b/sig/finch-api/resources/hris/pay_statements.rbs @@ -9,7 +9,7 @@ module FinchAPI ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse] | ( requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/hris/payments.rbs b/sig/finch-api/resources/hris/payments.rbs index a62fcd29..fd039621 100644 --- a/sig/finch-api/resources/hris/payments.rbs +++ b/sig/finch-api/resources/hris/payments.rbs @@ -10,7 +10,7 @@ module FinchAPI | ( end_date: Date, start_date: Date, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Payment] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/jobs/automated.rbs b/sig/finch-api/resources/jobs/automated.rbs index 438ca4f3..3e71eef8 100644 --- a/sig/finch-api/resources/jobs/automated.rbs +++ b/sig/finch-api/resources/jobs/automated.rbs @@ -10,7 +10,7 @@ module FinchAPI | ( type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Jobs::AutomatedCreateResponse def retrieve: @@ -21,7 +21,7 @@ module FinchAPI ) -> FinchAPI::Models::Jobs::AutomatedAsyncJob | ( String job_id, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Jobs::AutomatedAsyncJob def list: @@ -30,9 +30,9 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::Jobs::AutomatedListResponse | ( - limit: Integer, - offset: Integer, - request_options: FinchAPI::request_opts + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Jobs::AutomatedListResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/jobs/manual.rbs b/sig/finch-api/resources/jobs/manual.rbs index 503befd6..820281b2 100644 --- a/sig/finch-api/resources/jobs/manual.rbs +++ b/sig/finch-api/resources/jobs/manual.rbs @@ -10,7 +10,7 @@ module FinchAPI ) -> FinchAPI::Models::Jobs::ManualAsyncJob | ( String job_id, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Jobs::ManualAsyncJob def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/payroll/pay_groups.rbs b/sig/finch-api/resources/payroll/pay_groups.rbs index c65a495a..71c8b293 100644 --- a/sig/finch-api/resources/payroll/pay_groups.rbs +++ b/sig/finch-api/resources/payroll/pay_groups.rbs @@ -10,7 +10,7 @@ module FinchAPI ) -> FinchAPI::Models::Payroll::PayGroupRetrieveResponse | ( String pay_group_id, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Payroll::PayGroupRetrieveResponse def list: @@ -19,9 +19,9 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::SinglePage[FinchAPI::Models::Payroll::PayGroupListResponse] | ( - individual_id: String, - pay_frequencies: ::Array[String], - request_options: FinchAPI::request_opts + ?individual_id: String, + ?pay_frequencies: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::Payroll::PayGroupListResponse] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/providers.rbs b/sig/finch-api/resources/providers.rbs index 3df737da..5d5d9eff 100644 --- a/sig/finch-api/resources/providers.rbs +++ b/sig/finch-api/resources/providers.rbs @@ -6,7 +6,7 @@ module FinchAPI ?FinchAPI::Models::ProviderListParams | ::Hash[Symbol, top] params ) -> FinchAPI::SinglePage[FinchAPI::Models::Provider] | ( - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::SinglePage[FinchAPI::Models::Provider] def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/request_forwarding.rbs b/sig/finch-api/resources/request_forwarding.rbs index 7b7d4ee4..77201bb2 100644 --- a/sig/finch-api/resources/request_forwarding.rbs +++ b/sig/finch-api/resources/request_forwarding.rbs @@ -9,10 +9,10 @@ module FinchAPI | ( method_: String, route: String, - data: String?, - headers: top?, - params: top?, - request_options: FinchAPI::request_opts + ?data: String?, + ?headers: top?, + ?params: top?, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::RequestForwardingForwardResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/company.rbs b/sig/finch-api/resources/sandbox/company.rbs index a9591830..10c48227 100644 --- a/sig/finch-api/resources/sandbox/company.rbs +++ b/sig/finch-api/resources/sandbox/company.rbs @@ -16,7 +16,7 @@ module FinchAPI locations: ::Array[FinchAPI::Models::Location?]?, primary_email: String?, primary_phone_number: String?, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::CompanyUpdateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/connections.rbs b/sig/finch-api/resources/sandbox/connections.rbs index 7e750f44..bb1a14d4 100644 --- a/sig/finch-api/resources/sandbox/connections.rbs +++ b/sig/finch-api/resources/sandbox/connections.rbs @@ -11,10 +11,10 @@ module FinchAPI ) -> FinchAPI::Models::Sandbox::ConnectionCreateResponse | ( provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, - employee_size: Integer, - products: ::Array[String], - request_options: FinchAPI::request_opts + ?authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, + ?employee_size: Integer, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::ConnectionCreateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/connections/accounts.rbs b/sig/finch-api/resources/sandbox/connections/accounts.rbs index c200782e..2f0862c2 100644 --- a/sig/finch-api/resources/sandbox/connections/accounts.rbs +++ b/sig/finch-api/resources/sandbox/connections/accounts.rbs @@ -11,9 +11,9 @@ module FinchAPI | ( company_id: String, provider_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, - products: ::Array[String], - request_options: FinchAPI::request_opts + ?authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::Connections::AccountCreateResponse def update: @@ -22,8 +22,8 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse | ( - connection_status: FinchAPI::Models::connection_status_type, - request_options: FinchAPI::request_opts + ?connection_status: FinchAPI::Models::connection_status_type, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/directory.rbs b/sig/finch-api/resources/sandbox/directory.rbs index bc3cd7ca..4b37a477 100644 --- a/sig/finch-api/resources/sandbox/directory.rbs +++ b/sig/finch-api/resources/sandbox/directory.rbs @@ -8,8 +8,8 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::Sandbox::directory_create_response | ( - body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], - request_options: FinchAPI::request_opts + ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::directory_create_response def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/employment.rbs b/sig/finch-api/resources/sandbox/employment.rbs index e5c02114..75ef13ad 100644 --- a/sig/finch-api/resources/sandbox/employment.rbs +++ b/sig/finch-api/resources/sandbox/employment.rbs @@ -10,25 +10,25 @@ module FinchAPI ) -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse | ( String individual_id, - class_code: String?, - custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], - department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, - employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, - employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, - end_date: String?, - first_name: String?, - income: FinchAPI::Models::Income?, - income_history: ::Array[FinchAPI::Models::Income?]?, - is_active: bool?, - last_name: String?, - latest_rehire_date: String?, - location: FinchAPI::Models::Location?, - manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, - middle_name: String?, - source_id: String, - start_date: String?, - title: String?, - request_options: FinchAPI::request_opts + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], + ?department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, + ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, + ?middle_name: String?, + ?source_id: String, + ?start_date: String?, + ?title: String?, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/individual.rbs b/sig/finch-api/resources/sandbox/individual.rbs index c1cfa425..679b3e98 100644 --- a/sig/finch-api/resources/sandbox/individual.rbs +++ b/sig/finch-api/resources/sandbox/individual.rbs @@ -10,19 +10,19 @@ module FinchAPI ) -> FinchAPI::Models::Sandbox::IndividualUpdateResponse | ( String individual_id, - dob: String?, - emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, - encrypted_ssn: String?, - ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, - first_name: String?, - gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, - last_name: String?, - middle_name: String?, - phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, - preferred_name: String?, - residence: FinchAPI::Models::Location?, - ssn: String?, - request_options: FinchAPI::request_opts + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String?, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::IndividualUpdateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/jobs.rbs b/sig/finch-api/resources/sandbox/jobs.rbs index 6b39676f..c72de5b3 100644 --- a/sig/finch-api/resources/sandbox/jobs.rbs +++ b/sig/finch-api/resources/sandbox/jobs.rbs @@ -11,7 +11,7 @@ module FinchAPI ) -> FinchAPI::Models::Sandbox::JobCreateResponse | ( type: FinchAPI::Models::Sandbox::JobCreateParams::type_, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::JobCreateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/jobs/configuration.rbs b/sig/finch-api/resources/sandbox/jobs/configuration.rbs index c6bcdef1..9bccc436 100644 --- a/sig/finch-api/resources/sandbox/jobs/configuration.rbs +++ b/sig/finch-api/resources/sandbox/jobs/configuration.rbs @@ -9,7 +9,7 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_response | ( - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_response def update: @@ -20,7 +20,7 @@ module FinchAPI | ( completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status, type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_, - request_options: FinchAPI::request_opts + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/resources/sandbox/payment.rbs b/sig/finch-api/resources/sandbox/payment.rbs index f68c17da..bf8c2b10 100644 --- a/sig/finch-api/resources/sandbox/payment.rbs +++ b/sig/finch-api/resources/sandbox/payment.rbs @@ -8,10 +8,10 @@ module FinchAPI | ::Hash[Symbol, top] params ) -> FinchAPI::Models::Sandbox::PaymentCreateResponse | ( - end_date: String, - pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], - start_date: String, - request_options: FinchAPI::request_opts + ?end_date: String, + ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + ?start_date: String, + ?request_options: FinchAPI::request_opts ) -> FinchAPI::Models::Sandbox::PaymentCreateResponse def initialize: (client: FinchAPI::Client) -> void diff --git a/sig/finch-api/util.rbs b/sig/finch-api/util.rbs index aac98696..26b7fe56 100644 --- a/sig/finch-api/util.rbs +++ b/sig/finch-api/util.rbs @@ -20,12 +20,12 @@ module FinchAPI OMIT: top - def self?.deep_merge_lr: (top lhs, top rhs, concat: bool) -> top + def self?.deep_merge_lr: (top lhs, top rhs, ?concat: bool) -> top def self?.deep_merge: ( *::Array[top] values, - sentinel: top?, - concat: bool + ?sentinel: top?, + ?concat: bool ) -> top def self?.dig: ( @@ -104,12 +104,12 @@ module FinchAPI def self?.decode_content: ( ::Hash[String, String] headers, stream: Enumerable[String], - suppress_error: bool + ?suppress_error: bool ) -> top def self?.fused_enum: ( Enumerable[top] enum, - external: bool + ?external: bool ) { -> void } -> Enumerable[top] From 2d717426f7371291b3d6cde32f63d179a3ba5da0 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 17:35:16 +0000 Subject: [PATCH 51/67] chore: disable overloads in `*.rbs` definitions for readable LSP errors (#54) --- .../models/access_token_create_params.rbs | 19 +- .../models/account_disconnect_params.rbs | 7 +- .../models/account_introspect_params.rbs | 7 +- sig/finch-api/models/account_update_event.rbs | 545 ++++++----------- sig/finch-api/models/base_webhook_event.rbs | 10 +- sig/finch-api/models/company_event.rbs | 10 +- .../models/connect/session_new_params.rbs | 42 +- .../models/connect/session_new_response.rbs | 7 +- .../connect/session_reauthenticate_params.rbs | 19 +- .../session_reauthenticate_response.rbs | 7 +- .../models/create_access_token_response.rbs | 29 +- sig/finch-api/models/directory_event.rbs | 18 +- sig/finch-api/models/disconnect_response.rbs | 6 +- sig/finch-api/models/employment_event.rbs | 18 +- .../models/hris/benefit_contribution.rbs | 13 +- .../models/hris/benefit_create_params.rbs | 17 +- .../hris/benefit_features_and_operations.rbs | 36 +- .../models/hris/benefit_list_params.rbs | 7 +- ...benefit_list_supported_benefits_params.rbs | 7 +- .../models/hris/benefit_retrieve_params.rbs | 7 +- .../models/hris/benefit_update_params.rbs | 13 +- .../hris/benefits/enrolled_individual.rbs | 26 +- .../hris/benefits/individual_benefit.rbs | 34 +- .../individual_enroll_many_params.rbs | 71 +-- .../individual_enrolled_ids_params.rbs | 7 +- .../individual_enrolled_ids_response.rbs | 10 +- ...dividual_retrieve_many_benefits_params.rbs | 13 +- .../individual_unenroll_many_params.rbs | 13 +- .../hris/benefits/unenrolled_individual.rbs | 26 +- .../models/hris/benefits_support.rbs | 32 +- sig/finch-api/models/hris/company.rbs | 78 +-- sig/finch-api/models/hris/company_benefit.rbs | 16 +- .../models/hris/company_retrieve_params.rbs | 7 +- .../hris/create_company_benefits_response.rbs | 7 +- .../directory_list_individuals_params.rbs | 15 +- .../models/hris/directory_list_params.rbs | 15 +- .../models/hris/document_list_params.rbs | 19 +- .../models/hris/document_list_response.rbs | 13 +- .../models/hris/document_response.rbs | 19 +- .../models/hris/document_retreive_params.rbs | 7 +- sig/finch-api/models/hris/employment_data.rbs | 82 +-- .../models/hris/employment_data_response.rbs | 15 +- .../hris/employment_retrieve_many_params.rbs | 20 +- sig/finch-api/models/hris/individual.rbs | 60 +- .../models/hris/individual_in_directory.rbs | 37 +- .../models/hris/individual_response.rbs | 15 +- .../hris/individual_retrieve_many_params.rbs | 29 +- sig/finch-api/models/hris/pay_statement.rbs | 182 ++---- .../models/hris/pay_statement_response.rbs | 15 +- .../hris/pay_statement_response_body.rbs | 13 +- .../pay_statement_retrieve_many_params.rbs | 24 +- sig/finch-api/models/hris/payment.rbs | 39 +- .../models/hris/payment_list_params.rbs | 15 +- .../models/hris/support_per_benefit_type.rbs | 13 +- .../models/hris/supported_benefit.rbs | 25 +- .../hris/update_company_benefit_response.rbs | 7 +- sig/finch-api/models/hris/w42005.rbs | 30 +- sig/finch-api/models/hris/w42020.rbs | 36 +- sig/finch-api/models/income.rbs | 14 +- sig/finch-api/models/individual_event.rbs | 18 +- sig/finch-api/models/introspection.rbs | 79 +-- sig/finch-api/models/job_completion_event.rbs | 19 +- .../models/jobs/automated_async_job.rbs | 34 +- .../models/jobs/automated_create_params.rbs | 22 +- .../models/jobs/automated_create_response.rbs | 17 +- .../models/jobs/automated_list_params.rbs | 15 +- .../models/jobs/automated_list_response.rbs | 48 +- .../models/jobs/automated_retrieve_params.rbs | 7 +- .../models/jobs/manual_async_job.rbs | 14 +- .../models/jobs/manual_retrieve_params.rbs | 7 +- sig/finch-api/models/location.rbs | 22 +- sig/finch-api/models/money.rbs | 4 +- .../models/operation_support_matrix.rbs | 16 +- sig/finch-api/models/paging.rbs | 4 +- sig/finch-api/models/pay_statement_event.rbs | 19 +- sig/finch-api/models/payment_event.rbs | 16 +- .../models/payroll/pay_group_list_params.rbs | 15 +- .../payroll/pay_group_list_response.rbs | 15 +- .../payroll/pay_group_retrieve_params.rbs | 7 +- .../payroll/pay_group_retrieve_response.rbs | 17 +- sig/finch-api/models/provider.rbs | 546 +++++++----------- sig/finch-api/models/provider_list_params.rbs | 6 +- .../request_forwarding_forward_params.rbs | 21 +- .../request_forwarding_forward_response.rbs | 36 +- .../models/sandbox/company_update_params.rbs | 79 +-- .../sandbox/company_update_response.rbs | 77 +-- .../sandbox/connection_create_params.rbs | 19 +- .../sandbox/connection_create_response.rbs | 25 +- .../connections/account_create_params.rbs | 19 +- .../connections/account_create_response.rbs | 23 +- .../connections/account_update_params.rbs | 13 +- .../connections/account_update_response.rbs | 21 +- .../sandbox/directory_create_params.rbs | 136 ++--- .../sandbox/employment_update_params.rbs | 81 +-- .../sandbox/employment_update_response.rbs | 81 +-- .../sandbox/individual_update_params.rbs | 61 +- .../sandbox/individual_update_response.rbs | 61 +- .../models/sandbox/job_create_params.rbs | 13 +- .../models/sandbox/job_create_response.rbs | 17 +- .../jobs/configuration_retrieve_params.rbs | 7 +- .../jobs/configuration_update_params.rbs | 7 +- .../jobs/sandbox_job_configuration.rbs | 13 +- .../models/sandbox/payment_create_params.rbs | 200 +++---- .../sandbox/payment_create_response.rbs | 7 +- sig/finch-api/resources/access_tokens.rbs | 18 +- sig/finch-api/resources/account.rbs | 22 +- sig/finch-api/resources/connect/sessions.rbs | 48 +- sig/finch-api/resources/hris/benefits.rbs | 69 +-- .../resources/hris/benefits/individuals.rbs | 62 +- sig/finch-api/resources/hris/company.rbs | 11 +- sig/finch-api/resources/hris/directory.rbs | 15 +- sig/finch-api/resources/hris/documents.rbs | 33 +- sig/finch-api/resources/hris/employments.rbs | 13 +- sig/finch-api/resources/hris/individuals.rbs | 15 +- .../resources/hris/pay_statements.rbs | 13 +- sig/finch-api/resources/hris/payments.rbs | 15 +- sig/finch-api/resources/jobs/automated.rbs | 44 +- sig/finch-api/resources/jobs/manual.rbs | 14 +- .../resources/payroll/pay_groups.rbs | 29 +- sig/finch-api/resources/providers.rbs | 10 +- .../resources/request_forwarding.rbs | 21 +- sig/finch-api/resources/sandbox/company.rbs | 27 +- .../resources/sandbox/connections.rbs | 19 +- .../sandbox/connections/accounts.rbs | 32 +- sig/finch-api/resources/sandbox/directory.rbs | 13 +- .../resources/sandbox/employment.rbs | 50 +- .../resources/sandbox/individual.rbs | 38 +- sig/finch-api/resources/sandbox/jobs.rbs | 13 +- .../resources/sandbox/jobs/configuration.rbs | 26 +- sig/finch-api/resources/sandbox/payment.rbs | 17 +- 130 files changed, 1584 insertions(+), 3030 deletions(-) diff --git a/sig/finch-api/models/access_token_create_params.rbs b/sig/finch-api/models/access_token_create_params.rbs index aecbacee..429c58fa 100644 --- a/sig/finch-api/models/access_token_create_params.rbs +++ b/sig/finch-api/models/access_token_create_params.rbs @@ -27,18 +27,13 @@ module FinchAPI def redirect_uri=: (String) -> String - def initialize: - ( - code: String, - ?client_id: String, - ?client_secret: String, - ?redirect_uri: String, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::access_token_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + code: String, + ?client_id: String, + ?client_secret: String, + ?redirect_uri: String, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::access_token_create_params end diff --git a/sig/finch-api/models/account_disconnect_params.rbs b/sig/finch-api/models/account_disconnect_params.rbs index 10ba6015..a0ef5609 100644 --- a/sig/finch-api/models/account_disconnect_params.rbs +++ b/sig/finch-api/models/account_disconnect_params.rbs @@ -6,12 +6,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::account_disconnect_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::account_disconnect_params end diff --git a/sig/finch-api/models/account_introspect_params.rbs b/sig/finch-api/models/account_introspect_params.rbs index 0b796bbe..2068708e 100644 --- a/sig/finch-api/models/account_introspect_params.rbs +++ b/sig/finch-api/models/account_introspect_params.rbs @@ -6,12 +6,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::account_introspect_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::account_introspect_params end diff --git a/sig/finch-api/models/account_update_event.rbs b/sig/finch-api/models/account_update_event.rbs index f8bf6dfa..40a0d08b 100644 --- a/sig/finch-api/models/account_update_event.rbs +++ b/sig/finch-api/models/account_update_event.rbs @@ -19,14 +19,10 @@ module FinchAPI FinchAPI::Models::AccountUpdateEvent::event_type _ ) -> FinchAPI::Models::AccountUpdateEvent::event_type - def initialize: - ( - ?data: FinchAPI::Models::AccountUpdateEvent::Data, - ?event_type: FinchAPI::Models::AccountUpdateEvent::event_type - ) -> void - | ( - ?FinchAPI::Models::account_update_event | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: FinchAPI::Models::AccountUpdateEvent::Data, + ?event_type: FinchAPI::Models::AccountUpdateEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::account_update_event @@ -41,15 +37,10 @@ module FinchAPI attr_accessor status: FinchAPI::Models::connection_status_type - def initialize: - ( - authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, - status: FinchAPI::Models::connection_status_type - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::data - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, + status: FinchAPI::Models::connection_status_type + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::data @@ -71,16 +62,11 @@ module FinchAPI FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ - def initialize: - ( - ?benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, - ?supported_fields: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields?, - ?type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::authentication_method - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, + ?supported_fields: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields?, + ?type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_ + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::authentication_method @@ -138,20 +124,15 @@ module FinchAPI FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment - def initialize: - ( - ?company: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, - ?directory: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, - ?employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, - ?individual: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, - ?pay_group: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, - ?pay_statement: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, - ?payment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::supported_fields - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?company: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + ?directory: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + ?employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + ?individual: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + ?pay_group: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + ?pay_statement: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + ?payment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::supported_fields @@ -213,22 +194,17 @@ module FinchAPI def primary_phone_number=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - ?departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, - ?ein: bool, - ?entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, - ?legal_name: bool, - ?locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, - ?primary_email: bool, - ?primary_phone_number: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::company - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + ?departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + ?ein: bool, + ?entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + ?legal_name: bool, + ?locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + ?primary_email: bool, + ?primary_phone_number: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::company @@ -262,18 +238,13 @@ module FinchAPI def routing_number=: (bool) -> bool - def initialize: - ( - ?account_name: bool, - ?account_number: bool, - ?account_type: bool, - ?institution_name: bool, - ?routing_number: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::accounts - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?account_name: bool, + ?account_number: bool, + ?account_type: bool, + ?institution_name: bool, + ?routing_number: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::accounts end @@ -295,15 +266,10 @@ module FinchAPI FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent - def initialize: - ( - ?name: bool, - ?parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::departments - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?name: bool, + ?parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::departments @@ -314,12 +280,7 @@ module FinchAPI def name=: (bool) -> bool - def initialize: - (?name: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::parent - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::parent end @@ -336,12 +297,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?subtype: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::entity - | FinchAPI::BaseModel data - ) -> void + def initialize: (?subtype: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::entity end @@ -381,19 +337,14 @@ module FinchAPI def state=: (bool) -> bool - def initialize: - ( - ?city: bool, - ?country: bool, - ?line1: bool, - ?line2: bool, - ?postal_code: bool, - ?state: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::locations - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::locations end @@ -418,15 +369,10 @@ module FinchAPI FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging - def initialize: - ( - ?individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - ?paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::directory - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + ?paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::directory @@ -472,20 +418,15 @@ module FinchAPI def middle_name=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?department: bool, - ?first_name: bool, - ?is_active: bool, - ?last_name: bool, - ?manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - ?middle_name: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::individuals - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?department: bool, + ?first_name: bool, + ?is_active: bool, + ?last_name: bool, + ?manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + ?middle_name: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::individuals @@ -496,12 +437,7 @@ module FinchAPI def id=: (bool) -> bool - def initialize: - (?id: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::manager end @@ -518,12 +454,7 @@ module FinchAPI def offset=: (bool) -> bool - def initialize: - (?count: bool, ?offset: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::paging - | FinchAPI::BaseModel data - ) -> void + def initialize: (?count: bool, ?offset: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::paging end @@ -629,30 +560,25 @@ module FinchAPI def title=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?class_code: bool, - ?custom_fields: bool, - ?department: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, - ?employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, - ?employment_status: bool, - ?end_date: bool, - ?first_name: bool, - ?income: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, - ?income_history: bool, - ?is_active: bool, - ?last_name: bool, - ?location: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, - ?manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, - ?middle_name: bool, - ?start_date: bool, - ?title: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?class_code: bool, + ?custom_fields: bool, + ?department: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + ?employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, + ?employment_status: bool, + ?end_date: bool, + ?first_name: bool, + ?income: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, + ?income_history: bool, + ?is_active: bool, + ?last_name: bool, + ?location: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + ?manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, + ?middle_name: bool, + ?start_date: bool, + ?title: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::employment @@ -663,12 +589,7 @@ module FinchAPI def name=: (bool) -> bool - def initialize: - (?name: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::department - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::department end @@ -684,12 +605,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?subtype: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: (?subtype: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::employment end @@ -709,12 +625,11 @@ module FinchAPI def unit=: (bool) -> bool - def initialize: - (?amount: bool, ?currency: bool, ?unit: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::income - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?unit: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::income end @@ -754,19 +669,14 @@ module FinchAPI def state=: (bool) -> bool - def initialize: - ( - ?city: bool, - ?country: bool, - ?line1: bool, - ?line2: bool, - ?postal_code: bool, - ?state: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::location - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::location end @@ -778,12 +688,7 @@ module FinchAPI def id=: (bool) -> bool - def initialize: - (?id: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::manager end @@ -865,26 +770,21 @@ module FinchAPI def ssn=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?dob: bool, - ?emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, - ?encrypted_ssn: bool, - ?ethnicity: bool, - ?first_name: bool, - ?gender: bool, - ?last_name: bool, - ?middle_name: bool, - ?phone_numbers: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - ?preferred_name: bool, - ?residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, - ?ssn: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::individual - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?dob: bool, + ?emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + ?encrypted_ssn: bool, + ?ethnicity: bool, + ?first_name: bool, + ?gender: bool, + ?last_name: bool, + ?middle_name: bool, + ?phone_numbers: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + ?preferred_name: bool, + ?residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + ?ssn: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::individual @@ -899,12 +799,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?data: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::emails - | FinchAPI::BaseModel data - ) -> void + def initialize: (?data: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::emails end @@ -920,12 +815,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?data: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::phone_numbers - | FinchAPI::BaseModel data - ) -> void + def initialize: (?data: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::phone_numbers end @@ -965,19 +855,14 @@ module FinchAPI def state=: (bool) -> bool - def initialize: - ( - ?city: bool, - ?country: bool, - ?line1: bool, - ?line2: bool, - ?postal_code: bool, - ?state: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::residence - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::residence end @@ -1008,17 +893,12 @@ module FinchAPI def pay_frequencies=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?individual_ids: bool, - ?name: bool, - ?pay_frequencies: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_group - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?individual_ids: bool, + ?name: bool, + ?pay_frequencies: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_group end @@ -1042,15 +922,10 @@ module FinchAPI FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - def initialize: - ( - ?paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - ?pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_statement - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + ?pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::pay_statement @@ -1061,12 +936,7 @@ module FinchAPI attr_accessor offset: bool - def initialize: - (count: bool, offset: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::paging - | FinchAPI::BaseModel data - ) -> void + def initialize: (count: bool, offset: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::paging end @@ -1134,23 +1004,18 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?earnings: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - ?employee_deductions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - ?employer_contributions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - ?gross_pay: bool, - ?individual_id: bool, - ?net_pay: bool, - ?payment_method: bool, - ?taxes: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - ?total_hours: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::pay_statements - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?earnings: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + ?employee_deductions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + ?employer_contributions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + ?gross_pay: bool, + ?individual_id: bool, + ?net_pay: bool, + ?payment_method: bool, + ?taxes: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + ?total_hours: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::pay_statements @@ -1174,17 +1039,12 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?amount: bool, - ?currency: bool, - ?name: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?name: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings end @@ -1219,18 +1079,13 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?amount: bool, - ?currency: bool, - ?name: bool, - ?pre_tax: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?name: bool, + ?pre_tax: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions end @@ -1251,12 +1106,11 @@ module FinchAPI def name=: (bool) -> bool - def initialize: - (?amount: bool, ?currency: bool, ?name: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?name: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions end @@ -1291,18 +1145,13 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?amount: bool, - ?currency: bool, - ?employer: bool, - ?name: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?employer: bool, + ?name: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes end @@ -1376,25 +1225,20 @@ module FinchAPI FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod - def initialize: - ( - ?id: bool, - ?company_debit: bool, - ?debit_date: bool, - ?employee_taxes: bool, - ?employer_taxes: bool, - ?gross_pay: bool, - ?individual_ids: bool, - ?net_pay: bool, - ?pay_date: bool, - ?pay_frequencies: bool, - ?pay_group_ids: bool, - ?pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod - ) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::payment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?company_debit: bool, + ?debit_date: bool, + ?employee_taxes: bool, + ?employer_taxes: bool, + ?gross_pay: bool, + ?individual_ids: bool, + ?net_pay: bool, + ?pay_date: bool, + ?pay_frequencies: bool, + ?pay_group_ids: bool, + ?pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::payment @@ -1409,12 +1253,7 @@ module FinchAPI def start_date=: (bool) -> bool - def initialize: - (?end_date: bool, ?start_date: bool) -> void - | ( - ?FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::pay_period - | FinchAPI::BaseModel data - ) -> void + def initialize: (?end_date: bool, ?start_date: bool) -> void def to_hash: -> FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::pay_period end diff --git a/sig/finch-api/models/base_webhook_event.rbs b/sig/finch-api/models/base_webhook_event.rbs index 2f2168cf..1645bf72 100644 --- a/sig/finch-api/models/base_webhook_event.rbs +++ b/sig/finch-api/models/base_webhook_event.rbs @@ -12,11 +12,11 @@ module FinchAPI def connection_id=: (String) -> String - def initialize: - (account_id: String, company_id: String, ?connection_id: String) -> void - | ( - ?FinchAPI::Models::base_webhook_event | FinchAPI::BaseModel data - ) -> void + def initialize: ( + account_id: String, + company_id: String, + ?connection_id: String + ) -> void def to_hash: -> FinchAPI::Models::base_webhook_event end diff --git a/sig/finch-api/models/company_event.rbs b/sig/finch-api/models/company_event.rbs index 1c2622b9..0962e2ae 100644 --- a/sig/finch-api/models/company_event.rbs +++ b/sig/finch-api/models/company_event.rbs @@ -17,12 +17,10 @@ module FinchAPI FinchAPI::Models::CompanyEvent::event_type _ ) -> FinchAPI::Models::CompanyEvent::event_type - def initialize: - ( - ?data: ::Hash[Symbol, top]?, - ?event_type: FinchAPI::Models::CompanyEvent::event_type - ) -> void - | (?FinchAPI::Models::company_event | FinchAPI::BaseModel data) -> void + def initialize: ( + ?data: ::Hash[Symbol, top]?, + ?event_type: FinchAPI::Models::CompanyEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::company_event diff --git a/sig/finch-api/models/connect/session_new_params.rbs b/sig/finch-api/models/connect/session_new_params.rbs index ef5806b9..b85ec28e 100644 --- a/sig/finch-api/models/connect/session_new_params.rbs +++ b/sig/finch-api/models/connect/session_new_params.rbs @@ -37,23 +37,18 @@ module FinchAPI attr_accessor sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox? - def initialize: - ( - customer_id: String, - customer_name: String, - products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], - ?customer_email: String?, - ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, - ?manual: bool?, - ?minutes_to_expire: Float?, - ?redirect_uri: String?, - ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Connect::session_new_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + customer_id: String, + customer_name: String, + products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], + ?customer_email: String?, + ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, + ?manual: bool?, + ?minutes_to_expire: Float?, + ?redirect_uri: String?, + ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Connect::session_new_params @@ -91,15 +86,10 @@ module FinchAPI attr_accessor provider: String? - def initialize: - ( - ?auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?, - ?provider: String? - ) -> void - | ( - ?FinchAPI::Models::Connect::SessionNewParams::integration - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?auth_method: FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method?, + ?provider: String? + ) -> void def to_hash: -> FinchAPI::Models::Connect::SessionNewParams::integration diff --git a/sig/finch-api/models/connect/session_new_response.rbs b/sig/finch-api/models/connect/session_new_response.rbs index fe604178..cf174be8 100644 --- a/sig/finch-api/models/connect/session_new_response.rbs +++ b/sig/finch-api/models/connect/session_new_response.rbs @@ -8,12 +8,7 @@ module FinchAPI attr_accessor session_id: String - def initialize: - (connect_url: String, session_id: String) -> void - | ( - ?FinchAPI::Models::Connect::session_new_response - | FinchAPI::BaseModel data - ) -> void + def initialize: (connect_url: String, session_id: String) -> void def to_hash: -> FinchAPI::Models::Connect::session_new_response end diff --git a/sig/finch-api/models/connect/session_reauthenticate_params.rbs b/sig/finch-api/models/connect/session_reauthenticate_params.rbs index efcd0067..d30841e1 100644 --- a/sig/finch-api/models/connect/session_reauthenticate_params.rbs +++ b/sig/finch-api/models/connect/session_reauthenticate_params.rbs @@ -22,18 +22,13 @@ module FinchAPI attr_accessor redirect_uri: String? - def initialize: - ( - connection_id: String, - ?minutes_to_expire: Integer?, - ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, - ?redirect_uri: String?, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Connect::session_reauthenticate_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + connection_id: String, + ?minutes_to_expire: Integer?, + ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, + ?redirect_uri: String?, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Connect::session_reauthenticate_params diff --git a/sig/finch-api/models/connect/session_reauthenticate_response.rbs b/sig/finch-api/models/connect/session_reauthenticate_response.rbs index dc1c9b89..2c9ccee7 100644 --- a/sig/finch-api/models/connect/session_reauthenticate_response.rbs +++ b/sig/finch-api/models/connect/session_reauthenticate_response.rbs @@ -9,12 +9,7 @@ module FinchAPI attr_accessor session_id: String - def initialize: - (connect_url: String, session_id: String) -> void - | ( - ?FinchAPI::Models::Connect::session_reauthenticate_response - | FinchAPI::BaseModel data - ) -> void + def initialize: (connect_url: String, session_id: String) -> void def to_hash: -> FinchAPI::Models::Connect::session_reauthenticate_response end diff --git a/sig/finch-api/models/create_access_token_response.rbs b/sig/finch-api/models/create_access_token_response.rbs index ce7bc367..b3814aeb 100644 --- a/sig/finch-api/models/create_access_token_response.rbs +++ b/sig/finch-api/models/create_access_token_response.rbs @@ -37,23 +37,18 @@ module FinchAPI def token_type=: (String) -> String - def initialize: - ( - access_token: String, - account_id: String, - client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type, - company_id: String, - connection_id: String, - connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type, - products: ::Array[String], - provider_id: String, - ?customer_id: String?, - ?token_type: String - ) -> void - | ( - ?FinchAPI::Models::create_access_token_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + access_token: String, + account_id: String, + client_type: FinchAPI::Models::CreateAccessTokenResponse::client_type, + company_id: String, + connection_id: String, + connection_type: FinchAPI::Models::CreateAccessTokenResponse::connection_type, + products: ::Array[String], + provider_id: String, + ?customer_id: String?, + ?token_type: String + ) -> void def to_hash: -> FinchAPI::Models::create_access_token_response diff --git a/sig/finch-api/models/directory_event.rbs b/sig/finch-api/models/directory_event.rbs index b3739934..6da280ef 100644 --- a/sig/finch-api/models/directory_event.rbs +++ b/sig/finch-api/models/directory_event.rbs @@ -19,14 +19,10 @@ module FinchAPI FinchAPI::Models::DirectoryEvent::event_type _ ) -> FinchAPI::Models::DirectoryEvent::event_type - def initialize: - ( - ?data: FinchAPI::Models::DirectoryEvent::Data, - ?event_type: FinchAPI::Models::DirectoryEvent::event_type - ) -> void - | ( - ?FinchAPI::Models::directory_event | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: FinchAPI::Models::DirectoryEvent::Data, + ?event_type: FinchAPI::Models::DirectoryEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::directory_event @@ -37,11 +33,7 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - (?individual_id: String) -> void - | ( - ?FinchAPI::Models::DirectoryEvent::data | FinchAPI::BaseModel data - ) -> void + def initialize: (?individual_id: String) -> void def to_hash: -> FinchAPI::Models::DirectoryEvent::data end diff --git a/sig/finch-api/models/disconnect_response.rbs b/sig/finch-api/models/disconnect_response.rbs index c91409c7..41ded8a0 100644 --- a/sig/finch-api/models/disconnect_response.rbs +++ b/sig/finch-api/models/disconnect_response.rbs @@ -5,11 +5,7 @@ module FinchAPI class DisconnectResponse < FinchAPI::BaseModel attr_accessor status: String - def initialize: - (status: String) -> void - | ( - ?FinchAPI::Models::disconnect_response | FinchAPI::BaseModel data - ) -> void + def initialize: (status: String) -> void def to_hash: -> FinchAPI::Models::disconnect_response end diff --git a/sig/finch-api/models/employment_event.rbs b/sig/finch-api/models/employment_event.rbs index 183fecaf..2b965b48 100644 --- a/sig/finch-api/models/employment_event.rbs +++ b/sig/finch-api/models/employment_event.rbs @@ -19,14 +19,10 @@ module FinchAPI FinchAPI::Models::EmploymentEvent::event_type _ ) -> FinchAPI::Models::EmploymentEvent::event_type - def initialize: - ( - ?data: FinchAPI::Models::EmploymentEvent::Data, - ?event_type: FinchAPI::Models::EmploymentEvent::event_type - ) -> void - | ( - ?FinchAPI::Models::employment_event | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: FinchAPI::Models::EmploymentEvent::Data, + ?event_type: FinchAPI::Models::EmploymentEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::employment_event @@ -37,11 +33,7 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - (?individual_id: String) -> void - | ( - ?FinchAPI::Models::EmploymentEvent::data | FinchAPI::BaseModel data - ) -> void + def initialize: (?individual_id: String) -> void def to_hash: -> FinchAPI::Models::EmploymentEvent::data end diff --git a/sig/finch-api/models/hris/benefit_contribution.rbs b/sig/finch-api/models/hris/benefit_contribution.rbs index 2f4458ab..f3b2de17 100644 --- a/sig/finch-api/models/hris/benefit_contribution.rbs +++ b/sig/finch-api/models/hris/benefit_contribution.rbs @@ -12,15 +12,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::BenefitContribution::type_? - def initialize: - ( - ?amount: Integer?, - ?type: FinchAPI::Models::HRIS::BenefitContribution::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::benefit_contribution - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?type: FinchAPI::Models::HRIS::BenefitContribution::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::benefit_contribution diff --git a/sig/finch-api/models/hris/benefit_create_params.rbs b/sig/finch-api/models/hris/benefit_create_params.rbs index 8d6c607c..1408032f 100644 --- a/sig/finch-api/models/hris/benefit_create_params.rbs +++ b/sig/finch-api/models/hris/benefit_create_params.rbs @@ -21,17 +21,12 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? - def initialize: - ( - ?description: String, - ?frequency: FinchAPI::Models::HRIS::benefit_frequency?, - ?type: FinchAPI::Models::HRIS::benefit_type?, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::benefit_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?description: String, + ?frequency: FinchAPI::Models::HRIS::benefit_frequency?, + ?type: FinchAPI::Models::HRIS::benefit_type?, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::benefit_create_params end diff --git a/sig/finch-api/models/hris/benefit_features_and_operations.rbs b/sig/finch-api/models/hris/benefit_features_and_operations.rbs index bf8b9a52..c67fe10f 100644 --- a/sig/finch-api/models/hris/benefit_features_and_operations.rbs +++ b/sig/finch-api/models/hris/benefit_features_and_operations.rbs @@ -20,15 +20,10 @@ module FinchAPI FinchAPI::Models::HRIS::SupportPerBenefitType ) -> FinchAPI::Models::HRIS::SupportPerBenefitType - def initialize: - ( - ?supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - ?supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType - ) -> void - | ( - ?FinchAPI::Models::HRIS::benefit_features_and_operations - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, + ?supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType + ) -> void def to_hash: -> FinchAPI::Models::HRIS::benefit_features_and_operations @@ -62,20 +57,15 @@ module FinchAPI attr_accessor hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? - def initialize: - ( - ?annual_maximum: bool?, - ?catch_up: bool?, - ?company_contribution: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, - ?description: String?, - ?employee_deduction: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, - ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? - ) -> void - | ( - ?FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::supported_features - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?annual_maximum: bool?, + ?catch_up: bool?, + ?company_contribution: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution?]?, + ?description: String?, + ?employee_deduction: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction?]?, + ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], + ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit?]? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::supported_features diff --git a/sig/finch-api/models/hris/benefit_list_params.rbs b/sig/finch-api/models/hris/benefit_list_params.rbs index cf601eaa..ece372b4 100644 --- a/sig/finch-api/models/hris/benefit_list_params.rbs +++ b/sig/finch-api/models/hris/benefit_list_params.rbs @@ -7,12 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::HRIS::benefit_list_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::HRIS::benefit_list_params end diff --git a/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs b/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs index 32103c70..d159fa20 100644 --- a/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs +++ b/sig/finch-api/models/hris/benefit_list_supported_benefits_params.rbs @@ -8,12 +8,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::HRIS::benefit_list_supported_benefits_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::HRIS::benefit_list_supported_benefits_params end diff --git a/sig/finch-api/models/hris/benefit_retrieve_params.rbs b/sig/finch-api/models/hris/benefit_retrieve_params.rbs index a5611080..06135267 100644 --- a/sig/finch-api/models/hris/benefit_retrieve_params.rbs +++ b/sig/finch-api/models/hris/benefit_retrieve_params.rbs @@ -7,12 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::HRIS::benefit_retrieve_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::HRIS::benefit_retrieve_params end diff --git a/sig/finch-api/models/hris/benefit_update_params.rbs b/sig/finch-api/models/hris/benefit_update_params.rbs index 39c2ad01..2061368d 100644 --- a/sig/finch-api/models/hris/benefit_update_params.rbs +++ b/sig/finch-api/models/hris/benefit_update_params.rbs @@ -12,15 +12,10 @@ module FinchAPI def description=: (String) -> String - def initialize: - ( - ?description: String, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::benefit_update_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?description: String, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::benefit_update_params end diff --git a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs index d7b1b7c1..f3ba2533 100644 --- a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +++ b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs @@ -26,16 +26,11 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - ( - ?body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, - ?code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::code, - ?individual_id: String - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::enrolled_individual - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, + ?code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::code, + ?individual_id: String + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::enrolled_individual @@ -48,12 +43,11 @@ module FinchAPI attr_accessor name: String? - def initialize: - (?finch_code: String?, ?message: String?, ?name: String?) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::body - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?finch_code: String?, + ?message: String?, + ?name: String? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::body end diff --git a/sig/finch-api/models/hris/benefits/individual_benefit.rbs b/sig/finch-api/models/hris/benefits/individual_benefit.rbs index fd9fab54..468a1942 100644 --- a/sig/finch-api/models/hris/benefits/individual_benefit.rbs +++ b/sig/finch-api/models/hris/benefits/individual_benefit.rbs @@ -27,16 +27,11 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - ( - ?body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, - ?code: Integer, - ?individual_id: String - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::individual_benefit - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, + ?code: Integer, + ?individual_id: String + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_benefit @@ -60,18 +55,13 @@ module FinchAPI attr_accessor hsa_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? - def initialize: - ( - ?annual_maximum: Integer?, - ?catch_up: bool?, - ?company_contribution: FinchAPI::Models::HRIS::BenefitContribution?, - ?employee_deduction: FinchAPI::Models::HRIS::BenefitContribution?, - ?hsa_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::IndividualBenefit::body - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?annual_maximum: Integer?, + ?catch_up: bool?, + ?company_contribution: FinchAPI::Models::HRIS::BenefitContribution?, + ?employee_deduction: FinchAPI::Models::HRIS::BenefitContribution?, + ?hsa_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualBenefit::body diff --git a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs index 64ec016a..dafbccb0 100644 --- a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs @@ -18,15 +18,10 @@ module FinchAPI ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual] ) -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual] - def initialize: - ( - ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::individual_enroll_many_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enroll_many_params @@ -47,15 +42,10 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - ( - ?configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, - ?individual_id: String - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::individual - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + ?individual_id: String + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::individual @@ -93,18 +83,13 @@ module FinchAPI FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction - def initialize: - ( - ?annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, - ?annual_maximum: Integer?, - ?catch_up: bool, - ?company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, - ?employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::configuration - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit, + ?annual_maximum: Integer?, + ?catch_up: bool, + ?company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + ?employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::configuration @@ -134,15 +119,10 @@ module FinchAPI FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ - def initialize: - ( - ?amount: Integer, - ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::company_contribution - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer, + ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_ + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::company_contribution @@ -173,15 +153,10 @@ module FinchAPI FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ - def initialize: - ( - ?amount: Integer, - ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::employee_deduction - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer, + ?type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_ + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::employee_deduction diff --git a/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs b/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs index 6bf41b3b..2eab6aaa 100644 --- a/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbs @@ -9,12 +9,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_params end diff --git a/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs b/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs index d0a223a4..7e6fd361 100644 --- a/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs +++ b/sig/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbs @@ -10,12 +10,10 @@ module FinchAPI attr_accessor individual_ids: ::Array[String] - def initialize: - (benefit_id: String, individual_ids: ::Array[String]) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + benefit_id: String, + individual_ids: ::Array[String] + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_enrolled_ids_response end diff --git a/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs b/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs index 3753a1d6..108977cb 100644 --- a/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbs @@ -13,15 +13,10 @@ module FinchAPI def individual_ids=: (String) -> String - def initialize: - ( - ?individual_ids: String, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::individual_retrieve_many_benefits_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?individual_ids: String, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_retrieve_many_benefits_params end diff --git a/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs b/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs index 6bcca155..fb69c98c 100644 --- a/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_unenroll_many_params.rbs @@ -13,15 +13,10 @@ module FinchAPI def individual_ids=: (::Array[String]) -> ::Array[String] - def initialize: - ( - ?individual_ids: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::individual_unenroll_many_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?individual_ids: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::individual_unenroll_many_params end diff --git a/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs b/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs index e6425739..3d5aed66 100644 --- a/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs +++ b/sig/finch-api/models/hris/benefits/unenrolled_individual.rbs @@ -24,16 +24,11 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - ( - ?body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, - ?code: Integer, - ?individual_id: String - ) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::unenrolled_individual - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, + ?code: Integer, + ?individual_id: String + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::unenrolled_individual @@ -46,12 +41,11 @@ module FinchAPI attr_accessor name: String? - def initialize: - (?finch_code: String?, ?message: String?, ?name: String?) -> void - | ( - ?FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::body - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?finch_code: String?, + ?message: String?, + ?name: String? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::body end diff --git a/sig/finch-api/models/hris/benefits_support.rbs b/sig/finch-api/models/hris/benefits_support.rbs index 1869522d..3715523e 100644 --- a/sig/finch-api/models/hris/benefits_support.rbs +++ b/sig/finch-api/models/hris/benefits_support.rbs @@ -42,24 +42,20 @@ module FinchAPI attr_accessor simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? - def initialize: - ( - ?commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?s125_dental: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?s125_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?s125_vision: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, - ?simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? - ) -> void - | ( - ?FinchAPI::Models::HRIS::benefits_support | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?commuter: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?custom_post_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?custom_pre_tax: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?fsa_dependent_care: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?fsa_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?hsa_post: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?hsa_pre: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?s125_dental: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?s125_medical: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?s125_vision: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?simple: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations?, + ?simple_ira: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::benefits_support end diff --git a/sig/finch-api/models/hris/company.rbs b/sig/finch-api/models/hris/company.rbs index 44544669..0d2961ed 100644 --- a/sig/finch-api/models/hris/company.rbs +++ b/sig/finch-api/models/hris/company.rbs @@ -33,21 +33,17 @@ module FinchAPI attr_accessor primary_phone_number: String? - def initialize: - ( - id: String, - accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]?, - departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]?, - ein: String?, - entity: FinchAPI::Models::HRIS::HRISCompany::Entity?, - legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, - primary_email: String?, - primary_phone_number: String? - ) -> void - | ( - ?FinchAPI::Models::HRIS::hris_company | FinchAPI::BaseModel data - ) -> void + def initialize: ( + id: String, + accounts: ::Array[FinchAPI::Models::HRIS::HRISCompany::Account]?, + departments: ::Array[FinchAPI::Models::HRIS::HRISCompany::Department?]?, + ein: String?, + entity: FinchAPI::Models::HRIS::HRISCompany::Entity?, + legal_name: String?, + locations: ::Array[FinchAPI::Models::Location?]?, + primary_email: String?, + primary_phone_number: String? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::hris_company @@ -71,18 +67,13 @@ module FinchAPI attr_accessor routing_number: String? - def initialize: - ( - ?account_name: String?, - ?account_number: String?, - ?account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?, - ?institution_name: String?, - ?routing_number: String? - ) -> void - | ( - ?FinchAPI::Models::HRIS::HRISCompany::account - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?account_name: String?, + ?account_number: String?, + ?account_type: FinchAPI::Models::HRIS::HRISCompany::Account::account_type?, + ?institution_name: String?, + ?routing_number: String? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::account @@ -107,15 +98,10 @@ module FinchAPI attr_accessor parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? - def initialize: - ( - ?name: String?, - ?parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? - ) -> void - | ( - ?FinchAPI::Models::HRIS::HRISCompany::department - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?name: String?, + ?parent: FinchAPI::Models::HRIS::HRISCompany::Department::Parent? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::department @@ -124,12 +110,7 @@ module FinchAPI class Parent < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::HRIS::HRISCompany::Department::parent - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::Department::parent end @@ -146,15 +127,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? - def initialize: - ( - ?subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?, - ?type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::HRISCompany::entity - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?subtype: FinchAPI::Models::HRIS::HRISCompany::Entity::subtype?, + ?type: FinchAPI::Models::HRIS::HRISCompany::Entity::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::HRISCompany::entity diff --git a/sig/finch-api/models/hris/company_benefit.rbs b/sig/finch-api/models/hris/company_benefit.rbs index f752768e..5315f436 100644 --- a/sig/finch-api/models/hris/company_benefit.rbs +++ b/sig/finch-api/models/hris/company_benefit.rbs @@ -18,16 +18,12 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? - def initialize: - ( - benefit_id: String, - description: String?, - frequency: FinchAPI::Models::HRIS::benefit_frequency?, - type: FinchAPI::Models::HRIS::benefit_type? - ) -> void - | ( - ?FinchAPI::Models::HRIS::company_benefit | FinchAPI::BaseModel data - ) -> void + def initialize: ( + benefit_id: String, + description: String?, + frequency: FinchAPI::Models::HRIS::benefit_frequency?, + type: FinchAPI::Models::HRIS::benefit_type? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::company_benefit end diff --git a/sig/finch-api/models/hris/company_retrieve_params.rbs b/sig/finch-api/models/hris/company_retrieve_params.rbs index 842fd56a..4dbe3c88 100644 --- a/sig/finch-api/models/hris/company_retrieve_params.rbs +++ b/sig/finch-api/models/hris/company_retrieve_params.rbs @@ -7,12 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::HRIS::company_retrieve_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::HRIS::company_retrieve_params end diff --git a/sig/finch-api/models/hris/create_company_benefits_response.rbs b/sig/finch-api/models/hris/create_company_benefits_response.rbs index bf25635a..5d28b37f 100644 --- a/sig/finch-api/models/hris/create_company_benefits_response.rbs +++ b/sig/finch-api/models/hris/create_company_benefits_response.rbs @@ -6,12 +6,7 @@ module FinchAPI class CreateCompanyBenefitsResponse < FinchAPI::BaseModel attr_accessor benefit_id: String - def initialize: - (benefit_id: String) -> void - | ( - ?FinchAPI::Models::HRIS::create_company_benefits_response - | FinchAPI::BaseModel data - ) -> void + def initialize: (benefit_id: String) -> void def to_hash: -> FinchAPI::Models::HRIS::create_company_benefits_response end diff --git a/sig/finch-api/models/hris/directory_list_individuals_params.rbs b/sig/finch-api/models/hris/directory_list_individuals_params.rbs index 5e8e9df8..05187495 100644 --- a/sig/finch-api/models/hris/directory_list_individuals_params.rbs +++ b/sig/finch-api/models/hris/directory_list_individuals_params.rbs @@ -16,16 +16,11 @@ module FinchAPI def offset=: (Integer) -> Integer - def initialize: - ( - ?limit: Integer, - ?offset: Integer, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::directory_list_individuals_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::directory_list_individuals_params end diff --git a/sig/finch-api/models/hris/directory_list_params.rbs b/sig/finch-api/models/hris/directory_list_params.rbs index e795ac51..340ad765 100644 --- a/sig/finch-api/models/hris/directory_list_params.rbs +++ b/sig/finch-api/models/hris/directory_list_params.rbs @@ -16,16 +16,11 @@ module FinchAPI def offset=: (Integer) -> Integer - def initialize: - ( - ?limit: Integer, - ?offset: Integer, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::directory_list_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::directory_list_params end diff --git a/sig/finch-api/models/hris/document_list_params.rbs b/sig/finch-api/models/hris/document_list_params.rbs index d75cca90..014c6dcd 100644 --- a/sig/finch-api/models/hris/document_list_params.rbs +++ b/sig/finch-api/models/hris/document_list_params.rbs @@ -32,18 +32,13 @@ module FinchAPI ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_] ) -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_] - def initialize: - ( - ?individual_ids: ::Array[String], - ?limit: Integer, - ?offset: Integer, - ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::document_list_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?individual_ids: ::Array[String], + ?limit: Integer, + ?offset: Integer, + ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::document_list_params diff --git a/sig/finch-api/models/hris/document_list_response.rbs b/sig/finch-api/models/hris/document_list_response.rbs index 1a1717c2..d8acfc87 100644 --- a/sig/finch-api/models/hris/document_list_response.rbs +++ b/sig/finch-api/models/hris/document_list_response.rbs @@ -12,15 +12,10 @@ module FinchAPI attr_accessor paging: FinchAPI::Models::Paging - def initialize: - ( - documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse], - paging: FinchAPI::Models::Paging - ) -> void - | ( - ?FinchAPI::Models::HRIS::document_list_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + documents: ::Array[FinchAPI::Models::HRIS::DocumentResponse], + paging: FinchAPI::Models::Paging + ) -> void def to_hash: -> FinchAPI::Models::HRIS::document_list_response end diff --git a/sig/finch-api/models/hris/document_response.rbs b/sig/finch-api/models/hris/document_response.rbs index e3f6d7fb..83d8fcf8 100644 --- a/sig/finch-api/models/hris/document_response.rbs +++ b/sig/finch-api/models/hris/document_response.rbs @@ -29,18 +29,13 @@ module FinchAPI attr_accessor year: Float? - def initialize: - ( - ?id: String, - ?individual_id: String?, - ?type: FinchAPI::Models::HRIS::DocumentResponse::type_, - ?url: String, - ?year: Float? - ) -> void - | ( - ?FinchAPI::Models::HRIS::document_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?individual_id: String?, + ?type: FinchAPI::Models::HRIS::DocumentResponse::type_, + ?url: String, + ?year: Float? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::document_response diff --git a/sig/finch-api/models/hris/document_retreive_params.rbs b/sig/finch-api/models/hris/document_retreive_params.rbs index 3e13b479..bd91a63b 100644 --- a/sig/finch-api/models/hris/document_retreive_params.rbs +++ b/sig/finch-api/models/hris/document_retreive_params.rbs @@ -7,12 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::HRIS::document_retreive_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::HRIS::document_retreive_params end diff --git a/sig/finch-api/models/hris/employment_data.rbs b/sig/finch-api/models/hris/employment_data.rbs index c60f6928..693700db 100644 --- a/sig/finch-api/models/hris/employment_data.rbs +++ b/sig/finch-api/models/hris/employment_data.rbs @@ -68,32 +68,28 @@ module FinchAPI attr_accessor work_id: String? - def initialize: - ( - ?id: String, - ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]?, - ?department: FinchAPI::Models::HRIS::EmploymentData::Department?, - ?employment: FinchAPI::Models::HRIS::EmploymentData::Employment?, - ?employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status?, - ?end_date: String?, - ?first_name: String?, - ?income: FinchAPI::Models::Income?, - ?income_history: ::Array[FinchAPI::Models::Income?]?, - ?is_active: bool?, - ?last_name: String?, - ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::HRIS::EmploymentData::Manager?, - ?middle_name: String?, - ?source_id: String?, - ?start_date: String?, - ?title: String?, - ?work_id: String? - ) -> void - | ( - ?FinchAPI::Models::HRIS::employment_data | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]?, + ?department: FinchAPI::Models::HRIS::EmploymentData::Department?, + ?employment: FinchAPI::Models::HRIS::EmploymentData::Employment?, + ?employment_status: FinchAPI::Models::HRIS::EmploymentData::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::HRIS::EmploymentData::Manager?, + ?middle_name: String?, + ?source_id: String?, + ?start_date: String?, + ?title: String?, + ?work_id: String? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::employment_data @@ -108,12 +104,7 @@ module FinchAPI def value=: (top) -> top - def initialize: - (?name: String, ?value: top) -> void - | ( - ?FinchAPI::Models::HRIS::EmploymentData::custom_field - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String, ?value: top) -> void def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::custom_field end @@ -123,12 +114,7 @@ module FinchAPI class Department < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::HRIS::EmploymentData::department - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::department end @@ -144,15 +130,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? - def initialize: - ( - ?subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?, - ?type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::EmploymentData::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?subtype: FinchAPI::Models::HRIS::EmploymentData::Employment::subtype?, + ?type: FinchAPI::Models::HRIS::EmploymentData::Employment::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::employment @@ -213,12 +194,7 @@ module FinchAPI def id=: (String) -> String - def initialize: - (?id: String) -> void - | ( - ?FinchAPI::Models::HRIS::EmploymentData::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: String) -> void def to_hash: -> FinchAPI::Models::HRIS::EmploymentData::manager end diff --git a/sig/finch-api/models/hris/employment_data_response.rbs b/sig/finch-api/models/hris/employment_data_response.rbs index d195ac77..b543ac26 100644 --- a/sig/finch-api/models/hris/employment_data_response.rbs +++ b/sig/finch-api/models/hris/employment_data_response.rbs @@ -23,16 +23,11 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - ( - ?body: FinchAPI::Models::HRIS::EmploymentData, - ?code: Integer, - ?individual_id: String - ) -> void - | ( - ?FinchAPI::Models::HRIS::employment_data_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?body: FinchAPI::Models::HRIS::EmploymentData, + ?code: Integer, + ?individual_id: String + ) -> void def to_hash: -> FinchAPI::Models::HRIS::employment_data_response end diff --git a/sig/finch-api/models/hris/employment_retrieve_many_params.rbs b/sig/finch-api/models/hris/employment_retrieve_many_params.rbs index b4276767..0c3efcf7 100644 --- a/sig/finch-api/models/hris/employment_retrieve_many_params.rbs +++ b/sig/finch-api/models/hris/employment_retrieve_many_params.rbs @@ -13,15 +13,10 @@ module FinchAPI attr_accessor requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request] - def initialize: - ( - requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::employment_retrieve_many_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::employment_retrieve_many_params @@ -30,12 +25,7 @@ module FinchAPI class Request < FinchAPI::BaseModel attr_accessor individual_id: String - def initialize: - (individual_id: String) -> void - | ( - ?FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::request - | FinchAPI::BaseModel data - ) -> void + def initialize: (individual_id: String) -> void def to_hash: -> FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::request end diff --git a/sig/finch-api/models/hris/individual.rbs b/sig/finch-api/models/hris/individual.rbs index f6bb5418..8c211390 100644 --- a/sig/finch-api/models/hris/individual.rbs +++ b/sig/finch-api/models/hris/individual.rbs @@ -47,25 +47,21 @@ module FinchAPI attr_accessor ssn: String? - def initialize: - ( - ?id: String, - ?dob: String?, - ?emails: ::Array[FinchAPI::Models::HRIS::Individual::Email]?, - ?encrypted_ssn: String?, - ?ethnicity: FinchAPI::Models::HRIS::Individual::ethnicity?, - ?first_name: String?, - ?gender: FinchAPI::Models::HRIS::Individual::gender?, - ?last_name: String?, - ?middle_name: String?, - ?phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber?]?, - ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, - ?ssn: String? - ) -> void - | ( - ?FinchAPI::Models::HRIS::individual | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::HRIS::Individual::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::HRIS::Individual::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::HRIS::Individual::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::individual @@ -82,15 +78,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::Individual::Email::type_? - def initialize: - ( - ?data: String, - ?type: FinchAPI::Models::HRIS::Individual::Email::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::Individual::email - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String, + ?type: FinchAPI::Models::HRIS::Individual::Email::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Individual::email @@ -149,15 +140,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_? - def initialize: - ( - ?data: String?, - ?type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::Individual::phone_number - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String?, + ?type: FinchAPI::Models::HRIS::Individual::PhoneNumber::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::Individual::phone_number diff --git a/sig/finch-api/models/hris/individual_in_directory.rbs b/sig/finch-api/models/hris/individual_in_directory.rbs index 6a8db493..9557dba9 100644 --- a/sig/finch-api/models/hris/individual_in_directory.rbs +++ b/sig/finch-api/models/hris/individual_in_directory.rbs @@ -29,20 +29,15 @@ module FinchAPI attr_accessor middle_name: String? - def initialize: - ( - ?id: String, - ?department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?, - ?first_name: String?, - ?is_active: bool?, - ?last_name: String?, - ?manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?, - ?middle_name: String? - ) -> void - | ( - ?FinchAPI::Models::HRIS::individual_in_directory - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?department: FinchAPI::Models::HRIS::IndividualInDirectory::Department?, + ?first_name: String?, + ?is_active: bool?, + ?last_name: String?, + ?manager: FinchAPI::Models::HRIS::IndividualInDirectory::Manager?, + ?middle_name: String? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::individual_in_directory @@ -51,12 +46,7 @@ module FinchAPI class Department < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::HRIS::IndividualInDirectory::department - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::HRIS::IndividualInDirectory::department end @@ -68,12 +58,7 @@ module FinchAPI def id=: (String) -> String - def initialize: - (?id: String) -> void - | ( - ?FinchAPI::Models::HRIS::IndividualInDirectory::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: String) -> void def to_hash: -> FinchAPI::Models::HRIS::IndividualInDirectory::manager end diff --git a/sig/finch-api/models/hris/individual_response.rbs b/sig/finch-api/models/hris/individual_response.rbs index 3e2dd4ad..fd03877f 100644 --- a/sig/finch-api/models/hris/individual_response.rbs +++ b/sig/finch-api/models/hris/individual_response.rbs @@ -23,16 +23,11 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - ( - ?body: FinchAPI::Models::HRIS::Individual, - ?code: Integer, - ?individual_id: String - ) -> void - | ( - ?FinchAPI::Models::HRIS::individual_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?body: FinchAPI::Models::HRIS::Individual, + ?code: Integer, + ?individual_id: String + ) -> void def to_hash: -> FinchAPI::Models::HRIS::individual_response end diff --git a/sig/finch-api/models/hris/individual_retrieve_many_params.rbs b/sig/finch-api/models/hris/individual_retrieve_many_params.rbs index dacf87c3..d49d4158 100644 --- a/sig/finch-api/models/hris/individual_retrieve_many_params.rbs +++ b/sig/finch-api/models/hris/individual_retrieve_many_params.rbs @@ -20,16 +20,11 @@ module FinchAPI ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request] ) -> ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request] - def initialize: - ( - ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, - ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::individual_retrieve_many_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, + ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::individual_retrieve_many_params @@ -40,12 +35,7 @@ module FinchAPI def include=: (::Array[String]) -> ::Array[String] - def initialize: - (?include: ::Array[String]) -> void - | ( - ?FinchAPI::Models::HRIS::IndividualRetrieveManyParams::options - | FinchAPI::BaseModel data - ) -> void + def initialize: (?include: ::Array[String]) -> void def to_hash: -> FinchAPI::Models::HRIS::IndividualRetrieveManyParams::options end @@ -57,12 +47,7 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - (?individual_id: String) -> void - | ( - ?FinchAPI::Models::HRIS::IndividualRetrieveManyParams::request - | FinchAPI::BaseModel data - ) -> void + def initialize: (?individual_id: String) -> void def to_hash: -> FinchAPI::Models::HRIS::IndividualRetrieveManyParams::request end diff --git a/sig/finch-api/models/hris/pay_statement.rbs b/sig/finch-api/models/hris/pay_statement.rbs index 5ab57b3b..535bd05c 100644 --- a/sig/finch-api/models/hris/pay_statement.rbs +++ b/sig/finch-api/models/hris/pay_statement.rbs @@ -38,22 +38,18 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::PayStatement::type_? - def initialize: - ( - ?earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]?, - ?employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]?, - ?employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]?, - ?gross_pay: FinchAPI::Models::Money?, - ?individual_id: String, - ?net_pay: FinchAPI::Models::Money?, - ?payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?, - ?taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?, - ?total_hours: Float?, - ?type: FinchAPI::Models::HRIS::PayStatement::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::pay_statement | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?earnings: ::Array[FinchAPI::Models::HRIS::PayStatement::Earning?]?, + ?employee_deductions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction?]?, + ?employer_contributions: ::Array[FinchAPI::Models::HRIS::PayStatement::EmployerContribution?]?, + ?gross_pay: FinchAPI::Models::Money?, + ?individual_id: String, + ?net_pay: FinchAPI::Models::Money?, + ?payment_method: FinchAPI::Models::HRIS::PayStatement::payment_method?, + ?taxes: ::Array[FinchAPI::Models::HRIS::PayStatement::Tax?]?, + ?total_hours: Float?, + ?type: FinchAPI::Models::HRIS::PayStatement::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::pay_statement @@ -80,19 +76,14 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?, - ?currency: String?, - ?hours: Float?, - ?name: String?, - ?type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::earning - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes?, + ?currency: String?, + ?hours: Float?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::PayStatement::Earning::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::earning @@ -108,14 +99,9 @@ module FinchAPI FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata ) -> FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::Earning::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Earning::attributes @@ -126,12 +112,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::metadata end @@ -194,19 +175,14 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?, - ?currency: String?, - ?name: String?, - ?pre_tax: bool?, - ?type: FinchAPI::Models::HRIS::benefit_type? - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::employee_deduction - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes?, + ?currency: String?, + ?name: String?, + ?pre_tax: bool?, + ?type: FinchAPI::Models::HRIS::benefit_type? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::employee_deduction @@ -222,14 +198,9 @@ module FinchAPI FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata ) -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::attributes @@ -240,12 +211,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::metadata end @@ -272,18 +238,13 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?, - ?currency: String?, - ?name: String?, - ?type: FinchAPI::Models::HRIS::benefit_type? - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::employer_contribution - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes?, + ?currency: String?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::benefit_type? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::employer_contribution @@ -299,14 +260,9 @@ module FinchAPI FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata ) -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::EmployerContribution::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::attributes @@ -317,12 +273,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::metadata end @@ -361,19 +312,14 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?, - ?currency: String?, - ?employer: bool?, - ?name: String?, - ?type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::tax - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?, + ?currency: String?, + ?employer: bool?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::PayStatement::Tax::type_? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::tax @@ -389,14 +335,9 @@ module FinchAPI FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata ) -> FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::Tax::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Tax::attributes @@ -407,12 +348,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::metadata end diff --git a/sig/finch-api/models/hris/pay_statement_response.rbs b/sig/finch-api/models/hris/pay_statement_response.rbs index 9af9ca71..7896ecb1 100644 --- a/sig/finch-api/models/hris/pay_statement_response.rbs +++ b/sig/finch-api/models/hris/pay_statement_response.rbs @@ -23,16 +23,11 @@ module FinchAPI def payment_id=: (String) -> String - def initialize: - ( - ?body: FinchAPI::Models::HRIS::PayStatementResponseBody, - ?code: Integer, - ?payment_id: String - ) -> void - | ( - ?FinchAPI::Models::HRIS::pay_statement_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?body: FinchAPI::Models::HRIS::PayStatementResponseBody, + ?code: Integer, + ?payment_id: String + ) -> void def to_hash: -> FinchAPI::Models::HRIS::pay_statement_response end diff --git a/sig/finch-api/models/hris/pay_statement_response_body.rbs b/sig/finch-api/models/hris/pay_statement_response_body.rbs index be78e09e..6fecade4 100644 --- a/sig/finch-api/models/hris/pay_statement_response_body.rbs +++ b/sig/finch-api/models/hris/pay_statement_response_body.rbs @@ -18,15 +18,10 @@ module FinchAPI ::Array[FinchAPI::Models::HRIS::PayStatement] ) -> ::Array[FinchAPI::Models::HRIS::PayStatement] - def initialize: - ( - ?paging: FinchAPI::Models::Paging, - ?pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement] - ) -> void - | ( - ?FinchAPI::Models::HRIS::pay_statement_response_body - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?paging: FinchAPI::Models::Paging, + ?pay_statements: ::Array[FinchAPI::Models::HRIS::PayStatement] + ) -> void def to_hash: -> FinchAPI::Models::HRIS::pay_statement_response_body end diff --git a/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs b/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs index 72ec24f1..c58f5ce7 100644 --- a/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs +++ b/sig/finch-api/models/hris/pay_statement_retrieve_many_params.rbs @@ -13,15 +13,10 @@ module FinchAPI attr_accessor requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request] - def initialize: - ( - requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::pay_statement_retrieve_many_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::pay_statement_retrieve_many_params @@ -38,12 +33,11 @@ module FinchAPI def offset=: (Integer) -> Integer - def initialize: - (payment_id: String, ?limit: Integer, ?offset: Integer) -> void - | ( - ?FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::request - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + payment_id: String, + ?limit: Integer, + ?offset: Integer + ) -> void def to_hash: -> FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::request end diff --git a/sig/finch-api/models/hris/payment.rbs b/sig/finch-api/models/hris/payment.rbs index c20f2431..a683248f 100644 --- a/sig/finch-api/models/hris/payment.rbs +++ b/sig/finch-api/models/hris/payment.rbs @@ -44,24 +44,20 @@ module FinchAPI attr_accessor pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? - def initialize: - ( - ?id: String, - ?company_debit: FinchAPI::Models::Money?, - ?debit_date: String?, - ?employee_taxes: FinchAPI::Models::Money?, - ?employer_taxes: FinchAPI::Models::Money?, - ?gross_pay: FinchAPI::Models::Money?, - ?individual_ids: ::Array[String]?, - ?net_pay: FinchAPI::Models::Money?, - ?pay_date: String?, - ?pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?, - ?pay_group_ids: ::Array[String]?, - ?pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? - ) -> void - | ( - ?FinchAPI::Models::HRIS::payment | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?company_debit: FinchAPI::Models::Money?, + ?debit_date: String?, + ?employee_taxes: FinchAPI::Models::Money?, + ?employer_taxes: FinchAPI::Models::Money?, + ?gross_pay: FinchAPI::Models::Money?, + ?individual_ids: ::Array[String]?, + ?net_pay: FinchAPI::Models::Money?, + ?pay_date: String?, + ?pay_frequencies: ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency]?, + ?pay_group_ids: ::Array[String]?, + ?pay_period: FinchAPI::Models::HRIS::Payment::PayPeriod? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::payment @@ -97,12 +93,7 @@ module FinchAPI attr_accessor start_date: String? - def initialize: - (?end_date: String?, ?start_date: String?) -> void - | ( - ?FinchAPI::Models::HRIS::Payment::pay_period - | FinchAPI::BaseModel data - ) -> void + def initialize: (?end_date: String?, ?start_date: String?) -> void def to_hash: -> FinchAPI::Models::HRIS::Payment::pay_period end diff --git a/sig/finch-api/models/hris/payment_list_params.rbs b/sig/finch-api/models/hris/payment_list_params.rbs index 4da21241..92ed6229 100644 --- a/sig/finch-api/models/hris/payment_list_params.rbs +++ b/sig/finch-api/models/hris/payment_list_params.rbs @@ -12,16 +12,11 @@ module FinchAPI attr_accessor start_date: Date - def initialize: - ( - end_date: Date, - start_date: Date, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::HRIS::payment_list_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + end_date: Date, + start_date: Date, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::HRIS::payment_list_params end diff --git a/sig/finch-api/models/hris/support_per_benefit_type.rbs b/sig/finch-api/models/hris/support_per_benefit_type.rbs index c15e407a..02c28d56 100644 --- a/sig/finch-api/models/hris/support_per_benefit_type.rbs +++ b/sig/finch-api/models/hris/support_per_benefit_type.rbs @@ -20,15 +20,10 @@ module FinchAPI FinchAPI::Models::OperationSupportMatrix ) -> FinchAPI::Models::OperationSupportMatrix - def initialize: - ( - ?company_benefits: FinchAPI::Models::OperationSupportMatrix, - ?individual_benefits: FinchAPI::Models::OperationSupportMatrix - ) -> void - | ( - ?FinchAPI::Models::HRIS::support_per_benefit_type - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?company_benefits: FinchAPI::Models::OperationSupportMatrix, + ?individual_benefits: FinchAPI::Models::OperationSupportMatrix + ) -> void def to_hash: -> FinchAPI::Models::HRIS::support_per_benefit_type end diff --git a/sig/finch-api/models/hris/supported_benefit.rbs b/sig/finch-api/models/hris/supported_benefit.rbs index 78dea239..50edc296 100644 --- a/sig/finch-api/models/hris/supported_benefit.rbs +++ b/sig/finch-api/models/hris/supported_benefit.rbs @@ -34,21 +34,16 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? - def initialize: - ( - ?annual_maximum: bool?, - ?catch_up: bool?, - ?company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?, - ?description: String?, - ?employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?, - ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], - ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?, - ?type: FinchAPI::Models::HRIS::benefit_type? - ) -> void - | ( - ?FinchAPI::Models::HRIS::supported_benefit - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?annual_maximum: bool?, + ?catch_up: bool?, + ?company_contribution: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution?]?, + ?description: String?, + ?employee_deduction: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction?]?, + ?frequencies: ::Array[FinchAPI::Models::HRIS::benefit_frequency?], + ?hsa_contribution_limit: ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit?]?, + ?type: FinchAPI::Models::HRIS::benefit_type? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::supported_benefit diff --git a/sig/finch-api/models/hris/update_company_benefit_response.rbs b/sig/finch-api/models/hris/update_company_benefit_response.rbs index 8b0fca4f..7eb00d42 100644 --- a/sig/finch-api/models/hris/update_company_benefit_response.rbs +++ b/sig/finch-api/models/hris/update_company_benefit_response.rbs @@ -6,12 +6,7 @@ module FinchAPI class UpdateCompanyBenefitResponse < FinchAPI::BaseModel attr_accessor benefit_id: String - def initialize: - (benefit_id: String) -> void - | ( - ?FinchAPI::Models::HRIS::update_company_benefit_response - | FinchAPI::BaseModel data - ) -> void + def initialize: (benefit_id: String) -> void def to_hash: -> FinchAPI::Models::HRIS::update_company_benefit_response end diff --git a/sig/finch-api/models/hris/w42005.rbs b/sig/finch-api/models/hris/w42005.rbs index cf4208bd..e7f953b8 100644 --- a/sig/finch-api/models/hris/w42005.rbs +++ b/sig/finch-api/models/hris/w42005.rbs @@ -23,13 +23,11 @@ module FinchAPI attr_accessor year: Float? - def initialize: - ( - ?data: FinchAPI::Models::HRIS::W42005::Data, - ?type: FinchAPI::Models::HRIS::W42005::type_, - ?year: Float? - ) -> void - | (?FinchAPI::Models::HRIS::w42005 | FinchAPI::BaseModel data) -> void + def initialize: ( + ?data: FinchAPI::Models::HRIS::W42005::Data, + ?type: FinchAPI::Models::HRIS::W42005::type_, + ?year: Float? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::w42005 @@ -63,17 +61,13 @@ module FinchAPI 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? - ) -> void - | ( - ?FinchAPI::Models::HRIS::W42005::data | FinchAPI::BaseModel data - ) -> void + 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? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::W42005::data diff --git a/sig/finch-api/models/hris/w42020.rbs b/sig/finch-api/models/hris/w42020.rbs index 27025ac5..a451a37b 100644 --- a/sig/finch-api/models/hris/w42020.rbs +++ b/sig/finch-api/models/hris/w42020.rbs @@ -23,13 +23,11 @@ module FinchAPI attr_accessor year: Float? - def initialize: - ( - ?data: FinchAPI::Models::HRIS::W42020::Data, - ?type: FinchAPI::Models::HRIS::W42020::type_, - ?year: Float? - ) -> void - | (?FinchAPI::Models::HRIS::w42020 | FinchAPI::BaseModel data) -> void + def initialize: ( + ?data: FinchAPI::Models::HRIS::W42020::Data, + ?type: FinchAPI::Models::HRIS::W42020::type_, + ?year: Float? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::w42020 @@ -64,20 +62,16 @@ module FinchAPI 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? - ) -> void - | ( - ?FinchAPI::Models::HRIS::W42020::data | FinchAPI::BaseModel data - ) -> void + 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? + ) -> void def to_hash: -> FinchAPI::Models::HRIS::W42020::data diff --git a/sig/finch-api/models/income.rbs b/sig/finch-api/models/income.rbs index d8eddbf3..9f9eaf12 100644 --- a/sig/finch-api/models/income.rbs +++ b/sig/finch-api/models/income.rbs @@ -17,14 +17,12 @@ module FinchAPI attr_accessor unit: FinchAPI::Models::Income::unit? - def initialize: - ( - ?amount: Integer?, - ?currency: String?, - ?effective_date: String?, - ?unit: FinchAPI::Models::Income::unit? - ) -> void - | (?FinchAPI::Models::income | FinchAPI::BaseModel data) -> void + def initialize: ( + ?amount: Integer?, + ?currency: String?, + ?effective_date: String?, + ?unit: FinchAPI::Models::Income::unit? + ) -> void def to_hash: -> FinchAPI::Models::income diff --git a/sig/finch-api/models/individual_event.rbs b/sig/finch-api/models/individual_event.rbs index f985f76c..d9e5abc6 100644 --- a/sig/finch-api/models/individual_event.rbs +++ b/sig/finch-api/models/individual_event.rbs @@ -19,14 +19,10 @@ module FinchAPI FinchAPI::Models::IndividualEvent::event_type _ ) -> FinchAPI::Models::IndividualEvent::event_type - def initialize: - ( - ?data: FinchAPI::Models::IndividualEvent::Data, - ?event_type: FinchAPI::Models::IndividualEvent::event_type - ) -> void - | ( - ?FinchAPI::Models::individual_event | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: FinchAPI::Models::IndividualEvent::Data, + ?event_type: FinchAPI::Models::IndividualEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::individual_event @@ -37,11 +33,7 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - (?individual_id: String) -> void - | ( - ?FinchAPI::Models::IndividualEvent::data | FinchAPI::BaseModel data - ) -> void + def initialize: (?individual_id: String) -> void def to_hash: -> FinchAPI::Models::IndividualEvent::data end diff --git a/sig/finch-api/models/introspection.rbs b/sig/finch-api/models/introspection.rbs index fdf4b9c2..974492c4 100644 --- a/sig/finch-api/models/introspection.rbs +++ b/sig/finch-api/models/introspection.rbs @@ -53,26 +53,24 @@ module FinchAPI attr_accessor username: String - def initialize: - ( - account_id: String, - authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod], - client_id: String, - client_type: FinchAPI::Models::Introspection::client_type, - company_id: String, - connection_id: String, - connection_status: FinchAPI::Models::Introspection::ConnectionStatus, - connection_type: FinchAPI::Models::Introspection::connection_type, - customer_email: String?, - customer_id: String?, - customer_name: String?, - manual: bool, - payroll_provider_id: String, - products: ::Array[String], - provider_id: String, - username: String - ) -> void - | (?FinchAPI::Models::introspection | FinchAPI::BaseModel data) -> void + def initialize: ( + account_id: String, + authentication_methods: ::Array[FinchAPI::Models::Introspection::AuthenticationMethod], + client_id: String, + client_type: FinchAPI::Models::Introspection::client_type, + company_id: String, + connection_id: String, + connection_status: FinchAPI::Models::Introspection::ConnectionStatus, + connection_type: FinchAPI::Models::Introspection::connection_type, + customer_email: String?, + customer_id: String?, + customer_name: String?, + manual: bool, + payroll_provider_id: String, + products: ::Array[String], + provider_id: String, + username: String + ) -> void def to_hash: -> FinchAPI::Models::introspection @@ -100,16 +98,11 @@ module FinchAPI FinchAPI::Models::Introspection::AuthenticationMethod::type_ ) -> FinchAPI::Models::Introspection::AuthenticationMethod::type_ - def initialize: - ( - ?connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, - ?products: ::Array[String], - ?type: FinchAPI::Models::Introspection::AuthenticationMethod::type_ - ) -> void - | ( - ?FinchAPI::Models::Introspection::authentication_method - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, + ?products: ::Array[String], + ?type: FinchAPI::Models::Introspection::AuthenticationMethod::type_ + ) -> void def to_hash: -> FinchAPI::Models::Introspection::authentication_method @@ -127,15 +120,10 @@ module FinchAPI FinchAPI::Models::connection_status_type ) -> FinchAPI::Models::connection_status_type - def initialize: - ( - ?message: String, - ?status: FinchAPI::Models::connection_status_type - ) -> void - | ( - ?FinchAPI::Models::Introspection::AuthenticationMethod::connection_status - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?message: String, + ?status: FinchAPI::Models::connection_status_type + ) -> void def to_hash: -> FinchAPI::Models::Introspection::AuthenticationMethod::connection_status end @@ -178,15 +166,10 @@ module FinchAPI FinchAPI::Models::connection_status_type ) -> FinchAPI::Models::connection_status_type - def initialize: - ( - ?message: String, - ?status: FinchAPI::Models::connection_status_type - ) -> void - | ( - ?FinchAPI::Models::Introspection::connection_status - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?message: String, + ?status: FinchAPI::Models::connection_status_type + ) -> void def to_hash: -> FinchAPI::Models::Introspection::connection_status end diff --git a/sig/finch-api/models/job_completion_event.rbs b/sig/finch-api/models/job_completion_event.rbs index 2f530d0e..2ef9c5c9 100644 --- a/sig/finch-api/models/job_completion_event.rbs +++ b/sig/finch-api/models/job_completion_event.rbs @@ -19,14 +19,10 @@ module FinchAPI FinchAPI::Models::JobCompletionEvent::event_type _ ) -> FinchAPI::Models::JobCompletionEvent::event_type - def initialize: - ( - ?data: FinchAPI::Models::JobCompletionEvent::Data, - ?event_type: FinchAPI::Models::JobCompletionEvent::event_type - ) -> void - | ( - ?FinchAPI::Models::job_completion_event | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: FinchAPI::Models::JobCompletionEvent::Data, + ?event_type: FinchAPI::Models::JobCompletionEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::job_completion_event @@ -37,12 +33,7 @@ module FinchAPI attr_accessor job_url: String - def initialize: - (job_id: String, job_url: String) -> void - | ( - ?FinchAPI::Models::JobCompletionEvent::data - | FinchAPI::BaseModel data - ) -> void + def initialize: (job_id: String, job_url: String) -> void def to_hash: -> FinchAPI::Models::JobCompletionEvent::data end diff --git a/sig/finch-api/models/jobs/automated_async_job.rbs b/sig/finch-api/models/jobs/automated_async_job.rbs index 6851d480..96bfd9ca 100644 --- a/sig/finch-api/models/jobs/automated_async_job.rbs +++ b/sig/finch-api/models/jobs/automated_async_job.rbs @@ -33,22 +33,17 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_ - def initialize: - ( - completed_at: Time?, - created_at: Time, - job_id: String, - job_url: String, - params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params?, - scheduled_at: Time?, - started_at: Time?, - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_ - ) -> void - | ( - ?FinchAPI::Models::Jobs::automated_async_job - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + completed_at: Time?, + created_at: Time, + job_id: String, + job_url: String, + params: FinchAPI::Models::Jobs::AutomatedAsyncJob::Params?, + scheduled_at: Time?, + started_at: Time?, + status: FinchAPI::Models::Jobs::AutomatedAsyncJob::status, + type: FinchAPI::Models::Jobs::AutomatedAsyncJob::type_ + ) -> void def to_hash: -> FinchAPI::Models::Jobs::automated_async_job @@ -59,12 +54,7 @@ module FinchAPI def individual_id=: (String) -> String - def initialize: - (?individual_id: String) -> void - | ( - ?FinchAPI::Models::Jobs::AutomatedAsyncJob::params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?individual_id: String) -> void def to_hash: -> FinchAPI::Models::Jobs::AutomatedAsyncJob::params end diff --git a/sig/finch-api/models/jobs/automated_create_params.rbs b/sig/finch-api/models/jobs/automated_create_params.rbs index 2d61e6e0..6ad61d01 100644 --- a/sig/finch-api/models/jobs/automated_create_params.rbs +++ b/sig/finch-api/models/jobs/automated_create_params.rbs @@ -16,16 +16,11 @@ module FinchAPI attr_accessor params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params - def initialize: - ( - type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Jobs::automated_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, + params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Jobs::automated_create_params @@ -42,12 +37,7 @@ module FinchAPI class Params < FinchAPI::BaseModel attr_accessor individual_id: String - def initialize: - (individual_id: String) -> void - | ( - ?FinchAPI::Models::Jobs::AutomatedCreateParams::params - | FinchAPI::BaseModel data - ) -> void + def initialize: (individual_id: String) -> void def to_hash: -> FinchAPI::Models::Jobs::AutomatedCreateParams::params end diff --git a/sig/finch-api/models/jobs/automated_create_response.rbs b/sig/finch-api/models/jobs/automated_create_response.rbs index 6f49847f..9fc44570 100644 --- a/sig/finch-api/models/jobs/automated_create_response.rbs +++ b/sig/finch-api/models/jobs/automated_create_response.rbs @@ -18,17 +18,12 @@ module FinchAPI attr_accessor remaining_refreshes: Integer - def initialize: - ( - allowed_refreshes: Integer, - job_id: String, - job_url: String, - remaining_refreshes: Integer - ) -> void - | ( - ?FinchAPI::Models::Jobs::automated_create_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + allowed_refreshes: Integer, + job_id: String, + job_url: String, + remaining_refreshes: Integer + ) -> void def to_hash: -> FinchAPI::Models::Jobs::automated_create_response end diff --git a/sig/finch-api/models/jobs/automated_list_params.rbs b/sig/finch-api/models/jobs/automated_list_params.rbs index 86767b64..c0685155 100644 --- a/sig/finch-api/models/jobs/automated_list_params.rbs +++ b/sig/finch-api/models/jobs/automated_list_params.rbs @@ -16,16 +16,11 @@ module FinchAPI def offset=: (Integer) -> Integer - def initialize: - ( - ?limit: Integer, - ?offset: Integer, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Jobs::automated_list_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Jobs::automated_list_params end diff --git a/sig/finch-api/models/jobs/automated_list_response.rbs b/sig/finch-api/models/jobs/automated_list_response.rbs index 6c57bc25..db32886c 100644 --- a/sig/finch-api/models/jobs/automated_list_response.rbs +++ b/sig/finch-api/models/jobs/automated_list_response.rbs @@ -12,15 +12,10 @@ module FinchAPI attr_accessor meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta - def initialize: - ( - data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], - meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta - ) -> void - | ( - ?FinchAPI::Models::Jobs::automated_list_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + data: ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + ) -> void def to_hash: -> FinchAPI::Models::Jobs::automated_list_response @@ -36,14 +31,9 @@ module FinchAPI FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas ) -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas - def initialize: - ( - ?quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas - ) -> void - | ( - ?FinchAPI::Models::Jobs::AutomatedListResponse::meta - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas + ) -> void def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::meta @@ -59,14 +49,9 @@ module FinchAPI FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll ) -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll - def initialize: - ( - ?data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll - ) -> void - | ( - ?FinchAPI::Models::Jobs::AutomatedListResponse::Meta::quotas - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll + ) -> void def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::quotas @@ -82,15 +67,10 @@ module FinchAPI def remaining_refreshes=: (Integer) -> Integer - def initialize: - ( - ?allowed_refreshes: Integer, - ?remaining_refreshes: Integer - ) -> void - | ( - ?FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::data_sync_all - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?allowed_refreshes: Integer, + ?remaining_refreshes: Integer + ) -> void def to_hash: -> FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::data_sync_all end diff --git a/sig/finch-api/models/jobs/automated_retrieve_params.rbs b/sig/finch-api/models/jobs/automated_retrieve_params.rbs index 7f88d802..9a06a75c 100644 --- a/sig/finch-api/models/jobs/automated_retrieve_params.rbs +++ b/sig/finch-api/models/jobs/automated_retrieve_params.rbs @@ -7,12 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::Jobs::automated_retrieve_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::Jobs::automated_retrieve_params end diff --git a/sig/finch-api/models/jobs/manual_async_job.rbs b/sig/finch-api/models/jobs/manual_async_job.rbs index f34b7368..e79cd3e9 100644 --- a/sig/finch-api/models/jobs/manual_async_job.rbs +++ b/sig/finch-api/models/jobs/manual_async_job.rbs @@ -15,15 +15,11 @@ module FinchAPI attr_accessor status: FinchAPI::Models::Jobs::ManualAsyncJob::status - def initialize: - ( - body: ::Array[top]?, - job_id: String, - status: FinchAPI::Models::Jobs::ManualAsyncJob::status - ) -> void - | ( - ?FinchAPI::Models::Jobs::manual_async_job | FinchAPI::BaseModel data - ) -> void + def initialize: ( + body: ::Array[top]?, + job_id: String, + status: FinchAPI::Models::Jobs::ManualAsyncJob::status + ) -> void def to_hash: -> FinchAPI::Models::Jobs::manual_async_job diff --git a/sig/finch-api/models/jobs/manual_retrieve_params.rbs b/sig/finch-api/models/jobs/manual_retrieve_params.rbs index 2b56b6a5..4bfcc450 100644 --- a/sig/finch-api/models/jobs/manual_retrieve_params.rbs +++ b/sig/finch-api/models/jobs/manual_retrieve_params.rbs @@ -7,12 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::Jobs::manual_retrieve_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::Jobs::manual_retrieve_params end diff --git a/sig/finch-api/models/location.rbs b/sig/finch-api/models/location.rbs index 11413bdc..a77a748a 100644 --- a/sig/finch-api/models/location.rbs +++ b/sig/finch-api/models/location.rbs @@ -29,18 +29,16 @@ module FinchAPI attr_accessor state: String? - def initialize: - ( - ?city: String?, - ?country: String?, - ?line1: String?, - ?line2: String?, - ?name: String?, - ?postal_code: String?, - ?source_id: String?, - ?state: String? - ) -> void - | (?FinchAPI::Models::location | FinchAPI::BaseModel data) -> void + def initialize: ( + ?city: String?, + ?country: String?, + ?line1: String?, + ?line2: String?, + ?name: String?, + ?postal_code: String?, + ?source_id: String?, + ?state: String? + ) -> void def to_hash: -> FinchAPI::Models::location end diff --git a/sig/finch-api/models/money.rbs b/sig/finch-api/models/money.rbs index 33ea0236..bc163b02 100644 --- a/sig/finch-api/models/money.rbs +++ b/sig/finch-api/models/money.rbs @@ -9,9 +9,7 @@ module FinchAPI def currency=: (String) -> String - def initialize: - (?amount: Integer?, ?currency: String) -> void - | (?FinchAPI::Models::money | FinchAPI::BaseModel data) -> void + def initialize: (?amount: Integer?, ?currency: String) -> void def to_hash: -> FinchAPI::Models::money end diff --git a/sig/finch-api/models/operation_support_matrix.rbs b/sig/finch-api/models/operation_support_matrix.rbs index 215d6784..d75af6e9 100644 --- a/sig/finch-api/models/operation_support_matrix.rbs +++ b/sig/finch-api/models/operation_support_matrix.rbs @@ -33,16 +33,12 @@ module FinchAPI FinchAPI::Models::operation_support ) -> FinchAPI::Models::operation_support - def initialize: - ( - ?create: FinchAPI::Models::operation_support, - ?delete: FinchAPI::Models::operation_support, - ?read: FinchAPI::Models::operation_support, - ?update: FinchAPI::Models::operation_support - ) -> void - | ( - ?FinchAPI::Models::operation_support_matrix | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?create: FinchAPI::Models::operation_support, + ?delete: FinchAPI::Models::operation_support, + ?read: FinchAPI::Models::operation_support, + ?update: FinchAPI::Models::operation_support + ) -> void def to_hash: -> FinchAPI::Models::operation_support_matrix end diff --git a/sig/finch-api/models/paging.rbs b/sig/finch-api/models/paging.rbs index 12605589..5c2ec264 100644 --- a/sig/finch-api/models/paging.rbs +++ b/sig/finch-api/models/paging.rbs @@ -11,9 +11,7 @@ module FinchAPI def offset=: (Integer) -> Integer - def initialize: - (?count: Integer, ?offset: Integer) -> void - | (?FinchAPI::Models::paging | FinchAPI::BaseModel data) -> void + def initialize: (?count: Integer, ?offset: Integer) -> void def to_hash: -> FinchAPI::Models::paging end diff --git a/sig/finch-api/models/pay_statement_event.rbs b/sig/finch-api/models/pay_statement_event.rbs index 1eb71773..270492a6 100644 --- a/sig/finch-api/models/pay_statement_event.rbs +++ b/sig/finch-api/models/pay_statement_event.rbs @@ -19,14 +19,10 @@ module FinchAPI FinchAPI::Models::PayStatementEvent::event_type _ ) -> FinchAPI::Models::PayStatementEvent::event_type - def initialize: - ( - ?data: FinchAPI::Models::PayStatementEvent::Data, - ?event_type: FinchAPI::Models::PayStatementEvent::event_type - ) -> void - | ( - ?FinchAPI::Models::pay_statement_event | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: FinchAPI::Models::PayStatementEvent::Data, + ?event_type: FinchAPI::Models::PayStatementEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::pay_statement_event @@ -41,12 +37,7 @@ module FinchAPI def payment_id=: (String) -> String - def initialize: - (?individual_id: String, ?payment_id: String) -> void - | ( - ?FinchAPI::Models::PayStatementEvent::data - | FinchAPI::BaseModel data - ) -> void + def initialize: (?individual_id: String, ?payment_id: String) -> void def to_hash: -> FinchAPI::Models::PayStatementEvent::data end diff --git a/sig/finch-api/models/payment_event.rbs b/sig/finch-api/models/payment_event.rbs index f3d2eeea..a923cb27 100644 --- a/sig/finch-api/models/payment_event.rbs +++ b/sig/finch-api/models/payment_event.rbs @@ -19,12 +19,10 @@ module FinchAPI FinchAPI::Models::PaymentEvent::event_type _ ) -> FinchAPI::Models::PaymentEvent::event_type - def initialize: - ( - ?data: FinchAPI::Models::PaymentEvent::Data, - ?event_type: FinchAPI::Models::PaymentEvent::event_type - ) -> void - | (?FinchAPI::Models::payment_event | FinchAPI::BaseModel data) -> void + def initialize: ( + ?data: FinchAPI::Models::PaymentEvent::Data, + ?event_type: FinchAPI::Models::PaymentEvent::event_type + ) -> void def to_hash: -> FinchAPI::Models::payment_event @@ -35,11 +33,7 @@ module FinchAPI attr_accessor payment_id: String - def initialize: - (pay_date: String, payment_id: String) -> void - | ( - ?FinchAPI::Models::PaymentEvent::data | FinchAPI::BaseModel data - ) -> void + def initialize: (pay_date: String, payment_id: String) -> void def to_hash: -> FinchAPI::Models::PaymentEvent::data end diff --git a/sig/finch-api/models/payroll/pay_group_list_params.rbs b/sig/finch-api/models/payroll/pay_group_list_params.rbs index 3d1f2dd1..678483f7 100644 --- a/sig/finch-api/models/payroll/pay_group_list_params.rbs +++ b/sig/finch-api/models/payroll/pay_group_list_params.rbs @@ -17,16 +17,11 @@ module FinchAPI def pay_frequencies=: (::Array[String]) -> ::Array[String] - def initialize: - ( - ?individual_id: String, - ?pay_frequencies: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Payroll::pay_group_list_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?individual_id: String, + ?pay_frequencies: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Payroll::pay_group_list_params end diff --git a/sig/finch-api/models/payroll/pay_group_list_response.rbs b/sig/finch-api/models/payroll/pay_group_list_response.rbs index d583c752..f4e28c4c 100644 --- a/sig/finch-api/models/payroll/pay_group_list_response.rbs +++ b/sig/finch-api/models/payroll/pay_group_list_response.rbs @@ -23,16 +23,11 @@ module FinchAPI ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] ) -> ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] - def initialize: - ( - ?id: String, - ?name: String, - ?pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] - ) -> void - | ( - ?FinchAPI::Models::Payroll::pay_group_list_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?name: String, + ?pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] + ) -> void def to_hash: -> FinchAPI::Models::Payroll::pay_group_list_response diff --git a/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs b/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs index ea331523..11199b48 100644 --- a/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs +++ b/sig/finch-api/models/payroll/pay_group_retrieve_params.rbs @@ -7,12 +7,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::Payroll::pay_group_retrieve_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::Payroll::pay_group_retrieve_params end diff --git a/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs b/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs index a044159b..6eba1511 100644 --- a/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +++ b/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs @@ -18,17 +18,12 @@ module FinchAPI attr_accessor pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::pay_frequency] - def initialize: - ( - id: String, - individual_ids: ::Array[String], - name: String, - pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::pay_frequency] - ) -> void - | ( - ?FinchAPI::Models::Payroll::pay_group_retrieve_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + id: String, + individual_ids: ::Array[String], + name: String, + pay_frequencies: ::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::pay_frequency] + ) -> void def to_hash: -> FinchAPI::Models::Payroll::pay_group_retrieve_response diff --git a/sig/finch-api/models/provider.rbs b/sig/finch-api/models/provider.rbs index ab8af201..aa1d904f 100644 --- a/sig/finch-api/models/provider.rbs +++ b/sig/finch-api/models/provider.rbs @@ -57,20 +57,18 @@ module FinchAPI def products=: (::Array[String]) -> ::Array[String] - def initialize: - ( - ?id: String, - ?authentication_methods: ::Array[FinchAPI::Models::Provider::AuthenticationMethod], - ?beta: bool, - ?display_name: String, - ?icon: String, - ?logo: String, - ?manual: bool, - ?mfa_required: bool, - ?primary_color: String, - ?products: ::Array[String] - ) -> void - | (?FinchAPI::Models::provider | FinchAPI::BaseModel data) -> void + def initialize: ( + ?id: String, + ?authentication_methods: ::Array[FinchAPI::Models::Provider::AuthenticationMethod], + ?beta: bool, + ?display_name: String, + ?icon: String, + ?logo: String, + ?manual: bool, + ?mfa_required: bool, + ?primary_color: String, + ?products: ::Array[String] + ) -> void def to_hash: -> FinchAPI::Models::provider @@ -92,16 +90,11 @@ module FinchAPI FinchAPI::Models::Provider::AuthenticationMethod::type_ ) -> FinchAPI::Models::Provider::AuthenticationMethod::type_ - def initialize: - ( - ?benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, - ?supported_fields: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields?, - ?type: FinchAPI::Models::Provider::AuthenticationMethod::type_ - ) -> void - | ( - ?FinchAPI::Models::Provider::authentication_method - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?benefits_support: FinchAPI::Models::HRIS::BenefitsSupport?, + ?supported_fields: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields?, + ?type: FinchAPI::Models::Provider::AuthenticationMethod::type_ + ) -> void def to_hash: -> FinchAPI::Models::Provider::authentication_method @@ -159,20 +152,15 @@ module FinchAPI FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment - def initialize: - ( - ?company: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, - ?directory: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, - ?employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, - ?individual: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, - ?pay_group: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, - ?pay_statement: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, - ?payment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::supported_fields - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?company: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, + ?directory: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, + ?employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, + ?individual: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, + ?pay_group: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, + ?pay_statement: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, + ?payment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::supported_fields @@ -234,22 +222,17 @@ module FinchAPI def primary_phone_number=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - ?departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, - ?ein: bool, - ?entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, - ?legal_name: bool, - ?locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, - ?primary_email: bool, - ?primary_phone_number: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::company - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + ?departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + ?ein: bool, + ?entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + ?legal_name: bool, + ?locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + ?primary_email: bool, + ?primary_phone_number: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::company @@ -283,18 +266,13 @@ module FinchAPI def routing_number=: (bool) -> bool - def initialize: - ( - ?account_name: bool, - ?account_number: bool, - ?account_type: bool, - ?institution_name: bool, - ?routing_number: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::accounts - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?account_name: bool, + ?account_number: bool, + ?account_type: bool, + ?institution_name: bool, + ?routing_number: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::accounts end @@ -316,15 +294,10 @@ module FinchAPI FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent - def initialize: - ( - ?name: bool, - ?parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::departments - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?name: bool, + ?parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::departments @@ -335,12 +308,7 @@ module FinchAPI def name=: (bool) -> bool - def initialize: - (?name: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::parent - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::parent end @@ -357,12 +325,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?subtype: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::entity - | FinchAPI::BaseModel data - ) -> void + def initialize: (?subtype: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::entity end @@ -402,19 +365,14 @@ module FinchAPI def state=: (bool) -> bool - def initialize: - ( - ?city: bool, - ?country: bool, - ?line1: bool, - ?line2: bool, - ?postal_code: bool, - ?state: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::locations - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::locations end @@ -439,15 +397,10 @@ module FinchAPI FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging - def initialize: - ( - ?individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::directory - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::directory @@ -493,20 +446,15 @@ module FinchAPI def middle_name=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?department: bool, - ?first_name: bool, - ?is_active: bool, - ?last_name: bool, - ?manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - ?middle_name: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::individuals - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?department: bool, + ?first_name: bool, + ?is_active: bool, + ?last_name: bool, + ?manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + ?middle_name: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::individuals @@ -517,12 +465,7 @@ module FinchAPI def id=: (bool) -> bool - def initialize: - (?id: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::manager end @@ -539,12 +482,7 @@ module FinchAPI def offset=: (bool) -> bool - def initialize: - (?count: bool, ?offset: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::paging - | FinchAPI::BaseModel data - ) -> void + def initialize: (?count: bool, ?offset: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::paging end @@ -650,30 +588,25 @@ module FinchAPI def title=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?class_code: bool, - ?custom_fields: bool, - ?department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - ?employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, - ?employment_status: bool, - ?end_date: bool, - ?first_name: bool, - ?income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, - ?income_history: bool, - ?is_active: bool, - ?last_name: bool, - ?location: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, - ?manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, - ?middle_name: bool, - ?start_date: bool, - ?title: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?class_code: bool, + ?custom_fields: bool, + ?department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + ?employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + ?employment_status: bool, + ?end_date: bool, + ?first_name: bool, + ?income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + ?income_history: bool, + ?is_active: bool, + ?last_name: bool, + ?location: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + ?manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, + ?middle_name: bool, + ?start_date: bool, + ?title: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::employment @@ -684,12 +617,7 @@ module FinchAPI def name=: (bool) -> bool - def initialize: - (?name: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::department - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::department end @@ -705,12 +633,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?subtype: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: (?subtype: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::employment end @@ -730,12 +653,11 @@ module FinchAPI def unit=: (bool) -> bool - def initialize: - (?amount: bool, ?currency: bool, ?unit: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::income - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?unit: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::income end @@ -775,19 +697,14 @@ module FinchAPI def state=: (bool) -> bool - def initialize: - ( - ?city: bool, - ?country: bool, - ?line1: bool, - ?line2: bool, - ?postal_code: bool, - ?state: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::location - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::location end @@ -799,12 +716,7 @@ module FinchAPI def id=: (bool) -> bool - def initialize: - (?id: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::manager end @@ -886,26 +798,21 @@ module FinchAPI def ssn=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?dob: bool, - ?emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, - ?encrypted_ssn: bool, - ?ethnicity: bool, - ?first_name: bool, - ?gender: bool, - ?last_name: bool, - ?middle_name: bool, - ?phone_numbers: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - ?preferred_name: bool, - ?residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, - ?ssn: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::individual - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?dob: bool, + ?emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + ?encrypted_ssn: bool, + ?ethnicity: bool, + ?first_name: bool, + ?gender: bool, + ?last_name: bool, + ?middle_name: bool, + ?phone_numbers: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + ?preferred_name: bool, + ?residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + ?ssn: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::individual @@ -920,12 +827,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?data: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::emails - | FinchAPI::BaseModel data - ) -> void + def initialize: (?data: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::emails end @@ -941,12 +843,7 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - (?data: bool, ?type: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::phone_numbers - | FinchAPI::BaseModel data - ) -> void + def initialize: (?data: bool, ?type: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::phone_numbers end @@ -986,19 +883,14 @@ module FinchAPI def state=: (bool) -> bool - def initialize: - ( - ?city: bool, - ?country: bool, - ?line1: bool, - ?line2: bool, - ?postal_code: bool, - ?state: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::residence - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?city: bool, + ?country: bool, + ?line1: bool, + ?line2: bool, + ?postal_code: bool, + ?state: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::residence end @@ -1029,17 +921,12 @@ module FinchAPI def pay_frequencies=: (bool) -> bool - def initialize: - ( - ?id: bool, - ?individual_ids: bool, - ?name: bool, - ?pay_frequencies: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_group - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?individual_ids: bool, + ?name: bool, + ?pay_frequencies: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_group end @@ -1063,15 +950,10 @@ module FinchAPI FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - def initialize: - ( - ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - ?pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_statement - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + ?pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::pay_statement @@ -1082,12 +964,7 @@ module FinchAPI attr_accessor offset: bool - def initialize: - (count: bool, offset: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::paging - | FinchAPI::BaseModel data - ) -> void + def initialize: (count: bool, offset: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::paging end @@ -1155,23 +1032,18 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?earnings: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - ?employee_deductions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - ?employer_contributions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - ?gross_pay: bool, - ?individual_id: bool, - ?net_pay: bool, - ?payment_method: bool, - ?taxes: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - ?total_hours: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::pay_statements - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?earnings: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + ?employee_deductions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + ?employer_contributions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + ?gross_pay: bool, + ?individual_id: bool, + ?net_pay: bool, + ?payment_method: bool, + ?taxes: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + ?total_hours: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::pay_statements @@ -1195,17 +1067,12 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?amount: bool, - ?currency: bool, - ?name: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?name: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::earnings end @@ -1240,18 +1107,13 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?amount: bool, - ?currency: bool, - ?name: bool, - ?pre_tax: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?name: bool, + ?pre_tax: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employee_deductions end @@ -1272,12 +1134,11 @@ module FinchAPI def name=: (bool) -> bool - def initialize: - (?amount: bool, ?currency: bool, ?name: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?name: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::employer_contributions end @@ -1312,18 +1173,13 @@ module FinchAPI def type=: (bool) -> bool - def initialize: - ( - ?amount: bool, - ?currency: bool, - ?employer: bool, - ?name: bool, - ?type: bool - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: bool, + ?currency: bool, + ?employer: bool, + ?name: bool, + ?type: bool + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::taxes end @@ -1397,25 +1253,20 @@ module FinchAPI FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod ) -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod - def initialize: - ( - ?id: bool, - ?company_debit: bool, - ?debit_date: bool, - ?employee_taxes: bool, - ?employer_taxes: bool, - ?gross_pay: bool, - ?individual_ids: bool, - ?net_pay: bool, - ?pay_date: bool, - ?pay_frequencies: bool, - ?pay_group_ids: bool, - ?pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod - ) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::payment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: bool, + ?company_debit: bool, + ?debit_date: bool, + ?employee_taxes: bool, + ?employer_taxes: bool, + ?gross_pay: bool, + ?individual_ids: bool, + ?net_pay: bool, + ?pay_date: bool, + ?pay_frequencies: bool, + ?pay_group_ids: bool, + ?pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + ) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::payment @@ -1430,12 +1281,7 @@ module FinchAPI def start_date=: (bool) -> bool - def initialize: - (?end_date: bool, ?start_date: bool) -> void - | ( - ?FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::pay_period - | FinchAPI::BaseModel data - ) -> void + def initialize: (?end_date: bool, ?start_date: bool) -> void def to_hash: -> FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::pay_period end diff --git a/sig/finch-api/models/provider_list_params.rbs b/sig/finch-api/models/provider_list_params.rbs index 234d91c4..08a78938 100644 --- a/sig/finch-api/models/provider_list_params.rbs +++ b/sig/finch-api/models/provider_list_params.rbs @@ -6,11 +6,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::provider_list_params | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::provider_list_params end diff --git a/sig/finch-api/models/request_forwarding_forward_params.rbs b/sig/finch-api/models/request_forwarding_forward_params.rbs index 245a68f8..1551bffb 100644 --- a/sig/finch-api/models/request_forwarding_forward_params.rbs +++ b/sig/finch-api/models/request_forwarding_forward_params.rbs @@ -24,19 +24,14 @@ module FinchAPI attr_accessor params: top? - def initialize: - ( - method_: String, - route: String, - ?data: String?, - ?headers: top?, - ?params: top?, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::request_forwarding_forward_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + method_: String, + route: String, + ?data: String?, + ?headers: top?, + ?params: top?, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::request_forwarding_forward_params end diff --git a/sig/finch-api/models/request_forwarding_forward_response.rbs b/sig/finch-api/models/request_forwarding_forward_response.rbs index 3e822ec2..f610a1d2 100644 --- a/sig/finch-api/models/request_forwarding_forward_response.rbs +++ b/sig/finch-api/models/request_forwarding_forward_response.rbs @@ -17,17 +17,12 @@ module FinchAPI attr_accessor status_code: Integer - def initialize: - ( - data: String?, - headers: top?, - request: FinchAPI::Models::RequestForwardingForwardResponse::Request, - status_code: Integer - ) -> void - | ( - ?FinchAPI::Models::request_forwarding_forward_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + data: String?, + headers: top?, + request: FinchAPI::Models::RequestForwardingForwardResponse::Request, + status_code: Integer + ) -> void def to_hash: -> FinchAPI::Models::request_forwarding_forward_response @@ -51,18 +46,13 @@ module FinchAPI attr_accessor route: String - def initialize: - ( - data: String?, - headers: top?, - method_: String, - params: top?, - route: String - ) -> void - | ( - ?FinchAPI::Models::RequestForwardingForwardResponse::request - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + data: String?, + headers: top?, + method_: String, + params: top?, + route: String + ) -> void def to_hash: -> FinchAPI::Models::RequestForwardingForwardResponse::request end diff --git a/sig/finch-api/models/sandbox/company_update_params.rbs b/sig/finch-api/models/sandbox/company_update_params.rbs index f1ff0734..bb8e374b 100644 --- a/sig/finch-api/models/sandbox/company_update_params.rbs +++ b/sig/finch-api/models/sandbox/company_update_params.rbs @@ -34,22 +34,17 @@ module FinchAPI attr_accessor primary_phone_number: String? - def initialize: - ( - accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?, - departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]?, - ein: String?, - entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity?, - legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, - primary_email: String?, - primary_phone_number: String?, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::company_update_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?, + departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]?, + ein: String?, + entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity?, + legal_name: String?, + locations: ::Array[FinchAPI::Models::Location?]?, + primary_email: String?, + primary_phone_number: String?, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::company_update_params @@ -73,18 +68,13 @@ module FinchAPI attr_accessor routing_number: String? - def initialize: - ( - ?account_name: String?, - ?account_number: String?, - ?account_type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type?, - ?institution_name: String?, - ?routing_number: String? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateParams::account - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?account_name: String?, + ?account_number: String?, + ?account_type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type?, + ?institution_name: String?, + ?routing_number: String? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::account @@ -109,15 +99,10 @@ module FinchAPI attr_accessor parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? - def initialize: - ( - ?name: String?, - ?parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateParams::department - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?name: String?, + ?parent: FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::department @@ -126,12 +111,7 @@ module FinchAPI class Parent < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::parent - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::parent end @@ -148,15 +128,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? - def initialize: - ( - ?subtype: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype?, - ?type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateParams::entity - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?subtype: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype?, + ?type: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateParams::entity diff --git a/sig/finch-api/models/sandbox/company_update_response.rbs b/sig/finch-api/models/sandbox/company_update_response.rbs index f91c1677..f93a20e4 100644 --- a/sig/finch-api/models/sandbox/company_update_response.rbs +++ b/sig/finch-api/models/sandbox/company_update_response.rbs @@ -30,21 +30,16 @@ module FinchAPI attr_accessor primary_phone_number: String? - def initialize: - ( - accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account]?, - departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department?]?, - ein: String?, - entity: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity?, - legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, - primary_email: String?, - primary_phone_number: String? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::company_update_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account]?, + departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department?]?, + ein: String?, + entity: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity?, + legal_name: String?, + locations: ::Array[FinchAPI::Models::Location?]?, + primary_email: String?, + primary_phone_number: String? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::company_update_response @@ -68,18 +63,13 @@ module FinchAPI attr_accessor routing_number: String? - def initialize: - ( - ?account_name: String?, - ?account_number: String?, - ?account_type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::account_type?, - ?institution_name: String?, - ?routing_number: String? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::account - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?account_name: String?, + ?account_number: String?, + ?account_type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::account_type?, + ?institution_name: String?, + ?routing_number: String? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::account @@ -104,15 +94,10 @@ module FinchAPI attr_accessor parent: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent? - def initialize: - ( - ?name: String?, - ?parent: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::department - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?name: String?, + ?parent: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::department @@ -121,12 +106,7 @@ module FinchAPI class Parent < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::parent - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::parent end @@ -143,15 +123,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_? - def initialize: - ( - ?subtype: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::subtype?, - ?type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::CompanyUpdateResponse::entity - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?subtype: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::subtype?, + ?type: FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::CompanyUpdateResponse::entity diff --git a/sig/finch-api/models/sandbox/connection_create_params.rbs b/sig/finch-api/models/sandbox/connection_create_params.rbs index 2c426285..5c2e29fc 100644 --- a/sig/finch-api/models/sandbox/connection_create_params.rbs +++ b/sig/finch-api/models/sandbox/connection_create_params.rbs @@ -30,18 +30,13 @@ module FinchAPI def products=: (::Array[String]) -> ::Array[String] - def initialize: - ( - provider_id: String, - ?authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, - ?employee_size: Integer, - ?products: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::connection_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + provider_id: String, + ?authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, + ?employee_size: Integer, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::connection_create_params diff --git a/sig/finch-api/models/sandbox/connection_create_response.rbs b/sig/finch-api/models/sandbox/connection_create_response.rbs index d2fc7d88..9f366382 100644 --- a/sig/finch-api/models/sandbox/connection_create_response.rbs +++ b/sig/finch-api/models/sandbox/connection_create_response.rbs @@ -32,21 +32,16 @@ module FinchAPI def token_type=: (String) -> String - def initialize: - ( - access_token: String, - account_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type, - company_id: String, - connection_id: String, - products: ::Array[String], - provider_id: String, - ?token_type: String - ) -> void - | ( - ?FinchAPI::Models::Sandbox::connection_create_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + access_token: String, + account_id: String, + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type, + company_id: String, + connection_id: String, + products: ::Array[String], + provider_id: String, + ?token_type: String + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::connection_create_response diff --git a/sig/finch-api/models/sandbox/connections/account_create_params.rbs b/sig/finch-api/models/sandbox/connections/account_create_params.rbs index aed218ea..6e4b80ac 100644 --- a/sig/finch-api/models/sandbox/connections/account_create_params.rbs +++ b/sig/finch-api/models/sandbox/connections/account_create_params.rbs @@ -29,18 +29,13 @@ module FinchAPI def products=: (::Array[String]) -> ::Array[String] - def initialize: - ( - company_id: String, - provider_id: String, - ?authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, - ?products: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::Connections::account_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + company_id: String, + provider_id: String, + ?authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_create_params diff --git a/sig/finch-api/models/sandbox/connections/account_create_response.rbs b/sig/finch-api/models/sandbox/connections/account_create_response.rbs index c0104e87..25dd5737 100644 --- a/sig/finch-api/models/sandbox/connections/account_create_response.rbs +++ b/sig/finch-api/models/sandbox/connections/account_create_response.rbs @@ -28,20 +28,15 @@ module FinchAPI attr_accessor provider_id: String - def initialize: - ( - access_token: String, - account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type, - company_id: String, - connection_id: String, - products: ::Array[String], - provider_id: String - ) -> void - | ( - ?FinchAPI::Models::Sandbox::Connections::account_create_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + access_token: String, + account_id: String, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type, + company_id: String, + connection_id: String, + products: ::Array[String], + provider_id: String + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_create_response diff --git a/sig/finch-api/models/sandbox/connections/account_update_params.rbs b/sig/finch-api/models/sandbox/connections/account_update_params.rbs index 23203910..bf37b69b 100644 --- a/sig/finch-api/models/sandbox/connections/account_update_params.rbs +++ b/sig/finch-api/models/sandbox/connections/account_update_params.rbs @@ -16,15 +16,10 @@ module FinchAPI FinchAPI::Models::connection_status_type ) -> FinchAPI::Models::connection_status_type - def initialize: - ( - ?connection_status: FinchAPI::Models::connection_status_type, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::Connections::account_update_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?connection_status: FinchAPI::Models::connection_status_type, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_update_params end diff --git a/sig/finch-api/models/sandbox/connections/account_update_response.rbs b/sig/finch-api/models/sandbox/connections/account_update_response.rbs index 74388144..cbefea3c 100644 --- a/sig/finch-api/models/sandbox/connections/account_update_response.rbs +++ b/sig/finch-api/models/sandbox/connections/account_update_response.rbs @@ -27,19 +27,14 @@ module FinchAPI def connection_id=: (String) -> String - def initialize: - ( - account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type, - company_id: String, - products: ::Array[String], - provider_id: String, - ?connection_id: String - ) -> void - | ( - ?FinchAPI::Models::Sandbox::Connections::account_update_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + account_id: String, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type, + company_id: String, + products: ::Array[String], + provider_id: String, + ?connection_id: String + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::Connections::account_update_response diff --git a/sig/finch-api/models/sandbox/directory_create_params.rbs b/sig/finch-api/models/sandbox/directory_create_params.rbs index 1d672284..b8d72743 100644 --- a/sig/finch-api/models/sandbox/directory_create_params.rbs +++ b/sig/finch-api/models/sandbox/directory_create_params.rbs @@ -17,15 +17,10 @@ module FinchAPI ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body] ) -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body] - def initialize: - ( - ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::directory_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::directory_create_params @@ -121,40 +116,35 @@ module FinchAPI attr_accessor title: String? - def initialize: - ( - ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], - ?department: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department?, - ?dob: String?, - ?emails: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]?, - ?employment: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment?, - ?employment_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status?, - ?encrypted_ssn: String?, - ?end_date: String?, - ?ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?, - ?first_name: String?, - ?gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?, - ?income: FinchAPI::Models::Income?, - ?income_history: ::Array[FinchAPI::Models::Income?]?, - ?is_active: bool?, - ?last_name: String?, - ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager?, - ?middle_name: String?, - ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, - ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, - ?source_id: String, - ?ssn: String?, - ?start_date: String?, - ?title: String? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams::body - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], + ?department: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department?, + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]?, + ?employment: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status?, + ?encrypted_ssn: String?, + ?end_date: String?, + ?ethnicity: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?source_id: String, + ?ssn: String?, + ?start_date: String?, + ?title: String? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::body @@ -167,12 +157,7 @@ module FinchAPI def value=: (top) -> top - def initialize: - (?name: String?, ?value: top) -> void - | ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::custom_field - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?, ?value: top) -> void def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::custom_field end @@ -182,12 +167,7 @@ module FinchAPI class Department < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::department - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::department end @@ -205,15 +185,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? - def initialize: - ( - ?data: String, - ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::email - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String, + ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::email @@ -238,15 +213,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? - def initialize: - ( - ?subtype: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, - ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?subtype: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype?, + ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment @@ -341,12 +311,7 @@ module FinchAPI def id=: (String) -> String - def initialize: - (?id: String) -> void - | ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: String) -> void def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::manager end @@ -364,15 +329,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? - def initialize: - ( - ?data: String, - ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::phone_number - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String, + ?type: FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::phone_number diff --git a/sig/finch-api/models/sandbox/employment_update_params.rbs b/sig/finch-api/models/sandbox/employment_update_params.rbs index e0d6dc45..33d940ee 100644 --- a/sig/finch-api/models/sandbox/employment_update_params.rbs +++ b/sig/finch-api/models/sandbox/employment_update_params.rbs @@ -70,32 +70,27 @@ module FinchAPI attr_accessor title: String? - def initialize: - ( - ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], - ?department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, - ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, - ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, - ?end_date: String?, - ?first_name: String?, - ?income: FinchAPI::Models::Income?, - ?income_history: ::Array[FinchAPI::Models::Income?]?, - ?is_active: bool?, - ?last_name: String?, - ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, - ?middle_name: String?, - ?source_id: String, - ?start_date: String?, - ?title: String?, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::employment_update_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], + ?department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, + ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, + ?middle_name: String?, + ?source_id: String, + ?start_date: String?, + ?title: String?, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::employment_update_params @@ -108,12 +103,7 @@ module FinchAPI def value=: (top) -> top - def initialize: - (?name: String?, ?value: top) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::custom_field - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?, ?value: top) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::custom_field end @@ -123,12 +113,7 @@ module FinchAPI class Department < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::department - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::department end @@ -144,15 +129,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? - def initialize: - ( - ?subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?, - ?type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?subtype: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype?, + ?type: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment @@ -213,12 +193,7 @@ module FinchAPI def id=: (String) -> String - def initialize: - (?id: String) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateParams::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: String) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateParams::manager end diff --git a/sig/finch-api/models/sandbox/employment_update_response.rbs b/sig/finch-api/models/sandbox/employment_update_response.rbs index 8ef83f68..21ee4af4 100644 --- a/sig/finch-api/models/sandbox/employment_update_response.rbs +++ b/sig/finch-api/models/sandbox/employment_update_response.rbs @@ -71,32 +71,27 @@ module FinchAPI attr_accessor title: String? - def initialize: - ( - ?id: String, - ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], - ?department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?, - ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?, - ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, - ?end_date: String?, - ?first_name: String?, - ?income: FinchAPI::Models::Income?, - ?income_history: ::Array[FinchAPI::Models::Income?]?, - ?is_active: bool?, - ?last_name: String?, - ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, - ?middle_name: String?, - ?source_id: String, - ?start_date: String?, - ?title: String? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::employment_update_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], + ?department: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department?, + ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager?, + ?middle_name: String?, + ?source_id: String, + ?start_date: String?, + ?title: String? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::employment_update_response @@ -109,12 +104,7 @@ module FinchAPI def value=: (top) -> top - def initialize: - (?name: String?, ?value: top) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::custom_field - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?, ?value: top) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::custom_field end @@ -124,12 +114,7 @@ module FinchAPI class Department < FinchAPI::BaseModel attr_accessor name: String? - def initialize: - (?name: String?) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::department - | FinchAPI::BaseModel data - ) -> void + def initialize: (?name: String?) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::department end @@ -145,15 +130,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_? - def initialize: - ( - ?subtype: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype?, - ?type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?subtype: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype?, + ?type: FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment @@ -214,12 +194,7 @@ module FinchAPI def id=: (String) -> String - def initialize: - (?id: String) -> void - | ( - ?FinchAPI::Models::Sandbox::EmploymentUpdateResponse::manager - | FinchAPI::BaseModel data - ) -> void + def initialize: (?id: String) -> void def to_hash: -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse::manager end diff --git a/sig/finch-api/models/sandbox/individual_update_params.rbs b/sig/finch-api/models/sandbox/individual_update_params.rbs index c577e8f3..d7b78d9d 100644 --- a/sig/finch-api/models/sandbox/individual_update_params.rbs +++ b/sig/finch-api/models/sandbox/individual_update_params.rbs @@ -46,26 +46,21 @@ module FinchAPI attr_accessor ssn: String? - def initialize: - ( - ?dob: String?, - ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, - ?encrypted_ssn: String?, - ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, - ?first_name: String?, - ?gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, - ?last_name: String?, - ?middle_name: String?, - ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, - ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, - ?ssn: String?, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::individual_update_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String?, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::individual_update_params @@ -82,15 +77,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? - def initialize: - ( - ?data: String, - ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::IndividualUpdateParams::email - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateParams::email @@ -151,15 +141,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? - def initialize: - ( - ?data: String, - ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::IndividualUpdateParams::phone_number - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateParams::phone_number diff --git a/sig/finch-api/models/sandbox/individual_update_response.rbs b/sig/finch-api/models/sandbox/individual_update_response.rbs index 9b16ce29..1d6238f8 100644 --- a/sig/finch-api/models/sandbox/individual_update_response.rbs +++ b/sig/finch-api/models/sandbox/individual_update_response.rbs @@ -47,26 +47,21 @@ module FinchAPI attr_accessor ssn: String? - def initialize: - ( - ?id: String, - ?dob: String?, - ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]?, - ?encrypted_ssn: String?, - ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateResponse::ethnicity?, - ?first_name: String?, - ?gender: FinchAPI::Models::Sandbox::IndividualUpdateResponse::gender?, - ?last_name: String?, - ?middle_name: String?, - ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber?]?, - ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, - ?ssn: String? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::individual_update_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?id: String, + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateResponse::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::IndividualUpdateResponse::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::individual_update_response @@ -83,15 +78,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_? - def initialize: - ( - ?data: String, - ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::IndividualUpdateResponse::email - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateResponse::email @@ -152,15 +142,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_? - def initialize: - ( - ?data: String, - ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::IndividualUpdateResponse::phone_number - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?data: String, + ?type: FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::IndividualUpdateResponse::phone_number diff --git a/sig/finch-api/models/sandbox/job_create_params.rbs b/sig/finch-api/models/sandbox/job_create_params.rbs index 6cbfa8d7..20b73651 100644 --- a/sig/finch-api/models/sandbox/job_create_params.rbs +++ b/sig/finch-api/models/sandbox/job_create_params.rbs @@ -11,15 +11,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::JobCreateParams::type_ - def initialize: - ( - type: FinchAPI::Models::Sandbox::JobCreateParams::type_, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::job_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + type: FinchAPI::Models::Sandbox::JobCreateParams::type_, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::job_create_params diff --git a/sig/finch-api/models/sandbox/job_create_response.rbs b/sig/finch-api/models/sandbox/job_create_response.rbs index 424a465d..29eb4877 100644 --- a/sig/finch-api/models/sandbox/job_create_response.rbs +++ b/sig/finch-api/models/sandbox/job_create_response.rbs @@ -18,17 +18,12 @@ module FinchAPI attr_accessor remaining_refreshes: Integer - def initialize: - ( - allowed_refreshes: Integer, - job_id: String, - job_url: String, - remaining_refreshes: Integer - ) -> void - | ( - ?FinchAPI::Models::Sandbox::job_create_response - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + allowed_refreshes: Integer, + job_id: String, + job_url: String, + remaining_refreshes: Integer + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::job_create_response end diff --git a/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs b/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs index f82f1353..767087b0 100644 --- a/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs +++ b/sig/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbs @@ -8,12 +8,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_params end diff --git a/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs b/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs index 4a4fb42e..77d39bf2 100644 --- a/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs +++ b/sig/finch-api/models/sandbox/jobs/configuration_update_params.rbs @@ -8,12 +8,7 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - def initialize: - (?request_options: FinchAPI::request_opts) -> void - | ( - ?FinchAPI::Models::Sandbox::Jobs::configuration_update_params - | FinchAPI::BaseModel data - ) -> void + def initialize: (?request_options: FinchAPI::request_opts) -> void def to_hash: -> FinchAPI::Models::Sandbox::Jobs::configuration_update_params end diff --git a/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs b/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs index 21ccda50..9870049d 100644 --- a/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +++ b/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs @@ -13,15 +13,10 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_ - def initialize: - ( - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_ - ) -> void - | ( - ?FinchAPI::Models::Sandbox::Jobs::sandbox_job_configuration - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status, + type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_ + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::Jobs::sandbox_job_configuration diff --git a/sig/finch-api/models/sandbox/payment_create_params.rbs b/sig/finch-api/models/sandbox/payment_create_params.rbs index 05daae33..b76ef5c6 100644 --- a/sig/finch-api/models/sandbox/payment_create_params.rbs +++ b/sig/finch-api/models/sandbox/payment_create_params.rbs @@ -27,17 +27,12 @@ module FinchAPI def start_date=: (String) -> String - def initialize: - ( - ?end_date: String, - ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], - ?start_date: String, - ?request_options: FinchAPI::request_opts - ) -> void - | ( - ?FinchAPI::Models::Sandbox::payment_create_params - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?end_date: String, + ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + ?start_date: String, + ?request_options: FinchAPI::request_opts + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::payment_create_params @@ -78,23 +73,18 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? - def initialize: - ( - ?earnings: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning?]?, - ?employee_deductions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]?, - ?employer_contributions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]?, - ?gross_pay: FinchAPI::Models::Money?, - ?individual_id: String, - ?net_pay: FinchAPI::Models::Money?, - ?payment_method: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method?, - ?taxes: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax?]?, - ?total_hours: Float?, - ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::pay_statement - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?earnings: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning?]?, + ?employee_deductions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction?]?, + ?employer_contributions: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution?]?, + ?gross_pay: FinchAPI::Models::Money?, + ?individual_id: String, + ?net_pay: FinchAPI::Models::Money?, + ?payment_method: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method?, + ?taxes: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax?]?, + ?total_hours: Float?, + ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::pay_statement @@ -121,19 +111,14 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, - ?currency: String?, - ?hours: Float?, - ?name: String?, - ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::earning - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes?, + ?currency: String?, + ?hours: Float?, + ?name: String?, + ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::earning @@ -149,14 +134,9 @@ module FinchAPI FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::attributes @@ -167,12 +147,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::metadata end @@ -235,19 +210,14 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes?, - ?currency: String?, - ?name: String?, - ?pre_tax: bool?, - ?type: FinchAPI::Models::HRIS::benefit_type? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::employee_deduction - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes?, + ?currency: String?, + ?name: String?, + ?pre_tax: bool?, + ?type: FinchAPI::Models::HRIS::benefit_type? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::employee_deduction @@ -263,14 +233,9 @@ module FinchAPI FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::attributes @@ -281,12 +246,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::metadata end @@ -313,18 +273,13 @@ module FinchAPI attr_accessor type: FinchAPI::Models::HRIS::benefit_type? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes?, - ?currency: String?, - ?name: String?, - ?type: FinchAPI::Models::HRIS::benefit_type? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::employer_contribution - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes?, + ?currency: String?, + ?name: String?, + ?type: FinchAPI::Models::HRIS::benefit_type? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::employer_contribution @@ -340,14 +295,9 @@ module FinchAPI FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::attributes @@ -358,12 +308,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::metadata end @@ -402,19 +347,14 @@ module FinchAPI attr_accessor type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? - def initialize: - ( - ?amount: Integer?, - ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, - ?currency: String?, - ?employer: bool?, - ?name: String?, - ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::tax - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?amount: Integer?, + ?attributes: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes?, + ?currency: String?, + ?employer: bool?, + ?name: String?, + ?type: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_? + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::tax @@ -430,14 +370,9 @@ module FinchAPI FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata ) -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata - def initialize: - ( - ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata - ) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::attributes - | FinchAPI::BaseModel data - ) -> void + def initialize: ( + ?metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata + ) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::attributes @@ -448,12 +383,7 @@ module FinchAPI def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top] - def initialize: - (?metadata: ::Hash[Symbol, top]) -> void - | ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::metadata - | FinchAPI::BaseModel data - ) -> void + def initialize: (?metadata: ::Hash[Symbol, top]) -> void def to_hash: -> FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::metadata end diff --git a/sig/finch-api/models/sandbox/payment_create_response.rbs b/sig/finch-api/models/sandbox/payment_create_response.rbs index cf449f8f..d26afe86 100644 --- a/sig/finch-api/models/sandbox/payment_create_response.rbs +++ b/sig/finch-api/models/sandbox/payment_create_response.rbs @@ -8,12 +8,7 @@ module FinchAPI attr_accessor payment_id: String - def initialize: - (pay_date: String, payment_id: String) -> void - | ( - ?FinchAPI::Models::Sandbox::payment_create_response - | FinchAPI::BaseModel data - ) -> void + def initialize: (pay_date: String, payment_id: String) -> void def to_hash: -> FinchAPI::Models::Sandbox::payment_create_response end diff --git a/sig/finch-api/resources/access_tokens.rbs b/sig/finch-api/resources/access_tokens.rbs index c1172620..a7a785ef 100644 --- a/sig/finch-api/resources/access_tokens.rbs +++ b/sig/finch-api/resources/access_tokens.rbs @@ -1,17 +1,13 @@ module FinchAPI module Resources class AccessTokens - def create: - ( - FinchAPI::Models::AccessTokenCreateParams | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::CreateAccessTokenResponse - | ( - code: String, - ?client_id: String, - ?client_secret: String, - ?redirect_uri: String, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::CreateAccessTokenResponse + def create: ( + code: String, + ?client_id: String, + ?client_secret: String, + ?redirect_uri: String, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::CreateAccessTokenResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/account.rbs b/sig/finch-api/resources/account.rbs index 1e079fc7..71434068 100644 --- a/sig/finch-api/resources/account.rbs +++ b/sig/finch-api/resources/account.rbs @@ -1,23 +1,13 @@ module FinchAPI module Resources class Account - def disconnect: - ( - ?FinchAPI::Models::AccountDisconnectParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::DisconnectResponse - | ( - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::DisconnectResponse + def disconnect: ( + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::DisconnectResponse - def introspect: - ( - ?FinchAPI::Models::AccountIntrospectParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Introspection - | ( - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Introspection + def introspect: ( + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Introspection def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/connect/sessions.rbs b/sig/finch-api/resources/connect/sessions.rbs index f609b4e5..3b43e61a 100644 --- a/sig/finch-api/resources/connect/sessions.rbs +++ b/sig/finch-api/resources/connect/sessions.rbs @@ -2,36 +2,26 @@ module FinchAPI module Resources class Connect class Sessions - def new: - ( - FinchAPI::Models::Connect::SessionNewParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Connect::SessionNewResponse - | ( - customer_id: String, - customer_name: String, - products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], - ?customer_email: String?, - ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, - ?manual: bool?, - ?minutes_to_expire: Float?, - ?redirect_uri: String?, - ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Connect::SessionNewResponse + def new: ( + customer_id: String, + customer_name: String, + products: ::Array[FinchAPI::Models::Connect::SessionNewParams::product], + ?customer_email: String?, + ?integration: FinchAPI::Models::Connect::SessionNewParams::Integration?, + ?manual: bool?, + ?minutes_to_expire: Float?, + ?redirect_uri: String?, + ?sandbox: FinchAPI::Models::Connect::SessionNewParams::sandbox?, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Connect::SessionNewResponse - def reauthenticate: - ( - FinchAPI::Models::Connect::SessionReauthenticateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Connect::SessionReauthenticateResponse - | ( - connection_id: String, - ?minutes_to_expire: Integer?, - ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, - ?redirect_uri: String?, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Connect::SessionReauthenticateResponse + def reauthenticate: ( + connection_id: String, + ?minutes_to_expire: Integer?, + ?products: ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product]?, + ?redirect_uri: String?, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Connect::SessionReauthenticateResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/benefits.rbs b/sig/finch-api/resources/hris/benefits.rbs index 9dd301aa..6c8e932f 100644 --- a/sig/finch-api/resources/hris/benefits.rbs +++ b/sig/finch-api/resources/hris/benefits.rbs @@ -4,58 +4,31 @@ module FinchAPI class Benefits attr_reader individuals: FinchAPI::Resources::HRIS::Benefits::Individuals - def create: - ( - ?FinchAPI::Models::HRIS::BenefitCreateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse - | ( - ?description: String, - ?frequency: FinchAPI::Models::HRIS::benefit_frequency?, - ?type: FinchAPI::Models::HRIS::benefit_type?, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse + def create: ( + ?description: String, + ?frequency: FinchAPI::Models::HRIS::benefit_frequency?, + ?type: FinchAPI::Models::HRIS::benefit_type?, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse - def retrieve: - ( - String benefit_id, - ?FinchAPI::Models::HRIS::BenefitRetrieveParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::HRIS::CompanyBenefit - | ( - String benefit_id, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::CompanyBenefit + def retrieve: ( + String benefit_id, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::HRIS::CompanyBenefit - def update: - ( - String benefit_id, - ?FinchAPI::Models::HRIS::BenefitUpdateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse - | ( - String benefit_id, - ?description: String, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse + def update: ( + String benefit_id, + ?description: String, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse - def list: - ( - ?FinchAPI::Models::HRIS::BenefitListParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit] - | ( - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit] + def list: ( + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit] - def list_supported_benefits: - ( - ?FinchAPI::Models::HRIS::BenefitListSupportedBenefitsParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit] - | ( - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit] + def list_supported_benefits: ( + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/benefits/individuals.rbs b/sig/finch-api/resources/hris/benefits/individuals.rbs index 97304583..7da70cdf 100644 --- a/sig/finch-api/resources/hris/benefits/individuals.rbs +++ b/sig/finch-api/resources/hris/benefits/individuals.rbs @@ -3,52 +3,28 @@ module FinchAPI class HRIS class Benefits class Individuals - def enroll_many: - ( - String benefit_id, - ?FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual] - | ( - String benefit_id, - ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual] + def enroll_many: ( + String benefit_id, + ?individuals: ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual] - def enrolled_ids: - ( - String benefit_id, - ?FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse - | ( - String benefit_id, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse + def enrolled_ids: ( + String benefit_id, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse - def retrieve_many_benefits: - ( - String benefit_id, - ?FinchAPI::Models::HRIS::Benefits::IndividualRetrieveManyBenefitsParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit] - | ( - String benefit_id, - ?individual_ids: String, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit] + def retrieve_many_benefits: ( + String benefit_id, + ?individual_ids: String, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit] - def unenroll_many: - ( - String benefit_id, - ?FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual] - | ( - String benefit_id, - ?individual_ids: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual] + def unenroll_many: ( + String benefit_id, + ?individual_ids: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/company.rbs b/sig/finch-api/resources/hris/company.rbs index f2d563db..d4772d93 100644 --- a/sig/finch-api/resources/hris/company.rbs +++ b/sig/finch-api/resources/hris/company.rbs @@ -2,14 +2,9 @@ module FinchAPI module Resources class HRIS class Company - def retrieve: - ( - ?FinchAPI::Models::HRIS::CompanyRetrieveParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::HRIS::HRISCompany - | ( - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::HRISCompany + def retrieve: ( + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::HRIS::HRISCompany def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/directory.rbs b/sig/finch-api/resources/hris/directory.rbs index 195346f4..2c8d548f 100644 --- a/sig/finch-api/resources/hris/directory.rbs +++ b/sig/finch-api/resources/hris/directory.rbs @@ -2,16 +2,11 @@ module FinchAPI module Resources class HRIS class Directory - def list: - ( - ?FinchAPI::Models::HRIS::DirectoryListParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] - | ( - ?limit: Integer, - ?offset: Integer, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] + def list: ( + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory] alias list_individuals list diff --git a/sig/finch-api/resources/hris/documents.rbs b/sig/finch-api/resources/hris/documents.rbs index 8ef02131..f760d678 100644 --- a/sig/finch-api/resources/hris/documents.rbs +++ b/sig/finch-api/resources/hris/documents.rbs @@ -2,29 +2,18 @@ module FinchAPI module Resources class HRIS class Documents - def list: - ( - ?FinchAPI::Models::HRIS::DocumentListParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::HRIS::DocumentListResponse - | ( - ?individual_ids: ::Array[String], - ?limit: Integer, - ?offset: Integer, - ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::DocumentListResponse + def list: ( + ?individual_ids: ::Array[String], + ?limit: Integer, + ?offset: Integer, + ?types: ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::HRIS::DocumentListResponse - def retreive: - ( - String document_id, - ?FinchAPI::Models::HRIS::DocumentRetreiveParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::HRIS::document_retreive_response - | ( - String document_id, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::HRIS::document_retreive_response + def retreive: ( + String document_id, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::HRIS::document_retreive_response def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/employments.rbs b/sig/finch-api/resources/hris/employments.rbs index 25e71a0e..b8b1a3dc 100644 --- a/sig/finch-api/resources/hris/employments.rbs +++ b/sig/finch-api/resources/hris/employments.rbs @@ -2,15 +2,10 @@ module FinchAPI module Resources class HRIS class Employments - def retrieve_many: - ( - FinchAPI::Models::HRIS::EmploymentRetrieveManyParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse] - | ( - requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse] + def retrieve_many: ( + requests: ::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/individuals.rbs b/sig/finch-api/resources/hris/individuals.rbs index b5d9ba9b..68edce8b 100644 --- a/sig/finch-api/resources/hris/individuals.rbs +++ b/sig/finch-api/resources/hris/individuals.rbs @@ -2,16 +2,11 @@ module FinchAPI module Resources class HRIS class Individuals - def retrieve_many: - ( - ?FinchAPI::Models::HRIS::IndividualRetrieveManyParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse] - | ( - ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, - ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse] + def retrieve_many: ( + ?options: FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options?, + ?requests: ::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/pay_statements.rbs b/sig/finch-api/resources/hris/pay_statements.rbs index ebc9d193..16c8f9c0 100644 --- a/sig/finch-api/resources/hris/pay_statements.rbs +++ b/sig/finch-api/resources/hris/pay_statements.rbs @@ -2,15 +2,10 @@ module FinchAPI module Resources class HRIS class PayStatements - def retrieve_many: - ( - FinchAPI::Models::HRIS::PayStatementRetrieveManyParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse] - | ( - requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse] + def retrieve_many: ( + requests: ::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/hris/payments.rbs b/sig/finch-api/resources/hris/payments.rbs index fd039621..ad46cd22 100644 --- a/sig/finch-api/resources/hris/payments.rbs +++ b/sig/finch-api/resources/hris/payments.rbs @@ -2,16 +2,11 @@ module FinchAPI module Resources class HRIS class Payments - def list: - ( - FinchAPI::Models::HRIS::PaymentListParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Payment] - | ( - end_date: Date, - start_date: Date, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Payment] + def list: ( + end_date: Date, + start_date: Date, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::HRIS::Payment] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/jobs/automated.rbs b/sig/finch-api/resources/jobs/automated.rbs index 3e71eef8..21a263c6 100644 --- a/sig/finch-api/resources/jobs/automated.rbs +++ b/sig/finch-api/resources/jobs/automated.rbs @@ -2,38 +2,22 @@ module FinchAPI module Resources class Jobs class Automated - def create: - ( - FinchAPI::Models::Jobs::AutomatedCreateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Jobs::AutomatedCreateResponse - | ( - type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Jobs::AutomatedCreateResponse + def create: ( + type: FinchAPI::Models::Jobs::AutomatedCreateParams::type_, + params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Jobs::AutomatedCreateResponse - def retrieve: - ( - String job_id, - ?FinchAPI::Models::Jobs::AutomatedRetrieveParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Jobs::AutomatedAsyncJob - | ( - String job_id, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Jobs::AutomatedAsyncJob + def retrieve: ( + String job_id, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Jobs::AutomatedAsyncJob - def list: - ( - ?FinchAPI::Models::Jobs::AutomatedListParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Jobs::AutomatedListResponse - | ( - ?limit: Integer, - ?offset: Integer, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Jobs::AutomatedListResponse + def list: ( + ?limit: Integer, + ?offset: Integer, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Jobs::AutomatedListResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/jobs/manual.rbs b/sig/finch-api/resources/jobs/manual.rbs index 820281b2..dd060893 100644 --- a/sig/finch-api/resources/jobs/manual.rbs +++ b/sig/finch-api/resources/jobs/manual.rbs @@ -2,16 +2,10 @@ module FinchAPI module Resources class Jobs class Manual - def retrieve: - ( - String job_id, - ?FinchAPI::Models::Jobs::ManualRetrieveParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Jobs::ManualAsyncJob - | ( - String job_id, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Jobs::ManualAsyncJob + def retrieve: ( + String job_id, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Jobs::ManualAsyncJob def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/payroll/pay_groups.rbs b/sig/finch-api/resources/payroll/pay_groups.rbs index 71c8b293..d45e3439 100644 --- a/sig/finch-api/resources/payroll/pay_groups.rbs +++ b/sig/finch-api/resources/payroll/pay_groups.rbs @@ -2,27 +2,16 @@ module FinchAPI module Resources class Payroll class PayGroups - def retrieve: - ( - String pay_group_id, - ?FinchAPI::Models::Payroll::PayGroupRetrieveParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Payroll::PayGroupRetrieveResponse - | ( - String pay_group_id, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Payroll::PayGroupRetrieveResponse + def retrieve: ( + String pay_group_id, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Payroll::PayGroupRetrieveResponse - def list: - ( - ?FinchAPI::Models::Payroll::PayGroupListParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::Payroll::PayGroupListResponse] - | ( - ?individual_id: String, - ?pay_frequencies: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::Payroll::PayGroupListResponse] + def list: ( + ?individual_id: String, + ?pay_frequencies: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::Payroll::PayGroupListResponse] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/providers.rbs b/sig/finch-api/resources/providers.rbs index 5d5d9eff..b7d3a9af 100644 --- a/sig/finch-api/resources/providers.rbs +++ b/sig/finch-api/resources/providers.rbs @@ -1,13 +1,9 @@ module FinchAPI module Resources class Providers - def list: - ( - ?FinchAPI::Models::ProviderListParams | ::Hash[Symbol, top] params - ) -> FinchAPI::SinglePage[FinchAPI::Models::Provider] - | ( - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::SinglePage[FinchAPI::Models::Provider] + def list: ( + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::SinglePage[FinchAPI::Models::Provider] def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/request_forwarding.rbs b/sig/finch-api/resources/request_forwarding.rbs index 77201bb2..a27debf7 100644 --- a/sig/finch-api/resources/request_forwarding.rbs +++ b/sig/finch-api/resources/request_forwarding.rbs @@ -1,19 +1,14 @@ module FinchAPI module Resources class RequestForwarding - def forward: - ( - FinchAPI::Models::RequestForwardingForwardParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::RequestForwardingForwardResponse - | ( - method_: String, - route: String, - ?data: String?, - ?headers: top?, - ?params: top?, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::RequestForwardingForwardResponse + def forward: ( + method_: String, + route: String, + ?data: String?, + ?headers: top?, + ?params: top?, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::RequestForwardingForwardResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/company.rbs b/sig/finch-api/resources/sandbox/company.rbs index 10c48227..61ba0f8b 100644 --- a/sig/finch-api/resources/sandbox/company.rbs +++ b/sig/finch-api/resources/sandbox/company.rbs @@ -2,22 +2,17 @@ module FinchAPI module Resources class Sandbox class Company - def update: - ( - FinchAPI::Models::Sandbox::CompanyUpdateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::CompanyUpdateResponse - | ( - accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?, - departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]?, - ein: String?, - entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity?, - legal_name: String?, - locations: ::Array[FinchAPI::Models::Location?]?, - primary_email: String?, - primary_phone_number: String?, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::CompanyUpdateResponse + def update: ( + accounts: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]?, + departments: ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Department?]?, + ein: String?, + entity: FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity?, + legal_name: String?, + locations: ::Array[FinchAPI::Models::Location?]?, + primary_email: String?, + primary_phone_number: String?, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::CompanyUpdateResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/connections.rbs b/sig/finch-api/resources/sandbox/connections.rbs index bb1a14d4..9f358336 100644 --- a/sig/finch-api/resources/sandbox/connections.rbs +++ b/sig/finch-api/resources/sandbox/connections.rbs @@ -4,18 +4,13 @@ module FinchAPI class Connections attr_reader accounts: FinchAPI::Resources::Sandbox::Connections::Accounts - def create: - ( - FinchAPI::Models::Sandbox::ConnectionCreateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::ConnectionCreateResponse - | ( - provider_id: String, - ?authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, - ?employee_size: Integer, - ?products: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::ConnectionCreateResponse + def create: ( + provider_id: String, + ?authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type, + ?employee_size: Integer, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::ConnectionCreateResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/connections/accounts.rbs b/sig/finch-api/resources/sandbox/connections/accounts.rbs index 2f0862c2..7c2c8c23 100644 --- a/sig/finch-api/resources/sandbox/connections/accounts.rbs +++ b/sig/finch-api/resources/sandbox/connections/accounts.rbs @@ -3,28 +3,18 @@ module FinchAPI class Sandbox class Connections class Accounts - def create: - ( - FinchAPI::Models::Sandbox::Connections::AccountCreateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::Connections::AccountCreateResponse - | ( - company_id: String, - provider_id: String, - ?authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, - ?products: ::Array[String], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::Connections::AccountCreateResponse + def create: ( + company_id: String, + provider_id: String, + ?authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type, + ?products: ::Array[String], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::Connections::AccountCreateResponse - def update: - ( - ?FinchAPI::Models::Sandbox::Connections::AccountUpdateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse - | ( - ?connection_status: FinchAPI::Models::connection_status_type, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse + def update: ( + ?connection_status: FinchAPI::Models::connection_status_type, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/directory.rbs b/sig/finch-api/resources/sandbox/directory.rbs index 4b37a477..e2a5a437 100644 --- a/sig/finch-api/resources/sandbox/directory.rbs +++ b/sig/finch-api/resources/sandbox/directory.rbs @@ -2,15 +2,10 @@ module FinchAPI module Resources class Sandbox class Directory - def create: - ( - ?FinchAPI::Models::Sandbox::DirectoryCreateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::directory_create_response - | ( - ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::directory_create_response + def create: ( + ?body: ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::directory_create_response def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/employment.rbs b/sig/finch-api/resources/sandbox/employment.rbs index 75ef13ad..fa8f2880 100644 --- a/sig/finch-api/resources/sandbox/employment.rbs +++ b/sig/finch-api/resources/sandbox/employment.rbs @@ -2,34 +2,28 @@ module FinchAPI module Resources class Sandbox class Employment - def update: - ( - String individual_id, - ?FinchAPI::Models::Sandbox::EmploymentUpdateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse - | ( - String individual_id, - ?class_code: String?, - ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], - ?department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, - ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, - ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, - ?end_date: String?, - ?first_name: String?, - ?income: FinchAPI::Models::Income?, - ?income_history: ::Array[FinchAPI::Models::Income?]?, - ?is_active: bool?, - ?last_name: String?, - ?latest_rehire_date: String?, - ?location: FinchAPI::Models::Location?, - ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, - ?middle_name: String?, - ?source_id: String, - ?start_date: String?, - ?title: String?, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse + def update: ( + String individual_id, + ?class_code: String?, + ?custom_fields: ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], + ?department: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department?, + ?employment: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment?, + ?employment_status: FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status?, + ?end_date: String?, + ?first_name: String?, + ?income: FinchAPI::Models::Income?, + ?income_history: ::Array[FinchAPI::Models::Income?]?, + ?is_active: bool?, + ?last_name: String?, + ?latest_rehire_date: String?, + ?location: FinchAPI::Models::Location?, + ?manager: FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager?, + ?middle_name: String?, + ?source_id: String, + ?start_date: String?, + ?title: String?, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::EmploymentUpdateResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/individual.rbs b/sig/finch-api/resources/sandbox/individual.rbs index 679b3e98..76b23fa1 100644 --- a/sig/finch-api/resources/sandbox/individual.rbs +++ b/sig/finch-api/resources/sandbox/individual.rbs @@ -2,28 +2,22 @@ module FinchAPI module Resources class Sandbox class Individual - def update: - ( - String individual_id, - ?FinchAPI::Models::Sandbox::IndividualUpdateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::IndividualUpdateResponse - | ( - String individual_id, - ?dob: String?, - ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, - ?encrypted_ssn: String?, - ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, - ?first_name: String?, - ?gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, - ?last_name: String?, - ?middle_name: String?, - ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, - ?preferred_name: String?, - ?residence: FinchAPI::Models::Location?, - ?ssn: String?, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::IndividualUpdateResponse + def update: ( + String individual_id, + ?dob: String?, + ?emails: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]?, + ?encrypted_ssn: String?, + ?ethnicity: FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity?, + ?first_name: String?, + ?gender: FinchAPI::Models::Sandbox::IndividualUpdateParams::gender?, + ?last_name: String?, + ?middle_name: String?, + ?phone_numbers: ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber?]?, + ?preferred_name: String?, + ?residence: FinchAPI::Models::Location?, + ?ssn: String?, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::IndividualUpdateResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/jobs.rbs b/sig/finch-api/resources/sandbox/jobs.rbs index c72de5b3..252eb40c 100644 --- a/sig/finch-api/resources/sandbox/jobs.rbs +++ b/sig/finch-api/resources/sandbox/jobs.rbs @@ -4,15 +4,10 @@ module FinchAPI class Jobs attr_reader configuration: FinchAPI::Resources::Sandbox::Jobs::Configuration - def create: - ( - FinchAPI::Models::Sandbox::JobCreateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::JobCreateResponse - | ( - type: FinchAPI::Models::Sandbox::JobCreateParams::type_, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::JobCreateResponse + def create: ( + type: FinchAPI::Models::Sandbox::JobCreateParams::type_, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::JobCreateResponse def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/jobs/configuration.rbs b/sig/finch-api/resources/sandbox/jobs/configuration.rbs index 9bccc436..23b6afdc 100644 --- a/sig/finch-api/resources/sandbox/jobs/configuration.rbs +++ b/sig/finch-api/resources/sandbox/jobs/configuration.rbs @@ -3,25 +3,15 @@ module FinchAPI class Sandbox class Jobs class Configuration - def retrieve: - ( - ?FinchAPI::Models::Sandbox::Jobs::ConfigurationRetrieveParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_response - | ( - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_response + def retrieve: ( + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::Jobs::configuration_retrieve_response - def update: - ( - FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration - | ( - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration + def update: ( + completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status, + type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration def initialize: (client: FinchAPI::Client) -> void end diff --git a/sig/finch-api/resources/sandbox/payment.rbs b/sig/finch-api/resources/sandbox/payment.rbs index bf8c2b10..6c30fa7d 100644 --- a/sig/finch-api/resources/sandbox/payment.rbs +++ b/sig/finch-api/resources/sandbox/payment.rbs @@ -2,17 +2,12 @@ module FinchAPI module Resources class Sandbox class Payment - def create: - ( - ?FinchAPI::Models::Sandbox::PaymentCreateParams - | ::Hash[Symbol, top] params - ) -> FinchAPI::Models::Sandbox::PaymentCreateResponse - | ( - ?end_date: String, - ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], - ?start_date: String, - ?request_options: FinchAPI::request_opts - ) -> FinchAPI::Models::Sandbox::PaymentCreateResponse + def create: ( + ?end_date: String, + ?pay_statements: ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + ?start_date: String, + ?request_options: FinchAPI::request_opts + ) -> FinchAPI::Models::Sandbox::PaymentCreateResponse def initialize: (client: FinchAPI::Client) -> void end From c59a90c57b184e478192f899a6c2f0b10395f548 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 19 Mar 2025 23:15:30 +0000 Subject: [PATCH 52/67] feat!: support `for item in stream` style iteration on `Stream`s (#55) --- lib/finch-api/base_client.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index be06074a..b29d3f96 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -437,7 +437,7 @@ def request(req) decoded = FinchAPI::Util.decode_content(response, stream: stream) case req in { stream: Class => st } - st.new(model: model, url: url, status: status, response: response, messages: decoded) + st.new(model: model, url: url, status: status, response: response, stream: decoded) in { page: Class => page } page.new(client: self, req: req, headers: response, page_data: decoded) else From 0b1c07a2abd333fc000f785066987fe951f7bf59 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 20 Mar 2025 14:18:24 +0000 Subject: [PATCH 53/67] fix: resolve tapioca derived sorbet errors (#56) --- lib/finch-api/base_model.rb | 38 ++++++++++++------- rbi/lib/finch-api/base_model.rbi | 20 ++++++---- rbi/lib/finch-api/base_page.rbi | 2 - .../sandbox/directory_create_response.rbi | 2 +- .../jobs/configuration_retrieve_response.rbi | 2 +- .../finch-api/resources/hris/directory.rbi | 3 -- .../finch-api/resources/sandbox/directory.rbi | 2 +- .../resources/sandbox/jobs/configuration.rbi | 2 +- sig/finch-api/base_model.rbs | 8 ++-- 9 files changed, 45 insertions(+), 34 deletions(-) diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index eab7fd63..f7efa40e 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -182,8 +182,6 @@ class Unknown # rubocop:disable Lint/UnusedMethodArgument - private_class_method :new - # @param other [Object] # # @return [Boolean] @@ -233,8 +231,6 @@ def try_strict_coerce(value) class BooleanModel extend FinchAPI::Converter - private_class_method :new - # @param other [Object] # # @return [Boolean] @@ -336,8 +332,6 @@ def values = (@values ||= constants.map { const_get(_1) }) private def finalize! = values end - private_class_method :new - # @param other [Object] # # @return [Boolean] @@ -513,8 +507,6 @@ def variants # rubocop:disable Style/HashEachMethods # rubocop:disable Style/CaseEquality - private_class_method :new - # @param other [Object] # # @return [Boolean] @@ -625,9 +617,18 @@ def try_strict_coerce(value) class ArrayOf include FinchAPI::Converter - private_class_method :new - - def self.[](...) = new(...) + # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + def self.[](type_info, spec = {}) = new(type_info, spec) # @param other [Object] # @@ -748,9 +749,18 @@ def initialize(type_info, spec = {}) class HashOf include FinchAPI::Converter - private_class_method :new - - def self.[](...) = new(...) + # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + def self.[](type_info, spec = {}) = new(type_info, spec) # @param other [Object] # diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 8f9ae6a8..acfc2180 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -308,8 +308,6 @@ module FinchAPI abstract! final! - Elem = type_member(:out) - sig(:final) do params( type_info: T.any( @@ -360,7 +358,7 @@ module FinchAPI end # @api private - sig(:final) { returns(Elem) } + sig(:final) { returns(T.anything) } protected def item_type end @@ -389,8 +387,6 @@ module FinchAPI abstract! final! - Elem = type_member(:out) - sig(:final) do params( type_info: T.any( @@ -441,7 +437,7 @@ module FinchAPI end # @api private - sig(:final) { returns(Elem) } + sig(:final) { returns(T.anything) } protected def item_type end @@ -631,7 +627,17 @@ module FinchAPI def to_h end - alias_method :to_hash, :to_h + # Returns a Hash of the data underlying this object. O(1) + # + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. + # + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. + sig { overridable.returns(T::Hash[Symbol, T.anything]) } + def to_hash + end sig { params(keys: T.nilable(T::Array[Symbol])).returns(T::Hash[Symbol, T.anything]) } def deconstruct_keys(keys) diff --git a/rbi/lib/finch-api/base_page.rbi b/rbi/lib/finch-api/base_page.rbi index 3179fb7e..0b481300 100644 --- a/rbi/lib/finch-api/base_page.rbi +++ b/rbi/lib/finch-api/base_page.rbi @@ -20,8 +20,6 @@ module FinchAPI def to_enum end - alias_method :enum_for, :to_enum - # @api private sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi index 5098437d..94d3faa9 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_response.rbi @@ -3,7 +3,7 @@ module FinchAPI module Models module Sandbox - DirectoryCreateResponse = T.type_alias { T::Array[T.anything] } + DirectoryCreateResponse = T.let(FinchAPI::ArrayOf[FinchAPI::Unknown], FinchAPI::Converter) end end end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi index 16015f80..6c4fca76 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi @@ -5,7 +5,7 @@ module FinchAPI module Sandbox module Jobs ConfigurationRetrieveResponse = - T.type_alias { T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration] } + T.let(FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration], FinchAPI::Converter) end end end diff --git a/rbi/lib/finch-api/resources/hris/directory.rbi b/rbi/lib/finch-api/resources/hris/directory.rbi index 40a4c9d7..baf601a5 100644 --- a/rbi/lib/finch-api/resources/hris/directory.rbi +++ b/rbi/lib/finch-api/resources/hris/directory.rbi @@ -22,9 +22,6 @@ module FinchAPI ) end - # Read company directory and organization structure - alias_method :list_individuals, :list - sig { params(client: FinchAPI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/finch-api/resources/sandbox/directory.rbi b/rbi/lib/finch-api/resources/sandbox/directory.rbi index 080c750f..1303040b 100644 --- a/rbi/lib/finch-api/resources/sandbox/directory.rbi +++ b/rbi/lib/finch-api/resources/sandbox/directory.rbi @@ -10,7 +10,7 @@ module FinchAPI body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) - .returns(FinchAPI::Models::Sandbox::DirectoryCreateResponse) + .returns(T::Array[T.anything]) end def create( # Array of individuals to create. Takes all combined fields from `/individual` and diff --git a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi index 1e27f7dd..21950f6f 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi @@ -8,7 +8,7 @@ module FinchAPI # Get configurations for sandbox jobs sig do params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) - .returns(FinchAPI::Models::Sandbox::Jobs::ConfigurationRetrieveResponse) + .returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]) end def retrieve(request_options: {}) end diff --git a/sig/finch-api/base_model.rbs b/sig/finch-api/base_model.rbs index d352b36b..1545aef4 100644 --- a/sig/finch-api/base_model.rbs +++ b/sig/finch-api/base_model.rbs @@ -118,7 +118,7 @@ module FinchAPI ) -> ([true, top, nil] | [false, bool, Integer]) end - class ArrayOf[Elem] + class ArrayOf include FinchAPI::Converter def self.[]: ( @@ -140,7 +140,7 @@ module FinchAPI top value ) -> ([true, top, nil] | [false, bool, Integer]) - def item_type: -> Elem + def item_type: -> top def initialize: ( ::Hash[Symbol, top] @@ -150,7 +150,7 @@ module FinchAPI ) -> void end - class HashOf[Elem] + class HashOf include FinchAPI::Converter def self.[]: ( @@ -172,7 +172,7 @@ module FinchAPI top value ) -> ([true, top, nil] | [false, bool, Integer]) - def item_type: -> Elem + def item_type: -> top def initialize: ( ::Hash[Symbol, top] From 6956ce97a9b6d7298bc8264914cd0c121d5a3400 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 20 Mar 2025 21:28:06 +0000 Subject: [PATCH 54/67] feat!: use tagged enums in sorbet type definitions (#57) --- Rakefile | 21 +- lib/finch-api/base_model.rb | 388 +++++++++--------- lib/finch-api/models/account_update_event.rb | 11 +- lib/finch-api/models/company_event.rb | 5 +- .../models/connect/session_new_params.rb | 16 +- .../connect/session_reauthenticate_params.rb | 6 +- .../models/connection_status_type.rb | 5 +- .../models/create_access_token_response.rb | 12 +- lib/finch-api/models/directory_event.rb | 5 +- lib/finch-api/models/employment_event.rb | 5 +- .../models/hris/benefit_contribution.rb | 6 +- .../hris/benefit_features_and_operations.rb | 15 +- .../models/hris/benefit_frequency.rb | 5 +- lib/finch-api/models/hris/benefit_type.rb | 6 +- .../hris/benefits/enrolled_individual.rb | 6 +- .../hris/benefits/individual_benefit.rb | 6 +- .../benefits/individual_enroll_many_params.rb | 16 +- lib/finch-api/models/hris/company.rb | 18 +- .../models/hris/document_list_params.rb | 5 +- .../models/hris/document_response.rb | 6 +- .../models/hris/document_retreive_response.rb | 6 +- lib/finch-api/models/hris/employment_data.rb | 18 +- lib/finch-api/models/hris/individual.rb | 22 +- lib/finch-api/models/hris/pay_statement.rb | 24 +- lib/finch-api/models/hris/payment.rb | 5 +- .../models/hris/supported_benefit.rb | 15 +- lib/finch-api/models/hris/w42005.rb | 18 +- lib/finch-api/models/hris/w42020.rb | 12 +- lib/finch-api/models/income.rb | 6 +- lib/finch-api/models/individual_event.rb | 5 +- lib/finch-api/models/introspection.rb | 18 +- lib/finch-api/models/job_completion_event.rb | 5 +- .../models/jobs/automated_async_job.rb | 11 +- .../models/jobs/automated_create_params.rb | 6 +- lib/finch-api/models/jobs/manual_async_job.rb | 5 +- lib/finch-api/models/operation_support.rb | 6 +- lib/finch-api/models/pay_statement_event.rb | 5 +- lib/finch-api/models/payment_event.rb | 5 +- .../models/payroll/pay_group_list_response.rb | 5 +- .../payroll/pay_group_retrieve_response.rb | 5 +- lib/finch-api/models/provider.rb | 6 +- .../models/sandbox/company_update_params.rb | 18 +- .../models/sandbox/company_update_response.rb | 18 +- .../sandbox/connection_create_params.rb | 5 +- .../sandbox/connection_create_response.rb | 5 +- .../connections/account_create_params.rb | 5 +- .../connections/account_create_response.rb | 5 +- .../connections/account_update_response.rb | 5 +- .../models/sandbox/directory_create_params.rb | 40 +- .../sandbox/employment_update_params.rb | 18 +- .../sandbox/employment_update_response.rb | 18 +- .../sandbox/individual_update_params.rb | 22 +- .../sandbox/individual_update_response.rb | 22 +- .../models/sandbox/job_create_params.rb | 6 +- .../sandbox/jobs/sandbox_job_configuration.rb | 10 +- .../models/sandbox/payment_create_params.rb | 24 +- lib/finch-api/models/webhook_event.rb | 5 +- rbi/lib/finch-api/base_model.rbi | 172 ++++---- .../finch-api/models/account_update_event.rbi | 91 ++-- rbi/lib/finch-api/models/company_event.rbi | 32 +- .../models/connect/session_new_params.rbi | 105 +++-- .../connect/session_reauthenticate_params.rbi | 39 +- .../models/connection_status_type.rbi | 19 +- .../models/create_access_token_response.rbi | 49 ++- rbi/lib/finch-api/models/directory_event.rbi | 41 +- rbi/lib/finch-api/models/employment_event.rbi | 41 +- .../models/hris/benefit_contribution.rbi | 34 +- .../models/hris/benefit_create_params.rbi | 22 +- .../hris/benefit_features_and_operations.rbi | 234 +++++++++-- .../models/hris/benefit_frequency.rbi | 13 +- .../finch-api/models/hris/benefit_type.rbi | 45 +- .../hris/benefits/enrolled_individual.rbi | 36 +- .../hris/benefits/individual_benefit.rbi | 49 ++- .../individual_enroll_many_params.rbi | 187 +++++++-- rbi/lib/finch-api/models/hris/company.rbi | 96 +++-- .../finch-api/models/hris/company_benefit.rbi | 22 +- .../models/hris/document_list_params.rbi | 22 +- .../models/hris/document_response.rbi | 36 +- .../hris/document_retreive_response.rbi | 4 +- .../finch-api/models/hris/employment_data.rbi | 107 +++-- rbi/lib/finch-api/models/hris/individual.rbi | 135 +++--- .../finch-api/models/hris/pay_statement.rbi | 146 ++++--- rbi/lib/finch-api/models/hris/payment.rbi | 36 +- .../models/hris/supported_benefit.rbi | 133 ++++-- rbi/lib/finch-api/models/hris/w42005.rbi | 88 ++-- rbi/lib/finch-api/models/hris/w42020.rbi | 66 ++- rbi/lib/finch-api/models/income.rbi | 36 +- rbi/lib/finch-api/models/individual_event.rbi | 41 +- rbi/lib/finch-api/models/introspection.rbi | 110 +++-- .../finch-api/models/job_completion_event.rbi | 50 ++- .../models/jobs/automated_async_job.rbi | 55 ++- .../models/jobs/automated_create_params.rbi | 22 +- .../models/jobs/manual_async_job.rbi | 38 +- .../finch-api/models/operation_support.rbi | 16 +- .../models/operation_support_matrix.rbi | 50 ++- .../finch-api/models/pay_statement_event.rbi | 41 +- rbi/lib/finch-api/models/payment_event.rbi | 38 +- .../payroll/pay_group_list_response.rbi | 58 ++- .../payroll/pay_group_retrieve_response.rbi | 56 ++- rbi/lib/finch-api/models/provider.rbi | 34 +- .../models/sandbox/company_update_params.rbi | 103 +++-- .../sandbox/company_update_response.rbi | 108 +++-- .../sandbox/connection_create_params.rbi | 31 +- .../sandbox/connection_create_response.rbi | 32 +- .../connections/account_create_params.rbi | 50 ++- .../connections/account_create_response.rbi | 49 ++- .../connections/account_update_params.rbi | 19 +- .../connections/account_update_response.rbi | 49 ++- .../sandbox/directory_create_params.rbi | 286 +++++++++---- .../sandbox/employment_update_params.rbi | 124 ++++-- .../sandbox/employment_update_response.rbi | 132 ++++-- .../sandbox/individual_update_params.rbi | 154 ++++--- .../sandbox/individual_update_response.rbi | 162 +++++--- .../models/sandbox/job_create_params.rbi | 28 +- .../jobs/sandbox_job_configuration.rbi | 71 +++- .../models/sandbox/payment_create_params.rbi | 189 ++++++--- rbi/lib/finch-api/models/webhook_event.rbi | 4 +- .../finch-api/resources/connect/sessions.rbi | 6 +- rbi/lib/finch-api/resources/hris/benefits.rbi | 4 +- .../finch-api/resources/hris/documents.rbi | 2 +- .../finch-api/resources/jobs/automated.rbi | 2 +- .../resources/sandbox/connections.rbi | 2 +- .../sandbox/connections/accounts.rbi | 4 +- .../resources/sandbox/employment.rbi | 2 +- .../resources/sandbox/individual.rbi | 4 +- rbi/lib/finch-api/resources/sandbox/jobs.rbi | 2 +- .../resources/sandbox/jobs/configuration.rbi | 4 +- sig/finch-api/base_model.rbs | 28 +- sig/finch-api/models/account_update_event.rbs | 8 +- sig/finch-api/models/company_event.rbs | 4 +- .../models/connect/session_new_params.rbs | 12 +- .../connect/session_reauthenticate_params.rbs | 4 +- .../models/connection_status_type.rbs | 4 +- .../models/create_access_token_response.rbs | 8 +- sig/finch-api/models/directory_event.rbs | 4 +- sig/finch-api/models/employment_event.rbs | 4 +- .../models/hris/benefit_contribution.rbs | 4 +- .../hris/benefit_features_and_operations.rbs | 12 +- .../models/hris/benefit_frequency.rbs | 4 +- sig/finch-api/models/hris/benefit_type.rbs | 4 +- .../hris/benefits/enrolled_individual.rbs | 4 +- .../hris/benefits/individual_benefit.rbs | 5 +- .../individual_enroll_many_params.rbs | 12 +- .../models/hris/benfit_contribution.rbs | 1 - sig/finch-api/models/hris/company.rbs | 12 +- .../models/hris/document_list_params.rbs | 4 +- .../models/hris/document_response.rbs | 4 +- .../hris/document_retreive_response.rbs | 4 +- sig/finch-api/models/hris/employment_data.rbs | 12 +- sig/finch-api/models/hris/individual.rbs | 16 +- sig/finch-api/models/hris/pay_statement.rbs | 16 +- sig/finch-api/models/hris/payment.rbs | 4 +- .../models/hris/supported_benefit.rbs | 12 +- sig/finch-api/models/hris/w42005.rbs | 12 +- sig/finch-api/models/hris/w42020.rbs | 8 +- sig/finch-api/models/income.rbs | 4 +- sig/finch-api/models/individual_event.rbs | 4 +- sig/finch-api/models/introspection.rbs | 12 +- sig/finch-api/models/job_completion_event.rbs | 4 +- .../models/jobs/automated_async_job.rbs | 8 +- .../models/jobs/automated_create_params.rbs | 4 +- .../models/jobs/manual_async_job.rbs | 4 +- sig/finch-api/models/operation_support.rbs | 4 +- sig/finch-api/models/pay_statement_event.rbs | 4 +- sig/finch-api/models/payment_event.rbs | 4 +- .../payroll/pay_group_list_response.rbs | 4 +- .../payroll/pay_group_retrieve_response.rbs | 4 +- sig/finch-api/models/provider.rbs | 4 +- .../models/sandbox/company_update_params.rbs | 12 +- .../sandbox/company_update_response.rbs | 12 +- .../sandbox/connection_create_params.rbs | 4 +- .../sandbox/connection_create_response.rbs | 4 +- .../connections/account_create_params.rbs | 4 +- .../connections/account_create_response.rbs | 4 +- .../connections/account_update_response.rbs | 4 +- .../sandbox/directory_create_params.rbs | 28 +- .../sandbox/employment_update_params.rbs | 12 +- .../sandbox/employment_update_response.rbs | 12 +- .../sandbox/individual_update_params.rbs | 16 +- .../sandbox/individual_update_response.rbs | 16 +- .../models/sandbox/job_create_params.rbs | 4 +- .../jobs/sandbox_job_configuration.rbs | 8 +- .../models/sandbox/payment_create_params.rbs | 16 +- sig/finch-api/models/webhook_event.rbs | 4 +- test/finch-api/base_model_test.rb | 24 +- 185 files changed, 3861 insertions(+), 1978 deletions(-) diff --git a/Rakefile b/Rakefile index 109f6750..f3763943 100644 --- a/Rakefile +++ b/Rakefile @@ -35,24 +35,25 @@ multitask(:syntax_tree) do inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? %w[-i''] : %w[-i] uuid = SecureRandom.uuid - # `syntax_tree` has trouble with `rbs`'s class aliases + # `syntax_tree` has trouble with `rbs`'s class & module aliases sed = xargs + %w[sed -E] + inplace + %w[-e] - # annotate class aliases with a unique comment - pre = sed + ["s/class ([^ ]+) = (.+$)/# #{uuid}\\n\\1: \\2/", "--"] + # annotate unprocessable aliases with a unique comment + pre = sed + ["s/(class|module) ([^ ]+) = (.+$)/# \\1 #{uuid}\\n\\2: \\3/", "--"] fmt = xargs + %w[stree write --plugin=rbs --] - # remove the unique comment and transform class aliases to type aliases + # remove the unique comment and unprocessable aliases to type aliases subst = <<~SED - s/# #{uuid}// + s/# (class|module) #{uuid}/\\1/ t l1 b + : l1 - n - s/([^ :]+): (.+$)/class \\1 = \\2/ + N + s/\\n *([^:]+): (.+)$/ \\1 = \\2/ SED - # 1. delete the unique comment - # 2. if deletion happened, branch to label `l1`, else continue - # 3. transform the class alias to a type alias at label `l1` + # for each line: + # 1. try transform the unique comment into `class | module`, if successful, branch to label `l1`. + # 2. at label `l1`, join previously annotated line with `class | module` information. pst = sed + [subst, "--"] # transform class aliases to type aliases, which syntax tree has no trouble with diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index f7efa40e..52cfa76d 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -48,7 +48,7 @@ def type_info(spec) type_info(spec.slice(:const, :enum, :union).first&.last) in Proc spec - in FinchAPI::Converter | Class | Symbol + in FinchAPI::Converter | Module | Symbol -> { spec } in true | false -> { FinchAPI::BooleanModel } @@ -81,7 +81,7 @@ def coerce(target, value) else value end - in Class + in Module case target in -> { _1 <= NilClass } nil @@ -144,7 +144,7 @@ def try_strict_coerce(target, value) else [false, false, 0] end - in Class + in Module case [target, value] in [-> { _1 <= NilClass }, _] [true, nil, value.nil? ? 1 : 0] @@ -276,8 +276,6 @@ def try_strict_coerce(value) # @api private # - # @abstract - # # A value from among a specified list of options. OpenAPI enum values map to Ruby # values in the SDK as follows: # @@ -317,74 +315,70 @@ def try_strict_coerce(value) # puts(connection_status_type) # end # ``` - class Enum - extend FinchAPI::Converter + module Enum + include FinchAPI::Converter - class << self - # All of the valid Symbol values for this enum. - # - # @return [Array] - def values = (@values ||= constants.map { const_get(_1) }) + # All of the valid Symbol values for this enum. + # + # @return [Array] + def values = (@values ||= constants.map { const_get(_1) }) - # @api private - # - # Guard against thread safety issues by instantiating `@values`. - private def finalize! = values - end + # @api private + # + # Guard against thread safety issues by instantiating `@values`. + private def finalize! = values # @param other [Object] # # @return [Boolean] - def self.===(other) = values.include?(other) + def ===(other) = values.include?(other) # @param other [Object] # # @return [Boolean] - def self.==(other) - other.is_a?(Class) && other <= FinchAPI::Enum && other.values.to_set == values.to_set + def ==(other) + other.is_a?(Module) && other.singleton_class.ancestors.include?(FinchAPI::Enum) && other.values.to_set == values.to_set end - class << self - # @api private - # - # @param value [String, Symbol, Object] - # - # @return [Symbol, Object] - def coerce(value) - case value - in Symbol | String if values.include?(val = value.to_sym) - val - else - value - end + # @api private + # + # @param value [String, Symbol, Object] + # + # @return [Symbol, Object] + def coerce(value) + case value + in Symbol | String if values.include?(val = value.to_sym) + val + else + value end + end - # @!parse - # # @api private - # # - # # @param value [Symbol, Object] - # # - # # @return [Symbol, Object] - # def dump(value) = super + # @!parse + # # @api private + # # + # # @param value [Symbol, Object] + # # + # # @return [Symbol, Object] + # def dump(value) = super - # @api private - # - # @param value [Object] - # - # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - def try_strict_coerce(value) - return [true, value, 1] if values.include?(value) + # @api private + # + # @param value [Object] + # + # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] + def try_strict_coerce(value) + return [true, value, 1] if values.include?(value) - case value - in Symbol | String if values.include?(val = value.to_sym) - [true, val, 1] + case value + in Symbol | String if values.include?(val = value.to_sym) + [true, val, 1] + else + case [value, values.first] + in [true | false, true | false] | [Integer, Integer] | [Symbol | String, Symbol] + [false, true, 0] else - case [value, values.first] - in [true | false, true | false] | [Integer, Integer] | [Symbol | String, Symbol] - [false, true, 0] - else - [false, false, 0] - end + [false, false, 0] end end end @@ -392,8 +386,6 @@ def try_strict_coerce(value) # @api private # - # @abstract - # # @example # ```ruby # # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse` @@ -418,89 +410,87 @@ def try_strict_coerce(value) # puts(document_retreive_response) # end # ``` - class Union - extend FinchAPI::Converter + module Union + include FinchAPI::Converter - class << self - # @api private - # - # All of the specified variant info for this union. - # - # @return [Array] - private def known_variants = (@known_variants ||= []) + # @api private + # + # All of the specified variant info for this union. + # + # @return [Array] + private def known_variants = (@known_variants ||= []) - # @api private - # - # @return [Array] - protected def derefed_variants - @known_variants.map { |key, variant_fn| [key, variant_fn.call] } - end + # @api private + # + # @return [Array] + protected def derefed_variants + @known_variants.map { |key, variant_fn| [key, variant_fn.call] } + end - # All of the specified variants for this union. - # - # @return [Array] - def variants - derefed_variants.map(&:last) + # All of the specified variants for this union. + # + # @return [Array] + def variants + derefed_variants.map(&:last) + end + + # @api private + # + # @param property [Symbol] + private def discriminator(property) + case property + in Symbol + @discriminator = property end + end - # @api private - # - # @param property [Symbol] - private def discriminator(property) - case property + # @api private + # + # @param key [Symbol, Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] + # + # @param spec [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] . + # + # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const + # + # @option spec [Proc] :enum + # + # @option spec [Proc] :union + # + # @option spec [Boolean] :"nil?" + private def variant(key, spec = nil) + variant_info = + case key in Symbol - @discriminator = property + [key, FinchAPI::Converter.type_info(spec)] + in Proc | FinchAPI::Converter | Module | Hash + [nil, FinchAPI::Converter.type_info(key)] end - end - # @api private - # - # @param key [Symbol, Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] - # - # @param spec [Hash{Symbol=>Object}, Proc, FinchAPI::Converter, Class] . - # - # @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const - # - # @option spec [Proc] :enum - # - # @option spec [Proc] :union - # - # @option spec [Boolean] :"nil?" - private def variant(key, spec = nil) - variant_info = - case key - in Symbol - [key, FinchAPI::Converter.type_info(spec)] - in Proc | FinchAPI::Converter | Class | Hash - [nil, FinchAPI::Converter.type_info(key)] - end - - known_variants << variant_info - end + known_variants << variant_info + end - # @api private - # - # @param value [Object] - # - # @return [FinchAPI::Converter, Class, nil] - private def resolve_variant(value) - case [@discriminator, value] - in [_, FinchAPI::BaseModel] - value.class - in [Symbol, Hash] - key = - if value.key?(@discriminator) - value.fetch(@discriminator) - elsif value.key?((discriminator = @discriminator.to_s)) - value.fetch(discriminator) - end + # @api private + # + # @param value [Object] + # + # @return [FinchAPI::Converter, Class, nil] + private def resolve_variant(value) + case [@discriminator, value] + in [_, FinchAPI::BaseModel] + value.class + in [Symbol, Hash] + key = + if value.key?(@discriminator) + value.fetch(@discriminator) + elsif value.key?((discriminator = @discriminator.to_s)) + value.fetch(discriminator) + end - key = key.to_sym if key.is_a?(String) - _, resolved = known_variants.find { |k,| k == key } - resolved.nil? ? FinchAPI::Unknown : resolved.call - else - nil - end + key = key.to_sym if key.is_a?(String) + _, resolved = known_variants.find { |k,| k == key } + resolved.nil? ? FinchAPI::Unknown : resolved.call + else + nil end end @@ -510,7 +500,7 @@ def variants # @param other [Object] # # @return [Boolean] - def self.===(other) + def ===(other) known_variants.any? do |_, variant_fn| variant_fn.call === other end @@ -519,90 +509,88 @@ def self.===(other) # @param other [Object] # # @return [Boolean] - def self.==(other) - other.is_a?(Class) && other <= FinchAPI::Union && other.derefed_variants == derefed_variants + def ==(other) + other.is_a?(Module) && other.singleton_class.ancestors.include?(FinchAPI::Union) && other.derefed_variants == derefed_variants end - class << self - # @api private - # - # @param value [Object] - # - # @return [Object] - def coerce(value) - if (variant = resolve_variant(value)) - return FinchAPI::Converter.coerce(variant, value) - end + # @api private + # + # @param value [Object] + # + # @return [Object] + def coerce(value) + if (variant = resolve_variant(value)) + return FinchAPI::Converter.coerce(variant, value) + end - matches = [] + matches = [] - known_variants.each do |_, variant_fn| - variant = variant_fn.call + known_variants.each do |_, variant_fn| + variant = variant_fn.call - case FinchAPI::Converter.try_strict_coerce(variant, value) - in [true, coerced, _] - return coerced - in [false, true, score] - matches << [score, variant] - in [false, false, _] - nil - end + case FinchAPI::Converter.try_strict_coerce(variant, value) + in [true, coerced, _] + return coerced + in [false, true, score] + matches << [score, variant] + in [false, false, _] + nil end + end + + _, variant = matches.sort! { _2.first <=> _1.first }.find { |score,| !score.zero? } + variant.nil? ? value : FinchAPI::Converter.coerce(variant, value) + end - _, variant = matches.sort! { _2.first <=> _1.first }.find { |score,| !score.zero? } - variant.nil? ? value : FinchAPI::Converter.coerce(variant, value) + # @api private + # + # @param value [Object] + # + # @return [Object] + def dump(value) + if (variant = resolve_variant(value)) + return FinchAPI::Converter.dump(variant, value) end - # @api private - # - # @param value [Object] - # - # @return [Object] - def dump(value) - if (variant = resolve_variant(value)) + known_variants.each do |_, variant_fn| + variant = variant_fn.call + if variant === value return FinchAPI::Converter.dump(variant, value) end - - known_variants.each do |_, variant_fn| - variant = variant_fn.call - if variant === value - return FinchAPI::Converter.dump(variant, value) - end - end - value end + value + end - # @api private - # - # @param value [Object] - # - # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] - def try_strict_coerce(value) - # TODO(ruby) this will result in super linear decoding behaviour for nested unions - # follow up with a decoding context that captures current strictness levels - if (variant = resolve_variant(value)) - return Converter.try_strict_coerce(variant, value) - end + # @api private + # + # @param value [Object] + # + # @return [Array(true, Object, nil), Array(false, Boolean, Integer)] + def try_strict_coerce(value) + # TODO(ruby) this will result in super linear decoding behaviour for nested unions + # follow up with a decoding context that captures current strictness levels + if (variant = resolve_variant(value)) + return Converter.try_strict_coerce(variant, value) + end - coercible = false - max_score = 0 + coercible = false + max_score = 0 - known_variants.each do |_, variant_fn| - variant = variant_fn.call + known_variants.each do |_, variant_fn| + variant = variant_fn.call - case FinchAPI::Converter.try_strict_coerce(variant, value) - in [true, coerced, score] - return [true, coerced, score] - in [false, true, score] - coercible = true - max_score = [max_score, score].max - in [false, false, _] - nil - end + case FinchAPI::Converter.try_strict_coerce(variant, value) + in [true, coerced, score] + return [true, coerced, score] + in [false, true, score] + coercible = true + max_score = [max_score, score].max + in [false, false, _] + nil end - - [false, coercible, max_score] end + + [false, coercible, max_score] end # rubocop:enable Style/CaseEquality @@ -949,7 +937,7 @@ def defaults = (@defaults ||= {}) private def add_field(name_sym, required:, type_info:, spec:) type_fn, info = case type_info - in Proc | Class | FinchAPI::Converter + in Proc | Module | FinchAPI::Converter [FinchAPI::Converter.type_info({**spec, union: type_info}), spec] in Hash [FinchAPI::Converter.type_info(type_info), type_info] @@ -1221,7 +1209,7 @@ def initialize(data = {}) type = self.class.fields[mapped]&.fetch(:type) stored = case [type, value] - in [Class, Hash] if type <= FinchAPI::BaseModel + in [Module, Hash] if type <= FinchAPI::BaseModel type.new(value) in [FinchAPI::ArrayOf, Array] | [FinchAPI::HashOf, Hash] type.coerce(value) diff --git a/lib/finch-api/models/account_update_event.rb b/lib/finch-api/models/account_update_event.rb index caf4c725..721d247b 100644 --- a/lib/finch-api/models/account_update_event.rb +++ b/lib/finch-api/models/account_update_event.rb @@ -1918,10 +1918,10 @@ class PayPeriod < FinchAPI::BaseModel end end - # @abstract - # # The type of authentication method. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + ASSISTED = :assisted CREDENTIAL = :credential API_TOKEN = :api_token @@ -1933,8 +1933,9 @@ class Type < FinchAPI::Enum end end - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + ACCOUNT_UPDATED = :"account.updated" finalize! diff --git a/lib/finch-api/models/company_event.rb b/lib/finch-api/models/company_event.rb index ab4f1190..9cc2ed6a 100644 --- a/lib/finch-api/models/company_event.rb +++ b/lib/finch-api/models/company_event.rb @@ -25,8 +25,9 @@ class CompanyEvent < FinchAPI::Models::BaseWebhookEvent # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + COMPANY_UPDATED = :"company.updated" finalize! diff --git a/lib/finch-api/models/connect/session_new_params.rb b/lib/finch-api/models/connect/session_new_params.rb index 06e5fb3a..b44c44de 100644 --- a/lib/finch-api/models/connect/session_new_params.rb +++ b/lib/finch-api/models/connect/session_new_params.rb @@ -85,10 +85,10 @@ class SessionNewParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The Finch products that can be requested during the Connect flow. - class Product < FinchAPI::Enum + module Product + extend FinchAPI::Enum + COMPANY = :company DIRECTORY = :directory INDIVIDUAL = :individual @@ -122,8 +122,9 @@ class Integration < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class AuthMethod < FinchAPI::Enum + module AuthMethod + extend FinchAPI::Enum + ASSISTED = :assisted CREDENTIAL = :credential OAUTH = :oauth @@ -133,8 +134,9 @@ class AuthMethod < FinchAPI::Enum end end - # @abstract - class Sandbox < FinchAPI::Enum + module Sandbox + extend FinchAPI::Enum + FINCH = :finch PROVIDER = :provider diff --git a/lib/finch-api/models/connect/session_reauthenticate_params.rb b/lib/finch-api/models/connect/session_reauthenticate_params.rb index 4c3f1e74..13515eb9 100644 --- a/lib/finch-api/models/connect/session_reauthenticate_params.rb +++ b/lib/finch-api/models/connect/session_reauthenticate_params.rb @@ -46,10 +46,10 @@ class SessionReauthenticateParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The Finch products that can be requested during the Connect flow. - class Product < FinchAPI::Enum + module Product + extend FinchAPI::Enum + COMPANY = :company DIRECTORY = :directory INDIVIDUAL = :individual diff --git a/lib/finch-api/models/connection_status_type.rb b/lib/finch-api/models/connection_status_type.rb index 71d7aff6..a0f78058 100644 --- a/lib/finch-api/models/connection_status_type.rb +++ b/lib/finch-api/models/connection_status_type.rb @@ -2,8 +2,9 @@ module FinchAPI module Models - # @abstract - class ConnectionStatusType < FinchAPI::Enum + module ConnectionStatusType + extend FinchAPI::Enum + PENDING = :pending PROCESSING = :processing CONNECTED = :connected diff --git a/lib/finch-api/models/create_access_token_response.rb b/lib/finch-api/models/create_access_token_response.rb index 6b3864fe..e6881201 100644 --- a/lib/finch-api/models/create_access_token_response.rb +++ b/lib/finch-api/models/create_access_token_response.rb @@ -103,10 +103,10 @@ class CreateAccessTokenResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The type of application associated with a token. - class ClientType < FinchAPI::Enum + module ClientType + extend FinchAPI::Enum + PRODUCTION = :production DEVELOPMENT = :development SANDBOX = :sandbox @@ -114,13 +114,13 @@ class ClientType < FinchAPI::Enum finalize! end - # @abstract - # # The type of the connection associated with the token. # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - class ConnectionType < FinchAPI::Enum + module ConnectionType + extend FinchAPI::Enum + PROVIDER = :provider FINCH = :finch diff --git a/lib/finch-api/models/directory_event.rb b/lib/finch-api/models/directory_event.rb index d2901729..51151aa3 100644 --- a/lib/finch-api/models/directory_event.rb +++ b/lib/finch-api/models/directory_event.rb @@ -48,8 +48,9 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + DIRECTORY_CREATED = :"directory.created" DIRECTORY_UPDATED = :"directory.updated" DIRECTORY_DELETED = :"directory.deleted" diff --git a/lib/finch-api/models/employment_event.rb b/lib/finch-api/models/employment_event.rb index 6b5f3dd6..85d9705f 100644 --- a/lib/finch-api/models/employment_event.rb +++ b/lib/finch-api/models/employment_event.rb @@ -48,8 +48,9 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + EMPLOYMENT_CREATED = :"employment.created" EMPLOYMENT_UPDATED = :"employment.updated" EMPLOYMENT_DELETED = :"employment.deleted" diff --git a/lib/finch-api/models/hris/benefit_contribution.rb b/lib/finch-api/models/hris/benefit_contribution.rb index 7cdc6657..9b5253bf 100644 --- a/lib/finch-api/models/hris/benefit_contribution.rb +++ b/lib/finch-api/models/hris/benefit_contribution.rb @@ -24,10 +24,10 @@ class BenefitContribution < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # Contribution type. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + FIXED = :fixed PERCENT = :percent diff --git a/lib/finch-api/models/hris/benefit_features_and_operations.rb b/lib/finch-api/models/hris/benefit_features_and_operations.rb index 156eed1c..7215f5d5 100644 --- a/lib/finch-api/models/hris/benefit_features_and_operations.rb +++ b/lib/finch-api/models/hris/benefit_features_and_operations.rb @@ -124,24 +124,27 @@ class SupportedFeatures < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class CompanyContribution < FinchAPI::Enum + module CompanyContribution + extend FinchAPI::Enum + FIXED = :fixed PERCENT = :percent finalize! end - # @abstract - class EmployeeDeduction < FinchAPI::Enum + module EmployeeDeduction + extend FinchAPI::Enum + FIXED = :fixed PERCENT = :percent finalize! end - # @abstract - class HsaContributionLimit < FinchAPI::Enum + module HsaContributionLimit + extend FinchAPI::Enum + INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/hris/benefit_frequency.rb b/lib/finch-api/models/hris/benefit_frequency.rb index 509a3657..298724d4 100644 --- a/lib/finch-api/models/hris/benefit_frequency.rb +++ b/lib/finch-api/models/hris/benefit_frequency.rb @@ -3,8 +3,9 @@ module FinchAPI module Models module HRIS - # @abstract - class BenefitFrequency < FinchAPI::Enum + module BenefitFrequency + extend FinchAPI::Enum + ONE_TIME = :one_time EVERY_PAYCHECK = :every_paycheck MONTHLY = :monthly diff --git a/lib/finch-api/models/hris/benefit_type.rb b/lib/finch-api/models/hris/benefit_type.rb index cfeb25eb..96447146 100644 --- a/lib/finch-api/models/hris/benefit_type.rb +++ b/lib/finch-api/models/hris/benefit_type.rb @@ -3,10 +3,10 @@ module FinchAPI module Models module HRIS - # @abstract - # # Type of benefit. - class BenefitType < FinchAPI::Enum + module BenefitType + extend FinchAPI::Enum + NUMBER_401K = :"401k" NUMBER_401K_ROTH = :"401k_roth" NUMBER_401K_LOAN = :"401k_loan" diff --git a/lib/finch-api/models/hris/benefits/enrolled_individual.rb b/lib/finch-api/models/hris/benefits/enrolled_individual.rb index b0f17658..f4842898 100644 --- a/lib/finch-api/models/hris/benefits/enrolled_individual.rb +++ b/lib/finch-api/models/hris/benefits/enrolled_individual.rb @@ -71,10 +71,10 @@ class Body < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - # # HTTP status code. Either 201 or 200 - class Code < FinchAPI::Enum + module Code + extend FinchAPI::Enum + OK = 200 CREATED = 201 NOT_FOUND = 404 diff --git a/lib/finch-api/models/hris/benefits/individual_benefit.rb b/lib/finch-api/models/hris/benefits/individual_benefit.rb index 695b332c..726920db 100644 --- a/lib/finch-api/models/hris/benefits/individual_benefit.rb +++ b/lib/finch-api/models/hris/benefits/individual_benefit.rb @@ -93,10 +93,10 @@ class Body < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # Type for HSA contribution limit if the benefit is a HSA. - class HsaContributionLimit < FinchAPI::Enum + module HsaContributionLimit + extend FinchAPI::Enum + INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb index 82dc6b95..a33198e0 100644 --- a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +++ b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb @@ -126,11 +126,11 @@ class Configuration < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # For HSA benefits only - whether the contribution limit is for an individual or # family - class AnnualContributionLimit < FinchAPI::Enum + module AnnualContributionLimit + extend FinchAPI::Enum + INDIVIDUAL = :individual FAMILY = :family @@ -167,8 +167,9 @@ class CompanyContribution < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + FIXED = :fixed PERCENT = :percent @@ -206,8 +207,9 @@ class EmployeeDeduction < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + FIXED = :fixed PERCENT = :percent diff --git a/lib/finch-api/models/hris/company.rb b/lib/finch-api/models/hris/company.rb index a8e2e756..4c2c048a 100644 --- a/lib/finch-api/models/hris/company.rb +++ b/lib/finch-api/models/hris/company.rb @@ -130,10 +130,10 @@ class Account < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The type of bank account. - class AccountType < FinchAPI::Enum + module AccountType + extend FinchAPI::Enum + CHECKING = :checking SAVINGS = :savings @@ -203,10 +203,10 @@ class Entity < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The tax payer subtype of the company. - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + S_CORPORATION = :s_corporation C_CORPORATION = :c_corporation B_CORPORATION = :b_corporation @@ -214,10 +214,10 @@ class Subtype < FinchAPI::Enum finalize! end - # @abstract - # # The tax payer type of the company. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + LLC = :llc LP = :lp CORPORATION = :corporation diff --git a/lib/finch-api/models/hris/document_list_params.rb b/lib/finch-api/models/hris/document_list_params.rb index 211ed785..f8f4ab25 100644 --- a/lib/finch-api/models/hris/document_list_params.rb +++ b/lib/finch-api/models/hris/document_list_params.rb @@ -61,8 +61,9 @@ class DocumentListParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2020 = :w4_2020 W4_2005 = :w4_2005 diff --git a/lib/finch-api/models/hris/document_response.rb b/lib/finch-api/models/hris/document_response.rb index d776e335..c3c68be2 100644 --- a/lib/finch-api/models/hris/document_response.rb +++ b/lib/finch-api/models/hris/document_response.rb @@ -59,10 +59,10 @@ class DocumentResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The type of document. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2020 = :w4_2020 W4_2005 = :w4_2005 diff --git a/lib/finch-api/models/hris/document_retreive_response.rb b/lib/finch-api/models/hris/document_retreive_response.rb index b5d98436..4c15ce9a 100644 --- a/lib/finch-api/models/hris/document_retreive_response.rb +++ b/lib/finch-api/models/hris/document_retreive_response.rb @@ -3,11 +3,11 @@ module FinchAPI module Models module HRIS - # @abstract - # # A 2020 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. - class DocumentRetreiveResponse < FinchAPI::Union + module DocumentRetreiveResponse + extend FinchAPI::Union + discriminator :type # A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details. diff --git a/lib/finch-api/models/hris/employment_data.rb b/lib/finch-api/models/hris/employment_data.rb index 12f6497b..e47bbfaa 100644 --- a/lib/finch-api/models/hris/employment_data.rb +++ b/lib/finch-api/models/hris/employment_data.rb @@ -251,11 +251,11 @@ class Employment < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME = :full_time INTERN = :intern PART_TIME = :part_time @@ -266,10 +266,10 @@ class Subtype < FinchAPI::Enum finalize! end - # @abstract - # # The main employment type of the individual. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE = :employee CONTRACTOR = :contractor @@ -277,11 +277,11 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The detailed employment status of the individual. Available options: `active`, # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE = :active DECEASED = :deceased LEAVE = :leave diff --git a/lib/finch-api/models/hris/individual.rb b/lib/finch-api/models/hris/individual.rb index 4f0c37b0..80d0dea7 100644 --- a/lib/finch-api/models/hris/individual.rb +++ b/lib/finch-api/models/hris/individual.rb @@ -148,8 +148,9 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal @@ -157,10 +158,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN = :asian WHITE = :white BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american @@ -173,10 +174,10 @@ class Ethnicity < FinchAPI::Enum finalize! end - # @abstract - # # The gender of the individual. - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE = :female MALE = :male OTHER = :other @@ -204,8 +205,9 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/hris/pay_statement.rb b/lib/finch-api/models/hris/pay_statement.rb index 819e3de5..b86ed4eb 100644 --- a/lib/finch-api/models/hris/pay_statement.rb +++ b/lib/finch-api/models/hris/pay_statement.rb @@ -191,10 +191,10 @@ class Metadata < FinchAPI::BaseModel end end - # @abstract - # # The type of earning. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + SALARY = :salary WAGE = :wage REIMBURSEMENT = :reimbursement @@ -387,10 +387,10 @@ class Metadata < FinchAPI::BaseModel end end - # @abstract - # # The payment method. - class PaymentMethod < FinchAPI::Enum + module PaymentMethod + extend FinchAPI::Enum + CHECK = :check DIRECT_DEPOSIT = :direct_deposit @@ -484,10 +484,10 @@ class Metadata < FinchAPI::BaseModel end end - # @abstract - # # The type of taxes. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + STATE = :state FEDERAL = :federal LOCAL = :local @@ -497,10 +497,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The type of the payment associated with the pay statement. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + REGULAR_PAYROLL = :regular_payroll OFF_CYCLE_PAYROLL = :off_cycle_payroll ONE_TIME_PAYMENT = :one_time_payment diff --git a/lib/finch-api/models/hris/payment.rb b/lib/finch-api/models/hris/payment.rb index 38da06af..2ca86899 100644 --- a/lib/finch-api/models/hris/payment.rb +++ b/lib/finch-api/models/hris/payment.rb @@ -109,8 +109,9 @@ class Payment < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class PayFrequency < FinchAPI::Enum + module PayFrequency + extend FinchAPI::Enum + ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually QUARTERLY = :quarterly diff --git a/lib/finch-api/models/hris/supported_benefit.rb b/lib/finch-api/models/hris/supported_benefit.rb index d7595191..e8b409cd 100644 --- a/lib/finch-api/models/hris/supported_benefit.rb +++ b/lib/finch-api/models/hris/supported_benefit.rb @@ -92,24 +92,27 @@ class SupportedBenefit < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class CompanyContribution < FinchAPI::Enum + module CompanyContribution + extend FinchAPI::Enum + FIXED = :fixed PERCENT = :percent finalize! end - # @abstract - class EmployeeDeduction < FinchAPI::Enum + module EmployeeDeduction + extend FinchAPI::Enum + FIXED = :fixed PERCENT = :percent finalize! end - # @abstract - class HsaContributionLimit < FinchAPI::Enum + module HsaContributionLimit + extend FinchAPI::Enum + INDIVIDUAL = :individual FAMILY = :family diff --git a/lib/finch-api/models/hris/w42005.rb b/lib/finch-api/models/hris/w42005.rb index c0821600..dcb80435 100644 --- a/lib/finch-api/models/hris/w42005.rb +++ b/lib/finch-api/models/hris/w42005.rb @@ -107,20 +107,20 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # Indicates exemption status from federal tax withholding. - class Exemption < FinchAPI::Enum + module Exemption + extend FinchAPI::Enum + EXEMPT = :exempt NON_EXEMPT = :non_exempt finalize! end - # @abstract - # # The individual's filing status for tax purposes. - class FilingStatus < FinchAPI::Enum + module FilingStatus + extend FinchAPI::Enum + MARRIED = :married MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate SINGLE = :single @@ -129,10 +129,10 @@ class FilingStatus < FinchAPI::Enum end end - # @abstract - # # Specifies the form type, indicating that this document is a 2005 W4 form. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2005 = :w4_2005 finalize! diff --git a/lib/finch-api/models/hris/w42020.rb b/lib/finch-api/models/hris/w42020.rb index 961f0085..672c25fc 100644 --- a/lib/finch-api/models/hris/w42020.rb +++ b/lib/finch-api/models/hris/w42020.rb @@ -124,10 +124,10 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The individual's filing status for tax purposes. - class FilingStatus < FinchAPI::Enum + module FilingStatus + extend FinchAPI::Enum + HEAD_OF_HOUSEHOLD = :head_of_household MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = :married_filing_jointly_or_qualifying_surviving_spouse @@ -137,10 +137,10 @@ class FilingStatus < FinchAPI::Enum end end - # @abstract - # # Specifies the form type, indicating that this document is a 2020 W4 form. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2020 = :w4_2020 finalize! diff --git a/lib/finch-api/models/income.rb b/lib/finch-api/models/income.rb index 04e87cac..235da202 100644 --- a/lib/finch-api/models/income.rb +++ b/lib/finch-api/models/income.rb @@ -42,11 +42,11 @@ class Income < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. - class Unit < FinchAPI::Enum + module Unit + extend FinchAPI::Enum + YEARLY = :yearly QUARTERLY = :quarterly MONTHLY = :monthly diff --git a/lib/finch-api/models/individual_event.rb b/lib/finch-api/models/individual_event.rb index 224b1fd3..0376ba55 100644 --- a/lib/finch-api/models/individual_event.rb +++ b/lib/finch-api/models/individual_event.rb @@ -48,8 +48,9 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + INDIVIDUAL_CREATED = :"individual.created" INDIVIDUAL_UPDATED = :"individual.updated" INDIVIDUAL_DELETED = :"individual.deleted" diff --git a/lib/finch-api/models/introspection.rb b/lib/finch-api/models/introspection.rb index 9fc45166..fed47dae 100644 --- a/lib/finch-api/models/introspection.rb +++ b/lib/finch-api/models/introspection.rb @@ -219,10 +219,10 @@ class ConnectionStatus < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - # # The type of authentication method. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + ASSISTED = :assisted CREDENTIAL = :credential API_TOKEN = :api_token @@ -233,10 +233,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The type of application associated with a token. - class ClientType < FinchAPI::Enum + module ClientType + extend FinchAPI::Enum + PRODUCTION = :production DEVELOPMENT = :development SANDBOX = :sandbox @@ -272,13 +272,13 @@ class ConnectionStatus < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - # # The type of the connection associated with the token. # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - class ConnectionType < FinchAPI::Enum + module ConnectionType + extend FinchAPI::Enum + PROVIDER = :provider FINCH = :finch diff --git a/lib/finch-api/models/job_completion_event.rb b/lib/finch-api/models/job_completion_event.rb index 2bcb7d0a..52da8a62 100644 --- a/lib/finch-api/models/job_completion_event.rb +++ b/lib/finch-api/models/job_completion_event.rb @@ -51,8 +51,9 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + JOB_BENEFIT_CREATE_COMPLETED = :"job.benefit_create.completed" JOB_BENEFIT_ENROLL_COMPLETED = :"job.benefit_enroll.completed" JOB_BENEFIT_REGISTER_COMPLETED = :"job.benefit_register.completed" diff --git a/lib/finch-api/models/jobs/automated_async_job.rb b/lib/finch-api/models/jobs/automated_async_job.rb index 02543989..4d63c3f9 100644 --- a/lib/finch-api/models/jobs/automated_async_job.rb +++ b/lib/finch-api/models/jobs/automated_async_job.rb @@ -97,8 +97,9 @@ class Params < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - class Status < FinchAPI::Enum + module Status + extend FinchAPI::Enum + PENDING = :pending IN_PROGRESS = :in_progress COMPLETE = :complete @@ -109,10 +110,10 @@ class Status < FinchAPI::Enum finalize! end - # @abstract - # # The type of automated job - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + DATA_SYNC_ALL = :data_sync_all W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync diff --git a/lib/finch-api/models/jobs/automated_create_params.rb b/lib/finch-api/models/jobs/automated_create_params.rb index 5c7c43b3..4020f88a 100644 --- a/lib/finch-api/models/jobs/automated_create_params.rb +++ b/lib/finch-api/models/jobs/automated_create_params.rb @@ -28,10 +28,10 @@ class AutomatedCreateParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The type of job to start. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync finalize! diff --git a/lib/finch-api/models/jobs/manual_async_job.rb b/lib/finch-api/models/jobs/manual_async_job.rb index 3707ffca..f020b68a 100644 --- a/lib/finch-api/models/jobs/manual_async_job.rb +++ b/lib/finch-api/models/jobs/manual_async_job.rb @@ -29,8 +29,9 @@ class ManualAsyncJob < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Status < FinchAPI::Enum + module Status + extend FinchAPI::Enum + PENDING = :pending IN_PROGRESS = :in_progress ERROR = :error diff --git a/lib/finch-api/models/operation_support.rb b/lib/finch-api/models/operation_support.rb index ee695b65..477aecf9 100644 --- a/lib/finch-api/models/operation_support.rb +++ b/lib/finch-api/models/operation_support.rb @@ -2,8 +2,6 @@ module FinchAPI module Models - # @abstract - # # - `supported`: This operation is supported by both the provider and Finch # - `not_supported_by_finch`: This operation is not supported by Finch but # supported by the provider @@ -11,7 +9,9 @@ module Models # so Finch cannot support # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch - class OperationSupport < FinchAPI::Enum + module OperationSupport + extend FinchAPI::Enum + SUPPORTED = :supported NOT_SUPPORTED_BY_FINCH = :not_supported_by_finch NOT_SUPPORTED_BY_PROVIDER = :not_supported_by_provider diff --git a/lib/finch-api/models/pay_statement_event.rb b/lib/finch-api/models/pay_statement_event.rb index 84749bee..34ed514c 100644 --- a/lib/finch-api/models/pay_statement_event.rb +++ b/lib/finch-api/models/pay_statement_event.rb @@ -59,8 +59,9 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + PAY_STATEMENT_CREATED = :"pay_statement.created" PAY_STATEMENT_UPDATED = :"pay_statement.updated" PAY_STATEMENT_DELETED = :"pay_statement.deleted" diff --git a/lib/finch-api/models/payment_event.rb b/lib/finch-api/models/payment_event.rb index 3b1347cc..ead1e81b 100644 --- a/lib/finch-api/models/payment_event.rb +++ b/lib/finch-api/models/payment_event.rb @@ -51,8 +51,9 @@ class Data < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void end - # @abstract - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + PAYMENT_CREATED = :"payment.created" PAYMENT_UPDATED = :"payment.updated" PAYMENT_DELETED = :"payment.deleted" diff --git a/lib/finch-api/models/payroll/pay_group_list_response.rb b/lib/finch-api/models/payroll/pay_group_list_response.rb index d600cf7a..01bee766 100644 --- a/lib/finch-api/models/payroll/pay_group_list_response.rb +++ b/lib/finch-api/models/payroll/pay_group_list_response.rb @@ -44,8 +44,9 @@ class PayGroupListResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class PayFrequency < FinchAPI::Enum + module PayFrequency + extend FinchAPI::Enum + ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually QUARTERLY = :quarterly diff --git a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb index 7009abab..705ade68 100644 --- a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +++ b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb @@ -38,8 +38,9 @@ class PayGroupRetrieveResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class PayFrequency < FinchAPI::Enum + module PayFrequency + extend FinchAPI::Enum + ANNUALLY = :annually SEMI_ANNUALLY = :semi_annually QUARTERLY = :quarterly diff --git a/lib/finch-api/models/provider.rb b/lib/finch-api/models/provider.rb index 18a4ca4c..22e29c6d 100644 --- a/lib/finch-api/models/provider.rb +++ b/lib/finch-api/models/provider.rb @@ -2000,10 +2000,10 @@ class PayPeriod < FinchAPI::BaseModel end end - # @abstract - # # The type of authentication method. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + ASSISTED = :assisted CREDENTIAL = :credential API_TOKEN = :api_token diff --git a/lib/finch-api/models/sandbox/company_update_params.rb b/lib/finch-api/models/sandbox/company_update_params.rb index 3ef4e37c..0b757a8f 100644 --- a/lib/finch-api/models/sandbox/company_update_params.rb +++ b/lib/finch-api/models/sandbox/company_update_params.rb @@ -132,10 +132,10 @@ class Account < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The type of bank account. - class AccountType < FinchAPI::Enum + module AccountType + extend FinchAPI::Enum + CHECKING = :checking SAVINGS = :savings @@ -207,10 +207,10 @@ class Entity < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The tax payer subtype of the company. - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + S_CORPORATION = :s_corporation C_CORPORATION = :c_corporation B_CORPORATION = :b_corporation @@ -218,10 +218,10 @@ class Subtype < FinchAPI::Enum finalize! end - # @abstract - # # The tax payer type of the company. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + LLC = :llc LP = :lp CORPORATION = :corporation diff --git a/lib/finch-api/models/sandbox/company_update_response.rb b/lib/finch-api/models/sandbox/company_update_response.rb index a7b7318d..3c80c307 100644 --- a/lib/finch-api/models/sandbox/company_update_response.rb +++ b/lib/finch-api/models/sandbox/company_update_response.rb @@ -114,10 +114,10 @@ class Account < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The type of bank account. - class AccountType < FinchAPI::Enum + module AccountType + extend FinchAPI::Enum + CHECKING = :checking SAVINGS = :savings @@ -189,10 +189,10 @@ class Entity < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The tax payer subtype of the company. - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + S_CORPORATION = :s_corporation C_CORPORATION = :c_corporation B_CORPORATION = :b_corporation @@ -200,10 +200,10 @@ class Subtype < FinchAPI::Enum finalize! end - # @abstract - # # The tax payer type of the company. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + LLC = :llc LP = :lp CORPORATION = :corporation diff --git a/lib/finch-api/models/sandbox/connection_create_params.rb b/lib/finch-api/models/sandbox/connection_create_params.rb index 8aa4bd98..e1a4acf5 100644 --- a/lib/finch-api/models/sandbox/connection_create_params.rb +++ b/lib/finch-api/models/sandbox/connection_create_params.rb @@ -56,8 +56,9 @@ class ConnectionCreateParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth diff --git a/lib/finch-api/models/sandbox/connection_create_response.rb b/lib/finch-api/models/sandbox/connection_create_response.rb index 9248c964..a6cf7524 100644 --- a/lib/finch-api/models/sandbox/connection_create_response.rb +++ b/lib/finch-api/models/sandbox/connection_create_response.rb @@ -79,8 +79,9 @@ class ConnectionCreateResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth diff --git a/lib/finch-api/models/sandbox/connections/account_create_params.rb b/lib/finch-api/models/sandbox/connections/account_create_params.rb index 8d1fd510..e0ad65e4 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_params.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_params.rb @@ -52,8 +52,9 @@ class AccountCreateParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth diff --git a/lib/finch-api/models/sandbox/connections/account_create_response.rb b/lib/finch-api/models/sandbox/connections/account_create_response.rb index 967b79c3..a036233e 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_response.rb @@ -58,8 +58,9 @@ class AccountCreateResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth diff --git a/lib/finch-api/models/sandbox/connections/account_update_response.rb b/lib/finch-api/models/sandbox/connections/account_update_response.rb index 34b7892d..d675c17f 100644 --- a/lib/finch-api/models/sandbox/connections/account_update_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_update_response.rb @@ -56,8 +56,9 @@ class AccountUpdateResponse < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL = :credential API_TOKEN = :api_token OAUTH = :oauth diff --git a/lib/finch-api/models/sandbox/directory_create_params.rb b/lib/finch-api/models/sandbox/directory_create_params.rb index e187b88c..100f8433 100644 --- a/lib/finch-api/models/sandbox/directory_create_params.rb +++ b/lib/finch-api/models/sandbox/directory_create_params.rb @@ -342,8 +342,9 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal @@ -379,11 +380,11 @@ class Employment < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME = :full_time INTERN = :intern PART_TIME = :part_time @@ -394,10 +395,10 @@ class Subtype < FinchAPI::Enum finalize! end - # @abstract - # # The main employment type of the individual. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE = :employee CONTRACTOR = :contractor @@ -405,10 +406,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The detailed employment status of the individual. - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE = :active DECEASED = :deceased LEAVE = :leave @@ -420,10 +421,10 @@ class EmploymentStatus < FinchAPI::Enum finalize! end - # @abstract - # # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN = :asian WHITE = :white BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american @@ -436,10 +437,10 @@ class Ethnicity < FinchAPI::Enum finalize! end - # @abstract - # # The gender of the individual. - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE = :female MALE = :male OTHER = :other @@ -494,8 +495,9 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/employment_update_params.rb b/lib/finch-api/models/sandbox/employment_update_params.rb index 09b2a719..ed4bead6 100644 --- a/lib/finch-api/models/sandbox/employment_update_params.rb +++ b/lib/finch-api/models/sandbox/employment_update_params.rb @@ -244,11 +244,11 @@ class Employment < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME = :full_time INTERN = :intern PART_TIME = :part_time @@ -259,10 +259,10 @@ class Subtype < FinchAPI::Enum finalize! end - # @abstract - # # The main employment type of the individual. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE = :employee CONTRACTOR = :contractor @@ -270,10 +270,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The detailed employment status of the individual. - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE = :active DECEASED = :deceased LEAVE = :leave diff --git a/lib/finch-api/models/sandbox/employment_update_response.rb b/lib/finch-api/models/sandbox/employment_update_response.rb index cf696397..c2a20ca4 100644 --- a/lib/finch-api/models/sandbox/employment_update_response.rb +++ b/lib/finch-api/models/sandbox/employment_update_response.rb @@ -250,11 +250,11 @@ class Employment < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME = :full_time INTERN = :intern PART_TIME = :part_time @@ -265,10 +265,10 @@ class Subtype < FinchAPI::Enum finalize! end - # @abstract - # # The main employment type of the individual. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE = :employee CONTRACTOR = :contractor @@ -276,10 +276,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The detailed employment status of the individual. - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE = :active DECEASED = :deceased LEAVE = :leave diff --git a/lib/finch-api/models/sandbox/individual_update_params.rb b/lib/finch-api/models/sandbox/individual_update_params.rb index c72390ef..66d52a9b 100644 --- a/lib/finch-api/models/sandbox/individual_update_params.rb +++ b/lib/finch-api/models/sandbox/individual_update_params.rb @@ -144,8 +144,9 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal @@ -153,10 +154,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN = :asian WHITE = :white BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american @@ -169,10 +170,10 @@ class Ethnicity < FinchAPI::Enum finalize! end - # @abstract - # # The gender of the individual. - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE = :female MALE = :male OTHER = :other @@ -206,8 +207,9 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/individual_update_response.rb b/lib/finch-api/models/sandbox/individual_update_response.rb index da3119dd..67c649a0 100644 --- a/lib/finch-api/models/sandbox/individual_update_response.rb +++ b/lib/finch-api/models/sandbox/individual_update_response.rb @@ -152,8 +152,9 @@ class Email < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal @@ -161,10 +162,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN = :asian WHITE = :white BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american @@ -177,10 +178,10 @@ class Ethnicity < FinchAPI::Enum finalize! end - # @abstract - # # The gender of the individual. - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE = :female MALE = :male OTHER = :other @@ -214,8 +215,9 @@ class PhoneNumber < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK = :work PERSONAL = :personal diff --git a/lib/finch-api/models/sandbox/job_create_params.rb b/lib/finch-api/models/sandbox/job_create_params.rb index a64dea40..ffba6989 100644 --- a/lib/finch-api/models/sandbox/job_create_params.rb +++ b/lib/finch-api/models/sandbox/job_create_params.rb @@ -22,10 +22,10 @@ class JobCreateParams < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - # # The type of job to start. Currently the only supported type is `data_sync_all` - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + DATA_SYNC_ALL = :data_sync_all finalize! diff --git a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb index 38f5d652..8eded8eb 100644 --- a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +++ b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb @@ -24,8 +24,9 @@ class SandboxJobConfiguration < FinchAPI::BaseModel # def initialize: (Hash | FinchAPI::BaseModel) -> void - # @abstract - class CompletionStatus < FinchAPI::Enum + module CompletionStatus + extend FinchAPI::Enum + COMPLETE = :complete REAUTH_ERROR = :reauth_error PERMISSIONS_ERROR = :permissions_error @@ -34,8 +35,9 @@ class CompletionStatus < FinchAPI::Enum finalize! end - # @abstract - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + DATA_SYNC_ALL = :data_sync_all finalize! diff --git a/lib/finch-api/models/sandbox/payment_create_params.rb b/lib/finch-api/models/sandbox/payment_create_params.rb index 77f49849..3fa1643c 100644 --- a/lib/finch-api/models/sandbox/payment_create_params.rb +++ b/lib/finch-api/models/sandbox/payment_create_params.rb @@ -243,10 +243,10 @@ class Metadata < FinchAPI::BaseModel end end - # @abstract - # # The type of earning. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + SALARY = :salary WAGE = :wage REIMBURSEMENT = :reimbursement @@ -440,10 +440,10 @@ class Metadata < FinchAPI::BaseModel end end - # @abstract - # # The payment method. - class PaymentMethod < FinchAPI::Enum + module PaymentMethod + extend FinchAPI::Enum + CHECK = :check DIRECT_DEPOSIT = :direct_deposit @@ -542,10 +542,10 @@ class Metadata < FinchAPI::BaseModel end end - # @abstract - # # The type of taxes. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + STATE = :state FEDERAL = :federal LOCAL = :local @@ -555,10 +555,10 @@ class Type < FinchAPI::Enum end end - # @abstract - # # The type of the payment associated with the pay statement. - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + REGULAR_PAYROLL = :regular_payroll OFF_CYCLE_PAYROLL = :off_cycle_payroll ONE_TIME_PAYMENT = :one_time_payment diff --git a/lib/finch-api/models/webhook_event.rb b/lib/finch-api/models/webhook_event.rb index aa3548a2..a8efe956 100644 --- a/lib/finch-api/models/webhook_event.rb +++ b/lib/finch-api/models/webhook_event.rb @@ -2,8 +2,9 @@ module FinchAPI module Models - # @abstract - class WebhookEvent < FinchAPI::Union + module WebhookEvent + extend FinchAPI::Union + discriminator :event_type variant :"account.updated", -> { FinchAPI::Models::AccountUpdateEvent } diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index acfc2180..393f766d 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -170,132 +170,116 @@ module FinchAPI # # We can therefore convert string values to Symbols, but can't convert other # values safely. - class Enum - extend FinchAPI::Converter - - abstract! - - Value = type_template(:out) + module Enum + include FinchAPI::Converter - class << self - # All of the valid Symbol values for this enum. - sig { overridable.returns(T::Array[Value]) } - def values - end + # All of the valid Symbol values for this enum. + sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } + def values + end - # @api private - # - # Guard against thread safety issues by instantiating `@values`. - sig { void } - private def finalize! - end + # @api private + # + # Guard against thread safety issues by instantiating `@values`. + sig { void } + private def finalize! end sig { params(other: T.anything).returns(T::Boolean) } - def self.===(other) + def ===(other) end sig { params(other: T.anything).returns(T::Boolean) } - def self.==(other) + def ==(other) end - class << self - # @api private - sig { override.params(value: T.any(String, Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } - def coerce(value) - end + # @api private + sig { override.params(value: T.any(String, Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } + def coerce(value) + end - # @api private - sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } - def dump(value) - end + # @api private + sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } + def dump(value) + end - # @api private - sig do - override - .params(value: T.anything) - .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) - end - def try_strict_coerce(value) - end + # @api private + sig do + override + .params(value: T.anything) + .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) + end + def try_strict_coerce(value) end end # @api private - class Union - extend FinchAPI::Converter - - abstract! - - Variants = type_template(:out) + module Union + include FinchAPI::Converter - class << self - # @api private - # - # All of the specified variant info for this union. - sig { returns(T::Array[[T.nilable(Symbol), T.proc.returns(Variants)]]) } - private def known_variants - end + # @api private + # + # All of the specified variant info for this union. + sig { returns(T::Array[[T.nilable(Symbol), T.proc.returns(FinchAPI::Converter::Input)]]) } + private def known_variants + end - # @api private - sig { returns(T::Array[[T.nilable(Symbol), Variants]]) } - protected def derefed_variants - end + # @api private + sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) } + protected def derefed_variants + end - # All of the specified variants for this union. - sig { overridable.returns(T::Array[Variants]) } - def variants - end + # All of the specified variants for this union. + sig { overridable.returns(T::Array[T.anything]) } + def variants + end - # @api private - sig { params(property: Symbol).void } - private def discriminator(property) - end + # @api private + sig { params(property: Symbol).void } + private def discriminator(property) + end - # @api private - sig do - params( - key: T.any(Symbol, T::Hash[Symbol, T.anything], T.proc.returns(Variants), Variants), - spec: T.any(T::Hash[Symbol, T.anything], T.proc.returns(Variants), Variants) - ) - .void - end - private def variant(key, spec = nil) - end + # @api private + sig do + params( + key: T.any(Symbol, T::Hash[Symbol, T.anything], T.proc.returns(T.anything), T.anything), + spec: T.any(T::Hash[Symbol, T.anything], T.proc.returns(T.anything), T.anything) + ) + .void + end + private def variant(key, spec = nil) + end - # @api private - sig { params(value: T.anything).returns(T.nilable(Variants)) } - private def resolve_variant(value) - end + # @api private + sig { params(value: T.anything).returns(T.nilable(T.anything)) } + private def resolve_variant(value) end sig { params(other: T.anything).returns(T::Boolean) } - def self.===(other) + def ===(other) end sig { params(other: T.anything).returns(T::Boolean) } - def self.==(other) + def ==(other) end - class << self - # @api private - sig { override.params(value: T.anything).returns(T.anything) } - def coerce(value) - end + # @api private + sig { override.params(value: T.anything).returns(T.anything) } + def coerce(value) + end - # @api private - sig { override.params(value: T.anything).returns(T.anything) } - def dump(value) - end + # @api private + sig { override.params(value: T.anything).returns(T.anything) } + def dump(value) + end - # @api private - sig do - override - .params(value: T.anything) - .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) - end - def try_strict_coerce(value) - end + # @api private + sig do + override + .params(value: T.anything) + .returns(T.any([T::Boolean, T.anything, NilClass], [T::Boolean, T::Boolean, Integer])) + end + def try_strict_coerce(value) end end diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index cff9539a..63e14b9b 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -11,19 +11,36 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) + end def event_type=(_) end - sig { params(data: FinchAPI::Models::AccountUpdateEvent::Data, event_type: Symbol).returns(T.attached_class) } + sig do + params( + data: FinchAPI::Models::AccountUpdateEvent::Data, + event_type: FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: FinchAPI::Models::AccountUpdateEvent::Data, event_type: Symbol}) } + sig do + override + .returns( + { + data: FinchAPI::Models::AccountUpdateEvent::Data, + event_type: FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol + } + ) + end def to_hash end @@ -39,18 +56,21 @@ module FinchAPI def authentication_method=(_) end - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) } def status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + .returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + end def status=(_) end sig do params( authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, - status: Symbol + status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol ) .returns(T.attached_class) end @@ -60,7 +80,10 @@ module FinchAPI sig do override .returns( - {authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, status: Symbol} + { + authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, + status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol + } ) end def to_hash @@ -93,11 +116,14 @@ module FinchAPI end # The type of authentication method. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol)) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + end def type=(_) end @@ -105,7 +131,7 @@ module FinchAPI params( benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), supported_fields: T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields), - type: Symbol + type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol ) .returns(T.attached_class) end @@ -118,7 +144,7 @@ module FinchAPI { benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), supported_fields: T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields), - type: Symbol + type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol } ) end @@ -2451,26 +2477,39 @@ module FinchAPI end # The type of authentication method. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASSISTED = :assisted - CREDENTIAL = :credential - API_TOKEN = :api_token - API_CREDENTIAL = :api_credential - OAUTH = :oauth + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) } + + ASSISTED = + T.let(:assisted, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + CREDENTIAL = + T.let(:credential, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + API_TOKEN = + T.let(:api_token, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + API_CREDENTIAL = + T.let( + :api_credential, + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + ) + OAUTH = + T.let(:oauth, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) end end end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::AccountUpdateEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) } - ACCOUNT_UPDATED = :"account.updated" + ACCOUNT_UPDATED = + T.let(:"account.updated", FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index d09d176f..1702878d 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -13,30 +13,46 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) + end def event_type=(_) end sig do - params(data: T.nilable(T::Hash[Symbol, T.anything]), event_type: Symbol).returns(T.attached_class) + params( + data: T.nilable(T::Hash[Symbol, T.anything]), + event_type: FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: T.nilable(T::Hash[Symbol, T.anything]), event_type: Symbol}) } + sig do + override + .returns( + { + data: T.nilable(T::Hash[Symbol, T.anything]), + event_type: FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol + } + ) + end def to_hash end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::CompanyEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) } - COMPANY_UPDATED = :"company.updated" + COMPANY_UPDATED = T.let(:"company.updated", FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 17b6467d..52a6004b 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -23,11 +23,14 @@ module FinchAPI def customer_name=(_) end - sig { returns(T::Array[Symbol]) } + sig { returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol]) } def products end - sig { params(_: T::Array[Symbol]).returns(T::Array[Symbol]) } + sig do + params(_: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol]) + .returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol]) + end def products=(_) end @@ -76,11 +79,14 @@ module FinchAPI def redirect_uri=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol)) } def sandbox end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol)) + end def sandbox=(_) end @@ -88,13 +94,13 @@ module FinchAPI params( customer_id: String, customer_name: String, - products: T::Array[Symbol], + products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol], customer_email: T.nilable(String), integration: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration), manual: T.nilable(T::Boolean), minutes_to_expire: T.nilable(Float), redirect_uri: T.nilable(String), - sandbox: T.nilable(Symbol), + sandbox: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) .returns(T.attached_class) @@ -119,13 +125,13 @@ module FinchAPI { customer_id: String, customer_name: String, - products: T::Array[Symbol], + products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol], customer_email: T.nilable(String), integration: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration), manual: T.nilable(T::Boolean), minutes_to_expire: T.nilable(Float), redirect_uri: T.nilable(String), - sandbox: T.nilable(Symbol), + sandbox: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol), request_options: FinchAPI::RequestOptions } ) @@ -134,27 +140,32 @@ module FinchAPI end # The Finch products that can be requested during the Connect flow. - class Product < FinchAPI::Enum - abstract! + module Product + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionNewParams::Product) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) } - COMPANY = :company - DIRECTORY = :directory - INDIVIDUAL = :individual - EMPLOYMENT = :employment - PAYMENT = :payment - PAY_STATEMENT = :pay_statement - BENEFITS = :benefits - SSN = :ssn + COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + DIRECTORY = T.let(:directory, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + INDIVIDUAL = T.let(:individual, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + EMPLOYMENT = T.let(:employment, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + PAY_STATEMENT = T.let(:pay_statement, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + BENEFITS = T.let(:benefits, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) end class Integration < FinchAPI::BaseModel - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol)) } def auth_method end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol)) + end def auth_method=(_) end @@ -167,34 +178,54 @@ module FinchAPI end sig do - params(auth_method: T.nilable(Symbol), provider: T.nilable(String)).returns(T.attached_class) + params( + auth_method: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol), + provider: T.nilable(String) + ) + .returns(T.attached_class) end def self.new(auth_method: nil, provider: nil) end - sig { override.returns({auth_method: T.nilable(Symbol), provider: T.nilable(String)}) } + sig do + override + .returns( + { + auth_method: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol), + provider: T.nilable(String) + } + ) + end def to_hash end - class AuthMethod < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASSISTED = :assisted - CREDENTIAL = :credential - OAUTH = :oauth - API_TOKEN = :api_token + module AuthMethod + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) } + + ASSISTED = + T.let(:assisted, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) + CREDENTIAL = + T.let(:credential, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) + OAUTH = T.let(:oauth, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) + API_TOKEN = + T.let(:api_token, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) end end - class Sandbox < FinchAPI::Enum - abstract! + module Sandbox + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) } - FINCH = :finch - PROVIDER = :provider + FINCH = T.let(:finch, FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol) + PROVIDER = T.let(:provider, FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 86486f1f..83a64942 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -27,11 +27,14 @@ module FinchAPI end # The products to request access to (optional for reauthentication) - sig { returns(T.nilable(T::Array[Symbol])) } + sig { returns(T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol])) } def products end - sig { params(_: T.nilable(T::Array[Symbol])).returns(T.nilable(T::Array[Symbol])) } + sig do + params(_: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol])) + .returns(T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol])) + end def products=(_) end @@ -48,7 +51,7 @@ module FinchAPI params( connection_id: String, minutes_to_expire: T.nilable(Integer), - products: T.nilable(T::Array[Symbol]), + products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), redirect_uri: T.nilable(String), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) @@ -63,7 +66,7 @@ module FinchAPI { connection_id: String, minutes_to_expire: T.nilable(Integer), - products: T.nilable(T::Array[Symbol]), + products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), redirect_uri: T.nilable(String), request_options: FinchAPI::RequestOptions } @@ -73,19 +76,25 @@ module FinchAPI end # The Finch products that can be requested during the Connect flow. - class Product < FinchAPI::Enum - abstract! + module Product + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) } - COMPANY = :company - DIRECTORY = :directory - INDIVIDUAL = :individual - EMPLOYMENT = :employment - PAYMENT = :payment - PAY_STATEMENT = :pay_statement - BENEFITS = :benefits - SSN = :ssn + COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + DIRECTORY = T.let(:directory, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + INDIVIDUAL = + T.let(:individual, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + EMPLOYMENT = + T.let(:employment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + PAY_STATEMENT = + T.let(:pay_statement, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + BENEFITS = T.let(:benefits, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/connection_status_type.rbi b/rbi/lib/finch-api/models/connection_status_type.rbi index 61e4f310..c833b133 100644 --- a/rbi/lib/finch-api/models/connection_status_type.rbi +++ b/rbi/lib/finch-api/models/connection_status_type.rbi @@ -2,17 +2,18 @@ module FinchAPI module Models - class ConnectionStatusType < FinchAPI::Enum - abstract! + module ConnectionStatusType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::ConnectionStatusType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) } - PENDING = :pending - PROCESSING = :processing - CONNECTED = :connected - ERROR_NO_ACCOUNT_SETUP = :error_no_account_setup - ERROR_PERMISSIONS = :error_permissions - REAUTH = :reauth + PENDING = T.let(:pending, FinchAPI::Models::ConnectionStatusType::OrSymbol) + PROCESSING = T.let(:processing, FinchAPI::Models::ConnectionStatusType::OrSymbol) + CONNECTED = T.let(:connected, FinchAPI::Models::ConnectionStatusType::OrSymbol) + ERROR_NO_ACCOUNT_SETUP = T.let(:error_no_account_setup, FinchAPI::Models::ConnectionStatusType::OrSymbol) + ERROR_PERMISSIONS = T.let(:error_permissions, FinchAPI::Models::ConnectionStatusType::OrSymbol) + REAUTH = T.let(:reauth, FinchAPI::Models::ConnectionStatusType::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index ad572fc6..89db729e 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -23,11 +23,14 @@ module FinchAPI end # The type of application associated with a token. - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) } def client_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) + .returns(FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) + end def client_type=(_) end @@ -54,11 +57,14 @@ module FinchAPI # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) } def connection_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) + .returns(FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) + end def connection_type=(_) end @@ -103,10 +109,10 @@ module FinchAPI params( access_token: String, account_id: String, - client_type: Symbol, + client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol, company_id: String, connection_id: String, - connection_type: Symbol, + connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol, products: T::Array[String], provider_id: String, customer_id: T.nilable(String), @@ -134,10 +140,10 @@ module FinchAPI { access_token: String, account_id: String, - client_type: Symbol, + client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol, company_id: String, connection_id: String, - connection_type: Symbol, + connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol, products: T::Array[String], provider_id: String, customer_id: T.nilable(String), @@ -149,27 +155,32 @@ module FinchAPI end # The type of application associated with a token. - class ClientType < FinchAPI::Enum - abstract! + module ClientType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) } - PRODUCTION = :production - DEVELOPMENT = :development - SANDBOX = :sandbox + PRODUCTION = T.let(:production, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) + DEVELOPMENT = T.let(:development, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) + SANDBOX = T.let(:sandbox, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) end # The type of the connection associated with the token. # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - class ConnectionType < FinchAPI::Enum - abstract! + module ConnectionType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) } - PROVIDER = :provider - FINCH = :finch + PROVIDER = T.let(:provider, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) + FINCH = T.let(:finch, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index d5029718..5a664235 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -11,19 +11,36 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + end def event_type=(_) end - sig { params(data: FinchAPI::Models::DirectoryEvent::Data, event_type: Symbol).returns(T.attached_class) } + sig do + params( + data: FinchAPI::Models::DirectoryEvent::Data, + event_type: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: FinchAPI::Models::DirectoryEvent::Data, event_type: Symbol}) } + sig do + override + .returns( + { + data: FinchAPI::Models::DirectoryEvent::Data, + event_type: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol + } + ) + end def to_hash end @@ -46,14 +63,18 @@ module FinchAPI end end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::DirectoryEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) } - DIRECTORY_CREATED = :"directory.created" - DIRECTORY_UPDATED = :"directory.updated" - DIRECTORY_DELETED = :"directory.deleted" + DIRECTORY_CREATED = + T.let(:"directory.created", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + DIRECTORY_UPDATED = + T.let(:"directory.updated", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + DIRECTORY_DELETED = + T.let(:"directory.deleted", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index be60a3e9..9646e6f5 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -11,19 +11,36 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + end def event_type=(_) end - sig { params(data: FinchAPI::Models::EmploymentEvent::Data, event_type: Symbol).returns(T.attached_class) } + sig do + params( + data: FinchAPI::Models::EmploymentEvent::Data, + event_type: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: FinchAPI::Models::EmploymentEvent::Data, event_type: Symbol}) } + sig do + override + .returns( + { + data: FinchAPI::Models::EmploymentEvent::Data, + event_type: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol + } + ) + end def to_hash end @@ -46,14 +63,18 @@ module FinchAPI end end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::EmploymentEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) } - EMPLOYMENT_CREATED = :"employment.created" - EMPLOYMENT_UPDATED = :"employment.updated" - EMPLOYMENT_DELETED = :"employment.deleted" + EMPLOYMENT_CREATED = + T.let(:"employment.created", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + EMPLOYMENT_UPDATED = + T.let(:"employment.updated", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + EMPLOYMENT_DELETED = + T.let(:"employment.deleted", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index fd94c3c2..25cb978a 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -14,30 +14,46 @@ module FinchAPI end # Contribution type. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) + end def type=(_) end - sig { params(amount: T.nilable(Integer), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + amount: T.nilable(Integer), + type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(amount: nil, type: nil) end - sig { override.returns({amount: T.nilable(Integer), type: T.nilable(Symbol)}) } + sig do + override + .returns( + {amount: T.nilable(Integer), type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)} + ) + end def to_hash end # Contribution type. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) } - FIXED = :fixed - PERCENT = :percent + FIXED = T.let(:fixed, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) + PERCENT = T.let(:percent, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi index adbb1584..2b5a7c40 100644 --- a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi @@ -18,28 +18,34 @@ module FinchAPI def description=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) } def frequency end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) + end def frequency=(_) end # Type of benefit. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) + end def type=(_) end sig do params( description: String, - frequency: T.nilable(Symbol), - type: T.nilable(Symbol), + frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) .returns(T.attached_class) @@ -52,8 +58,8 @@ module FinchAPI .returns( { description: String, - frequency: T.nilable(Symbol), - type: T.nilable(Symbol), + frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), request_options: FinchAPI::RequestOptions } ) diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 7d4f9f33..013d9453 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -70,12 +70,39 @@ module FinchAPI # Supported contribution types. An empty array indicates contributions are not # supported. - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) + ] + ) + ) + end def company_contribution end sig do - params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)])) + params( + _: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) + ] + ) + ) + .returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) + ] + ) + ) end def company_contribution=(_) end @@ -90,33 +117,90 @@ module FinchAPI # Supported deduction types. An empty array indicates deductions are not # supported. - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) + ] + ) + ) + end def employee_deduction end sig do - params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)])) + params( + _: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) + ] + ) + ) + .returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) + ] + ) + ) end def employee_deduction=(_) end # The list of frequencies supported by the provider for this benefit - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)])) } def frequencies end - sig { params(_: T::Array[T.nilable(Symbol)]).returns(T::Array[T.nilable(Symbol)]) } + sig do + params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) + .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) + end def frequencies=(_) end # Whether the provider supports HSA contribution limits. Empty if this feature is # not supported for the benefit. This array only has values for HSA benefits. - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig do + returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) + ] + ) + ) + end def hsa_contribution_limit end sig do - params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)])) + params( + _: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) + ] + ) + ) + .returns( + T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) + ] + ) + ) end def hsa_contribution_limit=(_) end @@ -125,11 +209,29 @@ module FinchAPI params( annual_maximum: T.nilable(T::Boolean), catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable(T::Array[T.nilable(Symbol)]), + company_contribution: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) + ] + ), description: T.nilable(String), - employee_deduction: T.nilable(T::Array[T.nilable(Symbol)]), - frequencies: T::Array[T.nilable(Symbol)], - hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]) + employee_deduction: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) + ] + ), + frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], + hsa_contribution_limit: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) + ] + ) ) .returns(T.attached_class) end @@ -150,42 +252,112 @@ module FinchAPI { annual_maximum: T.nilable(T::Boolean), catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable(T::Array[T.nilable(Symbol)]), + company_contribution: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) + ] + ), description: T.nilable(String), - employee_deduction: T.nilable(T::Array[T.nilable(Symbol)]), - frequencies: T::Array[T.nilable(Symbol)], - hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]) + employee_deduction: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) + ] + ), + frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], + hsa_contribution_limit: T.nilable( + T::Array[ + T.nilable( + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) + ] + ) } ) end def to_hash end - class CompanyContribution < FinchAPI::Enum - abstract! + module CompanyContribution + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution) + end + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) + end - FIXED = :fixed - PERCENT = :percent + FIXED = + T.let( + :fixed, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) + PERCENT = + T.let( + :percent, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + ) end - class EmployeeDeduction < FinchAPI::Enum - abstract! + module EmployeeDeduction + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction) } + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) + end - FIXED = :fixed - PERCENT = :percent + FIXED = + T.let( + :fixed, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) + PERCENT = + T.let( + :percent, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + ) end - class HsaContributionLimit < FinchAPI::Enum - abstract! + module HsaContributionLimit + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit) + end + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) + end - INDIVIDUAL = :individual - FAMILY = :family + INDIVIDUAL = + T.let( + :individual, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) + FAMILY = + T.let( + :family, + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ) end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi index b99b72a6..d72a73e3 100644 --- a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi @@ -3,14 +3,15 @@ module FinchAPI module Models module HRIS - class BenefitFrequency < FinchAPI::Enum - abstract! + module BenefitFrequency + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitFrequency) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol) } - ONE_TIME = :one_time - EVERY_PAYCHECK = :every_paycheck - MONTHLY = :monthly + ONE_TIME = T.let(:one_time, FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol) + EVERY_PAYCHECK = T.let(:every_paycheck, FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol) + MONTHLY = T.let(:monthly, FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_type.rbi b/rbi/lib/finch-api/models/hris/benefit_type.rbi index d07eba9d..a78c504d 100644 --- a/rbi/lib/finch-api/models/hris/benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_type.rbi @@ -4,30 +4,31 @@ module FinchAPI module Models module HRIS # Type of benefit. - class BenefitType < FinchAPI::Enum - abstract! + module BenefitType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) } - NUMBER_401K = :"401k" - NUMBER_401K_ROTH = :"401k_roth" - NUMBER_401K_LOAN = :"401k_loan" - NUMBER_403B = :"403b" - NUMBER_403B_ROTH = :"403b_roth" - NUMBER_457 = :"457" - NUMBER_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 + NUMBER_401K = T.let(:"401k", FinchAPI::Models::HRIS::BenefitType::OrSymbol) + NUMBER_401K_ROTH = T.let(:"401k_roth", FinchAPI::Models::HRIS::BenefitType::OrSymbol) + NUMBER_401K_LOAN = T.let(:"401k_loan", FinchAPI::Models::HRIS::BenefitType::OrSymbol) + NUMBER_403B = T.let(:"403b", FinchAPI::Models::HRIS::BenefitType::OrSymbol) + NUMBER_403B_ROTH = T.let(:"403b_roth", FinchAPI::Models::HRIS::BenefitType::OrSymbol) + NUMBER_457 = T.let(:"457", FinchAPI::Models::HRIS::BenefitType::OrSymbol) + NUMBER_457_ROTH = T.let(:"457_roth", FinchAPI::Models::HRIS::BenefitType::OrSymbol) + S125_MEDICAL = T.let(:s125_medical, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + S125_DENTAL = T.let(:s125_dental, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + S125_VISION = T.let(:s125_vision, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + HSA_PRE = T.let(:hsa_pre, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + HSA_POST = T.let(:hsa_post, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + FSA_MEDICAL = T.let(:fsa_medical, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + FSA_DEPENDENT_CARE = T.let(:fsa_dependent_care, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + SIMPLE_IRA = T.let(:simple_ira, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + SIMPLE = T.let(:simple, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + COMMUTER = T.let(:commuter, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + CUSTOM_POST_TAX = T.let(:custom_post_tax, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + CUSTOM_PRE_TAX = T.let(:custom_pre_tax, FinchAPI::Models::HRIS::BenefitType::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index 286412d5..9063cdfe 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -17,11 +17,14 @@ module FinchAPI end # HTTP status code. Either 201 or 200 - sig { returns(T.nilable(Integer)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger)) } def code end - sig { params(_: Integer).returns(Integer) } + sig do + params(_: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) + .returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) + end def code=(_) end @@ -36,7 +39,7 @@ module FinchAPI sig do params( body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, - code: Integer, + code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger, individual_id: String ) .returns(T.attached_class) @@ -47,7 +50,11 @@ module FinchAPI sig do override .returns( - {body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, code: Integer, individual_id: String} + { + body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, + code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger, + individual_id: String + } ) end def to_hash @@ -102,15 +109,18 @@ module FinchAPI end # HTTP status code. Either 201 or 200 - class Code < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Integer} } - - OK = 200 - CREATED = 201 - NOT_FOUND = 404 - FORBIDDEN = 403 + module Code + extend FinchAPI::Enum + + TaggedInteger = + T.type_alias { T.all(Integer, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code) } + OrInteger = + T.type_alias { T.any(Integer, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) } + + OK = T.let(200, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) + CREATED = T.let(201, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) + NOT_FOUND = T.let(404, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) + FORBIDDEN = T.let(403, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index 5750f265..c375fca4 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -95,11 +95,22 @@ module FinchAPI end # Type for HSA contribution limit if the benefit is a HSA. - sig { returns(T.nilable(Symbol)) } + sig do + returns( + T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) + ) + end def hsa_contribution_limit end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params( + _: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) + ) + .returns( + T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) + ) + end def hsa_contribution_limit=(_) end @@ -109,7 +120,7 @@ module FinchAPI catch_up: T.nilable(T::Boolean), company_contribution: T.nilable(FinchAPI::Models::HRIS::BenefitContribution), employee_deduction: T.nilable(FinchAPI::Models::HRIS::BenefitContribution), - hsa_contribution_limit: T.nilable(Symbol) + hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) ) .returns(T.attached_class) end @@ -130,7 +141,7 @@ module FinchAPI catch_up: T.nilable(T::Boolean), company_contribution: T.nilable(FinchAPI::Models::HRIS::BenefitContribution), employee_deduction: T.nilable(FinchAPI::Models::HRIS::BenefitContribution), - hsa_contribution_limit: T.nilable(Symbol) + hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) } ) end @@ -138,13 +149,29 @@ module FinchAPI end # Type for HSA contribution limit if the benefit is a HSA. - class HsaContributionLimit < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - INDIVIDUAL = :individual - FAMILY = :family + module HsaContributionLimit + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit) } + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + ) + end + + INDIVIDUAL = + T.let( + :individual, + FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + ) + FAMILY = + T.let( + :family, + FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol + ) end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index c191d936..5e8cbcd3 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -92,11 +92,24 @@ module FinchAPI class Configuration < FinchAPI::BaseModel # For HSA benefits only - whether the contribution limit is for an individual or # family - sig { returns(T.nilable(Symbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + ) + ) + end def annual_contribution_limit end - sig { params(_: Symbol).returns(Symbol) } + sig do + params( + _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + ) + .returns( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + ) + end def annual_contribution_limit=(_) end @@ -162,7 +175,7 @@ module FinchAPI sig do params( - annual_contribution_limit: Symbol, + annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol, annual_maximum: T.nilable(Integer), catch_up: T::Boolean, company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, @@ -183,7 +196,7 @@ module FinchAPI override .returns( { - annual_contribution_limit: Symbol, + annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol, annual_maximum: T.nilable(Integer), catch_up: T::Boolean, company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, @@ -196,13 +209,31 @@ module FinchAPI # For HSA benefits only - whether the contribution limit is for an individual or # family - class AnnualContributionLimit < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - INDIVIDUAL = :individual - FAMILY = :family + module AnnualContributionLimit + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit) + end + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol + ) + end + + INDIVIDUAL = + T.let( + :individual, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + ) + FAMILY = + T.let( + :family, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + ) end class CompanyContribution < FinchAPI::BaseModel @@ -216,29 +247,74 @@ module FinchAPI def amount=(_) end - sig { returns(T.nilable(Symbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ) + ) + end def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params( + _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ) + .returns( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ) + end def type=(_) end - sig { params(amount: Integer, type: Symbol).returns(T.attached_class) } + sig do + params( + amount: Integer, + type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ) + .returns(T.attached_class) + end def self.new(amount: nil, type: nil) end - sig { override.returns({amount: Integer, type: Symbol}) } + sig do + override + .returns( + { + amount: Integer, + type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + } + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - FIXED = :fixed - PERCENT = :percent + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type) + end + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol + ) + end + + FIXED = + T.let( + :fixed, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ) + PERCENT = + T.let( + :percent, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + ) end end @@ -253,29 +329,74 @@ module FinchAPI def amount=(_) end - sig { returns(T.nilable(Symbol)) } + sig do + returns( + T.nilable( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ) + ) + end def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params( + _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ) + .returns( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ) + end def type=(_) end - sig { params(amount: Integer, type: Symbol).returns(T.attached_class) } + sig do + params( + amount: Integer, + type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ) + .returns(T.attached_class) + end def self.new(amount: nil, type: nil) end - sig { override.returns({amount: Integer, type: Symbol}) } + sig do + override + .returns( + { + amount: Integer, + type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + } + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - FIXED = :fixed - PERCENT = :percent + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type) + end + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol + ) + end + + FIXED = + T.let( + :fixed, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ) + PERCENT = + T.let( + :percent, + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + ) end end end diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index a2296983..82dafdac 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -162,11 +162,14 @@ module FinchAPI end # The type of bank account. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) } def account_type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) + end def account_type=(_) end @@ -193,7 +196,7 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(Symbol), + account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) ) @@ -208,7 +211,7 @@ module FinchAPI { account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(Symbol), + account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) } @@ -218,13 +221,15 @@ module FinchAPI end # The type of bank account. - class AccountType < FinchAPI::Enum - abstract! + module AccountType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) } - CHECKING = :checking - SAVINGS = :savings + CHECKING = T.let(:checking, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) + SAVINGS = T.let(:savings, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) end end @@ -292,56 +297,81 @@ module FinchAPI class Entity < FinchAPI::BaseModel # The tax payer subtype of the company. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) } def subtype end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) + end def subtype=(_) end # The tax payer type of the company. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) + end def type=(_) end # The entity type object. - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(subtype: nil, type: nil) end - sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + } + ) + end def to_hash end # The tax payer subtype of the company. - class Subtype < FinchAPI::Enum - abstract! + module Subtype + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) } - S_CORPORATION = :s_corporation - C_CORPORATION = :c_corporation - B_CORPORATION = :b_corporation + S_CORPORATION = T.let(:s_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) + C_CORPORATION = T.let(:c_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) + B_CORPORATION = T.let(:b_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) end # The tax payer type of the company. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - LLC = :llc - LP = :lp - CORPORATION = :corporation - SOLE_PROPRIETOR = :sole_proprietor - NON_PROFIT = :non_profit - PARTNERSHIP = :partnership - COOPERATIVE = :cooperative + module Type + extend FinchAPI::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) } + + LLC = T.let(:llc, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + LP = T.let(:lp, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + CORPORATION = T.let(:corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + SOLE_PROPRIETOR = + T.let(:sole_proprietor, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + NON_PROFIT = T.let(:non_profit, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + PARTNERSHIP = T.let(:partnership, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + COOPERATIVE = T.let(:cooperative, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/company_benefit.rbi b/rbi/lib/finch-api/models/hris/company_benefit.rbi index ae2345b9..ec7b6428 100644 --- a/rbi/lib/finch-api/models/hris/company_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/company_benefit.rbi @@ -20,20 +20,26 @@ module FinchAPI def description=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) } def frequency end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) + end def frequency=(_) end # Type of benefit. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + end def type=(_) end @@ -41,8 +47,8 @@ module FinchAPI params( benefit_id: String, description: T.nilable(String), - frequency: T.nilable(Symbol), - type: T.nilable(Symbol) + frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) ) .returns(T.attached_class) end @@ -55,8 +61,8 @@ module FinchAPI { benefit_id: String, description: T.nilable(String), - frequency: T.nilable(Symbol), - type: T.nilable(Symbol) + frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) } ) end diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index fbc736cc..a86db188 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -37,11 +37,14 @@ module FinchAPI # Comma-delimited list of document types to filter on. If empty, defaults to all # types - sig { returns(T.nilable(T::Array[Symbol])) } + sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol])) } def types end - sig { params(_: T::Array[Symbol]).returns(T::Array[Symbol]) } + sig do + params(_: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol]) + .returns(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol]) + end def types=(_) end @@ -50,7 +53,7 @@ module FinchAPI individual_ids: T::Array[String], limit: Integer, offset: Integer, - types: T::Array[Symbol], + types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) .returns(T.attached_class) @@ -65,7 +68,7 @@ module FinchAPI individual_ids: T::Array[String], limit: Integer, offset: Integer, - types: T::Array[Symbol], + types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], request_options: FinchAPI::RequestOptions } ) @@ -73,13 +76,14 @@ module FinchAPI def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) } - W4_2020 = :w4_2020 - W4_2005 = :w4_2005 + W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol) + W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index 23034dfa..67ae6fe8 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -24,11 +24,14 @@ module FinchAPI end # The type of document. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol)) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) + .returns(FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) + end def type=(_) end @@ -55,7 +58,7 @@ module FinchAPI params( id: String, individual_id: T.nilable(String), - type: Symbol, + type: FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol, url: String, year: T.nilable(Float) ) @@ -66,25 +69,28 @@ module FinchAPI sig do override - .returns({ - id: String, - individual_id: T.nilable(String), - type: Symbol, - url: String, - year: T.nilable(Float) - }) + .returns( + { + id: String, + individual_id: T.nilable(String), + type: FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol, + url: String, + year: T.nilable(Float) + } + ) end def to_hash end # The type of document. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) } - W4_2020 = :w4_2020 - W4_2005 = :w4_2005 + W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) + W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index 9335209d..2b79a510 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -5,8 +5,8 @@ module FinchAPI module HRIS # A 2020 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. - class DocumentRetreiveResponse < FinchAPI::Union - abstract! + module DocumentRetreiveResponse + extend FinchAPI::Union Variants = type_template(:out) { {fixed: T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)} } diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index 13e1fe84..22cc9398 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -61,11 +61,14 @@ module FinchAPI # The detailed employment status of the individual. Available options: `active`, # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol)) } def employment_status end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol)) + end def employment_status=(_) end @@ -206,7 +209,7 @@ module FinchAPI custom_fields: T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]), department: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department), employment: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(FinchAPI::Models::Income), @@ -257,7 +260,7 @@ module FinchAPI custom_fields: T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]), department: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department), employment: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(FinchAPI::Models::Income), @@ -327,72 +330,100 @@ module FinchAPI class Employment < FinchAPI::BaseModel # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol)) } def subtype end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol)) + end def subtype=(_) end # The main employment type of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol)) + end def type=(_) end # The employment object. - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + subtype: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(subtype: nil, type: nil) end - sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + subtype: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) + } + ) + end def to_hash end # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - FULL_TIME = :full_time - INTERN = :intern - PART_TIME = :part_time - TEMP = :temp - SEASONAL = :seasonal - INDIVIDUAL_CONTRACTOR = :individual_contractor + module Subtype + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) } + + FULL_TIME = T.let(:full_time, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) + INTERN = T.let(:intern, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) + PART_TIME = T.let(:part_time, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) + TEMP = T.let(:temp, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) + SEASONAL = T.let(:seasonal, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) + INDIVIDUAL_CONTRACTOR = + T.let(:individual_contractor, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) end # The main employment type of the individual. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) } - EMPLOYEE = :employee - CONTRACTOR = :contractor + EMPLOYEE = T.let(:employee, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) + CONTRACTOR = T.let(:contractor, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) end end # The detailed employment status of the individual. Available options: `active`, # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. - class EmploymentStatus < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ACTIVE = :active - DECEASED = :deceased - LEAVE = :leave - ONBOARDING = :onboarding - PREHIRE = :prehire - RETIRED = :retired - TERMINATED = :terminated + module EmploymentStatus + extend FinchAPI::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) } + + ACTIVE = T.let(:active, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) + DECEASED = T.let(:deceased, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) + LEAVE = T.let(:leave, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) + ONBOARDING = T.let(:onboarding, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) + PREHIRE = T.let(:prehire, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) + RETIRED = T.let(:retired, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) + TERMINATED = T.let(:terminated, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index 8a1577d9..1689ae8c 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -44,11 +44,14 @@ module FinchAPI end # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol)) } def ethnicity end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol)) + end def ethnicity=(_) end @@ -62,11 +65,14 @@ module FinchAPI end # The gender of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol)) } def gender end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol)) + end def gender=(_) end @@ -134,9 +140,9 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::Email]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber)]), @@ -171,9 +177,9 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::Email]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber)]), @@ -195,58 +201,76 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) + end def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params(data: String, type: T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: String, type: T.nilable(Symbol)}) } + sig do + override + .returns({data: String, type: T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)}) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::Email::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol) + PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol) end end # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASIAN = :asian - WHITE = :white - BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander - AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native - HISPANIC_OR_LATINO = :hispanic_or_latino - TWO_OR_MORE_RACES = :two_or_more_races - DECLINE_TO_SPECIFY = :decline_to_specify + module Ethnicity + extend FinchAPI::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::Ethnicity) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) } + + ASIAN = T.let(:asian, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + WHITE = T.let(:white, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + BLACK_OR_AFRICAN_AMERICAN = + T.let(:black_or_african_american, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = + T.let(:native_hawaiian_or_pacific_islander, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + AMERICAN_INDIAN_OR_ALASKA_NATIVE = + T.let(:american_indian_or_alaska_native, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + HISPANIC_OR_LATINO = + T.let(:hispanic_or_latino, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + TWO_OR_MORE_RACES = + T.let(:two_or_more_races, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + DECLINE_TO_SPECIFY = + T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) end # The gender of the individual. - class Gender < FinchAPI::Enum - abstract! + module Gender + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::Gender) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) } - FEMALE = :female - MALE = :male - OTHER = :other - DECLINE_TO_SPECIFY = :decline_to_specify + FEMALE = T.let(:female, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) + MALE = T.let(:male, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) + DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) end class PhoneNumber < FinchAPI::BaseModel @@ -258,29 +282,48 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol)) + end def type=(_) end - sig { params(data: T.nilable(String), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + data: T.nilable(String), + type: T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: T.nilable(String), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + data: T.nilable(String), + type: T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) + } + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) + PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 44308358..41c606b3 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -65,11 +65,14 @@ module FinchAPI end # The payment method. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) } def payment_method end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) + end def payment_method=(_) end @@ -95,11 +98,14 @@ module FinchAPI end # The type of the payment associated with the pay statement. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) + end def type=(_) end @@ -111,10 +117,10 @@ module FinchAPI gross_pay: T.nilable(FinchAPI::Models::Money), individual_id: String, net_pay: T.nilable(FinchAPI::Models::Money), - payment_method: T.nilable(Symbol), + payment_method: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol), taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]), total_hours: T.nilable(Float), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) ) .returns(T.attached_class) end @@ -142,10 +148,10 @@ module FinchAPI gross_pay: T.nilable(FinchAPI::Models::Money), individual_id: String, net_pay: T.nilable(FinchAPI::Models::Money), - payment_method: T.nilable(Symbol), + payment_method: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol), taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]), total_hours: T.nilable(Float), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) } ) end @@ -202,11 +208,14 @@ module FinchAPI end # The type of earning. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) + end def type=(_) end @@ -217,7 +226,7 @@ module FinchAPI currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) ) .returns(T.attached_class) end @@ -233,7 +242,7 @@ module FinchAPI currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) } ) end @@ -286,24 +295,27 @@ module FinchAPI end # The type of earning. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - SALARY = :salary - WAGE = :wage - REIMBURSEMENT = :reimbursement - OVERTIME = :overtime - SEVERANCE = :severance - DOUBLE_OVERTIME = :double_overtime - PTO = :pto - SICK = :sick - BONUS = :bonus - COMMISSION = :commission - TIPS = :tips - NUMBER_1099 = :"1099" - OTHER = :other + module Type + extend FinchAPI::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) } + + SALARY = T.let(:salary, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + WAGE = T.let(:wage, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + REIMBURSEMENT = T.let(:reimbursement, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + OVERTIME = T.let(:overtime, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + SEVERANCE = T.let(:severance, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + DOUBLE_OVERTIME = + T.let(:double_overtime, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + PTO = T.let(:pto, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + SICK = T.let(:sick, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + BONUS = T.let(:bonus, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + COMMISSION = T.let(:commission, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + TIPS = T.let(:tips, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + NUMBER_1099 = T.let(:"1099", FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) end end @@ -356,11 +368,14 @@ module FinchAPI end # Type of benefit. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + end def type=(_) end @@ -371,7 +386,7 @@ module FinchAPI currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) ) .returns(T.attached_class) end @@ -387,7 +402,7 @@ module FinchAPI currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) } ) end @@ -482,11 +497,14 @@ module FinchAPI end # Type of benefit. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + end def type=(_) end @@ -496,7 +514,7 @@ module FinchAPI attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes), currency: T.nilable(String), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) ) .returns(T.attached_class) end @@ -511,7 +529,7 @@ module FinchAPI attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes), currency: T.nilable(String), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) } ) end @@ -568,13 +586,16 @@ module FinchAPI end # The payment method. - class PaymentMethod < FinchAPI::Enum - abstract! + module PaymentMethod + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) } - CHECK = :check - DIRECT_DEPOSIT = :direct_deposit + CHECK = T.let(:check, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) + DIRECT_DEPOSIT = + T.let(:direct_deposit, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) end class Tax < FinchAPI::BaseModel @@ -626,11 +647,14 @@ module FinchAPI end # The type of taxes. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) + end def type=(_) end @@ -641,7 +665,7 @@ module FinchAPI currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) ) .returns(T.attached_class) end @@ -657,7 +681,7 @@ module FinchAPI currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) } ) end @@ -709,27 +733,29 @@ module FinchAPI end # The type of taxes. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) } - STATE = :state - FEDERAL = :federal - LOCAL = :local - FICA = :fica + STATE = T.let(:state, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) + FEDERAL = T.let(:federal, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) + LOCAL = T.let(:local, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) + FICA = T.let(:fica, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) end end # The type of the payment associated with the pay statement. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::PayStatement::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) } - REGULAR_PAYROLL = :regular_payroll - OFF_CYCLE_PAYROLL = :off_cycle_payroll - ONE_TIME_PAYMENT = :one_time_payment + REGULAR_PAYROLL = T.let(:regular_payroll, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) + OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) + ONE_TIME_PAYMENT = T.let(:one_time_payment, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 3c4ff9de..13095552 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -79,11 +79,14 @@ module FinchAPI end # List of pay frequencies associated with this payment. - sig { returns(T.nilable(T::Array[Symbol])) } + sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol])) } def pay_frequencies end - sig { params(_: T.nilable(T::Array[Symbol])).returns(T.nilable(T::Array[Symbol])) } + sig do + params(_: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol])) + .returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol])) + end def pay_frequencies=(_) end @@ -119,7 +122,7 @@ module FinchAPI individual_ids: T.nilable(T::Array[String]), net_pay: T.nilable(FinchAPI::Models::Money), pay_date: T.nilable(String), - pay_frequencies: T.nilable(T::Array[Symbol]), + pay_frequencies: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]), pay_group_ids: T.nilable(T::Array[String]), pay_period: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod) ) @@ -154,7 +157,7 @@ module FinchAPI individual_ids: T.nilable(T::Array[String]), net_pay: T.nilable(FinchAPI::Models::Money), pay_date: T.nilable(String), - pay_frequencies: T.nilable(T::Array[Symbol]), + pay_frequencies: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]), pay_group_ids: T.nilable(T::Array[String]), pay_period: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod) } @@ -163,20 +166,21 @@ module FinchAPI def to_hash end - class PayFrequency < FinchAPI::Enum - abstract! + module PayFrequency + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) } - ANNUALLY = :annually - SEMI_ANNUALLY = :semi_annually - QUARTERLY = :quarterly - MONTHLY = :monthly - SEMI_MONTHLY = :semi_monthly - BI_WEEKLY = :bi_weekly - WEEKLY = :weekly - DAILY = :daily - OTHER = :other + ANNUALLY = T.let(:annually, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + SEMI_ANNUALLY = T.let(:semi_annually, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + QUARTERLY = T.let(:quarterly, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + MONTHLY = T.let(:monthly, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + SEMI_MONTHLY = T.let(:semi_monthly, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + BI_WEEKLY = T.let(:bi_weekly, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + WEEKLY = T.let(:weekly, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + DAILY = T.let(:daily, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) end class PayPeriod < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index 175f700a..2bd3a760 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -25,12 +25,27 @@ module FinchAPI # Supported contribution types. An empty array indicates contributions are not # supported. - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig do + returns( + T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] + ) + ) + end def company_contribution end sig do - params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)])) + params( + _: T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] + ) + ) + .returns( + T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] + ) + ) end def company_contribution=(_) end @@ -45,43 +60,73 @@ module FinchAPI # Supported deduction types. An empty array indicates deductions are not # supported. - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig do + returns( + T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]) + ) + end def employee_deduction end sig do - params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)])) + params( + _: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]) + ) + .returns( + T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]) + ) end def employee_deduction=(_) end # The list of frequencies supported by the provider for this benefit - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)])) } def frequencies end - sig { params(_: T::Array[T.nilable(Symbol)]).returns(T::Array[T.nilable(Symbol)]) } + sig do + params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) + .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) + end def frequencies=(_) end # Whether the provider supports HSA contribution limits. Empty if this feature is # not supported for the benefit. This array only has values for HSA benefits. - sig { returns(T.nilable(T::Array[T.nilable(Symbol)])) } + sig do + returns( + T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] + ) + ) + end def hsa_contribution_limit end sig do - params(_: T.nilable(T::Array[T.nilable(Symbol)])).returns(T.nilable(T::Array[T.nilable(Symbol)])) + params( + _: T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] + ) + ) + .returns( + T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] + ) + ) end def hsa_contribution_limit=(_) end # Type of benefit. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) + end def type=(_) end @@ -89,12 +134,16 @@ module FinchAPI params( annual_maximum: T.nilable(T::Boolean), catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable(T::Array[T.nilable(Symbol)]), + company_contribution: T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] + ), description: T.nilable(String), - employee_deduction: T.nilable(T::Array[T.nilable(Symbol)]), - frequencies: T::Array[T.nilable(Symbol)], - hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]), - type: T.nilable(Symbol) + employee_deduction: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]), + frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], + hsa_contribution_limit: T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] + ), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) ) .returns(T.attached_class) end @@ -116,43 +165,57 @@ module FinchAPI { annual_maximum: T.nilable(T::Boolean), catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable(T::Array[T.nilable(Symbol)]), + company_contribution: T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] + ), description: T.nilable(String), - employee_deduction: T.nilable(T::Array[T.nilable(Symbol)]), - frequencies: T::Array[T.nilable(Symbol)], - hsa_contribution_limit: T.nilable(T::Array[T.nilable(Symbol)]), - type: T.nilable(Symbol) + employee_deduction: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]), + frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], + hsa_contribution_limit: T.nilable( + T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] + ), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) } ) end def to_hash end - class CompanyContribution < FinchAPI::Enum - abstract! + module CompanyContribution + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) } - FIXED = :fixed - PERCENT = :percent + FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) + PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) end - class EmployeeDeduction < FinchAPI::Enum - abstract! + module EmployeeDeduction + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) } - FIXED = :fixed - PERCENT = :percent + FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) + PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) end - class HsaContributionLimit < FinchAPI::Enum - abstract! + module HsaContributionLimit + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) } - INDIVIDUAL = :individual - FAMILY = :family + INDIVIDUAL = + T.let(:individual, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) + FAMILY = T.let(:family, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 875e22f0..1ccc25bc 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -14,11 +14,14 @@ module FinchAPI end # Specifies the form type, indicating that this document is a 2005 W4 form. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol)) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) + .returns(FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) + end def type=(_) end @@ -34,13 +37,26 @@ module FinchAPI # A 2005 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. sig do - params(data: FinchAPI::Models::HRIS::W42005::Data, type: Symbol, year: T.nilable(Float)) + params( + data: FinchAPI::Models::HRIS::W42005::Data, + type: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol, + year: T.nilable(Float) + ) .returns(T.attached_class) end def self.new(data: nil, type: nil, year: nil) end - sig { override.returns({data: FinchAPI::Models::HRIS::W42005::Data, type: Symbol, year: T.nilable(Float)}) } + sig do + override + .returns( + { + data: FinchAPI::Models::HRIS::W42005::Data, + type: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol, + year: T.nilable(Float) + } + ) + end def to_hash end @@ -55,20 +71,26 @@ module FinchAPI end # Indicates exemption status from federal tax withholding. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol)) } def exemption end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) + .returns(FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) + end def exemption=(_) end # The individual's filing status for tax purposes. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol)) } def filing_status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) + .returns(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) + end def filing_status=(_) end @@ -94,8 +116,8 @@ module FinchAPI sig do params( additional_withholding: T.nilable(Integer), - exemption: Symbol, - filing_status: Symbol, + exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol, + filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol, individual_id: String, total_number_of_allowances: T.nilable(Integer) ) @@ -115,8 +137,8 @@ module FinchAPI .returns( { additional_withholding: T.nilable(Integer), - exemption: Symbol, - filing_status: Symbol, + exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol, + filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol, individual_id: String, total_number_of_allowances: T.nilable(Integer) } @@ -126,34 +148,42 @@ module FinchAPI end # Indicates exemption status from federal tax withholding. - class Exemption < FinchAPI::Enum - abstract! + module Exemption + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) } - EXEMPT = :exempt - NON_EXEMPT = :non_exempt + EXEMPT = T.let(:exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) + NON_EXEMPT = T.let(:non_exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) end # The individual's filing status for tax purposes. - class FilingStatus < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - MARRIED = :married - MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate - SINGLE = :single + module FilingStatus + extend FinchAPI::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) } + + MARRIED = T.let(:married, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) + MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = + T.let( + :married_but_withhold_at_higher_single_rate, + FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol + ) + SINGLE = T.let(:single, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) end end # Specifies the form type, indicating that this document is a 2005 W4 form. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42005::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) } - W4_2005 = :w4_2005 + W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 24bc47a8..859c9260 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -14,11 +14,14 @@ module FinchAPI end # Specifies the form type, indicating that this document is a 2020 W4 form. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol)) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) + .returns(FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) + end def type=(_) end @@ -34,13 +37,26 @@ module FinchAPI # A 2020 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. sig do - params(data: FinchAPI::Models::HRIS::W42020::Data, type: Symbol, year: T.nilable(Float)) + params( + data: FinchAPI::Models::HRIS::W42020::Data, + type: FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol, + year: T.nilable(Float) + ) .returns(T.attached_class) end def self.new(data: nil, type: nil, year: nil) end - sig { override.returns({data: FinchAPI::Models::HRIS::W42020::Data, type: Symbol, year: T.nilable(Float)}) } + sig do + override + .returns( + { + data: FinchAPI::Models::HRIS::W42020::Data, + type: FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol, + year: T.nilable(Float) + } + ) + end def to_hash end @@ -83,11 +99,14 @@ module FinchAPI end # The individual's filing status for tax purposes. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol)) } def filing_status end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol)) + end def filing_status=(_) end @@ -125,7 +144,7 @@ module FinchAPI amount_for_qualifying_children_under_17: T.nilable(Integer), deductions: T.nilable(Integer), extra_withholding: T.nilable(Integer), - filing_status: T.nilable(Symbol), + filing_status: T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol), individual_id: String, other_income: T.nilable(Integer), total_claim_dependent_and_other_credits: T.nilable(Integer) @@ -152,7 +171,7 @@ module FinchAPI amount_for_qualifying_children_under_17: T.nilable(Integer), deductions: T.nilable(Integer), extra_withholding: T.nilable(Integer), - filing_status: T.nilable(Symbol), + filing_status: T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol), individual_id: String, other_income: T.nilable(Integer), total_claim_dependent_and_other_credits: T.nilable(Integer) @@ -163,25 +182,36 @@ module FinchAPI end # The individual's filing status for tax purposes. - class FilingStatus < FinchAPI::Enum - abstract! + module FilingStatus + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol) } - HEAD_OF_HOUSEHOLD = :head_of_household + HEAD_OF_HOUSEHOLD = + T.let(:head_of_household, FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol) MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = - :married_filing_jointly_or_qualifying_surviving_spouse - SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately + T.let( + :married_filing_jointly_or_qualifying_surviving_spouse, + FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol + ) + SINGLE_OR_MARRIED_FILING_SEPARATELY = + T.let( + :single_or_married_filing_separately, + FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol + ) end end # Specifies the form type, indicating that this document is a 2020 W4 form. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::W42020::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) } - W4_2020 = :w4_2020 + W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index 6adb36b2..e51ab961 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -32,11 +32,14 @@ module FinchAPI # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Income::Unit::OrSymbol)) } def unit end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Income::Unit::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Income::Unit::OrSymbol)) + end def unit=(_) end @@ -48,7 +51,7 @@ module FinchAPI amount: T.nilable(Integer), currency: T.nilable(String), effective_date: T.nilable(String), - unit: T.nilable(Symbol) + unit: T.nilable(FinchAPI::Models::Income::Unit::OrSymbol) ) .returns(T.attached_class) end @@ -62,7 +65,7 @@ module FinchAPI amount: T.nilable(Integer), currency: T.nilable(String), effective_date: T.nilable(String), - unit: T.nilable(Symbol) + unit: T.nilable(FinchAPI::Models::Income::Unit::OrSymbol) } ) end @@ -71,20 +74,21 @@ module FinchAPI # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. - class Unit < FinchAPI::Enum - abstract! + module Unit + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Income::Unit) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Income::Unit::TaggedSymbol) } - YEARLY = :yearly - QUARTERLY = :quarterly - MONTHLY = :monthly - SEMI_MONTHLY = :semi_monthly - BI_WEEKLY = :bi_weekly - WEEKLY = :weekly - DAILY = :daily - HOURLY = :hourly - FIXED = :fixed + YEARLY = T.let(:yearly, FinchAPI::Models::Income::Unit::OrSymbol) + QUARTERLY = T.let(:quarterly, FinchAPI::Models::Income::Unit::OrSymbol) + MONTHLY = T.let(:monthly, FinchAPI::Models::Income::Unit::OrSymbol) + SEMI_MONTHLY = T.let(:semi_monthly, FinchAPI::Models::Income::Unit::OrSymbol) + BI_WEEKLY = T.let(:bi_weekly, FinchAPI::Models::Income::Unit::OrSymbol) + WEEKLY = T.let(:weekly, FinchAPI::Models::Income::Unit::OrSymbol) + DAILY = T.let(:daily, FinchAPI::Models::Income::Unit::OrSymbol) + HOURLY = T.let(:hourly, FinchAPI::Models::Income::Unit::OrSymbol) + FIXED = T.let(:fixed, FinchAPI::Models::Income::Unit::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 44b8c05e..583c7b82 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -11,19 +11,36 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + end def event_type=(_) end - sig { params(data: FinchAPI::Models::IndividualEvent::Data, event_type: Symbol).returns(T.attached_class) } + sig do + params( + data: FinchAPI::Models::IndividualEvent::Data, + event_type: FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: FinchAPI::Models::IndividualEvent::Data, event_type: Symbol}) } + sig do + override + .returns( + { + data: FinchAPI::Models::IndividualEvent::Data, + event_type: FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol + } + ) + end def to_hash end @@ -46,14 +63,18 @@ module FinchAPI end end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::IndividualEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) } - INDIVIDUAL_CREATED = :"individual.created" - INDIVIDUAL_UPDATED = :"individual.updated" - INDIVIDUAL_DELETED = :"individual.deleted" + INDIVIDUAL_CREATED = + T.let(:"individual.created", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + INDIVIDUAL_UPDATED = + T.let(:"individual.updated", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + INDIVIDUAL_DELETED = + T.let(:"individual.deleted", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index 4af48c1c..797339fa 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -34,11 +34,14 @@ module FinchAPI end # The type of application associated with a token. - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Introspection::ClientType::TaggedSymbol) } def client_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Introspection::ClientType::TaggedSymbol) + .returns(FinchAPI::Models::Introspection::ClientType::TaggedSymbol) + end def client_type=(_) end @@ -76,11 +79,14 @@ module FinchAPI # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) } def connection_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) + .returns(FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) + end def connection_type=(_) end @@ -167,11 +173,11 @@ module FinchAPI account_id: String, authentication_methods: T::Array[FinchAPI::Models::Introspection::AuthenticationMethod], client_id: String, - client_type: Symbol, + client_type: FinchAPI::Models::Introspection::ClientType::TaggedSymbol, company_id: String, connection_id: String, connection_status: FinchAPI::Models::Introspection::ConnectionStatus, - connection_type: Symbol, + connection_type: FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol, customer_email: T.nilable(String), customer_id: T.nilable(String), customer_name: T.nilable(String), @@ -210,11 +216,11 @@ module FinchAPI account_id: String, authentication_methods: T::Array[FinchAPI::Models::Introspection::AuthenticationMethod], client_id: String, - client_type: Symbol, + client_type: FinchAPI::Models::Introspection::ClientType::TaggedSymbol, company_id: String, connection_id: String, connection_status: FinchAPI::Models::Introspection::ConnectionStatus, - connection_type: Symbol, + connection_type: FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol, customer_email: T.nilable(String), customer_id: T.nilable(String), customer_name: T.nilable(String), @@ -251,11 +257,14 @@ module FinchAPI end # The type of authentication method. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol)) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + .returns(FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + end def type=(_) end @@ -263,7 +272,7 @@ module FinchAPI params( connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, products: T::Array[String], - type: Symbol + type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol ) .returns(T.attached_class) end @@ -276,7 +285,7 @@ module FinchAPI { connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, products: T::Array[String], - type: Symbol + type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol } ) end @@ -292,46 +301,58 @@ module FinchAPI def message=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::TaggedSymbol)) } def status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + .returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + end def status=(_) end - sig { params(message: String, status: Symbol).returns(T.attached_class) } + sig do + params(message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + .returns(T.attached_class) + end def self.new(message: nil, status: nil) end - sig { override.returns({message: String, status: Symbol}) } + sig { override.returns({message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol}) } def to_hash end end # The type of authentication method. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASSISTED = :assisted - CREDENTIAL = :credential - API_TOKEN = :api_token - API_CREDENTIAL = :api_credential - OAUTH = :oauth + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) } + + ASSISTED = T.let(:assisted, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + CREDENTIAL = + T.let(:credential, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + API_TOKEN = T.let(:api_token, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + API_CREDENTIAL = + T.let(:api_credential, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + OAUTH = T.let(:oauth, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) end end # The type of application associated with a token. - class ClientType < FinchAPI::Enum - abstract! + module ClientType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Introspection::ClientType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) } - PRODUCTION = :production - DEVELOPMENT = :development - SANDBOX = :sandbox + PRODUCTION = T.let(:production, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) + DEVELOPMENT = T.let(:development, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) + SANDBOX = T.let(:sandbox, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) end class ConnectionStatus < FinchAPI::BaseModel @@ -343,19 +364,25 @@ module FinchAPI def message=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::TaggedSymbol)) } def status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + .returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + end def status=(_) end - sig { params(message: String, status: Symbol).returns(T.attached_class) } + sig do + params(message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + .returns(T.attached_class) + end def self.new(message: nil, status: nil) end - sig { override.returns({message: String, status: Symbol}) } + sig { override.returns({message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol}) } def to_hash end end @@ -364,13 +391,14 @@ module FinchAPI # # - `provider` - connection to an external provider # - `finch` - finch-generated data. - class ConnectionType < FinchAPI::Enum - abstract! + module ConnectionType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Introspection::ConnectionType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) } - PROVIDER = :provider - FINCH = :finch + PROVIDER = T.let(:provider, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) + FINCH = T.let(:finch, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index 1b3faa8f..ea5d5740 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -11,19 +11,36 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + end def event_type=(_) end - sig { params(data: FinchAPI::Models::JobCompletionEvent::Data, event_type: Symbol).returns(T.attached_class) } + sig do + params( + data: FinchAPI::Models::JobCompletionEvent::Data, + event_type: FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: FinchAPI::Models::JobCompletionEvent::Data, event_type: Symbol}) } + sig do + override + .returns( + { + data: FinchAPI::Models::JobCompletionEvent::Data, + event_type: FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol + } + ) + end def to_hash end @@ -55,17 +72,24 @@ module FinchAPI end end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::JobCompletionEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) } - JOB_BENEFIT_CREATE_COMPLETED = :"job.benefit_create.completed" - JOB_BENEFIT_ENROLL_COMPLETED = :"job.benefit_enroll.completed" - JOB_BENEFIT_REGISTER_COMPLETED = :"job.benefit_register.completed" - JOB_BENEFIT_UNENROLL_COMPLETED = :"job.benefit_unenroll.completed" - JOB_BENEFIT_UPDATE_COMPLETED = :"job.benefit_update.completed" - JOB_DATA_SYNC_ALL_COMPLETED = :"job.data_sync_all.completed" + JOB_BENEFIT_CREATE_COMPLETED = + T.let(:"job.benefit_create.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + JOB_BENEFIT_ENROLL_COMPLETED = + T.let(:"job.benefit_enroll.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + JOB_BENEFIT_REGISTER_COMPLETED = + T.let(:"job.benefit_register.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + JOB_BENEFIT_UNENROLL_COMPLETED = + T.let(:"job.benefit_unenroll.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + JOB_BENEFIT_UPDATE_COMPLETED = + T.let(:"job.benefit_update.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + JOB_DATA_SYNC_ALL_COMPLETED = + T.let(:"job.data_sync_all.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 2eb3743a..306f8573 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -74,20 +74,26 @@ module FinchAPI def started_at=(_) end - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) } def status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + .returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + end def status=(_) end # The type of automated job - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) + .returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) + end def type=(_) end @@ -100,8 +106,8 @@ module FinchAPI params: T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params), scheduled_at: T.nilable(Time), started_at: T.nilable(Time), - status: Symbol, - type: Symbol + status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol, + type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol ) .returns(T.attached_class) end @@ -119,8 +125,8 @@ module FinchAPI params: T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params), scheduled_at: T.nilable(Time), started_at: T.nilable(Time), - status: Symbol, - type: Symbol + status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol, + type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol } ) end @@ -147,27 +153,32 @@ module FinchAPI end end - class Status < FinchAPI::Enum - abstract! + module Status + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) } - PENDING = :pending - IN_PROGRESS = :in_progress - COMPLETE = :complete - ERROR = :error - REAUTH_ERROR = :reauth_error - PERMISSIONS_ERROR = :permissions_error + PENDING = T.let(:pending, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + IN_PROGRESS = T.let(:in_progress, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + COMPLETE = T.let(:complete, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + ERROR = T.let(:error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + REAUTH_ERROR = T.let(:reauth_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + PERMISSIONS_ERROR = + T.let(:permissions_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) end # The type of automated job - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) } - DATA_SYNC_ALL = :data_sync_all - W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync + DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) + W4_FORM_EMPLOYEE_SYNC = + T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index fd61d703..873d626d 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -8,11 +8,14 @@ module FinchAPI include FinchAPI::RequestParameters # The type of job to start. - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) + .returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) + end def type=(_) end @@ -29,7 +32,7 @@ module FinchAPI sig do params( - type: Symbol, + type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) @@ -42,7 +45,7 @@ module FinchAPI override .returns( { - type: Symbol, + type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, request_options: FinchAPI::RequestOptions } @@ -52,12 +55,15 @@ module FinchAPI end # The type of job to start. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol) } - W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync + W4_FORM_EMPLOYEE_SYNC = + T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) end class Params < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index 6368e540..ce303e52 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -21,11 +21,14 @@ module FinchAPI def job_id=(_) end - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) } def status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) + .returns(FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) + end def status=(_) end @@ -33,25 +36,36 @@ module FinchAPI params( body: T.nilable(T::Array[T.anything]), job_id: String, - status: Symbol - ).returns(T.attached_class) + status: FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol + ) + .returns(T.attached_class) end def self.new(body:, job_id:, status:) end - sig { override.returns({body: T.nilable(T::Array[T.anything]), job_id: String, status: Symbol}) } + sig do + override + .returns( + { + body: T.nilable(T::Array[T.anything]), + job_id: String, + status: FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol + } + ) + end def to_hash end - class Status < FinchAPI::Enum - abstract! + module Status + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) } - PENDING = :pending - IN_PROGRESS = :in_progress - ERROR = :error - COMPLETE = :complete + PENDING = T.let(:pending, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) + IN_PROGRESS = T.let(:in_progress, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) + ERROR = T.let(:error, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) + COMPLETE = T.let(:complete, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/operation_support.rbi b/rbi/lib/finch-api/models/operation_support.rbi index d3f7924d..50202668 100644 --- a/rbi/lib/finch-api/models/operation_support.rbi +++ b/rbi/lib/finch-api/models/operation_support.rbi @@ -9,15 +9,17 @@ module FinchAPI # so Finch cannot support # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch - class OperationSupport < FinchAPI::Enum - abstract! + module OperationSupport + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::OperationSupport) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::OperationSupport::TaggedSymbol) } - SUPPORTED = :supported - NOT_SUPPORTED_BY_FINCH = :not_supported_by_finch - NOT_SUPPORTED_BY_PROVIDER = :not_supported_by_provider - CLIENT_ACCESS_ONLY = :client_access_only + SUPPORTED = T.let(:supported, FinchAPI::Models::OperationSupport::TaggedSymbol) + NOT_SUPPORTED_BY_FINCH = T.let(:not_supported_by_finch, FinchAPI::Models::OperationSupport::TaggedSymbol) + NOT_SUPPORTED_BY_PROVIDER = + T.let(:not_supported_by_provider, FinchAPI::Models::OperationSupport::TaggedSymbol) + CLIENT_ACCESS_ONLY = T.let(:client_access_only, FinchAPI::Models::OperationSupport::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/operation_support_matrix.rbi b/rbi/lib/finch-api/models/operation_support_matrix.rbi index 1abc2138..6f940f3c 100644 --- a/rbi/lib/finch-api/models/operation_support_matrix.rbi +++ b/rbi/lib/finch-api/models/operation_support_matrix.rbi @@ -10,11 +10,14 @@ module FinchAPI # so Finch cannot support # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } def create end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) + .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + end def create=(_) end @@ -25,11 +28,14 @@ module FinchAPI # so Finch cannot support # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } def delete end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) + .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + end def delete=(_) end @@ -40,11 +46,14 @@ module FinchAPI # so Finch cannot support # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } def read end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) + .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + end def read=(_) end @@ -55,19 +64,40 @@ module FinchAPI # so Finch cannot support # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } def update end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) + .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + end def update=(_) end - sig { params(create: Symbol, delete: Symbol, read: Symbol, update: Symbol).returns(T.attached_class) } + sig do + params( + create: FinchAPI::Models::OperationSupport::TaggedSymbol, + delete: FinchAPI::Models::OperationSupport::TaggedSymbol, + read: FinchAPI::Models::OperationSupport::TaggedSymbol, + update: FinchAPI::Models::OperationSupport::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(create: nil, delete: nil, read: nil, update: nil) end - sig { override.returns({create: Symbol, delete: Symbol, read: Symbol, update: Symbol}) } + sig do + override + .returns( + { + create: FinchAPI::Models::OperationSupport::TaggedSymbol, + delete: FinchAPI::Models::OperationSupport::TaggedSymbol, + read: FinchAPI::Models::OperationSupport::TaggedSymbol, + update: FinchAPI::Models::OperationSupport::TaggedSymbol + } + ) + end def to_hash end end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index e3fa9d31..902c76fc 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -11,19 +11,36 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + end def event_type=(_) end - sig { params(data: FinchAPI::Models::PayStatementEvent::Data, event_type: Symbol).returns(T.attached_class) } + sig do + params( + data: FinchAPI::Models::PayStatementEvent::Data, + event_type: FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: FinchAPI::Models::PayStatementEvent::Data, event_type: Symbol}) } + sig do + override + .returns( + { + data: FinchAPI::Models::PayStatementEvent::Data, + event_type: FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol + } + ) + end def to_hash end @@ -55,14 +72,18 @@ module FinchAPI end end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::PayStatementEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) } - PAY_STATEMENT_CREATED = :"pay_statement.created" - PAY_STATEMENT_UPDATED = :"pay_statement.updated" - PAY_STATEMENT_DELETED = :"pay_statement.deleted" + PAY_STATEMENT_CREATED = + T.let(:"pay_statement.created", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + PAY_STATEMENT_UPDATED = + T.let(:"pay_statement.updated", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + PAY_STATEMENT_DELETED = + T.let(:"pay_statement.deleted", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index 65c1402f..1e5faf72 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -11,19 +11,36 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol)) } def event_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) + .returns(FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) + end def event_type=(_) end - sig { params(data: FinchAPI::Models::PaymentEvent::Data, event_type: Symbol).returns(T.attached_class) } + sig do + params( + data: FinchAPI::Models::PaymentEvent::Data, + event_type: FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(data: nil, event_type: nil) end - sig { override.returns({data: FinchAPI::Models::PaymentEvent::Data, event_type: Symbol}) } + sig do + override + .returns( + { + data: FinchAPI::Models::PaymentEvent::Data, + event_type: FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol + } + ) + end def to_hash end @@ -55,14 +72,15 @@ module FinchAPI end end - class EventType < FinchAPI::Enum - abstract! + module EventType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::PaymentEvent::EventType) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) } - PAYMENT_CREATED = :"payment.created" - PAYMENT_UPDATED = :"payment.updated" - PAYMENT_DELETED = :"payment.deleted" + PAYMENT_CREATED = T.let(:"payment.created", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) + PAYMENT_UPDATED = T.let(:"payment.updated", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) + PAYMENT_DELETED = T.let(:"payment.deleted", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index f53f82a8..f698413f 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -23,36 +23,62 @@ module FinchAPI end # List of pay frequencies associated with this pay group - sig { returns(T.nilable(T::Array[Symbol])) } + sig { returns(T.nilable(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol])) } def pay_frequencies end - sig { params(_: T::Array[Symbol]).returns(T::Array[Symbol]) } + sig do + params(_: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) + .returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) + end def pay_frequencies=(_) end - sig { params(id: String, name: String, pay_frequencies: T::Array[Symbol]).returns(T.attached_class) } + sig do + params( + id: String, + name: String, + pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol] + ) + .returns(T.attached_class) + end def self.new(id: nil, name: nil, pay_frequencies: nil) end - sig { override.returns({id: String, name: String, pay_frequencies: T::Array[Symbol]}) } + sig do + override + .returns( + { + id: String, + name: String, + pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol] + } + ) + end def to_hash end - class PayFrequency < FinchAPI::Enum - abstract! + module PayFrequency + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) } - ANNUALLY = :annually - SEMI_ANNUALLY = :semi_annually - QUARTERLY = :quarterly - MONTHLY = :monthly - SEMI_MONTHLY = :semi_monthly - BI_WEEKLY = :bi_weekly - WEEKLY = :weekly - DAILY = :daily - OTHER = :other + ANNUALLY = T.let(:annually, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + SEMI_ANNUALLY = + T.let(:semi_annually, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + QUARTERLY = + T.let(:quarterly, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + MONTHLY = T.let(:monthly, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + SEMI_MONTHLY = + T.let(:semi_monthly, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + BI_WEEKLY = + T.let(:bi_weekly, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + WEEKLY = T.let(:weekly, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + DAILY = T.let(:daily, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index 3d81e580..952080f9 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -31,11 +31,14 @@ module FinchAPI end # List of pay frequencies associated with this pay group - sig { returns(T::Array[Symbol]) } + sig { returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) } def pay_frequencies end - sig { params(_: T::Array[Symbol]).returns(T::Array[Symbol]) } + sig do + params(_: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) + .returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) + end def pay_frequencies=(_) end @@ -44,7 +47,7 @@ module FinchAPI id: String, individual_ids: T::Array[String], name: String, - pay_frequencies: T::Array[Symbol] + pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol] ) .returns(T.attached_class) end @@ -53,30 +56,41 @@ module FinchAPI sig do override - .returns({ - id: String, - individual_ids: T::Array[String], - name: String, - pay_frequencies: T::Array[Symbol] - }) + .returns( + { + id: String, + individual_ids: T::Array[String], + name: String, + pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol] + } + ) end def to_hash end - class PayFrequency < FinchAPI::Enum - abstract! + module PayFrequency + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) } - ANNUALLY = :annually - SEMI_ANNUALLY = :semi_annually - QUARTERLY = :quarterly - MONTHLY = :monthly - SEMI_MONTHLY = :semi_monthly - BI_WEEKLY = :bi_weekly - WEEKLY = :weekly - DAILY = :daily - OTHER = :other + ANNUALLY = + T.let(:annually, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + SEMI_ANNUALLY = + T.let(:semi_annually, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + QUARTERLY = + T.let(:quarterly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + MONTHLY = + T.let(:monthly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + SEMI_MONTHLY = + T.let(:semi_monthly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + BI_WEEKLY = + T.let(:bi_weekly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + WEEKLY = T.let(:weekly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + DAILY = T.let(:daily, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 69905d02..e125e013 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -174,11 +174,14 @@ module FinchAPI end # The type of authentication method. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol)) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + .returns(FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + end def type=(_) end @@ -186,7 +189,7 @@ module FinchAPI params( benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), supported_fields: T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields), - type: Symbol + type: FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol ) .returns(T.attached_class) end @@ -199,7 +202,7 @@ module FinchAPI { benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), supported_fields: T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields), - type: Symbol + type: FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol } ) end @@ -2360,16 +2363,19 @@ module FinchAPI end # The type of authentication method. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASSISTED = :assisted - CREDENTIAL = :credential - API_TOKEN = :api_token - API_CREDENTIAL = :api_credential - OAUTH = :oauth + module Type + extend FinchAPI::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) } + + ASSISTED = T.let(:assisted, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + CREDENTIAL = T.let(:credential, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + API_TOKEN = T.let(:api_token, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + API_CREDENTIAL = + T.let(:api_credential, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + OAUTH = T.let(:oauth, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index 8983cd1d..64db322f 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -156,11 +156,14 @@ module FinchAPI end # The type of bank account. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) } def account_type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) + end def account_type=(_) end @@ -187,7 +190,7 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(Symbol), + account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) ) @@ -202,7 +205,7 @@ module FinchAPI { account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(Symbol), + account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) } @@ -212,13 +215,17 @@ module FinchAPI end # The type of bank account. - class AccountType < FinchAPI::Enum - abstract! + module AccountType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) } - CHECKING = :checking - SAVINGS = :savings + CHECKING = + T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol) + SAVINGS = T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol) end end @@ -289,56 +296,86 @@ module FinchAPI class Entity < FinchAPI::BaseModel # The tax payer subtype of the company. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) } def subtype end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) + end def subtype=(_) end # The tax payer type of the company. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) + end def type=(_) end # The entity type object. - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + ) + .returns(T.attached_class) + end def self.new(subtype: nil, type: nil) end - sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + } + ) + end def to_hash end # The tax payer subtype of the company. - class Subtype < FinchAPI::Enum - abstract! + module Subtype + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) } - S_CORPORATION = :s_corporation - C_CORPORATION = :c_corporation - B_CORPORATION = :b_corporation + S_CORPORATION = + T.let(:s_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol) + C_CORPORATION = + T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol) + B_CORPORATION = + T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol) end # The tax payer type of the company. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - LLC = :llc - LP = :lp - CORPORATION = :corporation - SOLE_PROPRIETOR = :sole_proprietor - NON_PROFIT = :non_profit - PARTNERSHIP = :partnership - COOPERATIVE = :cooperative + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) } + + LLC = T.let(:llc, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + LP = T.let(:lp, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + CORPORATION = T.let(:corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + SOLE_PROPRIETOR = + T.let(:sole_proprietor, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + NON_PROFIT = T.let(:non_profit, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + PARTNERSHIP = T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + COOPERATIVE = T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index e22fe115..c43f9b8f 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -141,11 +141,14 @@ module FinchAPI end # The type of bank account. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol)) } def account_type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol)) + end def account_type=(_) end @@ -172,7 +175,7 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(Symbol), + account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) ) @@ -187,7 +190,7 @@ module FinchAPI { account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(Symbol), + account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) } @@ -197,13 +200,18 @@ module FinchAPI end # The type of bank account. - class AccountType < FinchAPI::Enum - abstract! + module AccountType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) } - CHECKING = :checking - SAVINGS = :savings + CHECKING = + T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) + SAVINGS = + T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) end end @@ -274,56 +282,90 @@ module FinchAPI class Entity < FinchAPI::BaseModel # The tax payer subtype of the company. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol)) } def subtype end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol)) + end def subtype=(_) end # The tax payer type of the company. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol)) + end def type=(_) end # The entity type object. - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(subtype: nil, type: nil) end - sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + } + ) + end def to_hash end # The tax payer subtype of the company. - class Subtype < FinchAPI::Enum - abstract! + module Subtype + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) } - S_CORPORATION = :s_corporation - C_CORPORATION = :c_corporation - B_CORPORATION = :b_corporation + S_CORPORATION = + T.let(:s_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) + C_CORPORATION = + T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) + B_CORPORATION = + T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) end # The tax payer type of the company. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - LLC = :llc - LP = :lp - CORPORATION = :corporation - SOLE_PROPRIETOR = :sole_proprietor - NON_PROFIT = :non_profit - PARTNERSHIP = :partnership - COOPERATIVE = :cooperative + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) } + + LLC = T.let(:llc, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + LP = T.let(:lp, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + CORPORATION = + T.let(:corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + SOLE_PROPRIETOR = + T.let(:sole_proprietor, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + NON_PROFIT = + T.let(:non_profit, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + PARTNERSHIP = + T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + COOPERATIVE = + T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 1357796c..54550907 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -16,11 +16,14 @@ module FinchAPI def provider_id=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol)) } def authentication_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + .returns(FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + end def authentication_type=(_) end @@ -46,7 +49,7 @@ module FinchAPI sig do params( provider_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, employee_size: Integer, products: T::Array[String], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) @@ -61,7 +64,7 @@ module FinchAPI .returns( { provider_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, employee_size: Integer, products: T::Array[String], request_options: FinchAPI::RequestOptions @@ -71,15 +74,21 @@ module FinchAPI def to_hash end - class AuthenticationType < FinchAPI::Enum - abstract! + module AuthenticationType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) } - CREDENTIAL = :credential - API_TOKEN = :api_token - OAUTH = :oauth - ASSISTED = :assisted + CREDENTIAL = + T.let(:credential, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + API_TOKEN = + T.let(:api_token, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + OAUTH = T.let(:oauth, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + ASSISTED = + T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index e52b4363..43962876 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -21,11 +21,14 @@ module FinchAPI def account_id=(_) end - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) } def authentication_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + .returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + end def authentication_type=(_) end @@ -76,7 +79,7 @@ module FinchAPI params( access_token: String, account_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol, company_id: String, connection_id: String, products: T::Array[String], @@ -103,7 +106,7 @@ module FinchAPI { access_token: String, account_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol, company_id: String, connection_id: String, products: T::Array[String], @@ -115,15 +118,22 @@ module FinchAPI def to_hash end - class AuthenticationType < FinchAPI::Enum - abstract! + module AuthenticationType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) } - CREDENTIAL = :credential - API_TOKEN = :api_token - OAUTH = :oauth - ASSISTED = :assisted + CREDENTIAL = + T.let(:credential, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + API_TOKEN = + T.let(:api_token, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + OAUTH = + T.let(:oauth, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + ASSISTED = + T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index ce09705f..ad3aac02 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -25,11 +25,18 @@ module FinchAPI def provider_id=(_) end - sig { returns(T.nilable(Symbol)) } + sig do + returns( + T.nilable(FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) + ) + end def authentication_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) + .returns(FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) + end def authentication_type=(_) end @@ -47,7 +54,7 @@ module FinchAPI params( company_id: String, provider_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, products: T::Array[String], request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) @@ -62,7 +69,7 @@ module FinchAPI { company_id: String, provider_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, products: T::Array[String], request_options: FinchAPI::RequestOptions } @@ -71,15 +78,36 @@ module FinchAPI def to_hash end - class AuthenticationType < FinchAPI::Enum - abstract! + module AuthenticationType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType) } + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol + ) + end - CREDENTIAL = :credential - API_TOKEN = :api_token - OAUTH = :oauth - ASSISTED = :assisted + CREDENTIAL = + T.let( + :credential, + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + ) + API_TOKEN = + T.let( + :api_token, + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + ) + OAUTH = + T.let(:oauth, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) + ASSISTED = + T.let( + :assisted, + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + ) end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index b0533821..8d52276e 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -22,11 +22,14 @@ module FinchAPI def account_id=(_) end - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol) } def authentication_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol) + .returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol) + end def authentication_type=(_) end @@ -69,7 +72,7 @@ module FinchAPI params( access_token: String, account_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol, company_id: String, connection_id: String, products: T::Array[String], @@ -86,7 +89,7 @@ module FinchAPI { access_token: String, account_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol, company_id: String, connection_id: String, products: T::Array[String], @@ -97,15 +100,39 @@ module FinchAPI def to_hash end - class AuthenticationType < FinchAPI::Enum - abstract! + module AuthenticationType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType) } + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol + ) + end - CREDENTIAL = :credential - API_TOKEN = :api_token - OAUTH = :oauth - ASSISTED = :assisted + CREDENTIAL = + T.let( + :credential, + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol + ) + API_TOKEN = + T.let( + :api_token, + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol + ) + OAUTH = + T.let( + :oauth, + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol + ) + ASSISTED = + T.let( + :assisted, + FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol + ) end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi index bc03bce1..9fd25006 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi @@ -8,17 +8,20 @@ module FinchAPI extend FinchAPI::RequestParameters::Converter include FinchAPI::RequestParameters - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::OrSymbol)) } def connection_status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::ConnectionStatusType::OrSymbol) + .returns(FinchAPI::Models::ConnectionStatusType::OrSymbol) + end def connection_status=(_) end sig do params( - connection_status: Symbol, + connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) ) .returns(T.attached_class) @@ -26,7 +29,15 @@ module FinchAPI def self.new(connection_status: nil, request_options: {}) end - sig { override.returns({connection_status: Symbol, request_options: FinchAPI::RequestOptions}) } + sig do + override + .returns( + { + connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, + request_options: FinchAPI::RequestOptions + } + ) + end def to_hash end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index 608f54bb..c87d0b8c 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -14,11 +14,14 @@ module FinchAPI def account_id=(_) end - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol) } def authentication_type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol) + .returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol) + end def authentication_type=(_) end @@ -60,7 +63,7 @@ module FinchAPI sig do params( account_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol, company_id: String, products: T::Array[String], provider_id: String, @@ -76,7 +79,7 @@ module FinchAPI .returns( { account_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol, company_id: String, products: T::Array[String], provider_id: String, @@ -87,15 +90,39 @@ module FinchAPI def to_hash end - class AuthenticationType < FinchAPI::Enum - abstract! + module AuthenticationType + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType) } + OrSymbol = + T.type_alias do + T.any( + Symbol, + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol + ) + end - CREDENTIAL = :credential - API_TOKEN = :api_token - OAUTH = :oauth - ASSISTED = :assisted + CREDENTIAL = + T.let( + :credential, + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol + ) + API_TOKEN = + T.let( + :api_token, + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol + ) + OAUTH = + T.let( + :oauth, + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol + ) + ASSISTED = + T.let( + :assisted, + FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol + ) end end end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index 507ff6f0..b71fbb7b 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -110,11 +110,14 @@ module FinchAPI end # The detailed employment status of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) } def employment_status end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) + end def employment_status=(_) end @@ -138,11 +141,14 @@ module FinchAPI end # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) } def ethnicity end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) + end def ethnicity=(_) end @@ -156,11 +162,14 @@ module FinchAPI end # The gender of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) } def gender end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) + end def gender=(_) end @@ -324,12 +333,12 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]), employment: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol), encrypted_ssn: T.nilable(String), end_date: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol), income: T.nilable(FinchAPI::Models::Income), income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), is_active: T.nilable(T::Boolean), @@ -389,12 +398,12 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]), employment: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol), encrypted_ssn: T.nilable(String), end_date: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol), income: T.nilable(FinchAPI::Models::Income), income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), is_active: T.nilable(T::Boolean), @@ -471,128 +480,216 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) + end def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol) + ) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: String, type: T.nilable(Symbol)}) } + sig do + override + .returns( + {data: String, type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)} + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol) + PERSONAL = + T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol) end end class Employment < FinchAPI::BaseModel # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol)) } def subtype end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params( + _: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + ) + .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol)) + end def subtype=(_) end # The main employment type of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) + end def type=(_) end # The employment object. - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + subtype: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol) + ) + .returns(T.attached_class) + end def self.new(subtype: nil, type: nil) end - sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + subtype: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol) + } + ) + end def to_hash end # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - FULL_TIME = :full_time - INTERN = :intern - PART_TIME = :part_time - TEMP = :temp - SEASONAL = :seasonal - INDIVIDUAL_CONTRACTOR = :individual_contractor + module Subtype + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol) } + + FULL_TIME = + T.let(:full_time, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + INTERN = + T.let(:intern, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + PART_TIME = + T.let(:part_time, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + TEMP = + T.let(:temp, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + SEASONAL = + T.let(:seasonal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + INDIVIDUAL_CONTRACTOR = + T.let( + :individual_contractor, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol + ) end # The main employment type of the individual. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) } - EMPLOYEE = :employee - CONTRACTOR = :contractor + EMPLOYEE = + T.let(:employee, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol) + CONTRACTOR = + T.let(:contractor, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol) end end # The detailed employment status of the individual. - class EmploymentStatus < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ACTIVE = :active - DECEASED = :deceased - LEAVE = :leave - ONBOARDING = :onboarding - PREHIRE = :prehire - RETIRED = :retired - TERMINATED = :terminated + module EmploymentStatus + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) } + + ACTIVE = + T.let(:active, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + DECEASED = + T.let(:deceased, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + ONBOARDING = + T.let(:onboarding, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + PREHIRE = + T.let(:prehire, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + RETIRED = + T.let(:retired, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + TERMINATED = + T.let(:terminated, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) end # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASIAN = :asian - WHITE = :white - BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander - AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native - HISPANIC_OR_LATINO = :hispanic_or_latino - TWO_OR_MORE_RACES = :two_or_more_races - DECLINE_TO_SPECIFY = :decline_to_specify + module Ethnicity + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) } + + ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + WHITE = T.let(:white, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + BLACK_OR_AFRICAN_AMERICAN = + T.let( + :black_or_african_american, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + ) + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = + T.let( + :native_hawaiian_or_pacific_islander, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + ) + AMERICAN_INDIAN_OR_ALASKA_NATIVE = + T.let( + :american_indian_or_alaska_native, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + ) + HISPANIC_OR_LATINO = + T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + TWO_OR_MORE_RACES = + T.let(:two_or_more_races, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + DECLINE_TO_SPECIFY = + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) end # The gender of the individual. - class Gender < FinchAPI::Enum - abstract! + module Gender + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) } - FEMALE = :female - MALE = :male - OTHER = :other - DECLINE_TO_SPECIFY = :decline_to_specify + FEMALE = T.let(:female, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) + MALE = T.let(:male, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) + OTHER = T.let(:other, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) + DECLINE_TO_SPECIFY = + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) end class Manager < FinchAPI::BaseModel @@ -624,29 +721,50 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) + end def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) + ) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: String, type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) + } + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) + PERSONAL = + T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index defcb492..d30bbc41 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -55,11 +55,14 @@ module FinchAPI end # The detailed employment status of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) } def employment_status end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) + end def employment_status=(_) end @@ -190,7 +193,7 @@ module FinchAPI custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department), employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(FinchAPI::Models::Income), @@ -239,7 +242,7 @@ module FinchAPI custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department), employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(FinchAPI::Models::Income), @@ -309,71 +312,112 @@ module FinchAPI class Employment < FinchAPI::BaseModel # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol)) } def subtype end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol)) + end def subtype=(_) end # The main employment type of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) + end def type=(_) end # The employment object. - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol) + ) + .returns(T.attached_class) + end def self.new(subtype: nil, type: nil) end - sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol) + } + ) + end def to_hash end # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - FULL_TIME = :full_time - INTERN = :intern - PART_TIME = :part_time - TEMP = :temp - SEASONAL = :seasonal - INDIVIDUAL_CONTRACTOR = :individual_contractor + module Subtype + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) } + + FULL_TIME = + T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + INTERN = T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + PART_TIME = + T.let(:part_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + TEMP = T.let(:temp, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + SEASONAL = + T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + INDIVIDUAL_CONTRACTOR = + T.let( + :individual_contractor, + FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol + ) end # The main employment type of the individual. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - EMPLOYEE = :employee - CONTRACTOR = :contractor + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) } + + EMPLOYEE = + T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol) + CONTRACTOR = + T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol) end end # The detailed employment status of the individual. - class EmploymentStatus < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ACTIVE = :active - DECEASED = :deceased - LEAVE = :leave - ONBOARDING = :onboarding - PREHIRE = :prehire - RETIRED = :retired - TERMINATED = :terminated + module EmploymentStatus + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) } + + ACTIVE = T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + DECEASED = + T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + ONBOARDING = + T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + PREHIRE = T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + RETIRED = T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + TERMINATED = + T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 62eb953e..6a6073af 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -61,11 +61,14 @@ module FinchAPI end # The detailed employment status of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol)) } def employment_status end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol)) + end def employment_status=(_) end @@ -197,7 +200,7 @@ module FinchAPI custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department), employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(FinchAPI::Models::Income), @@ -246,7 +249,7 @@ module FinchAPI custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department), employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(FinchAPI::Models::Income), @@ -315,71 +318,120 @@ module FinchAPI class Employment < FinchAPI::BaseModel # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol)) } def subtype end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params( + _: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + ) + .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol)) + end def subtype=(_) end # The main employment type of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol)) + end def type=(_) end # The employment object. - sig { params(subtype: T.nilable(Symbol), type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(subtype: nil, type: nil) end - sig { override.returns({subtype: T.nilable(Symbol), type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) + } + ) + end def to_hash end # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. - class Subtype < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - FULL_TIME = :full_time - INTERN = :intern - PART_TIME = :part_time - TEMP = :temp - SEASONAL = :seasonal - INDIVIDUAL_CONTRACTOR = :individual_contractor + module Subtype + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) } + + FULL_TIME = + T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + INTERN = + T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + PART_TIME = + T.let(:part_time, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + TEMP = + T.let(:temp, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + SEASONAL = + T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) + INDIVIDUAL_CONTRACTOR = + T.let( + :individual_contractor, + FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol + ) end # The main employment type of the individual. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - EMPLOYEE = :employee - CONTRACTOR = :contractor + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) } + + EMPLOYEE = + T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) + CONTRACTOR = + T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) end end # The detailed employment status of the individual. - class EmploymentStatus < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ACTIVE = :active - DECEASED = :deceased - LEAVE = :leave - ONBOARDING = :onboarding - PREHIRE = :prehire - RETIRED = :retired - TERMINATED = :terminated + module EmploymentStatus + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) } + + ACTIVE = + T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + DECEASED = + T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + LEAVE = + T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + ONBOARDING = + T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + PREHIRE = + T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + RETIRED = + T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + TERMINATED = + T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index 85fa27de..caca0005 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -38,11 +38,14 @@ module FinchAPI end # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol)) } def ethnicity end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol)) + end def ethnicity=(_) end @@ -56,11 +59,14 @@ module FinchAPI end # The gender of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol)) } def gender end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol)) + end def gender=(_) end @@ -127,9 +133,9 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)]), @@ -164,9 +170,9 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)]), @@ -189,58 +195,93 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)) + end def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol) + ) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: String, type: T.nilable(Symbol)}) } + sig do + override + .returns( + {data: String, type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)} + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol) + PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol) end end # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASIAN = :asian - WHITE = :white - BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander - AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native - HISPANIC_OR_LATINO = :hispanic_or_latino - TWO_OR_MORE_RACES = :two_or_more_races - DECLINE_TO_SPECIFY = :decline_to_specify + module Ethnicity + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) } + + ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + WHITE = T.let(:white, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + BLACK_OR_AFRICAN_AMERICAN = + T.let(:black_or_african_american, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = + T.let( + :native_hawaiian_or_pacific_islander, + FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + ) + AMERICAN_INDIAN_OR_ALASKA_NATIVE = + T.let( + :american_indian_or_alaska_native, + FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + ) + HISPANIC_OR_LATINO = + T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + TWO_OR_MORE_RACES = + T.let(:two_or_more_races, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + DECLINE_TO_SPECIFY = + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) end # The gender of the individual. - class Gender < FinchAPI::Enum - abstract! + module Gender + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) } - FEMALE = :female - MALE = :male - OTHER = :other - DECLINE_TO_SPECIFY = :decline_to_specify + FEMALE = T.let(:female, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) + MALE = T.let(:male, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) + OTHER = T.let(:other, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) + DECLINE_TO_SPECIFY = + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) end class PhoneNumber < FinchAPI::BaseModel @@ -252,29 +293,50 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol)) + end def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) + ) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: String, type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) + } + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) + PERSONAL = + T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index b791a544..b5ee010e 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -44,11 +44,14 @@ module FinchAPI end # The EEOC-defined ethnicity of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) } def ethnicity end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) + end def ethnicity=(_) end @@ -62,11 +65,14 @@ module FinchAPI end # The gender of the individual. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) } def gender end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) + end def gender=(_) end @@ -136,9 +142,9 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]), @@ -173,9 +179,9 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]), @@ -197,58 +203,101 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) + end def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: String, type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) + } + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) + PERSONAL = + T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) end end # The EEOC-defined ethnicity of the individual. - class Ethnicity < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - ASIAN = :asian - WHITE = :white - BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american - NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = :native_hawaiian_or_pacific_islander - AMERICAN_INDIAN_OR_ALASKA_NATIVE = :american_indian_or_alaska_native - HISPANIC_OR_LATINO = :hispanic_or_latino - TWO_OR_MORE_RACES = :two_or_more_races - DECLINE_TO_SPECIFY = :decline_to_specify + module Ethnicity + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) } + + ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) + WHITE = T.let(:white, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) + BLACK_OR_AFRICAN_AMERICAN = + T.let( + :black_or_african_american, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol + ) + NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = + T.let( + :native_hawaiian_or_pacific_islander, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol + ) + AMERICAN_INDIAN_OR_ALASKA_NATIVE = + T.let( + :american_indian_or_alaska_native, + FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol + ) + HISPANIC_OR_LATINO = + T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) + TWO_OR_MORE_RACES = + T.let(:two_or_more_races, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) + DECLINE_TO_SPECIFY = + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) end # The gender of the individual. - class Gender < FinchAPI::Enum - abstract! + module Gender + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) } - FEMALE = :female - MALE = :male - OTHER = :other - DECLINE_TO_SPECIFY = :decline_to_specify + FEMALE = T.let(:female, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) + MALE = T.let(:male, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) + DECLINE_TO_SPECIFY = + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) end class PhoneNumber < FinchAPI::BaseModel @@ -260,29 +309,50 @@ module FinchAPI def data=(_) end - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) + end def type=(_) end - sig { params(data: String, type: T.nilable(Symbol)).returns(T.attached_class) } + sig do + params( + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) + ) + .returns(T.attached_class) + end def self.new(data: nil, type: nil) end - sig { override.returns({data: String, type: T.nilable(Symbol)}) } + sig do + override + .returns( + { + data: String, + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) + } + ) + end def to_hash end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) } - WORK = :work - PERSONAL = :personal + WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) + PERSONAL = + T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index 341df379..c5b35d84 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -8,32 +8,44 @@ module FinchAPI include FinchAPI::RequestParameters # The type of job to start. Currently the only supported type is `data_sync_all` - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) + .returns(FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) + end def type=(_) end sig do - params(type: Symbol, request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + params( + type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, + request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + ) .returns(T.attached_class) end def self.new(type:, request_options: {}) end - sig { override.returns({type: Symbol, request_options: FinchAPI::RequestOptions}) } + sig do + override + .returns( + {type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, request_options: FinchAPI::RequestOptions} + ) + end def to_hash end # The type of job to start. Currently the only supported type is `data_sync_all` - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type) } + OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol) } - DATA_SYNC_ALL = :data_sync_all + DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index 7ea67cc0..bb9c9fb7 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -5,47 +5,84 @@ module FinchAPI module Sandbox module Jobs class SandboxJobConfiguration < FinchAPI::BaseModel - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) } def completion_status end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) + .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) + end def completion_status=(_) end - sig { returns(Symbol) } + sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) } def type end - sig { params(_: Symbol).returns(Symbol) } + sig do + params(_: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) + .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) + end def type=(_) end - sig { params(completion_status: Symbol, type: Symbol).returns(T.attached_class) } + sig do + params( + completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol, + type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol + ) + .returns(T.attached_class) + end def self.new(completion_status:, type:) end - sig { override.returns({completion_status: Symbol, type: Symbol}) } + sig do + override + .returns( + { + completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol, + type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol + } + ) + end def to_hash end - class CompletionStatus < FinchAPI::Enum - abstract! + module CompletionStatus + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) } - COMPLETE = :complete - REAUTH_ERROR = :reauth_error - PERMISSIONS_ERROR = :permissions_error - ERROR = :error + COMPLETE = + T.let(:complete, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) + REAUTH_ERROR = + T.let( + :reauth_error, + FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + ) + PERMISSIONS_ERROR = + T.let( + :permissions_error, + FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol + ) + ERROR = + T.let(:error, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) end - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) } - DATA_SYNC_ALL = :data_sync_all + DATA_SYNC_ALL = + T.let(:data_sync_all, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) end end end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index e68e454b..17d9c472 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -158,11 +158,16 @@ module FinchAPI end # The payment method. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol)) } def payment_method end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params( + _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol) + ) + .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol)) + end def payment_method=(_) end @@ -190,11 +195,14 @@ module FinchAPI end # The type of the payment associated with the pay statement. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) + end def type=(_) end @@ -210,10 +218,10 @@ module FinchAPI gross_pay: T.nilable(FinchAPI::Models::Money), individual_id: String, net_pay: T.nilable(FinchAPI::Models::Money), - payment_method: T.nilable(Symbol), + payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol), taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]), total_hours: T.nilable(Float), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) ) .returns(T.attached_class) end @@ -245,10 +253,10 @@ module FinchAPI gross_pay: T.nilable(FinchAPI::Models::Money), individual_id: String, net_pay: T.nilable(FinchAPI::Models::Money), - payment_method: T.nilable(Symbol), + payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol), taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]), total_hours: T.nilable(Float), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) } ) end @@ -305,11 +313,16 @@ module FinchAPI end # The type of earning. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params( + _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + ) + .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)) + end def type=(_) end @@ -320,7 +333,7 @@ module FinchAPI currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) ) .returns(T.attached_class) end @@ -336,7 +349,7 @@ module FinchAPI currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) } ) end @@ -400,24 +413,45 @@ module FinchAPI end # The type of earning. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - SALARY = :salary - WAGE = :wage - REIMBURSEMENT = :reimbursement - OVERTIME = :overtime - SEVERANCE = :severance - DOUBLE_OVERTIME = :double_overtime - PTO = :pto - SICK = :sick - BONUS = :bonus - COMMISSION = :commission - TIPS = :tips - NUMBER_1099 = :"1099" - OTHER = :other + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) } + + SALARY = + T.let(:salary, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + WAGE = + T.let(:wage, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + REIMBURSEMENT = + T.let( + :reimbursement, + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol + ) + OVERTIME = + T.let(:overtime, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + SEVERANCE = + T.let(:severance, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + DOUBLE_OVERTIME = + T.let( + :double_overtime, + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol + ) + PTO = T.let(:pto, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + SICK = + T.let(:sick, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + BONUS = + T.let(:bonus, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + COMMISSION = + T.let(:commission, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + TIPS = + T.let(:tips, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + NUMBER_1099 = + T.let(:"1099", FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + OTHER = + T.let(:other, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) end end @@ -478,11 +512,14 @@ module FinchAPI end # Type of benefit. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) + end def type=(_) end @@ -493,7 +530,7 @@ module FinchAPI currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) ) .returns(T.attached_class) end @@ -509,7 +546,7 @@ module FinchAPI currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) } ) end @@ -629,11 +666,14 @@ module FinchAPI end # Type of benefit. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) + end def type=(_) end @@ -643,7 +683,7 @@ module FinchAPI attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes), currency: T.nilable(String), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) ) .returns(T.attached_class) end @@ -658,7 +698,7 @@ module FinchAPI attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes), currency: T.nilable(String), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) } ) end @@ -731,13 +771,21 @@ module FinchAPI end # The payment method. - class PaymentMethod < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - CHECK = :check - DIRECT_DEPOSIT = :direct_deposit + module PaymentMethod + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol) } + + CHECK = + T.let(:check, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol) + DIRECT_DEPOSIT = + T.let( + :direct_deposit, + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol + ) end class Tax < FinchAPI::BaseModel @@ -789,11 +837,14 @@ module FinchAPI end # The type of taxes. - sig { returns(T.nilable(Symbol)) } + sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) } def type end - sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) } + sig do + params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) + .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) + end def type=(_) end @@ -804,7 +855,7 @@ module FinchAPI currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) ) .returns(T.attached_class) end @@ -820,7 +871,7 @@ module FinchAPI currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), - type: T.nilable(Symbol) + type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) } ) end @@ -882,27 +933,37 @@ module FinchAPI end # The type of taxes. - class Type < FinchAPI::Enum - abstract! + module Type + extend FinchAPI::Enum - Value = type_template(:out) { {fixed: Symbol} } + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) } - STATE = :state - FEDERAL = :federal - LOCAL = :local - FICA = :fica + STATE = T.let(:state, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) + FEDERAL = + T.let(:federal, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) + LOCAL = T.let(:local, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) + FICA = T.let(:fica, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) end end # The type of the payment associated with the pay statement. - class Type < FinchAPI::Enum - abstract! - - Value = type_template(:out) { {fixed: Symbol} } - - REGULAR_PAYROLL = :regular_payroll - OFF_CYCLE_PAYROLL = :off_cycle_payroll - ONE_TIME_PAYMENT = :one_time_payment + module Type + extend FinchAPI::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type) } + OrSymbol = + T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) } + + REGULAR_PAYROLL = + T.let(:regular_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) + OFF_CYCLE_PAYROLL = + T.let(:off_cycle_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) + ONE_TIME_PAYMENT = + T.let(:one_time_payment, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) end end end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index 223b2172..0703d7e5 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -2,8 +2,8 @@ module FinchAPI module Models - class WebhookEvent < FinchAPI::Union - abstract! + module WebhookEvent + extend FinchAPI::Union Variants = type_template(:out) do diff --git a/rbi/lib/finch-api/resources/connect/sessions.rbi b/rbi/lib/finch-api/resources/connect/sessions.rbi index 2ebdb716..a0141c80 100644 --- a/rbi/lib/finch-api/resources/connect/sessions.rbi +++ b/rbi/lib/finch-api/resources/connect/sessions.rbi @@ -9,13 +9,13 @@ module FinchAPI params( customer_id: String, customer_name: String, - products: T::Array[Symbol], + products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol], customer_email: T.nilable(String), integration: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration), manual: T.nilable(T::Boolean), minutes_to_expire: T.nilable(Float), redirect_uri: T.nilable(String), - sandbox: T.nilable(Symbol), + sandbox: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol), request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) .returns(FinchAPI::Models::Connect::SessionNewResponse) @@ -41,7 +41,7 @@ module FinchAPI params( connection_id: String, minutes_to_expire: T.nilable(Integer), - products: T.nilable(T::Array[Symbol]), + products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), redirect_uri: T.nilable(String), request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) diff --git a/rbi/lib/finch-api/resources/hris/benefits.rbi b/rbi/lib/finch-api/resources/hris/benefits.rbi index d8a3dbc4..d28c60a2 100644 --- a/rbi/lib/finch-api/resources/hris/benefits.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits.rbi @@ -13,8 +13,8 @@ module FinchAPI sig do params( description: String, - frequency: T.nilable(Symbol), - type: T.nilable(Symbol), + frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) .returns(FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse) diff --git a/rbi/lib/finch-api/resources/hris/documents.rbi b/rbi/lib/finch-api/resources/hris/documents.rbi index 297bfc2c..75bf7ae7 100644 --- a/rbi/lib/finch-api/resources/hris/documents.rbi +++ b/rbi/lib/finch-api/resources/hris/documents.rbi @@ -11,7 +11,7 @@ module FinchAPI individual_ids: T::Array[String], limit: Integer, offset: Integer, - types: T::Array[Symbol], + types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) .returns(FinchAPI::Models::HRIS::DocumentListResponse) diff --git a/rbi/lib/finch-api/resources/jobs/automated.rbi b/rbi/lib/finch-api/resources/jobs/automated.rbi index dd8d5cbb..7d0004a9 100644 --- a/rbi/lib/finch-api/resources/jobs/automated.rbi +++ b/rbi/lib/finch-api/resources/jobs/automated.rbi @@ -20,7 +20,7 @@ module FinchAPI # access to this endpoint, please contact your Finch account manager. sig do params( - type: Symbol, + type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) diff --git a/rbi/lib/finch-api/resources/sandbox/connections.rbi b/rbi/lib/finch-api/resources/sandbox/connections.rbi index 50d44fb3..7a8d41df 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections.rbi @@ -12,7 +12,7 @@ module FinchAPI sig do params( provider_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, employee_size: Integer, products: T::Array[String], request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) diff --git a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi index dd3b3bb5..6672b56c 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi @@ -10,7 +10,7 @@ module FinchAPI params( company_id: String, provider_id: String, - authentication_type: Symbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, products: T::Array[String], request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) @@ -32,7 +32,7 @@ module FinchAPI # how the Finch API responds. sig do params( - connection_status: Symbol, + connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) .returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse) diff --git a/rbi/lib/finch-api/resources/sandbox/employment.rbi b/rbi/lib/finch-api/resources/sandbox/employment.rbi index 369aa1d6..b64a60aa 100644 --- a/rbi/lib/finch-api/resources/sandbox/employment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/employment.rbi @@ -12,7 +12,7 @@ module FinchAPI custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department), employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment), - employment_status: T.nilable(Symbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(FinchAPI::Models::Income), diff --git a/rbi/lib/finch-api/resources/sandbox/individual.rbi b/rbi/lib/finch-api/resources/sandbox/individual.rbi index 85fe369a..42976298 100644 --- a/rbi/lib/finch-api/resources/sandbox/individual.rbi +++ b/rbi/lib/finch-api/resources/sandbox/individual.rbi @@ -11,9 +11,9 @@ module FinchAPI dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(Symbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol), first_name: T.nilable(String), - gender: T.nilable(Symbol), + gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)]), diff --git a/rbi/lib/finch-api/resources/sandbox/jobs.rbi b/rbi/lib/finch-api/resources/sandbox/jobs.rbi index 7a860120..50c98672 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs.rbi @@ -11,7 +11,7 @@ module FinchAPI # Enqueue a new sandbox job sig do params( - type: Symbol, + type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) .returns(FinchAPI::Models::Sandbox::JobCreateResponse) diff --git a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi index 21950f6f..6b905516 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi @@ -16,8 +16,8 @@ module FinchAPI # Update configurations for sandbox jobs sig do params( - completion_status: Symbol, - type: Symbol, + completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol, + type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol, request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) ) .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration) diff --git a/sig/finch-api/base_model.rbs b/sig/finch-api/base_model.rbs index 1545aef4..1844dafe 100644 --- a/sig/finch-api/base_model.rbs +++ b/sig/finch-api/base_model.rbs @@ -62,28 +62,28 @@ module FinchAPI ) -> ([true, top, nil] | [false, bool, Integer]) end - class Enum - extend FinchAPI::Converter + module Enum + include FinchAPI::Converter def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)] private def self.finalize!: -> void - def self.===: (top other) -> bool + def ===: (top other) -> bool - def self.==: (top other) -> bool + def ==: (top other) -> bool - def self.coerce: (String | Symbol | top value) -> (Symbol | top) + def coerce: (String | Symbol | top value) -> (Symbol | top) - def self.dump: (Symbol | top value) -> (Symbol | top) + def dump: (Symbol | top value) -> (Symbol | top) - def self.try_strict_coerce: ( + def try_strict_coerce: ( top value ) -> ([true, top, nil] | [false, bool, Integer]) end - class Union - extend FinchAPI::Converter + module Union + include FinchAPI::Converter private def self.known_variants: -> ::Array[[Symbol?, (^-> FinchAPI::Converter::input)]] @@ -105,15 +105,15 @@ module FinchAPI private def self.resolve_variant: (top value) -> FinchAPI::Converter::input? - def self.===: (top other) -> bool + def ===: (top other) -> bool - def self.==: (top other) -> bool + def ==: (top other) -> bool - def self.coerce: (top value) -> top + def coerce: (top value) -> top - def self.dump: (top value) -> top + def dump: (top value) -> top - def self.try_strict_coerce: ( + def try_strict_coerce: ( top value ) -> ([true, top, nil] | [false, bool, Integer]) end diff --git a/sig/finch-api/models/account_update_event.rbs b/sig/finch-api/models/account_update_event.rbs index 40a0d08b..a959e597 100644 --- a/sig/finch-api/models/account_update_event.rbs +++ b/sig/finch-api/models/account_update_event.rbs @@ -1263,7 +1263,9 @@ module FinchAPI type type_ = :assisted | :credential | :api_token | :api_credential | :oauth - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + ASSISTED: :assisted CREDENTIAL: :credential API_TOKEN: :api_token @@ -1277,7 +1279,9 @@ module FinchAPI type event_type = :"account.updated" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + ACCOUNT_UPDATED: :"account.updated" def self.values: -> ::Array[FinchAPI::Models::AccountUpdateEvent::event_type] diff --git a/sig/finch-api/models/company_event.rbs b/sig/finch-api/models/company_event.rbs index 0962e2ae..7802c4a0 100644 --- a/sig/finch-api/models/company_event.rbs +++ b/sig/finch-api/models/company_event.rbs @@ -26,7 +26,9 @@ module FinchAPI type event_type = :"company.updated" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + COMPANY_UPDATED: :"company.updated" def self.values: -> ::Array[FinchAPI::Models::CompanyEvent::event_type] diff --git a/sig/finch-api/models/connect/session_new_params.rbs b/sig/finch-api/models/connect/session_new_params.rbs index b85ec28e..e437aa22 100644 --- a/sig/finch-api/models/connect/session_new_params.rbs +++ b/sig/finch-api/models/connect/session_new_params.rbs @@ -62,7 +62,9 @@ module FinchAPI | :benefits | :ssn - class Product < FinchAPI::Enum + module Product + extend FinchAPI::Enum + COMPANY: :company DIRECTORY: :directory INDIVIDUAL: :individual @@ -95,7 +97,9 @@ module FinchAPI type auth_method = :assisted | :credential | :oauth | :api_token - class AuthMethod < FinchAPI::Enum + module AuthMethod + extend FinchAPI::Enum + ASSISTED: :assisted CREDENTIAL: :credential OAUTH: :oauth @@ -107,7 +111,9 @@ module FinchAPI type sandbox = :finch | :provider - class Sandbox < FinchAPI::Enum + module Sandbox + extend FinchAPI::Enum + FINCH: :finch PROVIDER: :provider diff --git a/sig/finch-api/models/connect/session_reauthenticate_params.rbs b/sig/finch-api/models/connect/session_reauthenticate_params.rbs index d30841e1..4b67b058 100644 --- a/sig/finch-api/models/connect/session_reauthenticate_params.rbs +++ b/sig/finch-api/models/connect/session_reauthenticate_params.rbs @@ -42,7 +42,9 @@ module FinchAPI | :benefits | :ssn - class Product < FinchAPI::Enum + module Product + extend FinchAPI::Enum + COMPANY: :company DIRECTORY: :directory INDIVIDUAL: :individual diff --git a/sig/finch-api/models/connection_status_type.rbs b/sig/finch-api/models/connection_status_type.rbs index 61e10a78..3b179ccd 100644 --- a/sig/finch-api/models/connection_status_type.rbs +++ b/sig/finch-api/models/connection_status_type.rbs @@ -8,7 +8,9 @@ module FinchAPI | :error_permissions | :reauth - class ConnectionStatusType < FinchAPI::Enum + module ConnectionStatusType + extend FinchAPI::Enum + PENDING: :pending PROCESSING: :processing CONNECTED: :connected diff --git a/sig/finch-api/models/create_access_token_response.rbs b/sig/finch-api/models/create_access_token_response.rbs index b3814aeb..a8328b2b 100644 --- a/sig/finch-api/models/create_access_token_response.rbs +++ b/sig/finch-api/models/create_access_token_response.rbs @@ -54,7 +54,9 @@ module FinchAPI type client_type = :production | :development | :sandbox - class ClientType < FinchAPI::Enum + module ClientType + extend FinchAPI::Enum + PRODUCTION: :production DEVELOPMENT: :development SANDBOX: :sandbox @@ -64,7 +66,9 @@ module FinchAPI type connection_type = :provider | :finch - class ConnectionType < FinchAPI::Enum + module ConnectionType + extend FinchAPI::Enum + PROVIDER: :provider FINCH: :finch diff --git a/sig/finch-api/models/directory_event.rbs b/sig/finch-api/models/directory_event.rbs index 6da280ef..e66d5717 100644 --- a/sig/finch-api/models/directory_event.rbs +++ b/sig/finch-api/models/directory_event.rbs @@ -41,7 +41,9 @@ module FinchAPI type event_type = :"directory.created" | :"directory.updated" | :"directory.deleted" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + DIRECTORY_CREATED: :"directory.created" DIRECTORY_UPDATED: :"directory.updated" DIRECTORY_DELETED: :"directory.deleted" diff --git a/sig/finch-api/models/employment_event.rbs b/sig/finch-api/models/employment_event.rbs index 2b965b48..d711d2a4 100644 --- a/sig/finch-api/models/employment_event.rbs +++ b/sig/finch-api/models/employment_event.rbs @@ -41,7 +41,9 @@ module FinchAPI type event_type = :"employment.created" | :"employment.updated" | :"employment.deleted" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + EMPLOYMENT_CREATED: :"employment.created" EMPLOYMENT_UPDATED: :"employment.updated" EMPLOYMENT_DELETED: :"employment.deleted" diff --git a/sig/finch-api/models/hris/benefit_contribution.rbs b/sig/finch-api/models/hris/benefit_contribution.rbs index f3b2de17..8a32db2e 100644 --- a/sig/finch-api/models/hris/benefit_contribution.rbs +++ b/sig/finch-api/models/hris/benefit_contribution.rbs @@ -21,7 +21,9 @@ module FinchAPI type type_ = :fixed | :percent - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + FIXED: :fixed PERCENT: :percent diff --git a/sig/finch-api/models/hris/benefit_features_and_operations.rbs b/sig/finch-api/models/hris/benefit_features_and_operations.rbs index c67fe10f..715df403 100644 --- a/sig/finch-api/models/hris/benefit_features_and_operations.rbs +++ b/sig/finch-api/models/hris/benefit_features_and_operations.rbs @@ -71,7 +71,9 @@ module FinchAPI type company_contribution = :fixed | :percent - class CompanyContribution < FinchAPI::Enum + module CompanyContribution + extend FinchAPI::Enum + FIXED: :fixed PERCENT: :percent @@ -80,7 +82,9 @@ module FinchAPI type employee_deduction = :fixed | :percent - class EmployeeDeduction < FinchAPI::Enum + module EmployeeDeduction + extend FinchAPI::Enum + FIXED: :fixed PERCENT: :percent @@ -89,7 +93,9 @@ module FinchAPI type hsa_contribution_limit = :individual | :family - class HsaContributionLimit < FinchAPI::Enum + module HsaContributionLimit + extend FinchAPI::Enum + INDIVIDUAL: :individual FAMILY: :family diff --git a/sig/finch-api/models/hris/benefit_frequency.rbs b/sig/finch-api/models/hris/benefit_frequency.rbs index 9e9b73df..4366ba53 100644 --- a/sig/finch-api/models/hris/benefit_frequency.rbs +++ b/sig/finch-api/models/hris/benefit_frequency.rbs @@ -3,7 +3,9 @@ module FinchAPI module HRIS type benefit_frequency = :one_time | :every_paycheck | :monthly - class BenefitFrequency < FinchAPI::Enum + module BenefitFrequency + extend FinchAPI::Enum + ONE_TIME: :one_time EVERY_PAYCHECK: :every_paycheck MONTHLY: :monthly diff --git a/sig/finch-api/models/hris/benefit_type.rbs b/sig/finch-api/models/hris/benefit_type.rbs index 4040241c..a99d027d 100644 --- a/sig/finch-api/models/hris/benefit_type.rbs +++ b/sig/finch-api/models/hris/benefit_type.rbs @@ -22,7 +22,9 @@ module FinchAPI | :custom_post_tax | :custom_pre_tax - class BenefitType < FinchAPI::Enum + module BenefitType + extend FinchAPI::Enum + NUMBER_401K: :"401k" NUMBER_401K_ROTH: :"401k_roth" NUMBER_401K_LOAN: :"401k_loan" diff --git a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs index f3ba2533..5270850c 100644 --- a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +++ b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs @@ -54,7 +54,9 @@ module FinchAPI type code = 200 | 201 | 404 | 403 - class Code < FinchAPI::Enum + module Code + extend FinchAPI::Enum + OK: 200 CREATED: 201 NOT_FOUND: 404 diff --git a/sig/finch-api/models/hris/benefits/individual_benefit.rbs b/sig/finch-api/models/hris/benefits/individual_benefit.rbs index 468a1942..164a78d8 100644 --- a/sig/finch-api/models/hris/benefits/individual_benefit.rbs +++ b/sig/finch-api/models/hris/benefits/individual_benefit.rbs @@ -1,7 +1,6 @@ module FinchAPI module Models module HRIS - class IndividualBenefit = Benefits::IndividualBenefit module Benefits @@ -67,7 +66,9 @@ module FinchAPI type hsa_contribution_limit = :individual | :family - class HsaContributionLimit < FinchAPI::Enum + module HsaContributionLimit + extend FinchAPI::Enum + INDIVIDUAL: :individual FAMILY: :family diff --git a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs index dafbccb0..d47847f1 100644 --- a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs @@ -95,7 +95,9 @@ module FinchAPI type annual_contribution_limit = :individual | :family - class AnnualContributionLimit < FinchAPI::Enum + module AnnualContributionLimit + extend FinchAPI::Enum + INDIVIDUAL: :individual FAMILY: :family @@ -128,7 +130,9 @@ module FinchAPI type type_ = :fixed | :percent - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + FIXED: :fixed PERCENT: :percent @@ -162,7 +166,9 @@ module FinchAPI type type_ = :fixed | :percent - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + FIXED: :fixed PERCENT: :percent diff --git a/sig/finch-api/models/hris/benfit_contribution.rbs b/sig/finch-api/models/hris/benfit_contribution.rbs index 7a2dac1c..429686d0 100644 --- a/sig/finch-api/models/hris/benfit_contribution.rbs +++ b/sig/finch-api/models/hris/benfit_contribution.rbs @@ -1,7 +1,6 @@ module FinchAPI module Models module HRIS - class BenfitContribution = FinchAPI::Models::HRIS::BenefitContribution end end diff --git a/sig/finch-api/models/hris/company.rbs b/sig/finch-api/models/hris/company.rbs index 0d2961ed..20488e62 100644 --- a/sig/finch-api/models/hris/company.rbs +++ b/sig/finch-api/models/hris/company.rbs @@ -79,7 +79,9 @@ module FinchAPI type account_type = :checking | :savings - class AccountType < FinchAPI::Enum + module AccountType + extend FinchAPI::Enum + CHECKING: :checking SAVINGS: :savings @@ -136,7 +138,9 @@ module FinchAPI type subtype = :s_corporation | :c_corporation | :b_corporation - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + S_CORPORATION: :s_corporation C_CORPORATION: :c_corporation B_CORPORATION: :b_corporation @@ -153,7 +157,9 @@ module FinchAPI | :partnership | :cooperative - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + LLC: :llc LP: :lp CORPORATION: :corporation diff --git a/sig/finch-api/models/hris/document_list_params.rbs b/sig/finch-api/models/hris/document_list_params.rbs index 014c6dcd..e6fc3393 100644 --- a/sig/finch-api/models/hris/document_list_params.rbs +++ b/sig/finch-api/models/hris/document_list_params.rbs @@ -44,7 +44,9 @@ module FinchAPI type type_ = :w4_2020 | :w4_2005 - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2020: :w4_2020 W4_2005: :w4_2005 diff --git a/sig/finch-api/models/hris/document_response.rbs b/sig/finch-api/models/hris/document_response.rbs index 83d8fcf8..a3fa4305 100644 --- a/sig/finch-api/models/hris/document_response.rbs +++ b/sig/finch-api/models/hris/document_response.rbs @@ -41,7 +41,9 @@ module FinchAPI type type_ = :w4_2020 | :w4_2005 - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2020: :w4_2020 W4_2005: :w4_2005 diff --git a/sig/finch-api/models/hris/document_retreive_response.rbs b/sig/finch-api/models/hris/document_retreive_response.rbs index 66ffdfae..aa8ef7c9 100644 --- a/sig/finch-api/models/hris/document_retreive_response.rbs +++ b/sig/finch-api/models/hris/document_retreive_response.rbs @@ -4,7 +4,9 @@ module FinchAPI type document_retreive_response = FinchAPI::Models::HRIS::W42020 | FinchAPI::Models::HRIS::W42005 - class DocumentRetreiveResponse < FinchAPI::Union + module DocumentRetreiveResponse + extend FinchAPI::Union + def self.variants: -> [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005] end end diff --git a/sig/finch-api/models/hris/employment_data.rbs b/sig/finch-api/models/hris/employment_data.rbs index 693700db..73eb4462 100644 --- a/sig/finch-api/models/hris/employment_data.rbs +++ b/sig/finch-api/models/hris/employment_data.rbs @@ -145,7 +145,9 @@ module FinchAPI | :seasonal | :individual_contractor - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME: :full_time INTERN: :intern PART_TIME: :part_time @@ -158,7 +160,9 @@ module FinchAPI type type_ = :employee | :contractor - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE: :employee CONTRACTOR: :contractor @@ -175,7 +179,9 @@ module FinchAPI | :retired | :terminated - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE: :active DECEASED: :deceased LEAVE: :leave diff --git a/sig/finch-api/models/hris/individual.rbs b/sig/finch-api/models/hris/individual.rbs index 8c211390..25696b2e 100644 --- a/sig/finch-api/models/hris/individual.rbs +++ b/sig/finch-api/models/hris/individual.rbs @@ -87,7 +87,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal @@ -105,7 +107,9 @@ module FinchAPI | :two_or_more_races | :decline_to_specify - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN: :asian WHITE: :white BLACK_OR_AFRICAN_AMERICAN: :black_or_african_american @@ -120,7 +124,9 @@ module FinchAPI type gender = :female | :male | :other | :decline_to_specify - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE: :female MALE: :male OTHER: :other @@ -149,7 +155,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal diff --git a/sig/finch-api/models/hris/pay_statement.rbs b/sig/finch-api/models/hris/pay_statement.rbs index 535bd05c..eba6727d 100644 --- a/sig/finch-api/models/hris/pay_statement.rbs +++ b/sig/finch-api/models/hris/pay_statement.rbs @@ -133,7 +133,9 @@ module FinchAPI | :"1099" | :other - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + SALARY: :salary WAGE: :wage REIMBURSEMENT: :reimbursement @@ -282,7 +284,9 @@ module FinchAPI type payment_method = :check | :direct_deposit - class PaymentMethod < FinchAPI::Enum + module PaymentMethod + extend FinchAPI::Enum + CHECK: :check DIRECT_DEPOSIT: :direct_deposit @@ -356,7 +360,9 @@ module FinchAPI type type_ = :state | :federal | :local | :fica - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + STATE: :state FEDERAL: :federal LOCAL: :local @@ -368,7 +374,9 @@ module FinchAPI type type_ = :regular_payroll | :off_cycle_payroll | :one_time_payment - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + REGULAR_PAYROLL: :regular_payroll OFF_CYCLE_PAYROLL: :off_cycle_payroll ONE_TIME_PAYMENT: :one_time_payment diff --git a/sig/finch-api/models/hris/payment.rbs b/sig/finch-api/models/hris/payment.rbs index a683248f..b0f586c8 100644 --- a/sig/finch-api/models/hris/payment.rbs +++ b/sig/finch-api/models/hris/payment.rbs @@ -72,7 +72,9 @@ module FinchAPI | :daily | :other - class PayFrequency < FinchAPI::Enum + module PayFrequency + extend FinchAPI::Enum + ANNUALLY: :annually SEMI_ANNUALLY: :semi_annually QUARTERLY: :quarterly diff --git a/sig/finch-api/models/hris/supported_benefit.rbs b/sig/finch-api/models/hris/supported_benefit.rbs index 50edc296..56a3a315 100644 --- a/sig/finch-api/models/hris/supported_benefit.rbs +++ b/sig/finch-api/models/hris/supported_benefit.rbs @@ -49,7 +49,9 @@ module FinchAPI type company_contribution = :fixed | :percent - class CompanyContribution < FinchAPI::Enum + module CompanyContribution + extend FinchAPI::Enum + FIXED: :fixed PERCENT: :percent @@ -58,7 +60,9 @@ module FinchAPI type employee_deduction = :fixed | :percent - class EmployeeDeduction < FinchAPI::Enum + module EmployeeDeduction + extend FinchAPI::Enum + FIXED: :fixed PERCENT: :percent @@ -67,7 +71,9 @@ module FinchAPI type hsa_contribution_limit = :individual | :family - class HsaContributionLimit < FinchAPI::Enum + module HsaContributionLimit + extend FinchAPI::Enum + INDIVIDUAL: :individual FAMILY: :family diff --git a/sig/finch-api/models/hris/w42005.rbs b/sig/finch-api/models/hris/w42005.rbs index e7f953b8..88b66bd0 100644 --- a/sig/finch-api/models/hris/w42005.rbs +++ b/sig/finch-api/models/hris/w42005.rbs @@ -73,7 +73,9 @@ module FinchAPI type exemption = :exempt | :non_exempt - class Exemption < FinchAPI::Enum + module Exemption + extend FinchAPI::Enum + EXEMPT: :exempt NON_EXEMPT: :non_exempt @@ -83,7 +85,9 @@ module FinchAPI type filing_status = :married | :married_but_withhold_at_higher_single_rate | :single - class FilingStatus < FinchAPI::Enum + module FilingStatus + extend FinchAPI::Enum + MARRIED: :married MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE: :married_but_withhold_at_higher_single_rate SINGLE: :single @@ -94,7 +98,9 @@ module FinchAPI type type_ = :w4_2005 - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2005: :w4_2005 def self.values: -> ::Array[FinchAPI::Models::HRIS::W42005::type_] diff --git a/sig/finch-api/models/hris/w42020.rbs b/sig/finch-api/models/hris/w42020.rbs index a451a37b..3b29ff29 100644 --- a/sig/finch-api/models/hris/w42020.rbs +++ b/sig/finch-api/models/hris/w42020.rbs @@ -80,7 +80,9 @@ module FinchAPI | :married_filing_jointly_or_qualifying_surviving_spouse | :single_or_married_filing_separately - class FilingStatus < FinchAPI::Enum + module FilingStatus + extend FinchAPI::Enum + HEAD_OF_HOUSEHOLD: :head_of_household MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE: :married_filing_jointly_or_qualifying_surviving_spouse SINGLE_OR_MARRIED_FILING_SEPARATELY: :single_or_married_filing_separately @@ -91,7 +93,9 @@ module FinchAPI type type_ = :w4_2020 - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_2020: :w4_2020 def self.values: -> ::Array[FinchAPI::Models::HRIS::W42020::type_] diff --git a/sig/finch-api/models/income.rbs b/sig/finch-api/models/income.rbs index 9f9eaf12..47717713 100644 --- a/sig/finch-api/models/income.rbs +++ b/sig/finch-api/models/income.rbs @@ -37,7 +37,9 @@ module FinchAPI | :hourly | :fixed - class Unit < FinchAPI::Enum + module Unit + extend FinchAPI::Enum + YEARLY: :yearly QUARTERLY: :quarterly MONTHLY: :monthly diff --git a/sig/finch-api/models/individual_event.rbs b/sig/finch-api/models/individual_event.rbs index d9e5abc6..50148324 100644 --- a/sig/finch-api/models/individual_event.rbs +++ b/sig/finch-api/models/individual_event.rbs @@ -41,7 +41,9 @@ module FinchAPI type event_type = :"individual.created" | :"individual.updated" | :"individual.deleted" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + INDIVIDUAL_CREATED: :"individual.created" INDIVIDUAL_UPDATED: :"individual.updated" INDIVIDUAL_DELETED: :"individual.deleted" diff --git a/sig/finch-api/models/introspection.rbs b/sig/finch-api/models/introspection.rbs index 974492c4..2460af9d 100644 --- a/sig/finch-api/models/introspection.rbs +++ b/sig/finch-api/models/introspection.rbs @@ -131,7 +131,9 @@ module FinchAPI type type_ = :assisted | :credential | :api_token | :api_credential | :oauth - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + ASSISTED: :assisted CREDENTIAL: :credential API_TOKEN: :api_token @@ -144,7 +146,9 @@ module FinchAPI type client_type = :production | :development | :sandbox - class ClientType < FinchAPI::Enum + module ClientType + extend FinchAPI::Enum + PRODUCTION: :production DEVELOPMENT: :development SANDBOX: :sandbox @@ -176,7 +180,9 @@ module FinchAPI type connection_type = :provider | :finch - class ConnectionType < FinchAPI::Enum + module ConnectionType + extend FinchAPI::Enum + PROVIDER: :provider FINCH: :finch diff --git a/sig/finch-api/models/job_completion_event.rbs b/sig/finch-api/models/job_completion_event.rbs index 2ef9c5c9..695d9353 100644 --- a/sig/finch-api/models/job_completion_event.rbs +++ b/sig/finch-api/models/job_completion_event.rbs @@ -46,7 +46,9 @@ module FinchAPI | :"job.benefit_update.completed" | :"job.data_sync_all.completed" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + JOB_BENEFIT_CREATE_COMPLETED: :"job.benefit_create.completed" JOB_BENEFIT_ENROLL_COMPLETED: :"job.benefit_enroll.completed" JOB_BENEFIT_REGISTER_COMPLETED: :"job.benefit_register.completed" diff --git a/sig/finch-api/models/jobs/automated_async_job.rbs b/sig/finch-api/models/jobs/automated_async_job.rbs index 96bfd9ca..20a5d1e9 100644 --- a/sig/finch-api/models/jobs/automated_async_job.rbs +++ b/sig/finch-api/models/jobs/automated_async_job.rbs @@ -67,7 +67,9 @@ module FinchAPI | :reauth_error | :permissions_error - class Status < FinchAPI::Enum + module Status + extend FinchAPI::Enum + PENDING: :pending IN_PROGRESS: :in_progress COMPLETE: :complete @@ -80,7 +82,9 @@ module FinchAPI type type_ = :data_sync_all | :w4_form_employee_sync - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + DATA_SYNC_ALL: :data_sync_all W4_FORM_EMPLOYEE_SYNC: :w4_form_employee_sync diff --git a/sig/finch-api/models/jobs/automated_create_params.rbs b/sig/finch-api/models/jobs/automated_create_params.rbs index 6ad61d01..1ab0b450 100644 --- a/sig/finch-api/models/jobs/automated_create_params.rbs +++ b/sig/finch-api/models/jobs/automated_create_params.rbs @@ -26,7 +26,9 @@ module FinchAPI type type_ = :w4_form_employee_sync - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + W4_FORM_EMPLOYEE_SYNC: :w4_form_employee_sync def self.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::type_] diff --git a/sig/finch-api/models/jobs/manual_async_job.rbs b/sig/finch-api/models/jobs/manual_async_job.rbs index e79cd3e9..a1c171bd 100644 --- a/sig/finch-api/models/jobs/manual_async_job.rbs +++ b/sig/finch-api/models/jobs/manual_async_job.rbs @@ -25,7 +25,9 @@ module FinchAPI type status = :pending | :in_progress | :error | :complete - class Status < FinchAPI::Enum + module Status + extend FinchAPI::Enum + PENDING: :pending IN_PROGRESS: :in_progress ERROR: :error diff --git a/sig/finch-api/models/operation_support.rbs b/sig/finch-api/models/operation_support.rbs index 29596ac6..cfb6b869 100644 --- a/sig/finch-api/models/operation_support.rbs +++ b/sig/finch-api/models/operation_support.rbs @@ -6,7 +6,9 @@ module FinchAPI | :not_supported_by_provider | :client_access_only - class OperationSupport < FinchAPI::Enum + module OperationSupport + extend FinchAPI::Enum + SUPPORTED: :supported NOT_SUPPORTED_BY_FINCH: :not_supported_by_finch NOT_SUPPORTED_BY_PROVIDER: :not_supported_by_provider diff --git a/sig/finch-api/models/pay_statement_event.rbs b/sig/finch-api/models/pay_statement_event.rbs index 270492a6..b827adc2 100644 --- a/sig/finch-api/models/pay_statement_event.rbs +++ b/sig/finch-api/models/pay_statement_event.rbs @@ -47,7 +47,9 @@ module FinchAPI | :"pay_statement.updated" | :"pay_statement.deleted" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + PAY_STATEMENT_CREATED: :"pay_statement.created" PAY_STATEMENT_UPDATED: :"pay_statement.updated" PAY_STATEMENT_DELETED: :"pay_statement.deleted" diff --git a/sig/finch-api/models/payment_event.rbs b/sig/finch-api/models/payment_event.rbs index a923cb27..696dbce2 100644 --- a/sig/finch-api/models/payment_event.rbs +++ b/sig/finch-api/models/payment_event.rbs @@ -41,7 +41,9 @@ module FinchAPI type event_type = :"payment.created" | :"payment.updated" | :"payment.deleted" - class EventType < FinchAPI::Enum + module EventType + extend FinchAPI::Enum + PAYMENT_CREATED: :"payment.created" PAYMENT_UPDATED: :"payment.updated" PAYMENT_DELETED: :"payment.deleted" diff --git a/sig/finch-api/models/payroll/pay_group_list_response.rbs b/sig/finch-api/models/payroll/pay_group_list_response.rbs index f4e28c4c..39183ee5 100644 --- a/sig/finch-api/models/payroll/pay_group_list_response.rbs +++ b/sig/finch-api/models/payroll/pay_group_list_response.rbs @@ -42,7 +42,9 @@ module FinchAPI | :daily | :other - class PayFrequency < FinchAPI::Enum + module PayFrequency + extend FinchAPI::Enum + ANNUALLY: :annually SEMI_ANNUALLY: :semi_annually QUARTERLY: :quarterly diff --git a/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs b/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs index 6eba1511..b88f01c7 100644 --- a/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +++ b/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs @@ -38,7 +38,9 @@ module FinchAPI | :daily | :other - class PayFrequency < FinchAPI::Enum + module PayFrequency + extend FinchAPI::Enum + ANNUALLY: :annually SEMI_ANNUALLY: :semi_annually QUARTERLY: :quarterly diff --git a/sig/finch-api/models/provider.rbs b/sig/finch-api/models/provider.rbs index aa1d904f..a2f4e318 100644 --- a/sig/finch-api/models/provider.rbs +++ b/sig/finch-api/models/provider.rbs @@ -1291,7 +1291,9 @@ module FinchAPI type type_ = :assisted | :credential | :api_token | :api_credential | :oauth - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + ASSISTED: :assisted CREDENTIAL: :credential API_TOKEN: :api_token diff --git a/sig/finch-api/models/sandbox/company_update_params.rbs b/sig/finch-api/models/sandbox/company_update_params.rbs index bb8e374b..5a73c84d 100644 --- a/sig/finch-api/models/sandbox/company_update_params.rbs +++ b/sig/finch-api/models/sandbox/company_update_params.rbs @@ -80,7 +80,9 @@ module FinchAPI type account_type = :checking | :savings - class AccountType < FinchAPI::Enum + module AccountType + extend FinchAPI::Enum + CHECKING: :checking SAVINGS: :savings @@ -137,7 +139,9 @@ module FinchAPI type subtype = :s_corporation | :c_corporation | :b_corporation - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + S_CORPORATION: :s_corporation C_CORPORATION: :c_corporation B_CORPORATION: :b_corporation @@ -154,7 +158,9 @@ module FinchAPI | :partnership | :cooperative - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + LLC: :llc LP: :lp CORPORATION: :corporation diff --git a/sig/finch-api/models/sandbox/company_update_response.rbs b/sig/finch-api/models/sandbox/company_update_response.rbs index f93a20e4..74fb906f 100644 --- a/sig/finch-api/models/sandbox/company_update_response.rbs +++ b/sig/finch-api/models/sandbox/company_update_response.rbs @@ -75,7 +75,9 @@ module FinchAPI type account_type = :checking | :savings - class AccountType < FinchAPI::Enum + module AccountType + extend FinchAPI::Enum + CHECKING: :checking SAVINGS: :savings @@ -132,7 +134,9 @@ module FinchAPI type subtype = :s_corporation | :c_corporation | :b_corporation - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + S_CORPORATION: :s_corporation C_CORPORATION: :c_corporation B_CORPORATION: :b_corporation @@ -149,7 +153,9 @@ module FinchAPI | :partnership | :cooperative - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + LLC: :llc LP: :lp CORPORATION: :corporation diff --git a/sig/finch-api/models/sandbox/connection_create_params.rbs b/sig/finch-api/models/sandbox/connection_create_params.rbs index 5c2e29fc..aa58a901 100644 --- a/sig/finch-api/models/sandbox/connection_create_params.rbs +++ b/sig/finch-api/models/sandbox/connection_create_params.rbs @@ -42,7 +42,9 @@ module FinchAPI type authentication_type = :credential | :api_token | :oauth | :assisted - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL: :credential API_TOKEN: :api_token OAUTH: :oauth diff --git a/sig/finch-api/models/sandbox/connection_create_response.rbs b/sig/finch-api/models/sandbox/connection_create_response.rbs index 9f366382..db346f93 100644 --- a/sig/finch-api/models/sandbox/connection_create_response.rbs +++ b/sig/finch-api/models/sandbox/connection_create_response.rbs @@ -47,7 +47,9 @@ module FinchAPI type authentication_type = :credential | :api_token | :oauth | :assisted - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL: :credential API_TOKEN: :api_token OAUTH: :oauth diff --git a/sig/finch-api/models/sandbox/connections/account_create_params.rbs b/sig/finch-api/models/sandbox/connections/account_create_params.rbs index 6e4b80ac..a659744e 100644 --- a/sig/finch-api/models/sandbox/connections/account_create_params.rbs +++ b/sig/finch-api/models/sandbox/connections/account_create_params.rbs @@ -42,7 +42,9 @@ module FinchAPI type authentication_type = :credential | :api_token | :oauth | :assisted - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL: :credential API_TOKEN: :api_token OAUTH: :oauth diff --git a/sig/finch-api/models/sandbox/connections/account_create_response.rbs b/sig/finch-api/models/sandbox/connections/account_create_response.rbs index 25dd5737..f561e9b8 100644 --- a/sig/finch-api/models/sandbox/connections/account_create_response.rbs +++ b/sig/finch-api/models/sandbox/connections/account_create_response.rbs @@ -43,7 +43,9 @@ module FinchAPI type authentication_type = :credential | :api_token | :oauth | :assisted - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL: :credential API_TOKEN: :api_token OAUTH: :oauth diff --git a/sig/finch-api/models/sandbox/connections/account_update_response.rbs b/sig/finch-api/models/sandbox/connections/account_update_response.rbs index cbefea3c..f576c5ea 100644 --- a/sig/finch-api/models/sandbox/connections/account_update_response.rbs +++ b/sig/finch-api/models/sandbox/connections/account_update_response.rbs @@ -41,7 +41,9 @@ module FinchAPI type authentication_type = :credential | :api_token | :oauth | :assisted - class AuthenticationType < FinchAPI::Enum + module AuthenticationType + extend FinchAPI::Enum + CREDENTIAL: :credential API_TOKEN: :api_token OAUTH: :oauth diff --git a/sig/finch-api/models/sandbox/directory_create_params.rbs b/sig/finch-api/models/sandbox/directory_create_params.rbs index b8d72743..d04319ef 100644 --- a/sig/finch-api/models/sandbox/directory_create_params.rbs +++ b/sig/finch-api/models/sandbox/directory_create_params.rbs @@ -194,7 +194,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal @@ -228,7 +230,9 @@ module FinchAPI | :seasonal | :individual_contractor - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME: :full_time INTERN: :intern PART_TIME: :part_time @@ -241,7 +245,9 @@ module FinchAPI type type_ = :employee | :contractor - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE: :employee CONTRACTOR: :contractor @@ -258,7 +264,9 @@ module FinchAPI | :retired | :terminated - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE: :active DECEASED: :deceased LEAVE: :leave @@ -280,7 +288,9 @@ module FinchAPI | :two_or_more_races | :decline_to_specify - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN: :asian WHITE: :white BLACK_OR_AFRICAN_AMERICAN: :black_or_african_american @@ -295,7 +305,9 @@ module FinchAPI type gender = :female | :male | :other | :decline_to_specify - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE: :female MALE: :male OTHER: :other @@ -338,7 +350,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal diff --git a/sig/finch-api/models/sandbox/employment_update_params.rbs b/sig/finch-api/models/sandbox/employment_update_params.rbs index 33d940ee..51da85e3 100644 --- a/sig/finch-api/models/sandbox/employment_update_params.rbs +++ b/sig/finch-api/models/sandbox/employment_update_params.rbs @@ -144,7 +144,9 @@ module FinchAPI | :seasonal | :individual_contractor - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME: :full_time INTERN: :intern PART_TIME: :part_time @@ -157,7 +159,9 @@ module FinchAPI type type_ = :employee | :contractor - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE: :employee CONTRACTOR: :contractor @@ -174,7 +178,9 @@ module FinchAPI | :retired | :terminated - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE: :active DECEASED: :deceased LEAVE: :leave diff --git a/sig/finch-api/models/sandbox/employment_update_response.rbs b/sig/finch-api/models/sandbox/employment_update_response.rbs index 21ee4af4..531b95df 100644 --- a/sig/finch-api/models/sandbox/employment_update_response.rbs +++ b/sig/finch-api/models/sandbox/employment_update_response.rbs @@ -145,7 +145,9 @@ module FinchAPI | :seasonal | :individual_contractor - class Subtype < FinchAPI::Enum + module Subtype + extend FinchAPI::Enum + FULL_TIME: :full_time INTERN: :intern PART_TIME: :part_time @@ -158,7 +160,9 @@ module FinchAPI type type_ = :employee | :contractor - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + EMPLOYEE: :employee CONTRACTOR: :contractor @@ -175,7 +179,9 @@ module FinchAPI | :retired | :terminated - class EmploymentStatus < FinchAPI::Enum + module EmploymentStatus + extend FinchAPI::Enum + ACTIVE: :active DECEASED: :deceased LEAVE: :leave diff --git a/sig/finch-api/models/sandbox/individual_update_params.rbs b/sig/finch-api/models/sandbox/individual_update_params.rbs index d7b78d9d..3a932830 100644 --- a/sig/finch-api/models/sandbox/individual_update_params.rbs +++ b/sig/finch-api/models/sandbox/individual_update_params.rbs @@ -86,7 +86,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal @@ -104,7 +106,9 @@ module FinchAPI | :two_or_more_races | :decline_to_specify - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN: :asian WHITE: :white BLACK_OR_AFRICAN_AMERICAN: :black_or_african_american @@ -119,7 +123,9 @@ module FinchAPI type gender = :female | :male | :other | :decline_to_specify - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE: :female MALE: :male OTHER: :other @@ -150,7 +156,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal diff --git a/sig/finch-api/models/sandbox/individual_update_response.rbs b/sig/finch-api/models/sandbox/individual_update_response.rbs index 1d6238f8..fe0c5cb1 100644 --- a/sig/finch-api/models/sandbox/individual_update_response.rbs +++ b/sig/finch-api/models/sandbox/individual_update_response.rbs @@ -87,7 +87,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal @@ -105,7 +107,9 @@ module FinchAPI | :two_or_more_races | :decline_to_specify - class Ethnicity < FinchAPI::Enum + module Ethnicity + extend FinchAPI::Enum + ASIAN: :asian WHITE: :white BLACK_OR_AFRICAN_AMERICAN: :black_or_african_american @@ -120,7 +124,9 @@ module FinchAPI type gender = :female | :male | :other | :decline_to_specify - class Gender < FinchAPI::Enum + module Gender + extend FinchAPI::Enum + FEMALE: :female MALE: :male OTHER: :other @@ -151,7 +157,9 @@ module FinchAPI type type_ = :work | :personal - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + WORK: :work PERSONAL: :personal diff --git a/sig/finch-api/models/sandbox/job_create_params.rbs b/sig/finch-api/models/sandbox/job_create_params.rbs index 20b73651..7a2a7cae 100644 --- a/sig/finch-api/models/sandbox/job_create_params.rbs +++ b/sig/finch-api/models/sandbox/job_create_params.rbs @@ -20,7 +20,9 @@ module FinchAPI type type_ = :data_sync_all - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + DATA_SYNC_ALL: :data_sync_all def self.values: -> ::Array[FinchAPI::Models::Sandbox::JobCreateParams::type_] diff --git a/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs b/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs index 9870049d..03612e27 100644 --- a/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +++ b/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs @@ -23,7 +23,9 @@ module FinchAPI type completion_status = :complete | :reauth_error | :permissions_error | :error - class CompletionStatus < FinchAPI::Enum + module CompletionStatus + extend FinchAPI::Enum + COMPLETE: :complete REAUTH_ERROR: :reauth_error PERMISSIONS_ERROR: :permissions_error @@ -34,7 +36,9 @@ module FinchAPI type type_ = :data_sync_all - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + DATA_SYNC_ALL: :data_sync_all def self.values: -> ::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_] diff --git a/sig/finch-api/models/sandbox/payment_create_params.rbs b/sig/finch-api/models/sandbox/payment_create_params.rbs index b76ef5c6..c5bb3fa1 100644 --- a/sig/finch-api/models/sandbox/payment_create_params.rbs +++ b/sig/finch-api/models/sandbox/payment_create_params.rbs @@ -168,7 +168,9 @@ module FinchAPI | :"1099" | :other - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + SALARY: :salary WAGE: :wage REIMBURSEMENT: :reimbursement @@ -317,7 +319,9 @@ module FinchAPI type payment_method = :check | :direct_deposit - class PaymentMethod < FinchAPI::Enum + module PaymentMethod + extend FinchAPI::Enum + CHECK: :check DIRECT_DEPOSIT: :direct_deposit @@ -391,7 +395,9 @@ module FinchAPI type type_ = :state | :federal | :local | :fica - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + STATE: :state FEDERAL: :federal LOCAL: :local @@ -403,7 +409,9 @@ module FinchAPI type type_ = :regular_payroll | :off_cycle_payroll | :one_time_payment - class Type < FinchAPI::Enum + module Type + extend FinchAPI::Enum + REGULAR_PAYROLL: :regular_payroll OFF_CYCLE_PAYROLL: :off_cycle_payroll ONE_TIME_PAYMENT: :one_time_payment diff --git a/sig/finch-api/models/webhook_event.rbs b/sig/finch-api/models/webhook_event.rbs index b52eb4c4..0a2d0587 100644 --- a/sig/finch-api/models/webhook_event.rbs +++ b/sig/finch-api/models/webhook_event.rbs @@ -10,7 +10,9 @@ module FinchAPI | FinchAPI::Models::PaymentEvent | FinchAPI::Models::PayStatementEvent - class WebhookEvent < FinchAPI::Union + module WebhookEvent + extend FinchAPI::Union + def self.variants: -> [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] end end diff --git a/test/finch-api/base_model_test.rb b/test/finch-api/base_model_test.rb index 79633c7a..53ea4094 100644 --- a/test/finch-api/base_model_test.rb +++ b/test/finch-api/base_model_test.rb @@ -3,7 +3,9 @@ require_relative "test_helper" class FinchAPI::Test::BaseModelTest < Minitest::Test - class E1 < FinchAPI::Enum + module E1 + extend FinchAPI::Enum + A = :a B = :b end @@ -242,13 +244,17 @@ class M3 < M1 optional :b, E1, api_name: :renamed_again end - class U1 < FinchAPI::Union + module U1 + extend FinchAPI::Union + discriminator :type variant :a, M1 variant :b, M3 end - class U2 < FinchAPI::Union + module U2 + extend FinchAPI::Union + variant A1 variant A3 end @@ -330,12 +336,16 @@ def test_basic_const end end - class E2 < FinchAPI::Enum + module E2 + extend FinchAPI::Enum + A = :a B = :b end - class U3 < FinchAPI::Union + module U3 + extend FinchAPI::Union + discriminator :type variant :a, M1 variant :b, M3 @@ -353,7 +363,9 @@ def test_basic_eql assert_equal(U1, U3) end - class U4 < FinchAPI::Union + module U4 + extend FinchAPI::Union + variant :a, const: :a variant :b, const: :b end From a519092120ad92d1ad8bb1fa1cdc18902b3842c4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 20 Mar 2025 22:41:49 +0000 Subject: [PATCH 55/67] chore: `BaseModel` fields that are `BaseModel` typed should also accept `Hash` (#58) --- .../finch-api/models/account_update_event.rbi | 361 +++++++++++++--- .../models/connect/session_new_params.rbi | 8 +- rbi/lib/finch-api/models/directory_event.rbi | 5 +- rbi/lib/finch-api/models/employment_event.rbi | 5 +- .../hris/benefit_features_and_operations.rbi | 12 +- .../hris/benefits/enrolled_individual.rbi | 4 +- .../hris/benefits/individual_benefit.rbi | 12 +- .../individual_enroll_many_params.rbi | 34 +- .../hris/benefits/unenrolled_individual.rbi | 4 +- .../models/hris/benefits_support.rbi | 48 +-- rbi/lib/finch-api/models/hris/company.rbi | 12 +- .../models/hris/document_list_response.rbi | 5 +- .../finch-api/models/hris/employment_data.rbi | 22 +- .../models/hris/employment_data_response.rbi | 5 +- rbi/lib/finch-api/models/hris/individual.rbi | 5 +- .../models/hris/individual_in_directory.rbi | 14 +- .../models/hris/individual_response.rbi | 5 +- .../hris/individual_retrieve_many_params.rbi | 8 +- .../finch-api/models/hris/pay_statement.rbi | 88 +++- .../models/hris/pay_statement_response.rbi | 4 +- .../hris/pay_statement_response_body.rbi | 5 +- rbi/lib/finch-api/models/hris/payment.rbi | 29 +- .../models/hris/support_per_benefit_type.rbi | 10 +- rbi/lib/finch-api/models/hris/w42005.rbi | 5 +- rbi/lib/finch-api/models/hris/w42020.rbi | 5 +- rbi/lib/finch-api/models/individual_event.rbi | 5 +- rbi/lib/finch-api/models/introspection.rbi | 12 +- .../finch-api/models/job_completion_event.rbi | 5 +- .../models/jobs/automated_async_job.rbi | 4 +- .../models/jobs/automated_create_params.rbi | 4 +- .../models/jobs/automated_list_response.rbi | 16 +- .../finch-api/models/pay_statement_event.rbi | 5 +- rbi/lib/finch-api/models/payment_event.rbi | 5 +- rbi/lib/finch-api/models/provider.rbi | 404 +++++++++++++++--- .../request_forwarding_forward_response.rbi | 4 +- .../models/sandbox/company_update_params.rbi | 18 +- .../sandbox/company_update_response.rbi | 20 +- .../sandbox/directory_create_params.rbi | 47 +- .../sandbox/employment_update_params.rbi | 34 +- .../sandbox/employment_update_response.rbi | 34 +- .../sandbox/individual_update_params.rbi | 5 +- .../sandbox/individual_update_response.rbi | 5 +- .../models/sandbox/payment_create_params.rbi | 122 +++++- rbi/lib/finch-api/util.rbi | 2 + 44 files changed, 1160 insertions(+), 306 deletions(-) diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index 63e14b9b..4dc23291 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -7,7 +7,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::AccountUpdateEvent::Data).returns(FinchAPI::Models::AccountUpdateEvent::Data) } + sig do + params(_: T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end @@ -50,8 +53,10 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod) + params( + _: T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Util::AnyHash) + ) + .returns(T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Util::AnyHash)) end def authentication_method=(_) end @@ -97,8 +102,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) end def benefits_support=(_) end @@ -109,8 +114,22 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields)) - .returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields)) + params( + _: T.nilable( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, + FinchAPI::Util::AnyHash + ) + ) + ) + .returns( + T.nilable( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, + FinchAPI::Util::AnyHash + ) + ) + ) end def supported_fields=(_) end @@ -161,8 +180,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company) + params( + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + FinchAPI::Util::AnyHash + ) + ) end def company=(_) end @@ -176,8 +205,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory) + params( + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + FinchAPI::Util::AnyHash + ) + ) end def directory=(_) end @@ -191,8 +230,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment) + params( + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + FinchAPI::Util::AnyHash + ) + ) end def employment=(_) end @@ -206,8 +255,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual) + params( + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + FinchAPI::Util::AnyHash + ) + ) end def individual=(_) end @@ -221,8 +280,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup) + params( + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + FinchAPI::Util::AnyHash + ) + ) end def pay_group=(_) end @@ -236,8 +305,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement) + params( + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + FinchAPI::Util::AnyHash + ) + ) end def pay_statement=(_) end @@ -251,8 +330,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment) + params( + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, + FinchAPI::Util::AnyHash + ) + ) end def payment=(_) end @@ -319,10 +408,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + FinchAPI::Util::AnyHash + ) ) end def accounts=(_) @@ -340,10 +435,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + FinchAPI::Util::AnyHash + ) ) end def departments=(_) @@ -369,10 +470,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + FinchAPI::Util::AnyHash + ) ) end def entity=(_) @@ -398,10 +505,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + FinchAPI::Util::AnyHash + ) ) end def locations=(_) @@ -560,10 +673,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, + FinchAPI::Util::AnyHash + ) ) end def parent=(_) @@ -730,10 +849,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + FinchAPI::Util::AnyHash + ) ) end def individuals=(_) @@ -751,10 +876,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, + FinchAPI::Util::AnyHash + ) ) end def paging=(_) @@ -835,10 +966,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + FinchAPI::Util::AnyHash + ) ) end def manager=(_) @@ -967,10 +1104,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + FinchAPI::Util::AnyHash + ) ) end def department=(_) @@ -988,10 +1131,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, + FinchAPI::Util::AnyHash + ) ) end def employment=(_) @@ -1033,10 +1182,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, + FinchAPI::Util::AnyHash + ) ) end def income=(_) @@ -1078,10 +1233,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + FinchAPI::Util::AnyHash + ) ) end def location=(_) @@ -1099,10 +1260,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, + FinchAPI::Util::AnyHash + ) ) end def manager=(_) @@ -1410,10 +1577,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + FinchAPI::Util::AnyHash + ) ) end def emails=(_) @@ -1479,10 +1652,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + FinchAPI::Util::AnyHash + ) ) end def phone_numbers=(_) @@ -1508,10 +1687,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + FinchAPI::Util::AnyHash + ) ) end def residence=(_) @@ -1787,10 +1972,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + FinchAPI::Util::AnyHash + ) ) end def paging=(_) @@ -1808,10 +1999,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, + FinchAPI::Util::AnyHash + ) ) end def pay_statements=(_) @@ -1878,10 +2075,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + FinchAPI::Util::AnyHash + ) ) end def earnings=(_) @@ -1899,10 +2102,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + FinchAPI::Util::AnyHash + ) ) end def employee_deductions=(_) @@ -1920,10 +2129,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + FinchAPI::Util::AnyHash + ) ) end def employer_contributions=(_) @@ -1973,10 +2188,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + FinchAPI::Util::AnyHash + ) ) end def taxes=(_) @@ -2384,10 +2605,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + _: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, + FinchAPI::Util::AnyHash + ) ) end def pay_period=(_) diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 52a6004b..ad8a01e4 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -47,8 +47,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration)) - .returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration)) + params( + _: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)) + ) end def integration=(_) end diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index 5a664235..fb681e8b 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -7,7 +7,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::DirectoryEvent::Data).returns(FinchAPI::Models::DirectoryEvent::Data) } + sig do + params(_: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index 9646e6f5..1f9bb9f1 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -7,7 +7,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::EmploymentEvent::Data).returns(FinchAPI::Models::EmploymentEvent::Data) } + sig do + params(_: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 013d9453..adef070c 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -9,8 +9,12 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures) - .returns(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures) + params( + _: T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, FinchAPI::Util::AnyHash) + ) + .returns( + T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, FinchAPI::Util::AnyHash) + ) end def supported_features=(_) end @@ -20,8 +24,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::SupportPerBenefitType) - .returns(FinchAPI::Models::HRIS::SupportPerBenefitType) + params(_: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Util::AnyHash)) end def supported_operations=(_) end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index 9063cdfe..568ba9f5 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -10,8 +10,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body) - .returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body) + params(_: T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash)) end def body=(_) end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index c375fca4..a6bdcda1 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -10,8 +10,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body) - .returns(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body) + params(_: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash)) end def body=(_) end @@ -77,8 +77,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) end def company_contribution=(_) end @@ -88,8 +88,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) end def employee_deduction=(_) end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index 5e8cbcd3..1e1fa220 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -52,8 +52,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration) - .returns(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration) + params( + _: T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + FinchAPI::Util::AnyHash + ) + ) end def configuration=(_) end @@ -143,10 +153,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution + _: T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution + T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + FinchAPI::Util::AnyHash + ) ) end def company_contribution=(_) @@ -164,10 +180,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + _: T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, + FinchAPI::Util::AnyHash + ) ) end def employee_deduction=(_) diff --git a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi index 06af9c86..8ec543cd 100644 --- a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi @@ -10,8 +10,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body) - .returns(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body) + params(_: T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash)) end def body=(_) end diff --git a/rbi/lib/finch-api/models/hris/benefits_support.rbi b/rbi/lib/finch-api/models/hris/benefits_support.rbi index ee390de0..59f1e7ab 100644 --- a/rbi/lib/finch-api/models/hris/benefits_support.rbi +++ b/rbi/lib/finch-api/models/hris/benefits_support.rbi @@ -9,8 +9,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def commuter=(_) end @@ -20,8 +20,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def custom_post_tax=(_) end @@ -31,8 +31,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def custom_pre_tax=(_) end @@ -42,8 +42,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def fsa_dependent_care=(_) end @@ -53,8 +53,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def fsa_medical=(_) end @@ -64,8 +64,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def hsa_post=(_) end @@ -75,8 +75,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def hsa_pre=(_) end @@ -86,8 +86,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def s125_dental=(_) end @@ -97,8 +97,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def s125_medical=(_) end @@ -108,8 +108,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def s125_vision=(_) end @@ -119,8 +119,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def simple=(_) end @@ -130,8 +130,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) end def simple_ira=(_) end diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 82dafdac..9b5ae481 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -52,8 +52,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity)) - .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Util::AnyHash))) end def entity=(_) end @@ -249,8 +249,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)) - .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)) + params( + _: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Util::AnyHash)) + ) end def parent=(_) end diff --git a/rbi/lib/finch-api/models/hris/document_list_response.rbi b/rbi/lib/finch-api/models/hris/document_list_response.rbi index 5897ce5c..4ebc3438 100644 --- a/rbi/lib/finch-api/models/hris/document_list_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_response.rbi @@ -19,7 +19,10 @@ module FinchAPI def paging end - sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } + sig do + params(_: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) + end def paging=(_) end diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index 22cc9398..bf7409c0 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -41,8 +41,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department)) - .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Util::AnyHash))) end def department=(_) end @@ -53,8 +53,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment)) - .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Util::AnyHash))) end def employment=(_) end @@ -96,7 +96,10 @@ module FinchAPI def income end - sig { params(_: T.nilable(FinchAPI::Models::Income)).returns(T.nilable(FinchAPI::Models::Income)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + end def income=(_) end @@ -142,7 +145,10 @@ module FinchAPI def location end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def location=(_) end @@ -152,8 +158,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Manager)) - .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Manager)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Util::AnyHash))) end def manager=(_) end diff --git a/rbi/lib/finch-api/models/hris/employment_data_response.rbi b/rbi/lib/finch-api/models/hris/employment_data_response.rbi index c83bf785..90e69d1d 100644 --- a/rbi/lib/finch-api/models/hris/employment_data_response.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data_response.rbi @@ -8,7 +8,10 @@ module FinchAPI def body end - sig { params(_: FinchAPI::Models::HRIS::EmploymentData).returns(FinchAPI::Models::HRIS::EmploymentData) } + sig do + params(_: T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Util::AnyHash)) + end def body=(_) end diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index 1689ae8c..d3a97206 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -118,7 +118,10 @@ module FinchAPI def residence end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def residence=(_) end diff --git a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi index 2b91a06e..eae58828 100644 --- a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +++ b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi @@ -19,8 +19,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Department)) - .returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Department)) + params( + _: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Util::AnyHash)) + ) end def department=(_) end @@ -58,8 +62,10 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager)) - .returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager)) + params( + _: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Util::AnyHash)) + ) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Util::AnyHash))) end def manager=(_) end diff --git a/rbi/lib/finch-api/models/hris/individual_response.rbi b/rbi/lib/finch-api/models/hris/individual_response.rbi index 4dfb5812..4db36390 100644 --- a/rbi/lib/finch-api/models/hris/individual_response.rbi +++ b/rbi/lib/finch-api/models/hris/individual_response.rbi @@ -8,7 +8,10 @@ module FinchAPI def body end - sig { params(_: FinchAPI::Models::HRIS::Individual).returns(FinchAPI::Models::HRIS::Individual) } + sig do + params(_: T.any(FinchAPI::Models::HRIS::Individual, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::Individual, FinchAPI::Util::AnyHash)) + end def body=(_) end diff --git a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi index 1b781b09..ed61411c 100644 --- a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi @@ -12,8 +12,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options)) - .returns(T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options)) + params( + _: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)) + ) end def options=(_) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 41c606b3..0b436a1c 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -43,7 +43,10 @@ module FinchAPI def gross_pay end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def gross_pay=(_) end @@ -60,7 +63,10 @@ module FinchAPI def net_pay end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def net_pay=(_) end @@ -173,8 +179,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes)) + params( + _: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash)) + ) end def attributes=(_) end @@ -255,8 +265,12 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata) - .returns(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata) + params( + _: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash) + ) + .returns( + T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash) + ) end def metadata=(_) end @@ -334,8 +348,16 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes)) + params( + _: T.nilable( + T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash) + ) + ) + .returns( + T.nilable( + T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash) + ) + ) end def attributes=(_) end @@ -415,8 +437,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata) - .returns(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata) + params( + _: T.any( + FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) end def metadata=(_) end @@ -472,8 +504,16 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes)) + params( + _: T.nilable( + T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash) + ) + ) + .returns( + T.nilable( + T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash) + ) + ) end def attributes=(_) end @@ -542,8 +582,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata) - .returns(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata) + params( + _: T.any( + FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) end def metadata=(_) end @@ -613,8 +663,10 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes)) + params( + _: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash)) + ) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash))) end def attributes=(_) end @@ -694,8 +746,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata) - .returns(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata) + params(_: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash)) end def metadata=(_) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi index dc4ecd14..dc26df12 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi @@ -9,8 +9,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::PayStatementResponseBody) - .returns(FinchAPI::Models::HRIS::PayStatementResponseBody) + params(_: T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Util::AnyHash)) end def body=(_) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi index f820bc3f..0e3caf9f 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi @@ -8,7 +8,10 @@ module FinchAPI def paging end - sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } + sig do + params(_: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) + end def paging=(_) end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 13095552..fd3178c1 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -17,7 +17,10 @@ module FinchAPI def company_debit end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def company_debit=(_) end @@ -33,7 +36,10 @@ module FinchAPI def employee_taxes end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def employee_taxes=(_) end @@ -41,7 +47,10 @@ module FinchAPI def employer_taxes end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def employer_taxes=(_) end @@ -49,7 +58,10 @@ module FinchAPI def gross_pay end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def gross_pay=(_) end @@ -66,7 +78,10 @@ module FinchAPI def net_pay end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def net_pay=(_) end @@ -105,8 +120,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)) - .returns(T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Util::AnyHash))) end def pay_period=(_) end diff --git a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi index 83a54a99..79fc7257 100644 --- a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi @@ -8,7 +8,10 @@ module FinchAPI def company_benefits end - sig { params(_: FinchAPI::Models::OperationSupportMatrix).returns(FinchAPI::Models::OperationSupportMatrix) } + sig do + params(_: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) + end def company_benefits=(_) end @@ -16,7 +19,10 @@ module FinchAPI def individual_benefits end - sig { params(_: FinchAPI::Models::OperationSupportMatrix).returns(FinchAPI::Models::OperationSupportMatrix) } + sig do + params(_: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) + end def individual_benefits=(_) end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 1ccc25bc..04193703 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -9,7 +9,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::HRIS::W42005::Data).returns(FinchAPI::Models::HRIS::W42005::Data) } + sig do + params(_: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 859c9260..78e435c7 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -9,7 +9,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::HRIS::W42020::Data).returns(FinchAPI::Models::HRIS::W42020::Data) } + sig do + params(_: T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 583c7b82..1ab21fc9 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -7,7 +7,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::IndividualEvent::Data).returns(FinchAPI::Models::IndividualEvent::Data) } + sig do + params(_: T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index 797339fa..48faa545 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -69,8 +69,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Introspection::ConnectionStatus) - .returns(FinchAPI::Models::Introspection::ConnectionStatus) + params(_: T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Util::AnyHash)) end def connection_status=(_) end @@ -241,8 +241,12 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus) - .returns(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus) + params( + _: T.any(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, FinchAPI::Util::AnyHash) + ) + .returns( + T.any(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, FinchAPI::Util::AnyHash) + ) end def connection_status=(_) end diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index ea5d5740..7e75ed92 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -7,7 +7,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::JobCompletionEvent::Data).returns(FinchAPI::Models::JobCompletionEvent::Data) } + sig do + params(_: T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 306f8573..261c2236 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -48,8 +48,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params)) - .returns(T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params)) + params(_: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Util::AnyHash))) end def params=(_) end diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index 873d626d..bc61057e 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -24,8 +24,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Jobs::AutomatedCreateParams::Params) - .returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Params) + params(_: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Util::AnyHash)) end def params=(_) end diff --git a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi index 6c9c3f87..19f50c56 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi @@ -20,8 +20,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Jobs::AutomatedListResponse::Meta) - .returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta) + params(_: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Util::AnyHash)) end def meta=(_) end @@ -58,8 +58,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas) - .returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas) + params(_: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Util::AnyHash)) end def quotas=(_) end @@ -78,8 +78,12 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll) - .returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll) + params( + _: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, FinchAPI::Util::AnyHash) + ) + .returns( + T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, FinchAPI::Util::AnyHash) + ) end def data_sync_all=(_) end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 902c76fc..9112d56e 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -7,7 +7,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::PayStatementEvent::Data).returns(FinchAPI::Models::PayStatementEvent::Data) } + sig do + params(_: T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index 1e5faf72..079855ee 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -7,7 +7,10 @@ module FinchAPI def data end - sig { params(_: FinchAPI::Models::PaymentEvent::Data).returns(FinchAPI::Models::PaymentEvent::Data) } + sig do + params(_: T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Util::AnyHash)) + end def data=(_) end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index e125e013..fc69a9e7 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -155,8 +155,8 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) + params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) end def benefits_support=(_) end @@ -167,8 +167,16 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields)) - .returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields)) + params( + _: T.nilable( + T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Util::AnyHash) + ) + ) + .returns( + T.nilable( + T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Util::AnyHash) + ) + ) end def supported_fields=(_) end @@ -215,8 +223,12 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company) + params( + _: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, FinchAPI::Util::AnyHash) + ) + .returns( + T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, FinchAPI::Util::AnyHash) + ) end def company=(_) end @@ -226,8 +238,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, + FinchAPI::Util::AnyHash + ) + ) end def directory=(_) end @@ -237,8 +259,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, + FinchAPI::Util::AnyHash + ) + ) end def employment=(_) end @@ -248,8 +280,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, + FinchAPI::Util::AnyHash + ) + ) end def individual=(_) end @@ -259,8 +301,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, + FinchAPI::Util::AnyHash + ) + ) end def pay_group=(_) end @@ -270,8 +322,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, + FinchAPI::Util::AnyHash + ) + ) end def pay_statement=(_) end @@ -281,8 +343,12 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment) + params( + _: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, FinchAPI::Util::AnyHash) + ) + .returns( + T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, FinchAPI::Util::AnyHash) + ) end def payment=(_) end @@ -342,8 +408,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + FinchAPI::Util::AnyHash + ) + ) end def accounts=(_) end @@ -357,8 +433,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + FinchAPI::Util::AnyHash + ) + ) end def departments=(_) end @@ -376,8 +462,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + FinchAPI::Util::AnyHash + ) + ) end def entity=(_) end @@ -395,8 +491,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + FinchAPI::Util::AnyHash + ) + ) end def locations=(_) end @@ -551,8 +657,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, + FinchAPI::Util::AnyHash + ) + ) end def parent=(_) end @@ -715,8 +831,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + FinchAPI::Util::AnyHash + ) + ) end def individuals=(_) end @@ -726,8 +852,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, + FinchAPI::Util::AnyHash + ) + ) end def paging=(_) end @@ -807,10 +943,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + FinchAPI::Util::AnyHash + ) ) end def manager=(_) @@ -936,8 +1078,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + FinchAPI::Util::AnyHash + ) + ) end def department=(_) end @@ -951,8 +1103,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + FinchAPI::Util::AnyHash + ) + ) end def employment=(_) end @@ -986,8 +1148,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + FinchAPI::Util::AnyHash + ) + ) end def income=(_) end @@ -1025,8 +1197,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + FinchAPI::Util::AnyHash + ) + ) end def location=(_) end @@ -1036,8 +1218,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, + FinchAPI::Util::AnyHash + ) + ) end def manager=(_) end @@ -1337,8 +1529,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + FinchAPI::Util::AnyHash + ) + ) end def emails=(_) end @@ -1400,8 +1602,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + FinchAPI::Util::AnyHash + ) + ) end def phone_numbers=(_) end @@ -1423,8 +1635,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + FinchAPI::Util::AnyHash + ) + ) end def residence=(_) end @@ -1696,8 +1918,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + FinchAPI::Util::AnyHash + ) + ) end def paging=(_) end @@ -1711,8 +1943,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, + FinchAPI::Util::AnyHash + ) + ) end def pay_statements=(_) end @@ -1778,10 +2020,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + FinchAPI::Util::AnyHash + ) ) end def earnings=(_) @@ -1799,10 +2047,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + FinchAPI::Util::AnyHash + ) ) end def employee_deductions=(_) @@ -1820,10 +2074,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + FinchAPI::Util::AnyHash + ) ) end def employer_contributions=(_) @@ -1873,10 +2133,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + FinchAPI::Util::AnyHash + ) ) end def taxes=(_) @@ -2273,8 +2539,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod) + params( + _: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, + FinchAPI::Util::AnyHash + ) + ) end def pay_period=(_) end diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi index 6ca5871c..c3645ad7 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi @@ -31,8 +31,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::RequestForwardingForwardResponse::Request) - .returns(FinchAPI::Models::RequestForwardingForwardResponse::Request) + params(_: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash)) end def request=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index 64db322f..1676913b 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -46,8 +46,10 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash)) + ) + .returns(T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash))) end def entity=(_) end @@ -245,8 +247,16 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent)) + params( + _: T.nilable( + T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Util::AnyHash) + ) + ) + .returns( + T.nilable( + T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Util::AnyHash) + ) + ) end def parent=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index c43f9b8f..13fb0ab2 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -43,8 +43,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Util::AnyHash)) + ) end def entity=(_) end @@ -231,8 +235,16 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent)) + params( + _: T.nilable( + T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, FinchAPI::Util::AnyHash) + ) + ) + .returns( + T.nilable( + T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, FinchAPI::Util::AnyHash) + ) + ) end def parent=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index b71fbb7b..e2837150 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -72,8 +72,16 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department)) + params( + _: T.nilable( + T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash) + ) + ) + .returns( + T.nilable( + T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash) + ) + ) end def department=(_) end @@ -103,8 +111,16 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment)) + params( + _: T.nilable( + T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash) + ) + ) + .returns( + T.nilable( + T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash) + ) + ) end def employment=(_) end @@ -180,7 +196,10 @@ module FinchAPI def income end - sig { params(_: T.nilable(FinchAPI::Models::Income)).returns(T.nilable(FinchAPI::Models::Income)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + end def income=(_) end @@ -226,7 +245,10 @@ module FinchAPI def location end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def location=(_) end @@ -236,8 +258,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)) + ) end def manager=(_) end @@ -283,7 +309,10 @@ module FinchAPI def residence end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def residence=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index d30bbc41..c2d05f9f 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -36,8 +36,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)) + ) end def department=(_) end @@ -48,8 +52,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)) + ) end def employment=(_) end @@ -90,7 +98,10 @@ module FinchAPI def income end - sig { params(_: T.nilable(FinchAPI::Models::Income)).returns(T.nilable(FinchAPI::Models::Income)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + end def income=(_) end @@ -136,7 +147,10 @@ module FinchAPI def location end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def location=(_) end @@ -146,8 +160,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)) + ) end def manager=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 6a6073af..baa734b1 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -42,8 +42,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Util::AnyHash)) + ) end def department=(_) end @@ -54,8 +58,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Util::AnyHash)) + ) end def employment=(_) end @@ -96,7 +104,10 @@ module FinchAPI def income end - sig { params(_: T.nilable(FinchAPI::Models::Income)).returns(T.nilable(FinchAPI::Models::Income)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) + end def income=(_) end @@ -142,7 +153,10 @@ module FinchAPI def location end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def location=(_) end @@ -152,8 +166,12 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager)) + params( + _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Util::AnyHash)) + ) + .returns( + T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Util::AnyHash)) + ) end def manager=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index caca0005..e34d8b33 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -112,7 +112,10 @@ module FinchAPI def residence end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def residence=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index b5ee010e..ec4b8100 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -120,7 +120,10 @@ module FinchAPI def residence end - sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) + end def residence=(_) end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index 17d9c472..98b35c75 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -136,7 +136,10 @@ module FinchAPI def gross_pay end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def gross_pay=(_) end @@ -153,7 +156,10 @@ module FinchAPI def net_pay end - sig { params(_: T.nilable(FinchAPI::Models::Money)).returns(T.nilable(FinchAPI::Models::Money)) } + sig do + params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) + end def net_pay=(_) end @@ -278,8 +284,22 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes)) - .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes)) + params( + _: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, + FinchAPI::Util::AnyHash + ) + ) + ) + .returns( + T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, + FinchAPI::Util::AnyHash + ) + ) + ) end def attributes=(_) end @@ -366,8 +386,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata) - .returns(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata) + params( + _: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) end def metadata=(_) end @@ -475,10 +505,20 @@ module FinchAPI sig do params( - _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes) + _: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, + FinchAPI::Util::AnyHash + ) + ) ) .returns( - T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes) + T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, + FinchAPI::Util::AnyHash + ) + ) ) end def attributes=(_) @@ -566,10 +606,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + _: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) ) end def metadata=(_) @@ -638,10 +684,20 @@ module FinchAPI sig do params( - _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes) + _: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, + FinchAPI::Util::AnyHash + ) + ) ) .returns( - T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes) + T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, + FinchAPI::Util::AnyHash + ) + ) ) end def attributes=(_) @@ -718,10 +774,16 @@ module FinchAPI sig do params( - _: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + _: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) ) .returns( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) ) end def metadata=(_) @@ -803,8 +865,22 @@ module FinchAPI end sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes)) - .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes)) + params( + _: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, + FinchAPI::Util::AnyHash + ) + ) + ) + .returns( + T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, + FinchAPI::Util::AnyHash + ) + ) + ) end def attributes=(_) end @@ -888,8 +964,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata) - .returns(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata) + params( + _: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) + .returns( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) end def metadata=(_) end diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 4281805b..0ceed529 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -3,6 +3,8 @@ module FinchAPI # @api private module Util + AnyHash = T.type_alias { T::Hash[Symbol, T.anything] } + # @api private sig { returns(Float) } def self.monotonic_secs From de42306ed5186b7031889b725609b28b8b04b35c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 20 Mar 2025 23:04:24 +0000 Subject: [PATCH 56/67] fix: yard example tag formatting (#59) --- lib/finch-api/base_client.rb | 2 +- lib/finch-api/base_model.rb | 98 ++++++++++++--------------- lib/finch-api/base_page.rb | 36 ++++------ lib/finch-api/individuals_page.rb | 36 ++++------ lib/finch-api/page.rb | 36 ++++------ lib/finch-api/request_options.rb | 2 +- lib/finch-api/responses_page.rb | 36 ++++------ lib/finch-api/single_page.rb | 36 ++++------ rbi/lib/finch-api/request_options.rbi | 4 +- sig/finch-api/request_options.rbs | 4 +- 10 files changed, 125 insertions(+), 165 deletions(-) diff --git a/lib/finch-api/base_client.rb b/lib/finch-api/base_client.rb index b29d3f96..a601f5db 100644 --- a/lib/finch-api/base_client.rb +++ b/lib/finch-api/base_client.rb @@ -220,7 +220,7 @@ def initialize( # # @option opts [Hash{String=>String, nil}, nil] :extra_headers # - # @option opts [Hash{Symbol=>Object}, nil] :extra_body + # @option opts [Object, nil] :extra_body # # @option opts [Integer, nil] :max_retries # diff --git a/lib/finch-api/base_model.rb b/lib/finch-api/base_model.rb index 52cfa76d..925e7ee1 100644 --- a/lib/finch-api/base_model.rb +++ b/lib/finch-api/base_model.rb @@ -288,33 +288,29 @@ def try_strict_coerce(value) # values safely. # # @example - # ```ruby - # # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType` - # case connection_status_type - # when FinchAPI::Models::ConnectionStatusType::PENDING - # # ... - # when FinchAPI::Models::ConnectionStatusType::PROCESSING - # # ... - # when FinchAPI::Models::ConnectionStatusType::CONNECTED - # # ... - # else - # puts(connection_status_type) - # end - # ``` + # # `connection_status_type` is a `FinchAPI::Models::ConnectionStatusType` + # case connection_status_type + # when FinchAPI::Models::ConnectionStatusType::PENDING + # # ... + # when FinchAPI::Models::ConnectionStatusType::PROCESSING + # # ... + # when FinchAPI::Models::ConnectionStatusType::CONNECTED + # # ... + # else + # puts(connection_status_type) + # end # # @example - # ```ruby - # case connection_status_type - # in :pending - # # ... - # in :processing - # # ... - # in :connected - # # ... - # else - # puts(connection_status_type) - # end - # ``` + # case connection_status_type + # in :pending + # # ... + # in :processing + # # ... + # in :connected + # # ... + # else + # puts(connection_status_type) + # end module Enum include FinchAPI::Converter @@ -387,29 +383,25 @@ def try_strict_coerce(value) # @api private # # @example - # ```ruby - # # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse` - # case document_retreive_response - # when FinchAPI::Models::HRIS::W42020 - # puts(document_retreive_response.data) - # when FinchAPI::Models::HRIS::W42005 - # puts(document_retreive_response.type) - # else - # puts(document_retreive_response) - # end - # ``` + # # `document_retreive_response` is a `FinchAPI::Models::HRIS::DocumentRetreiveResponse` + # case document_retreive_response + # when FinchAPI::Models::HRIS::W42020 + # puts(document_retreive_response.data) + # when FinchAPI::Models::HRIS::W42005 + # puts(document_retreive_response.type) + # else + # puts(document_retreive_response) + # end # # @example - # ```ruby - # case document_retreive_response - # in {type: :w4_2020, data: data, year: year} - # puts(data) - # in {type: :w4_2005, data: data, year: year} - # puts(year) - # else - # puts(document_retreive_response) - # end - # ``` + # case document_retreive_response + # in {type: :w4_2020, data: data, year: year} + # puts(data) + # in {type: :w4_2005, data: data, year: year} + # puts(year) + # else + # puts(document_retreive_response) + # end module Union include FinchAPI::Converter @@ -874,14 +866,12 @@ def initialize(type_info, spec = {}) # @abstract # # @example - # ```ruby - # # `operation_support_matrix` is a `FinchAPI::Models::OperationSupportMatrix` - # operation_support_matrix => { - # create: create, - # delete: delete, - # read: read - # } - # ``` + # # `operation_support_matrix` is a `FinchAPI::Models::OperationSupportMatrix` + # operation_support_matrix => { + # create: create, + # delete: delete, + # read: read + # } class BaseModel extend FinchAPI::Converter diff --git a/lib/finch-api/base_page.rb b/lib/finch-api/base_page.rb index 751dbb94..4ceaf25e 100644 --- a/lib/finch-api/base_page.rb +++ b/lib/finch-api/base_page.rb @@ -2,32 +2,26 @@ module FinchAPI # @example - # ```ruby - # if page.has_next? - # page = page.next_page - # end - # ``` + # if page.has_next? + # page = page.next_page + # end # # @example - # ```ruby - # page.auto_paging_each do |access_token| - # puts(access_token) - # end - # ``` + # page.auto_paging_each do |access_token| + # puts(access_token) + # end # # @example - # ```ruby - # access_tokens = - # page - # .to_enum - # .lazy - # .select { _1.object_id.even? } - # .map(&:itself) - # .take(2) - # .to_a + # access_tokens = + # page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # - # access_tokens => Array - # ``` + # access_tokens => Array module BasePage # rubocop:disable Lint/UnusedMethodArgument diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index 0fde1397..0820660e 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -2,32 +2,26 @@ module FinchAPI # @example - # ```ruby - # if individuals_page.has_next? - # individuals_page = individuals_page.next_page - # end - # ``` + # if individuals_page.has_next? + # individuals_page = individuals_page.next_page + # end # # @example - # ```ruby - # individuals_page.auto_paging_each do |directory| - # puts(directory) - # end - # ``` + # individuals_page.auto_paging_each do |directory| + # puts(directory) + # end # # @example - # ```ruby - # directories = - # individuals_page - # .to_enum - # .lazy - # .select { _1.object_id.even? } - # .map(&:itself) - # .take(2) - # .to_a + # directories = + # individuals_page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # - # directories => Array - # ``` + # directories => Array class IndividualsPage include FinchAPI::BasePage diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index 775f7e60..f9313a52 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -2,32 +2,26 @@ module FinchAPI # @example - # ```ruby - # if page.has_next? - # page = page.next_page - # end - # ``` + # if page.has_next? + # page = page.next_page + # end # # @example - # ```ruby - # page.auto_paging_each do |item| - # puts(item) - # end - # ``` + # page.auto_paging_each do |item| + # puts(item) + # end # # @example - # ```ruby - # items = - # page - # .to_enum - # .lazy - # .select { _1.object_id.even? } - # .map(&:itself) - # .take(2) - # .to_a + # items = + # page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # - # items => Array - # ``` + # items => Array class Page include FinchAPI::BasePage diff --git a/lib/finch-api/request_options.rb b/lib/finch-api/request_options.rb index 5488ce4e..a6f9db8a 100644 --- a/lib/finch-api/request_options.rb +++ b/lib/finch-api/request_options.rb @@ -83,7 +83,7 @@ def self.validate!(opts) # Extra data to send with the request. These are deep merged into any data # generated as part of the normal request. # - # @return [Hash{Symbol=>Object}, nil] + # @return [Object, nil] optional :extra_body, FinchAPI::HashOf[FinchAPI::Unknown] # @!attribute max_retries diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index 74d58fcb..951a7693 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -2,32 +2,26 @@ module FinchAPI # @example - # ```ruby - # if responses_page.has_next? - # responses_page = responses_page.next_page - # end - # ``` + # if responses_page.has_next? + # responses_page = responses_page.next_page + # end # # @example - # ```ruby - # responses_page.auto_paging_each do |individual| - # puts(individual) - # end - # ``` + # responses_page.auto_paging_each do |individual| + # puts(individual) + # end # # @example - # ```ruby - # individuals = - # responses_page - # .to_enum - # .lazy - # .select { _1.object_id.even? } - # .map(&:itself) - # .take(2) - # .to_a + # individuals = + # responses_page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # - # individuals => Array - # ``` + # individuals => Array class ResponsesPage include FinchAPI::BasePage diff --git a/lib/finch-api/single_page.rb b/lib/finch-api/single_page.rb index f9c3f98d..ea744fec 100644 --- a/lib/finch-api/single_page.rb +++ b/lib/finch-api/single_page.rb @@ -2,32 +2,26 @@ module FinchAPI # @example - # ```ruby - # if single_page.has_next? - # single_page = single_page.next_page - # end - # ``` + # if single_page.has_next? + # single_page = single_page.next_page + # end # # @example - # ```ruby - # single_page.auto_paging_each do |payment| - # puts(payment) - # end - # ``` + # single_page.auto_paging_each do |payment| + # puts(payment) + # end # # @example - # ```ruby - # payments = - # single_page - # .to_enum - # .lazy - # .select { _1.object_id.even? } - # .map(&:itself) - # .take(2) - # .to_a + # payments = + # single_page + # .to_enum + # .lazy + # .select { _1.object_id.even? } + # .map(&:itself) + # .take(2) + # .to_a # - # payments => Array - # ``` + # payments => Array class SinglePage < ::Array include FinchAPI::BasePage diff --git a/rbi/lib/finch-api/request_options.rbi b/rbi/lib/finch-api/request_options.rbi index 57022054..a660f778 100644 --- a/rbi/lib/finch-api/request_options.rbi +++ b/rbi/lib/finch-api/request_options.rbi @@ -73,11 +73,11 @@ module FinchAPI # Extra data to send with the request. These are deep merged into any data # generated as part of the normal request. - sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } + sig { returns(T.nilable(T.anything)) } def extra_body end - sig { params(_: T.nilable(T::Hash[Symbol, T.anything])).returns(T.nilable(T::Hash[Symbol, T.anything])) } + sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } def extra_body=(_) end diff --git a/sig/finch-api/request_options.rbs b/sig/finch-api/request_options.rbs index 18bf621b..32a98342 100644 --- a/sig/finch-api/request_options.rbs +++ b/sig/finch-api/request_options.rbs @@ -17,7 +17,7 @@ module FinchAPI idempotency_key: String?, extra_query: ::Hash[String, (::Array[String] | String)?]?, extra_headers: ::Hash[String, String?]?, - extra_body: ::Hash[Symbol, top]?, + extra_body: top?, max_retries: Integer?, timeout: Float? } @@ -31,7 +31,7 @@ module FinchAPI attr_accessor extra_headers: ::Hash[String, String?]? - attr_accessor extra_body: ::Hash[Symbol, top]? + attr_accessor extra_body: top? attr_accessor max_retries: Integer? From 414af1a8c761ded84a26cd5ad1d85838fe372cdf Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 20 Mar 2025 23:37:19 +0000 Subject: [PATCH 57/67] chore: add type annotations for enum and union member listing methods (#60) --- lib/finch-api/models/account_update_event.rb | 12 ++ lib/finch-api/models/company_event.rb | 6 + .../models/connect/session_new_params.rb | 18 +++ .../connect/session_reauthenticate_params.rb | 6 + .../models/connection_status_type.rb | 6 + .../models/create_access_token_response.rb | 12 ++ lib/finch-api/models/directory_event.rb | 6 + lib/finch-api/models/employment_event.rb | 6 + .../models/hris/benefit_contribution.rb | 6 + .../hris/benefit_features_and_operations.rb | 18 +++ .../models/hris/benefit_frequency.rb | 6 + lib/finch-api/models/hris/benefit_type.rb | 6 + .../hris/benefits/enrolled_individual.rb | 6 + .../hris/benefits/individual_benefit.rb | 6 + .../benefits/individual_enroll_many_params.rb | 18 +++ lib/finch-api/models/hris/company.rb | 18 +++ .../models/hris/document_list_params.rb | 6 + .../models/hris/document_response.rb | 6 + lib/finch-api/models/hris/employment_data.rb | 18 +++ lib/finch-api/models/hris/individual.rb | 24 +++ lib/finch-api/models/hris/pay_statement.rb | 24 +++ lib/finch-api/models/hris/payment.rb | 6 + .../models/hris/supported_benefit.rb | 18 +++ lib/finch-api/models/hris/w42005.rb | 18 +++ lib/finch-api/models/hris/w42020.rb | 12 ++ lib/finch-api/models/income.rb | 6 + lib/finch-api/models/individual_event.rb | 6 + lib/finch-api/models/introspection.rb | 18 +++ lib/finch-api/models/job_completion_event.rb | 6 + .../models/jobs/automated_async_job.rb | 12 ++ .../models/jobs/automated_create_params.rb | 6 + lib/finch-api/models/jobs/manual_async_job.rb | 6 + lib/finch-api/models/operation_support.rb | 6 + lib/finch-api/models/pay_statement_event.rb | 6 + lib/finch-api/models/payment_event.rb | 6 + .../models/payroll/pay_group_list_response.rb | 6 + .../payroll/pay_group_retrieve_response.rb | 6 + lib/finch-api/models/provider.rb | 6 + .../models/sandbox/company_update_params.rb | 18 +++ .../models/sandbox/company_update_response.rb | 18 +++ .../sandbox/connection_create_params.rb | 6 + .../sandbox/connection_create_response.rb | 6 + .../connections/account_create_params.rb | 6 + .../connections/account_create_response.rb | 6 + .../connections/account_update_response.rb | 6 + .../models/sandbox/directory_create_params.rb | 42 ++++++ .../sandbox/employment_update_params.rb | 18 +++ .../sandbox/employment_update_response.rb | 18 +++ .../sandbox/individual_update_params.rb | 24 +++ .../sandbox/individual_update_response.rb | 24 +++ .../models/sandbox/job_create_params.rb | 6 + .../sandbox/jobs/sandbox_job_configuration.rb | 12 ++ .../models/sandbox/payment_create_params.rb | 24 +++ .../finch-api/models/account_update_event.rbi | 15 ++ rbi/lib/finch-api/models/company_event.rbi | 6 + .../models/connect/session_new_params.rbi | 49 ++++-- .../connect/session_reauthenticate_params.rbi | 24 ++- .../models/connection_status_type.rbi | 19 ++- .../models/create_access_token_response.rbi | 12 ++ rbi/lib/finch-api/models/directory_event.rbi | 6 + rbi/lib/finch-api/models/employment_event.rbi | 6 + .../models/hris/benefit_contribution.rbi | 6 + .../hris/benefit_features_and_operations.rbi | 35 +++++ .../models/hris/benefit_frequency.rbi | 12 +- .../finch-api/models/hris/benefit_type.rbi | 44 +++--- .../hris/benefits/enrolled_individual.rbi | 6 + .../hris/benefits/individual_benefit.rbi | 11 ++ .../individual_enroll_many_params.rbi | 51 ++++++- rbi/lib/finch-api/models/hris/company.rbi | 18 +++ .../models/hris/document_list_params.rbi | 10 +- .../models/hris/document_response.rbi | 6 + .../hris/document_retreive_response.rbi | 6 + .../finch-api/models/hris/employment_data.rbi | 18 +++ rbi/lib/finch-api/models/hris/individual.rbi | 24 +++ .../finch-api/models/hris/pay_statement.rbi | 24 +++ rbi/lib/finch-api/models/hris/payment.rbi | 6 + .../models/hris/supported_benefit.rbi | 18 +++ rbi/lib/finch-api/models/hris/w42005.rbi | 18 +++ rbi/lib/finch-api/models/hris/w42020.rbi | 12 ++ rbi/lib/finch-api/models/income.rbi | 24 +-- rbi/lib/finch-api/models/individual_event.rbi | 6 + rbi/lib/finch-api/models/introspection.rbi | 18 +++ .../finch-api/models/job_completion_event.rbi | 6 + .../models/jobs/automated_async_job.rbi | 12 ++ .../models/jobs/automated_create_params.rbi | 8 +- .../models/jobs/manual_async_job.rbi | 6 + .../finch-api/models/operation_support.rbi | 6 + .../finch-api/models/pay_statement_event.rbi | 6 + rbi/lib/finch-api/models/payment_event.rbi | 6 + .../payroll/pay_group_list_response.rbi | 6 + .../payroll/pay_group_retrieve_response.rbi | 8 + rbi/lib/finch-api/models/provider.rbi | 6 + .../models/sandbox/company_update_params.rbi | 50 +++++-- .../sandbox/company_update_response.rbi | 23 +++ .../sandbox/connection_create_params.rbi | 18 ++- .../sandbox/connection_create_response.rbi | 9 ++ .../connections/account_create_params.rbi | 22 ++- .../connections/account_create_response.rbi | 11 ++ .../connections/account_update_response.rbi | 11 ++ .../sandbox/directory_create_params.rbi | 140 ++++++++++++++---- .../sandbox/employment_update_params.rbi | 61 ++++++-- .../sandbox/employment_update_response.rbi | 27 ++++ .../sandbox/individual_update_params.rbi | 62 ++++++-- .../sandbox/individual_update_response.rbi | 27 ++++ .../models/sandbox/job_create_params.rbi | 8 +- .../jobs/sandbox_job_configuration.rbi | 17 +++ .../models/sandbox/payment_create_params.rbi | 100 ++++++++++--- rbi/lib/finch-api/models/webhook_event.rbi | 11 ++ sig/finch-api/models/account_update_event.rbs | 4 +- sig/finch-api/models/company_event.rbs | 2 +- .../models/connect/session_new_params.rbs | 6 +- .../connect/session_reauthenticate_params.rbs | 2 +- .../models/connection_status_type.rbs | 2 +- .../models/create_access_token_response.rbs | 4 +- sig/finch-api/models/directory_event.rbs | 2 +- sig/finch-api/models/employment_event.rbs | 2 +- .../models/hris/benefit_contribution.rbs | 2 +- .../hris/benefit_features_and_operations.rbs | 6 +- .../models/hris/benefit_frequency.rbs | 2 +- sig/finch-api/models/hris/benefit_type.rbs | 2 +- .../hris/benefits/enrolled_individual.rbs | 2 +- .../hris/benefits/individual_benefit.rbs | 2 +- .../individual_enroll_many_params.rbs | 6 +- sig/finch-api/models/hris/company.rbs | 6 +- .../models/hris/document_list_params.rbs | 2 +- .../models/hris/document_response.rbs | 2 +- .../hris/document_retreive_response.rbs | 2 +- sig/finch-api/models/hris/employment_data.rbs | 6 +- sig/finch-api/models/hris/individual.rbs | 8 +- sig/finch-api/models/hris/pay_statement.rbs | 8 +- sig/finch-api/models/hris/payment.rbs | 2 +- .../models/hris/supported_benefit.rbs | 6 +- sig/finch-api/models/hris/w42005.rbs | 6 +- sig/finch-api/models/hris/w42020.rbs | 4 +- sig/finch-api/models/income.rbs | 2 +- sig/finch-api/models/individual_event.rbs | 2 +- sig/finch-api/models/introspection.rbs | 6 +- sig/finch-api/models/job_completion_event.rbs | 2 +- .../models/jobs/automated_async_job.rbs | 4 +- .../models/jobs/automated_create_params.rbs | 2 +- .../models/jobs/manual_async_job.rbs | 2 +- sig/finch-api/models/operation_support.rbs | 2 +- sig/finch-api/models/pay_statement_event.rbs | 2 +- sig/finch-api/models/payment_event.rbs | 2 +- .../payroll/pay_group_list_response.rbs | 2 +- .../payroll/pay_group_retrieve_response.rbs | 2 +- sig/finch-api/models/provider.rbs | 2 +- .../models/sandbox/company_update_params.rbs | 6 +- .../sandbox/company_update_response.rbs | 6 +- .../sandbox/connection_create_params.rbs | 2 +- .../sandbox/connection_create_response.rbs | 2 +- .../connections/account_create_params.rbs | 2 +- .../connections/account_create_response.rbs | 2 +- .../connections/account_update_response.rbs | 2 +- .../sandbox/directory_create_params.rbs | 14 +- .../sandbox/employment_update_params.rbs | 6 +- .../sandbox/employment_update_response.rbs | 6 +- .../sandbox/individual_update_params.rbs | 8 +- .../sandbox/individual_update_response.rbs | 8 +- .../models/sandbox/job_create_params.rbs | 2 +- .../jobs/sandbox_job_configuration.rbs | 4 +- .../models/sandbox/payment_create_params.rbs | 8 +- sig/finch-api/models/webhook_event.rbs | 2 +- 163 files changed, 1727 insertions(+), 278 deletions(-) diff --git a/lib/finch-api/models/account_update_event.rb b/lib/finch-api/models/account_update_event.rb index 721d247b..8497989f 100644 --- a/lib/finch-api/models/account_update_event.rb +++ b/lib/finch-api/models/account_update_event.rb @@ -1929,6 +1929,12 @@ module Type OAUTH = :oauth finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end @@ -1939,6 +1945,12 @@ module EventType ACCOUNT_UPDATED = :"account.updated" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/company_event.rb b/lib/finch-api/models/company_event.rb index 9cc2ed6a..0ad25215 100644 --- a/lib/finch-api/models/company_event.rb +++ b/lib/finch-api/models/company_event.rb @@ -31,6 +31,12 @@ module EventType COMPANY_UPDATED = :"company.updated" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/connect/session_new_params.rb b/lib/finch-api/models/connect/session_new_params.rb index b44c44de..40120ed4 100644 --- a/lib/finch-api/models/connect/session_new_params.rb +++ b/lib/finch-api/models/connect/session_new_params.rb @@ -99,6 +99,12 @@ module Product SSN = :ssn finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Integration < FinchAPI::BaseModel @@ -131,6 +137,12 @@ module AuthMethod API_TOKEN = :api_token finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -141,6 +153,12 @@ module Sandbox PROVIDER = :provider finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/connect/session_reauthenticate_params.rb b/lib/finch-api/models/connect/session_reauthenticate_params.rb index 13515eb9..cac5a2dd 100644 --- a/lib/finch-api/models/connect/session_reauthenticate_params.rb +++ b/lib/finch-api/models/connect/session_reauthenticate_params.rb @@ -60,6 +60,12 @@ module Product SSN = :ssn finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/connection_status_type.rb b/lib/finch-api/models/connection_status_type.rb index a0f78058..14cd8a52 100644 --- a/lib/finch-api/models/connection_status_type.rb +++ b/lib/finch-api/models/connection_status_type.rb @@ -13,6 +13,12 @@ module ConnectionStatusType REAUTH = :reauth finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/create_access_token_response.rb b/lib/finch-api/models/create_access_token_response.rb index e6881201..44761ce1 100644 --- a/lib/finch-api/models/create_access_token_response.rb +++ b/lib/finch-api/models/create_access_token_response.rb @@ -112,6 +112,12 @@ module ClientType SANDBOX = :sandbox finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The type of the connection associated with the token. @@ -125,6 +131,12 @@ module ConnectionType FINCH = :finch finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/directory_event.rb b/lib/finch-api/models/directory_event.rb index 51151aa3..27971458 100644 --- a/lib/finch-api/models/directory_event.rb +++ b/lib/finch-api/models/directory_event.rb @@ -56,6 +56,12 @@ module EventType DIRECTORY_DELETED = :"directory.deleted" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/employment_event.rb b/lib/finch-api/models/employment_event.rb index 85d9705f..73e801f6 100644 --- a/lib/finch-api/models/employment_event.rb +++ b/lib/finch-api/models/employment_event.rb @@ -56,6 +56,12 @@ module EventType EMPLOYMENT_DELETED = :"employment.deleted" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/benefit_contribution.rb b/lib/finch-api/models/hris/benefit_contribution.rb index 9b5253bf..3795f780 100644 --- a/lib/finch-api/models/hris/benefit_contribution.rb +++ b/lib/finch-api/models/hris/benefit_contribution.rb @@ -32,6 +32,12 @@ module Type PERCENT = :percent finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/benefit_features_and_operations.rb b/lib/finch-api/models/hris/benefit_features_and_operations.rb index 7215f5d5..6bda696e 100644 --- a/lib/finch-api/models/hris/benefit_features_and_operations.rb +++ b/lib/finch-api/models/hris/benefit_features_and_operations.rb @@ -131,6 +131,12 @@ module CompanyContribution PERCENT = :percent finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end module EmployeeDeduction @@ -140,6 +146,12 @@ module EmployeeDeduction PERCENT = :percent finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end module HsaContributionLimit @@ -149,6 +161,12 @@ module HsaContributionLimit FAMILY = :family finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/benefit_frequency.rb b/lib/finch-api/models/hris/benefit_frequency.rb index 298724d4..923e8070 100644 --- a/lib/finch-api/models/hris/benefit_frequency.rb +++ b/lib/finch-api/models/hris/benefit_frequency.rb @@ -11,6 +11,12 @@ module BenefitFrequency MONTHLY = :monthly finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/benefit_type.rb b/lib/finch-api/models/hris/benefit_type.rb index 96447146..16a46b65 100644 --- a/lib/finch-api/models/hris/benefit_type.rb +++ b/lib/finch-api/models/hris/benefit_type.rb @@ -28,6 +28,12 @@ module BenefitType CUSTOM_PRE_TAX = :custom_pre_tax finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/benefits/enrolled_individual.rb b/lib/finch-api/models/hris/benefits/enrolled_individual.rb index f4842898..a48e2467 100644 --- a/lib/finch-api/models/hris/benefits/enrolled_individual.rb +++ b/lib/finch-api/models/hris/benefits/enrolled_individual.rb @@ -81,6 +81,12 @@ module Code FORBIDDEN = 403 finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/benefits/individual_benefit.rb b/lib/finch-api/models/hris/benefits/individual_benefit.rb index 726920db..f1d1b6ed 100644 --- a/lib/finch-api/models/hris/benefits/individual_benefit.rb +++ b/lib/finch-api/models/hris/benefits/individual_benefit.rb @@ -101,6 +101,12 @@ module HsaContributionLimit FAMILY = :family finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb index a33198e0..a662b57e 100644 --- a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +++ b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb @@ -135,6 +135,12 @@ module AnnualContributionLimit FAMILY = :family finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class CompanyContribution < FinchAPI::BaseModel @@ -174,6 +180,12 @@ module Type PERCENT = :percent finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -214,6 +226,12 @@ module Type PERCENT = :percent finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/company.rb b/lib/finch-api/models/hris/company.rb index 4c2c048a..636d2239 100644 --- a/lib/finch-api/models/hris/company.rb +++ b/lib/finch-api/models/hris/company.rb @@ -138,6 +138,12 @@ module AccountType SAVINGS = :savings finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -212,6 +218,12 @@ module Subtype B_CORPORATION = :b_corporation finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The tax payer type of the company. @@ -227,6 +239,12 @@ module Type COOPERATIVE = :cooperative finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/document_list_params.rb b/lib/finch-api/models/hris/document_list_params.rb index f8f4ab25..edfc91ac 100644 --- a/lib/finch-api/models/hris/document_list_params.rb +++ b/lib/finch-api/models/hris/document_list_params.rb @@ -68,6 +68,12 @@ module Type W4_2005 = :w4_2005 finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/document_response.rb b/lib/finch-api/models/hris/document_response.rb index c3c68be2..6fc53ab1 100644 --- a/lib/finch-api/models/hris/document_response.rb +++ b/lib/finch-api/models/hris/document_response.rb @@ -67,6 +67,12 @@ module Type W4_2005 = :w4_2005 finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/employment_data.rb b/lib/finch-api/models/hris/employment_data.rb index e47bbfaa..71e3ae05 100644 --- a/lib/finch-api/models/hris/employment_data.rb +++ b/lib/finch-api/models/hris/employment_data.rb @@ -264,6 +264,12 @@ module Subtype INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The main employment type of the individual. @@ -274,6 +280,12 @@ module Type CONTRACTOR = :contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -291,6 +303,12 @@ module EmploymentStatus TERMINATED = :terminated finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/hris/individual.rb b/lib/finch-api/models/hris/individual.rb index 80d0dea7..22048ae1 100644 --- a/lib/finch-api/models/hris/individual.rb +++ b/lib/finch-api/models/hris/individual.rb @@ -155,6 +155,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -172,6 +178,12 @@ module Ethnicity DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The gender of the individual. @@ -184,6 +196,12 @@ module Gender DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class PhoneNumber < FinchAPI::BaseModel @@ -212,6 +230,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/pay_statement.rb b/lib/finch-api/models/hris/pay_statement.rb index b86ed4eb..4e0f9685 100644 --- a/lib/finch-api/models/hris/pay_statement.rb +++ b/lib/finch-api/models/hris/pay_statement.rb @@ -210,6 +210,12 @@ module Type OTHER = :other finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -395,6 +401,12 @@ module PaymentMethod DIRECT_DEPOSIT = :direct_deposit finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Tax < FinchAPI::BaseModel @@ -494,6 +506,12 @@ module Type FICA = :fica finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -506,6 +524,12 @@ module Type ONE_TIME_PAYMENT = :one_time_payment finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/payment.rb b/lib/finch-api/models/hris/payment.rb index 2ca86899..13fdba6d 100644 --- a/lib/finch-api/models/hris/payment.rb +++ b/lib/finch-api/models/hris/payment.rb @@ -123,6 +123,12 @@ module PayFrequency OTHER = :other finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class PayPeriod < FinchAPI::BaseModel diff --git a/lib/finch-api/models/hris/supported_benefit.rb b/lib/finch-api/models/hris/supported_benefit.rb index e8b409cd..6b5aa852 100644 --- a/lib/finch-api/models/hris/supported_benefit.rb +++ b/lib/finch-api/models/hris/supported_benefit.rb @@ -99,6 +99,12 @@ module CompanyContribution PERCENT = :percent finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end module EmployeeDeduction @@ -108,6 +114,12 @@ module EmployeeDeduction PERCENT = :percent finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end module HsaContributionLimit @@ -117,6 +129,12 @@ module HsaContributionLimit FAMILY = :family finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/w42005.rb b/lib/finch-api/models/hris/w42005.rb index dcb80435..9ad03dad 100644 --- a/lib/finch-api/models/hris/w42005.rb +++ b/lib/finch-api/models/hris/w42005.rb @@ -115,6 +115,12 @@ module Exemption NON_EXEMPT = :non_exempt finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The individual's filing status for tax purposes. @@ -126,6 +132,12 @@ module FilingStatus SINGLE = :single finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -136,6 +148,12 @@ module Type W4_2005 = :w4_2005 finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/hris/w42020.rb b/lib/finch-api/models/hris/w42020.rb index 672c25fc..5aaecd3d 100644 --- a/lib/finch-api/models/hris/w42020.rb +++ b/lib/finch-api/models/hris/w42020.rb @@ -134,6 +134,12 @@ module FilingStatus SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -144,6 +150,12 @@ module Type W4_2020 = :w4_2020 finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/income.rb b/lib/finch-api/models/income.rb index 235da202..5ff70c23 100644 --- a/lib/finch-api/models/income.rb +++ b/lib/finch-api/models/income.rb @@ -58,6 +58,12 @@ module Unit FIXED = :fixed finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/individual_event.rb b/lib/finch-api/models/individual_event.rb index 0376ba55..523e9c31 100644 --- a/lib/finch-api/models/individual_event.rb +++ b/lib/finch-api/models/individual_event.rb @@ -56,6 +56,12 @@ module EventType INDIVIDUAL_DELETED = :"individual.deleted" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/introspection.rb b/lib/finch-api/models/introspection.rb index fed47dae..7d66a2a3 100644 --- a/lib/finch-api/models/introspection.rb +++ b/lib/finch-api/models/introspection.rb @@ -230,6 +230,12 @@ module Type OAUTH = :oauth finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -242,6 +248,12 @@ module ClientType SANDBOX = :sandbox finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class ConnectionStatus < FinchAPI::BaseModel @@ -283,6 +295,12 @@ module ConnectionType FINCH = :finch finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/job_completion_event.rb b/lib/finch-api/models/job_completion_event.rb index 52da8a62..6e957750 100644 --- a/lib/finch-api/models/job_completion_event.rb +++ b/lib/finch-api/models/job_completion_event.rb @@ -62,6 +62,12 @@ module EventType JOB_DATA_SYNC_ALL_COMPLETED = :"job.data_sync_all.completed" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/jobs/automated_async_job.rb b/lib/finch-api/models/jobs/automated_async_job.rb index 4d63c3f9..4f74c873 100644 --- a/lib/finch-api/models/jobs/automated_async_job.rb +++ b/lib/finch-api/models/jobs/automated_async_job.rb @@ -108,6 +108,12 @@ module Status PERMISSIONS_ERROR = :permissions_error finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The type of automated job @@ -118,6 +124,12 @@ module Type W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/jobs/automated_create_params.rb b/lib/finch-api/models/jobs/automated_create_params.rb index 4020f88a..ab0b94f7 100644 --- a/lib/finch-api/models/jobs/automated_create_params.rb +++ b/lib/finch-api/models/jobs/automated_create_params.rb @@ -35,6 +35,12 @@ module Type W4_FORM_EMPLOYEE_SYNC = :w4_form_employee_sync finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Params < FinchAPI::BaseModel diff --git a/lib/finch-api/models/jobs/manual_async_job.rb b/lib/finch-api/models/jobs/manual_async_job.rb index f020b68a..469f11a6 100644 --- a/lib/finch-api/models/jobs/manual_async_job.rb +++ b/lib/finch-api/models/jobs/manual_async_job.rb @@ -38,6 +38,12 @@ module Status COMPLETE = :complete finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/operation_support.rb b/lib/finch-api/models/operation_support.rb index 477aecf9..f2d2407a 100644 --- a/lib/finch-api/models/operation_support.rb +++ b/lib/finch-api/models/operation_support.rb @@ -18,6 +18,12 @@ module OperationSupport CLIENT_ACCESS_ONLY = :client_access_only finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/pay_statement_event.rb b/lib/finch-api/models/pay_statement_event.rb index 34ed514c..5d04867c 100644 --- a/lib/finch-api/models/pay_statement_event.rb +++ b/lib/finch-api/models/pay_statement_event.rb @@ -67,6 +67,12 @@ module EventType PAY_STATEMENT_DELETED = :"pay_statement.deleted" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/payment_event.rb b/lib/finch-api/models/payment_event.rb index ead1e81b..a0247c9f 100644 --- a/lib/finch-api/models/payment_event.rb +++ b/lib/finch-api/models/payment_event.rb @@ -59,6 +59,12 @@ module EventType PAYMENT_DELETED = :"payment.deleted" finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/payroll/pay_group_list_response.rb b/lib/finch-api/models/payroll/pay_group_list_response.rb index 01bee766..4454ea01 100644 --- a/lib/finch-api/models/payroll/pay_group_list_response.rb +++ b/lib/finch-api/models/payroll/pay_group_list_response.rb @@ -58,6 +58,12 @@ module PayFrequency OTHER = :other finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb index 705ade68..0d888ff3 100644 --- a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +++ b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb @@ -52,6 +52,12 @@ module PayFrequency OTHER = :other finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/provider.rb b/lib/finch-api/models/provider.rb index 22e29c6d..17f5ca44 100644 --- a/lib/finch-api/models/provider.rb +++ b/lib/finch-api/models/provider.rb @@ -2011,6 +2011,12 @@ module Type OAUTH = :oauth finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/company_update_params.rb b/lib/finch-api/models/sandbox/company_update_params.rb index 0b757a8f..b44d3a85 100644 --- a/lib/finch-api/models/sandbox/company_update_params.rb +++ b/lib/finch-api/models/sandbox/company_update_params.rb @@ -140,6 +140,12 @@ module AccountType SAVINGS = :savings finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -216,6 +222,12 @@ module Subtype B_CORPORATION = :b_corporation finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The tax payer type of the company. @@ -231,6 +243,12 @@ module Type COOPERATIVE = :cooperative finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/company_update_response.rb b/lib/finch-api/models/sandbox/company_update_response.rb index 3c80c307..734f466d 100644 --- a/lib/finch-api/models/sandbox/company_update_response.rb +++ b/lib/finch-api/models/sandbox/company_update_response.rb @@ -122,6 +122,12 @@ module AccountType SAVINGS = :savings finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -198,6 +204,12 @@ module Subtype B_CORPORATION = :b_corporation finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The tax payer type of the company. @@ -213,6 +225,12 @@ module Type COOPERATIVE = :cooperative finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/connection_create_params.rb b/lib/finch-api/models/sandbox/connection_create_params.rb index e1a4acf5..df39f5a0 100644 --- a/lib/finch-api/models/sandbox/connection_create_params.rb +++ b/lib/finch-api/models/sandbox/connection_create_params.rb @@ -65,6 +65,12 @@ module AuthenticationType ASSISTED = :assisted finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/connection_create_response.rb b/lib/finch-api/models/sandbox/connection_create_response.rb index a6cf7524..60c04a2d 100644 --- a/lib/finch-api/models/sandbox/connection_create_response.rb +++ b/lib/finch-api/models/sandbox/connection_create_response.rb @@ -88,6 +88,12 @@ module AuthenticationType ASSISTED = :assisted finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_create_params.rb b/lib/finch-api/models/sandbox/connections/account_create_params.rb index e0ad65e4..47af82b4 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_params.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_params.rb @@ -61,6 +61,12 @@ module AuthenticationType ASSISTED = :assisted finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_create_response.rb b/lib/finch-api/models/sandbox/connections/account_create_response.rb index a036233e..e51e68b7 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_response.rb @@ -67,6 +67,12 @@ module AuthenticationType ASSISTED = :assisted finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_update_response.rb b/lib/finch-api/models/sandbox/connections/account_update_response.rb index d675c17f..c662a7a7 100644 --- a/lib/finch-api/models/sandbox/connections/account_update_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_update_response.rb @@ -65,6 +65,12 @@ module AuthenticationType ASSISTED = :assisted finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/directory_create_params.rb b/lib/finch-api/models/sandbox/directory_create_params.rb index 100f8433..70eabc0e 100644 --- a/lib/finch-api/models/sandbox/directory_create_params.rb +++ b/lib/finch-api/models/sandbox/directory_create_params.rb @@ -349,6 +349,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -393,6 +399,12 @@ module Subtype INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The main employment type of the individual. @@ -403,6 +415,12 @@ module Type CONTRACTOR = :contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -419,6 +437,12 @@ module EmploymentStatus TERMINATED = :terminated finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The EEOC-defined ethnicity of the individual. @@ -435,6 +459,12 @@ module Ethnicity DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The gender of the individual. @@ -447,6 +477,12 @@ module Gender DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Manager < FinchAPI::BaseModel @@ -502,6 +538,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/employment_update_params.rb b/lib/finch-api/models/sandbox/employment_update_params.rb index ed4bead6..1ba6fe09 100644 --- a/lib/finch-api/models/sandbox/employment_update_params.rb +++ b/lib/finch-api/models/sandbox/employment_update_params.rb @@ -257,6 +257,12 @@ module Subtype INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The main employment type of the individual. @@ -267,6 +273,12 @@ module Type CONTRACTOR = :contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -283,6 +295,12 @@ module EmploymentStatus TERMINATED = :terminated finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/sandbox/employment_update_response.rb b/lib/finch-api/models/sandbox/employment_update_response.rb index c2a20ca4..b1363d47 100644 --- a/lib/finch-api/models/sandbox/employment_update_response.rb +++ b/lib/finch-api/models/sandbox/employment_update_response.rb @@ -263,6 +263,12 @@ module Subtype INDIVIDUAL_CONTRACTOR = :individual_contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The main employment type of the individual. @@ -273,6 +279,12 @@ module Type CONTRACTOR = :contractor finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -289,6 +301,12 @@ module EmploymentStatus TERMINATED = :terminated finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/sandbox/individual_update_params.rb b/lib/finch-api/models/sandbox/individual_update_params.rb index 66d52a9b..a3b45f98 100644 --- a/lib/finch-api/models/sandbox/individual_update_params.rb +++ b/lib/finch-api/models/sandbox/individual_update_params.rb @@ -151,6 +151,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -168,6 +174,12 @@ module Ethnicity DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The gender of the individual. @@ -180,6 +192,12 @@ module Gender DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class PhoneNumber < FinchAPI::BaseModel @@ -214,6 +232,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/individual_update_response.rb b/lib/finch-api/models/sandbox/individual_update_response.rb index 67c649a0..9faac1eb 100644 --- a/lib/finch-api/models/sandbox/individual_update_response.rb +++ b/lib/finch-api/models/sandbox/individual_update_response.rb @@ -159,6 +159,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -176,6 +182,12 @@ module Ethnicity DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end # The gender of the individual. @@ -188,6 +200,12 @@ module Gender DECLINE_TO_SPECIFY = :decline_to_specify finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class PhoneNumber < FinchAPI::BaseModel @@ -222,6 +240,12 @@ module Type PERSONAL = :personal finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/job_create_params.rb b/lib/finch-api/models/sandbox/job_create_params.rb index ffba6989..cc17b434 100644 --- a/lib/finch-api/models/sandbox/job_create_params.rb +++ b/lib/finch-api/models/sandbox/job_create_params.rb @@ -29,6 +29,12 @@ module Type DATA_SYNC_ALL = :data_sync_all finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb index 8eded8eb..226b0e51 100644 --- a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +++ b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb @@ -33,6 +33,12 @@ module CompletionStatus ERROR = :error finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end module Type @@ -41,6 +47,12 @@ module Type DATA_SYNC_ALL = :data_sync_all finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/lib/finch-api/models/sandbox/payment_create_params.rb b/lib/finch-api/models/sandbox/payment_create_params.rb index 3fa1643c..0aeb3911 100644 --- a/lib/finch-api/models/sandbox/payment_create_params.rb +++ b/lib/finch-api/models/sandbox/payment_create_params.rb @@ -262,6 +262,12 @@ module Type OTHER = :other finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -448,6 +454,12 @@ module PaymentMethod DIRECT_DEPOSIT = :direct_deposit finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end class Tax < FinchAPI::BaseModel @@ -552,6 +564,12 @@ module Type FICA = :fica finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end @@ -564,6 +582,12 @@ module Type ONE_TIME_PAYMENT = :one_time_payment finalize! + + class << self + # @!parse + # # @return [Array] + # def values; end + end end end end diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index 4dc23291..d3b95886 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -2725,6 +2725,15 @@ module FinchAPI ) OAUTH = T.let(:oauth, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol]) + end + def values + end + end end end end @@ -2737,6 +2746,12 @@ module FinchAPI ACCOUNT_UPDATED = T.let(:"account.updated", FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index 1702878d..acba3f87 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -53,6 +53,12 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) } COMPANY_UPDATED = T.let(:"company.updated", FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index ad8a01e4..918b1b5b 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -151,14 +151,20 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) } - COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) - DIRECTORY = T.let(:directory, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) - INDIVIDUAL = T.let(:individual, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) - EMPLOYMENT = T.let(:employment, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) - PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) - PAY_STATEMENT = T.let(:pay_statement, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) - BENEFITS = T.let(:benefits, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) - SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol) + COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + DIRECTORY = T.let(:directory, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + INDIVIDUAL = T.let(:individual, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + EMPLOYMENT = T.let(:employment, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + PAY_STATEMENT = T.let(:pay_statement, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + BENEFITS = T.let(:benefits, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol]) } + def values + end + end end class Integration < FinchAPI::BaseModel @@ -212,12 +218,21 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) } ASSISTED = - T.let(:assisted, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) + T.let(:assisted, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) CREDENTIAL = - T.let(:credential, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) - OAUTH = T.let(:oauth, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) + T.let(:credential, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) + OAUTH = T.let(:oauth, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) API_TOKEN = - T.let(:api_token, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol) + T.let(:api_token, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol]) + end + def values + end + end end end @@ -228,8 +243,14 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) } - FINCH = T.let(:finch, FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol) - PROVIDER = T.let(:provider, FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol) + FINCH = T.let(:finch, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) + PROVIDER = T.let(:provider, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 83a64942..332841e6 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -84,17 +84,25 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) } - COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) - DIRECTORY = T.let(:directory, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + COMPANY = T.let(:company, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + DIRECTORY = + T.let(:directory, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) INDIVIDUAL = - T.let(:individual, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + T.let(:individual, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) EMPLOYMENT = - T.let(:employment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) - PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + T.let(:employment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + PAYMENT = T.let(:payment, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) PAY_STATEMENT = - T.let(:pay_statement, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) - BENEFITS = T.let(:benefits, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) - SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol) + T.let(:pay_statement, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + BENEFITS = + T.let(:benefits, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/connection_status_type.rbi b/rbi/lib/finch-api/models/connection_status_type.rbi index c833b133..ae3fb4d1 100644 --- a/rbi/lib/finch-api/models/connection_status_type.rbi +++ b/rbi/lib/finch-api/models/connection_status_type.rbi @@ -8,12 +8,19 @@ module FinchAPI TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::ConnectionStatusType) } OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) } - PENDING = T.let(:pending, FinchAPI::Models::ConnectionStatusType::OrSymbol) - PROCESSING = T.let(:processing, FinchAPI::Models::ConnectionStatusType::OrSymbol) - CONNECTED = T.let(:connected, FinchAPI::Models::ConnectionStatusType::OrSymbol) - ERROR_NO_ACCOUNT_SETUP = T.let(:error_no_account_setup, FinchAPI::Models::ConnectionStatusType::OrSymbol) - ERROR_PERMISSIONS = T.let(:error_permissions, FinchAPI::Models::ConnectionStatusType::OrSymbol) - REAUTH = T.let(:reauth, FinchAPI::Models::ConnectionStatusType::OrSymbol) + PENDING = T.let(:pending, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + PROCESSING = T.let(:processing, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + CONNECTED = T.let(:connected, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + ERROR_NO_ACCOUNT_SETUP = + T.let(:error_no_account_setup, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + ERROR_PERMISSIONS = T.let(:error_permissions, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + REAUTH = T.let(:reauth, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::ConnectionStatusType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index 89db729e..df3cc706 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -165,6 +165,12 @@ module FinchAPI PRODUCTION = T.let(:production, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) DEVELOPMENT = T.let(:development, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) SANDBOX = T.let(:sandbox, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol]) } + def values + end + end end # The type of the connection associated with the token. @@ -181,6 +187,12 @@ module FinchAPI PROVIDER = T.let(:provider, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) FINCH = T.let(:finch, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index fb681e8b..0516f6ad 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -78,6 +78,12 @@ module FinchAPI T.let(:"directory.updated", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) DIRECTORY_DELETED = T.let(:"directory.deleted", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index 1f9bb9f1..53ad5203 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -78,6 +78,12 @@ module FinchAPI T.let(:"employment.updated", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) EMPLOYMENT_DELETED = T.let(:"employment.deleted", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index 25cb978a..5e205ff8 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -54,6 +54,12 @@ module FinchAPI FIXED = T.let(:fixed, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) PERCENT = T.let(:percent, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index adef070c..58fafeb4 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -310,6 +310,17 @@ module FinchAPI :percent, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol] + ) + end + def values + end + end end module EmployeeDeduction @@ -335,6 +346,17 @@ module FinchAPI :percent, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol] + ) + end + def values + end + end end module HsaContributionLimit @@ -362,6 +384,19 @@ module FinchAPI :family, FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ] + ) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi index d72a73e3..427ee8b7 100644 --- a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi @@ -9,9 +9,15 @@ module FinchAPI TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitFrequency) } OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol) } - ONE_TIME = T.let(:one_time, FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol) - EVERY_PAYCHECK = T.let(:every_paycheck, FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol) - MONTHLY = T.let(:monthly, FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol) + ONE_TIME = T.let(:one_time, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol) + EVERY_PAYCHECK = T.let(:every_paycheck, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol) + MONTHLY = T.let(:monthly, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_type.rbi b/rbi/lib/finch-api/models/hris/benefit_type.rbi index a78c504d..2c03081a 100644 --- a/rbi/lib/finch-api/models/hris/benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_type.rbi @@ -10,25 +10,31 @@ module FinchAPI TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::BenefitType) } OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) } - NUMBER_401K = T.let(:"401k", FinchAPI::Models::HRIS::BenefitType::OrSymbol) - NUMBER_401K_ROTH = T.let(:"401k_roth", FinchAPI::Models::HRIS::BenefitType::OrSymbol) - NUMBER_401K_LOAN = T.let(:"401k_loan", FinchAPI::Models::HRIS::BenefitType::OrSymbol) - NUMBER_403B = T.let(:"403b", FinchAPI::Models::HRIS::BenefitType::OrSymbol) - NUMBER_403B_ROTH = T.let(:"403b_roth", FinchAPI::Models::HRIS::BenefitType::OrSymbol) - NUMBER_457 = T.let(:"457", FinchAPI::Models::HRIS::BenefitType::OrSymbol) - NUMBER_457_ROTH = T.let(:"457_roth", FinchAPI::Models::HRIS::BenefitType::OrSymbol) - S125_MEDICAL = T.let(:s125_medical, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - S125_DENTAL = T.let(:s125_dental, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - S125_VISION = T.let(:s125_vision, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - HSA_PRE = T.let(:hsa_pre, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - HSA_POST = T.let(:hsa_post, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - FSA_MEDICAL = T.let(:fsa_medical, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - FSA_DEPENDENT_CARE = T.let(:fsa_dependent_care, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - SIMPLE_IRA = T.let(:simple_ira, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - SIMPLE = T.let(:simple, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - COMMUTER = T.let(:commuter, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - CUSTOM_POST_TAX = T.let(:custom_post_tax, FinchAPI::Models::HRIS::BenefitType::OrSymbol) - CUSTOM_PRE_TAX = T.let(:custom_pre_tax, FinchAPI::Models::HRIS::BenefitType::OrSymbol) + NUMBER_401K = T.let(:"401k", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + NUMBER_401K_ROTH = T.let(:"401k_roth", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + NUMBER_401K_LOAN = T.let(:"401k_loan", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + NUMBER_403B = T.let(:"403b", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + NUMBER_403B_ROTH = T.let(:"403b_roth", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + NUMBER_457 = T.let(:"457", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + NUMBER_457_ROTH = T.let(:"457_roth", FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + S125_MEDICAL = T.let(:s125_medical, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + S125_DENTAL = T.let(:s125_dental, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + S125_VISION = T.let(:s125_vision, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + HSA_PRE = T.let(:hsa_pre, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + HSA_POST = T.let(:hsa_post, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + FSA_MEDICAL = T.let(:fsa_medical, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + FSA_DEPENDENT_CARE = T.let(:fsa_dependent_care, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + SIMPLE_IRA = T.let(:simple_ira, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + SIMPLE = T.let(:simple, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + COMMUTER = T.let(:commuter, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + CUSTOM_POST_TAX = T.let(:custom_post_tax, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + CUSTOM_PRE_TAX = T.let(:custom_pre_tax, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index 568ba9f5..57e0d104 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -121,6 +121,12 @@ module FinchAPI CREATED = T.let(201, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) NOT_FOUND = T.let(404, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) FORBIDDEN = T.let(403, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index a6bdcda1..e07404fb 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -172,6 +172,17 @@ module FinchAPI :family, FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol] + ) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index 1e1fa220..ff271c5b 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -249,13 +249,26 @@ module FinchAPI INDIVIDUAL = T.let( :individual, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol ) FAMILY = T.let( :family, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol + ] + ) + end + def values + end + end end class CompanyContribution < FinchAPI::BaseModel @@ -330,13 +343,26 @@ module FinchAPI FIXED = T.let( :fixed, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol ) PERCENT = T.let( :percent, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol + ] + ) + end + def values + end + end end end @@ -412,13 +438,26 @@ module FinchAPI FIXED = T.let( :fixed, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol ) PERCENT = T.let( :percent, - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol + ] + ) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 9b5ae481..513ba59d 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -230,6 +230,12 @@ module FinchAPI CHECKING = T.let(:checking, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) SAVINGS = T.let(:savings, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol]) } + def values + end + end end end @@ -358,6 +364,12 @@ module FinchAPI S_CORPORATION = T.let(:s_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) C_CORPORATION = T.let(:c_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) B_CORPORATION = T.let(:b_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol]) } + def values + end + end end # The tax payer type of the company. @@ -376,6 +388,12 @@ module FinchAPI NON_PROFIT = T.let(:non_profit, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) PARTNERSHIP = T.let(:partnership, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) COOPERATIVE = T.let(:cooperative, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index a86db188..8411a1a8 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -82,8 +82,14 @@ module FinchAPI TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type) } OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) } - W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol) - W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol) + W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) + W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index 67ae6fe8..bfd0b645 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -91,6 +91,12 @@ module FinchAPI W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index 2b79a510..67a5c9da 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -10,6 +10,12 @@ module FinchAPI Variants = type_template(:out) { {fixed: T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)} } + + class << self + sig { override.returns([FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]) } + def variants + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index bf7409c0..c50526c5 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -399,6 +399,12 @@ module FinchAPI SEASONAL = T.let(:seasonal, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol]) } + def values + end + end end # The main employment type of the individual. @@ -411,6 +417,12 @@ module FinchAPI EMPLOYEE = T.let(:employee, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) CONTRACTOR = T.let(:contractor, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol]) } + def values + end + end end end @@ -430,6 +442,12 @@ module FinchAPI PREHIRE = T.let(:prehire, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) RETIRED = T.let(:retired, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) TERMINATED = T.let(:terminated, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol]) } + def values + end + end end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index d3a97206..9849e79c 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -237,6 +237,12 @@ module FinchAPI WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol) PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol]) } + def values + end + end end end @@ -261,6 +267,12 @@ module FinchAPI T.let(:two_or_more_races, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol]) } + def values + end + end end # The gender of the individual. @@ -274,6 +286,12 @@ module FinchAPI MALE = T.let(:male, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol]) } + def values + end + end end class PhoneNumber < FinchAPI::BaseModel @@ -327,6 +345,12 @@ module FinchAPI WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 0b436a1c..dd0330bd 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -330,6 +330,12 @@ module FinchAPI TIPS = T.let(:tips, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) NUMBER_1099 = T.let(:"1099", FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol]) } + def values + end + end end end @@ -646,6 +652,12 @@ module FinchAPI CHECK = T.let(:check, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) DIRECT_DEPOSIT = T.let(:direct_deposit, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol]) } + def values + end + end end class Tax < FinchAPI::BaseModel @@ -795,6 +807,12 @@ module FinchAPI FEDERAL = T.let(:federal, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) LOCAL = T.let(:local, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) FICA = T.let(:fica, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol]) } + def values + end + end end end @@ -808,6 +826,12 @@ module FinchAPI REGULAR_PAYROLL = T.let(:regular_payroll, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) ONE_TIME_PAYMENT = T.let(:one_time_payment, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index fd3178c1..8e7a39e1 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -196,6 +196,12 @@ module FinchAPI WEEKLY = T.let(:weekly, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) DAILY = T.let(:daily, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]) } + def values + end + end end class PayPeriod < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index 2bd3a760..ef1cce5d 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -191,6 +191,12 @@ module FinchAPI FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol]) } + def values + end + end end module EmployeeDeduction @@ -203,6 +209,12 @@ module FinchAPI FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol]) } + def values + end + end end module HsaContributionLimit @@ -216,6 +228,12 @@ module FinchAPI INDIVIDUAL = T.let(:individual, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) FAMILY = T.let(:family, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 04193703..685cea99 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -159,6 +159,12 @@ module FinchAPI EXEMPT = T.let(:exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) NON_EXEMPT = T.let(:non_exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol]) } + def values + end + end end # The individual's filing status for tax purposes. @@ -176,6 +182,12 @@ module FinchAPI FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol ) SINGLE = T.let(:single, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol]) } + def values + end + end end end @@ -187,6 +199,12 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) } W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 78e435c7..620cb345 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -204,6 +204,12 @@ module FinchAPI :single_or_married_filing_separately, FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol ) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol]) } + def values + end + end end end @@ -215,6 +221,12 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) } W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index e51ab961..43d431c6 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -80,15 +80,21 @@ module FinchAPI TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Income::Unit) } OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Income::Unit::TaggedSymbol) } - YEARLY = T.let(:yearly, FinchAPI::Models::Income::Unit::OrSymbol) - QUARTERLY = T.let(:quarterly, FinchAPI::Models::Income::Unit::OrSymbol) - MONTHLY = T.let(:monthly, FinchAPI::Models::Income::Unit::OrSymbol) - SEMI_MONTHLY = T.let(:semi_monthly, FinchAPI::Models::Income::Unit::OrSymbol) - BI_WEEKLY = T.let(:bi_weekly, FinchAPI::Models::Income::Unit::OrSymbol) - WEEKLY = T.let(:weekly, FinchAPI::Models::Income::Unit::OrSymbol) - DAILY = T.let(:daily, FinchAPI::Models::Income::Unit::OrSymbol) - HOURLY = T.let(:hourly, FinchAPI::Models::Income::Unit::OrSymbol) - FIXED = T.let(:fixed, FinchAPI::Models::Income::Unit::OrSymbol) + YEARLY = T.let(:yearly, FinchAPI::Models::Income::Unit::TaggedSymbol) + QUARTERLY = T.let(:quarterly, FinchAPI::Models::Income::Unit::TaggedSymbol) + MONTHLY = T.let(:monthly, FinchAPI::Models::Income::Unit::TaggedSymbol) + SEMI_MONTHLY = T.let(:semi_monthly, FinchAPI::Models::Income::Unit::TaggedSymbol) + BI_WEEKLY = T.let(:bi_weekly, FinchAPI::Models::Income::Unit::TaggedSymbol) + WEEKLY = T.let(:weekly, FinchAPI::Models::Income::Unit::TaggedSymbol) + DAILY = T.let(:daily, FinchAPI::Models::Income::Unit::TaggedSymbol) + HOURLY = T.let(:hourly, FinchAPI::Models::Income::Unit::TaggedSymbol) + FIXED = T.let(:fixed, FinchAPI::Models::Income::Unit::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Income::Unit::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 1ab21fc9..7a40578c 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -78,6 +78,12 @@ module FinchAPI T.let(:"individual.updated", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) INDIVIDUAL_DELETED = T.let(:"individual.deleted", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index 48faa545..a9b11e37 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -344,6 +344,12 @@ module FinchAPI API_CREDENTIAL = T.let(:api_credential, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) OAUTH = T.let(:oauth, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol]) } + def values + end + end end end @@ -357,6 +363,12 @@ module FinchAPI PRODUCTION = T.let(:production, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) DEVELOPMENT = T.let(:development, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) SANDBOX = T.let(:sandbox, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Introspection::ClientType::TaggedSymbol]) } + def values + end + end end class ConnectionStatus < FinchAPI::BaseModel @@ -403,6 +415,12 @@ module FinchAPI PROVIDER = T.let(:provider, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) FINCH = T.let(:finch, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index 7e75ed92..f54ee167 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -93,6 +93,12 @@ module FinchAPI T.let(:"job.benefit_update.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) JOB_DATA_SYNC_ALL_COMPLETED = T.let(:"job.data_sync_all.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 261c2236..f6ee5732 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -167,6 +167,12 @@ module FinchAPI REAUTH_ERROR = T.let(:reauth_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) PERMISSIONS_ERROR = T.let(:permissions_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol]) } + def values + end + end end # The type of automated job @@ -179,6 +185,12 @@ module FinchAPI DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) W4_FORM_EMPLOYEE_SYNC = T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index bc61057e..090acba2 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -63,7 +63,13 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol) } W4_FORM_EMPLOYEE_SYNC = - T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) + T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol]) } + def values + end + end end class Params < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index ce303e52..5a21d7cb 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -66,6 +66,12 @@ module FinchAPI IN_PROGRESS = T.let(:in_progress, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) ERROR = T.let(:error, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) COMPLETE = T.let(:complete, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/operation_support.rbi b/rbi/lib/finch-api/models/operation_support.rbi index 50202668..2fd5096a 100644 --- a/rbi/lib/finch-api/models/operation_support.rbi +++ b/rbi/lib/finch-api/models/operation_support.rbi @@ -20,6 +20,12 @@ module FinchAPI NOT_SUPPORTED_BY_PROVIDER = T.let(:not_supported_by_provider, FinchAPI::Models::OperationSupport::TaggedSymbol) CLIENT_ACCESS_ONLY = T.let(:client_access_only, FinchAPI::Models::OperationSupport::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::OperationSupport::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 9112d56e..3c57f61f 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -87,6 +87,12 @@ module FinchAPI T.let(:"pay_statement.updated", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) PAY_STATEMENT_DELETED = T.let(:"pay_statement.deleted", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index 079855ee..d6120ae7 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -84,6 +84,12 @@ module FinchAPI PAYMENT_CREATED = T.let(:"payment.created", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) PAYMENT_UPDATED = T.let(:"payment.updated", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) PAYMENT_DELETED = T.let(:"payment.deleted", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index f698413f..4d590212 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -79,6 +79,12 @@ module FinchAPI WEEKLY = T.let(:weekly, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) DAILY = T.let(:daily, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index 952080f9..bb0f6645 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -91,6 +91,14 @@ module FinchAPI WEEKLY = T.let(:weekly, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) DAILY = T.let(:daily, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) + + class << self + sig do + override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index fc69a9e7..08d47c60 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -2652,6 +2652,12 @@ module FinchAPI API_CREDENTIAL = T.let(:api_credential, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) OAUTH = T.let(:oauth, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index 1676913b..b949d5d7 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -226,8 +226,18 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) } CHECKING = - T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol) - SAVINGS = T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol) + T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) + SAVINGS = + T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol]) + end + def values + end + end end end @@ -362,11 +372,17 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) } S_CORPORATION = - T.let(:s_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol) + T.let(:s_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) C_CORPORATION = - T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol) + T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) B_CORPORATION = - T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol) + T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol]) } + def values + end + end end # The tax payer type of the company. @@ -378,14 +394,24 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) } - LLC = T.let(:llc, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) - LP = T.let(:lp, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) - CORPORATION = T.let(:corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + LLC = T.let(:llc, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + LP = T.let(:lp, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + CORPORATION = + T.let(:corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) SOLE_PROPRIETOR = - T.let(:sole_proprietor, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) - NON_PROFIT = T.let(:non_profit, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) - PARTNERSHIP = T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) - COOPERATIVE = T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol) + T.let(:sole_proprietor, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + NON_PROFIT = + T.let(:non_profit, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + PARTNERSHIP = + T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + COOPERATIVE = + T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index 13fb0ab2..bd8dfda9 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -216,6 +216,15 @@ module FinchAPI T.let(:checking, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) SAVINGS = T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol]) + end + def values + end + end end end @@ -355,6 +364,14 @@ module FinchAPI T.let(:c_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) B_CORPORATION = T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) + + class << self + sig do + override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol]) + end + def values + end + end end # The tax payer type of the company. @@ -378,6 +395,12 @@ module FinchAPI T.let(:partnership, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) COOPERATIVE = T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 54550907..5f43a176 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -83,12 +83,22 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) } CREDENTIAL = - T.let(:credential, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + T.let(:credential, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) API_TOKEN = - T.let(:api_token, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) - OAUTH = T.let(:oauth, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + T.let(:api_token, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) + OAUTH = + T.let(:oauth, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) ASSISTED = - T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) + T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol]) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index 43962876..61f31cde 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -134,6 +134,15 @@ module FinchAPI T.let(:oauth, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) ASSISTED = T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol]) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index ad3aac02..286b0932 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -94,20 +94,34 @@ module FinchAPI CREDENTIAL = T.let( :credential, - FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) API_TOKEN = T.let( :api_token, - FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) OAUTH = - T.let(:oauth, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) + T.let( + :oauth, + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol + ) ASSISTED = T.let( :assisted, - FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol] + ) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index 8d52276e..15df1845 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -133,6 +133,17 @@ module FinchAPI :assisted, FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol] + ) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index c87d0b8c..9ba89a9a 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -123,6 +123,17 @@ module FinchAPI :assisted, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol] + ) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index e2837150..b95bb27e 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -547,9 +547,18 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol) + WORK = T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol) + T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol]) + end + def values + end + end end end @@ -615,20 +624,40 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol) } FULL_TIME = - T.let(:full_time, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + T.let( + :full_time, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + ) INTERN = - T.let(:intern, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + T.let(:intern, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol) PART_TIME = - T.let(:part_time, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + T.let( + :part_time, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + ) TEMP = - T.let(:temp, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + T.let(:temp, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol) SEASONAL = - T.let(:seasonal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) + T.let( + :seasonal, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol + ) INDIVIDUAL_CONTRACTOR = T.let( :individual_contractor, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol] + ) + end + def values + end + end end # The main employment type of the individual. @@ -641,9 +670,18 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) } EMPLOYEE = - T.let(:employee, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol) + T.let(:employee, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) CONTRACTOR = - T.let(:contractor, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol) + T.let(:contractor, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol]) + end + def values + end + end end end @@ -657,18 +695,28 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) } ACTIVE = - T.let(:active, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + T.let(:active, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) DECEASED = - T.let(:deceased, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) - LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + T.let(:deceased, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + LEAVE = + T.let(:leave, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) ONBOARDING = - T.let(:onboarding, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + T.let(:onboarding, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) PREHIRE = - T.let(:prehire, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + T.let(:prehire, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) RETIRED = - T.let(:retired, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + T.let(:retired, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) TERMINATED = - T.let(:terminated, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol) + T.let(:terminated, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol]) + end + def values + end + end end # The EEOC-defined ethnicity of the individual. @@ -680,29 +728,43 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) } - ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) - WHITE = T.let(:white, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) + WHITE = T.let(:white, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) BLACK_OR_AFRICAN_AMERICAN = T.let( :black_or_african_american, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let( :native_hawaiian_or_pacific_islander, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let( :american_indian_or_alaska_native, - FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) HISPANIC_OR_LATINO = - T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + T.let( + :hispanic_or_latino, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + ) TWO_OR_MORE_RACES = - T.let(:two_or_more_races, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + T.let(:two_or_more_races, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol) + T.let( + :decline_to_specify, + FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol + ) + + class << self + sig do + override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol]) + end + def values + end + end end # The gender of the individual. @@ -714,11 +776,17 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) } - FEMALE = T.let(:female, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) - MALE = T.let(:male, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) - OTHER = T.let(:other, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) + FEMALE = T.let(:female, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) + MALE = T.let(:male, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol) + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol]) } + def values + end + end end class Manager < FinchAPI::BaseModel @@ -791,9 +859,19 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) + WORK = + T.let(:work, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol) + T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol]) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index c2d05f9f..25207122 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -387,18 +387,28 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) } FULL_TIME = - T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) - INTERN = T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) + INTERN = + T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) PART_TIME = - T.let(:part_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) - TEMP = T.let(:temp, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + T.let(:part_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) + TEMP = T.let(:temp, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) SEASONAL = - T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol) + T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) INDIVIDUAL_CONTRACTOR = T.let( :individual_contractor, - FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol + FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol ) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol]) + end + def values + end + end end # The main employment type of the individual. @@ -411,9 +421,18 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) } EMPLOYEE = - T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol) + T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) CONTRACTOR = - T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol) + T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol]) + end + def values + end + end end end @@ -426,16 +445,28 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) } - ACTIVE = T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + ACTIVE = + T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) DECEASED = - T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) - LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) ONBOARDING = - T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) - PREHIRE = T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) - RETIRED = T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + PREHIRE = + T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + RETIRED = + T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) TERMINATED = - T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol) + T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol]) + end + def values + end + end end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index baa734b1..680f805a 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -409,6 +409,15 @@ module FinchAPI :individual_contractor, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol ) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol]) + end + def values + end + end end # The main employment type of the individual. @@ -424,6 +433,15 @@ module FinchAPI T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) CONTRACTOR = T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol]) + end + def values + end + end end end @@ -450,6 +468,15 @@ module FinchAPI T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) TERMINATED = T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol]) + end + def values + end + end end class Manager < FinchAPI::BaseModel diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index e34d8b33..7f9d107c 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -236,8 +236,14 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol) - PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol) + WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) + PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol]) } + def values + end + end end end @@ -250,26 +256,35 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) } - ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) - WHITE = T.let(:white, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) + WHITE = T.let(:white, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) BLACK_OR_AFRICAN_AMERICAN = - T.let(:black_or_african_american, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + T.let( + :black_or_african_american, + FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol + ) NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let( :native_hawaiian_or_pacific_islander, - FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol ) AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let( :american_indian_or_alaska_native, - FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol + FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol ) HISPANIC_OR_LATINO = - T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) TWO_OR_MORE_RACES = - T.let(:two_or_more_races, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + T.let(:two_or_more_races, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol) + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol]) } + def values + end + end end # The gender of the individual. @@ -280,11 +295,17 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) } - FEMALE = T.let(:female, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) - MALE = T.let(:male, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) - OTHER = T.let(:other, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) + FEMALE = T.let(:female, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) + MALE = T.let(:male, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) + OTHER = T.let(:other, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) DECLINE_TO_SPECIFY = - T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol) + T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol]) } + def values + end + end end class PhoneNumber < FinchAPI::BaseModel @@ -337,9 +358,18 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol) } - WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) + WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol) PERSONAL = - T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol) + T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol]) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index ec4b8100..63f1be1e 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -250,6 +250,12 @@ module FinchAPI WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol]) } + def values + end + end end end @@ -285,6 +291,12 @@ module FinchAPI T.let(:two_or_more_races, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol]) } + def values + end + end end # The gender of the individual. @@ -301,6 +313,12 @@ module FinchAPI OTHER = T.let(:other, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol]) } + def values + end + end end class PhoneNumber < FinchAPI::BaseModel @@ -356,6 +374,15 @@ module FinchAPI WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol]) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index c5b35d84..dd794896 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -45,7 +45,13 @@ module FinchAPI TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type) } OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol) } - DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) + DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index bb9c9fb7..efe6b64d 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -71,6 +71,17 @@ module FinchAPI ) ERROR = T.let(:error, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol] + ) + end + def values + end + end end module Type @@ -83,6 +94,12 @@ module FinchAPI DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) + + class << self + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol]) } + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index 98b35c75..ea955968 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -452,36 +452,57 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) } SALARY = - T.let(:salary, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let(:salary, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) WAGE = - T.let(:wage, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let(:wage, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) REIMBURSEMENT = T.let( :reimbursement, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol ) OVERTIME = - T.let(:overtime, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let( + :overtime, + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) SEVERANCE = - T.let(:severance, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let( + :severance, + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) DOUBLE_OVERTIME = T.let( :double_overtime, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol ) - PTO = T.let(:pto, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + PTO = + T.let(:pto, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) SICK = - T.let(:sick, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let(:sick, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) BONUS = - T.let(:bonus, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let(:bonus, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) COMMISSION = - T.let(:commission, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let( + :commission, + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol + ) TIPS = - T.let(:tips, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let(:tips, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) NUMBER_1099 = - T.let(:"1099", FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let(:"1099", FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) OTHER = - T.let(:other, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) + T.let(:other, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol] + ) + end + def values + end + end end end @@ -842,12 +863,23 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol) } CHECK = - T.let(:check, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol) + T.let(:check, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol) DIRECT_DEPOSIT = T.let( :direct_deposit, - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol ) + + class << self + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol] + ) + end + def values + end + end end class Tax < FinchAPI::BaseModel @@ -1027,11 +1059,23 @@ module FinchAPI OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) } - STATE = T.let(:state, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) + STATE = + T.let(:state, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) FEDERAL = - T.let(:federal, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) - LOCAL = T.let(:local, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) - FICA = T.let(:fica, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol) + T.let(:federal, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) + LOCAL = + T.let(:local, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) + FICA = + T.let(:fica, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol]) + end + def values + end + end end end @@ -1045,11 +1089,23 @@ module FinchAPI T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) } REGULAR_PAYROLL = - T.let(:regular_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) + T.let(:regular_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) OFF_CYCLE_PAYROLL = - T.let(:off_cycle_payroll, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) + T.let( + :off_cycle_payroll, + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol + ) ONE_TIME_PAYMENT = - T.let(:one_time_payment, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) + T.let(:one_time_payment, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) + + class << self + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol]) + end + def values + end + end end end end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index 0703d7e5..51b1e7fb 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -20,6 +20,17 @@ module FinchAPI ) } end + + class << self + sig do + override + .returns( + [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] + ) + end + def variants + end + end end end end diff --git a/sig/finch-api/models/account_update_event.rbs b/sig/finch-api/models/account_update_event.rbs index a959e597..383bffef 100644 --- a/sig/finch-api/models/account_update_event.rbs +++ b/sig/finch-api/models/account_update_event.rbs @@ -1272,7 +1272,7 @@ module FinchAPI API_CREDENTIAL: :api_credential OAUTH: :oauth - def self.values: -> ::Array[FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_] + def self?.values: -> ::Array[FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::type_] end end end @@ -1284,7 +1284,7 @@ module FinchAPI ACCOUNT_UPDATED: :"account.updated" - def self.values: -> ::Array[FinchAPI::Models::AccountUpdateEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::AccountUpdateEvent::event_type] end end end diff --git a/sig/finch-api/models/company_event.rbs b/sig/finch-api/models/company_event.rbs index 7802c4a0..21e92e2d 100644 --- a/sig/finch-api/models/company_event.rbs +++ b/sig/finch-api/models/company_event.rbs @@ -31,7 +31,7 @@ module FinchAPI COMPANY_UPDATED: :"company.updated" - def self.values: -> ::Array[FinchAPI::Models::CompanyEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::CompanyEvent::event_type] end end end diff --git a/sig/finch-api/models/connect/session_new_params.rbs b/sig/finch-api/models/connect/session_new_params.rbs index e437aa22..e5d31aa1 100644 --- a/sig/finch-api/models/connect/session_new_params.rbs +++ b/sig/finch-api/models/connect/session_new_params.rbs @@ -74,7 +74,7 @@ module FinchAPI BENEFITS: :benefits SSN: :ssn - def self.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::product] + def self?.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::product] end type integration = @@ -105,7 +105,7 @@ module FinchAPI OAUTH: :oauth API_TOKEN: :api_token - def self.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method] + def self?.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::Integration::auth_method] end end @@ -117,7 +117,7 @@ module FinchAPI FINCH: :finch PROVIDER: :provider - def self.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::sandbox] + def self?.values: -> ::Array[FinchAPI::Models::Connect::SessionNewParams::sandbox] end end end diff --git a/sig/finch-api/models/connect/session_reauthenticate_params.rbs b/sig/finch-api/models/connect/session_reauthenticate_params.rbs index 4b67b058..33d3d200 100644 --- a/sig/finch-api/models/connect/session_reauthenticate_params.rbs +++ b/sig/finch-api/models/connect/session_reauthenticate_params.rbs @@ -54,7 +54,7 @@ module FinchAPI BENEFITS: :benefits SSN: :ssn - def self.values: -> ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product] + def self?.values: -> ::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::product] end end end diff --git a/sig/finch-api/models/connection_status_type.rbs b/sig/finch-api/models/connection_status_type.rbs index 3b179ccd..3116a419 100644 --- a/sig/finch-api/models/connection_status_type.rbs +++ b/sig/finch-api/models/connection_status_type.rbs @@ -18,7 +18,7 @@ module FinchAPI ERROR_PERMISSIONS: :error_permissions REAUTH: :reauth - def self.values: -> ::Array[FinchAPI::Models::connection_status_type] + def self?.values: -> ::Array[FinchAPI::Models::connection_status_type] end end end diff --git a/sig/finch-api/models/create_access_token_response.rbs b/sig/finch-api/models/create_access_token_response.rbs index a8328b2b..affd7a36 100644 --- a/sig/finch-api/models/create_access_token_response.rbs +++ b/sig/finch-api/models/create_access_token_response.rbs @@ -61,7 +61,7 @@ module FinchAPI DEVELOPMENT: :development SANDBOX: :sandbox - def self.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::client_type] + def self?.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::client_type] end type connection_type = :provider | :finch @@ -72,7 +72,7 @@ module FinchAPI PROVIDER: :provider FINCH: :finch - def self.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::connection_type] + def self?.values: -> ::Array[FinchAPI::Models::CreateAccessTokenResponse::connection_type] end end end diff --git a/sig/finch-api/models/directory_event.rbs b/sig/finch-api/models/directory_event.rbs index e66d5717..8abf30fc 100644 --- a/sig/finch-api/models/directory_event.rbs +++ b/sig/finch-api/models/directory_event.rbs @@ -48,7 +48,7 @@ module FinchAPI DIRECTORY_UPDATED: :"directory.updated" DIRECTORY_DELETED: :"directory.deleted" - def self.values: -> ::Array[FinchAPI::Models::DirectoryEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::DirectoryEvent::event_type] end end end diff --git a/sig/finch-api/models/employment_event.rbs b/sig/finch-api/models/employment_event.rbs index d711d2a4..70ac8f5d 100644 --- a/sig/finch-api/models/employment_event.rbs +++ b/sig/finch-api/models/employment_event.rbs @@ -48,7 +48,7 @@ module FinchAPI EMPLOYMENT_UPDATED: :"employment.updated" EMPLOYMENT_DELETED: :"employment.deleted" - def self.values: -> ::Array[FinchAPI::Models::EmploymentEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::EmploymentEvent::event_type] end end end diff --git a/sig/finch-api/models/hris/benefit_contribution.rbs b/sig/finch-api/models/hris/benefit_contribution.rbs index 8a32db2e..2ef78933 100644 --- a/sig/finch-api/models/hris/benefit_contribution.rbs +++ b/sig/finch-api/models/hris/benefit_contribution.rbs @@ -27,7 +27,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self.values: -> ::Array[FinchAPI::Models::HRIS::BenefitContribution::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitContribution::type_] end end end diff --git a/sig/finch-api/models/hris/benefit_features_and_operations.rbs b/sig/finch-api/models/hris/benefit_features_and_operations.rbs index 715df403..4173cfde 100644 --- a/sig/finch-api/models/hris/benefit_features_and_operations.rbs +++ b/sig/finch-api/models/hris/benefit_features_and_operations.rbs @@ -77,7 +77,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::company_contribution] end type employee_deduction = :fixed | :percent @@ -88,7 +88,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::employee_deduction] end type hsa_contribution_limit = :individual | :family @@ -99,7 +99,7 @@ module FinchAPI INDIVIDUAL: :individual FAMILY: :family - def self.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::hsa_contribution_limit] end end end diff --git a/sig/finch-api/models/hris/benefit_frequency.rbs b/sig/finch-api/models/hris/benefit_frequency.rbs index 4366ba53..849ad28c 100644 --- a/sig/finch-api/models/hris/benefit_frequency.rbs +++ b/sig/finch-api/models/hris/benefit_frequency.rbs @@ -10,7 +10,7 @@ module FinchAPI EVERY_PAYCHECK: :every_paycheck MONTHLY: :monthly - def self.values: -> ::Array[FinchAPI::Models::HRIS::benefit_frequency] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::benefit_frequency] end end end diff --git a/sig/finch-api/models/hris/benefit_type.rbs b/sig/finch-api/models/hris/benefit_type.rbs index a99d027d..d3c1d48b 100644 --- a/sig/finch-api/models/hris/benefit_type.rbs +++ b/sig/finch-api/models/hris/benefit_type.rbs @@ -45,7 +45,7 @@ module FinchAPI CUSTOM_POST_TAX: :custom_post_tax CUSTOM_PRE_TAX: :custom_pre_tax - def self.values: -> ::Array[FinchAPI::Models::HRIS::benefit_type] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::benefit_type] end end end diff --git a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs index 5270850c..d1656d6c 100644 --- a/sig/finch-api/models/hris/benefits/enrolled_individual.rbs +++ b/sig/finch-api/models/hris/benefits/enrolled_individual.rbs @@ -62,7 +62,7 @@ module FinchAPI NOT_FOUND: 404 FORBIDDEN: 403 - def self.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::code] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::code] end end end diff --git a/sig/finch-api/models/hris/benefits/individual_benefit.rbs b/sig/finch-api/models/hris/benefits/individual_benefit.rbs index 164a78d8..598e1822 100644 --- a/sig/finch-api/models/hris/benefits/individual_benefit.rbs +++ b/sig/finch-api/models/hris/benefits/individual_benefit.rbs @@ -72,7 +72,7 @@ module FinchAPI INDIVIDUAL: :individual FAMILY: :family - def self.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::hsa_contribution_limit] end end end diff --git a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs index d47847f1..b1c8ac0b 100644 --- a/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs +++ b/sig/finch-api/models/hris/benefits/individual_enroll_many_params.rbs @@ -101,7 +101,7 @@ module FinchAPI INDIVIDUAL: :individual FAMILY: :family - def self.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::annual_contribution_limit] end type company_contribution = @@ -136,7 +136,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::type_] end end @@ -172,7 +172,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::type_] end end end diff --git a/sig/finch-api/models/hris/company.rbs b/sig/finch-api/models/hris/company.rbs index 20488e62..79f8aa6b 100644 --- a/sig/finch-api/models/hris/company.rbs +++ b/sig/finch-api/models/hris/company.rbs @@ -85,7 +85,7 @@ module FinchAPI CHECKING: :checking SAVINGS: :savings - def self.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Account::account_type] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Account::account_type] end end @@ -145,7 +145,7 @@ module FinchAPI C_CORPORATION: :c_corporation B_CORPORATION: :b_corporation - def self.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::subtype] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::subtype] end type type_ = @@ -168,7 +168,7 @@ module FinchAPI PARTNERSHIP: :partnership COOPERATIVE: :cooperative - def self.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::type_] end end end diff --git a/sig/finch-api/models/hris/document_list_params.rbs b/sig/finch-api/models/hris/document_list_params.rbs index e6fc3393..99b460c9 100644 --- a/sig/finch-api/models/hris/document_list_params.rbs +++ b/sig/finch-api/models/hris/document_list_params.rbs @@ -50,7 +50,7 @@ module FinchAPI W4_2020: :w4_2020 W4_2005: :w4_2005 - def self.values: -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::DocumentListParams::type_] end end end diff --git a/sig/finch-api/models/hris/document_response.rbs b/sig/finch-api/models/hris/document_response.rbs index a3fa4305..e2506e98 100644 --- a/sig/finch-api/models/hris/document_response.rbs +++ b/sig/finch-api/models/hris/document_response.rbs @@ -47,7 +47,7 @@ module FinchAPI W4_2020: :w4_2020 W4_2005: :w4_2005 - def self.values: -> ::Array[FinchAPI::Models::HRIS::DocumentResponse::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::DocumentResponse::type_] end end end diff --git a/sig/finch-api/models/hris/document_retreive_response.rbs b/sig/finch-api/models/hris/document_retreive_response.rbs index aa8ef7c9..e0e55858 100644 --- a/sig/finch-api/models/hris/document_retreive_response.rbs +++ b/sig/finch-api/models/hris/document_retreive_response.rbs @@ -7,7 +7,7 @@ module FinchAPI module DocumentRetreiveResponse extend FinchAPI::Union - def self.variants: -> [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005] + def self?.variants: -> [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005] end end end diff --git a/sig/finch-api/models/hris/employment_data.rbs b/sig/finch-api/models/hris/employment_data.rbs index 73eb4462..88bafd33 100644 --- a/sig/finch-api/models/hris/employment_data.rbs +++ b/sig/finch-api/models/hris/employment_data.rbs @@ -155,7 +155,7 @@ module FinchAPI SEASONAL: :seasonal INDIVIDUAL_CONTRACTOR: :individual_contractor - def self.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::subtype] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::subtype] end type type_ = :employee | :contractor @@ -166,7 +166,7 @@ module FinchAPI EMPLOYEE: :employee CONTRACTOR: :contractor - def self.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::type_] end end @@ -190,7 +190,7 @@ module FinchAPI RETIRED: :retired TERMINATED: :terminated - def self.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::employment_status] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::EmploymentData::employment_status] end type manager = { id: String } diff --git a/sig/finch-api/models/hris/individual.rbs b/sig/finch-api/models/hris/individual.rbs index 25696b2e..cb5aa9f4 100644 --- a/sig/finch-api/models/hris/individual.rbs +++ b/sig/finch-api/models/hris/individual.rbs @@ -93,7 +93,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::Email::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::Email::type_] end end @@ -119,7 +119,7 @@ module FinchAPI TWO_OR_MORE_RACES: :two_or_more_races DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::ethnicity] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::ethnicity] end type gender = :female | :male | :other | :decline_to_specify @@ -132,7 +132,7 @@ module FinchAPI OTHER: :other DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::gender] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::gender] end type phone_number = @@ -161,7 +161,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber::type_] end end end diff --git a/sig/finch-api/models/hris/pay_statement.rbs b/sig/finch-api/models/hris/pay_statement.rbs index eba6727d..f11db80e 100644 --- a/sig/finch-api/models/hris/pay_statement.rbs +++ b/sig/finch-api/models/hris/pay_statement.rbs @@ -150,7 +150,7 @@ module FinchAPI NUMBER_1099: :"1099" OTHER: :other - def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Earning::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Earning::type_] end end @@ -290,7 +290,7 @@ module FinchAPI CHECK: :check DIRECT_DEPOSIT: :direct_deposit - def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::payment_method] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::payment_method] end type tax = @@ -368,7 +368,7 @@ module FinchAPI LOCAL: :local FICA: :fica - def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Tax::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Tax::type_] end end @@ -381,7 +381,7 @@ module FinchAPI OFF_CYCLE_PAYROLL: :off_cycle_payroll ONE_TIME_PAYMENT: :one_time_payment - def self.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::type_] end end end diff --git a/sig/finch-api/models/hris/payment.rbs b/sig/finch-api/models/hris/payment.rbs index b0f586c8..385ece1c 100644 --- a/sig/finch-api/models/hris/payment.rbs +++ b/sig/finch-api/models/hris/payment.rbs @@ -85,7 +85,7 @@ module FinchAPI DAILY: :daily OTHER: :other - def self.values: -> ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::Payment::pay_frequency] end type pay_period = { end_date: String?, start_date: String? } diff --git a/sig/finch-api/models/hris/supported_benefit.rbs b/sig/finch-api/models/hris/supported_benefit.rbs index 56a3a315..8aab6ca1 100644 --- a/sig/finch-api/models/hris/supported_benefit.rbs +++ b/sig/finch-api/models/hris/supported_benefit.rbs @@ -55,7 +55,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::company_contribution] end type employee_deduction = :fixed | :percent @@ -66,7 +66,7 @@ module FinchAPI FIXED: :fixed PERCENT: :percent - def self.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::employee_deduction] end type hsa_contribution_limit = :individual | :family @@ -77,7 +77,7 @@ module FinchAPI INDIVIDUAL: :individual FAMILY: :family - def self.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::SupportedBenefit::hsa_contribution_limit] end end end diff --git a/sig/finch-api/models/hris/w42005.rbs b/sig/finch-api/models/hris/w42005.rbs index 88b66bd0..8259c4d9 100644 --- a/sig/finch-api/models/hris/w42005.rbs +++ b/sig/finch-api/models/hris/w42005.rbs @@ -79,7 +79,7 @@ module FinchAPI EXEMPT: :exempt NON_EXEMPT: :non_exempt - def self.values: -> ::Array[FinchAPI::Models::HRIS::W42005::Data::exemption] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42005::Data::exemption] end type filing_status = @@ -92,7 +92,7 @@ module FinchAPI MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE: :married_but_withhold_at_higher_single_rate SINGLE: :single - def self.values: -> ::Array[FinchAPI::Models::HRIS::W42005::Data::filing_status] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42005::Data::filing_status] end end @@ -103,7 +103,7 @@ module FinchAPI W4_2005: :w4_2005 - def self.values: -> ::Array[FinchAPI::Models::HRIS::W42005::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42005::type_] end end end diff --git a/sig/finch-api/models/hris/w42020.rbs b/sig/finch-api/models/hris/w42020.rbs index 3b29ff29..93732b3f 100644 --- a/sig/finch-api/models/hris/w42020.rbs +++ b/sig/finch-api/models/hris/w42020.rbs @@ -87,7 +87,7 @@ module FinchAPI MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE: :married_filing_jointly_or_qualifying_surviving_spouse SINGLE_OR_MARRIED_FILING_SEPARATELY: :single_or_married_filing_separately - def self.values: -> ::Array[FinchAPI::Models::HRIS::W42020::Data::filing_status] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42020::Data::filing_status] end end @@ -98,7 +98,7 @@ module FinchAPI W4_2020: :w4_2020 - def self.values: -> ::Array[FinchAPI::Models::HRIS::W42020::type_] + def self?.values: -> ::Array[FinchAPI::Models::HRIS::W42020::type_] end end end diff --git a/sig/finch-api/models/income.rbs b/sig/finch-api/models/income.rbs index 47717713..47357e64 100644 --- a/sig/finch-api/models/income.rbs +++ b/sig/finch-api/models/income.rbs @@ -50,7 +50,7 @@ module FinchAPI HOURLY: :hourly FIXED: :fixed - def self.values: -> ::Array[FinchAPI::Models::Income::unit] + def self?.values: -> ::Array[FinchAPI::Models::Income::unit] end end end diff --git a/sig/finch-api/models/individual_event.rbs b/sig/finch-api/models/individual_event.rbs index 50148324..4f8e6783 100644 --- a/sig/finch-api/models/individual_event.rbs +++ b/sig/finch-api/models/individual_event.rbs @@ -48,7 +48,7 @@ module FinchAPI INDIVIDUAL_UPDATED: :"individual.updated" INDIVIDUAL_DELETED: :"individual.deleted" - def self.values: -> ::Array[FinchAPI::Models::IndividualEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::IndividualEvent::event_type] end end end diff --git a/sig/finch-api/models/introspection.rbs b/sig/finch-api/models/introspection.rbs index 2460af9d..257a8217 100644 --- a/sig/finch-api/models/introspection.rbs +++ b/sig/finch-api/models/introspection.rbs @@ -140,7 +140,7 @@ module FinchAPI API_CREDENTIAL: :api_credential OAUTH: :oauth - def self.values: -> ::Array[FinchAPI::Models::Introspection::AuthenticationMethod::type_] + def self?.values: -> ::Array[FinchAPI::Models::Introspection::AuthenticationMethod::type_] end end @@ -153,7 +153,7 @@ module FinchAPI DEVELOPMENT: :development SANDBOX: :sandbox - def self.values: -> ::Array[FinchAPI::Models::Introspection::client_type] + def self?.values: -> ::Array[FinchAPI::Models::Introspection::client_type] end type connection_status = @@ -186,7 +186,7 @@ module FinchAPI PROVIDER: :provider FINCH: :finch - def self.values: -> ::Array[FinchAPI::Models::Introspection::connection_type] + def self?.values: -> ::Array[FinchAPI::Models::Introspection::connection_type] end end end diff --git a/sig/finch-api/models/job_completion_event.rbs b/sig/finch-api/models/job_completion_event.rbs index 695d9353..e45bbf89 100644 --- a/sig/finch-api/models/job_completion_event.rbs +++ b/sig/finch-api/models/job_completion_event.rbs @@ -56,7 +56,7 @@ module FinchAPI JOB_BENEFIT_UPDATE_COMPLETED: :"job.benefit_update.completed" JOB_DATA_SYNC_ALL_COMPLETED: :"job.data_sync_all.completed" - def self.values: -> ::Array[FinchAPI::Models::JobCompletionEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::JobCompletionEvent::event_type] end end end diff --git a/sig/finch-api/models/jobs/automated_async_job.rbs b/sig/finch-api/models/jobs/automated_async_job.rbs index 20a5d1e9..78d7ee27 100644 --- a/sig/finch-api/models/jobs/automated_async_job.rbs +++ b/sig/finch-api/models/jobs/automated_async_job.rbs @@ -77,7 +77,7 @@ module FinchAPI REAUTH_ERROR: :reauth_error PERMISSIONS_ERROR: :permissions_error - def self.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::status] + def self?.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::status] end type type_ = :data_sync_all | :w4_form_employee_sync @@ -88,7 +88,7 @@ module FinchAPI DATA_SYNC_ALL: :data_sync_all W4_FORM_EMPLOYEE_SYNC: :w4_form_employee_sync - def self.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::type_] + def self?.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::type_] end end end diff --git a/sig/finch-api/models/jobs/automated_create_params.rbs b/sig/finch-api/models/jobs/automated_create_params.rbs index 1ab0b450..3338797d 100644 --- a/sig/finch-api/models/jobs/automated_create_params.rbs +++ b/sig/finch-api/models/jobs/automated_create_params.rbs @@ -31,7 +31,7 @@ module FinchAPI W4_FORM_EMPLOYEE_SYNC: :w4_form_employee_sync - def self.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::type_] + def self?.values: -> ::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::type_] end type params = { individual_id: String } diff --git a/sig/finch-api/models/jobs/manual_async_job.rbs b/sig/finch-api/models/jobs/manual_async_job.rbs index a1c171bd..aadf6f21 100644 --- a/sig/finch-api/models/jobs/manual_async_job.rbs +++ b/sig/finch-api/models/jobs/manual_async_job.rbs @@ -33,7 +33,7 @@ module FinchAPI ERROR: :error COMPLETE: :complete - def self.values: -> ::Array[FinchAPI::Models::Jobs::ManualAsyncJob::status] + def self?.values: -> ::Array[FinchAPI::Models::Jobs::ManualAsyncJob::status] end end end diff --git a/sig/finch-api/models/operation_support.rbs b/sig/finch-api/models/operation_support.rbs index cfb6b869..55fd1aab 100644 --- a/sig/finch-api/models/operation_support.rbs +++ b/sig/finch-api/models/operation_support.rbs @@ -14,7 +14,7 @@ module FinchAPI NOT_SUPPORTED_BY_PROVIDER: :not_supported_by_provider CLIENT_ACCESS_ONLY: :client_access_only - def self.values: -> ::Array[FinchAPI::Models::operation_support] + def self?.values: -> ::Array[FinchAPI::Models::operation_support] end end end diff --git a/sig/finch-api/models/pay_statement_event.rbs b/sig/finch-api/models/pay_statement_event.rbs index b827adc2..8ecfbf4a 100644 --- a/sig/finch-api/models/pay_statement_event.rbs +++ b/sig/finch-api/models/pay_statement_event.rbs @@ -54,7 +54,7 @@ module FinchAPI PAY_STATEMENT_UPDATED: :"pay_statement.updated" PAY_STATEMENT_DELETED: :"pay_statement.deleted" - def self.values: -> ::Array[FinchAPI::Models::PayStatementEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::PayStatementEvent::event_type] end end end diff --git a/sig/finch-api/models/payment_event.rbs b/sig/finch-api/models/payment_event.rbs index 696dbce2..252c7d00 100644 --- a/sig/finch-api/models/payment_event.rbs +++ b/sig/finch-api/models/payment_event.rbs @@ -48,7 +48,7 @@ module FinchAPI PAYMENT_UPDATED: :"payment.updated" PAYMENT_DELETED: :"payment.deleted" - def self.values: -> ::Array[FinchAPI::Models::PaymentEvent::event_type] + def self?.values: -> ::Array[FinchAPI::Models::PaymentEvent::event_type] end end end diff --git a/sig/finch-api/models/payroll/pay_group_list_response.rbs b/sig/finch-api/models/payroll/pay_group_list_response.rbs index 39183ee5..4604e029 100644 --- a/sig/finch-api/models/payroll/pay_group_list_response.rbs +++ b/sig/finch-api/models/payroll/pay_group_list_response.rbs @@ -55,7 +55,7 @@ module FinchAPI DAILY: :daily OTHER: :other - def self.values: -> ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] + def self?.values: -> ::Array[FinchAPI::Models::Payroll::PayGroupListResponse::pay_frequency] end end end diff --git a/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs b/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs index b88f01c7..25ef7ffd 100644 --- a/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs +++ b/sig/finch-api/models/payroll/pay_group_retrieve_response.rbs @@ -51,7 +51,7 @@ module FinchAPI DAILY: :daily OTHER: :other - def self.values: -> ::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::pay_frequency] + def self?.values: -> ::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::pay_frequency] end end end diff --git a/sig/finch-api/models/provider.rbs b/sig/finch-api/models/provider.rbs index a2f4e318..10f6b411 100644 --- a/sig/finch-api/models/provider.rbs +++ b/sig/finch-api/models/provider.rbs @@ -1300,7 +1300,7 @@ module FinchAPI API_CREDENTIAL: :api_credential OAUTH: :oauth - def self.values: -> ::Array[FinchAPI::Models::Provider::AuthenticationMethod::type_] + def self?.values: -> ::Array[FinchAPI::Models::Provider::AuthenticationMethod::type_] end end end diff --git a/sig/finch-api/models/sandbox/company_update_params.rbs b/sig/finch-api/models/sandbox/company_update_params.rbs index 5a73c84d..6ed708e3 100644 --- a/sig/finch-api/models/sandbox/company_update_params.rbs +++ b/sig/finch-api/models/sandbox/company_update_params.rbs @@ -86,7 +86,7 @@ module FinchAPI CHECKING: :checking SAVINGS: :savings - def self.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::account_type] end end @@ -146,7 +146,7 @@ module FinchAPI C_CORPORATION: :c_corporation B_CORPORATION: :b_corporation - def self.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::subtype] end type type_ = @@ -169,7 +169,7 @@ module FinchAPI PARTNERSHIP: :partnership COOPERATIVE: :cooperative - def self.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::type_] end end end diff --git a/sig/finch-api/models/sandbox/company_update_response.rbs b/sig/finch-api/models/sandbox/company_update_response.rbs index 74fb906f..f1c9dc63 100644 --- a/sig/finch-api/models/sandbox/company_update_response.rbs +++ b/sig/finch-api/models/sandbox/company_update_response.rbs @@ -81,7 +81,7 @@ module FinchAPI CHECKING: :checking SAVINGS: :savings - def self.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::account_type] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::account_type] end end @@ -141,7 +141,7 @@ module FinchAPI C_CORPORATION: :c_corporation B_CORPORATION: :b_corporation - def self.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::subtype] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::subtype] end type type_ = @@ -164,7 +164,7 @@ module FinchAPI PARTNERSHIP: :partnership COOPERATIVE: :cooperative - def self.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::type_] end end end diff --git a/sig/finch-api/models/sandbox/connection_create_params.rbs b/sig/finch-api/models/sandbox/connection_create_params.rbs index aa58a901..67a6b792 100644 --- a/sig/finch-api/models/sandbox/connection_create_params.rbs +++ b/sig/finch-api/models/sandbox/connection_create_params.rbs @@ -50,7 +50,7 @@ module FinchAPI OAUTH: :oauth ASSISTED: :assisted - def self.values: -> ::Array[FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::ConnectionCreateParams::authentication_type] end end end diff --git a/sig/finch-api/models/sandbox/connection_create_response.rbs b/sig/finch-api/models/sandbox/connection_create_response.rbs index db346f93..a42a0068 100644 --- a/sig/finch-api/models/sandbox/connection_create_response.rbs +++ b/sig/finch-api/models/sandbox/connection_create_response.rbs @@ -55,7 +55,7 @@ module FinchAPI OAUTH: :oauth ASSISTED: :assisted - def self.values: -> ::Array[FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type] end end end diff --git a/sig/finch-api/models/sandbox/connections/account_create_params.rbs b/sig/finch-api/models/sandbox/connections/account_create_params.rbs index a659744e..e0269f75 100644 --- a/sig/finch-api/models/sandbox/connections/account_create_params.rbs +++ b/sig/finch-api/models/sandbox/connections/account_create_params.rbs @@ -50,7 +50,7 @@ module FinchAPI OAUTH: :oauth ASSISTED: :assisted - def self.values: -> ::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateParams::authentication_type] end end end diff --git a/sig/finch-api/models/sandbox/connections/account_create_response.rbs b/sig/finch-api/models/sandbox/connections/account_create_response.rbs index f561e9b8..1dda3ee7 100644 --- a/sig/finch-api/models/sandbox/connections/account_create_response.rbs +++ b/sig/finch-api/models/sandbox/connections/account_create_response.rbs @@ -51,7 +51,7 @@ module FinchAPI OAUTH: :oauth ASSISTED: :assisted - def self.values: -> ::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type] end end end diff --git a/sig/finch-api/models/sandbox/connections/account_update_response.rbs b/sig/finch-api/models/sandbox/connections/account_update_response.rbs index f576c5ea..09d2e17c 100644 --- a/sig/finch-api/models/sandbox/connections/account_update_response.rbs +++ b/sig/finch-api/models/sandbox/connections/account_update_response.rbs @@ -49,7 +49,7 @@ module FinchAPI OAUTH: :oauth ASSISTED: :assisted - def self.values: -> ::Array[FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type] end end end diff --git a/sig/finch-api/models/sandbox/directory_create_params.rbs b/sig/finch-api/models/sandbox/directory_create_params.rbs index d04319ef..9bf5b78c 100644 --- a/sig/finch-api/models/sandbox/directory_create_params.rbs +++ b/sig/finch-api/models/sandbox/directory_create_params.rbs @@ -200,7 +200,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::type_] end end @@ -240,7 +240,7 @@ module FinchAPI SEASONAL: :seasonal INDIVIDUAL_CONTRACTOR: :individual_contractor - def self.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::subtype] end type type_ = :employee | :contractor @@ -251,7 +251,7 @@ module FinchAPI EMPLOYEE: :employee CONTRACTOR: :contractor - def self.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::type_] end end @@ -275,7 +275,7 @@ module FinchAPI RETIRED: :retired TERMINATED: :terminated - def self.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::employment_status] end type ethnicity = @@ -300,7 +300,7 @@ module FinchAPI TWO_OR_MORE_RACES: :two_or_more_races DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::ethnicity] end type gender = :female | :male | :other | :decline_to_specify @@ -313,7 +313,7 @@ module FinchAPI OTHER: :other DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::gender] end type manager = { id: String } @@ -356,7 +356,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::type_] end end end diff --git a/sig/finch-api/models/sandbox/employment_update_params.rbs b/sig/finch-api/models/sandbox/employment_update_params.rbs index 51da85e3..d47b4a39 100644 --- a/sig/finch-api/models/sandbox/employment_update_params.rbs +++ b/sig/finch-api/models/sandbox/employment_update_params.rbs @@ -154,7 +154,7 @@ module FinchAPI SEASONAL: :seasonal INDIVIDUAL_CONTRACTOR: :individual_contractor - def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::subtype] end type type_ = :employee | :contractor @@ -165,7 +165,7 @@ module FinchAPI EMPLOYEE: :employee CONTRACTOR: :contractor - def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::type_] end end @@ -189,7 +189,7 @@ module FinchAPI RETIRED: :retired TERMINATED: :terminated - def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::employment_status] end type manager = { id: String } diff --git a/sig/finch-api/models/sandbox/employment_update_response.rbs b/sig/finch-api/models/sandbox/employment_update_response.rbs index 531b95df..9360ac59 100644 --- a/sig/finch-api/models/sandbox/employment_update_response.rbs +++ b/sig/finch-api/models/sandbox/employment_update_response.rbs @@ -155,7 +155,7 @@ module FinchAPI SEASONAL: :seasonal INDIVIDUAL_CONTRACTOR: :individual_contractor - def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::subtype] end type type_ = :employee | :contractor @@ -166,7 +166,7 @@ module FinchAPI EMPLOYEE: :employee CONTRACTOR: :contractor - def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::type_] end end @@ -190,7 +190,7 @@ module FinchAPI RETIRED: :retired TERMINATED: :terminated - def self.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::employment_status] end type manager = { id: String } diff --git a/sig/finch-api/models/sandbox/individual_update_params.rbs b/sig/finch-api/models/sandbox/individual_update_params.rbs index 3a932830..b2a3240a 100644 --- a/sig/finch-api/models/sandbox/individual_update_params.rbs +++ b/sig/finch-api/models/sandbox/individual_update_params.rbs @@ -92,7 +92,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::type_] end end @@ -118,7 +118,7 @@ module FinchAPI TWO_OR_MORE_RACES: :two_or_more_races DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::ethnicity] end type gender = :female | :male | :other | :decline_to_specify @@ -131,7 +131,7 @@ module FinchAPI OTHER: :other DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::gender] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::gender] end type phone_number = @@ -162,7 +162,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::type_] end end end diff --git a/sig/finch-api/models/sandbox/individual_update_response.rbs b/sig/finch-api/models/sandbox/individual_update_response.rbs index fe0c5cb1..5de3d53b 100644 --- a/sig/finch-api/models/sandbox/individual_update_response.rbs +++ b/sig/finch-api/models/sandbox/individual_update_response.rbs @@ -93,7 +93,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::type_] end end @@ -119,7 +119,7 @@ module FinchAPI TWO_OR_MORE_RACES: :two_or_more_races DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::ethnicity] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::ethnicity] end type gender = :female | :male | :other | :decline_to_specify @@ -132,7 +132,7 @@ module FinchAPI OTHER: :other DECLINE_TO_SPECIFY: :decline_to_specify - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::gender] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::gender] end type phone_number = @@ -163,7 +163,7 @@ module FinchAPI WORK: :work PERSONAL: :personal - def self.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::type_] end end end diff --git a/sig/finch-api/models/sandbox/job_create_params.rbs b/sig/finch-api/models/sandbox/job_create_params.rbs index 7a2a7cae..0e7b8862 100644 --- a/sig/finch-api/models/sandbox/job_create_params.rbs +++ b/sig/finch-api/models/sandbox/job_create_params.rbs @@ -25,7 +25,7 @@ module FinchAPI DATA_SYNC_ALL: :data_sync_all - def self.values: -> ::Array[FinchAPI::Models::Sandbox::JobCreateParams::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::JobCreateParams::type_] end end end diff --git a/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs b/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs index 03612e27..c3c09985 100644 --- a/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs +++ b/sig/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbs @@ -31,7 +31,7 @@ module FinchAPI PERMISSIONS_ERROR: :permissions_error ERROR: :error - def self.values: -> ::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::completion_status] end type type_ = :data_sync_all @@ -41,7 +41,7 @@ module FinchAPI DATA_SYNC_ALL: :data_sync_all - def self.values: -> ::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::type_] end end end diff --git a/sig/finch-api/models/sandbox/payment_create_params.rbs b/sig/finch-api/models/sandbox/payment_create_params.rbs index c5bb3fa1..d858d2ba 100644 --- a/sig/finch-api/models/sandbox/payment_create_params.rbs +++ b/sig/finch-api/models/sandbox/payment_create_params.rbs @@ -185,7 +185,7 @@ module FinchAPI NUMBER_1099: :"1099" OTHER: :other - def self.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::type_] end end @@ -325,7 +325,7 @@ module FinchAPI CHECK: :check DIRECT_DEPOSIT: :direct_deposit - def self.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::payment_method] end type tax = @@ -403,7 +403,7 @@ module FinchAPI LOCAL: :local FICA: :fica - def self.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::type_] end end @@ -416,7 +416,7 @@ module FinchAPI OFF_CYCLE_PAYROLL: :off_cycle_payroll ONE_TIME_PAYMENT: :one_time_payment - def self.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_] + def self?.values: -> ::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::type_] end end end diff --git a/sig/finch-api/models/webhook_event.rbs b/sig/finch-api/models/webhook_event.rbs index 0a2d0587..b6870bda 100644 --- a/sig/finch-api/models/webhook_event.rbs +++ b/sig/finch-api/models/webhook_event.rbs @@ -13,7 +13,7 @@ module FinchAPI module WebhookEvent extend FinchAPI::Union - def self.variants: -> [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] + def self?.variants: -> [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] end end end From a7e45cc2a440752eba32881faeb37b3192634ce7 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 01:02:08 +0000 Subject: [PATCH 58/67] feat: prevent tapioca from introspecting the gem internals (#61) --- README.md | 2 ++ lib/finch-api.rb | 15 +++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index ad7e0ad9..0033c802 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,8 @@ finch.hris.directory.list(request_options: {timeout: 5}) ## Sorbet Support +**This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality. + This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`. What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself. diff --git a/lib/finch-api.rb b/lib/finch-api.rb index 33a05cae..5f55e876 100644 --- a/lib/finch-api.rb +++ b/lib/finch-api.rb @@ -1,5 +1,20 @@ # frozen_string_literal: true +# We already ship the preferred sorbet manifests in the package itself. +# `tapioca` currently does not offer us a way to opt out of unnecessary compilation. +if defined?(:Tapioca) && caller_locations.any? { _1.path.end_with?("tapioca/cli.rb") } + Warning.warn( + <<~WARN + \n + ⚠️ skipped loading of "finch-api" gem under `tapioca`. + + This message is normal and expected if you are running a `tapioca` command, and does not impact `.rbi` generation. + \n + WARN + ) + return +end + # Standard libraries. require "cgi" require "date" From 8a5cbf70086cb9b903b8b54594995332fdf12a29 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 01:27:22 +0000 Subject: [PATCH 59/67] feat: consistently accept `AnyHash` types in parameter positions in sorbet (#62) --- rbi/lib/finch-api/base_client.rbi | 6 +- rbi/lib/finch-api/base_model.rbi | 40 ++--- .../models/access_token_create_params.rbi | 2 +- .../models/account_disconnect_params.rbi | 8 +- .../models/account_introspect_params.rbi | 8 +- .../finch-api/models/account_update_event.rbi | 163 ++++++++++++++---- .../models/connect/session_new_params.rbi | 4 +- .../connect/session_reauthenticate_params.rbi | 2 +- rbi/lib/finch-api/models/directory_event.rbi | 2 +- rbi/lib/finch-api/models/employment_event.rbi | 2 +- .../models/hris/benefit_create_params.rbi | 2 +- .../hris/benefit_features_and_operations.rbi | 4 +- .../models/hris/benefit_list_params.rbi | 8 +- ...benefit_list_supported_benefits_params.rbi | 8 +- .../models/hris/benefit_retrieve_params.rbi | 8 +- .../models/hris/benefit_update_params.rbi | 5 +- .../hris/benefits/enrolled_individual.rbi | 2 +- .../hris/benefits/individual_benefit.rbi | 6 +- .../individual_enroll_many_params.rbi | 17 +- .../individual_enrolled_ids_params.rbi | 8 +- ...dividual_retrieve_many_benefits_params.rbi | 5 +- .../individual_unenroll_many_params.rbi | 2 +- .../hris/benefits/unenrolled_individual.rbi | 2 +- .../models/hris/benefits_support.rbi | 24 +-- rbi/lib/finch-api/models/hris/company.rbi | 4 +- .../models/hris/company_retrieve_params.rbi | 8 +- .../directory_list_individuals_params.rbi | 2 +- .../models/hris/directory_list_params.rbi | 2 +- .../models/hris/document_list_params.rbi | 2 +- .../models/hris/document_list_response.rbi | 5 +- .../models/hris/document_retreive_params.rbi | 8 +- .../finch-api/models/hris/employment_data.rbi | 10 +- .../models/hris/employment_data_response.rbi | 6 +- .../hris/employment_retrieve_many_params.rbi | 2 +- rbi/lib/finch-api/models/hris/individual.rbi | 2 +- .../models/hris/individual_in_directory.rbi | 4 +- .../models/hris/individual_response.rbi | 6 +- .../hris/individual_retrieve_many_params.rbi | 4 +- .../finch-api/models/hris/pay_statement.rbi | 39 +++-- .../models/hris/pay_statement_response.rbi | 6 +- .../hris/pay_statement_response_body.rbi | 5 +- .../pay_statement_retrieve_many_params.rbi | 2 +- rbi/lib/finch-api/models/hris/payment.rbi | 12 +- .../models/hris/payment_list_params.rbi | 2 +- .../models/hris/support_per_benefit_type.rbi | 4 +- rbi/lib/finch-api/models/hris/w42005.rbi | 2 +- rbi/lib/finch-api/models/hris/w42020.rbi | 2 +- rbi/lib/finch-api/models/individual_event.rbi | 2 +- rbi/lib/finch-api/models/introspection.rbi | 4 +- .../finch-api/models/job_completion_event.rbi | 2 +- .../models/jobs/automated_async_job.rbi | 2 +- .../models/jobs/automated_create_params.rbi | 4 +- .../models/jobs/automated_list_params.rbi | 2 +- .../models/jobs/automated_list_response.rbi | 13 +- .../models/jobs/automated_retrieve_params.rbi | 8 +- .../models/jobs/manual_retrieve_params.rbi | 8 +- .../finch-api/models/pay_statement_event.rbi | 2 +- rbi/lib/finch-api/models/payment_event.rbi | 2 +- .../models/payroll/pay_group_list_params.rbi | 2 +- .../payroll/pay_group_retrieve_params.rbi | 8 +- rbi/lib/finch-api/models/provider.rbi | 150 ++++++++++++---- .../finch-api/models/provider_list_params.rbi | 8 +- .../request_forwarding_forward_params.rbi | 2 +- .../request_forwarding_forward_response.rbi | 2 +- .../models/sandbox/company_update_params.rbi | 8 +- .../sandbox/company_update_response.rbi | 6 +- .../sandbox/connection_create_params.rbi | 2 +- .../connections/account_create_params.rbi | 2 +- .../connections/account_update_params.rbi | 2 +- .../sandbox/directory_create_params.rbi | 18 +- .../sandbox/employment_update_params.rbi | 12 +- .../sandbox/employment_update_response.rbi | 10 +- .../sandbox/individual_update_params.rbi | 4 +- .../sandbox/individual_update_response.rbi | 2 +- .../models/sandbox/job_create_params.rbi | 2 +- .../jobs/configuration_retrieve_params.rbi | 8 +- .../jobs/configuration_update_params.rbi | 8 +- .../models/sandbox/payment_create_params.rbi | 56 ++++-- rbi/lib/finch-api/request_options.rbi | 10 +- rbi/lib/finch-api/resources/access_tokens.rbi | 2 +- rbi/lib/finch-api/resources/account.rbi | 4 +- .../finch-api/resources/connect/sessions.rbi | 4 +- rbi/lib/finch-api/resources/hris/benefits.rbi | 10 +- .../resources/hris/benefits/individuals.rbi | 8 +- rbi/lib/finch-api/resources/hris/company.rbi | 2 +- .../finch-api/resources/hris/directory.rbi | 2 +- .../finch-api/resources/hris/documents.rbi | 4 +- .../finch-api/resources/hris/employments.rbi | 2 +- .../finch-api/resources/hris/individuals.rbi | 2 +- .../resources/hris/pay_statements.rbi | 2 +- rbi/lib/finch-api/resources/hris/payments.rbi | 2 +- .../finch-api/resources/jobs/automated.rbi | 6 +- rbi/lib/finch-api/resources/jobs/manual.rbi | 2 +- .../resources/payroll/pay_groups.rbi | 4 +- rbi/lib/finch-api/resources/providers.rbi | 2 +- .../resources/request_forwarding.rbi | 2 +- .../finch-api/resources/sandbox/company.rbi | 2 +- .../resources/sandbox/connections.rbi | 2 +- .../sandbox/connections/accounts.rbi | 4 +- .../finch-api/resources/sandbox/directory.rbi | 2 +- .../resources/sandbox/employment.rbi | 2 +- .../resources/sandbox/individual.rbi | 2 +- rbi/lib/finch-api/resources/sandbox/jobs.rbi | 2 +- .../resources/sandbox/jobs/configuration.rbi | 4 +- .../finch-api/resources/sandbox/payment.rbi | 2 +- rbi/lib/finch-api/util.rbi | 4 +- 106 files changed, 634 insertions(+), 300 deletions(-) diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index f551692c..fef8199f 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -26,7 +26,7 @@ module FinchAPI page: T.nilable(T::Class[FinchAPI::BasePage[FinchAPI::BaseModel]]), stream: T.nilable(T::Class[T.anything]), model: T.nilable(FinchAPI::Converter::Input), - options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) } end @@ -129,7 +129,7 @@ module FinchAPI # @api private sig do overridable - .params(req: FinchAPI::BaseClient::RequestComponentsShape, opts: T::Hash[Symbol, T.anything]) + .params(req: FinchAPI::BaseClient::RequestComponentsShape, opts: FinchAPI::Util::AnyHash) .returns(FinchAPI::BaseClient::RequestInputShape) end private def build_request(req, opts) @@ -175,7 +175,7 @@ module FinchAPI page: T.nilable(T::Class[FinchAPI::BasePage[FinchAPI::BaseModel]]), stream: T.nilable(T::Class[T.anything]), model: T.nilable(FinchAPI::Converter::Input), - options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(T.anything) end diff --git a/rbi/lib/finch-api/base_model.rbi b/rbi/lib/finch-api/base_model.rbi index 393f766d..d5219284 100644 --- a/rbi/lib/finch-api/base_model.rbi +++ b/rbi/lib/finch-api/base_model.rbi @@ -242,8 +242,8 @@ module FinchAPI # @api private sig do params( - key: T.any(Symbol, T::Hash[Symbol, T.anything], T.proc.returns(T.anything), T.anything), - spec: T.any(T::Hash[Symbol, T.anything], T.proc.returns(T.anything), T.anything) + key: T.any(Symbol, FinchAPI::Util::AnyHash, T.proc.returns(T.anything), T.anything), + spec: T.any(FinchAPI::Util::AnyHash, T.proc.returns(T.anything), T.anything) ) .void end @@ -295,11 +295,11 @@ module FinchAPI sig(:final) do params( type_info: T.any( - T::Hash[Symbol, T.anything], + FinchAPI::Util::AnyHash, T.proc.returns(FinchAPI::Converter::Input), FinchAPI::Converter::Input ), - spec: T::Hash[Symbol, T.anything] + spec: FinchAPI::Util::AnyHash ) .returns(T.attached_class) end @@ -350,11 +350,11 @@ module FinchAPI sig(:final) do params( type_info: T.any( - T::Hash[Symbol, T.anything], + FinchAPI::Util::AnyHash, T.proc.returns(FinchAPI::Converter::Input), FinchAPI::Converter::Input ), - spec: T::Hash[Symbol, T.anything] + spec: FinchAPI::Util::AnyHash ) .void end @@ -374,11 +374,11 @@ module FinchAPI sig(:final) do params( type_info: T.any( - T::Hash[Symbol, T.anything], + FinchAPI::Util::AnyHash, T.proc.returns(FinchAPI::Converter::Input), FinchAPI::Converter::Input ), - spec: T::Hash[Symbol, T.anything] + spec: FinchAPI::Util::AnyHash ) .returns(T.attached_class) end @@ -397,7 +397,7 @@ module FinchAPI sig(:final) do override .params(value: T.any(T::Hash[T.anything, T.anything], T.anything)) - .returns(T.any(T::Hash[Symbol, T.anything], T.anything)) + .returns(T.any(FinchAPI::Util::AnyHash, T.anything)) end def coerce(value) end @@ -406,7 +406,7 @@ module FinchAPI sig(:final) do override .params(value: T.any(T::Hash[T.anything, T.anything], T.anything)) - .returns(T.any(T::Hash[Symbol, T.anything], T.anything)) + .returns(T.any(FinchAPI::Util::AnyHash, T.anything)) end def dump(value) end @@ -429,11 +429,11 @@ module FinchAPI sig(:final) do params( type_info: T.any( - T::Hash[Symbol, T.anything], + FinchAPI::Util::AnyHash, T.proc.returns(FinchAPI::Converter::Input), FinchAPI::Converter::Input ), - spec: T::Hash[Symbol, T.anything] + spec: FinchAPI::Util::AnyHash ) .void end @@ -501,7 +501,7 @@ module FinchAPI T.proc.returns(FinchAPI::Converter::Input), FinchAPI::Converter::Input ), - spec: T::Hash[Symbol, T.anything] + spec: FinchAPI::Util::AnyHash ) .void end @@ -513,11 +513,11 @@ module FinchAPI params( name_sym: Symbol, type_info: T.any( - T::Hash[Symbol, T.anything], + FinchAPI::Util::AnyHash, T.proc.returns(FinchAPI::Converter::Input), FinchAPI::Converter::Input ), - spec: T::Hash[Symbol, T.anything] + spec: FinchAPI::Util::AnyHash ) .void end @@ -529,11 +529,11 @@ module FinchAPI params( name_sym: Symbol, type_info: T.any( - T::Hash[Symbol, T.anything], + FinchAPI::Util::AnyHash, T.proc.returns(FinchAPI::Converter::Input), FinchAPI::Converter::Input ), - spec: T::Hash[Symbol, T.anything] + spec: FinchAPI::Util::AnyHash ) .void end @@ -607,7 +607,7 @@ module FinchAPI # # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. - sig { overridable.returns(T::Hash[Symbol, T.anything]) } + sig { overridable.returns(FinchAPI::Util::AnyHash) } def to_h end @@ -619,11 +619,11 @@ module FinchAPI # # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. - sig { overridable.returns(T::Hash[Symbol, T.anything]) } + sig { overridable.returns(FinchAPI::Util::AnyHash) } def to_hash end - sig { params(keys: T.nilable(T::Array[Symbol])).returns(T::Hash[Symbol, T.anything]) } + sig { params(keys: T.nilable(T::Array[Symbol])).returns(FinchAPI::Util::AnyHash) } def deconstruct_keys(keys) end diff --git a/rbi/lib/finch-api/models/access_token_create_params.rbi b/rbi/lib/finch-api/models/access_token_create_params.rbi index 31126cb9..b1d5805f 100644 --- a/rbi/lib/finch-api/models/access_token_create_params.rbi +++ b/rbi/lib/finch-api/models/access_token_create_params.rbi @@ -44,7 +44,7 @@ module FinchAPI client_id: String, client_secret: String, redirect_uri: String, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/account_disconnect_params.rbi b/rbi/lib/finch-api/models/account_disconnect_params.rbi index 3b22ac66..9a204527 100644 --- a/rbi/lib/finch-api/models/account_disconnect_params.rbi +++ b/rbi/lib/finch-api/models/account_disconnect_params.rbi @@ -7,8 +7,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/account_introspect_params.rbi b/rbi/lib/finch-api/models/account_introspect_params.rbi index c7d35ad8..183bc5bb 100644 --- a/rbi/lib/finch-api/models/account_introspect_params.rbi +++ b/rbi/lib/finch-api/models/account_introspect_params.rbi @@ -7,8 +7,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index d3b95886..b10b2e4b 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -27,7 +27,7 @@ module FinchAPI sig do params( - data: FinchAPI::Models::AccountUpdateEvent::Data, + data: T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Util::AnyHash), event_type: FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol ) .returns(T.attached_class) @@ -74,7 +74,7 @@ module FinchAPI sig do params( - authentication_method: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, + authentication_method: T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Util::AnyHash), status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol ) .returns(T.attached_class) @@ -148,8 +148,13 @@ module FinchAPI sig do params( - benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), - supported_fields: T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields), + benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash)), + supported_fields: T.nilable( + T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, + FinchAPI::Util::AnyHash + ) + ), type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol ) .returns(T.attached_class) @@ -349,13 +354,34 @@ module FinchAPI # The supported data fields returned by our HR and payroll endpoints sig do params( - company: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, - directory: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, - employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, - individual: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, - pay_group: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, - pay_statement: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, - payment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment + company: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, + FinchAPI::Util::AnyHash + ), + directory: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, + FinchAPI::Util::AnyHash + ), + employment: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, + FinchAPI::Util::AnyHash + ), + individual: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, + FinchAPI::Util::AnyHash + ), + pay_group: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, + FinchAPI::Util::AnyHash + ), + pay_statement: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, + FinchAPI::Util::AnyHash + ), + payment: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -539,12 +565,24 @@ module FinchAPI sig do params( id: T::Boolean, - accounts: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + accounts: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, + FinchAPI::Util::AnyHash + ), + departments: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, + FinchAPI::Util::AnyHash + ), ein: T::Boolean, - entity: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + entity: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, + FinchAPI::Util::AnyHash + ), legal_name: T::Boolean, - locations: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + locations: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, + FinchAPI::Util::AnyHash + ), primary_email: T::Boolean, primary_phone_number: T::Boolean ) @@ -691,7 +729,10 @@ module FinchAPI sig do params( name: T::Boolean, - parent: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent + parent: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -893,8 +934,14 @@ module FinchAPI sig do params( - individuals: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging + individuals: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, + FinchAPI::Util::AnyHash + ), + paging: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -996,7 +1043,10 @@ module FinchAPI first_name: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + manager: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + FinchAPI::Util::AnyHash + ), middle_name: T::Boolean ) .returns(T.attached_class) @@ -1304,17 +1354,32 @@ module FinchAPI id: T::Boolean, class_code: T::Boolean, custom_fields: T::Boolean, - department: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, - employment: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, + department: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, + FinchAPI::Util::AnyHash + ), + employment: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, + FinchAPI::Util::AnyHash + ), employment_status: T::Boolean, end_date: T::Boolean, first_name: T::Boolean, - income: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, + income: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, + FinchAPI::Util::AnyHash + ), income_history: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - location: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, - manager: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, + location: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, + FinchAPI::Util::AnyHash + ), + manager: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, + FinchAPI::Util::AnyHash + ), middle_name: T::Boolean, start_date: T::Boolean, title: T::Boolean @@ -1714,16 +1779,25 @@ module FinchAPI params( id: T::Boolean, dob: T::Boolean, - emails: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + emails: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, + FinchAPI::Util::AnyHash + ), encrypted_ssn: T::Boolean, ethnicity: T::Boolean, first_name: T::Boolean, gender: T::Boolean, last_name: T::Boolean, middle_name: T::Boolean, - phone_numbers: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + phone_numbers: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + FinchAPI::Util::AnyHash + ), preferred_name: T::Boolean, - residence: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + residence: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, + FinchAPI::Util::AnyHash + ), ssn: T::Boolean ) .returns(T.attached_class) @@ -2016,8 +2090,14 @@ module FinchAPI sig do params( - paging: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + paging: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, + FinchAPI::Util::AnyHash + ), + pay_statements: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -2221,14 +2301,26 @@ module FinchAPI sig do params( - earnings: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - employee_deductions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - employer_contributions: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + earnings: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + FinchAPI::Util::AnyHash + ), + employee_deductions: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + FinchAPI::Util::AnyHash + ), + employer_contributions: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + FinchAPI::Util::AnyHash + ), gross_pay: T::Boolean, individual_id: T::Boolean, net_pay: T::Boolean, payment_method: T::Boolean, - taxes: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + taxes: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + FinchAPI::Util::AnyHash + ), total_hours: T::Boolean, type: T::Boolean ) @@ -2633,7 +2725,10 @@ module FinchAPI pay_date: T::Boolean, pay_frequencies: T::Boolean, pay_group_ids: T::Boolean, - pay_period: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod + pay_period: T.any( + FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 918b1b5b..609baaf8 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -100,12 +100,12 @@ module FinchAPI customer_name: String, products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol], customer_email: T.nilable(String), - integration: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration), + integration: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)), manual: T.nilable(T::Boolean), minutes_to_expire: T.nilable(Float), redirect_uri: T.nilable(String), sandbox: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol), - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 332841e6..1cb856e9 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -53,7 +53,7 @@ module FinchAPI minutes_to_expire: T.nilable(Integer), products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), redirect_uri: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index 0516f6ad..fbef01d1 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -27,7 +27,7 @@ module FinchAPI sig do params( - data: FinchAPI::Models::DirectoryEvent::Data, + data: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Util::AnyHash), event_type: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index 53ad5203..b8599aa3 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -27,7 +27,7 @@ module FinchAPI sig do params( - data: FinchAPI::Models::EmploymentEvent::Data, + data: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Util::AnyHash), event_type: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi index 2b5a7c40..414e2b91 100644 --- a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi @@ -46,7 +46,7 @@ module FinchAPI description: String, frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 58fafeb4..4b550285 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -32,8 +32,8 @@ module FinchAPI sig do params( - supported_features: FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, - supported_operations: FinchAPI::Models::HRIS::SupportPerBenefitType + supported_features: T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, FinchAPI::Util::AnyHash), + supported_operations: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefit_list_params.rbi b/rbi/lib/finch-api/models/hris/benefit_list_params.rbi index 0d10d271..f0175d26 100644 --- a/rbi/lib/finch-api/models/hris/benefit_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_list_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi b/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi index 413b3305..c9b14062 100644 --- a/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_list_supported_benefits_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi b/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi index 37dbfb13..38b0371d 100644 --- a/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_retrieve_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi index 99d5a3ca..c0640c76 100644 --- a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi @@ -19,10 +19,7 @@ module FinchAPI sig do params( description: String, - request_options: T.any( - FinchAPI::RequestOptions, - T::Hash[Symbol, T.anything] - ) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index 57e0d104..c1ea5628 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -38,7 +38,7 @@ module FinchAPI sig do params( - body: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, + body: T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash), code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger, individual_id: String ) diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index e07404fb..014f9fff 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -34,7 +34,7 @@ module FinchAPI sig do params( - body: FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, + body: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash), code: Integer, individual_id: String ) @@ -118,8 +118,8 @@ module FinchAPI params( annual_maximum: T.nilable(Integer), catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable(FinchAPI::Models::HRIS::BenefitContribution), - employee_deduction: T.nilable(FinchAPI::Models::HRIS::BenefitContribution), + company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)), + employee_deduction: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)), hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index ff271c5b..c71a01c9 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -23,7 +23,7 @@ module FinchAPI sig do params( individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end @@ -79,7 +79,10 @@ module FinchAPI sig do params( - configuration: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + configuration: T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, + FinchAPI::Util::AnyHash + ), individual_id: String ) .returns(T.attached_class) @@ -200,8 +203,14 @@ module FinchAPI annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol, annual_maximum: T.nilable(Integer), catch_up: T::Boolean, - company_contribution: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, - employee_deduction: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction + company_contribution: T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, + FinchAPI::Util::AnyHash + ), + employee_deduction: T.any( + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi index 47a06df2..0a8f9470 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_params.rbi @@ -9,8 +9,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi index 2753b624..b539b38b 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi @@ -21,7 +21,10 @@ module FinchAPI sig do params( individual_ids: String, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi index 7c755396..afec0760 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi @@ -20,7 +20,7 @@ module FinchAPI sig do params( individual_ids: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi index 8ec543cd..b537dc0c 100644 --- a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi @@ -35,7 +35,7 @@ module FinchAPI sig do params( - body: FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, + body: T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash), code: Integer, individual_id: String ) diff --git a/rbi/lib/finch-api/models/hris/benefits_support.rbi b/rbi/lib/finch-api/models/hris/benefits_support.rbi index 59f1e7ab..ce43d8a5 100644 --- a/rbi/lib/finch-api/models/hris/benefits_support.rbi +++ b/rbi/lib/finch-api/models/hris/benefits_support.rbi @@ -140,18 +140,18 @@ module FinchAPI # supported, the property will be null sig do params( - commuter: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - custom_post_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - custom_pre_tax: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - fsa_dependent_care: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - fsa_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - hsa_post: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - hsa_pre: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - s125_dental: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - s125_medical: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - s125_vision: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - simple: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations), - simple_ira: T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations) + commuter: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + custom_post_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + custom_pre_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + fsa_dependent_care: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + fsa_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + hsa_post: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + hsa_pre: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + s125_dental: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + s125_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + s125_vision: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + simple: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)), + simple_ira: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 513ba59d..0a9a3786 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -102,7 +102,7 @@ module FinchAPI accounts: T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account]), departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)]), ein: T.nilable(String), - entity: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity), + entity: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Util::AnyHash)), legal_name: T.nilable(String), locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), primary_email: T.nilable(String), @@ -268,7 +268,7 @@ module FinchAPI sig do params( name: T.nilable(String), - parent: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent) + parent: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Util::AnyHash)) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi b/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi index 77c4d11f..ad51c2bc 100644 --- a/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/hris/company_retrieve_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi index 8bf199b4..08b86c41 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi @@ -29,7 +29,7 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/directory_list_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_params.rbi index e1477b5e..d60f2825 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_params.rbi @@ -29,7 +29,7 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index 8411a1a8..3a8a4a79 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -54,7 +54,7 @@ module FinchAPI limit: Integer, offset: Integer, types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/document_list_response.rbi b/rbi/lib/finch-api/models/hris/document_list_response.rbi index 4ebc3438..5367ffff 100644 --- a/rbi/lib/finch-api/models/hris/document_list_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_response.rbi @@ -27,7 +27,10 @@ module FinchAPI end sig do - params(documents: T::Array[FinchAPI::Models::HRIS::DocumentResponse], paging: FinchAPI::Models::Paging) + params( + documents: T::Array[FinchAPI::Models::HRIS::DocumentResponse], + paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash) + ) .returns(T.attached_class) end def self.new(documents:, paging:) diff --git a/rbi/lib/finch-api/models/hris/document_retreive_params.rbi b/rbi/lib/finch-api/models/hris/document_retreive_params.rbi index a2bc8af2..50c4082e 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index c50526c5..d7ed2a8c 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -213,18 +213,18 @@ module FinchAPI id: String, class_code: T.nilable(String), custom_fields: T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]), - department: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department), - employment: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment), + department: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Util::AnyHash)), + employment: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Util::AnyHash)), employment_status: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol), end_date: T.nilable(String), first_name: T.nilable(String), - income: T.nilable(FinchAPI::Models::Income), + income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), - location: T.nilable(FinchAPI::Models::Location), - manager: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Manager), + location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), + manager: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Util::AnyHash)), middle_name: T.nilable(String), source_id: T.nilable(String), start_date: T.nilable(String), diff --git a/rbi/lib/finch-api/models/hris/employment_data_response.rbi b/rbi/lib/finch-api/models/hris/employment_data_response.rbi index 90e69d1d..56ca6b10 100644 --- a/rbi/lib/finch-api/models/hris/employment_data_response.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data_response.rbi @@ -32,7 +32,11 @@ module FinchAPI end sig do - params(body: FinchAPI::Models::HRIS::EmploymentData, code: Integer, individual_id: String) + params( + body: T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Util::AnyHash), + code: Integer, + individual_id: String + ) .returns(T.attached_class) end def self.new(body: nil, code: nil, individual_id: nil) diff --git a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi index c0cdda5e..c4fb7f5e 100644 --- a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi @@ -22,7 +22,7 @@ module FinchAPI sig do params( requests: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index 9849e79c..2f299561 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -150,7 +150,7 @@ module FinchAPI middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber)]), preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), + residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), ssn: T.nilable(String) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi index eae58828..2315d86e 100644 --- a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +++ b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi @@ -82,11 +82,11 @@ module FinchAPI sig do params( id: String, - department: T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Department), + department: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Util::AnyHash)), first_name: T.nilable(String), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), - manager: T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager), + manager: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Util::AnyHash)), middle_name: T.nilable(String) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/individual_response.rbi b/rbi/lib/finch-api/models/hris/individual_response.rbi index 4db36390..42492fd3 100644 --- a/rbi/lib/finch-api/models/hris/individual_response.rbi +++ b/rbi/lib/finch-api/models/hris/individual_response.rbi @@ -32,7 +32,11 @@ module FinchAPI end sig do - params(body: FinchAPI::Models::HRIS::Individual, code: Integer, individual_id: String) + params( + body: T.any(FinchAPI::Models::HRIS::Individual, FinchAPI::Util::AnyHash), + code: Integer, + individual_id: String + ) .returns(T.attached_class) end def self.new(body: nil, code: nil, individual_id: nil) diff --git a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi index ed61411c..354bec27 100644 --- a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi @@ -35,9 +35,9 @@ module FinchAPI sig do params( - options: T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options), + options: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)), requests: T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index dd0330bd..56679989 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -120,9 +120,9 @@ module FinchAPI earnings: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)]), employee_deductions: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)]), employer_contributions: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)]), - gross_pay: T.nilable(FinchAPI::Models::Money), + gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), individual_id: String, - net_pay: T.nilable(FinchAPI::Models::Money), + net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), payment_method: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol), taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]), total_hours: T.nilable(Float), @@ -232,7 +232,7 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes), + attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash)), currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), @@ -276,7 +276,9 @@ module FinchAPI end sig do - params(metadata: FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata) + params( + metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash) + ) .returns(T.attached_class) end def self.new(metadata: nil) @@ -410,7 +412,9 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes), + attributes: T.nilable( + T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash) + ), currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), @@ -460,7 +464,12 @@ module FinchAPI end sig do - params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata) + params( + metadata: T.any( + FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) .returns(T.attached_class) end def self.new(metadata: nil) @@ -557,7 +566,9 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes), + attributes: T.nilable( + T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash) + ), currency: T.nilable(String), name: T.nilable(String), type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) @@ -605,7 +616,12 @@ module FinchAPI end sig do - params(metadata: FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata) + params( + metadata: T.any( + FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) .returns(T.attached_class) end def self.new(metadata: nil) @@ -725,7 +741,7 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes), + attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash)), currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), @@ -765,7 +781,10 @@ module FinchAPI end sig do - params(metadata: FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata).returns(T.attached_class) + params( + metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash) + ) + .returns(T.attached_class) end def self.new(metadata: nil) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi index dc26df12..cfd31e95 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi @@ -32,7 +32,11 @@ module FinchAPI end sig do - params(body: FinchAPI::Models::HRIS::PayStatementResponseBody, code: Integer, payment_id: String) + params( + body: T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Util::AnyHash), + code: Integer, + payment_id: String + ) .returns(T.attached_class) end def self.new(body: nil, code: nil, payment_id: nil) diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi index 0e3caf9f..b6a7e5b1 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi @@ -28,7 +28,10 @@ module FinchAPI end sig do - params(paging: FinchAPI::Models::Paging, pay_statements: T::Array[FinchAPI::Models::HRIS::PayStatement]) + params( + paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash), + pay_statements: T::Array[FinchAPI::Models::HRIS::PayStatement] + ) .returns(T.attached_class) end def self.new(paging: nil, pay_statements: nil) diff --git a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi index 51f5c858..592e3711 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi @@ -22,7 +22,7 @@ module FinchAPI sig do params( requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 8e7a39e1..e4dbf420 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -129,17 +129,17 @@ module FinchAPI sig do params( id: String, - company_debit: T.nilable(FinchAPI::Models::Money), + company_debit: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), debit_date: T.nilable(String), - employee_taxes: T.nilable(FinchAPI::Models::Money), - employer_taxes: T.nilable(FinchAPI::Models::Money), - gross_pay: T.nilable(FinchAPI::Models::Money), + employee_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), + employer_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), + gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), individual_ids: T.nilable(T::Array[String]), - net_pay: T.nilable(FinchAPI::Models::Money), + net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), pay_date: T.nilable(String), pay_frequencies: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]), pay_group_ids: T.nilable(T::Array[String]), - pay_period: T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod) + pay_period: T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Util::AnyHash)) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/payment_list_params.rbi b/rbi/lib/finch-api/models/hris/payment_list_params.rbi index 8266baef..370a0ec5 100644 --- a/rbi/lib/finch-api/models/hris/payment_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/payment_list_params.rbi @@ -31,7 +31,7 @@ module FinchAPI params( end_date: Date, start_date: Date, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi index 79fc7257..1743e2c7 100644 --- a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi @@ -28,8 +28,8 @@ module FinchAPI sig do params( - company_benefits: FinchAPI::Models::OperationSupportMatrix, - individual_benefits: FinchAPI::Models::OperationSupportMatrix + company_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash), + individual_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 685cea99..4aa48ddd 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -41,7 +41,7 @@ module FinchAPI # filing status, dependents, and withholding details. sig do params( - data: FinchAPI::Models::HRIS::W42005::Data, + data: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Util::AnyHash), type: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol, year: T.nilable(Float) ) diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 620cb345..888c6c61 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -41,7 +41,7 @@ module FinchAPI # filing status, dependents, and withholding details. sig do params( - data: FinchAPI::Models::HRIS::W42020::Data, + data: T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Util::AnyHash), type: FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol, year: T.nilable(Float) ) diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 7a40578c..5294e87e 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -27,7 +27,7 @@ module FinchAPI sig do params( - data: FinchAPI::Models::IndividualEvent::Data, + data: T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Util::AnyHash), event_type: FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index a9b11e37..db51922b 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -176,7 +176,7 @@ module FinchAPI client_type: FinchAPI::Models::Introspection::ClientType::TaggedSymbol, company_id: String, connection_id: String, - connection_status: FinchAPI::Models::Introspection::ConnectionStatus, + connection_status: T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Util::AnyHash), connection_type: FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol, customer_email: T.nilable(String), customer_id: T.nilable(String), @@ -274,7 +274,7 @@ module FinchAPI sig do params( - connection_status: FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, + connection_status: T.any(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, FinchAPI::Util::AnyHash), products: T::Array[String], type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol ) diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index f54ee167..f4ae51fe 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -27,7 +27,7 @@ module FinchAPI sig do params( - data: FinchAPI::Models::JobCompletionEvent::Data, + data: T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Util::AnyHash), event_type: FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index f6ee5732..54dd2f00 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -103,7 +103,7 @@ module FinchAPI created_at: Time, job_id: String, job_url: String, - params: T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params), + params: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Util::AnyHash)), scheduled_at: T.nilable(Time), started_at: T.nilable(Time), status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol, diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index 090acba2..cb088c84 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -33,8 +33,8 @@ module FinchAPI sig do params( type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Util::AnyHash), + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi index edda36b7..0cf41f10 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi @@ -29,7 +29,7 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi index 19f50c56..7e4e3f38 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi @@ -29,7 +29,7 @@ module FinchAPI sig do params( data: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], - meta: FinchAPI::Models::Jobs::AutomatedListResponse::Meta + meta: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end @@ -64,7 +64,12 @@ module FinchAPI def quotas=(_) end - sig { params(quotas: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas).returns(T.attached_class) } + sig do + params( + quotas: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Util::AnyHash) + ) + .returns(T.attached_class) + end def self.new(quotas: nil) end @@ -93,7 +98,9 @@ module FinchAPI # (`POST /jobs/automated`). Please contact a Finch representative for more # details. sig do - params(data_sync_all: FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll) + params( + data_sync_all: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, FinchAPI::Util::AnyHash) + ) .returns(T.attached_class) end def self.new(data_sync_all: nil) diff --git a/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi b/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi index 6de22d1f..f4e49c4c 100644 --- a/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_retrieve_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi b/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi index 2cf683b0..f23caf2a 100644 --- a/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_retrieve_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 3c57f61f..3d91974c 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -27,7 +27,7 @@ module FinchAPI sig do params( - data: FinchAPI::Models::PayStatementEvent::Data, + data: T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Util::AnyHash), event_type: FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index d6120ae7..2b569c07 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -27,7 +27,7 @@ module FinchAPI sig do params( - data: FinchAPI::Models::PaymentEvent::Data, + data: T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Util::AnyHash), event_type: FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi index 41e3fc06..bd934429 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi @@ -27,7 +27,7 @@ module FinchAPI params( individual_id: String, pay_frequencies: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi index 34297679..c8bc2f5d 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_params.rbi @@ -8,8 +8,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 08d47c60..f6a384ad 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -195,8 +195,10 @@ module FinchAPI sig do params( - benefits_support: T.nilable(FinchAPI::Models::HRIS::BenefitsSupport), - supported_fields: T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields), + benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash)), + supported_fields: T.nilable( + T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Util::AnyHash) + ), type: FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol ) .returns(T.attached_class) @@ -356,13 +358,28 @@ module FinchAPI # The supported data fields returned by our HR and payroll endpoints sig do params( - company: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, - directory: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, - employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, - individual: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, - pay_group: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, - pay_statement: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, - payment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment + company: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, FinchAPI::Util::AnyHash), + directory: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, + FinchAPI::Util::AnyHash + ), + employment: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, + FinchAPI::Util::AnyHash + ), + individual: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, + FinchAPI::Util::AnyHash + ), + pay_group: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, + FinchAPI::Util::AnyHash + ), + pay_statement: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, + FinchAPI::Util::AnyHash + ), + payment: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end @@ -526,12 +543,24 @@ module FinchAPI sig do params( id: T::Boolean, - accounts: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - departments: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + accounts: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, + FinchAPI::Util::AnyHash + ), + departments: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, + FinchAPI::Util::AnyHash + ), ein: T::Boolean, - entity: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + entity: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, + FinchAPI::Util::AnyHash + ), legal_name: T::Boolean, - locations: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + locations: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, + FinchAPI::Util::AnyHash + ), primary_email: T::Boolean, primary_phone_number: T::Boolean ) @@ -676,7 +705,10 @@ module FinchAPI sig do params( name: T::Boolean, - parent: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent + parent: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -870,8 +902,14 @@ module FinchAPI sig do params( - individuals: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging + individuals: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, + FinchAPI::Util::AnyHash + ), + paging: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -973,7 +1011,10 @@ module FinchAPI first_name: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + manager: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, + FinchAPI::Util::AnyHash + ), middle_name: T::Boolean ) .returns(T.attached_class) @@ -1263,17 +1304,32 @@ module FinchAPI id: T::Boolean, class_code: T::Boolean, custom_fields: T::Boolean, - department: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - employment: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + department: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, + FinchAPI::Util::AnyHash + ), + employment: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, + FinchAPI::Util::AnyHash + ), employment_status: T::Boolean, end_date: T::Boolean, first_name: T::Boolean, - income: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + income: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, + FinchAPI::Util::AnyHash + ), income_history: T::Boolean, is_active: T::Boolean, last_name: T::Boolean, - location: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, - manager: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, + location: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, + FinchAPI::Util::AnyHash + ), + manager: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, + FinchAPI::Util::AnyHash + ), middle_name: T::Boolean, start_date: T::Boolean, title: T::Boolean @@ -1663,16 +1719,25 @@ module FinchAPI params( id: T::Boolean, dob: T::Boolean, - emails: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + emails: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, + FinchAPI::Util::AnyHash + ), encrypted_ssn: T::Boolean, ethnicity: T::Boolean, first_name: T::Boolean, gender: T::Boolean, last_name: T::Boolean, middle_name: T::Boolean, - phone_numbers: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + phone_numbers: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, + FinchAPI::Util::AnyHash + ), preferred_name: T::Boolean, - residence: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + residence: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, + FinchAPI::Util::AnyHash + ), ssn: T::Boolean ) .returns(T.attached_class) @@ -1961,8 +2026,14 @@ module FinchAPI sig do params( - paging: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - pay_statements: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements + paging: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, + FinchAPI::Util::AnyHash + ), + pay_statements: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -2166,14 +2237,26 @@ module FinchAPI sig do params( - earnings: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - employee_deductions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - employer_contributions: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + earnings: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, + FinchAPI::Util::AnyHash + ), + employee_deductions: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, + FinchAPI::Util::AnyHash + ), + employer_contributions: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, + FinchAPI::Util::AnyHash + ), gross_pay: T::Boolean, individual_id: T::Boolean, net_pay: T::Boolean, payment_method: T::Boolean, - taxes: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + taxes: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, + FinchAPI::Util::AnyHash + ), total_hours: T::Boolean, type: T::Boolean ) @@ -2568,7 +2651,10 @@ module FinchAPI pay_date: T::Boolean, pay_frequencies: T::Boolean, pay_group_ids: T::Boolean, - pay_period: FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod + pay_period: T.any( + FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/provider_list_params.rbi b/rbi/lib/finch-api/models/provider_list_params.rbi index 26777e40..4c5e4ae7 100644 --- a/rbi/lib/finch-api/models/provider_list_params.rbi +++ b/rbi/lib/finch-api/models/provider_list_params.rbi @@ -7,8 +7,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi index c50eb830..e0e7523b 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi @@ -65,7 +65,7 @@ module FinchAPI data: T.nilable(String), headers: T.nilable(T.anything), params: T.nilable(T.anything), - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi index c3645ad7..5ec8dbf5 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi @@ -51,7 +51,7 @@ module FinchAPI params( data: T.nilable(String), headers: T.nilable(T.anything), - request: FinchAPI::Models::RequestForwardingForwardResponse::Request, + request: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash), status_code: Integer ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index b949d5d7..302b0ed3 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -97,12 +97,12 @@ module FinchAPI accounts: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]), departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)]), ein: T.nilable(String), - entity: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity), + entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash)), legal_name: T.nilable(String), locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end @@ -274,7 +274,9 @@ module FinchAPI sig do params( name: T.nilable(String), - parent: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent) + parent: T.nilable( + T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Util::AnyHash) + ) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index bd8dfda9..413e0c00 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -96,7 +96,7 @@ module FinchAPI accounts: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account]), departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department)]), ein: T.nilable(String), - entity: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity), + entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Util::AnyHash)), legal_name: T.nilable(String), locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), primary_email: T.nilable(String), @@ -261,7 +261,9 @@ module FinchAPI sig do params( name: T.nilable(String), - parent: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent) + parent: T.nilable( + T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, FinchAPI::Util::AnyHash) + ) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 5f43a176..4205f6d4 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -52,7 +52,7 @@ module FinchAPI authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, employee_size: Integer, products: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index 286b0932..e77e7d8b 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -56,7 +56,7 @@ module FinchAPI provider_id: String, authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, products: T::Array[String], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi index 9fd25006..fc861e05 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi @@ -22,7 +22,7 @@ module FinchAPI sig do params( connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index b95bb27e..0b25ca38 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -23,7 +23,7 @@ module FinchAPI sig do params( body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end @@ -358,27 +358,31 @@ module FinchAPI params( class_code: T.nilable(String), custom_fields: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], - department: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department), + department: T.nilable( + T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash) + ), dob: T.nilable(String), emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]), - employment: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment), + employment: T.nilable( + T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash) + ), employment_status: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol), encrypted_ssn: T.nilable(String), end_date: T.nilable(String), ethnicity: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol), first_name: T.nilable(String), gender: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol), - income: T.nilable(FinchAPI::Models::Income), + income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), - location: T.nilable(FinchAPI::Models::Location), - manager: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager), + location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), + manager: T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)), middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)]), preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), + residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), source_id: String, ssn: T.nilable(String), start_date: T.nilable(String), diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index 25207122..1ee22179 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -209,23 +209,23 @@ module FinchAPI params( class_code: T.nilable(String), custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], - department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department), - employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment), + department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)), + employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)), employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), - income: T.nilable(FinchAPI::Models::Income), + income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), - location: T.nilable(FinchAPI::Models::Location), - manager: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager), + location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), + manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)), middle_name: T.nilable(String), source_id: String, start_date: T.nilable(String), title: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 680f805a..fe916932 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -216,18 +216,18 @@ module FinchAPI id: String, class_code: T.nilable(String), custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], - department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department), - employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment), + department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Util::AnyHash)), + employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Util::AnyHash)), employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol), end_date: T.nilable(String), first_name: T.nilable(String), - income: T.nilable(FinchAPI::Models::Income), + income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), - location: T.nilable(FinchAPI::Models::Location), - manager: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager), + location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), + manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Util::AnyHash)), middle_name: T.nilable(String), source_id: String, start_date: T.nilable(String), diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index 7f9d107c..2266aba4 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -143,9 +143,9 @@ module FinchAPI middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)]), preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), + residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), ssn: T.nilable(String), - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index 63f1be1e..536265d9 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -152,7 +152,7 @@ module FinchAPI middle_name: T.nilable(String), phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]), preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), + residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), ssn: T.nilable(String) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index dd794896..cdc6d389 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -22,7 +22,7 @@ module FinchAPI sig do params( type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi index 73144afb..4f636988 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi @@ -9,8 +9,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi b/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi index c4294ff7..01b47b93 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi @@ -9,8 +9,12 @@ module FinchAPI include FinchAPI::RequestParameters sig do - params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.attached_class) + params( + request_options: T.any( + FinchAPI::RequestOptions, + FinchAPI::Util::AnyHash + ) + ).returns(T.attached_class) end def self.new(request_options: {}) end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index ea955968..ef5cd7ff 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -39,7 +39,7 @@ module FinchAPI end_date: String, pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], start_date: String, - request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]) + request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) end @@ -221,9 +221,9 @@ module FinchAPI employer_contributions: T.nilable( T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)] ), - gross_pay: T.nilable(FinchAPI::Models::Money), + gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), individual_id: String, - net_pay: T.nilable(FinchAPI::Models::Money), + net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol), taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]), total_hours: T.nilable(Float), @@ -349,7 +349,12 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes), + attributes: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, + FinchAPI::Util::AnyHash + ) + ), currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), @@ -404,7 +409,10 @@ module FinchAPI sig do params( - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata + metadata: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -587,7 +595,12 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes), + attributes: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, + FinchAPI::Util::AnyHash + ) + ), currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), @@ -644,7 +657,10 @@ module FinchAPI sig do params( - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata + metadata: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -757,7 +773,12 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes), + attributes: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, + FinchAPI::Util::AnyHash + ) + ), currency: T.nilable(String), name: T.nilable(String), type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) @@ -812,7 +833,10 @@ module FinchAPI sig do params( - metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata + metadata: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) ) .returns(T.attached_class) end @@ -959,7 +983,12 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - attributes: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes), + attributes: T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, + FinchAPI::Util::AnyHash + ) + ), currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), @@ -1013,7 +1042,12 @@ module FinchAPI end sig do - params(metadata: FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata) + params( + metadata: T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, + FinchAPI::Util::AnyHash + ) + ) .returns(T.attached_class) end def self.new(metadata: nil) diff --git a/rbi/lib/finch-api/request_options.rbi b/rbi/lib/finch-api/request_options.rbi index a660f778..feaaa813 100644 --- a/rbi/lib/finch-api/request_options.rbi +++ b/rbi/lib/finch-api/request_options.rbi @@ -4,13 +4,13 @@ module FinchAPI # @api private module RequestParameters # Options to specify HTTP behaviour for this request. - sig { returns(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) } + sig { returns(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) } def request_options end sig do - params(_: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) - .returns(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + params(_: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) + .returns(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) end def request_options=(_) end @@ -18,7 +18,7 @@ module FinchAPI # @api private module Converter # @api private - sig { params(params: T.anything).returns([T.anything, T::Hash[Symbol, T.anything]]) } + sig { params(params: T.anything).returns([T.anything, FinchAPI::Util::AnyHash]) } def dump_request(params) end end @@ -100,7 +100,7 @@ module FinchAPI end # Returns a new instance of RequestOptions. - sig { params(values: T::Hash[Symbol, T.anything]).returns(T.attached_class) } + sig { params(values: FinchAPI::Util::AnyHash).returns(T.attached_class) } def self.new(values = {}) end end diff --git a/rbi/lib/finch-api/resources/access_tokens.rbi b/rbi/lib/finch-api/resources/access_tokens.rbi index 8d154b5b..858bb967 100644 --- a/rbi/lib/finch-api/resources/access_tokens.rbi +++ b/rbi/lib/finch-api/resources/access_tokens.rbi @@ -10,7 +10,7 @@ module FinchAPI client_id: String, client_secret: String, redirect_uri: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::CreateAccessTokenResponse) end diff --git a/rbi/lib/finch-api/resources/account.rbi b/rbi/lib/finch-api/resources/account.rbi index 501f7043..273fc622 100644 --- a/rbi/lib/finch-api/resources/account.rbi +++ b/rbi/lib/finch-api/resources/account.rbi @@ -5,7 +5,7 @@ module FinchAPI class Account # Disconnect one or more `access_token`s from your application. sig do - params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) + params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))) .returns(FinchAPI::Models::DisconnectResponse) end def disconnect(request_options: {}) @@ -13,7 +13,7 @@ module FinchAPI # Read account information associated with an `access_token` sig do - params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) + params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))) .returns(FinchAPI::Models::Introspection) end def introspect(request_options: {}) diff --git a/rbi/lib/finch-api/resources/connect/sessions.rbi b/rbi/lib/finch-api/resources/connect/sessions.rbi index a0141c80..53fc9531 100644 --- a/rbi/lib/finch-api/resources/connect/sessions.rbi +++ b/rbi/lib/finch-api/resources/connect/sessions.rbi @@ -16,7 +16,7 @@ module FinchAPI minutes_to_expire: T.nilable(Float), redirect_uri: T.nilable(String), sandbox: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol), - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Connect::SessionNewResponse) end @@ -43,7 +43,7 @@ module FinchAPI minutes_to_expire: T.nilable(Integer), products: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol]), redirect_uri: T.nilable(String), - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Connect::SessionReauthenticateResponse) end diff --git a/rbi/lib/finch-api/resources/hris/benefits.rbi b/rbi/lib/finch-api/resources/hris/benefits.rbi index d28c60a2..7bc2008b 100644 --- a/rbi/lib/finch-api/resources/hris/benefits.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits.rbi @@ -15,7 +15,7 @@ module FinchAPI description: String, frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol), - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::HRIS::CreateCompanyBenefitsResponse) end @@ -35,7 +35,7 @@ module FinchAPI sig do params( benefit_id: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::HRIS::CompanyBenefit) end @@ -47,7 +47,7 @@ module FinchAPI params( benefit_id: String, description: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::HRIS::UpdateCompanyBenefitResponse) end @@ -61,7 +61,7 @@ module FinchAPI # List all company-wide deductions and contributions. sig do - params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) + params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::CompanyBenefit]) end def list(request_options: {}) @@ -69,7 +69,7 @@ module FinchAPI # Get deductions metadata sig do - params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) + params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::SupportedBenefit]) end def list_supported_benefits(request_options: {}) diff --git a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi index 0cd31c7d..ba7e950f 100644 --- a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi @@ -13,7 +13,7 @@ module FinchAPI params( benefit_id: String, individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual]) end @@ -29,7 +29,7 @@ module FinchAPI sig do params( benefit_id: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsResponse) end @@ -41,7 +41,7 @@ module FinchAPI params( benefit_id: String, individual_ids: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::IndividualBenefit]) end @@ -59,7 +59,7 @@ module FinchAPI params( benefit_id: String, individual_ids: T::Array[String], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual]) end diff --git a/rbi/lib/finch-api/resources/hris/company.rbi b/rbi/lib/finch-api/resources/hris/company.rbi index f8e81ef2..2a1d768a 100644 --- a/rbi/lib/finch-api/resources/hris/company.rbi +++ b/rbi/lib/finch-api/resources/hris/company.rbi @@ -6,7 +6,7 @@ module FinchAPI class Company # Read basic company data sig do - params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) + params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))) .returns(FinchAPI::Models::HRIS::HRISCompany) end def retrieve(request_options: {}) diff --git a/rbi/lib/finch-api/resources/hris/directory.rbi b/rbi/lib/finch-api/resources/hris/directory.rbi index baf601a5..484c94fc 100644 --- a/rbi/lib/finch-api/resources/hris/directory.rbi +++ b/rbi/lib/finch-api/resources/hris/directory.rbi @@ -9,7 +9,7 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::IndividualsPage[FinchAPI::Models::HRIS::IndividualInDirectory]) end diff --git a/rbi/lib/finch-api/resources/hris/documents.rbi b/rbi/lib/finch-api/resources/hris/documents.rbi index 75bf7ae7..358028a3 100644 --- a/rbi/lib/finch-api/resources/hris/documents.rbi +++ b/rbi/lib/finch-api/resources/hris/documents.rbi @@ -12,7 +12,7 @@ module FinchAPI limit: Integer, offset: Integer, types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::HRIS::DocumentListResponse) end @@ -36,7 +36,7 @@ module FinchAPI sig do params( document_id: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)) end diff --git a/rbi/lib/finch-api/resources/hris/employments.rbi b/rbi/lib/finch-api/resources/hris/employments.rbi index 2b264c28..57078b21 100644 --- a/rbi/lib/finch-api/resources/hris/employments.rbi +++ b/rbi/lib/finch-api/resources/hris/employments.rbi @@ -8,7 +8,7 @@ module FinchAPI sig do params( requests: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse]) end diff --git a/rbi/lib/finch-api/resources/hris/individuals.rbi b/rbi/lib/finch-api/resources/hris/individuals.rbi index 96b38afd..f02a9d05 100644 --- a/rbi/lib/finch-api/resources/hris/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/individuals.rbi @@ -9,7 +9,7 @@ module FinchAPI params( options: T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options), requests: T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse]) end diff --git a/rbi/lib/finch-api/resources/hris/pay_statements.rbi b/rbi/lib/finch-api/resources/hris/pay_statements.rbi index dbcd8fd6..7dc8a24a 100644 --- a/rbi/lib/finch-api/resources/hris/pay_statements.rbi +++ b/rbi/lib/finch-api/resources/hris/pay_statements.rbi @@ -11,7 +11,7 @@ module FinchAPI sig do params( requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse]) end diff --git a/rbi/lib/finch-api/resources/hris/payments.rbi b/rbi/lib/finch-api/resources/hris/payments.rbi index 0bf750fd..29559d86 100644 --- a/rbi/lib/finch-api/resources/hris/payments.rbi +++ b/rbi/lib/finch-api/resources/hris/payments.rbi @@ -9,7 +9,7 @@ module FinchAPI params( end_date: Date, start_date: Date, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Payment]) end diff --git a/rbi/lib/finch-api/resources/jobs/automated.rbi b/rbi/lib/finch-api/resources/jobs/automated.rbi index 7d0004a9..de4ecde9 100644 --- a/rbi/lib/finch-api/resources/jobs/automated.rbi +++ b/rbi/lib/finch-api/resources/jobs/automated.rbi @@ -22,7 +22,7 @@ module FinchAPI params( type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Jobs::AutomatedCreateResponse) end @@ -38,7 +38,7 @@ module FinchAPI sig do params( job_id: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Jobs::AutomatedAsyncJob) end @@ -52,7 +52,7 @@ module FinchAPI params( limit: Integer, offset: Integer, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Jobs::AutomatedListResponse) end diff --git a/rbi/lib/finch-api/resources/jobs/manual.rbi b/rbi/lib/finch-api/resources/jobs/manual.rbi index 2c65d526..d297bc2a 100644 --- a/rbi/lib/finch-api/resources/jobs/manual.rbi +++ b/rbi/lib/finch-api/resources/jobs/manual.rbi @@ -9,7 +9,7 @@ module FinchAPI sig do params( job_id: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Jobs::ManualAsyncJob) end diff --git a/rbi/lib/finch-api/resources/payroll/pay_groups.rbi b/rbi/lib/finch-api/resources/payroll/pay_groups.rbi index ecd6e80c..ea721705 100644 --- a/rbi/lib/finch-api/resources/payroll/pay_groups.rbi +++ b/rbi/lib/finch-api/resources/payroll/pay_groups.rbi @@ -8,7 +8,7 @@ module FinchAPI sig do params( pay_group_id: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Payroll::PayGroupRetrieveResponse) end @@ -20,7 +20,7 @@ module FinchAPI params( individual_id: String, pay_frequencies: T::Array[String], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::SinglePage[FinchAPI::Models::Payroll::PayGroupListResponse]) end diff --git a/rbi/lib/finch-api/resources/providers.rbi b/rbi/lib/finch-api/resources/providers.rbi index c2333724..f8e8922a 100644 --- a/rbi/lib/finch-api/resources/providers.rbi +++ b/rbi/lib/finch-api/resources/providers.rbi @@ -5,7 +5,7 @@ module FinchAPI class Providers # Return details on all available payroll and HR systems. sig do - params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) + params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))) .returns(FinchAPI::SinglePage[FinchAPI::Models::Provider]) end def list(request_options: {}) diff --git a/rbi/lib/finch-api/resources/request_forwarding.rbi b/rbi/lib/finch-api/resources/request_forwarding.rbi index ee1ab755..80e9893d 100644 --- a/rbi/lib/finch-api/resources/request_forwarding.rbi +++ b/rbi/lib/finch-api/resources/request_forwarding.rbi @@ -14,7 +14,7 @@ module FinchAPI data: T.nilable(String), headers: T.nilable(T.anything), params: T.nilable(T.anything), - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::RequestForwardingForwardResponse) end diff --git a/rbi/lib/finch-api/resources/sandbox/company.rbi b/rbi/lib/finch-api/resources/sandbox/company.rbi index 3b19708a..a7cd242a 100644 --- a/rbi/lib/finch-api/resources/sandbox/company.rbi +++ b/rbi/lib/finch-api/resources/sandbox/company.rbi @@ -15,7 +15,7 @@ module FinchAPI locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String), - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::CompanyUpdateResponse) end diff --git a/rbi/lib/finch-api/resources/sandbox/connections.rbi b/rbi/lib/finch-api/resources/sandbox/connections.rbi index 7a8d41df..13a41a34 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections.rbi @@ -15,7 +15,7 @@ module FinchAPI authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol, employee_size: Integer, products: T::Array[String], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse) end diff --git a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi index 6672b56c..b9c04168 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections/accounts.rbi @@ -12,7 +12,7 @@ module FinchAPI provider_id: String, authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol, products: T::Array[String], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse) end @@ -33,7 +33,7 @@ module FinchAPI sig do params( connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse) end diff --git a/rbi/lib/finch-api/resources/sandbox/directory.rbi b/rbi/lib/finch-api/resources/sandbox/directory.rbi index 1303040b..1c3407c7 100644 --- a/rbi/lib/finch-api/resources/sandbox/directory.rbi +++ b/rbi/lib/finch-api/resources/sandbox/directory.rbi @@ -8,7 +8,7 @@ module FinchAPI sig do params( body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(T::Array[T.anything]) end diff --git a/rbi/lib/finch-api/resources/sandbox/employment.rbi b/rbi/lib/finch-api/resources/sandbox/employment.rbi index b64a60aa..200e2244 100644 --- a/rbi/lib/finch-api/resources/sandbox/employment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/employment.rbi @@ -26,7 +26,7 @@ module FinchAPI source_id: String, start_date: T.nilable(String), title: T.nilable(String), - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::EmploymentUpdateResponse) end diff --git a/rbi/lib/finch-api/resources/sandbox/individual.rbi b/rbi/lib/finch-api/resources/sandbox/individual.rbi index 42976298..2fd6cc60 100644 --- a/rbi/lib/finch-api/resources/sandbox/individual.rbi +++ b/rbi/lib/finch-api/resources/sandbox/individual.rbi @@ -20,7 +20,7 @@ module FinchAPI preferred_name: T.nilable(String), residence: T.nilable(FinchAPI::Models::Location), ssn: T.nilable(String), - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::IndividualUpdateResponse) end diff --git a/rbi/lib/finch-api/resources/sandbox/jobs.rbi b/rbi/lib/finch-api/resources/sandbox/jobs.rbi index 50c98672..8ebdbefc 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs.rbi @@ -12,7 +12,7 @@ module FinchAPI sig do params( type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::JobCreateResponse) end diff --git a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi index 6b905516..627d34aa 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi @@ -7,7 +7,7 @@ module FinchAPI class Configuration # Get configurations for sandbox jobs sig do - params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))) + params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))) .returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]) end def retrieve(request_options: {}) @@ -18,7 +18,7 @@ module FinchAPI params( completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol, type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration) end diff --git a/rbi/lib/finch-api/resources/sandbox/payment.rbi b/rbi/lib/finch-api/resources/sandbox/payment.rbi index 28b80658..76b28dd8 100644 --- a/rbi/lib/finch-api/resources/sandbox/payment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/payment.rbi @@ -10,7 +10,7 @@ module FinchAPI end_date: String, pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], start_date: String, - request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])) + request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Sandbox::PaymentCreateResponse) end diff --git a/rbi/lib/finch-api/util.rbi b/rbi/lib/finch-api/util.rbi index 0ceed529..e005e5d8 100644 --- a/rbi/lib/finch-api/util.rbi +++ b/rbi/lib/finch-api/util.rbi @@ -3,6 +3,8 @@ module FinchAPI # @api private module Util + # Due to the current WIP status of Shapes support in Sorbet, types referencing + # this alias might be refined in the future. AnyHash = T.type_alias { T::Hash[Symbol, T.anything] } # @api private @@ -87,7 +89,7 @@ module FinchAPI # @api private sig do params( - data: T.any(T::Hash[Symbol, T.anything], T::Array[T.anything], T.anything), + data: T.any(FinchAPI::Util::AnyHash, T::Array[T.anything], T.anything), pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])), sentinel: T.nilable(T.anything), blk: T.nilable(T.proc.returns(T.anything)) From 727a5b5a14aa309e4db8a21fac8689f8924863df Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 08:17:13 +0000 Subject: [PATCH 60/67] chore: recursively accept `AnyHash` for `BaseModel`s in arrays and hashes (#63) --- .../finch-api/models/account_update_event.rbi | 14 +++--- rbi/lib/finch-api/models/company_event.rbi | 6 +-- .../models/create_access_token_response.rbi | 4 +- rbi/lib/finch-api/models/directory_event.rbi | 6 +-- rbi/lib/finch-api/models/employment_event.rbi | 6 +-- .../models/hris/benefit_contribution.rbi | 2 +- .../hris/benefit_features_and_operations.rbi | 12 ++--- .../hris/benefits/enrolled_individual.rbi | 6 +-- .../hris/benefits/individual_benefit.rbi | 2 +- .../individual_enroll_many_params.rbi | 10 +++-- rbi/lib/finch-api/models/hris/company.rbi | 14 +++--- .../finch-api/models/hris/company_benefit.rbi | 4 +- .../models/hris/document_list_response.rbi | 2 +- .../models/hris/document_response.rbi | 6 +-- .../finch-api/models/hris/employment_data.rbi | 10 ++--- .../hris/employment_retrieve_many_params.rbi | 2 +- rbi/lib/finch-api/models/hris/individual.rbi | 14 +++--- .../hris/individual_retrieve_many_params.rbi | 10 +++-- .../finch-api/models/hris/pay_statement.rbi | 26 ++++++----- .../hris/pay_statement_response_body.rbi | 6 +-- .../pay_statement_retrieve_many_params.rbi | 2 +- rbi/lib/finch-api/models/hris/payment.rbi | 2 +- .../models/hris/supported_benefit.rbi | 18 +++----- rbi/lib/finch-api/models/hris/w42005.rbi | 18 ++++---- rbi/lib/finch-api/models/hris/w42020.rbi | 8 ++-- rbi/lib/finch-api/models/individual_event.rbi | 6 +-- rbi/lib/finch-api/models/introspection.rbi | 26 +++++------ .../finch-api/models/job_completion_event.rbi | 6 +-- .../models/jobs/automated_async_job.rbi | 4 +- .../models/jobs/automated_list_response.rbi | 2 +- .../models/jobs/manual_async_job.rbi | 2 +- .../models/operation_support_matrix.rbi | 24 +++++----- .../finch-api/models/pay_statement_event.rbi | 6 +-- rbi/lib/finch-api/models/payment_event.rbi | 6 +-- .../payroll/pay_group_list_response.rbi | 6 +-- .../payroll/pay_group_retrieve_response.rbi | 2 +- rbi/lib/finch-api/models/provider.rbi | 12 ++--- .../models/sandbox/company_update_params.rbi | 10 +++-- .../sandbox/company_update_response.rbi | 16 ++++--- .../sandbox/connection_create_response.rbi | 2 +- .../connections/account_create_response.rbi | 2 +- .../connections/account_update_response.rbi | 2 +- .../sandbox/directory_create_params.rbi | 32 ++++++++++---- .../sandbox/employment_update_params.rbi | 12 +++-- .../sandbox/employment_update_response.rbi | 18 +++++--- .../sandbox/individual_update_params.rbi | 8 +++- .../sandbox/individual_update_response.rbi | 20 ++++++--- .../jobs/sandbox_job_configuration.rbi | 4 +- .../models/sandbox/payment_create_params.rbi | 44 ++++++++++++++++--- .../finch-api/resources/connect/sessions.rbi | 2 +- .../resources/hris/benefits/individuals.rbi | 2 +- .../finch-api/resources/hris/employments.rbi | 2 +- .../finch-api/resources/hris/individuals.rbi | 4 +- .../resources/hris/pay_statements.rbi | 2 +- .../finch-api/resources/jobs/automated.rbi | 2 +- .../finch-api/resources/sandbox/company.rbi | 12 +++-- .../finch-api/resources/sandbox/directory.rbi | 2 +- .../resources/sandbox/employment.rbi | 14 +++--- .../resources/sandbox/individual.rbi | 10 +++-- .../finch-api/resources/sandbox/payment.rbi | 2 +- 60 files changed, 314 insertions(+), 222 deletions(-) diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index b10b2e4b..80eb6a50 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -19,8 +19,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol) end def event_type=(_) end @@ -28,7 +28,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Util::AnyHash), - event_type: FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol ) .returns(T.attached_class) end @@ -75,7 +75,7 @@ module FinchAPI sig do params( authentication_method: T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Util::AnyHash), - status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol + status: FinchAPI::Models::ConnectionStatusType::OrSymbol ) .returns(T.attached_class) end @@ -140,8 +140,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) + params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol) + .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol) end def type=(_) end @@ -155,7 +155,7 @@ module FinchAPI FinchAPI::Util::AnyHash ) ), - type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol + type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index acba3f87..9d2cb25b 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -18,8 +18,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::CompanyEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::CompanyEvent::EventType::OrSymbol) end def event_type=(_) end @@ -27,7 +27,7 @@ module FinchAPI sig do params( data: T.nilable(T::Hash[Symbol, T.anything]), - event_type: FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::CompanyEvent::EventType::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index df3cc706..e906fa24 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -109,10 +109,10 @@ module FinchAPI params( access_token: String, account_id: String, - client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol, + client_type: FinchAPI::Models::CreateAccessTokenResponse::ClientType::OrSymbol, company_id: String, connection_id: String, - connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol, + connection_type: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::OrSymbol, products: T::Array[String], provider_id: String, customer_id: T.nilable(String), diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index fbef01d1..91004480 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -19,8 +19,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::DirectoryEvent::EventType::OrSymbol) end def event_type=(_) end @@ -28,7 +28,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Util::AnyHash), - event_type: FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index b8599aa3..64c055e9 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -19,8 +19,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::EmploymentEvent::EventType::OrSymbol) end def event_type=(_) end @@ -28,7 +28,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Util::AnyHash), - event_type: FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index 5e205ff8..a501831c 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -28,7 +28,7 @@ module FinchAPI sig do params( amount: T.nilable(Integer), - type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 4b550285..616b31da 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -164,8 +164,8 @@ module FinchAPI end sig do - params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) - .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) + params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) + .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) end def frequencies=(_) end @@ -216,7 +216,7 @@ module FinchAPI company_contribution: T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::OrSymbol ) ] ), @@ -224,15 +224,15 @@ module FinchAPI employee_deduction: T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::OrSymbol ) ] ), - frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], + frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)], hsa_contribution_limit: T.nilable( T::Array[ T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::OrSymbol ) ] ) diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index c1ea5628..03f97c07 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -22,8 +22,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) - .returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) + params(_: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger) + .returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger) end def code=(_) end @@ -39,7 +39,7 @@ module FinchAPI sig do params( body: T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash), - code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger, + code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger, individual_id: String ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index 014f9fff..c7d7e603 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -120,7 +120,7 @@ module FinchAPI catch_up: T.nilable(T::Boolean), company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)), employee_deduction: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)), - hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) + hsa_contribution_limit: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index c71a01c9..04135eb2 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -14,15 +14,19 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual]) - .returns(T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual]) + params( + _: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)] + ) + .returns( + T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)] + ) end def individuals=(_) end sig do params( - individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + individuals: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)], request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 0a9a3786..71699afa 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -99,12 +99,14 @@ module FinchAPI sig do params( id: String, - accounts: T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account]), - departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)]), + accounts: T.nilable(T::Array[T.any(FinchAPI::Models::HRIS::HRISCompany::Account, FinchAPI::Util::AnyHash)]), + departments: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department, FinchAPI::Util::AnyHash))] + ), ein: T.nilable(String), entity: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Util::AnyHash)), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), + locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String) ) @@ -196,7 +198,7 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol), + account_type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::OrSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) ) @@ -333,8 +335,8 @@ module FinchAPI # The entity type object. sig do params( - subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) + subtype: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/company_benefit.rbi b/rbi/lib/finch-api/models/hris/company_benefit.rbi index ec7b6428..89693e17 100644 --- a/rbi/lib/finch-api/models/hris/company_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/company_benefit.rbi @@ -47,8 +47,8 @@ module FinchAPI params( benefit_id: String, description: T.nilable(String), - frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + frequency: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/document_list_response.rbi b/rbi/lib/finch-api/models/hris/document_list_response.rbi index 5367ffff..2856c373 100644 --- a/rbi/lib/finch-api/models/hris/document_list_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_response.rbi @@ -28,7 +28,7 @@ module FinchAPI sig do params( - documents: T::Array[FinchAPI::Models::HRIS::DocumentResponse], + documents: T::Array[T.any(FinchAPI::Models::HRIS::DocumentResponse, FinchAPI::Util::AnyHash)], paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index bfd0b645..39e2e0ff 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -29,8 +29,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) - .returns(FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) + params(_: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol) + .returns(FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol) end def type=(_) end @@ -58,7 +58,7 @@ module FinchAPI params( id: String, individual_id: T.nilable(String), - type: FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol, + type: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol, url: String, year: T.nilable(Float) ) diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index d7ed2a8c..51b49dc2 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -212,14 +212,14 @@ module FinchAPI params( id: String, class_code: T.nilable(String), - custom_fields: T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField]), + custom_fields: T.nilable(T::Array[T.any(FinchAPI::Models::HRIS::EmploymentData::CustomField, FinchAPI::Util::AnyHash)]), department: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Util::AnyHash)), employment: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Util::AnyHash)), - employment_status: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol), + employment_status: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), + income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), @@ -362,8 +362,8 @@ module FinchAPI # The employment object. sig do params( - subtype: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) + subtype: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi index c4fb7f5e..c5834412 100644 --- a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi @@ -21,7 +21,7 @@ module FinchAPI sig do params( - requests: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], + requests: T::Array[T.any(FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request, FinchAPI::Util::AnyHash)], request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index 2f299561..4196fdb3 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -141,14 +141,16 @@ module FinchAPI params( id: String, dob: T.nilable(String), - emails: T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::Email]), + emails: T.nilable(T::Array[T.any(FinchAPI::Models::HRIS::Individual::Email, FinchAPI::Util::AnyHash)]), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol), + ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::OrSymbol), first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol), + gender: T.nilable(FinchAPI::Models::HRIS::Individual::Gender::OrSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), - phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber)]), + phone_numbers: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::Individual::PhoneNumber, FinchAPI::Util::AnyHash))] + ), preferred_name: T.nilable(String), residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), ssn: T.nilable(String) @@ -216,7 +218,7 @@ module FinchAPI end sig do - params(data: String, type: T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) + params(data: String, type: T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::OrSymbol)) .returns(T.attached_class) end def self.new(data: nil, type: nil) @@ -317,7 +319,7 @@ module FinchAPI sig do params( data: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) + type: T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi index 354bec27..338463c7 100644 --- a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi @@ -27,8 +27,12 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request]) - .returns(T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request]) + params( + _: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Util::AnyHash)] + ) + .returns( + T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Util::AnyHash)] + ) end def requests=(_) end @@ -36,7 +40,7 @@ module FinchAPI sig do params( options: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)), - requests: T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + requests: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Util::AnyHash)], request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 56679989..0fe4f30b 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -117,16 +117,22 @@ module FinchAPI sig do params( - earnings: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)]), - employee_deductions: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)]), - employer_contributions: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)]), + earnings: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning, FinchAPI::Util::AnyHash))] + ), + employee_deductions: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction, FinchAPI::Util::AnyHash))] + ), + employer_contributions: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution, FinchAPI::Util::AnyHash))] + ), gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), individual_id: String, net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), - payment_method: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol), - taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)]), + payment_method: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::OrSymbol), + taxes: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax, FinchAPI::Util::AnyHash))]), total_hours: T.nilable(Float), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::OrSymbol) ) .returns(T.attached_class) end @@ -236,7 +242,7 @@ module FinchAPI currency: T.nilable(String), hours: T.nilable(Float), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::OrSymbol) ) .returns(T.attached_class) end @@ -418,7 +424,7 @@ module FinchAPI currency: T.nilable(String), name: T.nilable(String), pre_tax: T.nilable(T::Boolean), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) ) .returns(T.attached_class) end @@ -571,7 +577,7 @@ module FinchAPI ), currency: T.nilable(String), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) ) .returns(T.attached_class) end @@ -745,7 +751,7 @@ module FinchAPI currency: T.nilable(String), employer: T.nilable(T::Boolean), name: T.nilable(String), - type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) + type: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi index b6a7e5b1..c2e3dd0d 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi @@ -21,8 +21,8 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::HRIS::PayStatement]) - .returns(T::Array[FinchAPI::Models::HRIS::PayStatement]) + params(_: T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Util::AnyHash)]) + .returns(T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Util::AnyHash)]) end def pay_statements=(_) end @@ -30,7 +30,7 @@ module FinchAPI sig do params( paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash), - pay_statements: T::Array[FinchAPI::Models::HRIS::PayStatement] + pay_statements: T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Util::AnyHash)] ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi index 592e3711..4cf09209 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi @@ -21,7 +21,7 @@ module FinchAPI sig do params( - requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], + requests: T::Array[T.any(FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request, FinchAPI::Util::AnyHash)], request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index e4dbf420..576954c0 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -137,7 +137,7 @@ module FinchAPI individual_ids: T.nilable(T::Array[String]), net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), pay_date: T.nilable(String), - pay_frequencies: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]), + pay_frequencies: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::OrSymbol]), pay_group_ids: T.nilable(T::Array[String]), pay_period: T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Util::AnyHash)) ) diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index ef1cce5d..f9e24a7d 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -85,8 +85,8 @@ module FinchAPI end sig do - params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) - .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)]) + params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) + .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) end def frequencies=(_) end @@ -134,16 +134,12 @@ module FinchAPI params( annual_maximum: T.nilable(T::Boolean), catch_up: T.nilable(T::Boolean), - company_contribution: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] - ), + company_contribution: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::OrSymbol)]), description: T.nilable(String), - employee_deduction: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]), - frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)], - hsa_contribution_limit: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] - ), - type: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) + employee_deduction: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::OrSymbol)]), + frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)], + hsa_contribution_limit: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::OrSymbol)]), + type: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 4aa48ddd..8fd4bf26 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -22,8 +22,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) - .returns(FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) + params(_: FinchAPI::Models::HRIS::W42005::Type::OrSymbol) + .returns(FinchAPI::Models::HRIS::W42005::Type::OrSymbol) end def type=(_) end @@ -42,7 +42,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Util::AnyHash), - type: FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol, + type: FinchAPI::Models::HRIS::W42005::Type::OrSymbol, year: T.nilable(Float) ) .returns(T.attached_class) @@ -79,8 +79,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) - .returns(FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) + params(_: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol) + .returns(FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol) end def exemption=(_) end @@ -91,8 +91,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) - .returns(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) + params(_: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol) + .returns(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol) end def filing_status=(_) end @@ -119,8 +119,8 @@ module FinchAPI sig do params( additional_withholding: T.nilable(Integer), - exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol, - filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol, + exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol, + filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol, individual_id: String, total_number_of_allowances: T.nilable(Integer) ) diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 888c6c61..103bcef4 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -22,8 +22,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) - .returns(FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) + params(_: FinchAPI::Models::HRIS::W42020::Type::OrSymbol) + .returns(FinchAPI::Models::HRIS::W42020::Type::OrSymbol) end def type=(_) end @@ -42,7 +42,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Util::AnyHash), - type: FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol, + type: FinchAPI::Models::HRIS::W42020::Type::OrSymbol, year: T.nilable(Float) ) .returns(T.attached_class) @@ -147,7 +147,7 @@ module FinchAPI amount_for_qualifying_children_under_17: T.nilable(Integer), deductions: T.nilable(Integer), extra_withholding: T.nilable(Integer), - filing_status: T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol), + filing_status: T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::OrSymbol), individual_id: String, other_income: T.nilable(Integer), total_claim_dependent_and_other_credits: T.nilable(Integer) diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 5294e87e..2e756cb2 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -19,8 +19,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::IndividualEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::IndividualEvent::EventType::OrSymbol) end def event_type=(_) end @@ -28,7 +28,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Util::AnyHash), - event_type: FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::IndividualEvent::EventType::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index db51922b..c7fa5047 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -171,13 +171,13 @@ module FinchAPI sig do params( account_id: String, - authentication_methods: T::Array[FinchAPI::Models::Introspection::AuthenticationMethod], + authentication_methods: T::Array[T.any(FinchAPI::Models::Introspection::AuthenticationMethod, FinchAPI::Util::AnyHash)], client_id: String, - client_type: FinchAPI::Models::Introspection::ClientType::TaggedSymbol, + client_type: FinchAPI::Models::Introspection::ClientType::OrSymbol, company_id: String, connection_id: String, connection_status: T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Util::AnyHash), - connection_type: FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol, + connection_type: FinchAPI::Models::Introspection::ConnectionType::OrSymbol, customer_email: T.nilable(String), customer_id: T.nilable(String), customer_name: T.nilable(String), @@ -266,8 +266,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) - .returns(FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) + params(_: FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol) + .returns(FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol) end def type=(_) end @@ -276,7 +276,7 @@ module FinchAPI params( connection_status: T.any(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, FinchAPI::Util::AnyHash), products: T::Array[String], - type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol + type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol ) .returns(T.attached_class) end @@ -310,15 +310,14 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - .returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + params(_: FinchAPI::Models::ConnectionStatusType::OrSymbol) + .returns(FinchAPI::Models::ConnectionStatusType::OrSymbol) end def status=(_) end sig do - params(message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - .returns(T.attached_class) + params(message: String, status: FinchAPI::Models::ConnectionStatusType::OrSymbol).returns(T.attached_class) end def self.new(message: nil, status: nil) end @@ -385,15 +384,14 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - .returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) + params(_: FinchAPI::Models::ConnectionStatusType::OrSymbol) + .returns(FinchAPI::Models::ConnectionStatusType::OrSymbol) end def status=(_) end sig do - params(message: String, status: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - .returns(T.attached_class) + params(message: String, status: FinchAPI::Models::ConnectionStatusType::OrSymbol).returns(T.attached_class) end def self.new(message: nil, status: nil) end diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index f4ae51fe..d53591c9 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -19,8 +19,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol) end def event_type=(_) end @@ -28,7 +28,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Util::AnyHash), - event_type: FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 54dd2f00..122f84da 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -106,8 +106,8 @@ module FinchAPI params: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Util::AnyHash)), scheduled_at: T.nilable(Time), started_at: T.nilable(Time), - status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol, - type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol + status: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::OrSymbol, + type: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi index 7e4e3f38..c49abd16 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi @@ -28,7 +28,7 @@ module FinchAPI sig do params( - data: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob], + data: T::Array[T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob, FinchAPI::Util::AnyHash)], meta: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index 5a21d7cb..1e4706f3 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -36,7 +36,7 @@ module FinchAPI params( body: T.nilable(T::Array[T.anything]), job_id: String, - status: FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol + status: FinchAPI::Models::Jobs::ManualAsyncJob::Status::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/operation_support_matrix.rbi b/rbi/lib/finch-api/models/operation_support_matrix.rbi index 6f940f3c..d8cc7ed3 100644 --- a/rbi/lib/finch-api/models/operation_support_matrix.rbi +++ b/rbi/lib/finch-api/models/operation_support_matrix.rbi @@ -15,8 +15,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) - .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + params(_: FinchAPI::Models::OperationSupport::OrSymbol) + .returns(FinchAPI::Models::OperationSupport::OrSymbol) end def create=(_) end @@ -33,8 +33,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) - .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + params(_: FinchAPI::Models::OperationSupport::OrSymbol) + .returns(FinchAPI::Models::OperationSupport::OrSymbol) end def delete=(_) end @@ -51,8 +51,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) - .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + params(_: FinchAPI::Models::OperationSupport::OrSymbol) + .returns(FinchAPI::Models::OperationSupport::OrSymbol) end def read=(_) end @@ -69,18 +69,18 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::OperationSupport::TaggedSymbol) - .returns(FinchAPI::Models::OperationSupport::TaggedSymbol) + params(_: FinchAPI::Models::OperationSupport::OrSymbol) + .returns(FinchAPI::Models::OperationSupport::OrSymbol) end def update=(_) end sig do params( - create: FinchAPI::Models::OperationSupport::TaggedSymbol, - delete: FinchAPI::Models::OperationSupport::TaggedSymbol, - read: FinchAPI::Models::OperationSupport::TaggedSymbol, - update: FinchAPI::Models::OperationSupport::TaggedSymbol + create: FinchAPI::Models::OperationSupport::OrSymbol, + delete: FinchAPI::Models::OperationSupport::OrSymbol, + read: FinchAPI::Models::OperationSupport::OrSymbol, + update: FinchAPI::Models::OperationSupport::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 3d91974c..9d48c374 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -19,8 +19,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::PayStatementEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::PayStatementEvent::EventType::OrSymbol) end def event_type=(_) end @@ -28,7 +28,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Util::AnyHash), - event_type: FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::PayStatementEvent::EventType::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index 2b569c07..f93fcd0d 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -19,8 +19,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) - .returns(FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) + params(_: FinchAPI::Models::PaymentEvent::EventType::OrSymbol) + .returns(FinchAPI::Models::PaymentEvent::EventType::OrSymbol) end def event_type=(_) end @@ -28,7 +28,7 @@ module FinchAPI sig do params( data: T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Util::AnyHash), - event_type: FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol + event_type: FinchAPI::Models::PaymentEvent::EventType::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index 4d590212..856aad57 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -28,8 +28,8 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) - .returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) + params(_: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol]) + .returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol]) end def pay_frequencies=(_) end @@ -38,7 +38,7 @@ module FinchAPI params( id: String, name: String, - pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol] + pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol] ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index bb0f6645..0f61e831 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -47,7 +47,7 @@ module FinchAPI id: String, individual_ids: T::Array[String], name: String, - pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol] + pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::OrSymbol] ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index f6a384ad..91227e28 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -18,8 +18,8 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::Provider::AuthenticationMethod]) - .returns(T::Array[FinchAPI::Models::Provider::AuthenticationMethod]) + params(_: T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Util::AnyHash)]) + .returns(T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Util::AnyHash)]) end def authentication_methods=(_) end @@ -101,7 +101,7 @@ module FinchAPI sig do params( id: String, - authentication_methods: T::Array[FinchAPI::Models::Provider::AuthenticationMethod], + authentication_methods: T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Util::AnyHash)], beta: T::Boolean, display_name: String, icon: String, @@ -187,8 +187,8 @@ module FinchAPI end sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) + params(_: FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol) + .returns(FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol) end def type=(_) end @@ -199,7 +199,7 @@ module FinchAPI supported_fields: T.nilable( T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Util::AnyHash) ), - type: FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol + type: FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index 302b0ed3..1650fe74 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -94,12 +94,16 @@ module FinchAPI sig do params( - accounts: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]), - departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)]), + accounts: T.nilable( + T::Array[T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account, FinchAPI::Util::AnyHash)] + ), + departments: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, FinchAPI::Util::AnyHash))] + ), ein: T.nilable(String), entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash)), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), + locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String), request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index 413e0c00..df851676 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -93,12 +93,16 @@ module FinchAPI sig do params( - accounts: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account]), - departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department)]), + accounts: T.nilable( + T::Array[T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account, FinchAPI::Util::AnyHash)] + ), + departments: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department, FinchAPI::Util::AnyHash))] + ), ein: T.nilable(String), entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Util::AnyHash)), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), + locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String) ) @@ -179,7 +183,7 @@ module FinchAPI params( account_name: T.nilable(String), account_number: T.nilable(String), - account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol), + account_type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::OrSymbol), institution_name: T.nilable(String), routing_number: T.nilable(String) ) @@ -331,8 +335,8 @@ module FinchAPI # The entity type object. sig do params( - subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) + subtype: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index 61f31cde..cf1d38a1 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -79,7 +79,7 @@ module FinchAPI params( access_token: String, account_id: String, - authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol, + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::OrSymbol, company_id: String, connection_id: String, products: T::Array[String], diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index 15df1845..8a482f54 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -72,7 +72,7 @@ module FinchAPI params( access_token: String, account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::OrSymbol, company_id: String, connection_id: String, products: T::Array[String], diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index 9ba89a9a..3441db64 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -63,7 +63,7 @@ module FinchAPI sig do params( account_id: String, - authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol, + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::OrSymbol, company_id: String, products: T::Array[String], provider_id: String, diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index 0b25ca38..0a332029 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -14,15 +14,17 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body]) - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body]) + params( + _: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)] + ) + .returns(T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)]) end def body=(_) end sig do params( - body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)], request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) .returns(T.attached_class) @@ -60,8 +62,12 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField]) - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField]) + params( + _: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)] + ) + .returns( + T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)] + ) end def custom_fields=(_) end @@ -357,12 +363,14 @@ module FinchAPI sig do params( class_code: T.nilable(String), - custom_fields: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField], + custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)], department: T.nilable( T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash) ), dob: T.nilable(String), - emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email]), + emails: T.nilable( + T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email, FinchAPI::Util::AnyHash)] + ), employment: T.nilable( T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash) ), @@ -373,14 +381,20 @@ module FinchAPI first_name: T.nilable(String), gender: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol), income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), + income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), manager: T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)), middle_name: T.nilable(String), - phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)]), + phone_numbers: T.nilable( + T::Array[ + T.nilable( + T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber, FinchAPI::Util::AnyHash) + ) + ] + ), preferred_name: T.nilable(String), residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), source_id: String, diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index 1ee22179..9225a454 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -24,8 +24,12 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField]) - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField]) + params( + _: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)] + ) + .returns( + T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)] + ) end def custom_fields=(_) end @@ -208,14 +212,14 @@ module FinchAPI sig do params( class_code: T.nilable(String), - custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], + custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)], department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)), employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)), employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), + income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index fe916932..1589b176 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -30,8 +30,12 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]) - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField]) + params( + _: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Util::AnyHash)] + ) + .returns( + T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Util::AnyHash)] + ) end def custom_fields=(_) end @@ -215,14 +219,14 @@ module FinchAPI params( id: String, class_code: T.nilable(String), - custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField], + custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Util::AnyHash)], department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Util::AnyHash)), employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Util::AnyHash)), - employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol), + employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), - income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), + income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), @@ -364,8 +368,8 @@ module FinchAPI # The employment object. sig do params( - subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol), - type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) + subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::OrSymbol), + type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index 2266aba4..9f936f5e 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -134,14 +134,18 @@ module FinchAPI sig do params( dob: T.nilable(String), - emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]), + emails: T.nilable( + T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email, FinchAPI::Util::AnyHash)] + ), encrypted_ssn: T.nilable(String), ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol), first_name: T.nilable(String), gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), - phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)]), + phone_numbers: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, FinchAPI::Util::AnyHash))] + ), preferred_name: T.nilable(String), residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), ssn: T.nilable(String), diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index 536265d9..62c72c75 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -143,14 +143,22 @@ module FinchAPI params( id: String, dob: T.nilable(String), - emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]), + emails: T.nilable( + T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email, FinchAPI::Util::AnyHash)] + ), encrypted_ssn: T.nilable(String), - ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol), + ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::OrSymbol), first_name: T.nilable(String), - gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol), + gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::OrSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), - phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]), + phone_numbers: T.nilable( + T::Array[ + T.nilable( + T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, FinchAPI::Util::AnyHash) + ) + ] + ), preferred_name: T.nilable(String), residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), ssn: T.nilable(String) @@ -220,7 +228,7 @@ module FinchAPI sig do params( data: String, - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::OrSymbol) ) .returns(T.attached_class) end @@ -344,7 +352,7 @@ module FinchAPI sig do params( data: String, - type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) + type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::OrSymbol) ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index efe6b64d..419b08a0 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -29,8 +29,8 @@ module FinchAPI sig do params( - completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol, - type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol + completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol, + type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol ) .returns(T.attached_class) end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index ef5cd7ff..b8216906 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -20,8 +20,12 @@ module FinchAPI end sig do - params(_: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement]) - .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement]) + params( + _: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)] + ) + .returns( + T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)] + ) end def pay_statements=(_) end @@ -37,7 +41,7 @@ module FinchAPI sig do params( end_date: String, - pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)], start_date: String, request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash) ) @@ -214,18 +218,44 @@ module FinchAPI sig do params( - earnings: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)]), + earnings: T.nilable( + T::Array[ + T.nilable( + T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning, FinchAPI::Util::AnyHash) + ) + ] + ), employee_deductions: T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)] + T::Array[ + T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction, + FinchAPI::Util::AnyHash + ) + ) + ] ), employer_contributions: T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)] + T::Array[ + T.nilable( + T.any( + FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution, + FinchAPI::Util::AnyHash + ) + ) + ] ), gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), individual_id: String, net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash)), payment_method: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol), - taxes: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]), + taxes: T.nilable( + T::Array[ + T.nilable( + T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax, FinchAPI::Util::AnyHash) + ) + ] + ), total_hours: T.nilable(Float), type: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol) ) diff --git a/rbi/lib/finch-api/resources/connect/sessions.rbi b/rbi/lib/finch-api/resources/connect/sessions.rbi index 53fc9531..e52ad833 100644 --- a/rbi/lib/finch-api/resources/connect/sessions.rbi +++ b/rbi/lib/finch-api/resources/connect/sessions.rbi @@ -11,7 +11,7 @@ module FinchAPI customer_name: String, products: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol], customer_email: T.nilable(String), - integration: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration), + integration: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)), manual: T.nilable(T::Boolean), minutes_to_expire: T.nilable(Float), redirect_uri: T.nilable(String), diff --git a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi index ba7e950f..cc51fa97 100644 --- a/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits/individuals.rbi @@ -12,7 +12,7 @@ module FinchAPI sig do params( benefit_id: String, - individuals: T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual], + individuals: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)], request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::SinglePage[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual]) diff --git a/rbi/lib/finch-api/resources/hris/employments.rbi b/rbi/lib/finch-api/resources/hris/employments.rbi index 57078b21..332e2560 100644 --- a/rbi/lib/finch-api/resources/hris/employments.rbi +++ b/rbi/lib/finch-api/resources/hris/employments.rbi @@ -7,7 +7,7 @@ module FinchAPI # Read individual employment and income data sig do params( - requests: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request], + requests: T::Array[T.any(FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request, FinchAPI::Util::AnyHash)], request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::EmploymentDataResponse]) diff --git a/rbi/lib/finch-api/resources/hris/individuals.rbi b/rbi/lib/finch-api/resources/hris/individuals.rbi index f02a9d05..cc6e017c 100644 --- a/rbi/lib/finch-api/resources/hris/individuals.rbi +++ b/rbi/lib/finch-api/resources/hris/individuals.rbi @@ -7,8 +7,8 @@ module FinchAPI # Read individual data, excluding income and employment data sig do params( - options: T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options), - requests: T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request], + options: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)), + requests: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Util::AnyHash)], request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::IndividualResponse]) diff --git a/rbi/lib/finch-api/resources/hris/pay_statements.rbi b/rbi/lib/finch-api/resources/hris/pay_statements.rbi index 7dc8a24a..0feb644d 100644 --- a/rbi/lib/finch-api/resources/hris/pay_statements.rbi +++ b/rbi/lib/finch-api/resources/hris/pay_statements.rbi @@ -10,7 +10,7 @@ module FinchAPI # supports Benefits. sig do params( - requests: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request], + requests: T::Array[T.any(FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request, FinchAPI::Util::AnyHash)], request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::ResponsesPage[FinchAPI::Models::HRIS::PayStatementResponse]) diff --git a/rbi/lib/finch-api/resources/jobs/automated.rbi b/rbi/lib/finch-api/resources/jobs/automated.rbi index de4ecde9..5e90492a 100644 --- a/rbi/lib/finch-api/resources/jobs/automated.rbi +++ b/rbi/lib/finch-api/resources/jobs/automated.rbi @@ -21,7 +21,7 @@ module FinchAPI sig do params( type: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol, - params: FinchAPI::Models::Jobs::AutomatedCreateParams::Params, + params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Util::AnyHash), request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(FinchAPI::Models::Jobs::AutomatedCreateResponse) diff --git a/rbi/lib/finch-api/resources/sandbox/company.rbi b/rbi/lib/finch-api/resources/sandbox/company.rbi index a7cd242a..779911d1 100644 --- a/rbi/lib/finch-api/resources/sandbox/company.rbi +++ b/rbi/lib/finch-api/resources/sandbox/company.rbi @@ -7,12 +7,16 @@ module FinchAPI # Update a sandbox company's data sig do params( - accounts: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account]), - departments: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)]), + accounts: T.nilable( + T::Array[T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account, FinchAPI::Util::AnyHash)] + ), + departments: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, FinchAPI::Util::AnyHash))] + ), ein: T.nilable(String), - entity: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity), + entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash)), legal_name: T.nilable(String), - locations: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)]), + locations: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))]), primary_email: T.nilable(String), primary_phone_number: T.nilable(String), request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) diff --git a/rbi/lib/finch-api/resources/sandbox/directory.rbi b/rbi/lib/finch-api/resources/sandbox/directory.rbi index 1c3407c7..03bae430 100644 --- a/rbi/lib/finch-api/resources/sandbox/directory.rbi +++ b/rbi/lib/finch-api/resources/sandbox/directory.rbi @@ -7,7 +7,7 @@ module FinchAPI # Add new individuals to a sandbox company sig do params( - body: T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body], + body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)], request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) .returns(T::Array[T.anything]) diff --git a/rbi/lib/finch-api/resources/sandbox/employment.rbi b/rbi/lib/finch-api/resources/sandbox/employment.rbi index 200e2244..9c5dffb0 100644 --- a/rbi/lib/finch-api/resources/sandbox/employment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/employment.rbi @@ -9,19 +9,19 @@ module FinchAPI params( individual_id: String, class_code: T.nilable(String), - custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField], - department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department), - employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment), + custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)], + department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)), + employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)), employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol), end_date: T.nilable(String), first_name: T.nilable(String), - income: T.nilable(FinchAPI::Models::Income), - income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]), + income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)), + income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]), is_active: T.nilable(T::Boolean), last_name: T.nilable(String), latest_rehire_date: T.nilable(String), - location: T.nilable(FinchAPI::Models::Location), - manager: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager), + location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), + manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)), middle_name: T.nilable(String), source_id: String, start_date: T.nilable(String), diff --git a/rbi/lib/finch-api/resources/sandbox/individual.rbi b/rbi/lib/finch-api/resources/sandbox/individual.rbi index 2fd6cc60..b5e76f3f 100644 --- a/rbi/lib/finch-api/resources/sandbox/individual.rbi +++ b/rbi/lib/finch-api/resources/sandbox/individual.rbi @@ -9,16 +9,20 @@ module FinchAPI params( individual_id: String, dob: T.nilable(String), - emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]), + emails: T.nilable( + T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email, FinchAPI::Util::AnyHash)] + ), encrypted_ssn: T.nilable(String), ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol), first_name: T.nilable(String), gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol), last_name: T.nilable(String), middle_name: T.nilable(String), - phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)]), + phone_numbers: T.nilable( + T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, FinchAPI::Util::AnyHash))] + ), preferred_name: T.nilable(String), - residence: T.nilable(FinchAPI::Models::Location), + residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)), ssn: T.nilable(String), request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) diff --git a/rbi/lib/finch-api/resources/sandbox/payment.rbi b/rbi/lib/finch-api/resources/sandbox/payment.rbi index 76b28dd8..e9f1e1be 100644 --- a/rbi/lib/finch-api/resources/sandbox/payment.rbi +++ b/rbi/lib/finch-api/resources/sandbox/payment.rbi @@ -8,7 +8,7 @@ module FinchAPI sig do params( end_date: String, - pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement], + pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)], start_date: String, request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) ) From 797cdf7ff1377392296b80b8681447b47de0c3a9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 08:23:22 +0000 Subject: [PATCH 61/67] chore: switch to prettier looking sorbet annotations (#64) --- rbi/lib/finch-api/base_client.rbi | 8 +- rbi/lib/finch-api/client.rbi | 39 +- rbi/lib/finch-api/errors.rbi | 49 +- rbi/lib/finch-api/individuals_page.rbi | 14 +- .../models/access_token_create_params.rbi | 31 +- .../finch-api/models/account_update_event.rbi | 1458 ++++++---------- .../finch-api/models/base_webhook_event.rbi | 22 +- rbi/lib/finch-api/models/company_event.rbi | 20 +- .../models/connect/session_new_params.rbi | 91 +- .../models/connect/session_new_response.rbi | 14 +- .../connect/session_reauthenticate_params.rbi | 31 +- .../session_reauthenticate_response.rbi | 14 +- .../models/create_access_token_response.rbi | 77 +- rbi/lib/finch-api/models/directory_event.rbi | 30 +- .../finch-api/models/disconnect_response.rbi | 7 +- rbi/lib/finch-api/models/employment_event.rbi | 30 +- .../models/hris/benefit_contribution.rbi | 17 +- .../models/hris/benefit_create_params.rbi | 28 +- .../hris/benefit_features_and_operations.rbi | 134 +- .../models/hris/benefit_update_params.rbi | 8 +- .../hris/benefits/enrolled_individual.rbi | 50 +- .../hris/benefits/individual_benefit.rbi | 78 +- .../individual_enroll_many_params.rbi | 132 +- .../individual_enrolled_ids_response.rbi | 14 +- ...dividual_retrieve_many_benefits_params.rbi | 8 +- .../individual_unenroll_many_params.rbi | 8 +- .../hris/benefits/unenrolled_individual.rbi | 47 +- .../models/hris/benefits_support.rbi | 144 +- rbi/lib/finch-api/models/hris/company.rbi | 160 +- .../finch-api/models/hris/company_benefit.rbi | 34 +- .../hris/create_company_benefits_response.rbi | 7 +- .../directory_list_individuals_params.rbi | 16 +- .../models/hris/directory_list_params.rbi | 16 +- .../models/hris/document_list_params.rbi | 35 +- .../models/hris/document_list_response.rbi | 21 +- .../models/hris/document_response.rbi | 41 +- .../finch-api/models/hris/employment_data.rbi | 224 +-- .../models/hris/employment_data_response.rbi | 27 +- .../hris/employment_retrieve_many_params.rbi | 17 +- rbi/lib/finch-api/models/hris/individual.rbi | 143 +- .../models/hris/individual_in_directory.rbi | 73 +- .../models/hris/individual_response.rbi | 27 +- .../hris/individual_retrieve_many_params.rbi | 40 +- .../finch-api/models/hris/pay_statement.rbi | 378 +---- .../models/hris/pay_statement_response.rbi | 27 +- .../hris/pay_statement_response_body.rbi | 22 +- .../pay_statement_retrieve_many_params.rbi | 33 +- rbi/lib/finch-api/models/hris/payment.rbi | 125 +- .../models/hris/payment_list_params.rbi | 14 +- .../models/hris/support_per_benefit_type.rbi | 22 +- .../models/hris/supported_benefit.rbi | 92 +- .../hris/update_company_benefit_response.rbi | 7 +- rbi/lib/finch-api/models/hris/w42005.rbi | 73 +- rbi/lib/finch-api/models/hris/w42020.rbi | 89 +- rbi/lib/finch-api/models/income.rbi | 31 +- rbi/lib/finch-api/models/individual_event.rbi | 30 +- rbi/lib/finch-api/models/introspection.rbi | 195 +-- .../finch-api/models/job_completion_event.rbi | 36 +- .../models/jobs/automated_async_job.rbi | 82 +- .../models/jobs/automated_create_params.rbi | 28 +- .../models/jobs/automated_create_response.rbi | 28 +- .../models/jobs/automated_list_params.rbi | 16 +- .../models/jobs/automated_list_response.rbi | 61 +- .../models/jobs/manual_async_job.rbi | 24 +- rbi/lib/finch-api/models/location.rbi | 56 +- rbi/lib/finch-api/models/money.rbi | 15 +- .../models/operation_support_matrix.rbi | 44 +- rbi/lib/finch-api/models/paging.rbi | 16 +- .../finch-api/models/pay_statement_event.rbi | 38 +- rbi/lib/finch-api/models/payment_event.rbi | 36 +- .../models/payroll/pay_group_list_params.rbi | 16 +- .../payroll/pay_group_list_response.rbi | 26 +- .../payroll/pay_group_retrieve_response.rbi | 31 +- rbi/lib/finch-api/models/provider.rbi | 1491 ++++++----------- .../request_forwarding_forward_params.rbi | 35 +- .../request_forwarding_forward_response.rbi | 68 +- .../models/sandbox/company_update_params.rbi | 154 +- .../sandbox/company_update_response.rbi | 156 +- .../sandbox/connection_create_params.rbi | 35 +- .../sandbox/connection_create_response.rbi | 60 +- .../connections/account_create_params.rbi | 34 +- .../connections/account_create_response.rbi | 52 +- .../connections/account_update_params.rbi | 11 +- .../connections/account_update_response.rbi | 46 +- .../sandbox/directory_create_params.rbi | 346 +--- .../sandbox/employment_update_params.rbi | 211 +-- .../sandbox/employment_update_response.rbi | 221 +-- .../sandbox/individual_update_params.rbi | 136 +- .../sandbox/individual_update_response.rbi | 146 +- .../models/sandbox/job_create_params.rbi | 10 +- .../models/sandbox/job_create_response.rbi | 28 +- .../jobs/sandbox_job_configuration.rbi | 20 +- .../models/sandbox/payment_create_params.rbi | 456 +---- .../sandbox/payment_create_response.rbi | 14 +- rbi/lib/finch-api/page.rbi | 14 +- rbi/lib/finch-api/request_options.rbi | 58 +- rbi/lib/finch-api/resources/connect.rbi | 3 +- rbi/lib/finch-api/resources/hris.rbi | 24 +- rbi/lib/finch-api/resources/hris/benefits.rbi | 3 +- rbi/lib/finch-api/resources/jobs.rbi | 6 +- rbi/lib/finch-api/resources/payroll.rbi | 3 +- rbi/lib/finch-api/resources/sandbox.rbi | 21 +- .../resources/sandbox/connections.rbi | 3 +- rbi/lib/finch-api/resources/sandbox/jobs.rbi | 3 +- rbi/lib/finch-api/responses_page.rbi | 7 +- 105 files changed, 2328 insertions(+), 6722 deletions(-) diff --git a/rbi/lib/finch-api/base_client.rbi b/rbi/lib/finch-api/base_client.rbi index fef8199f..5ee8e3ce 100644 --- a/rbi/lib/finch-api/base_client.rbi +++ b/rbi/lib/finch-api/base_client.rbi @@ -83,13 +83,9 @@ module FinchAPI end end + # @api private sig { returns(T.anything) } - def requester - end - - sig { params(_: T.anything).returns(T.anything) } - def requester=(_) - end + attr_accessor :requester # @api private sig do diff --git a/rbi/lib/finch-api/client.rbi b/rbi/lib/finch-api/client.rbi index a62abb94..6af43f2c 100644 --- a/rbi/lib/finch-api/client.rbi +++ b/rbi/lib/finch-api/client.rbi @@ -11,56 +11,43 @@ module FinchAPI DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float) sig { returns(T.nilable(String)) } - def access_token - end + attr_reader :access_token sig { returns(T.nilable(String)) } - def client_id - end + attr_reader :client_id sig { returns(T.nilable(String)) } - def client_secret - end + attr_reader :client_secret sig { returns(FinchAPI::Resources::AccessTokens) } - def access_tokens - end + attr_reader :access_tokens sig { returns(FinchAPI::Resources::HRIS) } - def hris - end + attr_reader :hris sig { returns(FinchAPI::Resources::Providers) } - def providers - end + attr_reader :providers sig { returns(FinchAPI::Resources::Account) } - def account - end + attr_reader :account sig { returns(FinchAPI::Resources::Webhooks) } - def webhooks - end + attr_reader :webhooks sig { returns(FinchAPI::Resources::RequestForwarding) } - def request_forwarding - end + attr_reader :request_forwarding sig { returns(FinchAPI::Resources::Jobs) } - def jobs - end + attr_reader :jobs sig { returns(FinchAPI::Resources::Sandbox) } - def sandbox - end + attr_reader :sandbox sig { returns(FinchAPI::Resources::Payroll) } - def payroll - end + attr_reader :payroll sig { returns(FinchAPI::Resources::Connect) } - def connect - end + attr_reader :connect # @api private sig { override.returns(T::Hash[String, String]) } diff --git a/rbi/lib/finch-api/errors.rbi b/rbi/lib/finch-api/errors.rbi index a8c4129b..7ffea6da 100644 --- a/rbi/lib/finch-api/errors.rbi +++ b/rbi/lib/finch-api/errors.rbi @@ -3,12 +3,7 @@ module FinchAPI class Error < StandardError sig { returns(T.nilable(StandardError)) } - def cause - end - - sig { params(_: T.nilable(StandardError)).returns(T.nilable(StandardError)) } - def cause=(_) - end + attr_accessor :cause end class ConversionError < FinchAPI::Error @@ -16,28 +11,13 @@ module FinchAPI class APIError < FinchAPI::Error sig { returns(URI::Generic) } - def url - end - - sig { params(_: URI::Generic).returns(URI::Generic) } - def url=(_) - end + attr_accessor :url sig { returns(T.nilable(Integer)) } - def status - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def status=(_) - end + attr_accessor :status sig { returns(T.nilable(T.anything)) } - def body - end - - sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } - def body=(_) - end + attr_accessor :body # @api private sig do @@ -57,20 +37,10 @@ module FinchAPI class APIConnectionError < FinchAPI::APIError sig { void } - def status - end - - sig { params(_: NilClass).void } - def status=(_) - end + attr_accessor :status sig { void } - def body - end - - sig { params(_: NilClass).void } - def body=(_) - end + attr_accessor :body # @api private sig do @@ -122,12 +92,7 @@ module FinchAPI end sig { returns(Integer) } - def status - end - - sig { params(_: Integer).returns(Integer) } - def status=(_) - end + attr_accessor :status # @api private sig do diff --git a/rbi/lib/finch-api/individuals_page.rbi b/rbi/lib/finch-api/individuals_page.rbi index 20ebcd03..dc735152 100644 --- a/rbi/lib/finch-api/individuals_page.rbi +++ b/rbi/lib/finch-api/individuals_page.rbi @@ -7,20 +7,10 @@ module FinchAPI Elem = type_member sig { returns(T.nilable(T::Array[Elem])) } - def individuals - end - - sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) } - def individuals=(_) - end + attr_accessor :individuals sig { returns(FinchAPI::Models::Paging) } - def paging - end - - sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } - def paging=(_) - end + attr_accessor :paging sig { returns(String) } def inspect diff --git a/rbi/lib/finch-api/models/access_token_create_params.rbi b/rbi/lib/finch-api/models/access_token_create_params.rbi index b1d5805f..2b02d4b9 100644 --- a/rbi/lib/finch-api/models/access_token_create_params.rbi +++ b/rbi/lib/finch-api/models/access_token_create_params.rbi @@ -7,36 +7,25 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(String) } - def code - end - - sig { params(_: String).returns(String) } - def code=(_) - end + attr_accessor :code sig { returns(T.nilable(String)) } - def client_id - end + attr_reader :client_id - sig { params(_: String).returns(String) } - def client_id=(_) - end + sig { params(client_id: String).void } + attr_writer :client_id sig { returns(T.nilable(String)) } - def client_secret - end + attr_reader :client_secret - sig { params(_: String).returns(String) } - def client_secret=(_) - end + sig { params(client_secret: String).void } + attr_writer :client_secret sig { returns(T.nilable(String)) } - def redirect_uri - end + attr_reader :redirect_uri - sig { params(_: String).returns(String) } - def redirect_uri=(_) - end + sig { params(redirect_uri: String).void } + attr_writer :redirect_uri sig do params( diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index 80eb6a50..f979b54c 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -4,26 +4,16 @@ module FinchAPI module Models class AccountUpdateEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::AccountUpdateEvent::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::AccountUpdateEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( @@ -49,28 +39,18 @@ module FinchAPI class Data < FinchAPI::BaseModel sig { returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod) } - def authentication_method - end + attr_reader :authentication_method sig do params( - _: T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Util::AnyHash) + authentication_method: T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Util::AnyHash) ) - .returns(T.any(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod, FinchAPI::Util::AnyHash)) - end - def authentication_method=(_) + .void end + attr_writer :authentication_method sig { returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) } - def status - end - - sig do - params(_: FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - .returns(FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - end - def status=(_) - end + attr_accessor :status sig do params( @@ -98,53 +78,39 @@ module FinchAPI # Each benefit type and their supported features. If the benefit type is not # supported, the property will be null sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) } - def benefits_support - end + attr_reader :benefits_support sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) - end - def benefits_support=(_) + params( + benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :benefits_support # The supported data fields returned by our HR and payroll endpoints sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields)) } - def supported_fields - end + attr_reader :supported_fields sig do params( - _: T.nilable( + supported_fields: T.nilable( T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, FinchAPI::Util::AnyHash ) ) ) - .returns( - T.nilable( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields, - FinchAPI::Util::AnyHash - ) - ) - ) - end - def supported_fields=(_) + .void end + attr_writer :supported_fields # The type of authentication method. sig { returns(T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol)) } - def type - end + attr_reader :type - sig do - params(_: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol) - .returns(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol) - end - def type=(_) - end + sig { params(type: FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::OrSymbol).void } + attr_writer :type sig do params( @@ -181,175 +147,126 @@ module FinchAPI T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company) ) end - def company - end + attr_reader :company sig do params( - _: T.any( + company: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company, - FinchAPI::Util::AnyHash - ) - ) - end - def company=(_) + .void end + attr_writer :company sig do returns( T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory) ) end - def directory - end + attr_reader :directory sig do params( - _: T.any( + directory: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory, - FinchAPI::Util::AnyHash - ) - ) - end - def directory=(_) + .void end + attr_writer :directory sig do returns( T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment) ) end - def employment - end + attr_reader :employment sig do params( - _: T.any( + employment: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment, - FinchAPI::Util::AnyHash - ) - ) - end - def employment=(_) + .void end + attr_writer :employment sig do returns( T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual) ) end - def individual - end + attr_reader :individual sig do params( - _: T.any( + individual: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual, - FinchAPI::Util::AnyHash - ) - ) - end - def individual=(_) + .void end + attr_writer :individual sig do returns( T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup) ) end - def pay_group - end + attr_reader :pay_group sig do params( - _: T.any( + pay_group: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayGroup, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_group=(_) + .void end + attr_writer :pay_group sig do returns( T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement) ) end - def pay_statement - end + attr_reader :pay_statement sig do params( - _: T.any( + pay_statement: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_statement=(_) + .void end + attr_writer :pay_statement sig do returns( T.nilable(FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment) ) end - def payment - end + attr_reader :payment sig do params( - _: T.any( + payment: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment, - FinchAPI::Util::AnyHash - ) - ) - end - def payment=(_) + .void end + attr_writer :payment # The supported data fields returned by our HR and payroll endpoints sig do @@ -415,12 +332,10 @@ module FinchAPI class Company < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig do returns( @@ -429,25 +344,18 @@ module FinchAPI ) ) end - def accounts - end + attr_reader :accounts sig do params( - _: T.any( + accounts: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Accounts, - FinchAPI::Util::AnyHash - ) - ) - end - def accounts=(_) + .void end + attr_writer :accounts sig do returns( @@ -456,33 +364,24 @@ module FinchAPI ) ) end - def departments - end + attr_reader :departments sig do params( - _: T.any( + departments: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments, - FinchAPI::Util::AnyHash - ) - ) - end - def departments=(_) + .void end + attr_writer :departments sig { returns(T.nilable(T::Boolean)) } - def ein - end + attr_reader :ein - sig { params(_: T::Boolean).returns(T::Boolean) } - def ein=(_) - end + sig { params(ein: T::Boolean).void } + attr_writer :ein sig do returns( @@ -491,33 +390,24 @@ module FinchAPI ) ) end - def entity - end + attr_reader :entity sig do params( - _: T.any( + entity: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Entity, - FinchAPI::Util::AnyHash - ) - ) - end - def entity=(_) + .void end + attr_writer :entity sig { returns(T.nilable(T::Boolean)) } - def legal_name - end + attr_reader :legal_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def legal_name=(_) - end + sig { params(legal_name: T::Boolean).void } + attr_writer :legal_name sig do returns( @@ -526,41 +416,30 @@ module FinchAPI ) ) end - def locations - end + attr_reader :locations sig do params( - _: T.any( + locations: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Locations, - FinchAPI::Util::AnyHash - ) - ) - end - def locations=(_) + .void end + attr_writer :locations sig { returns(T.nilable(T::Boolean)) } - def primary_email - end + attr_reader :primary_email - sig { params(_: T::Boolean).returns(T::Boolean) } - def primary_email=(_) - end + sig { params(primary_email: T::Boolean).void } + attr_writer :primary_email sig { returns(T.nilable(T::Boolean)) } - def primary_phone_number - end + attr_reader :primary_phone_number - sig { params(_: T::Boolean).returns(T::Boolean) } - def primary_phone_number=(_) - end + sig { params(primary_phone_number: T::Boolean).void } + attr_writer :primary_phone_number sig do params( @@ -622,44 +501,34 @@ module FinchAPI class Accounts < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def account_name - end + attr_reader :account_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def account_name=(_) - end + sig { params(account_name: T::Boolean).void } + attr_writer :account_name sig { returns(T.nilable(T::Boolean)) } - def account_number - end + attr_reader :account_number - sig { params(_: T::Boolean).returns(T::Boolean) } - def account_number=(_) - end + sig { params(account_number: T::Boolean).void } + attr_writer :account_number sig { returns(T.nilable(T::Boolean)) } - def account_type - end + attr_reader :account_type - sig { params(_: T::Boolean).returns(T::Boolean) } - def account_type=(_) - end + sig { params(account_type: T::Boolean).void } + attr_writer :account_type sig { returns(T.nilable(T::Boolean)) } - def institution_name - end + attr_reader :institution_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def institution_name=(_) - end + sig { params(institution_name: T::Boolean).void } + attr_writer :institution_name sig { returns(T.nilable(T::Boolean)) } - def routing_number - end + attr_reader :routing_number - sig { params(_: T::Boolean).returns(T::Boolean) } - def routing_number=(_) - end + sig { params(routing_number: T::Boolean).void } + attr_writer :routing_number sig do params( @@ -692,12 +561,10 @@ module FinchAPI class Departments < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig do returns( @@ -706,25 +573,18 @@ module FinchAPI ) ) end - def parent - end + attr_reader :parent sig do params( - _: T.any( + parent: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Company::Departments::Parent, - FinchAPI::Util::AnyHash - ) - ) - end - def parent=(_) + .void end + attr_writer :parent sig do params( @@ -753,12 +613,10 @@ module FinchAPI class Parent < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } def self.new(name: nil) @@ -772,20 +630,16 @@ module FinchAPI class Entity < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def subtype - end + attr_reader :subtype - sig { params(_: T::Boolean).returns(T::Boolean) } - def subtype=(_) - end + sig { params(subtype: T::Boolean).void } + attr_writer :subtype sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(subtype: nil, type: nil) @@ -798,52 +652,40 @@ module FinchAPI class Locations < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def city - end + attr_reader :city - sig { params(_: T::Boolean).returns(T::Boolean) } - def city=(_) - end + sig { params(city: T::Boolean).void } + attr_writer :city sig { returns(T.nilable(T::Boolean)) } - def country - end + attr_reader :country - sig { params(_: T::Boolean).returns(T::Boolean) } - def country=(_) - end + sig { params(country: T::Boolean).void } + attr_writer :country sig { returns(T.nilable(T::Boolean)) } - def line1 - end + attr_reader :line1 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line1=(_) - end + sig { params(line1: T::Boolean).void } + attr_writer :line1 sig { returns(T.nilable(T::Boolean)) } - def line2 - end + attr_reader :line2 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line2=(_) - end + sig { params(line2: T::Boolean).void } + attr_writer :line2 sig { returns(T.nilable(T::Boolean)) } - def postal_code - end + attr_reader :postal_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def postal_code=(_) - end + sig { params(postal_code: T::Boolean).void } + attr_writer :postal_code sig { returns(T.nilable(T::Boolean)) } - def state - end + attr_reader :state - sig { params(_: T::Boolean).returns(T::Boolean) } - def state=(_) - end + sig { params(state: T::Boolean).void } + attr_writer :state sig do params( @@ -885,25 +727,18 @@ module FinchAPI ) ) end - def individuals - end + attr_reader :individuals sig do params( - _: T.any( + individuals: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals, - FinchAPI::Util::AnyHash - ) - ) - end - def individuals=(_) + .void end + attr_writer :individuals sig do returns( @@ -912,25 +747,18 @@ module FinchAPI ) ) end - def paging - end + attr_reader :paging sig do params( - _: T.any( + paging: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Paging, - FinchAPI::Util::AnyHash - ) - ) - end - def paging=(_) + .void end + attr_writer :paging sig do params( @@ -962,44 +790,34 @@ module FinchAPI class Individuals < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def department - end + attr_reader :department - sig { params(_: T::Boolean).returns(T::Boolean) } - def department=(_) - end + sig { params(department: T::Boolean).void } + attr_writer :department sig { returns(T.nilable(T::Boolean)) } - def first_name - end + attr_reader :first_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def first_name=(_) - end + sig { params(first_name: T::Boolean).void } + attr_writer :first_name sig { returns(T.nilable(T::Boolean)) } - def is_active - end + attr_reader :is_active - sig { params(_: T::Boolean).returns(T::Boolean) } - def is_active=(_) - end + sig { params(is_active: T::Boolean).void } + attr_writer :is_active sig { returns(T.nilable(T::Boolean)) } - def last_name - end + attr_reader :last_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def last_name=(_) - end + sig { params(last_name: T::Boolean).void } + attr_writer :last_name sig do returns( @@ -1008,33 +826,24 @@ module FinchAPI ) ) end - def manager - end + attr_reader :manager sig do params( - _: T.any( + manager: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - FinchAPI::Util::AnyHash - ) - ) - end - def manager=(_) + .void end + attr_writer :manager sig { returns(T.nilable(T::Boolean)) } - def middle_name - end + attr_reader :middle_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def middle_name=(_) - end + sig { params(middle_name: T::Boolean).void } + attr_writer :middle_name sig do params( @@ -1073,12 +882,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } def self.new(id: nil) @@ -1092,20 +899,16 @@ module FinchAPI class Paging < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def count - end + attr_reader :count - sig { params(_: T::Boolean).returns(T::Boolean) } - def count=(_) - end + sig { params(count: T::Boolean).void } + attr_writer :count sig { returns(T.nilable(T::Boolean)) } - def offset - end + attr_reader :offset - sig { params(_: T::Boolean).returns(T::Boolean) } - def offset=(_) - end + sig { params(offset: T::Boolean).void } + attr_writer :offset sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } def self.new(count: nil, offset: nil) @@ -1119,28 +922,22 @@ module FinchAPI class Employment < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def class_code - end + attr_reader :class_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def class_code=(_) - end + sig { params(class_code: T::Boolean).void } + attr_writer :class_code sig { returns(T.nilable(T::Boolean)) } - def custom_fields - end + attr_reader :custom_fields - sig { params(_: T::Boolean).returns(T::Boolean) } - def custom_fields=(_) - end + sig { params(custom_fields: T::Boolean).void } + attr_writer :custom_fields sig do returns( @@ -1149,25 +946,18 @@ module FinchAPI ) ) end - def department - end + attr_reader :department sig do params( - _: T.any( + department: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Department, - FinchAPI::Util::AnyHash - ) - ) - end - def department=(_) + .void end + attr_writer :department sig do returns( @@ -1176,49 +966,36 @@ module FinchAPI ) ) end - def employment - end + attr_reader :employment sig do params( - _: T.any( + employment: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Employment, - FinchAPI::Util::AnyHash - ) - ) - end - def employment=(_) + .void end + attr_writer :employment sig { returns(T.nilable(T::Boolean)) } - def employment_status - end + attr_reader :employment_status - sig { params(_: T::Boolean).returns(T::Boolean) } - def employment_status=(_) - end + sig { params(employment_status: T::Boolean).void } + attr_writer :employment_status sig { returns(T.nilable(T::Boolean)) } - def end_date - end + attr_reader :end_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def end_date=(_) - end + sig { params(end_date: T::Boolean).void } + attr_writer :end_date sig { returns(T.nilable(T::Boolean)) } - def first_name - end + attr_reader :first_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def first_name=(_) - end + sig { params(first_name: T::Boolean).void } + attr_writer :first_name sig do returns( @@ -1227,49 +1004,36 @@ module FinchAPI ) ) end - def income - end + attr_reader :income sig do params( - _: T.any( + income: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Income, - FinchAPI::Util::AnyHash - ) - ) - end - def income=(_) + .void end + attr_writer :income sig { returns(T.nilable(T::Boolean)) } - def income_history - end + attr_reader :income_history - sig { params(_: T::Boolean).returns(T::Boolean) } - def income_history=(_) - end + sig { params(income_history: T::Boolean).void } + attr_writer :income_history sig { returns(T.nilable(T::Boolean)) } - def is_active - end + attr_reader :is_active - sig { params(_: T::Boolean).returns(T::Boolean) } - def is_active=(_) - end + sig { params(is_active: T::Boolean).void } + attr_writer :is_active sig { returns(T.nilable(T::Boolean)) } - def last_name - end + attr_reader :last_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def last_name=(_) - end + sig { params(last_name: T::Boolean).void } + attr_writer :last_name sig do returns( @@ -1278,25 +1042,18 @@ module FinchAPI ) ) end - def location - end + attr_reader :location sig do params( - _: T.any( + location: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Location, - FinchAPI::Util::AnyHash - ) - ) - end - def location=(_) + .void end + attr_writer :location sig do returns( @@ -1305,49 +1062,36 @@ module FinchAPI ) ) end - def manager - end + attr_reader :manager sig do params( - _: T.any( + manager: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Employment::Manager, - FinchAPI::Util::AnyHash - ) - ) - end - def manager=(_) + .void end + attr_writer :manager sig { returns(T.nilable(T::Boolean)) } - def middle_name - end + attr_reader :middle_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def middle_name=(_) - end + sig { params(middle_name: T::Boolean).void } + attr_writer :middle_name sig { returns(T.nilable(T::Boolean)) } - def start_date - end + attr_reader :start_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def start_date=(_) - end + sig { params(start_date: T::Boolean).void } + attr_writer :start_date sig { returns(T.nilable(T::Boolean)) } - def title - end + attr_reader :title - sig { params(_: T::Boolean).returns(T::Boolean) } - def title=(_) - end + sig { params(title: T::Boolean).void } + attr_writer :title sig do params( @@ -1436,12 +1180,10 @@ module FinchAPI class Department < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } def self.new(name: nil) @@ -1454,20 +1196,16 @@ module FinchAPI class Employment < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def subtype - end + attr_reader :subtype - sig { params(_: T::Boolean).returns(T::Boolean) } - def subtype=(_) - end + sig { params(subtype: T::Boolean).void } + attr_writer :subtype sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(subtype: nil, type: nil) @@ -1480,28 +1218,22 @@ module FinchAPI class Income < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def unit - end + attr_reader :unit - sig { params(_: T::Boolean).returns(T::Boolean) } - def unit=(_) - end + sig { params(unit: T::Boolean).void } + attr_writer :unit sig do params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).returns(T.attached_class) @@ -1516,52 +1248,40 @@ module FinchAPI class Location < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def city - end + attr_reader :city - sig { params(_: T::Boolean).returns(T::Boolean) } - def city=(_) - end + sig { params(city: T::Boolean).void } + attr_writer :city sig { returns(T.nilable(T::Boolean)) } - def country - end + attr_reader :country - sig { params(_: T::Boolean).returns(T::Boolean) } - def country=(_) - end + sig { params(country: T::Boolean).void } + attr_writer :country sig { returns(T.nilable(T::Boolean)) } - def line1 - end + attr_reader :line1 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line1=(_) - end + sig { params(line1: T::Boolean).void } + attr_writer :line1 sig { returns(T.nilable(T::Boolean)) } - def line2 - end + attr_reader :line2 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line2=(_) - end + sig { params(line2: T::Boolean).void } + attr_writer :line2 sig { returns(T.nilable(T::Boolean)) } - def postal_code - end + attr_reader :postal_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def postal_code=(_) - end + sig { params(postal_code: T::Boolean).void } + attr_writer :postal_code sig { returns(T.nilable(T::Boolean)) } - def state - end + attr_reader :state - sig { params(_: T::Boolean).returns(T::Boolean) } - def state=(_) - end + sig { params(state: T::Boolean).void } + attr_writer :state sig do params( @@ -1596,12 +1316,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } def self.new(id: nil) @@ -1615,20 +1333,16 @@ module FinchAPI class Individual < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def dob - end + attr_reader :dob - sig { params(_: T::Boolean).returns(T::Boolean) } - def dob=(_) - end + sig { params(dob: T::Boolean).void } + attr_writer :dob sig do returns( @@ -1637,73 +1351,54 @@ module FinchAPI ) ) end - def emails - end + attr_reader :emails sig do params( - _: T.any( + emails: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Emails, - FinchAPI::Util::AnyHash - ) - ) - end - def emails=(_) + .void end + attr_writer :emails sig { returns(T.nilable(T::Boolean)) } - def encrypted_ssn - end + attr_reader :encrypted_ssn - sig { params(_: T::Boolean).returns(T::Boolean) } - def encrypted_ssn=(_) - end + sig { params(encrypted_ssn: T::Boolean).void } + attr_writer :encrypted_ssn sig { returns(T.nilable(T::Boolean)) } - def ethnicity - end + attr_reader :ethnicity - sig { params(_: T::Boolean).returns(T::Boolean) } - def ethnicity=(_) - end + sig { params(ethnicity: T::Boolean).void } + attr_writer :ethnicity sig { returns(T.nilable(T::Boolean)) } - def first_name - end + attr_reader :first_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def first_name=(_) - end + sig { params(first_name: T::Boolean).void } + attr_writer :first_name sig { returns(T.nilable(T::Boolean)) } - def gender - end + attr_reader :gender - sig { params(_: T::Boolean).returns(T::Boolean) } - def gender=(_) - end + sig { params(gender: T::Boolean).void } + attr_writer :gender sig { returns(T.nilable(T::Boolean)) } - def last_name - end + attr_reader :last_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def last_name=(_) - end + sig { params(last_name: T::Boolean).void } + attr_writer :last_name sig { returns(T.nilable(T::Boolean)) } - def middle_name - end + attr_reader :middle_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def middle_name=(_) - end + sig { params(middle_name: T::Boolean).void } + attr_writer :middle_name sig do returns( @@ -1712,33 +1407,24 @@ module FinchAPI ) ) end - def phone_numbers - end + attr_reader :phone_numbers sig do params( - _: T.any( + phone_numbers: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - FinchAPI::Util::AnyHash - ) - ) - end - def phone_numbers=(_) + .void end + attr_writer :phone_numbers sig { returns(T.nilable(T::Boolean)) } - def preferred_name - end + attr_reader :preferred_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def preferred_name=(_) - end + sig { params(preferred_name: T::Boolean).void } + attr_writer :preferred_name sig do returns( @@ -1747,33 +1433,24 @@ module FinchAPI ) ) end - def residence - end + attr_reader :residence sig do params( - _: T.any( + residence: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Individual::Residence, - FinchAPI::Util::AnyHash - ) - ) - end - def residence=(_) + .void end + attr_writer :residence sig { returns(T.nilable(T::Boolean)) } - def ssn - end + attr_reader :ssn - sig { params(_: T::Boolean).returns(T::Boolean) } - def ssn=(_) - end + sig { params(ssn: T::Boolean).void } + attr_writer :ssn sig do params( @@ -1844,20 +1521,16 @@ module FinchAPI class Emails < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def data - end + attr_reader :data - sig { params(_: T::Boolean).returns(T::Boolean) } - def data=(_) - end + sig { params(data: T::Boolean).void } + attr_writer :data sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(data: nil, type: nil) @@ -1870,20 +1543,16 @@ module FinchAPI class PhoneNumbers < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def data - end + attr_reader :data - sig { params(_: T::Boolean).returns(T::Boolean) } - def data=(_) - end + sig { params(data: T::Boolean).void } + attr_writer :data sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(data: nil, type: nil) @@ -1896,52 +1565,40 @@ module FinchAPI class Residence < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def city - end + attr_reader :city - sig { params(_: T::Boolean).returns(T::Boolean) } - def city=(_) - end + sig { params(city: T::Boolean).void } + attr_writer :city sig { returns(T.nilable(T::Boolean)) } - def country - end + attr_reader :country - sig { params(_: T::Boolean).returns(T::Boolean) } - def country=(_) - end + sig { params(country: T::Boolean).void } + attr_writer :country sig { returns(T.nilable(T::Boolean)) } - def line1 - end + attr_reader :line1 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line1=(_) - end + sig { params(line1: T::Boolean).void } + attr_writer :line1 sig { returns(T.nilable(T::Boolean)) } - def line2 - end + attr_reader :line2 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line2=(_) - end + sig { params(line2: T::Boolean).void } + attr_writer :line2 sig { returns(T.nilable(T::Boolean)) } - def postal_code - end + attr_reader :postal_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def postal_code=(_) - end + sig { params(postal_code: T::Boolean).void } + attr_writer :postal_code sig { returns(T.nilable(T::Boolean)) } - def state - end + attr_reader :state - sig { params(_: T::Boolean).returns(T::Boolean) } - def state=(_) - end + sig { params(state: T::Boolean).void } + attr_writer :state sig do params( @@ -1977,36 +1634,28 @@ module FinchAPI class PayGroup < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def individual_ids - end + attr_reader :individual_ids - sig { params(_: T::Boolean).returns(T::Boolean) } - def individual_ids=(_) - end + sig { params(individual_ids: T::Boolean).void } + attr_writer :individual_ids sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def pay_frequencies - end + attr_reader :pay_frequencies - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_frequencies=(_) - end + sig { params(pay_frequencies: T::Boolean).void } + attr_writer :pay_frequencies sig do params( @@ -2041,25 +1690,18 @@ module FinchAPI ) ) end - def paging - end + attr_reader :paging sig do params( - _: T.any( + paging: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::Paging, - FinchAPI::Util::AnyHash - ) - ) - end - def paging=(_) + .void end + attr_writer :paging sig do returns( @@ -2068,25 +1710,18 @@ module FinchAPI ) ) end - def pay_statements - end + attr_reader :pay_statements sig do params( - _: T.any( + pay_statements: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_statements=(_) + .void end + attr_writer :pay_statements sig do params( @@ -2118,20 +1753,10 @@ module FinchAPI class Paging < FinchAPI::BaseModel sig { returns(T::Boolean) } - def count - end - - sig { params(_: T::Boolean).returns(T::Boolean) } - def count=(_) - end + attr_accessor :count sig { returns(T::Boolean) } - def offset - end - - sig { params(_: T::Boolean).returns(T::Boolean) } - def offset=(_) - end + attr_accessor :offset sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } def self.new(count:, offset:) @@ -2150,25 +1775,18 @@ module FinchAPI ) ) end - def earnings - end + attr_reader :earnings sig do params( - _: T.any( + earnings: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - FinchAPI::Util::AnyHash - ) - ) - end - def earnings=(_) + .void end + attr_writer :earnings sig do returns( @@ -2177,25 +1795,18 @@ module FinchAPI ) ) end - def employee_deductions - end + attr_reader :employee_deductions sig do params( - _: T.any( + employee_deductions: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - FinchAPI::Util::AnyHash - ) - ) - end - def employee_deductions=(_) + .void end + attr_writer :employee_deductions sig do returns( @@ -2204,57 +1815,42 @@ module FinchAPI ) ) end - def employer_contributions - end + attr_reader :employer_contributions sig do params( - _: T.any( + employer_contributions: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - FinchAPI::Util::AnyHash - ) - ) - end - def employer_contributions=(_) + .void end + attr_writer :employer_contributions sig { returns(T.nilable(T::Boolean)) } - def gross_pay - end + attr_reader :gross_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def gross_pay=(_) - end + sig { params(gross_pay: T::Boolean).void } + attr_writer :gross_pay sig { returns(T.nilable(T::Boolean)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: T::Boolean).returns(T::Boolean) } - def individual_id=(_) - end + sig { params(individual_id: T::Boolean).void } + attr_writer :individual_id sig { returns(T.nilable(T::Boolean)) } - def net_pay - end + attr_reader :net_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def net_pay=(_) - end + sig { params(net_pay: T::Boolean).void } + attr_writer :net_pay sig { returns(T.nilable(T::Boolean)) } - def payment_method - end + attr_reader :payment_method - sig { params(_: T::Boolean).returns(T::Boolean) } - def payment_method=(_) - end + sig { params(payment_method: T::Boolean).void } + attr_writer :payment_method sig do returns( @@ -2263,41 +1859,30 @@ module FinchAPI ) ) end - def taxes - end + attr_reader :taxes sig do params( - _: T.any( + taxes: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - FinchAPI::Util::AnyHash - ) - ) - end - def taxes=(_) + .void end + attr_writer :taxes sig { returns(T.nilable(T::Boolean)) } - def total_hours - end + attr_reader :total_hours - sig { params(_: T::Boolean).returns(T::Boolean) } - def total_hours=(_) - end + sig { params(total_hours: T::Boolean).void } + attr_writer :total_hours sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params( @@ -2362,36 +1947,28 @@ module FinchAPI class Earnings < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean) @@ -2416,44 +1993,34 @@ module FinchAPI class EmployeeDeductions < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def pre_tax - end + attr_reader :pre_tax - sig { params(_: T::Boolean).returns(T::Boolean) } - def pre_tax=(_) - end + sig { params(pre_tax: T::Boolean).void } + attr_writer :pre_tax sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params( @@ -2486,28 +2053,22 @@ module FinchAPI class EmployerContributions < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig do params( @@ -2526,44 +2087,34 @@ module FinchAPI class Taxes < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def employer - end + attr_reader :employer - sig { params(_: T::Boolean).returns(T::Boolean) } - def employer=(_) - end + sig { params(employer: T::Boolean).void } + attr_writer :employer sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params( @@ -2598,92 +2149,70 @@ module FinchAPI class Payment < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def company_debit - end + attr_reader :company_debit - sig { params(_: T::Boolean).returns(T::Boolean) } - def company_debit=(_) - end + sig { params(company_debit: T::Boolean).void } + attr_writer :company_debit sig { returns(T.nilable(T::Boolean)) } - def debit_date - end + attr_reader :debit_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def debit_date=(_) - end + sig { params(debit_date: T::Boolean).void } + attr_writer :debit_date sig { returns(T.nilable(T::Boolean)) } - def employee_taxes - end + attr_reader :employee_taxes - sig { params(_: T::Boolean).returns(T::Boolean) } - def employee_taxes=(_) - end + sig { params(employee_taxes: T::Boolean).void } + attr_writer :employee_taxes sig { returns(T.nilable(T::Boolean)) } - def employer_taxes - end + attr_reader :employer_taxes - sig { params(_: T::Boolean).returns(T::Boolean) } - def employer_taxes=(_) - end + sig { params(employer_taxes: T::Boolean).void } + attr_writer :employer_taxes sig { returns(T.nilable(T::Boolean)) } - def gross_pay - end + attr_reader :gross_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def gross_pay=(_) - end + sig { params(gross_pay: T::Boolean).void } + attr_writer :gross_pay sig { returns(T.nilable(T::Boolean)) } - def individual_ids - end + attr_reader :individual_ids - sig { params(_: T::Boolean).returns(T::Boolean) } - def individual_ids=(_) - end + sig { params(individual_ids: T::Boolean).void } + attr_writer :individual_ids sig { returns(T.nilable(T::Boolean)) } - def net_pay - end + attr_reader :net_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def net_pay=(_) - end + sig { params(net_pay: T::Boolean).void } + attr_writer :net_pay sig { returns(T.nilable(T::Boolean)) } - def pay_date - end + attr_reader :pay_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_date=(_) - end + sig { params(pay_date: T::Boolean).void } + attr_writer :pay_date sig { returns(T.nilable(T::Boolean)) } - def pay_frequencies - end + attr_reader :pay_frequencies - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_frequencies=(_) - end + sig { params(pay_frequencies: T::Boolean).void } + attr_writer :pay_frequencies sig { returns(T.nilable(T::Boolean)) } - def pay_group_ids - end + attr_reader :pay_group_ids - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_group_ids=(_) - end + sig { params(pay_group_ids: T::Boolean).void } + attr_writer :pay_group_ids sig do returns( @@ -2692,25 +2221,18 @@ module FinchAPI ) ) end - def pay_period - end + attr_reader :pay_period sig do params( - _: T.any( + pay_period: T.any( FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::SupportedFields::Payment::PayPeriod, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_period=(_) + .void end + attr_writer :pay_period sig do params( @@ -2772,20 +2294,16 @@ module FinchAPI class PayPeriod < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def end_date - end + attr_reader :end_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def end_date=(_) - end + sig { params(end_date: T::Boolean).void } + attr_writer :end_date sig { returns(T.nilable(T::Boolean)) } - def start_date - end + attr_reader :start_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def start_date=(_) - end + sig { params(start_date: T::Boolean).void } + attr_writer :start_date sig { params(end_date: T::Boolean, start_date: T::Boolean).returns(T.attached_class) } def self.new(end_date: nil, start_date: nil) diff --git a/rbi/lib/finch-api/models/base_webhook_event.rbi b/rbi/lib/finch-api/models/base_webhook_event.rbi index 084ebe54..0516e4ce 100644 --- a/rbi/lib/finch-api/models/base_webhook_event.rbi +++ b/rbi/lib/finch-api/models/base_webhook_event.rbi @@ -7,31 +7,19 @@ module FinchAPI # connection. Use `connection_id` instead to identify the connection associated # with this event. sig { returns(String) } - def account_id - end - - sig { params(_: String).returns(String) } - def account_id=(_) - end + attr_accessor :account_id # [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use # `connection_id` instead to identify the connection associated with this event. sig { returns(String) } - def company_id - end - - sig { params(_: String).returns(String) } - def company_id=(_) - end + attr_accessor :company_id # Unique Finch ID of the connection associated with the webhook event. sig { returns(T.nilable(String)) } - def connection_id - end + attr_reader :connection_id - sig { params(_: String).returns(String) } - def connection_id=(_) - end + sig { params(connection_id: String).void } + attr_writer :connection_id sig { params(account_id: String, company_id: String, connection_id: String).returns(T.attached_class) } def self.new(account_id:, company_id:, connection_id: nil) diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index 9d2cb25b..55af18e3 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -4,25 +4,13 @@ module FinchAPI module Models class CompanyEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def data - end - - sig do - params(_: T.nilable(T::Hash[Symbol, T.anything])).returns(T.nilable(T::Hash[Symbol, T.anything])) - end - def data=(_) - end + attr_accessor :data sig { returns(T.nilable(FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::CompanyEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::CompanyEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::CompanyEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 609baaf8..1c06ab3c 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -8,91 +8,41 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(String) } - def customer_id - end - - sig { params(_: String).returns(String) } - def customer_id=(_) - end + attr_accessor :customer_id sig { returns(String) } - def customer_name - end - - sig { params(_: String).returns(String) } - def customer_name=(_) - end + attr_accessor :customer_name sig { returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol]) } - def products - end - - sig do - params(_: T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol]) - .returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::OrSymbol]) - end - def products=(_) - end + attr_accessor :products sig { returns(T.nilable(String)) } - def customer_email - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def customer_email=(_) - end + attr_accessor :customer_email sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration)) } - def integration - end + attr_reader :integration sig do params( - _: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)) + integration: T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Connect::SessionNewParams::Integration, FinchAPI::Util::AnyHash)) - ) - end - def integration=(_) + .void end + attr_writer :integration sig { returns(T.nilable(T::Boolean)) } - def manual - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def manual=(_) - end + attr_accessor :manual # The number of minutes until the session expires (defaults to 43,200, which is 30 # days) sig { returns(T.nilable(Float)) } - def minutes_to_expire - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def minutes_to_expire=(_) - end + attr_accessor :minutes_to_expire sig { returns(T.nilable(String)) } - def redirect_uri - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def redirect_uri=(_) - end + attr_accessor :redirect_uri sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol)) } - def sandbox - end - - sig do - params(_: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Sandbox::OrSymbol)) - end - def sandbox=(_) - end + attr_accessor :sandbox sig do params( @@ -169,23 +119,10 @@ module FinchAPI class Integration < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol)) } - def auth_method - end - - sig do - params(_: T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::OrSymbol)) - end - def auth_method=(_) - end + attr_accessor :auth_method sig { returns(T.nilable(String)) } - def provider - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def provider=(_) - end + attr_accessor :provider sig do params( diff --git a/rbi/lib/finch-api/models/connect/session_new_response.rbi b/rbi/lib/finch-api/models/connect/session_new_response.rbi index 8b146c57..99b78779 100644 --- a/rbi/lib/finch-api/models/connect/session_new_response.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_response.rbi @@ -6,21 +6,11 @@ module FinchAPI class SessionNewResponse < FinchAPI::BaseModel # The Connect URL to redirect the user to for authentication sig { returns(String) } - def connect_url - end - - sig { params(_: String).returns(String) } - def connect_url=(_) - end + attr_accessor :connect_url # The unique identifier for the created connect session sig { returns(String) } - def session_id - end - - sig { params(_: String).returns(String) } - def session_id=(_) - end + attr_accessor :session_id sig { params(connect_url: String, session_id: String).returns(T.attached_class) } def self.new(connect_url:, session_id:) diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index 1cb856e9..b035d63f 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -9,43 +9,20 @@ module FinchAPI # The ID of the existing connection to reauthenticate sig { returns(String) } - def connection_id - end - - sig { params(_: String).returns(String) } - def connection_id=(_) - end + attr_accessor :connection_id # The number of minutes until the session expires (defaults to 43,200, which is 30 # days) sig { returns(T.nilable(Integer)) } - def minutes_to_expire - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def minutes_to_expire=(_) - end + attr_accessor :minutes_to_expire # The products to request access to (optional for reauthentication) sig { returns(T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol])) } - def products - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol])) - .returns(T.nilable(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::OrSymbol])) - end - def products=(_) - end + attr_accessor :products # The URI to redirect to after the Connect flow is completed sig { returns(T.nilable(String)) } - def redirect_uri - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def redirect_uri=(_) - end + attr_accessor :redirect_uri sig do params( diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi index 7ef06a67..fa8b1c7d 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_response.rbi @@ -6,21 +6,11 @@ module FinchAPI class SessionReauthenticateResponse < FinchAPI::BaseModel # The Connect URL to redirect the user to for reauthentication sig { returns(String) } - def connect_url - end - - sig { params(_: String).returns(String) } - def connect_url=(_) - end + attr_accessor :connect_url # The unique identifier for the created connect session sig { returns(String) } - def session_id - end - - sig { params(_: String).returns(String) } - def session_id=(_) - end + attr_accessor :session_id sig { params(connect_url: String, session_id: String).returns(T.attached_class) } def self.new(connect_url:, session_id:) diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index e906fa24..8a1ab90a 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -5,105 +5,52 @@ module FinchAPI class CreateAccessTokenResponse < FinchAPI::BaseModel # The access token for the connection. sig { returns(String) } - def access_token - end - - sig { params(_: String).returns(String) } - def access_token=(_) - end + attr_accessor :access_token # [DEPRECATED] Use `connection_id` to identify the connection instead of this # account ID. sig { returns(String) } - def account_id - end - - sig { params(_: String).returns(String) } - def account_id=(_) - end + attr_accessor :account_id # The type of application associated with a token. sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) } - def client_type - end - - sig do - params(_: FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) - .returns(FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) - end - def client_type=(_) - end + attr_accessor :client_type # [DEPRECATED] Use `connection_id` to identify the connection instead of this # company ID. sig { returns(String) } - def company_id - end - - sig { params(_: String).returns(String) } - def company_id=(_) - end + attr_accessor :company_id # The Finch UUID of the connection associated with the `access_token`. sig { returns(String) } - def connection_id - end - - sig { params(_: String).returns(String) } - def connection_id=(_) - end + attr_accessor :connection_id # The type of the connection associated with the token. # # - `provider` - connection to an external provider # - `finch` - finch-generated data. sig { returns(FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) } - def connection_type - end - - sig do - params(_: FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) - .returns(FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) - end - def connection_type=(_) - end + attr_accessor :connection_type # An array of the authorized products associated with the `access_token`. sig { returns(T::Array[String]) } - def products - end - - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + attr_accessor :products # The ID of the provider associated with the `access_token`. sig { returns(String) } - def provider_id - end - - sig { params(_: String).returns(String) } - def provider_id=(_) - end + attr_accessor :provider_id # The ID of your customer you provided to Finch when a connect session was created # for this connection. sig { returns(T.nilable(String)) } - def customer_id - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def customer_id=(_) - end + attr_accessor :customer_id # The RFC 8693 token type (Finch uses `bearer` tokens) sig { returns(T.nilable(String)) } - def token_type - end + attr_reader :token_type - sig { params(_: String).returns(String) } - def token_type=(_) - end + sig { params(token_type: String).void } + attr_writer :token_type sig do params( diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index 91004480..abbc6fec 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -4,26 +4,16 @@ module FinchAPI module Models class DirectoryEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(FinchAPI::Models::DirectoryEvent::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::DirectoryEvent::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::DirectoryEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::DirectoryEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( @@ -50,12 +40,10 @@ module FinchAPI class Data < FinchAPI::BaseModel # The ID of the individual related to the event. sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig { params(individual_id: String).returns(T.attached_class) } def self.new(individual_id: nil) diff --git a/rbi/lib/finch-api/models/disconnect_response.rbi b/rbi/lib/finch-api/models/disconnect_response.rbi index 5b1ccc63..1b96cae8 100644 --- a/rbi/lib/finch-api/models/disconnect_response.rbi +++ b/rbi/lib/finch-api/models/disconnect_response.rbi @@ -5,12 +5,7 @@ module FinchAPI class DisconnectResponse < FinchAPI::BaseModel # If the request is successful, Finch will return “success” (HTTP 200 status). sig { returns(String) } - def status - end - - sig { params(_: String).returns(String) } - def status=(_) - end + attr_accessor :status sig { params(status: String).returns(T.attached_class) } def self.new(status:) diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index 64c055e9..ca7cc789 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -4,26 +4,16 @@ module FinchAPI module Models class EmploymentEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(FinchAPI::Models::EmploymentEvent::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::EmploymentEvent::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::EmploymentEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::EmploymentEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( @@ -50,12 +40,10 @@ module FinchAPI class Data < FinchAPI::BaseModel # The ID of the individual related to the event. sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig { params(individual_id: String).returns(T.attached_class) } def self.new(individual_id: nil) diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index a501831c..4ed09243 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -6,24 +6,11 @@ module FinchAPI class BenefitContribution < FinchAPI::BaseModel # Contribution amount in cents (if `fixed`) or basis points (if `percent`). sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount # Contribution type. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi index 414e2b91..4a8c86a7 100644 --- a/rbi/lib/finch-api/models/hris/benefit_create_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_create_params.rbi @@ -11,35 +11,17 @@ module FinchAPI # limiting this to <30 characters due to limitations in specific providers (e.g. # Justworks). sig { returns(T.nilable(String)) } - def description - end + attr_reader :description - sig { params(_: String).returns(String) } - def description=(_) - end + sig { params(description: String).void } + attr_writer :description sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) } - def frequency - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)) - end - def frequency=(_) - end + attr_accessor :frequency # Type of benefit. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 616b31da..220048e2 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -5,30 +5,26 @@ module FinchAPI module HRIS class BenefitFeaturesAndOperations < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures)) } - def supported_features - end + attr_reader :supported_features sig do params( - _: T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, FinchAPI::Util::AnyHash) + supported_features: T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, FinchAPI::Util::AnyHash) ) - .returns( - T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures, FinchAPI::Util::AnyHash) - ) - end - def supported_features=(_) + .void end + attr_writer :supported_features sig { returns(T.nilable(FinchAPI::Models::HRIS::SupportPerBenefitType)) } - def supported_operations - end + attr_reader :supported_operations sig do - params(_: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Util::AnyHash)) - end - def supported_operations=(_) + params( + supported_operations: T.any(FinchAPI::Models::HRIS::SupportPerBenefitType, FinchAPI::Util::AnyHash) + ) + .void end + attr_writer :supported_operations sig do params( @@ -55,22 +51,12 @@ module FinchAPI class SupportedFeatures < FinchAPI::BaseModel # Whether the provider supports an annual maximum for this benefit. sig { returns(T.nilable(T::Boolean)) } - def annual_maximum - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def annual_maximum=(_) - end + attr_accessor :annual_maximum # Whether the provider supports catch up for this benefit. This field will only be # true for retirement benefits. sig { returns(T.nilable(T::Boolean)) } - def catch_up - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def catch_up=(_) - end + attr_accessor :catch_up # Supported contribution types. An empty array indicates contributions are not # supported. @@ -85,39 +71,10 @@ module FinchAPI ) ) end - def company_contribution - end - - sig do - params( - _: T.nilable( - T::Array[ - T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol - ) - ] - ) - ) - .returns( - T.nilable( - T::Array[ - T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol - ) - ] - ) - ) - end - def company_contribution=(_) - end + attr_accessor :company_contribution sig { returns(T.nilable(String)) } - def description - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def description=(_) - end + attr_accessor :description # Supported deduction types. An empty array indicates deductions are not # supported. @@ -132,43 +89,14 @@ module FinchAPI ) ) end - def employee_deduction - end - - sig do - params( - _: T.nilable( - T::Array[ - T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol - ) - ] - ) - ) - .returns( - T.nilable( - T::Array[ - T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol - ) - ] - ) - ) - end - def employee_deduction=(_) - end + attr_accessor :employee_deduction # The list of frequencies supported by the provider for this benefit sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)])) } - def frequencies - end + attr_reader :frequencies - sig do - params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) - .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) - end - def frequencies=(_) - end + sig { params(frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]).void } + attr_writer :frequencies # Whether the provider supports HSA contribution limits. Empty if this feature is # not supported for the benefit. This array only has values for HSA benefits. @@ -183,31 +111,7 @@ module FinchAPI ) ) end - def hsa_contribution_limit - end - - sig do - params( - _: T.nilable( - T::Array[ - T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol - ) - ] - ) - ) - .returns( - T.nilable( - T::Array[ - T.nilable( - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol - ) - ] - ) - ) - end - def hsa_contribution_limit=(_) - end + attr_accessor :hsa_contribution_limit sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi index c0640c76..3b5343a9 100644 --- a/rbi/lib/finch-api/models/hris/benefit_update_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_update_params.rbi @@ -9,12 +9,10 @@ module FinchAPI # Updated name or description. sig { returns(T.nilable(String)) } - def description - end + attr_reader :description - sig { params(_: String).returns(String) } - def description=(_) - end + sig { params(description: String).void } + attr_writer :description sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index 03f97c07..39ed96bb 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -6,35 +6,26 @@ module FinchAPI module Benefits class EnrolledIndividual < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body)) } - def body - end + attr_reader :body sig do - params(_: T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash)) - end - def body=(_) + params(body: T.any(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Body, FinchAPI::Util::AnyHash)) + .void end + attr_writer :body # HTTP status code. Either 201 or 200 sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger)) } - def code - end + attr_reader :code - sig do - params(_: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger) - .returns(FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger) - end - def code=(_) - end + sig { params(code: FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::OrInteger).void } + attr_writer :code sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig do params( @@ -63,30 +54,15 @@ module FinchAPI class Body < FinchAPI::BaseModel # A descriptive identifier for the response sig { returns(T.nilable(String)) } - def finch_code - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def finch_code=(_) - end + attr_accessor :finch_code # Short description in English that provides more information about the response. sig { returns(T.nilable(String)) } - def message - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def message=(_) - end + attr_accessor :message # Identifier indicating whether the benefit was newly enrolled or updated. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name sig do params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String)) diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index c7d7e603..250086cf 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -6,31 +6,25 @@ module FinchAPI module Benefits class IndividualBenefit < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body)) } - def body - end + attr_reader :body sig do - params(_: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash)) - end - def body=(_) + params(body: T.any(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body, FinchAPI::Util::AnyHash)) + .void end + attr_writer :body sig { returns(T.nilable(Integer)) } - def code - end + attr_reader :code - sig { params(_: Integer).returns(Integer) } - def code=(_) - end + sig { params(code: Integer).void } + attr_writer :code sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig do params( @@ -55,44 +49,34 @@ module FinchAPI class Body < FinchAPI::BaseModel # If the benefit supports annual maximum, the amount in cents for this individual. sig { returns(T.nilable(Integer)) } - def annual_maximum - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def annual_maximum=(_) - end + attr_accessor :annual_maximum # If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled # for this individual. sig { returns(T.nilable(T::Boolean)) } - def catch_up - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def catch_up=(_) - end + attr_accessor :catch_up sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) } - def company_contribution - end + attr_reader :company_contribution sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) - end - def company_contribution=(_) + params( + company_contribution: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :company_contribution sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitContribution)) } - def employee_deduction - end + attr_reader :employee_deduction sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash))) - end - def employee_deduction=(_) + params( + employee_deduction: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitContribution, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :employee_deduction # Type for HSA contribution limit if the benefit is a HSA. sig do @@ -100,19 +84,7 @@ module FinchAPI T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) ) end - def hsa_contribution_limit - end - - sig do - params( - _: T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) - ) - .returns( - T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol) - ) - end - def hsa_contribution_limit=(_) - end + attr_accessor :hsa_contribution_limit sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index 04135eb2..7b24df70 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -10,19 +10,15 @@ module FinchAPI # Array of the individual_id to enroll and a configuration object. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual])) } - def individuals - end + attr_reader :individuals sig do params( - _: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)] + individuals: T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)] ) - .returns( - T::Array[T.any(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual, FinchAPI::Util::AnyHash)] - ) - end - def individuals=(_) + .void end + attr_writer :individuals sig do params( @@ -52,34 +48,25 @@ module FinchAPI T.nilable(FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration) ) end - def configuration - end + attr_reader :configuration sig do params( - _: T.any( + configuration: T.any( FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration, - FinchAPI::Util::AnyHash - ) - ) - end - def configuration=(_) + .void end + attr_writer :configuration # Finch id (uuidv4) for the individual to enroll sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig do params( @@ -116,37 +103,26 @@ module FinchAPI ) ) end - def annual_contribution_limit - end + attr_reader :annual_contribution_limit sig do params( - _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol + annual_contribution_limit: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol ) - .returns( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::OrSymbol - ) - end - def annual_contribution_limit=(_) + .void end + attr_writer :annual_contribution_limit # Maximum annual amount in cents sig { returns(T.nilable(Integer)) } - def annual_maximum - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def annual_maximum=(_) - end + attr_accessor :annual_maximum # For retirement benefits only - whether catch up contributions are enabled sig { returns(T.nilable(T::Boolean)) } - def catch_up - end + attr_reader :catch_up - sig { params(_: T::Boolean).returns(T::Boolean) } - def catch_up=(_) - end + sig { params(catch_up: T::Boolean).void } + attr_writer :catch_up sig do returns( @@ -155,25 +131,18 @@ module FinchAPI ) ) end - def company_contribution - end + attr_reader :company_contribution sig do params( - _: T.any( + company_contribution: T.any( FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution, - FinchAPI::Util::AnyHash - ) - ) - end - def company_contribution=(_) + .void end + attr_writer :company_contribution sig do returns( @@ -182,25 +151,18 @@ module FinchAPI ) ) end - def employee_deduction - end + attr_reader :employee_deduction sig do params( - _: T.any( + employee_deduction: T.any( FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction, - FinchAPI::Util::AnyHash - ) - ) - end - def employee_deduction=(_) + .void end + attr_writer :employee_deduction sig do params( @@ -288,12 +250,10 @@ module FinchAPI # Amount in cents for fixed type or basis points (1/100th of a percent) for # percent type sig { returns(T.nilable(Integer)) } - def amount - end + attr_reader :amount - sig { params(_: Integer).returns(Integer) } - def amount=(_) - end + sig { params(amount: Integer).void } + attr_writer :amount sig do returns( @@ -302,19 +262,15 @@ module FinchAPI ) ) end - def type - end + attr_reader :type sig do params( - _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol + type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol ) - .returns( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::OrSymbol - ) - end - def type=(_) + .void end + attr_writer :type sig do params( @@ -383,12 +339,10 @@ module FinchAPI # Amount in cents for fixed type or basis points (1/100th of a percent) for # percent type sig { returns(T.nilable(Integer)) } - def amount - end + attr_reader :amount - sig { params(_: Integer).returns(Integer) } - def amount=(_) - end + sig { params(amount: Integer).void } + attr_writer :amount sig do returns( @@ -397,19 +351,15 @@ module FinchAPI ) ) end - def type - end + attr_reader :type sig do params( - _: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol + type: FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol ) - .returns( - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::OrSymbol - ) - end - def type=(_) + .void end + attr_writer :type sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi index 7249275b..ef979642 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enrolled_ids_response.rbi @@ -6,20 +6,10 @@ module FinchAPI module Benefits class IndividualEnrolledIDsResponse < FinchAPI::BaseModel sig { returns(String) } - def benefit_id - end - - sig { params(_: String).returns(String) } - def benefit_id=(_) - end + attr_accessor :benefit_id sig { returns(T::Array[String]) } - def individual_ids - end - - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def individual_ids=(_) - end + attr_accessor :individual_ids sig { params(benefit_id: String, individual_ids: T::Array[String]).returns(T.attached_class) } def self.new(benefit_id:, individual_ids:) diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi index b539b38b..650ad7c8 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi @@ -11,12 +11,10 @@ module FinchAPI # comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals sig { returns(T.nilable(String)) } - def individual_ids - end + attr_reader :individual_ids - sig { params(_: String).returns(String) } - def individual_ids=(_) - end + sig { params(individual_ids: String).void } + attr_writer :individual_ids sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi index afec0760..9a5bc734 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_unenroll_many_params.rbi @@ -10,12 +10,10 @@ module FinchAPI # Array of individual_ids to unenroll. sig { returns(T.nilable(T::Array[String])) } - def individual_ids - end + attr_reader :individual_ids - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def individual_ids=(_) - end + sig { params(individual_ids: T::Array[String]).void } + attr_writer :individual_ids sig do params( diff --git a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi index b537dc0c..5a8206ce 100644 --- a/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/unenrolled_individual.rbi @@ -6,32 +6,26 @@ module FinchAPI module Benefits class UnenrolledIndividual < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body)) } - def body - end + attr_reader :body sig do - params(_: T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash)) - end - def body=(_) + params(body: T.any(FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual::Body, FinchAPI::Util::AnyHash)) + .void end + attr_writer :body # HTTP status code sig { returns(T.nilable(Integer)) } - def code - end + attr_reader :code - sig { params(_: Integer).returns(Integer) } - def code=(_) - end + sig { params(code: Integer).void } + attr_writer :code sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig do params( @@ -56,30 +50,15 @@ module FinchAPI class Body < FinchAPI::BaseModel # A descriptive identifier for the response. sig { returns(T.nilable(String)) } - def finch_code - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def finch_code=(_) - end + attr_accessor :finch_code # Short description in English that provides more information about the response. sig { returns(T.nilable(String)) } - def message - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def message=(_) - end + attr_accessor :message # Identifier indicating whether the benefit was newly enrolled or updated. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name sig do params(finch_code: T.nilable(String), message: T.nilable(String), name: T.nilable(String)) diff --git a/rbi/lib/finch-api/models/hris/benefits_support.rbi b/rbi/lib/finch-api/models/hris/benefits_support.rbi index ce43d8a5..0394d2d9 100644 --- a/rbi/lib/finch-api/models/hris/benefits_support.rbi +++ b/rbi/lib/finch-api/models/hris/benefits_support.rbi @@ -5,136 +5,136 @@ module FinchAPI module HRIS class BenefitsSupport < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def commuter - end + attr_reader :commuter sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def commuter=(_) + params( + commuter: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :commuter sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def custom_post_tax - end + attr_reader :custom_post_tax sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def custom_post_tax=(_) + params( + custom_post_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :custom_post_tax sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def custom_pre_tax - end + attr_reader :custom_pre_tax sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def custom_pre_tax=(_) + params( + custom_pre_tax: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :custom_pre_tax sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def fsa_dependent_care - end + attr_reader :fsa_dependent_care sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def fsa_dependent_care=(_) + params( + fsa_dependent_care: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :fsa_dependent_care sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def fsa_medical - end + attr_reader :fsa_medical sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def fsa_medical=(_) + params( + fsa_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :fsa_medical sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def hsa_post - end + attr_reader :hsa_post sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def hsa_post=(_) + params( + hsa_post: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :hsa_post sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def hsa_pre - end + attr_reader :hsa_pre sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def hsa_pre=(_) + params( + hsa_pre: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :hsa_pre sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def s125_dental - end + attr_reader :s125_dental sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def s125_dental=(_) + params( + s125_dental: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :s125_dental sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def s125_medical - end + attr_reader :s125_medical sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def s125_medical=(_) + params( + s125_medical: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :s125_medical sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def s125_vision - end + attr_reader :s125_vision sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def s125_vision=(_) + params( + s125_vision: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :s125_vision sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def simple - end + attr_reader :simple sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def simple=(_) + params( + simple: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :simple sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations)) } - def simple_ira - end + attr_reader :simple_ira sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash))) - end - def simple_ira=(_) + params( + simple_ira: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitFeaturesAndOperations, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :simple_ira # Each benefit type and their supported features. If the benefit type is not # supported, the property will be null diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 71699afa..40bbab48 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -6,95 +6,41 @@ module FinchAPI class HRISCompany < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for the company. sig { returns(String) } - def id - end - - sig { params(_: String).returns(String) } - def id=(_) - end + attr_accessor :id # An array of bank account objects associated with the payroll/HRIS system. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account])) } - def accounts - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account])) - .returns(T.nilable(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account])) - end - def accounts=(_) - end + attr_accessor :accounts # The array of company departments. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)])) } - def departments - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department)])) - end - def departments=(_) - end + attr_accessor :departments # The employer identification number. sig { returns(T.nilable(String)) } - def ein - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def ein=(_) - end + attr_accessor :ein # The entity type object. sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity)) } - def entity - end + attr_reader :entity - sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Util::AnyHash))) - end - def entity=(_) - end + sig { params(entity: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Entity, FinchAPI::Util::AnyHash))).void } + attr_writer :entity # The legal name of the company. sig { returns(T.nilable(String)) } - def legal_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def legal_name=(_) - end + attr_accessor :legal_name sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) } - def locations - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) - end - def locations=(_) - end + attr_accessor :locations # The email of the main administrator on the account. sig { returns(T.nilable(String)) } - def primary_email - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def primary_email=(_) - end + attr_accessor :primary_email # The phone number of the main administrator on the account. Format: `XXXXXXXXXX` sig { returns(T.nilable(String)) } - def primary_phone_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def primary_phone_number=(_) - end + attr_accessor :primary_phone_number sig do params( @@ -147,52 +93,24 @@ module FinchAPI class Account < FinchAPI::BaseModel # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } - def account_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def account_name=(_) - end + attr_accessor :account_name # 10-12 digit number to specify the bank account sig { returns(T.nilable(String)) } - def account_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def account_number=(_) - end + attr_accessor :account_number # The type of bank account. sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) } - def account_type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol)) - end - def account_type=(_) - end + attr_accessor :account_type # Name of the banking institution. sig { returns(T.nilable(String)) } - def institution_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def institution_name=(_) - end + attr_accessor :institution_name # A nine-digit code that's based on the U.S. Bank location where your account was # opened. sig { returns(T.nilable(String)) } - def routing_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def routing_number=(_) - end + attr_accessor :routing_number sig do params( @@ -244,28 +162,19 @@ module FinchAPI class Department < FinchAPI::BaseModel # The department name. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The parent department, if present. sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Department::Parent)) } - def parent - end + attr_reader :parent sig do params( - _: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Util::AnyHash)) + parent: T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::HRIS::HRISCompany::Department::Parent, FinchAPI::Util::AnyHash)) - ) - end - def parent=(_) + .void end + attr_writer :parent sig do params( @@ -289,12 +198,7 @@ module FinchAPI class Parent < FinchAPI::BaseModel # The parent department's name. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The parent department, if present. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -310,27 +214,11 @@ module FinchAPI class Entity < FinchAPI::BaseModel # The tax payer subtype of the company. sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) } - def subtype - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol)) - end - def subtype=(_) - end + attr_accessor :subtype # The tax payer type of the company. sig { returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type # The entity type object. sig do diff --git a/rbi/lib/finch-api/models/hris/company_benefit.rbi b/rbi/lib/finch-api/models/hris/company_benefit.rbi index 89693e17..265758ee 100644 --- a/rbi/lib/finch-api/models/hris/company_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/company_benefit.rbi @@ -5,43 +5,17 @@ module FinchAPI module HRIS class CompanyBenefit < FinchAPI::BaseModel sig { returns(String) } - def benefit_id - end - - sig { params(_: String).returns(String) } - def benefit_id=(_) - end + attr_accessor :benefit_id sig { returns(T.nilable(String)) } - def description - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def description=(_) - end + attr_accessor :description sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) } - def frequency - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)) - end - def frequency=(_) - end + attr_accessor :frequency # Type of benefit. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi b/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi index 6ca84f99..5ff70dca 100644 --- a/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi +++ b/rbi/lib/finch-api/models/hris/create_company_benefits_response.rbi @@ -5,12 +5,7 @@ module FinchAPI module HRIS class CreateCompanyBenefitsResponse < FinchAPI::BaseModel sig { returns(String) } - def benefit_id - end - - sig { params(_: String).returns(String) } - def benefit_id=(_) - end + attr_accessor :benefit_id sig { params(benefit_id: String).returns(T.attached_class) } def self.new(benefit_id:) diff --git a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi index 08b86c41..b616e087 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_individuals_params.rbi @@ -9,21 +9,17 @@ module FinchAPI # Number of employees to return (defaults to all) sig { returns(T.nilable(Integer)) } - def limit - end + attr_reader :limit - sig { params(_: Integer).returns(Integer) } - def limit=(_) - end + sig { params(limit: Integer).void } + attr_writer :limit # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } - def offset - end + attr_reader :offset - sig { params(_: Integer).returns(Integer) } - def offset=(_) - end + sig { params(offset: Integer).void } + attr_writer :offset sig do params( diff --git a/rbi/lib/finch-api/models/hris/directory_list_params.rbi b/rbi/lib/finch-api/models/hris/directory_list_params.rbi index d60f2825..df9594b7 100644 --- a/rbi/lib/finch-api/models/hris/directory_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/directory_list_params.rbi @@ -9,21 +9,17 @@ module FinchAPI # Number of employees to return (defaults to all) sig { returns(T.nilable(Integer)) } - def limit - end + attr_reader :limit - sig { params(_: Integer).returns(Integer) } - def limit=(_) - end + sig { params(limit: Integer).void } + attr_writer :limit # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } - def offset - end + attr_reader :offset - sig { params(_: Integer).returns(Integer) } - def offset=(_) - end + sig { params(offset: Integer).void } + attr_writer :offset sig do params( diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index 3a8a4a79..4ae1c24b 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -10,43 +10,32 @@ module FinchAPI # Comma-delimited list of stable Finch uuids for each individual. If empty, # defaults to all individuals sig { returns(T.nilable(T::Array[String])) } - def individual_ids - end + attr_reader :individual_ids - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def individual_ids=(_) - end + sig { params(individual_ids: T::Array[String]).void } + attr_writer :individual_ids # Number of documents to return (defaults to all) sig { returns(T.nilable(Integer)) } - def limit - end + attr_reader :limit - sig { params(_: Integer).returns(Integer) } - def limit=(_) - end + sig { params(limit: Integer).void } + attr_writer :limit # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } - def offset - end + attr_reader :offset - sig { params(_: Integer).returns(Integer) } - def offset=(_) - end + sig { params(offset: Integer).void } + attr_writer :offset # Comma-delimited list of document types to filter on. If empty, defaults to all # types sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol])) } - def types - end + attr_reader :types - sig do - params(_: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol]) - .returns(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol]) - end - def types=(_) - end + sig { params(types: T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::OrSymbol]).void } + attr_writer :types sig do params( diff --git a/rbi/lib/finch-api/models/hris/document_list_response.rbi b/rbi/lib/finch-api/models/hris/document_list_response.rbi index 2856c373..4c912a9d 100644 --- a/rbi/lib/finch-api/models/hris/document_list_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_response.rbi @@ -5,26 +5,13 @@ module FinchAPI module HRIS class DocumentListResponse < FinchAPI::BaseModel sig { returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse]) } - def documents - end - - sig do - params(_: T::Array[FinchAPI::Models::HRIS::DocumentResponse]) - .returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse]) - end - def documents=(_) - end + attr_accessor :documents sig { returns(FinchAPI::Models::Paging) } - def paging - end + attr_reader :paging - sig do - params(_: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) - end - def paging=(_) - end + sig { params(paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)).void } + attr_writer :paging sig do params( diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index 39e2e0ff..0f301daa 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -6,53 +6,34 @@ module FinchAPI class DocumentResponse < FinchAPI::BaseModel # A stable Finch id for the document. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The ID of the individual associated with the document. This will be null for # employer-level documents. sig { returns(T.nilable(String)) } - def individual_id - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def individual_id=(_) - end + attr_accessor :individual_id # The type of document. sig { returns(T.nilable(FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol)) } - def type - end + attr_reader :type - sig do - params(_: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol) - .returns(FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol) - end - def type=(_) - end + sig { params(type: FinchAPI::Models::HRIS::DocumentResponse::Type::OrSymbol).void } + attr_writer :type # A URL to access the document. Format: # `https://api.tryfinch.com/employer/documents/:document_id`. sig { returns(T.nilable(String)) } - def url - end + attr_reader :url - sig { params(_: String).returns(String) } - def url=(_) - end + sig { params(url: String).void } + attr_writer :url # The year the document applies to, if available. sig { returns(T.nilable(Float)) } - def year - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def year=(_) - end + attr_accessor :year sig do params( diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index 51b49dc2..ecc14ce4 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -6,207 +6,116 @@ module FinchAPI class EmploymentData < FinchAPI::BaseModel # string A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } - def class_code - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def class_code=(_) - end + attr_accessor :class_code # Custom fields for the individual. These are fields which are defined by the # employer in the system. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField])) } - def custom_fields - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField])) - .returns(T.nilable(T::Array[FinchAPI::Models::HRIS::EmploymentData::CustomField])) - end - def custom_fields=(_) - end + attr_accessor :custom_fields # The department object. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Department)) } - def department - end + attr_reader :department sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Util::AnyHash))) - end - def department=(_) + params( + department: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Department, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :department # The employment object. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment)) } - def employment - end + attr_reader :employment sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Util::AnyHash))) - end - def employment=(_) + params( + employment: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Employment, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :employment # The detailed employment status of the individual. Available options: `active`, # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol)) } - def employment_status - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol)) - end - def employment_status=(_) - end + attr_accessor :employment_status sig { returns(T.nilable(String)) } - def end_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def end_date=(_) - end + attr_accessor :end_date # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # The employee's income as reported by the provider. This may not always be # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } - def income - end + attr_reader :income - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - end - def income=(_) - end + sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))).void } + attr_writer :income # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } - def income_history - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - end - def income_history=(_) - end + attr_accessor :income_history # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } - def is_active - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def is_active=(_) - end + attr_accessor :is_active # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name sig { returns(T.nilable(String)) } - def latest_rehire_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def latest_rehire_date=(_) - end + attr_accessor :latest_rehire_date sig { returns(T.nilable(FinchAPI::Models::Location)) } - def location - end + attr_reader :location - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def location=(_) - end + sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :location # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Manager)) } - def manager - end + attr_reader :manager sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Util::AnyHash))) - end - def manager=(_) + params( + manager: T.nilable(T.any(FinchAPI::Models::HRIS::EmploymentData::Manager, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :manager # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } - def source_id - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def source_id=(_) - end + attr_accessor :source_id sig { returns(T.nilable(String)) } - def start_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def start_date=(_) - end + attr_accessor :start_date # The current title of the individual. sig { returns(T.nilable(String)) } - def title - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def title=(_) - end + attr_accessor :title # This field is deprecated in favour of `source_id` sig { returns(T.nilable(String)) } - def work_id - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def work_id=(_) - end + attr_accessor :work_id sig do params( @@ -289,20 +198,16 @@ module FinchAPI class CustomField < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def name - end + attr_reader :name - sig { params(_: String).returns(String) } - def name=(_) - end + sig { params(name: String).void } + attr_writer :name sig { returns(T.nilable(T.anything)) } - def value - end + attr_reader :value - sig { params(_: T.anything).returns(T.anything) } - def value=(_) - end + sig { params(value: T.anything).void } + attr_writer :value sig { params(name: String, value: T.anything).returns(T.attached_class) } def self.new(name: nil, value: nil) @@ -316,12 +221,7 @@ module FinchAPI class Department < FinchAPI::BaseModel # The name of the department associated with the individual. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -337,27 +237,11 @@ module FinchAPI # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol)) } - def subtype - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol)) - end - def subtype=(_) - end + attr_accessor :subtype # The main employment type of the individual. sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type # The employment object. sig do @@ -453,12 +337,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/models/hris/employment_data_response.rbi b/rbi/lib/finch-api/models/hris/employment_data_response.rbi index 56ca6b10..c4f4ed80 100644 --- a/rbi/lib/finch-api/models/hris/employment_data_response.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data_response.rbi @@ -5,31 +5,22 @@ module FinchAPI module HRIS class EmploymentDataResponse < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::EmploymentData)) } - def body - end + attr_reader :body - sig do - params(_: T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Util::AnyHash)) - end - def body=(_) - end + sig { params(body: T.any(FinchAPI::Models::HRIS::EmploymentData, FinchAPI::Util::AnyHash)).void } + attr_writer :body sig { returns(T.nilable(Integer)) } - def code - end + attr_reader :code - sig { params(_: Integer).returns(Integer) } - def code=(_) - end + sig { params(code: Integer).void } + attr_writer :code sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig do params( diff --git a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi index c5834412..5328d35e 100644 --- a/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/employment_retrieve_many_params.rbi @@ -9,15 +9,7 @@ module FinchAPI # The array of batch requests. sig { returns(T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]) } - def requests - end - - sig do - params(_: T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]) - .returns(T::Array[FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request]) - end - def requests=(_) - end + attr_accessor :requests sig do params( @@ -46,12 +38,7 @@ module FinchAPI # limit to the number of `individual_id` to send per request. It is preferantial # to send all ids in a single request for Finch to optimize provider rate-limits. sig { returns(String) } - def individual_id - end - - sig { params(_: String).returns(String) } - def individual_id=(_) - end + attr_accessor :individual_id sig { params(individual_id: String).returns(T.attached_class) } def self.new(individual_id:) diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index 4196fdb3..ce2789b5 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -6,136 +6,62 @@ module FinchAPI class Individual < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id sig { returns(T.nilable(String)) } - def dob - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def dob=(_) - end + attr_accessor :dob sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::Email])) } - def emails - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::Email])) - .returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::Email])) - end - def emails=(_) - end + attr_accessor :emails # Social Security Number of the individual in **encrypted** format. This field is # only available with the `ssn` scope enabled and the # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } - def encrypted_ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def encrypted_ssn=(_) - end + attr_accessor :encrypted_ssn # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol)) } - def ethnicity - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol)) - end - def ethnicity=(_) - end + attr_accessor :ethnicity # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # The gender of the individual. sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol)) } - def gender - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol)) - end - def gender=(_) - end + attr_accessor :gender # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber)])) } - def phone_numbers - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber)])) - end - def phone_numbers=(_) - end + attr_accessor :phone_numbers # The preferred name of the individual. sig { returns(T.nilable(String)) } - def preferred_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def preferred_name=(_) - end + attr_accessor :preferred_name sig { returns(T.nilable(FinchAPI::Models::Location)) } - def residence - end + attr_reader :residence - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def residence=(_) - end + sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :residence # Social Security Number of the individual. This field is only available with the # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the # body. # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } - def ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def ssn=(_) - end + attr_accessor :ssn sig do params( @@ -199,23 +125,13 @@ module FinchAPI class Email < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end + attr_reader :data - sig { params(_: String).returns(String) } - def data=(_) - end + sig { params(data: String).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params(data: String, type: T.nilable(FinchAPI::Models::HRIS::Individual::Email::Type::OrSymbol)) @@ -298,23 +214,10 @@ module FinchAPI class PhoneNumber < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def data=(_) - end + attr_accessor :data sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi index 2315d86e..96c1af08 100644 --- a/rbi/lib/finch-api/models/hris/individual_in_directory.rbi +++ b/rbi/lib/finch-api/models/hris/individual_in_directory.rbi @@ -6,78 +6,50 @@ module FinchAPI class IndividualInDirectory < FinchAPI::BaseModel # A stable Finch id (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The department object. sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Department)) } - def department - end + attr_reader :department sig do params( - _: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Util::AnyHash)) + department: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Department, FinchAPI::Util::AnyHash)) - ) - end - def department=(_) + .void end + attr_writer :department # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # `true` if the individual is an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } - def is_active - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def is_active=(_) - end + attr_accessor :is_active # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name # The manager object. sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualInDirectory::Manager)) } - def manager - end + attr_reader :manager sig do params( - _: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Util::AnyHash)) + manager: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Util::AnyHash)) ) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::IndividualInDirectory::Manager, FinchAPI::Util::AnyHash))) - end - def manager=(_) + .void end + attr_writer :manager # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name sig do params( @@ -114,12 +86,7 @@ module FinchAPI class Department < FinchAPI::BaseModel # The name of the department. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -134,12 +101,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The manager object. sig { params(id: String).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/models/hris/individual_response.rbi b/rbi/lib/finch-api/models/hris/individual_response.rbi index 42492fd3..19ed5262 100644 --- a/rbi/lib/finch-api/models/hris/individual_response.rbi +++ b/rbi/lib/finch-api/models/hris/individual_response.rbi @@ -5,31 +5,22 @@ module FinchAPI module HRIS class IndividualResponse < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual)) } - def body - end + attr_reader :body - sig do - params(_: T.any(FinchAPI::Models::HRIS::Individual, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::Individual, FinchAPI::Util::AnyHash)) - end - def body=(_) - end + sig { params(body: T.any(FinchAPI::Models::HRIS::Individual, FinchAPI::Util::AnyHash)).void } + attr_writer :body sig { returns(T.nilable(Integer)) } - def code - end + attr_reader :code - sig { params(_: Integer).returns(Integer) } - def code=(_) - end + sig { params(code: Integer).void } + attr_writer :code sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig do params( diff --git a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi index 338463c7..c1a70c1d 100644 --- a/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/individual_retrieve_many_params.rbi @@ -8,34 +8,26 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(T.nilable(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options)) } - def options - end + attr_reader :options sig do params( - _: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)) + options: T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, FinchAPI::Util::AnyHash)) - ) - end - def options=(_) + .void end + attr_writer :options sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request])) } - def requests - end + attr_reader :requests sig do params( - _: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Util::AnyHash)] + requests: T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Util::AnyHash)] ) - .returns( - T::Array[T.any(FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request, FinchAPI::Util::AnyHash)] - ) - end - def requests=(_) + .void end + attr_writer :requests sig do params( @@ -63,12 +55,10 @@ module FinchAPI class Options < FinchAPI::BaseModel sig { returns(T.nilable(T::Array[String])) } - def include - end + attr_reader :include - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def include=(_) - end + sig { params(include: T::Array[String]).void } + attr_writer :include sig { params(include: T::Array[String]).returns(T.attached_class) } def self.new(include: nil) @@ -81,12 +71,10 @@ module FinchAPI class Request < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig { params(individual_id: String).returns(T.attached_class) } def self.new(individual_id: nil) diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 0fe4f30b..7b927183 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -6,114 +6,49 @@ module FinchAPI class PayStatement < FinchAPI::BaseModel # The array of earnings objects associated with this pay statement sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)])) } - def earnings - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning)])) - end - def earnings=(_) - end + attr_accessor :earnings # The array of deductions objects associated with this pay statement. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)])) } - def employee_deductions - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction)])) - end - def employee_deductions=(_) - end + attr_accessor :employee_deductions sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)])) } - def employer_contributions - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution)])) - end - def employer_contributions=(_) - end + attr_accessor :employer_contributions sig { returns(T.nilable(FinchAPI::Models::Money)) } - def gross_pay - end + attr_reader :gross_pay - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def gross_pay=(_) - end + sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :gross_pay # A stable Finch `id` (UUID v4) for an individual in the company sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig { returns(T.nilable(FinchAPI::Models::Money)) } - def net_pay - end + attr_reader :net_pay - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def net_pay=(_) - end + sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :net_pay # The payment method. sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) } - def payment_method - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol)) - end - def payment_method=(_) - end + attr_accessor :payment_method # The array of taxes objects associated with this pay statement. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)])) } - def taxes - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax)])) - end - def taxes=(_) - end + attr_accessor :taxes # The number of hours worked for this pay period sig { returns(T.nilable(Float)) } - def total_hours - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def total_hours=(_) - end + attr_accessor :total_hours # The type of the payment associated with the pay statement. sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -173,67 +108,35 @@ module FinchAPI class Earning < FinchAPI::BaseModel # The earnings amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes)) } - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash)) + attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash)) - ) - end - def attributes=(_) + .void end + attr_writer :attributes # The earnings currency code. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # The number of hours associated with this earning. (For salaried employees, this # could be hours per pay period, `0` or `null`, depending on the provider). sig { returns(T.nilable(Float)) } - def hours - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def hours=(_) - end + attr_accessor :hours # The exact name of the deduction from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The type of earning. sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -267,19 +170,15 @@ module FinchAPI class Attributes < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata)) } - def metadata - end + attr_reader :metadata sig do params( - _: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash) + metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash) ) - .returns( - T.any(FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash) - ) - end - def metadata=(_) + .void end + attr_writer :metadata sig do params( @@ -299,12 +198,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) @@ -350,70 +247,36 @@ module FinchAPI class EmployeeDeduction < FinchAPI::BaseModel # The deduction amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes)) } - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable( + attributes: T.nilable( T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash) ) ) - .returns( - T.nilable( - T.any(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash) - ) - ) - end - def attributes=(_) + .void end + attr_writer :attributes # The deduction currency. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # The deduction name from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # Boolean indicating if the deduction is pre-tax. sig { returns(T.nilable(T::Boolean)) } - def pre_tax - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def pre_tax=(_) - end + attr_accessor :pre_tax # Type of benefit. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -449,25 +312,18 @@ module FinchAPI class Attributes < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata)) } - def metadata - end + attr_reader :metadata sig do params( - _: T.any( + metadata: T.any( FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata, - FinchAPI::Util::AnyHash - ) - ) - end - def metadata=(_) + .void end + attr_writer :metadata sig do params( @@ -492,12 +348,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) @@ -513,61 +367,32 @@ module FinchAPI class EmployerContribution < FinchAPI::BaseModel # The contribution amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes)) } - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable( + attributes: T.nilable( T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash) ) ) - .returns( - T.nilable( - T.any(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash) - ) - ) - end - def attributes=(_) + .void end + attr_writer :attributes # The contribution currency. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # The contribution name from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # Type of benefit. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -601,25 +426,18 @@ module FinchAPI class Attributes < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata)) } - def metadata - end + attr_reader :metadata sig do params( - _: T.any( + metadata: T.any( FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata, - FinchAPI::Util::AnyHash - ) - ) - end - def metadata=(_) + .void end + attr_writer :metadata sig do params( @@ -645,12 +463,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) @@ -685,64 +501,34 @@ module FinchAPI class Tax < FinchAPI::BaseModel # The tax amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes)) } - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash)) + attributes: T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash)) ) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash))) - end - def attributes=(_) + .void end + attr_writer :attributes # The currency code. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # `true` if the amount is paid by the employers. sig { returns(T.nilable(T::Boolean)) } - def employer - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def employer=(_) - end + attr_accessor :employer # The exact name of tax from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The type of taxes. sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -776,15 +562,15 @@ module FinchAPI class Attributes < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata)) } - def metadata - end + attr_reader :metadata sig do - params(_: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash)) - end - def metadata=(_) + params( + metadata: T.any(FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash) + ) + .void end + attr_writer :metadata sig do params( @@ -804,12 +590,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi index cfd31e95..0a080722 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response.rbi @@ -5,31 +5,22 @@ module FinchAPI module HRIS class PayStatementResponse < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::HRIS::PayStatementResponseBody)) } - def body - end + attr_reader :body - sig do - params(_: T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Util::AnyHash)) - end - def body=(_) - end + sig { params(body: T.any(FinchAPI::Models::HRIS::PayStatementResponseBody, FinchAPI::Util::AnyHash)).void } + attr_writer :body sig { returns(T.nilable(Integer)) } - def code - end + attr_reader :code - sig { params(_: Integer).returns(Integer) } - def code=(_) - end + sig { params(code: Integer).void } + attr_writer :code sig { returns(T.nilable(String)) } - def payment_id - end + attr_reader :payment_id - sig { params(_: String).returns(String) } - def payment_id=(_) - end + sig { params(payment_id: String).void } + attr_writer :payment_id sig do params( diff --git a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi index c2e3dd0d..906ab10f 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_response_body.rbi @@ -5,27 +5,17 @@ module FinchAPI module HRIS class PayStatementResponseBody < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::Paging)) } - def paging - end + attr_reader :paging - sig do - params(_: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)) - end - def paging=(_) - end + sig { params(paging: T.any(FinchAPI::Models::Paging, FinchAPI::Util::AnyHash)).void } + attr_writer :paging # The array of pay statements for the current payment. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::PayStatement])) } - def pay_statements - end + attr_reader :pay_statements - sig do - params(_: T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Util::AnyHash)]) - .returns(T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Util::AnyHash)]) - end - def pay_statements=(_) - end + sig { params(pay_statements: T::Array[T.any(FinchAPI::Models::HRIS::PayStatement, FinchAPI::Util::AnyHash)]).void } + attr_writer :pay_statements sig do params( diff --git a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi index 4cf09209..165efc26 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement_retrieve_many_params.rbi @@ -9,15 +9,7 @@ module FinchAPI # The array of batch requests. sig { returns(T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]) } - def requests - end - - sig do - params(_: T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]) - .returns(T::Array[FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request]) - end - def requests=(_) - end + attr_accessor :requests sig do params( @@ -44,30 +36,21 @@ module FinchAPI class Request < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for a payment. sig { returns(String) } - def payment_id - end - - sig { params(_: String).returns(String) } - def payment_id=(_) - end + attr_accessor :payment_id # Number of pay statements to return (defaults to all). sig { returns(T.nilable(Integer)) } - def limit - end + attr_reader :limit - sig { params(_: Integer).returns(Integer) } - def limit=(_) - end + sig { params(limit: Integer).void } + attr_writer :limit # Index to start from. sig { returns(T.nilable(Integer)) } - def offset - end + attr_reader :offset - sig { params(_: Integer).returns(Integer) } - def offset=(_) - end + sig { params(offset: Integer).void } + attr_writer :offset sig { params(payment_id: String, limit: Integer, offset: Integer).returns(T.attached_class) } def self.new(payment_id:, limit: nil, offset: nil) diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index 576954c0..f7007887 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -6,125 +6,68 @@ module FinchAPI class Payment < FinchAPI::BaseModel # The unique id for the payment. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id sig { returns(T.nilable(FinchAPI::Models::Money)) } - def company_debit - end + attr_reader :company_debit - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def company_debit=(_) - end + sig { params(company_debit: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :company_debit sig { returns(T.nilable(String)) } - def debit_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def debit_date=(_) - end + attr_accessor :debit_date sig { returns(T.nilable(FinchAPI::Models::Money)) } - def employee_taxes - end + attr_reader :employee_taxes - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def employee_taxes=(_) - end + sig { params(employee_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :employee_taxes sig { returns(T.nilable(FinchAPI::Models::Money)) } - def employer_taxes - end + attr_reader :employer_taxes - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def employer_taxes=(_) - end + sig { params(employer_taxes: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :employer_taxes sig { returns(T.nilable(FinchAPI::Models::Money)) } - def gross_pay - end + attr_reader :gross_pay - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def gross_pay=(_) - end + sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :gross_pay # Array of every individual on this payment. sig { returns(T.nilable(T::Array[String])) } - def individual_ids - end - - sig { params(_: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) } - def individual_ids=(_) - end + attr_accessor :individual_ids sig { returns(T.nilable(FinchAPI::Models::Money)) } - def net_pay - end + attr_reader :net_pay - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def net_pay=(_) - end + sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :net_pay sig { returns(T.nilable(String)) } - def pay_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def pay_date=(_) - end + attr_accessor :pay_date # List of pay frequencies associated with this payment. sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol])) } - def pay_frequencies - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol])) - .returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol])) - end - def pay_frequencies=(_) - end + attr_accessor :pay_frequencies # Array of the Finch id (uuidv4) of every pay group associated with this payment. sig { returns(T.nilable(T::Array[String])) } - def pay_group_ids - end - - sig { params(_: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) } - def pay_group_ids=(_) - end + attr_accessor :pay_group_ids # The pay period object. sig { returns(T.nilable(FinchAPI::Models::HRIS::Payment::PayPeriod)) } - def pay_period - end + attr_reader :pay_period sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Util::AnyHash))) - end - def pay_period=(_) + params(pay_period: T.nilable(T.any(FinchAPI::Models::HRIS::Payment::PayPeriod, FinchAPI::Util::AnyHash))) + .void end + attr_writer :pay_period sig do params( @@ -206,20 +149,10 @@ module FinchAPI class PayPeriod < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def end_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def end_date=(_) - end + attr_accessor :end_date sig { returns(T.nilable(String)) } - def start_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def start_date=(_) - end + attr_accessor :start_date # The pay period object. sig { params(end_date: T.nilable(String), start_date: T.nilable(String)).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/models/hris/payment_list_params.rbi b/rbi/lib/finch-api/models/hris/payment_list_params.rbi index 370a0ec5..0287f985 100644 --- a/rbi/lib/finch-api/models/hris/payment_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/payment_list_params.rbi @@ -10,22 +10,12 @@ module FinchAPI # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` # format. sig { returns(Date) } - def end_date - end - - sig { params(_: Date).returns(Date) } - def end_date=(_) - end + attr_accessor :end_date # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` # format. sig { returns(Date) } - def start_date - end - - sig { params(_: Date).returns(Date) } - def start_date=(_) - end + attr_accessor :start_date sig do params( diff --git a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi index 1743e2c7..0d8cea7c 100644 --- a/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/support_per_benefit_type.rbi @@ -5,26 +5,16 @@ module FinchAPI module HRIS class SupportPerBenefitType < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::OperationSupportMatrix)) } - def company_benefits - end + attr_reader :company_benefits - sig do - params(_: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) - end - def company_benefits=(_) - end + sig { params(company_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)).void } + attr_writer :company_benefits sig { returns(T.nilable(FinchAPI::Models::OperationSupportMatrix)) } - def individual_benefits - end + attr_reader :individual_benefits - sig do - params(_: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)) - end - def individual_benefits=(_) - end + sig { params(individual_benefits: T.any(FinchAPI::Models::OperationSupportMatrix, FinchAPI::Util::AnyHash)).void } + attr_writer :individual_benefits sig do params( diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index f9e24a7d..4e43b027 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -6,22 +6,12 @@ module FinchAPI class SupportedBenefit < FinchAPI::BaseModel # Whether the provider supports an annual maximum for this benefit. sig { returns(T.nilable(T::Boolean)) } - def annual_maximum - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def annual_maximum=(_) - end + attr_accessor :annual_maximum # Whether the provider supports catch up for this benefit. This field will only be # true for retirement benefits. sig { returns(T.nilable(T::Boolean)) } - def catch_up - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def catch_up=(_) - end + attr_accessor :catch_up # Supported contribution types. An empty array indicates contributions are not # supported. @@ -32,31 +22,10 @@ module FinchAPI ) ) end - def company_contribution - end - - sig do - params( - _: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] - ) - ) - .returns( - T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol)] - ) - ) - end - def company_contribution=(_) - end + attr_accessor :company_contribution sig { returns(T.nilable(String)) } - def description - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def description=(_) - end + attr_accessor :description # Supported deduction types. An empty array indicates deductions are not # supported. @@ -65,31 +34,14 @@ module FinchAPI T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]) ) end - def employee_deduction - end - - sig do - params( - _: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]) - ) - .returns( - T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol)]) - ) - end - def employee_deduction=(_) - end + attr_accessor :employee_deduction # The list of frequencies supported by the provider for this benefit sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol)])) } - def frequencies - end + attr_reader :frequencies - sig do - params(_: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) - .returns(T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]) - end - def frequencies=(_) - end + sig { params(frequencies: T::Array[T.nilable(FinchAPI::Models::HRIS::BenefitFrequency::OrSymbol)]).void } + attr_writer :frequencies # Whether the provider supports HSA contribution limits. Empty if this feature is # not supported for the benefit. This array only has values for HSA benefits. @@ -100,35 +52,11 @@ module FinchAPI ) ) end - def hsa_contribution_limit - end - - sig do - params( - _: T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] - ) - ) - .returns( - T.nilable( - T::Array[T.nilable(FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol)] - ) - ) - end - def hsa_contribution_limit=(_) - end + attr_accessor :hsa_contribution_limit # Type of benefit. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi b/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi index b9d0cc85..822dbf5c 100644 --- a/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi +++ b/rbi/lib/finch-api/models/hris/update_company_benefit_response.rbi @@ -5,12 +5,7 @@ module FinchAPI module HRIS class UpdateCompanyBenefitResponse < FinchAPI::BaseModel sig { returns(String) } - def benefit_id - end - - sig { params(_: String).returns(String) } - def benefit_id=(_) - end + attr_accessor :benefit_id sig { params(benefit_id: String).returns(T.attached_class) } def self.new(benefit_id:) diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 8fd4bf26..67a6852c 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -6,36 +6,21 @@ module FinchAPI class W42005 < FinchAPI::BaseModel # Detailed information specific to the 2005 W4 form. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::HRIS::W42005::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data # Specifies the form type, indicating that this document is a 2005 W4 form. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol)) } - def type - end + attr_reader :type - sig do - params(_: FinchAPI::Models::HRIS::W42005::Type::OrSymbol) - .returns(FinchAPI::Models::HRIS::W42005::Type::OrSymbol) - end - def type=(_) - end + sig { params(type: FinchAPI::Models::HRIS::W42005::Type::OrSymbol).void } + attr_writer :type # The tax year this W4 document applies to. sig { returns(T.nilable(Float)) } - def year - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def year=(_) - end + attr_accessor :year # A 2005 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. @@ -66,54 +51,32 @@ module FinchAPI class Data < FinchAPI::BaseModel # Additional withholding amount (in cents). sig { returns(T.nilable(Integer)) } - def additional_withholding - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def additional_withholding=(_) - end + attr_accessor :additional_withholding # Indicates exemption status from federal tax withholding. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol)) } - def exemption - end + attr_reader :exemption - sig do - params(_: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol) - .returns(FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol) - end - def exemption=(_) - end + sig { params(exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol).void } + attr_writer :exemption # The individual's filing status for tax purposes. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol)) } - def filing_status - end + attr_reader :filing_status - sig do - params(_: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol) - .returns(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol) - end - def filing_status=(_) - end + sig { params(filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol).void } + attr_writer :filing_status # The unique identifier for the individual associated with this 2005 W4 form. sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id # Total number of allowances claimed (in cents). sig { returns(T.nilable(Integer)) } - def total_number_of_allowances - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def total_number_of_allowances=(_) - end + attr_accessor :total_number_of_allowances # Detailed information specific to the 2005 W4 form. sig do diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index 103bcef4..eb075137 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -6,36 +6,21 @@ module FinchAPI class W42020 < FinchAPI::BaseModel # Detailed information specific to the 2020 W4 form. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::HRIS::W42020::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data # Specifies the form type, indicating that this document is a 2020 W4 form. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol)) } - def type - end + attr_reader :type - sig do - params(_: FinchAPI::Models::HRIS::W42020::Type::OrSymbol) - .returns(FinchAPI::Models::HRIS::W42020::Type::OrSymbol) - end - def type=(_) - end + sig { params(type: FinchAPI::Models::HRIS::W42020::Type::OrSymbol).void } + attr_writer :type # The tax year this W4 document applies to. sig { returns(T.nilable(Float)) } - def year - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def year=(_) - end + attr_accessor :year # A 2020 version of the W-4 tax form containing information on an individual's # filing status, dependents, and withholding details. @@ -67,78 +52,38 @@ module FinchAPI # Amount claimed for dependents other than qualifying children under 17 (in # cents). sig { returns(T.nilable(Integer)) } - def amount_for_other_dependents - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount_for_other_dependents=(_) - end + attr_accessor :amount_for_other_dependents # Amount claimed for dependents under 17 years old (in cents). sig { returns(T.nilable(Integer)) } - def amount_for_qualifying_children_under_17 - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount_for_qualifying_children_under_17=(_) - end + attr_accessor :amount_for_qualifying_children_under_17 # Deductible expenses (in cents). sig { returns(T.nilable(Integer)) } - def deductions - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def deductions=(_) - end + attr_accessor :deductions # Additional withholding amount (in cents). sig { returns(T.nilable(Integer)) } - def extra_withholding - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def extra_withholding=(_) - end + attr_accessor :extra_withholding # The individual's filing status for tax purposes. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol)) } - def filing_status - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol)) - end - def filing_status=(_) - end + attr_accessor :filing_status # The unique identifier for the individual associated with this document. sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id # Additional income from sources outside of primary employment (in cents). sig { returns(T.nilable(Integer)) } - def other_income - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def other_income=(_) - end + attr_accessor :other_income # Total amount claimed for dependents and other credits (in cents). sig { returns(T.nilable(Integer)) } - def total_claim_dependent_and_other_credits - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def total_claim_dependent_and_other_credits=(_) - end + attr_accessor :total_claim_dependent_and_other_credits # Detailed information specific to the 2020 W4 form. sig do diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index 43d431c6..82e845a0 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -5,43 +5,20 @@ module FinchAPI class Income < FinchAPI::BaseModel # The income amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount # The currency code. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # The date the income amount went into effect. sig { returns(T.nilable(String)) } - def effective_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def effective_date=(_) - end + attr_accessor :effective_date # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, # `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. sig { returns(T.nilable(FinchAPI::Models::Income::Unit::OrSymbol)) } - def unit - end - - sig do - params(_: T.nilable(FinchAPI::Models::Income::Unit::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Income::Unit::OrSymbol)) - end - def unit=(_) - end + attr_accessor :unit # The employee's income as reported by the provider. This may not always be # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index 2e756cb2..a6c5be02 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -4,26 +4,16 @@ module FinchAPI module Models class IndividualEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(FinchAPI::Models::IndividualEvent::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::IndividualEvent::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::IndividualEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::IndividualEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::IndividualEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( @@ -50,12 +40,10 @@ module FinchAPI class Data < FinchAPI::BaseModel # The ID of the individual related to the event. sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig { params(individual_id: String).returns(T.attached_class) } def self.new(individual_id: nil) diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index c7fa5047..647b979e 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -6,167 +6,83 @@ module FinchAPI # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection # instead of this account ID. sig { returns(String) } - def account_id - end - - sig { params(_: String).returns(String) } - def account_id=(_) - end + attr_accessor :account_id sig { returns(T::Array[FinchAPI::Models::Introspection::AuthenticationMethod]) } - def authentication_methods - end - - sig do - params(_: T::Array[FinchAPI::Models::Introspection::AuthenticationMethod]) - .returns(T::Array[FinchAPI::Models::Introspection::AuthenticationMethod]) - end - def authentication_methods=(_) - end + attr_accessor :authentication_methods # The client ID of the application associated with the `access_token`. sig { returns(String) } - def client_id - end - - sig { params(_: String).returns(String) } - def client_id=(_) - end + attr_accessor :client_id # The type of application associated with a token. sig { returns(FinchAPI::Models::Introspection::ClientType::TaggedSymbol) } - def client_type - end - - sig do - params(_: FinchAPI::Models::Introspection::ClientType::TaggedSymbol) - .returns(FinchAPI::Models::Introspection::ClientType::TaggedSymbol) - end - def client_type=(_) - end + attr_accessor :client_type # [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection # instead of this company ID. sig { returns(String) } - def company_id - end - - sig { params(_: String).returns(String) } - def company_id=(_) - end + attr_accessor :company_id # The Finch UUID of the connection associated with the `access_token`. sig { returns(String) } - def connection_id - end - - sig { params(_: String).returns(String) } - def connection_id=(_) - end + attr_accessor :connection_id sig { returns(FinchAPI::Models::Introspection::ConnectionStatus) } - def connection_status - end + attr_reader :connection_status sig do - params(_: T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Util::AnyHash)) - end - def connection_status=(_) + params( + connection_status: T.any(FinchAPI::Models::Introspection::ConnectionStatus, FinchAPI::Util::AnyHash) + ) + .void end + attr_writer :connection_status # The type of the connection associated with the token. # # - `provider` - connection to an external provider # - `finch` - finch-generated data. sig { returns(FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) } - def connection_type - end - - sig do - params(_: FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) - .returns(FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) - end - def connection_type=(_) - end + attr_accessor :connection_type # The email of your customer you provided to Finch when a connect session was # created for this connection. sig { returns(T.nilable(String)) } - def customer_email - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def customer_email=(_) - end + attr_accessor :customer_email # The ID of your customer you provided to Finch when a connect session was created # for this connection. sig { returns(T.nilable(String)) } - def customer_id - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def customer_id=(_) - end + attr_accessor :customer_id # The name of your customer you provided to Finch when a connect session was # created for this connection. sig { returns(T.nilable(String)) } - def customer_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def customer_name=(_) - end + attr_accessor :customer_name # Whether the connection associated with the `access_token` uses the Assisted # Connect Flow. (`true` if using Assisted Connect, `false` if connection is # automated) sig { returns(T::Boolean) } - def manual - end - - sig { params(_: T::Boolean).returns(T::Boolean) } - def manual=(_) - end + attr_accessor :manual # [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll # provider ID. sig { returns(String) } - def payroll_provider_id - end - - sig { params(_: String).returns(String) } - def payroll_provider_id=(_) - end + attr_accessor :payroll_provider_id # An array of the authorized products associated with the `access_token`. sig { returns(T::Array[String]) } - def products - end - - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + attr_accessor :products # The ID of the provider associated with the `access_token`. sig { returns(String) } - def provider_id - end - - sig { params(_: String).returns(String) } - def provider_id=(_) - end + attr_accessor :provider_id # The account username used for login associated with the `access_token`. sig { returns(String) } - def username - end - - sig { params(_: String).returns(String) } - def username=(_) - end + attr_accessor :username sig do params( @@ -237,40 +153,29 @@ module FinchAPI class AuthenticationMethod < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus)) } - def connection_status - end + attr_reader :connection_status sig do params( - _: T.any(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, FinchAPI::Util::AnyHash) + connection_status: T.any(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, FinchAPI::Util::AnyHash) ) - .returns( - T.any(FinchAPI::Models::Introspection::AuthenticationMethod::ConnectionStatus, FinchAPI::Util::AnyHash) - ) - end - def connection_status=(_) + .void end + attr_writer :connection_status # An array of the authorized products associated with the `access_token`. sig { returns(T.nilable(T::Array[String])) } - def products - end + attr_reader :products - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + sig { params(products: T::Array[String]).void } + attr_writer :products # The type of authentication method. sig { returns(T.nilable(FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol)) } - def type - end + attr_reader :type - sig do - params(_: FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol) - .returns(FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol) - end - def type=(_) - end + sig { params(type: FinchAPI::Models::Introspection::AuthenticationMethod::Type::OrSymbol).void } + attr_writer :type sig do params( @@ -298,23 +203,16 @@ module FinchAPI class ConnectionStatus < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def message - end + attr_reader :message - sig { params(_: String).returns(String) } - def message=(_) - end + sig { params(message: String).void } + attr_writer :message sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::TaggedSymbol)) } - def status - end + attr_reader :status - sig do - params(_: FinchAPI::Models::ConnectionStatusType::OrSymbol) - .returns(FinchAPI::Models::ConnectionStatusType::OrSymbol) - end - def status=(_) - end + sig { params(status: FinchAPI::Models::ConnectionStatusType::OrSymbol).void } + attr_writer :status sig do params(message: String, status: FinchAPI::Models::ConnectionStatusType::OrSymbol).returns(T.attached_class) @@ -372,23 +270,16 @@ module FinchAPI class ConnectionStatus < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def message - end + attr_reader :message - sig { params(_: String).returns(String) } - def message=(_) - end + sig { params(message: String).void } + attr_writer :message sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::TaggedSymbol)) } - def status - end + attr_reader :status - sig do - params(_: FinchAPI::Models::ConnectionStatusType::OrSymbol) - .returns(FinchAPI::Models::ConnectionStatusType::OrSymbol) - end - def status=(_) - end + sig { params(status: FinchAPI::Models::ConnectionStatusType::OrSymbol).void } + attr_writer :status sig do params(message: String, status: FinchAPI::Models::ConnectionStatusType::OrSymbol).returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index d53591c9..bb7a2ba7 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -4,26 +4,16 @@ module FinchAPI module Models class JobCompletionEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(FinchAPI::Models::JobCompletionEvent::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::JobCompletionEvent::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::JobCompletionEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( @@ -50,21 +40,11 @@ module FinchAPI class Data < FinchAPI::BaseModel # The id of the job which has completed. sig { returns(String) } - def job_id - end - - sig { params(_: String).returns(String) } - def job_id=(_) - end + attr_accessor :job_id # The url to query the result of the job. sig { returns(String) } - def job_url - end - - sig { params(_: String).returns(String) } - def job_url=(_) - end + attr_accessor :job_url sig { params(job_id: String, job_url: String).returns(T.attached_class) } def self.new(job_id:, job_url:) diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 122f84da..7b54ec62 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -6,96 +6,50 @@ module FinchAPI class AutomatedAsyncJob < FinchAPI::BaseModel # The datetime the job completed. sig { returns(T.nilable(Time)) } - def completed_at - end - - sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) } - def completed_at=(_) - end + attr_accessor :completed_at # The datetime when the job was created. for scheduled jobs, this will be the # initial connection time. For ad-hoc jobs, this will be the time the creation # request was received. sig { returns(Time) } - def created_at - end - - sig { params(_: Time).returns(Time) } - def created_at=(_) - end + attr_accessor :created_at # The id of the job that has been created. sig { returns(String) } - def job_id - end - - sig { params(_: String).returns(String) } - def job_id=(_) - end + attr_accessor :job_id # The url that can be used to retrieve the job status sig { returns(String) } - def job_url - end - - sig { params(_: String).returns(String) } - def job_url=(_) - end + attr_accessor :job_url # The input parameters for the job. sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params)) } - def params - end + attr_reader :params sig do - params(_: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Util::AnyHash))) - end - def params=(_) + params( + params: T.nilable(T.any(FinchAPI::Models::Jobs::AutomatedAsyncJob::Params, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :params # The datetime a job is scheduled to be run. For scheduled jobs, this datetime can # be in the future if the job has not yet been enqueued. For ad-hoc jobs, this # field will be null. sig { returns(T.nilable(Time)) } - def scheduled_at - end - - sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) } - def scheduled_at=(_) - end + attr_accessor :scheduled_at # The datetime a job entered into the job queue. sig { returns(T.nilable(Time)) } - def started_at - end - - sig { params(_: T.nilable(Time)).returns(T.nilable(Time)) } - def started_at=(_) - end + attr_accessor :started_at sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) } - def status - end - - sig do - params(_: FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) - .returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) - end - def status=(_) - end + attr_accessor :status # The type of automated job sig { returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) } - def type - end - - sig do - params(_: FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) - .returns(FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -136,12 +90,10 @@ module FinchAPI class Params < FinchAPI::BaseModel # The ID of the individual that the job was completed for. sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id # The input parameters for the job. sig { params(individual_id: String).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index cb088c84..d35cabc0 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -9,26 +9,13 @@ module FinchAPI # The type of job to start. sig { returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) } - def type - end - - sig do - params(_: FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) - .returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Type::OrSymbol) - end - def type=(_) - end + attr_accessor :type sig { returns(FinchAPI::Models::Jobs::AutomatedCreateParams::Params) } - def params - end + attr_reader :params - sig do - params(_: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Util::AnyHash)) - end - def params=(_) - end + sig { params(params: T.any(FinchAPI::Models::Jobs::AutomatedCreateParams::Params, FinchAPI::Util::AnyHash)).void } + attr_writer :params sig do params( @@ -75,12 +62,7 @@ module FinchAPI class Params < FinchAPI::BaseModel # The unique ID of the individual for W-4 data sync. sig { returns(String) } - def individual_id - end - - sig { params(_: String).returns(String) } - def individual_id=(_) - end + attr_accessor :individual_id sig { params(individual_id: String).returns(T.attached_class) } def self.new(individual_id:) diff --git a/rbi/lib/finch-api/models/jobs/automated_create_response.rbi b/rbi/lib/finch-api/models/jobs/automated_create_response.rbi index 08db7b27..b431553e 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_response.rbi @@ -6,39 +6,19 @@ module FinchAPI class AutomatedCreateResponse < FinchAPI::BaseModel # The number of allowed refreshes per hour (per hour, fixed window) sig { returns(Integer) } - def allowed_refreshes - end - - sig { params(_: Integer).returns(Integer) } - def allowed_refreshes=(_) - end + attr_accessor :allowed_refreshes # The id of the job that has been created. sig { returns(String) } - def job_id - end - - sig { params(_: String).returns(String) } - def job_id=(_) - end + attr_accessor :job_id # The url that can be used to retrieve the job status sig { returns(String) } - def job_url - end - - sig { params(_: String).returns(String) } - def job_url=(_) - end + attr_accessor :job_url # The number of remaining refreshes available (per hour, fixed window) sig { returns(Integer) } - def remaining_refreshes - end - - sig { params(_: Integer).returns(Integer) } - def remaining_refreshes=(_) - end + attr_accessor :remaining_refreshes sig do params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer) diff --git a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi index 0cf41f10..644ff55f 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_params.rbi @@ -9,21 +9,17 @@ module FinchAPI # Number of items to return sig { returns(T.nilable(Integer)) } - def limit - end + attr_reader :limit - sig { params(_: Integer).returns(Integer) } - def limit=(_) - end + sig { params(limit: Integer).void } + attr_writer :limit # Index to start from (defaults to 0) sig { returns(T.nilable(Integer)) } - def offset - end + attr_reader :offset - sig { params(_: Integer).returns(Integer) } - def offset=(_) - end + sig { params(offset: Integer).void } + attr_writer :offset sig do params( diff --git a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi index c49abd16..eb420941 100644 --- a/rbi/lib/finch-api/models/jobs/automated_list_response.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_list_response.rbi @@ -5,26 +5,13 @@ module FinchAPI module Jobs class AutomatedListResponse < FinchAPI::BaseModel sig { returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) } - def data - end - - sig do - params(_: T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) - .returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob]) - end - def data=(_) - end + attr_accessor :data sig { returns(FinchAPI::Models::Jobs::AutomatedListResponse::Meta) } - def meta - end + attr_reader :meta - sig do - params(_: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Util::AnyHash)) - end - def meta=(_) - end + sig { params(meta: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta, FinchAPI::Util::AnyHash)).void } + attr_writer :meta sig do params( @@ -54,15 +41,15 @@ module FinchAPI # (`POST /jobs/automated`). Please contact a Finch representative for more # details. sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas)) } - def quotas - end + attr_reader :quotas sig do - params(_: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Util::AnyHash)) - end - def quotas=(_) + params( + quotas: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas, FinchAPI::Util::AnyHash) + ) + .void end + attr_writer :quotas sig do params( @@ -79,19 +66,15 @@ module FinchAPI class Quotas < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll)) } - def data_sync_all - end + attr_reader :data_sync_all sig do params( - _: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, FinchAPI::Util::AnyHash) + data_sync_all: T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, FinchAPI::Util::AnyHash) ) - .returns( - T.any(FinchAPI::Models::Jobs::AutomatedListResponse::Meta::Quotas::DataSyncAll, FinchAPI::Util::AnyHash) - ) - end - def data_sync_all=(_) + .void end + attr_writer :data_sync_all # Information about remaining quotas for this connection. Only applicable for # customers opted in to use Finch's Data Sync Refresh endpoint @@ -114,20 +97,16 @@ module FinchAPI class DataSyncAll < FinchAPI::BaseModel sig { returns(T.nilable(Integer)) } - def allowed_refreshes - end + attr_reader :allowed_refreshes - sig { params(_: Integer).returns(Integer) } - def allowed_refreshes=(_) - end + sig { params(allowed_refreshes: Integer).void } + attr_writer :allowed_refreshes sig { returns(T.nilable(Integer)) } - def remaining_refreshes - end + attr_reader :remaining_refreshes - sig { params(_: Integer).returns(Integer) } - def remaining_refreshes=(_) - end + sig { params(remaining_refreshes: Integer).void } + attr_writer :remaining_refreshes sig do params(allowed_refreshes: Integer, remaining_refreshes: Integer).returns(T.attached_class) diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index 1e4706f3..95675245 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -6,31 +6,13 @@ module FinchAPI class ManualAsyncJob < FinchAPI::BaseModel # Specific information about the job, such as individual statuses for batch jobs. sig { returns(T.nilable(T::Array[T.anything])) } - def body - end - - sig { params(_: T.nilable(T::Array[T.anything])).returns(T.nilable(T::Array[T.anything])) } - def body=(_) - end + attr_accessor :body sig { returns(String) } - def job_id - end - - sig { params(_: String).returns(String) } - def job_id=(_) - end + attr_accessor :job_id sig { returns(FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) } - def status - end - - sig do - params(_: FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) - .returns(FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) - end - def status=(_) - end + attr_accessor :status sig do params( diff --git a/rbi/lib/finch-api/models/location.rbi b/rbi/lib/finch-api/models/location.rbi index 363fa7cb..0c7df5cc 100644 --- a/rbi/lib/finch-api/models/location.rbi +++ b/rbi/lib/finch-api/models/location.rbi @@ -5,73 +5,33 @@ module FinchAPI class Location < FinchAPI::BaseModel # City, district, suburb, town, or village. sig { returns(T.nilable(String)) } - def city - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def city=(_) - end + attr_accessor :city # The 2-letter ISO 3166 country code. sig { returns(T.nilable(String)) } - def country - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def country=(_) - end + attr_accessor :country # Street address or PO box. sig { returns(T.nilable(String)) } - def line1 - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def line1=(_) - end + attr_accessor :line1 # Apartment, suite, unit, or building. sig { returns(T.nilable(String)) } - def line2 - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def line2=(_) - end + attr_accessor :line2 sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The postal code or zip code. sig { returns(T.nilable(String)) } - def postal_code - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def postal_code=(_) - end + attr_accessor :postal_code sig { returns(T.nilable(String)) } - def source_id - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def source_id=(_) - end + attr_accessor :source_id # The state code. sig { returns(T.nilable(String)) } - def state - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def state=(_) - end + attr_accessor :state sig do params( diff --git a/rbi/lib/finch-api/models/money.rbi b/rbi/lib/finch-api/models/money.rbi index 5309e3f2..c95b3321 100644 --- a/rbi/lib/finch-api/models/money.rbi +++ b/rbi/lib/finch-api/models/money.rbi @@ -5,20 +5,13 @@ module FinchAPI class Money < FinchAPI::BaseModel # Amount for money object (in cents) sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig { returns(T.nilable(String)) } - def currency - end + attr_reader :currency - sig { params(_: String).returns(String) } - def currency=(_) - end + sig { params(currency: String).void } + attr_writer :currency sig { params(amount: T.nilable(Integer), currency: String).returns(T.attached_class) } def self.new(amount: nil, currency: nil) diff --git a/rbi/lib/finch-api/models/operation_support_matrix.rbi b/rbi/lib/finch-api/models/operation_support_matrix.rbi index d8cc7ed3..193dff70 100644 --- a/rbi/lib/finch-api/models/operation_support_matrix.rbi +++ b/rbi/lib/finch-api/models/operation_support_matrix.rbi @@ -11,15 +11,10 @@ module FinchAPI # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } - def create - end + attr_reader :create - sig do - params(_: FinchAPI::Models::OperationSupport::OrSymbol) - .returns(FinchAPI::Models::OperationSupport::OrSymbol) - end - def create=(_) - end + sig { params(create: FinchAPI::Models::OperationSupport::OrSymbol).void } + attr_writer :create # - `supported`: This operation is supported by both the provider and Finch # - `not_supported_by_finch`: This operation is not supported by Finch but @@ -29,15 +24,10 @@ module FinchAPI # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } - def delete - end + attr_reader :delete - sig do - params(_: FinchAPI::Models::OperationSupport::OrSymbol) - .returns(FinchAPI::Models::OperationSupport::OrSymbol) - end - def delete=(_) - end + sig { params(delete: FinchAPI::Models::OperationSupport::OrSymbol).void } + attr_writer :delete # - `supported`: This operation is supported by both the provider and Finch # - `not_supported_by_finch`: This operation is not supported by Finch but @@ -47,15 +37,10 @@ module FinchAPI # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } - def read - end + attr_reader :read - sig do - params(_: FinchAPI::Models::OperationSupport::OrSymbol) - .returns(FinchAPI::Models::OperationSupport::OrSymbol) - end - def read=(_) - end + sig { params(read: FinchAPI::Models::OperationSupport::OrSymbol).void } + attr_writer :read # - `supported`: This operation is supported by both the provider and Finch # - `not_supported_by_finch`: This operation is not supported by Finch but @@ -65,15 +50,10 @@ module FinchAPI # - `client_access_only`: This behavior is supported by the provider, but only # available to the client and not to Finch sig { returns(T.nilable(FinchAPI::Models::OperationSupport::TaggedSymbol)) } - def update - end + attr_reader :update - sig do - params(_: FinchAPI::Models::OperationSupport::OrSymbol) - .returns(FinchAPI::Models::OperationSupport::OrSymbol) - end - def update=(_) - end + sig { params(update: FinchAPI::Models::OperationSupport::OrSymbol).void } + attr_writer :update sig do params( diff --git a/rbi/lib/finch-api/models/paging.rbi b/rbi/lib/finch-api/models/paging.rbi index 17f0de0f..4b8b236d 100644 --- a/rbi/lib/finch-api/models/paging.rbi +++ b/rbi/lib/finch-api/models/paging.rbi @@ -5,21 +5,17 @@ module FinchAPI class Paging < FinchAPI::BaseModel # The total number of elements for the entire query (not just the given page) sig { returns(T.nilable(Integer)) } - def count - end + attr_reader :count - sig { params(_: Integer).returns(Integer) } - def count=(_) - end + sig { params(count: Integer).void } + attr_writer :count # The current start index of the returned list of elements sig { returns(T.nilable(Integer)) } - def offset - end + attr_reader :offset - sig { params(_: Integer).returns(Integer) } - def offset=(_) - end + sig { params(offset: Integer).void } + attr_writer :offset sig { params(count: Integer, offset: Integer).returns(T.attached_class) } def self.new(count: nil, offset: nil) diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 9d48c374..32acea05 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -4,26 +4,16 @@ module FinchAPI module Models class PayStatementEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(FinchAPI::Models::PayStatementEvent::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::PayStatementEvent::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::PayStatementEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::PayStatementEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::PayStatementEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( @@ -50,21 +40,17 @@ module FinchAPI class Data < FinchAPI::BaseModel # The ID of the individual associated with the pay statement. sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id # The ID of the payment associated with the pay statement. sig { returns(T.nilable(String)) } - def payment_id - end + attr_reader :payment_id - sig { params(_: String).returns(String) } - def payment_id=(_) - end + sig { params(payment_id: String).void } + attr_writer :payment_id sig { params(individual_id: String, payment_id: String).returns(T.attached_class) } def self.new(individual_id: nil, payment_id: nil) diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index f93fcd0d..583aa3c6 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -4,26 +4,16 @@ module FinchAPI module Models class PaymentEvent < FinchAPI::Models::BaseWebhookEvent sig { returns(T.nilable(FinchAPI::Models::PaymentEvent::Data)) } - def data - end + attr_reader :data - sig do - params(_: T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Util::AnyHash)) - end - def data=(_) - end + sig { params(data: T.any(FinchAPI::Models::PaymentEvent::Data, FinchAPI::Util::AnyHash)).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol)) } - def event_type - end + attr_reader :event_type - sig do - params(_: FinchAPI::Models::PaymentEvent::EventType::OrSymbol) - .returns(FinchAPI::Models::PaymentEvent::EventType::OrSymbol) - end - def event_type=(_) - end + sig { params(event_type: FinchAPI::Models::PaymentEvent::EventType::OrSymbol).void } + attr_writer :event_type sig do params( @@ -50,21 +40,11 @@ module FinchAPI class Data < FinchAPI::BaseModel # The date of the payment. sig { returns(String) } - def pay_date - end - - sig { params(_: String).returns(String) } - def pay_date=(_) - end + attr_accessor :pay_date # The ID of the payment. sig { returns(String) } - def payment_id - end - - sig { params(_: String).returns(String) } - def payment_id=(_) - end + attr_accessor :payment_id sig { params(pay_date: String, payment_id: String).returns(T.attached_class) } def self.new(pay_date:, payment_id:) diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi index bd934429..27d545d3 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_params.rbi @@ -8,20 +8,16 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig { returns(T.nilable(T::Array[String])) } - def pay_frequencies - end + attr_reader :pay_frequencies - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def pay_frequencies=(_) - end + sig { params(pay_frequencies: T::Array[String]).void } + attr_writer :pay_frequencies sig do params( diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index 856aad57..46de2961 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -6,33 +6,27 @@ module FinchAPI class PayGroupListResponse < FinchAPI::BaseModel # Finch id (uuidv4) for the pay group sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # Name of the pay group sig { returns(T.nilable(String)) } - def name - end + attr_reader :name - sig { params(_: String).returns(String) } - def name=(_) - end + sig { params(name: String).void } + attr_writer :name # List of pay frequencies associated with this pay group sig { returns(T.nilable(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol])) } - def pay_frequencies - end + attr_reader :pay_frequencies sig do - params(_: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol]) - .returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol]) - end - def pay_frequencies=(_) + params(pay_frequencies: T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::OrSymbol]) + .void end + attr_writer :pay_frequencies sig do params( diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index 0f61e831..22573599 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -6,41 +6,18 @@ module FinchAPI class PayGroupRetrieveResponse < FinchAPI::BaseModel # Finch id (uuidv4) for the pay group sig { returns(String) } - def id - end - - sig { params(_: String).returns(String) } - def id=(_) - end + attr_accessor :id sig { returns(T::Array[String]) } - def individual_ids - end - - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def individual_ids=(_) - end + attr_accessor :individual_ids # Name of the pay group sig { returns(String) } - def name - end - - sig { params(_: String).returns(String) } - def name=(_) - end + attr_accessor :name # List of pay frequencies associated with this pay group sig { returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) } - def pay_frequencies - end - - sig do - params(_: T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) - .returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) - end - def pay_frequencies=(_) - end + attr_accessor :pay_frequencies sig do params( diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 91227e28..89da6bce 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -5,98 +5,80 @@ module FinchAPI class Provider < FinchAPI::BaseModel # The id of the payroll provider used in Connect. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The list of authentication methods supported by the provider. sig { returns(T.nilable(T::Array[FinchAPI::Models::Provider::AuthenticationMethod])) } - def authentication_methods - end + attr_reader :authentication_methods sig do - params(_: T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Util::AnyHash)]) - .returns(T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Util::AnyHash)]) - end - def authentication_methods=(_) + params( + authentication_methods: T::Array[T.any(FinchAPI::Models::Provider::AuthenticationMethod, FinchAPI::Util::AnyHash)] + ) + .void end + attr_writer :authentication_methods # `true` if the integration is in a beta state, `false` otherwise sig { returns(T.nilable(T::Boolean)) } - def beta - end + attr_reader :beta - sig { params(_: T::Boolean).returns(T::Boolean) } - def beta=(_) - end + sig { params(beta: T::Boolean).void } + attr_writer :beta # The display name of the payroll provider. sig { returns(T.nilable(String)) } - def display_name - end + attr_reader :display_name - sig { params(_: String).returns(String) } - def display_name=(_) - end + sig { params(display_name: String).void } + attr_writer :display_name # The url to the official icon of the payroll provider. sig { returns(T.nilable(String)) } - def icon - end + attr_reader :icon - sig { params(_: String).returns(String) } - def icon=(_) - end + sig { params(icon: String).void } + attr_writer :icon # The url to the official logo of the payroll provider. sig { returns(T.nilable(String)) } - def logo - end + attr_reader :logo - sig { params(_: String).returns(String) } - def logo=(_) - end + sig { params(logo: String).void } + attr_writer :logo # [DEPRECATED] Whether the Finch integration with this provider uses the Assisted # Connect Flow by default. This field is now deprecated. Please check for a `type` # of `assisted` in the `authentication_methods` field instead. sig { returns(T.nilable(T::Boolean)) } - def manual - end + attr_reader :manual - sig { params(_: T::Boolean).returns(T::Boolean) } - def manual=(_) - end + sig { params(manual: T::Boolean).void } + attr_writer :manual # whether MFA is required for the provider. sig { returns(T.nilable(T::Boolean)) } - def mfa_required - end + attr_reader :mfa_required - sig { params(_: T::Boolean).returns(T::Boolean) } - def mfa_required=(_) - end + sig { params(mfa_required: T::Boolean).void } + attr_writer :mfa_required # The hex code for the primary color of the payroll provider. sig { returns(T.nilable(String)) } - def primary_color - end + attr_reader :primary_color - sig { params(_: String).returns(String) } - def primary_color=(_) - end + sig { params(primary_color: String).void } + attr_writer :primary_color # The list of Finch products supported on this payroll provider. sig { returns(T.nilable(T::Array[String])) } - def products - end + attr_reader :products - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + sig { params(products: T::Array[String]).void } + attr_writer :products sig do params( @@ -151,47 +133,36 @@ module FinchAPI # Each benefit type and their supported features. If the benefit type is not # supported, the property will be null sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitsSupport)) } - def benefits_support - end + attr_reader :benefits_support sig do - params(_: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash))) - end - def benefits_support=(_) + params( + benefits_support: T.nilable(T.any(FinchAPI::Models::HRIS::BenefitsSupport, FinchAPI::Util::AnyHash)) + ) + .void end + attr_writer :benefits_support # The supported data fields returned by our HR and payroll endpoints sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields)) } - def supported_fields - end + attr_reader :supported_fields sig do params( - _: T.nilable( + supported_fields: T.nilable( T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Util::AnyHash) ) ) - .returns( - T.nilable( - T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields, FinchAPI::Util::AnyHash) - ) - ) - end - def supported_fields=(_) + .void end + attr_writer :supported_fields # The type of authentication method. sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol)) } - def type - end + attr_reader :type - sig do - params(_: FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol) - .returns(FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol) - end - def type=(_) - end + sig { params(type: FinchAPI::Models::Provider::AuthenticationMethod::Type::OrSymbol).void } + attr_writer :type sig do params( @@ -221,139 +192,96 @@ module FinchAPI class SupportedFields < FinchAPI::BaseModel sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company)) } - def company - end + attr_reader :company sig do params( - _: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, FinchAPI::Util::AnyHash) + company: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, FinchAPI::Util::AnyHash) ) - .returns( - T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company, FinchAPI::Util::AnyHash) - ) - end - def company=(_) + .void end + attr_writer :company sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory)) } - def directory - end + attr_reader :directory sig do params( - _: T.any( + directory: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory, - FinchAPI::Util::AnyHash - ) - ) - end - def directory=(_) + .void end + attr_writer :directory sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment)) } - def employment - end + attr_reader :employment sig do params( - _: T.any( + employment: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment, - FinchAPI::Util::AnyHash - ) - ) - end - def employment=(_) + .void end + attr_writer :employment sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual)) } - def individual - end + attr_reader :individual sig do params( - _: T.any( + individual: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual, - FinchAPI::Util::AnyHash - ) - ) - end - def individual=(_) + .void end + attr_writer :individual sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup)) } - def pay_group - end + attr_reader :pay_group sig do params( - _: T.any( + pay_group: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayGroup, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_group=(_) + .void end + attr_writer :pay_group sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement)) } - def pay_statement - end + attr_reader :pay_statement sig do params( - _: T.any( + pay_statement: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_statement=(_) + .void end + attr_writer :pay_statement sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment)) } - def payment - end + attr_reader :payment sig do params( - _: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, FinchAPI::Util::AnyHash) + payment: T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, FinchAPI::Util::AnyHash) ) - .returns( - T.any(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment, FinchAPI::Util::AnyHash) - ) - end - def payment=(_) + .void end + attr_writer :payment # The supported data fields returned by our HR and payroll endpoints sig do @@ -413,132 +341,94 @@ module FinchAPI class Company < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts)) } - def accounts - end + attr_reader :accounts sig do params( - _: T.any( + accounts: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Accounts, - FinchAPI::Util::AnyHash - ) - ) - end - def accounts=(_) + .void end + attr_writer :accounts sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments) ) end - def departments - end + attr_reader :departments sig do params( - _: T.any( + departments: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments, - FinchAPI::Util::AnyHash - ) - ) - end - def departments=(_) + .void end + attr_writer :departments sig { returns(T.nilable(T::Boolean)) } - def ein - end + attr_reader :ein - sig { params(_: T::Boolean).returns(T::Boolean) } - def ein=(_) - end + sig { params(ein: T::Boolean).void } + attr_writer :ein sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity)) } - def entity - end + attr_reader :entity sig do params( - _: T.any( + entity: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Entity, - FinchAPI::Util::AnyHash - ) - ) - end - def entity=(_) + .void end + attr_writer :entity sig { returns(T.nilable(T::Boolean)) } - def legal_name - end + attr_reader :legal_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def legal_name=(_) - end + sig { params(legal_name: T::Boolean).void } + attr_writer :legal_name sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations)) } - def locations - end + attr_reader :locations sig do params( - _: T.any( + locations: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Locations, - FinchAPI::Util::AnyHash - ) - ) - end - def locations=(_) + .void end + attr_writer :locations sig { returns(T.nilable(T::Boolean)) } - def primary_email - end + attr_reader :primary_email - sig { params(_: T::Boolean).returns(T::Boolean) } - def primary_email=(_) - end + sig { params(primary_email: T::Boolean).void } + attr_writer :primary_email sig { returns(T.nilable(T::Boolean)) } - def primary_phone_number - end + attr_reader :primary_phone_number - sig { params(_: T::Boolean).returns(T::Boolean) } - def primary_phone_number=(_) - end + sig { params(primary_phone_number: T::Boolean).void } + attr_writer :primary_phone_number sig do params( @@ -600,44 +490,34 @@ module FinchAPI class Accounts < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def account_name - end + attr_reader :account_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def account_name=(_) - end + sig { params(account_name: T::Boolean).void } + attr_writer :account_name sig { returns(T.nilable(T::Boolean)) } - def account_number - end + attr_reader :account_number - sig { params(_: T::Boolean).returns(T::Boolean) } - def account_number=(_) - end + sig { params(account_number: T::Boolean).void } + attr_writer :account_number sig { returns(T.nilable(T::Boolean)) } - def account_type - end + attr_reader :account_type - sig { params(_: T::Boolean).returns(T::Boolean) } - def account_type=(_) - end + sig { params(account_type: T::Boolean).void } + attr_writer :account_type sig { returns(T.nilable(T::Boolean)) } - def institution_name - end + attr_reader :institution_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def institution_name=(_) - end + sig { params(institution_name: T::Boolean).void } + attr_writer :institution_name sig { returns(T.nilable(T::Boolean)) } - def routing_number - end + attr_reader :routing_number - sig { params(_: T::Boolean).returns(T::Boolean) } - def routing_number=(_) - end + sig { params(routing_number: T::Boolean).void } + attr_writer :routing_number sig do params( @@ -670,37 +550,28 @@ module FinchAPI class Departments < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent) ) end - def parent - end + attr_reader :parent sig do params( - _: T.any( + parent: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Company::Departments::Parent, - FinchAPI::Util::AnyHash - ) - ) - end - def parent=(_) + .void end + attr_writer :parent sig do params( @@ -729,12 +600,10 @@ module FinchAPI class Parent < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } def self.new(name: nil) @@ -748,20 +617,16 @@ module FinchAPI class Entity < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def subtype - end + attr_reader :subtype - sig { params(_: T::Boolean).returns(T::Boolean) } - def subtype=(_) - end + sig { params(subtype: T::Boolean).void } + attr_writer :subtype sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(subtype: nil, type: nil) @@ -774,52 +639,40 @@ module FinchAPI class Locations < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def city - end + attr_reader :city - sig { params(_: T::Boolean).returns(T::Boolean) } - def city=(_) - end + sig { params(city: T::Boolean).void } + attr_writer :city sig { returns(T.nilable(T::Boolean)) } - def country - end + attr_reader :country - sig { params(_: T::Boolean).returns(T::Boolean) } - def country=(_) - end + sig { params(country: T::Boolean).void } + attr_writer :country sig { returns(T.nilable(T::Boolean)) } - def line1 - end + attr_reader :line1 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line1=(_) - end + sig { params(line1: T::Boolean).void } + attr_writer :line1 sig { returns(T.nilable(T::Boolean)) } - def line2 - end + attr_reader :line2 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line2=(_) - end + sig { params(line2: T::Boolean).void } + attr_writer :line2 sig { returns(T.nilable(T::Boolean)) } - def postal_code - end + attr_reader :postal_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def postal_code=(_) - end + sig { params(postal_code: T::Boolean).void } + attr_writer :postal_code sig { returns(T.nilable(T::Boolean)) } - def state - end + attr_reader :state - sig { params(_: T::Boolean).returns(T::Boolean) } - def state=(_) - end + sig { params(state: T::Boolean).void } + attr_writer :state sig do params( @@ -859,46 +712,32 @@ module FinchAPI T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals) ) end - def individuals - end + attr_reader :individuals sig do params( - _: T.any( + individuals: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals, - FinchAPI::Util::AnyHash - ) - ) - end - def individuals=(_) + .void end + attr_writer :individuals sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging)) } - def paging - end + attr_reader :paging sig do params( - _: T.any( + paging: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Paging, - FinchAPI::Util::AnyHash - ) - ) - end - def paging=(_) + .void end + attr_writer :paging sig do params( @@ -930,44 +769,34 @@ module FinchAPI class Individuals < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def department - end + attr_reader :department - sig { params(_: T::Boolean).returns(T::Boolean) } - def department=(_) - end + sig { params(department: T::Boolean).void } + attr_writer :department sig { returns(T.nilable(T::Boolean)) } - def first_name - end + attr_reader :first_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def first_name=(_) - end + sig { params(first_name: T::Boolean).void } + attr_writer :first_name sig { returns(T.nilable(T::Boolean)) } - def is_active - end + attr_reader :is_active - sig { params(_: T::Boolean).returns(T::Boolean) } - def is_active=(_) - end + sig { params(is_active: T::Boolean).void } + attr_writer :is_active sig { returns(T.nilable(T::Boolean)) } - def last_name - end + attr_reader :last_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def last_name=(_) - end + sig { params(last_name: T::Boolean).void } + attr_writer :last_name sig do returns( @@ -976,33 +805,24 @@ module FinchAPI ) ) end - def manager - end + attr_reader :manager sig do params( - _: T.any( + manager: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Directory::Individuals::Manager, - FinchAPI::Util::AnyHash - ) - ) - end - def manager=(_) + .void end + attr_writer :manager sig { returns(T.nilable(T::Boolean)) } - def middle_name - end + attr_reader :middle_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def middle_name=(_) - end + sig { params(middle_name: T::Boolean).void } + attr_writer :middle_name sig do params( @@ -1041,12 +861,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } def self.new(id: nil) @@ -1060,20 +878,16 @@ module FinchAPI class Paging < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def count - end + attr_reader :count - sig { params(_: T::Boolean).returns(T::Boolean) } - def count=(_) - end + sig { params(count: T::Boolean).void } + attr_writer :count sig { returns(T.nilable(T::Boolean)) } - def offset - end + attr_reader :offset - sig { params(_: T::Boolean).returns(T::Boolean) } - def offset=(_) - end + sig { params(offset: T::Boolean).void } + attr_writer :offset sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } def self.new(count: nil, offset: nil) @@ -1087,217 +901,158 @@ module FinchAPI class Employment < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def class_code - end + attr_reader :class_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def class_code=(_) - end + sig { params(class_code: T::Boolean).void } + attr_writer :class_code sig { returns(T.nilable(T::Boolean)) } - def custom_fields - end + attr_reader :custom_fields - sig { params(_: T::Boolean).returns(T::Boolean) } - def custom_fields=(_) - end + sig { params(custom_fields: T::Boolean).void } + attr_writer :custom_fields sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department) ) end - def department - end + attr_reader :department sig do params( - _: T.any( + department: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Department, - FinchAPI::Util::AnyHash - ) - ) - end - def department=(_) + .void end + attr_writer :department sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment) ) end - def employment - end + attr_reader :employment sig do params( - _: T.any( + employment: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Employment, - FinchAPI::Util::AnyHash - ) - ) - end - def employment=(_) + .void end + attr_writer :employment sig { returns(T.nilable(T::Boolean)) } - def employment_status - end + attr_reader :employment_status - sig { params(_: T::Boolean).returns(T::Boolean) } - def employment_status=(_) - end + sig { params(employment_status: T::Boolean).void } + attr_writer :employment_status sig { returns(T.nilable(T::Boolean)) } - def end_date - end + attr_reader :end_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def end_date=(_) - end + sig { params(end_date: T::Boolean).void } + attr_writer :end_date sig { returns(T.nilable(T::Boolean)) } - def first_name - end + attr_reader :first_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def first_name=(_) - end + sig { params(first_name: T::Boolean).void } + attr_writer :first_name sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income)) } - def income - end + attr_reader :income sig do params( - _: T.any( + income: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Income, - FinchAPI::Util::AnyHash - ) - ) - end - def income=(_) + .void end + attr_writer :income sig { returns(T.nilable(T::Boolean)) } - def income_history - end + attr_reader :income_history - sig { params(_: T::Boolean).returns(T::Boolean) } - def income_history=(_) - end + sig { params(income_history: T::Boolean).void } + attr_writer :income_history sig { returns(T.nilable(T::Boolean)) } - def is_active - end + attr_reader :is_active - sig { params(_: T::Boolean).returns(T::Boolean) } - def is_active=(_) - end + sig { params(is_active: T::Boolean).void } + attr_writer :is_active sig { returns(T.nilable(T::Boolean)) } - def last_name - end + attr_reader :last_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def last_name=(_) - end + sig { params(last_name: T::Boolean).void } + attr_writer :last_name sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location) ) end - def location - end + attr_reader :location sig do params( - _: T.any( + location: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Location, - FinchAPI::Util::AnyHash - ) - ) - end - def location=(_) + .void end + attr_writer :location sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager)) } - def manager - end + attr_reader :manager sig do params( - _: T.any( + manager: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Employment::Manager, - FinchAPI::Util::AnyHash - ) - ) - end - def manager=(_) + .void end + attr_writer :manager sig { returns(T.nilable(T::Boolean)) } - def middle_name - end + attr_reader :middle_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def middle_name=(_) - end + sig { params(middle_name: T::Boolean).void } + attr_writer :middle_name sig { returns(T.nilable(T::Boolean)) } - def start_date - end + attr_reader :start_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def start_date=(_) - end + sig { params(start_date: T::Boolean).void } + attr_writer :start_date sig { returns(T.nilable(T::Boolean)) } - def title - end + attr_reader :title - sig { params(_: T::Boolean).returns(T::Boolean) } - def title=(_) - end + sig { params(title: T::Boolean).void } + attr_writer :title sig do params( @@ -1386,12 +1141,10 @@ module FinchAPI class Department < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { params(name: T::Boolean).returns(T.attached_class) } def self.new(name: nil) @@ -1404,20 +1157,16 @@ module FinchAPI class Employment < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def subtype - end + attr_reader :subtype - sig { params(_: T::Boolean).returns(T::Boolean) } - def subtype=(_) - end + sig { params(subtype: T::Boolean).void } + attr_writer :subtype sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(subtype: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(subtype: nil, type: nil) @@ -1430,28 +1179,22 @@ module FinchAPI class Income < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def unit - end + attr_reader :unit - sig { params(_: T::Boolean).returns(T::Boolean) } - def unit=(_) - end + sig { params(unit: T::Boolean).void } + attr_writer :unit sig do params(amount: T::Boolean, currency: T::Boolean, unit: T::Boolean).returns(T.attached_class) @@ -1466,52 +1209,40 @@ module FinchAPI class Location < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def city - end + attr_reader :city - sig { params(_: T::Boolean).returns(T::Boolean) } - def city=(_) - end + sig { params(city: T::Boolean).void } + attr_writer :city sig { returns(T.nilable(T::Boolean)) } - def country - end + attr_reader :country - sig { params(_: T::Boolean).returns(T::Boolean) } - def country=(_) - end + sig { params(country: T::Boolean).void } + attr_writer :country sig { returns(T.nilable(T::Boolean)) } - def line1 - end + attr_reader :line1 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line1=(_) - end + sig { params(line1: T::Boolean).void } + attr_writer :line1 sig { returns(T.nilable(T::Boolean)) } - def line2 - end + attr_reader :line2 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line2=(_) - end + sig { params(line2: T::Boolean).void } + attr_writer :line2 sig { returns(T.nilable(T::Boolean)) } - def postal_code - end + attr_reader :postal_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def postal_code=(_) - end + sig { params(postal_code: T::Boolean).void } + attr_writer :postal_code sig { returns(T.nilable(T::Boolean)) } - def state - end + attr_reader :state - sig { params(_: T::Boolean).returns(T::Boolean) } - def state=(_) - end + sig { params(state: T::Boolean).void } + attr_writer :state sig do params( @@ -1546,12 +1277,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { params(id: T::Boolean).returns(T.attached_class) } def self.new(id: nil) @@ -1565,155 +1294,114 @@ module FinchAPI class Individual < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def dob - end + attr_reader :dob - sig { params(_: T::Boolean).returns(T::Boolean) } - def dob=(_) - end + sig { params(dob: T::Boolean).void } + attr_writer :dob sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails)) } - def emails - end + attr_reader :emails sig do params( - _: T.any( + emails: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Emails, - FinchAPI::Util::AnyHash - ) - ) - end - def emails=(_) + .void end + attr_writer :emails sig { returns(T.nilable(T::Boolean)) } - def encrypted_ssn - end + attr_reader :encrypted_ssn - sig { params(_: T::Boolean).returns(T::Boolean) } - def encrypted_ssn=(_) - end + sig { params(encrypted_ssn: T::Boolean).void } + attr_writer :encrypted_ssn sig { returns(T.nilable(T::Boolean)) } - def ethnicity - end + attr_reader :ethnicity - sig { params(_: T::Boolean).returns(T::Boolean) } - def ethnicity=(_) - end + sig { params(ethnicity: T::Boolean).void } + attr_writer :ethnicity sig { returns(T.nilable(T::Boolean)) } - def first_name - end + attr_reader :first_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def first_name=(_) - end + sig { params(first_name: T::Boolean).void } + attr_writer :first_name sig { returns(T.nilable(T::Boolean)) } - def gender - end + attr_reader :gender - sig { params(_: T::Boolean).returns(T::Boolean) } - def gender=(_) - end + sig { params(gender: T::Boolean).void } + attr_writer :gender sig { returns(T.nilable(T::Boolean)) } - def last_name - end + attr_reader :last_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def last_name=(_) - end + sig { params(last_name: T::Boolean).void } + attr_writer :last_name sig { returns(T.nilable(T::Boolean)) } - def middle_name - end + attr_reader :middle_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def middle_name=(_) - end + sig { params(middle_name: T::Boolean).void } + attr_writer :middle_name sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers) ) end - def phone_numbers - end + attr_reader :phone_numbers sig do params( - _: T.any( + phone_numbers: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::PhoneNumbers, - FinchAPI::Util::AnyHash - ) - ) - end - def phone_numbers=(_) + .void end + attr_writer :phone_numbers sig { returns(T.nilable(T::Boolean)) } - def preferred_name - end + attr_reader :preferred_name - sig { params(_: T::Boolean).returns(T::Boolean) } - def preferred_name=(_) - end + sig { params(preferred_name: T::Boolean).void } + attr_writer :preferred_name sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence) ) end - def residence - end + attr_reader :residence sig do params( - _: T.any( + residence: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Individual::Residence, - FinchAPI::Util::AnyHash - ) - ) - end - def residence=(_) + .void end + attr_writer :residence sig { returns(T.nilable(T::Boolean)) } - def ssn - end + attr_reader :ssn - sig { params(_: T::Boolean).returns(T::Boolean) } - def ssn=(_) - end + sig { params(ssn: T::Boolean).void } + attr_writer :ssn sig do params( @@ -1784,20 +1472,16 @@ module FinchAPI class Emails < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def data - end + attr_reader :data - sig { params(_: T::Boolean).returns(T::Boolean) } - def data=(_) - end + sig { params(data: T::Boolean).void } + attr_writer :data sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(data: nil, type: nil) @@ -1810,20 +1494,16 @@ module FinchAPI class PhoneNumbers < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def data - end + attr_reader :data - sig { params(_: T::Boolean).returns(T::Boolean) } - def data=(_) - end + sig { params(data: T::Boolean).void } + attr_writer :data sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig { params(data: T::Boolean, type: T::Boolean).returns(T.attached_class) } def self.new(data: nil, type: nil) @@ -1836,52 +1516,40 @@ module FinchAPI class Residence < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def city - end + attr_reader :city - sig { params(_: T::Boolean).returns(T::Boolean) } - def city=(_) - end + sig { params(city: T::Boolean).void } + attr_writer :city sig { returns(T.nilable(T::Boolean)) } - def country - end + attr_reader :country - sig { params(_: T::Boolean).returns(T::Boolean) } - def country=(_) - end + sig { params(country: T::Boolean).void } + attr_writer :country sig { returns(T.nilable(T::Boolean)) } - def line1 - end + attr_reader :line1 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line1=(_) - end + sig { params(line1: T::Boolean).void } + attr_writer :line1 sig { returns(T.nilable(T::Boolean)) } - def line2 - end + attr_reader :line2 - sig { params(_: T::Boolean).returns(T::Boolean) } - def line2=(_) - end + sig { params(line2: T::Boolean).void } + attr_writer :line2 sig { returns(T.nilable(T::Boolean)) } - def postal_code - end + attr_reader :postal_code - sig { params(_: T::Boolean).returns(T::Boolean) } - def postal_code=(_) - end + sig { params(postal_code: T::Boolean).void } + attr_writer :postal_code sig { returns(T.nilable(T::Boolean)) } - def state - end + attr_reader :state - sig { params(_: T::Boolean).returns(T::Boolean) } - def state=(_) - end + sig { params(state: T::Boolean).void } + attr_writer :state sig do params( @@ -1917,36 +1585,28 @@ module FinchAPI class PayGroup < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def individual_ids - end + attr_reader :individual_ids - sig { params(_: T::Boolean).returns(T::Boolean) } - def individual_ids=(_) - end + sig { params(individual_ids: T::Boolean).void } + attr_writer :individual_ids sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def pay_frequencies - end + attr_reader :pay_frequencies - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_frequencies=(_) - end + sig { params(pay_frequencies: T::Boolean).void } + attr_writer :pay_frequencies sig do params( @@ -1979,50 +1639,36 @@ module FinchAPI T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging) ) end - def paging - end + attr_reader :paging sig do params( - _: T.any( + paging: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::Paging, - FinchAPI::Util::AnyHash - ) - ) - end - def paging=(_) + .void end + attr_writer :paging sig do returns( T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements) ) end - def pay_statements - end + attr_reader :pay_statements sig do params( - _: T.any( + pay_statements: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_statements=(_) + .void end + attr_writer :pay_statements sig do params( @@ -2054,20 +1700,10 @@ module FinchAPI class Paging < FinchAPI::BaseModel sig { returns(T::Boolean) } - def count - end - - sig { params(_: T::Boolean).returns(T::Boolean) } - def count=(_) - end + attr_accessor :count sig { returns(T::Boolean) } - def offset - end - - sig { params(_: T::Boolean).returns(T::Boolean) } - def offset=(_) - end + attr_accessor :offset sig { params(count: T::Boolean, offset: T::Boolean).returns(T.attached_class) } def self.new(count:, offset:) @@ -2086,25 +1722,18 @@ module FinchAPI ) ) end - def earnings - end + attr_reader :earnings sig do params( - _: T.any( + earnings: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Earnings, - FinchAPI::Util::AnyHash - ) - ) - end - def earnings=(_) + .void end + attr_writer :earnings sig do returns( @@ -2113,25 +1742,18 @@ module FinchAPI ) ) end - def employee_deductions - end + attr_reader :employee_deductions sig do params( - _: T.any( + employee_deductions: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployeeDeductions, - FinchAPI::Util::AnyHash - ) - ) - end - def employee_deductions=(_) + .void end + attr_writer :employee_deductions sig do returns( @@ -2140,57 +1762,42 @@ module FinchAPI ) ) end - def employer_contributions - end + attr_reader :employer_contributions sig do params( - _: T.any( + employer_contributions: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::EmployerContributions, - FinchAPI::Util::AnyHash - ) - ) - end - def employer_contributions=(_) + .void end + attr_writer :employer_contributions sig { returns(T.nilable(T::Boolean)) } - def gross_pay - end + attr_reader :gross_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def gross_pay=(_) - end + sig { params(gross_pay: T::Boolean).void } + attr_writer :gross_pay sig { returns(T.nilable(T::Boolean)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: T::Boolean).returns(T::Boolean) } - def individual_id=(_) - end + sig { params(individual_id: T::Boolean).void } + attr_writer :individual_id sig { returns(T.nilable(T::Boolean)) } - def net_pay - end + attr_reader :net_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def net_pay=(_) - end + sig { params(net_pay: T::Boolean).void } + attr_writer :net_pay sig { returns(T.nilable(T::Boolean)) } - def payment_method - end + attr_reader :payment_method - sig { params(_: T::Boolean).returns(T::Boolean) } - def payment_method=(_) - end + sig { params(payment_method: T::Boolean).void } + attr_writer :payment_method sig do returns( @@ -2199,41 +1806,30 @@ module FinchAPI ) ) end - def taxes - end + attr_reader :taxes sig do params( - _: T.any( + taxes: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::PayStatement::PayStatements::Taxes, - FinchAPI::Util::AnyHash - ) - ) - end - def taxes=(_) + .void end + attr_writer :taxes sig { returns(T.nilable(T::Boolean)) } - def total_hours - end + attr_reader :total_hours - sig { params(_: T::Boolean).returns(T::Boolean) } - def total_hours=(_) - end + sig { params(total_hours: T::Boolean).void } + attr_writer :total_hours sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params( @@ -2298,36 +1894,28 @@ module FinchAPI class Earnings < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean, type: T::Boolean) @@ -2352,44 +1940,34 @@ module FinchAPI class EmployeeDeductions < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def pre_tax - end + attr_reader :pre_tax - sig { params(_: T::Boolean).returns(T::Boolean) } - def pre_tax=(_) - end + sig { params(pre_tax: T::Boolean).void } + attr_writer :pre_tax sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params( @@ -2422,28 +2000,22 @@ module FinchAPI class EmployerContributions < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig do params(amount: T::Boolean, currency: T::Boolean, name: T::Boolean).returns(T.attached_class) @@ -2458,44 +2030,34 @@ module FinchAPI class Taxes < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def amount - end + attr_reader :amount - sig { params(_: T::Boolean).returns(T::Boolean) } - def amount=(_) - end + sig { params(amount: T::Boolean).void } + attr_writer :amount sig { returns(T.nilable(T::Boolean)) } - def currency - end + attr_reader :currency - sig { params(_: T::Boolean).returns(T::Boolean) } - def currency=(_) - end + sig { params(currency: T::Boolean).void } + attr_writer :currency sig { returns(T.nilable(T::Boolean)) } - def employer - end + attr_reader :employer - sig { params(_: T::Boolean).returns(T::Boolean) } - def employer=(_) - end + sig { params(employer: T::Boolean).void } + attr_writer :employer sig { returns(T.nilable(T::Boolean)) } - def name - end + attr_reader :name - sig { params(_: T::Boolean).returns(T::Boolean) } - def name=(_) - end + sig { params(name: T::Boolean).void } + attr_writer :name sig { returns(T.nilable(T::Boolean)) } - def type - end + attr_reader :type - sig { params(_: T::Boolean).returns(T::Boolean) } - def type=(_) - end + sig { params(type: T::Boolean).void } + attr_writer :type sig do params( @@ -2530,113 +2092,84 @@ module FinchAPI class Payment < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def id - end + attr_reader :id - sig { params(_: T::Boolean).returns(T::Boolean) } - def id=(_) - end + sig { params(id: T::Boolean).void } + attr_writer :id sig { returns(T.nilable(T::Boolean)) } - def company_debit - end + attr_reader :company_debit - sig { params(_: T::Boolean).returns(T::Boolean) } - def company_debit=(_) - end + sig { params(company_debit: T::Boolean).void } + attr_writer :company_debit sig { returns(T.nilable(T::Boolean)) } - def debit_date - end + attr_reader :debit_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def debit_date=(_) - end + sig { params(debit_date: T::Boolean).void } + attr_writer :debit_date sig { returns(T.nilable(T::Boolean)) } - def employee_taxes - end + attr_reader :employee_taxes - sig { params(_: T::Boolean).returns(T::Boolean) } - def employee_taxes=(_) - end + sig { params(employee_taxes: T::Boolean).void } + attr_writer :employee_taxes sig { returns(T.nilable(T::Boolean)) } - def employer_taxes - end + attr_reader :employer_taxes - sig { params(_: T::Boolean).returns(T::Boolean) } - def employer_taxes=(_) - end + sig { params(employer_taxes: T::Boolean).void } + attr_writer :employer_taxes sig { returns(T.nilable(T::Boolean)) } - def gross_pay - end + attr_reader :gross_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def gross_pay=(_) - end + sig { params(gross_pay: T::Boolean).void } + attr_writer :gross_pay sig { returns(T.nilable(T::Boolean)) } - def individual_ids - end + attr_reader :individual_ids - sig { params(_: T::Boolean).returns(T::Boolean) } - def individual_ids=(_) - end + sig { params(individual_ids: T::Boolean).void } + attr_writer :individual_ids sig { returns(T.nilable(T::Boolean)) } - def net_pay - end + attr_reader :net_pay - sig { params(_: T::Boolean).returns(T::Boolean) } - def net_pay=(_) - end + sig { params(net_pay: T::Boolean).void } + attr_writer :net_pay sig { returns(T.nilable(T::Boolean)) } - def pay_date - end + attr_reader :pay_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_date=(_) - end + sig { params(pay_date: T::Boolean).void } + attr_writer :pay_date sig { returns(T.nilable(T::Boolean)) } - def pay_frequencies - end + attr_reader :pay_frequencies - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_frequencies=(_) - end + sig { params(pay_frequencies: T::Boolean).void } + attr_writer :pay_frequencies sig { returns(T.nilable(T::Boolean)) } - def pay_group_ids - end + attr_reader :pay_group_ids - sig { params(_: T::Boolean).returns(T::Boolean) } - def pay_group_ids=(_) - end + sig { params(pay_group_ids: T::Boolean).void } + attr_writer :pay_group_ids sig { returns(T.nilable(FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod)) } - def pay_period - end + attr_reader :pay_period sig do params( - _: T.any( + pay_period: T.any( FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Provider::AuthenticationMethod::SupportedFields::Payment::PayPeriod, - FinchAPI::Util::AnyHash - ) - ) - end - def pay_period=(_) + .void end + attr_writer :pay_period sig do params( @@ -2698,20 +2231,16 @@ module FinchAPI class PayPeriod < FinchAPI::BaseModel sig { returns(T.nilable(T::Boolean)) } - def end_date - end + attr_reader :end_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def end_date=(_) - end + sig { params(end_date: T::Boolean).void } + attr_writer :end_date sig { returns(T.nilable(T::Boolean)) } - def start_date - end + attr_reader :start_date - sig { params(_: T::Boolean).returns(T::Boolean) } - def start_date=(_) - end + sig { params(start_date: T::Boolean).void } + attr_writer :start_date sig { params(end_date: T::Boolean, start_date: T::Boolean).returns(T.attached_class) } def self.new(end_date: nil, start_date: nil) diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi index e0e7523b..b45804fc 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_params.rbi @@ -9,54 +9,29 @@ module FinchAPI # The HTTP method for the forwarded request. Valid values include: `GET` , `POST` # , `PUT` , `DELETE` , and `PATCH`. sig { returns(String) } - def method_ - end - - sig { params(_: String).returns(String) } - def method_=(_) - end + attr_accessor :method_ # The URL route path for the forwarded request. This value must begin with a # forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and # underscores. sig { returns(String) } - def route - end - - sig { params(_: String).returns(String) } - def route=(_) - end + attr_accessor :route # The body for the forwarded request. This value must be specified as either a # string or a valid JSON object. sig { returns(T.nilable(String)) } - def data - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def data=(_) - end + attr_accessor :data # The HTTP headers to include on the forwarded request. This value must be # specified as an object of key-value pairs. Example: # `{"Content-Type": "application/xml", "X-API-Version": "v1" }` sig { returns(T.nilable(T.anything)) } - def headers - end - - sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } - def headers=(_) - end + attr_accessor :headers # The query parameters for the forwarded request. This value must be specified as # a valid JSON object rather than a query string. sig { returns(T.nilable(T.anything)) } - def params - end - - sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } - def params=(_) - end + attr_accessor :params sig do params( diff --git a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi index 5ec8dbf5..75f52e1c 100644 --- a/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi +++ b/rbi/lib/finch-api/models/request_forwarding_forward_response.rbi @@ -7,45 +7,30 @@ module FinchAPI # response received from the underlying integration’s API. This field may be null # in the case where the upstream system’s response is empty. sig { returns(T.nilable(String)) } - def data - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def data=(_) - end + attr_accessor :data # The HTTP headers of the forwarded request’s response, exactly as received from # the underlying integration’s API. sig { returns(T.nilable(T.anything)) } - def headers - end - - sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } - def headers=(_) - end + attr_accessor :headers # An object containing details of your original forwarded request, for your ease # of reference. sig { returns(FinchAPI::Models::RequestForwardingForwardResponse::Request) } - def request - end + attr_reader :request sig do - params(_: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash)) - end - def request=(_) + params( + request: T.any(FinchAPI::Models::RequestForwardingForwardResponse::Request, FinchAPI::Util::AnyHash) + ) + .void end + attr_writer :request # The HTTP status code of the forwarded request’s response, exactly received from # the underlying integration’s API. This value will be returned as an integer. sig { returns(Integer) } - def status_code - end - - sig { params(_: Integer).returns(Integer) } - def status_code=(_) - end + attr_accessor :status_code sig do params( @@ -78,51 +63,26 @@ module FinchAPI # specified in the original request, this value will be returned as null ; # otherwise, this value will always be returned as a string. sig { returns(T.nilable(String)) } - def data - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def data=(_) - end + attr_accessor :data # The specified HTTP headers that were included in the forwarded request. If no # headers were specified, this will be returned as `null`. sig { returns(T.nilable(T.anything)) } - def headers - end - - sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } - def headers=(_) - end + attr_accessor :headers # The HTTP method that was specified for the forwarded request. Valid values # include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`. sig { returns(String) } - def method_ - end - - sig { params(_: String).returns(String) } - def method_=(_) - end + attr_accessor :method_ # The query parameters that were included in the forwarded request. If no query # parameters were specified, this will be returned as `null`. sig { returns(T.nilable(T.anything)) } - def params - end - - sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } - def params=(_) - end + attr_accessor :params # The URL route path that was specified for the forwarded request. sig { returns(String) } - def route - end - - sig { params(_: String).returns(String) } - def route=(_) - end + attr_accessor :route # An object containing details of your original forwarded request, for your ease # of reference. diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index 1650fe74..6cb1f6f2 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -9,88 +9,42 @@ module FinchAPI # An array of bank account objects associated with the payroll/HRIS system. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account])) } - def accounts - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account])) - .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account])) - end - def accounts=(_) - end + attr_accessor :accounts # The array of company departments. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)])) } - def departments - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department)])) - end - def departments=(_) - end + attr_accessor :departments # The employer identification number. sig { returns(T.nilable(String)) } - def ein - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def ein=(_) - end + attr_accessor :ein # The entity type object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity)) } - def entity - end + attr_reader :entity sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash)) + entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash)) ) - .returns(T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, FinchAPI::Util::AnyHash))) - end - def entity=(_) + .void end + attr_writer :entity # The legal name of the company. sig { returns(T.nilable(String)) } - def legal_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def legal_name=(_) - end + attr_accessor :legal_name sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) } - def locations - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) - end - def locations=(_) - end + attr_accessor :locations # The email of the main administrator on the account. sig { returns(T.nilable(String)) } - def primary_email - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def primary_email=(_) - end + attr_accessor :primary_email # The phone number of the main administrator on the account. Format: `XXXXXXXXXX` sig { returns(T.nilable(String)) } - def primary_phone_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def primary_phone_number=(_) - end + attr_accessor :primary_phone_number sig do params( @@ -145,52 +99,24 @@ module FinchAPI class Account < FinchAPI::BaseModel # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } - def account_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def account_name=(_) - end + attr_accessor :account_name # 10-12 digit number to specify the bank account sig { returns(T.nilable(String)) } - def account_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def account_number=(_) - end + attr_accessor :account_number # The type of bank account. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) } - def account_type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol)) - end - def account_type=(_) - end + attr_accessor :account_type # Name of the banking institution. sig { returns(T.nilable(String)) } - def institution_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def institution_name=(_) - end + attr_accessor :institution_name # A nine-digit code that's based on the U.S. Bank location where your account was # opened. sig { returns(T.nilable(String)) } - def routing_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def routing_number=(_) - end + attr_accessor :routing_number sig do params( @@ -248,32 +174,21 @@ module FinchAPI class Department < FinchAPI::BaseModel # The department name. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The parent department, if present. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent)) } - def parent - end + attr_reader :parent sig do params( - _: T.nilable( + parent: T.nilable( T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Util::AnyHash) ) ) - .returns( - T.nilable( - T.any(FinchAPI::Models::Sandbox::CompanyUpdateParams::Department::Parent, FinchAPI::Util::AnyHash) - ) - ) - end - def parent=(_) + .void end + attr_writer :parent sig do params( @@ -302,12 +217,7 @@ module FinchAPI class Parent < FinchAPI::BaseModel # The parent department's name. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The parent department, if present. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -323,27 +233,11 @@ module FinchAPI class Entity < FinchAPI::BaseModel # The tax payer subtype of the company. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) } - def subtype - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol)) - end - def subtype=(_) - end + attr_accessor :subtype # The tax payer type of the company. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type # The entity type object. sig do diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index df851676..b0f56f73 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -6,90 +6,42 @@ module FinchAPI class CompanyUpdateResponse < FinchAPI::BaseModel # An array of bank account objects associated with the payroll/HRIS system. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account])) } - def accounts - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account])) - .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account])) - end - def accounts=(_) - end + attr_accessor :accounts # The array of company departments. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department)])) } - def departments - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department)])) - end - def departments=(_) - end + attr_accessor :departments # The employer identification number. sig { returns(T.nilable(String)) } - def ein - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def ein=(_) - end + attr_accessor :ein # The entity type object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity)) } - def entity - end + attr_reader :entity sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Util::AnyHash)) + entity: T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity, FinchAPI::Util::AnyHash)) - ) - end - def entity=(_) + .void end + attr_writer :entity # The legal name of the company. sig { returns(T.nilable(String)) } - def legal_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def legal_name=(_) - end + attr_accessor :legal_name sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) } - def locations - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Location)])) - end - def locations=(_) - end + attr_accessor :locations # The email of the main administrator on the account. sig { returns(T.nilable(String)) } - def primary_email - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def primary_email=(_) - end + attr_accessor :primary_email # The phone number of the main administrator on the account. Format: `XXXXXXXXXX` sig { returns(T.nilable(String)) } - def primary_phone_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def primary_phone_number=(_) - end + attr_accessor :primary_phone_number sig do params( @@ -132,52 +84,24 @@ module FinchAPI class Account < FinchAPI::BaseModel # The name of the bank associated in the payroll/HRIS system. sig { returns(T.nilable(String)) } - def account_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def account_name=(_) - end + attr_accessor :account_name # 10-12 digit number to specify the bank account sig { returns(T.nilable(String)) } - def account_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def account_number=(_) - end + attr_accessor :account_number # The type of bank account. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol)) } - def account_type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol)) - end - def account_type=(_) - end + attr_accessor :account_type # Name of the banking institution. sig { returns(T.nilable(String)) } - def institution_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def institution_name=(_) - end + attr_accessor :institution_name # A nine-digit code that's based on the U.S. Bank location where your account was # opened. sig { returns(T.nilable(String)) } - def routing_number - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def routing_number=(_) - end + attr_accessor :routing_number sig do params( @@ -235,32 +159,21 @@ module FinchAPI class Department < FinchAPI::BaseModel # The department name. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The parent department, if present. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent)) } - def parent - end + attr_reader :parent sig do params( - _: T.nilable( + parent: T.nilable( T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, FinchAPI::Util::AnyHash) ) ) - .returns( - T.nilable( - T.any(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Department::Parent, FinchAPI::Util::AnyHash) - ) - ) - end - def parent=(_) + .void end + attr_writer :parent sig do params( @@ -289,12 +202,7 @@ module FinchAPI class Parent < FinchAPI::BaseModel # The parent department's name. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The parent department, if present. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -310,27 +218,11 @@ module FinchAPI class Entity < FinchAPI::BaseModel # The tax payer subtype of the company. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol)) } - def subtype - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol)) - end - def subtype=(_) - end + attr_accessor :subtype # The tax payer type of the company. sig { returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type # The entity type object. sig do diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 4205f6d4..323c0022 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -9,42 +9,33 @@ module FinchAPI # The provider associated with the connection sig { returns(String) } - def provider_id - end - - sig { params(_: String).returns(String) } - def provider_id=(_) - end + attr_accessor :provider_id sig { returns(T.nilable(FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol)) } - def authentication_type - end + attr_reader :authentication_type sig do - params(_: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) - .returns(FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol) - end - def authentication_type=(_) + params( + authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::OrSymbol + ) + .void end + attr_writer :authentication_type # Optional: the size of the employer to be created with this connection. Defaults # to 20. Note that if this is higher than 100, historical payroll data will not be # generated, and instead only one pay period will be created. sig { returns(T.nilable(Integer)) } - def employee_size - end + attr_reader :employee_size - sig { params(_: Integer).returns(Integer) } - def employee_size=(_) - end + sig { params(employee_size: Integer).void } + attr_writer :employee_size sig { returns(T.nilable(T::Array[String])) } - def products - end + attr_reader :products - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + sig { params(products: T::Array[String]).void } + attr_writer :products sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index cf1d38a1..074e58ff 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -5,75 +5,35 @@ module FinchAPI module Sandbox class ConnectionCreateResponse < FinchAPI::BaseModel sig { returns(String) } - def access_token - end - - sig { params(_: String).returns(String) } - def access_token=(_) - end + attr_accessor :access_token # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } - def account_id - end - - sig { params(_: String).returns(String) } - def account_id=(_) - end + attr_accessor :account_id sig { returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) } - def authentication_type - end - - sig do - params(_: FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) - .returns(FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) - end - def authentication_type=(_) - end + attr_accessor :authentication_type # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } - def company_id - end - - sig { params(_: String).returns(String) } - def company_id=(_) - end + attr_accessor :company_id # The ID of the new connection sig { returns(String) } - def connection_id - end - - sig { params(_: String).returns(String) } - def connection_id=(_) - end + attr_accessor :connection_id sig { returns(T::Array[String]) } - def products - end - - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + attr_accessor :products # The ID of the provider associated with the `access_token`. sig { returns(String) } - def provider_id - end - - sig { params(_: String).returns(String) } - def provider_id=(_) - end + attr_accessor :provider_id sig { returns(T.nilable(String)) } - def token_type - end + attr_reader :token_type - sig { params(_: String).returns(String) } - def token_type=(_) - end + sig { params(token_type: String).void } + attr_writer :token_type sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index e77e7d8b..f4edb194 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -9,46 +9,34 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(String) } - def company_id - end - - sig { params(_: String).returns(String) } - def company_id=(_) - end + attr_accessor :company_id # The provider associated with the `access_token` sig { returns(String) } - def provider_id - end - - sig { params(_: String).returns(String) } - def provider_id=(_) - end + attr_accessor :provider_id sig do returns( T.nilable(FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) ) end - def authentication_type - end + attr_reader :authentication_type sig do - params(_: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) - .returns(FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol) - end - def authentication_type=(_) + params( + authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::OrSymbol + ) + .void end + attr_writer :authentication_type # Optional, defaults to Organization products (`company`, `directory`, # `employment`, `individual`) sig { returns(T.nilable(T::Array[String])) } - def products - end + attr_reader :products - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + sig { params(products: T::Array[String]).void } + attr_writer :products sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index 8a482f54..1a3564c3 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -6,67 +6,29 @@ module FinchAPI module Connections class AccountCreateResponse < FinchAPI::BaseModel sig { returns(String) } - def access_token - end - - sig { params(_: String).returns(String) } - def access_token=(_) - end + attr_accessor :access_token # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } - def account_id - end - - sig { params(_: String).returns(String) } - def account_id=(_) - end + attr_accessor :account_id sig { returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol) } - def authentication_type - end - - sig do - params(_: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol) - .returns(FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol) - end - def authentication_type=(_) - end + attr_accessor :authentication_type # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } - def company_id - end - - sig { params(_: String).returns(String) } - def company_id=(_) - end + attr_accessor :company_id # The ID of the new connection sig { returns(String) } - def connection_id - end - - sig { params(_: String).returns(String) } - def connection_id=(_) - end + attr_accessor :connection_id sig { returns(T::Array[String]) } - def products - end - - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + attr_accessor :products # The ID of the provider associated with the `access_token` sig { returns(String) } - def provider_id - end - - sig { params(_: String).returns(String) } - def provider_id=(_) - end + attr_accessor :provider_id sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi index fc861e05..a02e3d99 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_params.rbi @@ -9,15 +9,10 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(T.nilable(FinchAPI::Models::ConnectionStatusType::OrSymbol)) } - def connection_status - end + attr_reader :connection_status - sig do - params(_: FinchAPI::Models::ConnectionStatusType::OrSymbol) - .returns(FinchAPI::Models::ConnectionStatusType::OrSymbol) - end - def connection_status=(_) - end + sig { params(connection_status: FinchAPI::Models::ConnectionStatusType::OrSymbol).void } + attr_writer :connection_status sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index 3441db64..6c960431 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -7,58 +7,28 @@ module FinchAPI class AccountUpdateResponse < FinchAPI::BaseModel # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } - def account_id - end - - sig { params(_: String).returns(String) } - def account_id=(_) - end + attr_accessor :account_id sig { returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol) } - def authentication_type - end - - sig do - params(_: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol) - .returns(FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol) - end - def authentication_type=(_) - end + attr_accessor :authentication_type # [DEPRECATED] Use `connection_id` to associate a connection with an access token sig { returns(String) } - def company_id - end - - sig { params(_: String).returns(String) } - def company_id=(_) - end + attr_accessor :company_id sig { returns(T::Array[String]) } - def products - end - - sig { params(_: T::Array[String]).returns(T::Array[String]) } - def products=(_) - end + attr_accessor :products # The ID of the provider associated with the `access_token` sig { returns(String) } - def provider_id - end - - sig { params(_: String).returns(String) } - def provider_id=(_) - end + attr_accessor :provider_id # The ID of the new connection sig { returns(T.nilable(String)) } - def connection_id - end + attr_reader :connection_id - sig { params(_: String).returns(String) } - def connection_id=(_) - end + sig { params(connection_id: String).void } + attr_writer :connection_id sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index 0a332029..3347efb7 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -10,17 +10,15 @@ module FinchAPI # Array of individuals to create. Takes all combined fields from `/individual` and # `/employment` endpoints. All fields are optional. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body])) } - def body - end + attr_reader :body sig do params( - _: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)] + body: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)] ) - .returns(T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body, FinchAPI::Util::AnyHash)]) - end - def body=(_) + .void end + attr_writer :body sig do params( @@ -47,318 +45,164 @@ module FinchAPI class Body < FinchAPI::BaseModel # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } - def class_code - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def class_code=(_) - end + attr_accessor :class_code # 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. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField])) } - def custom_fields - end + attr_reader :custom_fields sig do params( - _: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)] + custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)] ) - .returns( - T::Array[T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField, FinchAPI::Util::AnyHash)] - ) - end - def custom_fields=(_) + .void end + attr_writer :custom_fields # The department object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department)) } - def department - end + attr_reader :department sig do params( - _: T.nilable( + department: T.nilable( T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash) ) ) - .returns( - T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Department, FinchAPI::Util::AnyHash) - ) - ) - end - def department=(_) + .void end + attr_writer :department sig { returns(T.nilable(String)) } - def dob - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def dob=(_) - end + attr_accessor :dob sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email])) } - def emails - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email])) - .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email])) - end - def emails=(_) - end + attr_accessor :emails # The employment object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment)) } - def employment - end + attr_reader :employment sig do params( - _: T.nilable( + employment: T.nilable( T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash) ) ) - .returns( - T.nilable( - T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, FinchAPI::Util::AnyHash) - ) - ) - end - def employment=(_) + .void end + attr_writer :employment # The detailed employment status of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) } - def employment_status - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::OrSymbol)) - end - def employment_status=(_) - end + attr_accessor :employment_status # Social Security Number of the individual in **encrypted** format. This field is # only available with the `ssn` scope enabled and the # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } - def encrypted_ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def encrypted_ssn=(_) - end + attr_accessor :encrypted_ssn sig { returns(T.nilable(String)) } - def end_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def end_date=(_) - end + attr_accessor :end_date # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) } - def ethnicity - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::OrSymbol)) - end - def ethnicity=(_) - end + attr_accessor :ethnicity # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # The gender of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) } - def gender - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol)) - end - def gender=(_) - end + attr_accessor :gender # The employee's income as reported by the provider. This may not always be # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } - def income - end + attr_reader :income - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - end - def income=(_) - end + sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))).void } + attr_writer :income # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } - def income_history - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - end - def income_history=(_) - end + attr_accessor :income_history # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } - def is_active - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def is_active=(_) - end + attr_accessor :is_active # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name sig { returns(T.nilable(String)) } - def latest_rehire_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def latest_rehire_date=(_) - end + attr_accessor :latest_rehire_date sig { returns(T.nilable(FinchAPI::Models::Location)) } - def location - end + attr_reader :location - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def location=(_) - end + sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :location # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager)) } - def manager - end + attr_reader :manager sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)) + manager: T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, FinchAPI::Util::AnyHash)) - ) - end - def manager=(_) + .void end + attr_writer :manager # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name sig do returns( T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)]) ) end - def phone_numbers - end - - sig do - params( - _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)]) - ) - .returns( - T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber)]) - ) - end - def phone_numbers=(_) - end + attr_accessor :phone_numbers # The preferred name of the individual. sig { returns(T.nilable(String)) } - def preferred_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def preferred_name=(_) - end + attr_accessor :preferred_name sig { returns(T.nilable(FinchAPI::Models::Location)) } - def residence - end + attr_reader :residence - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def residence=(_) - end + sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :residence # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } - def source_id - end + attr_reader :source_id - sig { params(_: String).returns(String) } - def source_id=(_) - end + sig { params(source_id: String).void } + attr_writer :source_id # Social Security Number of the individual. This field is only available with the # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the # body. # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } - def ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def ssn=(_) - end + attr_accessor :ssn sig { returns(T.nilable(String)) } - def start_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def start_date=(_) - end + attr_accessor :start_date # The current title of the individual. sig { returns(T.nilable(String)) } - def title - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def title=(_) - end + attr_accessor :title sig do params( @@ -474,20 +318,13 @@ module FinchAPI class CustomField < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name sig { returns(T.nilable(T.anything)) } - def value - end + attr_reader :value - sig { params(_: T.anything).returns(T.anything) } - def value=(_) - end + sig { params(value: T.anything).void } + attr_writer :value sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) } def self.new(name: nil, value: nil) @@ -501,12 +338,7 @@ module FinchAPI class Department < FinchAPI::BaseModel # The name of the department associated with the individual. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -520,23 +352,13 @@ module FinchAPI class Email < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end + attr_reader :data - sig { params(_: String).returns(String) } - def data=(_) - end + sig { params(data: String).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -584,29 +406,11 @@ module FinchAPI # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol)) } - def subtype - end - - sig do - params( - _: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol) - ) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::OrSymbol)) - end - def subtype=(_) - end + attr_accessor :subtype # The main employment type of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type # The employment object. sig do @@ -810,12 +614,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } @@ -829,23 +631,13 @@ module FinchAPI class PhoneNumber < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end + attr_reader :data - sig { params(_: String).returns(String) } - def data=(_) - end + sig { params(data: String).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index 9225a454..070386fa 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -9,205 +9,116 @@ module FinchAPI # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } - def class_code - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def class_code=(_) - end + attr_accessor :class_code # 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. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField])) } - def custom_fields - end + attr_reader :custom_fields sig do params( - _: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)] + custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)] ) - .returns( - T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)] - ) - end - def custom_fields=(_) + .void end + attr_writer :custom_fields # The department object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department)) } - def department - end + attr_reader :department sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)) + department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)) - ) - end - def department=(_) + .void end + attr_writer :department # The employment object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment)) } - def employment - end + attr_reader :employment sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)) + employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)) - ) - end - def employment=(_) + .void end + attr_writer :employment # The detailed employment status of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) } - def employment_status - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) - end - def employment_status=(_) - end + attr_accessor :employment_status sig { returns(T.nilable(String)) } - def end_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def end_date=(_) - end + attr_accessor :end_date # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # The employee's income as reported by the provider. This may not always be # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } - def income - end + attr_reader :income - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - end - def income=(_) - end + sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))).void } + attr_writer :income # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } - def income_history - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - end - def income_history=(_) - end + attr_accessor :income_history # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } - def is_active - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def is_active=(_) - end + attr_accessor :is_active # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name sig { returns(T.nilable(String)) } - def latest_rehire_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def latest_rehire_date=(_) - end + attr_accessor :latest_rehire_date sig { returns(T.nilable(FinchAPI::Models::Location)) } - def location - end + attr_reader :location - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def location=(_) - end + sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :location # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager)) } - def manager - end + attr_reader :manager sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)) + manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)) - ) - end - def manager=(_) + .void end + attr_writer :manager # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } - def source_id - end + attr_reader :source_id - sig { params(_: String).returns(String) } - def source_id=(_) - end + sig { params(source_id: String).void } + attr_writer :source_id sig { returns(T.nilable(String)) } - def start_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def start_date=(_) - end + attr_accessor :start_date # The current title of the individual. sig { returns(T.nilable(String)) } - def title - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def title=(_) - end + attr_accessor :title sig do params( @@ -287,20 +198,13 @@ module FinchAPI class CustomField < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name sig { returns(T.nilable(T.anything)) } - def value - end + attr_reader :value - sig { params(_: T.anything).returns(T.anything) } - def value=(_) - end + sig { params(value: T.anything).void } + attr_writer :value sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) } def self.new(name: nil, value: nil) @@ -314,12 +218,7 @@ module FinchAPI class Department < FinchAPI::BaseModel # The name of the department associated with the individual. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -335,27 +234,11 @@ module FinchAPI # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol)) } - def subtype - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol)) - end - def subtype=(_) - end + attr_accessor :subtype # The main employment type of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type # The employment object. sig do @@ -476,12 +359,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 1589b176..6b13137a 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -6,214 +6,123 @@ module FinchAPI class EmploymentUpdateResponse < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # Worker's compensation classification code for this employee sig { returns(T.nilable(String)) } - def class_code - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def class_code=(_) - end + attr_accessor :class_code # 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. sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField])) } - def custom_fields - end + attr_reader :custom_fields sig do params( - _: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Util::AnyHash)] + custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Util::AnyHash)] ) - .returns( - T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField, FinchAPI::Util::AnyHash)] - ) - end - def custom_fields=(_) + .void end + attr_writer :custom_fields # The department object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department)) } - def department - end + attr_reader :department sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Util::AnyHash)) + department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, FinchAPI::Util::AnyHash)) - ) - end - def department=(_) + .void end + attr_writer :department # The employment object. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment)) } - def employment - end + attr_reader :employment sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Util::AnyHash)) + employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, FinchAPI::Util::AnyHash)) - ) - end - def employment=(_) + .void end + attr_writer :employment # The detailed employment status of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol)) } - def employment_status - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol)) - end - def employment_status=(_) - end + attr_accessor :employment_status sig { returns(T.nilable(String)) } - def end_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def end_date=(_) - end + attr_accessor :end_date # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # The employee's income as reported by the provider. This may not always be # annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, # depending on what information the provider returns. sig { returns(T.nilable(FinchAPI::Models::Income)) } - def income - end + attr_reader :income - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))) - end - def income=(_) - end + sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))).void } + attr_writer :income # The array of income history. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) } - def income_history - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) - end - def income_history=(_) - end + attr_accessor :income_history # `true` if the individual an an active employee or contractor at the company. sig { returns(T.nilable(T::Boolean)) } - def is_active - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def is_active=(_) - end + attr_accessor :is_active # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name sig { returns(T.nilable(String)) } - def latest_rehire_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def latest_rehire_date=(_) - end + attr_accessor :latest_rehire_date sig { returns(T.nilable(FinchAPI::Models::Location)) } - def location - end + attr_reader :location - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def location=(_) - end + sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :location # The manager object representing the manager of the individual within the org. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager)) } - def manager - end + attr_reader :manager sig do params( - _: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Util::AnyHash)) + manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Util::AnyHash)) ) - .returns( - T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Manager, FinchAPI::Util::AnyHash)) - ) - end - def manager=(_) + .void end + attr_writer :manager # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name # The source system's unique employment identifier for this individual sig { returns(T.nilable(String)) } - def source_id - end + attr_reader :source_id - sig { params(_: String).returns(String) } - def source_id=(_) - end + sig { params(source_id: String).void } + attr_writer :source_id sig { returns(T.nilable(String)) } - def start_date - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def start_date=(_) - end + attr_accessor :start_date # The current title of the individual. sig { returns(T.nilable(String)) } - def title - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def title=(_) - end + attr_accessor :title sig do params( @@ -293,20 +202,13 @@ module FinchAPI class CustomField < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name sig { returns(T.nilable(T.anything)) } - def value - end + attr_reader :value - sig { params(_: T.anything).returns(T.anything) } - def value=(_) - end + sig { params(value: T.anything).void } + attr_writer :value sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) } def self.new(name: nil, value: nil) @@ -320,12 +222,7 @@ module FinchAPI class Department < FinchAPI::BaseModel # The name of the department associated with the individual. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The department object. sig { params(name: T.nilable(String)).returns(T.attached_class) } @@ -341,29 +238,11 @@ module FinchAPI # The secondary employment type of the individual. Options: `full_time`, # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol)) } - def subtype - end - - sig do - params( - _: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol) - ) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol)) - end - def subtype=(_) - end + attr_accessor :subtype # The main employment type of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type # The employment object. sig do @@ -486,12 +365,10 @@ module FinchAPI class Manager < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id # The manager object representing the manager of the individual within the org. sig { params(id: String).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index 9f936f5e..20c72e9b 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -8,128 +8,56 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(T.nilable(String)) } - def dob - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def dob=(_) - end + attr_accessor :dob sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email])) } - def emails - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email])) - .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email])) - end - def emails=(_) - end + attr_accessor :emails # Social Security Number of the individual in **encrypted** format. This field is # only available with the `ssn` scope enabled and the # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } - def encrypted_ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def encrypted_ssn=(_) - end + attr_accessor :encrypted_ssn # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol)) } - def ethnicity - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol)) - end - def ethnicity=(_) - end + attr_accessor :ethnicity # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # The gender of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol)) } - def gender - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol)) - end - def gender=(_) - end + attr_accessor :gender # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)])) } - def phone_numbers - end - - sig do - params(_: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)])) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)])) - end - def phone_numbers=(_) - end + attr_accessor :phone_numbers # The preferred name of the individual. sig { returns(T.nilable(String)) } - def preferred_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def preferred_name=(_) - end + attr_accessor :preferred_name sig { returns(T.nilable(FinchAPI::Models::Location)) } - def residence - end + attr_reader :residence - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def residence=(_) - end + sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :residence # Social Security Number of the individual. This field is only available with the # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the # body. # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } - def ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def ssn=(_) - end + attr_accessor :ssn sig do params( @@ -195,23 +123,13 @@ module FinchAPI class Email < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end + attr_reader :data - sig { params(_: String).returns(String) } - def data=(_) - end + sig { params(data: String).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -314,23 +232,13 @@ module FinchAPI class PhoneNumber < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end + attr_reader :data - sig { params(_: String).returns(String) } - def data=(_) - end + sig { params(data: String).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index 62c72c75..4641647e 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -6,138 +6,62 @@ module FinchAPI class IndividualUpdateResponse < FinchAPI::BaseModel # A stable Finch `id` (UUID v4) for an individual in the company. sig { returns(T.nilable(String)) } - def id - end + attr_reader :id - sig { params(_: String).returns(String) } - def id=(_) - end + sig { params(id: String).void } + attr_writer :id sig { returns(T.nilable(String)) } - def dob - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def dob=(_) - end + attr_accessor :dob sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email])) } - def emails - end - - sig do - params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email])) - .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email])) - end - def emails=(_) - end + attr_accessor :emails # Social Security Number of the individual in **encrypted** format. This field is # only available with the `ssn` scope enabled and the # `options: { include: ['ssn'] }` param set in the body. sig { returns(T.nilable(String)) } - def encrypted_ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def encrypted_ssn=(_) - end + attr_accessor :encrypted_ssn # The EEOC-defined ethnicity of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) } - def ethnicity - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) - end - def ethnicity=(_) - end + attr_accessor :ethnicity # The legal first name of the individual. sig { returns(T.nilable(String)) } - def first_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def first_name=(_) - end + attr_accessor :first_name # The gender of the individual. sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) } - def gender - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) - end - def gender=(_) - end + attr_accessor :gender # The legal last name of the individual. sig { returns(T.nilable(String)) } - def last_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def last_name=(_) - end + attr_accessor :last_name # The legal middle name of the individual. sig { returns(T.nilable(String)) } - def middle_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def middle_name=(_) - end + attr_accessor :middle_name sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)])) } - def phone_numbers - end - - sig do - params( - _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]) - ) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)])) - end - def phone_numbers=(_) - end + attr_accessor :phone_numbers # The preferred name of the individual. sig { returns(T.nilable(String)) } - def preferred_name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def preferred_name=(_) - end + attr_accessor :preferred_name sig { returns(T.nilable(FinchAPI::Models::Location)) } - def residence - end + attr_reader :residence - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))) - end - def residence=(_) - end + sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void } + attr_writer :residence # Social Security Number of the individual. This field is only available with the # `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the # body. # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). sig { returns(T.nilable(String)) } - def ssn - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def ssn=(_) - end + attr_accessor :ssn sig do params( @@ -207,23 +131,13 @@ module FinchAPI class Email < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end + attr_reader :data - sig { params(_: String).returns(String) } - def data=(_) - end + sig { params(data: String).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -331,23 +245,13 @@ module FinchAPI class PhoneNumber < FinchAPI::BaseModel sig { returns(T.nilable(String)) } - def data - end + attr_reader :data - sig { params(_: String).returns(String) } - def data=(_) - end + sig { params(data: String).void } + attr_writer :data sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index cdc6d389..0adca813 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -9,15 +9,7 @@ module FinchAPI # The type of job to start. Currently the only supported type is `data_sync_all` sig { returns(FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) } - def type - end - - sig do - params(_: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) - .returns(FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/job_create_response.rbi b/rbi/lib/finch-api/models/sandbox/job_create_response.rbi index 2b504245..a49b5e91 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_response.rbi @@ -6,39 +6,19 @@ module FinchAPI class JobCreateResponse < FinchAPI::BaseModel # The number of allowed refreshes per hour (per hour, fixed window) sig { returns(Integer) } - def allowed_refreshes - end - - sig { params(_: Integer).returns(Integer) } - def allowed_refreshes=(_) - end + attr_accessor :allowed_refreshes # The id of the job that has been created. sig { returns(String) } - def job_id - end - - sig { params(_: String).returns(String) } - def job_id=(_) - end + attr_accessor :job_id # The url that can be used to retrieve the job status sig { returns(String) } - def job_url - end - - sig { params(_: String).returns(String) } - def job_url=(_) - end + attr_accessor :job_url # The number of remaining refreshes available (per hour, fixed window) sig { returns(Integer) } - def remaining_refreshes - end - - sig { params(_: Integer).returns(Integer) } - def remaining_refreshes=(_) - end + attr_accessor :remaining_refreshes sig do params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer) diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index 419b08a0..8da49d3a 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -6,26 +6,10 @@ module FinchAPI module Jobs class SandboxJobConfiguration < FinchAPI::BaseModel sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) } - def completion_status - end - - sig do - params(_: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) - .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) - end - def completion_status=(_) - end + attr_accessor :completion_status sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) } - def type - end - - sig do - params(_: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) - .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) - end - def type=(_) - end + attr_accessor :type sig do params( diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index b8216906..4a2c88e9 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -8,35 +8,27 @@ module FinchAPI include FinchAPI::RequestParameters sig { returns(T.nilable(String)) } - def end_date - end + attr_reader :end_date - sig { params(_: String).returns(String) } - def end_date=(_) - end + sig { params(end_date: String).void } + attr_writer :end_date sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement])) } - def pay_statements - end + attr_reader :pay_statements sig do params( - _: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)] + pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)] ) - .returns( - T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)] - ) - end - def pay_statements=(_) + .void end + attr_writer :pay_statements sig { returns(T.nilable(String)) } - def start_date - end + attr_reader :start_date - sig { params(_: String).returns(String) } - def start_date=(_) - end + sig { params(start_date: String).void } + attr_writer :start_date sig do params( @@ -71,19 +63,7 @@ module FinchAPI T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)]) ) end - def earnings - end - - sig do - params( - _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)]) - ) - .returns( - T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning)]) - ) - end - def earnings=(_) - end + attr_accessor :earnings # The array of deductions objects associated with this pay statement. sig do @@ -93,23 +73,7 @@ module FinchAPI ) ) end - def employee_deductions - end - - sig do - params( - _: T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)] - ) - ) - .returns( - T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction)] - ) - ) - end - def employee_deductions=(_) - end + attr_accessor :employee_deductions sig do returns( @@ -118,103 +82,42 @@ module FinchAPI ) ) end - def employer_contributions - end - - sig do - params( - _: T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)] - ) - ) - .returns( - T.nilable( - T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution)] - ) - ) - end - def employer_contributions=(_) - end + attr_accessor :employer_contributions sig { returns(T.nilable(FinchAPI::Models::Money)) } - def gross_pay - end + attr_reader :gross_pay - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def gross_pay=(_) - end + sig { params(gross_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :gross_pay # A stable Finch `id` (UUID v4) for an individual in the company sig { returns(T.nilable(String)) } - def individual_id - end + attr_reader :individual_id - sig { params(_: String).returns(String) } - def individual_id=(_) - end + sig { params(individual_id: String).void } + attr_writer :individual_id sig { returns(T.nilable(FinchAPI::Models::Money)) } - def net_pay - end + attr_reader :net_pay - sig do - params(_: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - .returns(T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))) - end - def net_pay=(_) - end + sig { params(net_pay: T.nilable(T.any(FinchAPI::Models::Money, FinchAPI::Util::AnyHash))).void } + attr_writer :net_pay # The payment method. sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol)) } - def payment_method - end - - sig do - params( - _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol) - ) - .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::OrSymbol)) - end - def payment_method=(_) - end + attr_accessor :payment_method # The array of taxes objects associated with this pay statement. sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)])) } - def taxes - end - - sig do - params( - _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)]) - ) - .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax)])) - end - def taxes=(_) - end + attr_accessor :taxes # The number of hours worked for this pay period sig { returns(T.nilable(Float)) } - def total_hours - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def total_hours=(_) - end + attr_accessor :total_hours # The type of the payment associated with the pay statement. sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -302,79 +205,40 @@ module FinchAPI class Earning < FinchAPI::BaseModel # The earnings amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes)) } - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable( + attributes: T.nilable( T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, FinchAPI::Util::AnyHash ) ) ) - .returns( - T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes, - FinchAPI::Util::AnyHash - ) - ) - ) - end - def attributes=(_) + .void end + attr_writer :attributes # The earnings currency code. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # The number of hours associated with this earning. (For salaried employees, this # could be hours per pay period, `0` or `null`, depending on the provider). sig { returns(T.nilable(Float)) } - def hours - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def hours=(_) - end + attr_accessor :hours # The exact name of the deduction from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The type of earning. sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)) } - def type - end - - sig do - params( - _: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol) - ) - .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -417,25 +281,18 @@ module FinchAPI T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata) ) end - def metadata - end + attr_reader :metadata sig do params( - _: T.any( + metadata: T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Attributes::Metadata, - FinchAPI::Util::AnyHash - ) - ) - end - def metadata=(_) + .void end + attr_writer :metadata sig do params( @@ -463,12 +320,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) @@ -547,80 +402,43 @@ module FinchAPI class EmployeeDeduction < FinchAPI::BaseModel # The deduction amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig do returns( T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes) ) end - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable( + attributes: T.nilable( T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, FinchAPI::Util::AnyHash ) ) ) - .returns( - T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes, - FinchAPI::Util::AnyHash - ) - ) - ) - end - def attributes=(_) + .void end + attr_writer :attributes # The deduction currency. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # The deduction name from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # Boolean indicating if the deduction is pre-tax. sig { returns(T.nilable(T::Boolean)) } - def pre_tax - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def pre_tax=(_) - end + attr_accessor :pre_tax # Type of benefit. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -665,25 +483,18 @@ module FinchAPI ) ) end - def metadata - end + attr_reader :metadata sig do params( - _: T.any( + metadata: T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployeeDeduction::Attributes::Metadata, - FinchAPI::Util::AnyHash - ) - ) - end - def metadata=(_) + .void end + attr_writer :metadata sig do params( @@ -713,12 +524,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) @@ -734,71 +543,39 @@ module FinchAPI class EmployerContribution < FinchAPI::BaseModel # The contribution amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig do returns( T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes) ) end - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable( + attributes: T.nilable( T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, FinchAPI::Util::AnyHash ) ) ) - .returns( - T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes, - FinchAPI::Util::AnyHash - ) - ) - ) - end - def attributes=(_) + .void end + attr_writer :attributes # The contribution currency. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # The contribution name from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # Type of benefit. sig { returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::HRIS::BenefitType::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -841,25 +618,18 @@ module FinchAPI ) ) end - def metadata - end + attr_reader :metadata sig do params( - _: T.any( + metadata: T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::EmployerContribution::Attributes::Metadata, - FinchAPI::Util::AnyHash - ) - ) - end - def metadata=(_) + .void end + attr_writer :metadata sig do params( @@ -889,12 +659,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) @@ -939,76 +707,39 @@ module FinchAPI class Tax < FinchAPI::BaseModel # The tax amount in cents. sig { returns(T.nilable(Integer)) } - def amount - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def amount=(_) - end + attr_accessor :amount sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes)) } - def attributes - end + attr_reader :attributes sig do params( - _: T.nilable( + attributes: T.nilable( T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, FinchAPI::Util::AnyHash ) ) ) - .returns( - T.nilable( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes, - FinchAPI::Util::AnyHash - ) - ) - ) - end - def attributes=(_) + .void end + attr_writer :attributes # The currency code. sig { returns(T.nilable(String)) } - def currency - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def currency=(_) - end + attr_accessor :currency # `true` if the amount is paid by the employers. sig { returns(T.nilable(T::Boolean)) } - def employer - end - - sig { params(_: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) } - def employer=(_) - end + attr_accessor :employer # The exact name of tax from the pay statement. sig { returns(T.nilable(String)) } - def name - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def name=(_) - end + attr_accessor :name # The type of taxes. sig { returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) } - def type - end - - sig do - params(_: T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) - .returns(T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::OrSymbol)) - end - def type=(_) - end + attr_accessor :type sig do params( @@ -1051,25 +782,18 @@ module FinchAPI T.nilable(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata) ) end - def metadata - end + attr_reader :metadata sig do params( - _: T.any( + metadata: T.any( FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, FinchAPI::Util::AnyHash ) ) - .returns( - T.any( - FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Attributes::Metadata, - FinchAPI::Util::AnyHash - ) - ) - end - def metadata=(_) + .void end + attr_writer :metadata sig do params( @@ -1097,12 +821,10 @@ module FinchAPI # pairs where the values can be of any type (string, number, boolean, object, # array, etc.). sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } - def metadata - end + attr_reader :metadata - sig { params(_: T::Hash[Symbol, T.anything]).returns(T::Hash[Symbol, T.anything]) } - def metadata=(_) - end + sig { params(metadata: T::Hash[Symbol, T.anything]).void } + attr_writer :metadata sig { params(metadata: T::Hash[Symbol, T.anything]).returns(T.attached_class) } def self.new(metadata: nil) diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi index f591b997..efc39ac5 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_response.rbi @@ -6,21 +6,11 @@ module FinchAPI class PaymentCreateResponse < FinchAPI::BaseModel # The date of the payment. sig { returns(String) } - def pay_date - end - - sig { params(_: String).returns(String) } - def pay_date=(_) - end + attr_accessor :pay_date # The ID of the payment. sig { returns(String) } - def payment_id - end - - sig { params(_: String).returns(String) } - def payment_id=(_) - end + attr_accessor :payment_id sig { params(pay_date: String, payment_id: String).returns(T.attached_class) } def self.new(pay_date:, payment_id:) diff --git a/rbi/lib/finch-api/page.rbi b/rbi/lib/finch-api/page.rbi index b759ab95..f1019dbe 100644 --- a/rbi/lib/finch-api/page.rbi +++ b/rbi/lib/finch-api/page.rbi @@ -7,20 +7,10 @@ module FinchAPI Elem = type_member sig { returns(T.nilable(T::Array[Elem])) } - def data - end - - sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) } - def data=(_) - end + attr_accessor :data sig { returns(FinchAPI::Models::Paging) } - def paging - end - - sig { params(_: FinchAPI::Models::Paging).returns(FinchAPI::Models::Paging) } - def paging=(_) - end + attr_accessor :paging sig { returns(String) } def inspect diff --git a/rbi/lib/finch-api/request_options.rbi b/rbi/lib/finch-api/request_options.rbi index feaaa813..9c6d0e10 100644 --- a/rbi/lib/finch-api/request_options.rbi +++ b/rbi/lib/finch-api/request_options.rbi @@ -5,15 +5,7 @@ module FinchAPI module RequestParameters # Options to specify HTTP behaviour for this request. sig { returns(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) } - def request_options - end - - sig do - params(_: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) - .returns(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) - end - def request_options=(_) - end + attr_accessor :request_options # @api private module Converter @@ -38,66 +30,30 @@ module FinchAPI # Idempotency key to send with request and all associated retries. Will only be # sent for write requests. sig { returns(T.nilable(String)) } - def idempotency_key - end - - sig { params(_: T.nilable(String)).returns(T.nilable(String)) } - def idempotency_key=(_) - end + attr_accessor :idempotency_key # Extra query params to send with the request. These are `.merge`’d into any # `query` given at the client level. sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) } - def extra_query - end - - sig do - params(_: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) - .returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) - end - def extra_query=(_) - end + attr_accessor :extra_query # Extra headers to send with the request. These are `.merged`’d into any # `extra_headers` given at the client level. sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) } - def extra_headers - end - - sig do - params(_: T.nilable(T::Hash[String, T.nilable(String)])) - .returns(T.nilable(T::Hash[String, T.nilable(String)])) - end - def extra_headers=(_) - end + attr_accessor :extra_headers # Extra data to send with the request. These are deep merged into any data # generated as part of the normal request. sig { returns(T.nilable(T.anything)) } - def extra_body - end - - sig { params(_: T.nilable(T.anything)).returns(T.nilable(T.anything)) } - def extra_body=(_) - end + attr_accessor :extra_body # Maximum number of retries to attempt after a failed initial request. sig { returns(T.nilable(Integer)) } - def max_retries - end - - sig { params(_: T.nilable(Integer)).returns(T.nilable(Integer)) } - def max_retries=(_) - end + attr_accessor :max_retries # Request timeout in seconds. sig { returns(T.nilable(Float)) } - def timeout - end - - sig { params(_: T.nilable(Float)).returns(T.nilable(Float)) } - def timeout=(_) - end + attr_accessor :timeout # Returns a new instance of RequestOptions. sig { params(values: FinchAPI::Util::AnyHash).returns(T.attached_class) } diff --git a/rbi/lib/finch-api/resources/connect.rbi b/rbi/lib/finch-api/resources/connect.rbi index 9a5a228e..9cf5a0bf 100644 --- a/rbi/lib/finch-api/resources/connect.rbi +++ b/rbi/lib/finch-api/resources/connect.rbi @@ -4,8 +4,7 @@ module FinchAPI module Resources class Connect sig { returns(FinchAPI::Resources::Connect::Sessions) } - def sessions - end + attr_reader :sessions sig { params(client: FinchAPI::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/lib/finch-api/resources/hris.rbi b/rbi/lib/finch-api/resources/hris.rbi index b3e3fab4..0273e083 100644 --- a/rbi/lib/finch-api/resources/hris.rbi +++ b/rbi/lib/finch-api/resources/hris.rbi @@ -4,36 +4,28 @@ module FinchAPI module Resources class HRIS sig { returns(FinchAPI::Resources::HRIS::Company) } - def company - end + attr_reader :company sig { returns(FinchAPI::Resources::HRIS::Directory) } - def directory - end + attr_reader :directory sig { returns(FinchAPI::Resources::HRIS::Individuals) } - def individuals - end + attr_reader :individuals sig { returns(FinchAPI::Resources::HRIS::Employments) } - def employments - end + attr_reader :employments sig { returns(FinchAPI::Resources::HRIS::Payments) } - def payments - end + attr_reader :payments sig { returns(FinchAPI::Resources::HRIS::PayStatements) } - def pay_statements - end + attr_reader :pay_statements sig { returns(FinchAPI::Resources::HRIS::Documents) } - def documents - end + attr_reader :documents sig { returns(FinchAPI::Resources::HRIS::Benefits) } - def benefits - end + attr_reader :benefits sig { params(client: FinchAPI::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/lib/finch-api/resources/hris/benefits.rbi b/rbi/lib/finch-api/resources/hris/benefits.rbi index 7bc2008b..26b286c5 100644 --- a/rbi/lib/finch-api/resources/hris/benefits.rbi +++ b/rbi/lib/finch-api/resources/hris/benefits.rbi @@ -5,8 +5,7 @@ module FinchAPI class HRIS class Benefits sig { returns(FinchAPI::Resources::HRIS::Benefits::Individuals) } - def individuals - end + attr_reader :individuals # Creates a new company-wide deduction or contribution. Please use the # `/providers` endpoint to view available types for each provider. diff --git a/rbi/lib/finch-api/resources/jobs.rbi b/rbi/lib/finch-api/resources/jobs.rbi index 07750bc4..3bdb92d1 100644 --- a/rbi/lib/finch-api/resources/jobs.rbi +++ b/rbi/lib/finch-api/resources/jobs.rbi @@ -4,12 +4,10 @@ module FinchAPI module Resources class Jobs sig { returns(FinchAPI::Resources::Jobs::Automated) } - def automated - end + attr_reader :automated sig { returns(FinchAPI::Resources::Jobs::Manual) } - def manual - end + attr_reader :manual sig { params(client: FinchAPI::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/lib/finch-api/resources/payroll.rbi b/rbi/lib/finch-api/resources/payroll.rbi index a3958085..f2405820 100644 --- a/rbi/lib/finch-api/resources/payroll.rbi +++ b/rbi/lib/finch-api/resources/payroll.rbi @@ -4,8 +4,7 @@ module FinchAPI module Resources class Payroll sig { returns(FinchAPI::Resources::Payroll::PayGroups) } - def pay_groups - end + attr_reader :pay_groups sig { params(client: FinchAPI::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/lib/finch-api/resources/sandbox.rbi b/rbi/lib/finch-api/resources/sandbox.rbi index acc78527..794ac209 100644 --- a/rbi/lib/finch-api/resources/sandbox.rbi +++ b/rbi/lib/finch-api/resources/sandbox.rbi @@ -4,32 +4,25 @@ module FinchAPI module Resources class Sandbox sig { returns(FinchAPI::Resources::Sandbox::Connections) } - def connections - end + attr_reader :connections sig { returns(FinchAPI::Resources::Sandbox::Company) } - def company - end + attr_reader :company sig { returns(FinchAPI::Resources::Sandbox::Directory) } - def directory - end + attr_reader :directory sig { returns(FinchAPI::Resources::Sandbox::Individual) } - def individual - end + attr_reader :individual sig { returns(FinchAPI::Resources::Sandbox::Employment) } - def employment - end + attr_reader :employment sig { returns(FinchAPI::Resources::Sandbox::Payment) } - def payment - end + attr_reader :payment sig { returns(FinchAPI::Resources::Sandbox::Jobs) } - def jobs - end + attr_reader :jobs sig { params(client: FinchAPI::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/lib/finch-api/resources/sandbox/connections.rbi b/rbi/lib/finch-api/resources/sandbox/connections.rbi index 13a41a34..0f6fcb32 100644 --- a/rbi/lib/finch-api/resources/sandbox/connections.rbi +++ b/rbi/lib/finch-api/resources/sandbox/connections.rbi @@ -5,8 +5,7 @@ module FinchAPI class Sandbox class Connections sig { returns(FinchAPI::Resources::Sandbox::Connections::Accounts) } - def accounts - end + attr_reader :accounts # Create a new connection (new company/provider pair) with a new account sig do diff --git a/rbi/lib/finch-api/resources/sandbox/jobs.rbi b/rbi/lib/finch-api/resources/sandbox/jobs.rbi index 8ebdbefc..063921b6 100644 --- a/rbi/lib/finch-api/resources/sandbox/jobs.rbi +++ b/rbi/lib/finch-api/resources/sandbox/jobs.rbi @@ -5,8 +5,7 @@ module FinchAPI class Sandbox class Jobs sig { returns(FinchAPI::Resources::Sandbox::Jobs::Configuration) } - def configuration - end + attr_reader :configuration # Enqueue a new sandbox job sig do diff --git a/rbi/lib/finch-api/responses_page.rbi b/rbi/lib/finch-api/responses_page.rbi index 9976226d..e30b83c1 100644 --- a/rbi/lib/finch-api/responses_page.rbi +++ b/rbi/lib/finch-api/responses_page.rbi @@ -7,12 +7,7 @@ module FinchAPI Elem = type_member sig { returns(T.nilable(T::Array[Elem])) } - def responses - end - - sig { params(_: T.nilable(T::Array[Elem])).returns(T.nilable(T::Array[Elem])) } - def responses=(_) - end + attr_accessor :responses sig { returns(String) } def inspect From 1927323200a74179fde0a73a976eeea2096b1969 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 12:31:40 +0000 Subject: [PATCH 62/67] fix: pages should be able to accept non-converter models (#65) --- lib/finch-api/individuals_page.rb | 2 +- lib/finch-api/page.rb | 2 +- lib/finch-api/responses_page.rb | 2 +- test/finch-api/resources/hris/benefits/individuals_test.rb | 6 ++++++ test/finch-api/resources/hris/benefits_test.rb | 4 ++++ test/finch-api/resources/hris/directory_test.rb | 4 ++++ test/finch-api/resources/hris/employments_test.rb | 2 ++ test/finch-api/resources/hris/individuals_test.rb | 2 ++ test/finch-api/resources/hris/pay_statements_test.rb | 2 ++ test/finch-api/resources/hris/payments_test.rb | 2 ++ test/finch-api/resources/payroll/pay_groups_test.rb | 2 ++ test/finch-api/resources/providers_test.rb | 2 ++ 12 files changed, 29 insertions(+), 3 deletions(-) diff --git a/lib/finch-api/individuals_page.rb b/lib/finch-api/individuals_page.rb index 0820660e..f14c9aeb 100644 --- a/lib/finch-api/individuals_page.rb +++ b/lib/finch-api/individuals_page.rb @@ -43,7 +43,7 @@ def initialize(client:, req:, headers:, page_data:) case page_data in {individuals: Array | nil => individuals} - @individuals = individuals&.map { model.coerce(_1) } + @individuals = individuals&.map { FinchAPI::Converter.coerce(model, _1) } else end diff --git a/lib/finch-api/page.rb b/lib/finch-api/page.rb index f9313a52..117cd89d 100644 --- a/lib/finch-api/page.rb +++ b/lib/finch-api/page.rb @@ -43,7 +43,7 @@ def initialize(client:, req:, headers:, page_data:) case page_data in {data: Array | nil => data} - @data = data&.map { model.coerce(_1) } + @data = data&.map { FinchAPI::Converter.coerce(model, _1) } else end diff --git a/lib/finch-api/responses_page.rb b/lib/finch-api/responses_page.rb index 951a7693..ecff105d 100644 --- a/lib/finch-api/responses_page.rb +++ b/lib/finch-api/responses_page.rb @@ -40,7 +40,7 @@ def initialize(client:, req:, headers:, page_data:) case page_data in {responses: Array | nil => responses} - @responses = responses&.map { model.coerce(_1) } + @responses = responses&.map { FinchAPI::Converter.coerce(model, _1) } else end end diff --git a/test/finch-api/resources/hris/benefits/individuals_test.rb b/test/finch-api/resources/hris/benefits/individuals_test.rb index c38a05af..eab27de2 100644 --- a/test/finch-api/resources/hris/benefits/individuals_test.rb +++ b/test/finch-api/resources/hris/benefits/individuals_test.rb @@ -11,6 +11,8 @@ def test_enroll_many end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::Benefits::EnrolledIndividual end @@ -47,6 +49,8 @@ def test_retrieve_many_benefits end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::Benefits::IndividualBenefit end @@ -68,6 +72,8 @@ def test_unenroll_many end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::Benefits::UnenrolledIndividual end diff --git a/test/finch-api/resources/hris/benefits_test.rb b/test/finch-api/resources/hris/benefits_test.rb index ab07d369..2ab6ec42 100644 --- a/test/finch-api/resources/hris/benefits_test.rb +++ b/test/finch-api/resources/hris/benefits_test.rb @@ -56,6 +56,8 @@ def test_list end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::CompanyBenefit end @@ -78,6 +80,8 @@ def test_list_supported_benefits end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::SupportedBenefit end diff --git a/test/finch-api/resources/hris/directory_test.rb b/test/finch-api/resources/hris/directory_test.rb index 1e40cbe6..e463f67a 100644 --- a/test/finch-api/resources/hris/directory_test.rb +++ b/test/finch-api/resources/hris/directory_test.rb @@ -11,6 +11,8 @@ def test_list end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::IndividualInDirectory end @@ -36,6 +38,8 @@ def test_list_individuals end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::IndividualInDirectory end diff --git a/test/finch-api/resources/hris/employments_test.rb b/test/finch-api/resources/hris/employments_test.rb index a1355ca5..f207e5e6 100644 --- a/test/finch-api/resources/hris/employments_test.rb +++ b/test/finch-api/resources/hris/employments_test.rb @@ -11,6 +11,8 @@ def test_retrieve_many_required_params end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::EmploymentDataResponse end diff --git a/test/finch-api/resources/hris/individuals_test.rb b/test/finch-api/resources/hris/individuals_test.rb index 3a382ade..efc4a612 100644 --- a/test/finch-api/resources/hris/individuals_test.rb +++ b/test/finch-api/resources/hris/individuals_test.rb @@ -11,6 +11,8 @@ def test_retrieve_many end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::IndividualResponse end diff --git a/test/finch-api/resources/hris/pay_statements_test.rb b/test/finch-api/resources/hris/pay_statements_test.rb index 11920211..cfcc147c 100644 --- a/test/finch-api/resources/hris/pay_statements_test.rb +++ b/test/finch-api/resources/hris/pay_statements_test.rb @@ -11,6 +11,8 @@ def test_retrieve_many_required_params end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::PayStatementResponse end diff --git a/test/finch-api/resources/hris/payments_test.rb b/test/finch-api/resources/hris/payments_test.rb index 9462cc3b..7410f95d 100644 --- a/test/finch-api/resources/hris/payments_test.rb +++ b/test/finch-api/resources/hris/payments_test.rb @@ -11,6 +11,8 @@ def test_list_required_params end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::HRIS::Payment end diff --git a/test/finch-api/resources/payroll/pay_groups_test.rb b/test/finch-api/resources/payroll/pay_groups_test.rb index e1493647..c69b7544 100644 --- a/test/finch-api/resources/payroll/pay_groups_test.rb +++ b/test/finch-api/resources/payroll/pay_groups_test.rb @@ -28,6 +28,8 @@ def test_list end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::Payroll::PayGroupListResponse end diff --git a/test/finch-api/resources/providers_test.rb b/test/finch-api/resources/providers_test.rb index e754d341..13fa06b0 100644 --- a/test/finch-api/resources/providers_test.rb +++ b/test/finch-api/resources/providers_test.rb @@ -11,6 +11,8 @@ def test_list end row = response.to_enum.first + return if row.nil? + assert_pattern do row => FinchAPI::Models::Provider end From 47de6833d2762936d4dd2be7f21466c1a7f2d6b1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 20:13:03 +0000 Subject: [PATCH 63/67] chore: reduce verbosity in type declarations (#66) --- lib/finch-api.rb | 2 +- lib/finch-api/models/account_update_event.rb | 16 ++-- lib/finch-api/models/company_event.rb | 8 +- .../models/connect/session_new_params.rb | 24 +++--- .../connect/session_reauthenticate_params.rb | 8 +- .../models/connection_status_type.rb | 8 +- .../models/create_access_token_response.rb | 16 ++-- lib/finch-api/models/directory_event.rb | 8 +- lib/finch-api/models/employment_event.rb | 8 +- .../models/hris/benefit_contribution.rb | 8 +- .../hris/benefit_features_and_operations.rb | 24 +++--- .../models/hris/benefit_frequency.rb | 8 +- lib/finch-api/models/hris/benefit_type.rb | 8 +- .../hris/benefits/enrolled_individual.rb | 8 +- .../hris/benefits/individual_benefit.rb | 8 +- .../benefits/individual_enroll_many_params.rb | 24 +++--- lib/finch-api/models/hris/company.rb | 24 +++--- .../models/hris/document_list_params.rb | 8 +- .../models/hris/document_response.rb | 8 +- .../models/hris/document_retreive_response.rb | 6 +- lib/finch-api/models/hris/employment_data.rb | 24 +++--- lib/finch-api/models/hris/individual.rb | 32 +++----- lib/finch-api/models/hris/pay_statement.rb | 32 +++----- lib/finch-api/models/hris/payment.rb | 8 +- .../models/hris/supported_benefit.rb | 24 +++--- lib/finch-api/models/hris/w42005.rb | 24 +++--- lib/finch-api/models/hris/w42020.rb | 16 ++-- lib/finch-api/models/income.rb | 8 +- lib/finch-api/models/individual_event.rb | 8 +- lib/finch-api/models/introspection.rb | 24 +++--- lib/finch-api/models/job_completion_event.rb | 8 +- .../models/jobs/automated_async_job.rb | 16 ++-- .../models/jobs/automated_create_params.rb | 8 +- lib/finch-api/models/jobs/manual_async_job.rb | 8 +- lib/finch-api/models/operation_support.rb | 8 +- lib/finch-api/models/pay_statement_event.rb | 8 +- lib/finch-api/models/payment_event.rb | 8 +- .../models/payroll/pay_group_list_response.rb | 8 +- .../payroll/pay_group_retrieve_response.rb | 8 +- lib/finch-api/models/provider.rb | 8 +- .../models/sandbox/company_update_params.rb | 24 +++--- .../models/sandbox/company_update_response.rb | 24 +++--- .../sandbox/connection_create_params.rb | 8 +- .../sandbox/connection_create_response.rb | 8 +- .../connections/account_create_params.rb | 8 +- .../connections/account_create_response.rb | 8 +- .../connections/account_update_response.rb | 8 +- .../models/sandbox/directory_create_params.rb | 56 +++++-------- .../sandbox/employment_update_params.rb | 24 +++--- .../sandbox/employment_update_response.rb | 24 +++--- .../sandbox/individual_update_params.rb | 32 +++----- .../sandbox/individual_update_response.rb | 32 +++----- .../models/sandbox/job_create_params.rb | 8 +- .../sandbox/jobs/sandbox_job_configuration.rb | 16 ++-- .../models/sandbox/payment_create_params.rb | 32 +++----- lib/finch-api/models/webhook_event.rb | 6 +- .../finch-api/models/account_update_event.rbi | 18 ++--- rbi/lib/finch-api/models/company_event.rbi | 6 +- .../models/connect/session_new_params.rbi | 24 +++--- .../connect/session_reauthenticate_params.rbi | 6 +- .../models/connection_status_type.rbi | 6 +- .../models/create_access_token_response.rbi | 12 +-- rbi/lib/finch-api/models/directory_event.rbi | 6 +- rbi/lib/finch-api/models/employment_event.rbi | 6 +- .../models/hris/benefit_contribution.rbi | 6 +- .../hris/benefit_features_and_operations.rbi | 52 ++++++------ .../models/hris/benefit_frequency.rbi | 6 +- .../finch-api/models/hris/benefit_type.rbi | 6 +- .../hris/benefits/enrolled_individual.rbi | 6 +- .../hris/benefits/individual_benefit.rbi | 16 ++-- .../individual_enroll_many_params.rbi | 60 +++++++------- rbi/lib/finch-api/models/hris/company.rbi | 18 ++--- .../models/hris/document_list_params.rbi | 6 +- .../models/hris/document_response.rbi | 6 +- .../hris/document_retreive_response.rbi | 9 +-- .../finch-api/models/hris/employment_data.rbi | 18 ++--- rbi/lib/finch-api/models/hris/individual.rbi | 24 ++---- .../finch-api/models/hris/pay_statement.rbi | 24 ++---- rbi/lib/finch-api/models/hris/payment.rbi | 6 +- .../models/hris/supported_benefit.rbi | 18 ++--- rbi/lib/finch-api/models/hris/w42005.rbi | 18 ++--- rbi/lib/finch-api/models/hris/w42020.rbi | 12 +-- rbi/lib/finch-api/models/income.rbi | 6 +- rbi/lib/finch-api/models/individual_event.rbi | 6 +- rbi/lib/finch-api/models/introspection.rbi | 18 ++--- .../finch-api/models/job_completion_event.rbi | 6 +- .../models/jobs/automated_async_job.rbi | 12 +-- .../models/jobs/automated_create_params.rbi | 6 +- .../models/jobs/manual_async_job.rbi | 6 +- .../finch-api/models/operation_support.rbi | 6 +- .../finch-api/models/pay_statement_event.rbi | 6 +- rbi/lib/finch-api/models/payment_event.rbi | 6 +- .../payroll/pay_group_list_response.rbi | 6 +- .../payroll/pay_group_retrieve_response.rbi | 10 +-- rbi/lib/finch-api/models/provider.rbi | 6 +- .../models/sandbox/company_update_params.rbi | 24 +++--- .../sandbox/company_update_response.rbi | 28 +++---- .../sandbox/connection_create_params.rbi | 12 ++- .../sandbox/connection_create_response.rbi | 12 ++- .../connections/account_create_params.rbi | 16 ++-- .../connections/account_create_response.rbi | 16 ++-- .../connections/account_update_response.rbi | 16 ++-- .../sandbox/directory_create_params.rbi | 80 ++++++++----------- .../sandbox/employment_update_params.rbi | 36 ++++----- .../sandbox/employment_update_response.rbi | 36 ++++----- .../sandbox/individual_update_params.rbi | 30 +++---- .../sandbox/individual_update_response.rbi | 30 +++---- .../models/sandbox/job_create_params.rbi | 6 +- .../jobs/sandbox_job_configuration.rbi | 22 +++-- .../models/sandbox/payment_create_params.rbi | 56 ++++++------- rbi/lib/finch-api/models/webhook_event.rbi | 32 ++------ 111 files changed, 673 insertions(+), 1112 deletions(-) diff --git a/lib/finch-api.rb b/lib/finch-api.rb index 5f55e876..aca387c2 100644 --- a/lib/finch-api.rb +++ b/lib/finch-api.rb @@ -2,7 +2,7 @@ # We already ship the preferred sorbet manifests in the package itself. # `tapioca` currently does not offer us a way to opt out of unnecessary compilation. -if defined?(:Tapioca) && caller_locations.any? { _1.path.end_with?("tapioca/cli.rb") } +if Object.const_defined?(:Tapioca) && caller_locations.any? { _1.path.end_with?("tapioca/cli.rb") } Warning.warn( <<~WARN \n diff --git a/lib/finch-api/models/account_update_event.rb b/lib/finch-api/models/account_update_event.rb index 8497989f..a9f16bb9 100644 --- a/lib/finch-api/models/account_update_event.rb +++ b/lib/finch-api/models/account_update_event.rb @@ -1930,11 +1930,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end @@ -1946,11 +1944,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/company_event.rb b/lib/finch-api/models/company_event.rb index 0ad25215..c8f57e27 100644 --- a/lib/finch-api/models/company_event.rb +++ b/lib/finch-api/models/company_event.rb @@ -32,11 +32,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/connect/session_new_params.rb b/lib/finch-api/models/connect/session_new_params.rb index 40120ed4..8761f443 100644 --- a/lib/finch-api/models/connect/session_new_params.rb +++ b/lib/finch-api/models/connect/session_new_params.rb @@ -100,11 +100,9 @@ module Product finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Integration < FinchAPI::BaseModel @@ -138,11 +136,9 @@ module AuthMethod finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -154,11 +150,9 @@ module Sandbox finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/connect/session_reauthenticate_params.rb b/lib/finch-api/models/connect/session_reauthenticate_params.rb index cac5a2dd..51d90696 100644 --- a/lib/finch-api/models/connect/session_reauthenticate_params.rb +++ b/lib/finch-api/models/connect/session_reauthenticate_params.rb @@ -61,11 +61,9 @@ module Product finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/connection_status_type.rb b/lib/finch-api/models/connection_status_type.rb index 14cd8a52..60299526 100644 --- a/lib/finch-api/models/connection_status_type.rb +++ b/lib/finch-api/models/connection_status_type.rb @@ -14,11 +14,9 @@ module ConnectionStatusType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/create_access_token_response.rb b/lib/finch-api/models/create_access_token_response.rb index 44761ce1..b651790b 100644 --- a/lib/finch-api/models/create_access_token_response.rb +++ b/lib/finch-api/models/create_access_token_response.rb @@ -113,11 +113,9 @@ module ClientType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The type of the connection associated with the token. @@ -132,11 +130,9 @@ module ConnectionType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/directory_event.rb b/lib/finch-api/models/directory_event.rb index 27971458..5bb8ff07 100644 --- a/lib/finch-api/models/directory_event.rb +++ b/lib/finch-api/models/directory_event.rb @@ -57,11 +57,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/employment_event.rb b/lib/finch-api/models/employment_event.rb index 73e801f6..86f18c5f 100644 --- a/lib/finch-api/models/employment_event.rb +++ b/lib/finch-api/models/employment_event.rb @@ -57,11 +57,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_contribution.rb b/lib/finch-api/models/hris/benefit_contribution.rb index 3795f780..4c57ebe4 100644 --- a/lib/finch-api/models/hris/benefit_contribution.rb +++ b/lib/finch-api/models/hris/benefit_contribution.rb @@ -33,11 +33,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_features_and_operations.rb b/lib/finch-api/models/hris/benefit_features_and_operations.rb index 6bda696e..9d7f186d 100644 --- a/lib/finch-api/models/hris/benefit_features_and_operations.rb +++ b/lib/finch-api/models/hris/benefit_features_and_operations.rb @@ -132,11 +132,9 @@ module CompanyContribution finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end module EmployeeDeduction @@ -147,11 +145,9 @@ module EmployeeDeduction finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end module HsaContributionLimit @@ -162,11 +158,9 @@ module HsaContributionLimit finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_frequency.rb b/lib/finch-api/models/hris/benefit_frequency.rb index 923e8070..d882c80c 100644 --- a/lib/finch-api/models/hris/benefit_frequency.rb +++ b/lib/finch-api/models/hris/benefit_frequency.rb @@ -12,11 +12,9 @@ module BenefitFrequency finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefit_type.rb b/lib/finch-api/models/hris/benefit_type.rb index 16a46b65..b78cb3fa 100644 --- a/lib/finch-api/models/hris/benefit_type.rb +++ b/lib/finch-api/models/hris/benefit_type.rb @@ -29,11 +29,9 @@ module BenefitType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefits/enrolled_individual.rb b/lib/finch-api/models/hris/benefits/enrolled_individual.rb index a48e2467..b55a4731 100644 --- a/lib/finch-api/models/hris/benefits/enrolled_individual.rb +++ b/lib/finch-api/models/hris/benefits/enrolled_individual.rb @@ -82,11 +82,9 @@ module Code finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefits/individual_benefit.rb b/lib/finch-api/models/hris/benefits/individual_benefit.rb index f1d1b6ed..e6203e58 100644 --- a/lib/finch-api/models/hris/benefits/individual_benefit.rb +++ b/lib/finch-api/models/hris/benefits/individual_benefit.rb @@ -102,11 +102,9 @@ module HsaContributionLimit finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb index a662b57e..5e068387 100644 --- a/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb +++ b/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb @@ -136,11 +136,9 @@ module AnnualContributionLimit finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class CompanyContribution < FinchAPI::BaseModel @@ -181,11 +179,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -227,11 +223,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/company.rb b/lib/finch-api/models/hris/company.rb index 636d2239..94788671 100644 --- a/lib/finch-api/models/hris/company.rb +++ b/lib/finch-api/models/hris/company.rb @@ -139,11 +139,9 @@ module AccountType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -219,11 +217,9 @@ module Subtype finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The tax payer type of the company. @@ -240,11 +236,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/document_list_params.rb b/lib/finch-api/models/hris/document_list_params.rb index edfc91ac..2e077b06 100644 --- a/lib/finch-api/models/hris/document_list_params.rb +++ b/lib/finch-api/models/hris/document_list_params.rb @@ -69,11 +69,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/document_response.rb b/lib/finch-api/models/hris/document_response.rb index 6fc53ab1..bfafdc49 100644 --- a/lib/finch-api/models/hris/document_response.rb +++ b/lib/finch-api/models/hris/document_response.rb @@ -68,11 +68,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/document_retreive_response.rb b/lib/finch-api/models/hris/document_retreive_response.rb index 4c15ce9a..39e25456 100644 --- a/lib/finch-api/models/hris/document_retreive_response.rb +++ b/lib/finch-api/models/hris/document_retreive_response.rb @@ -17,10 +17,8 @@ module DocumentRetreiveResponse variant :w4_2005, -> { FinchAPI::Models::HRIS::W42005 } # @!parse - # class << self - # # @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)] - # def variants; end - # end + # # @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)] + # def self.variants; end end end end diff --git a/lib/finch-api/models/hris/employment_data.rb b/lib/finch-api/models/hris/employment_data.rb index 71e3ae05..b02e66f2 100644 --- a/lib/finch-api/models/hris/employment_data.rb +++ b/lib/finch-api/models/hris/employment_data.rb @@ -265,11 +265,9 @@ module Subtype finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The main employment type of the individual. @@ -281,11 +279,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -304,11 +300,9 @@ module EmploymentStatus finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/hris/individual.rb b/lib/finch-api/models/hris/individual.rb index 22048ae1..726ac4bd 100644 --- a/lib/finch-api/models/hris/individual.rb +++ b/lib/finch-api/models/hris/individual.rb @@ -156,11 +156,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -179,11 +177,9 @@ module Ethnicity finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The gender of the individual. @@ -197,11 +193,9 @@ module Gender finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class PhoneNumber < FinchAPI::BaseModel @@ -231,11 +225,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/pay_statement.rb b/lib/finch-api/models/hris/pay_statement.rb index 4e0f9685..95f66e65 100644 --- a/lib/finch-api/models/hris/pay_statement.rb +++ b/lib/finch-api/models/hris/pay_statement.rb @@ -211,11 +211,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -402,11 +400,9 @@ module PaymentMethod finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Tax < FinchAPI::BaseModel @@ -507,11 +503,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -525,11 +519,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/payment.rb b/lib/finch-api/models/hris/payment.rb index 13fdba6d..c79bc869 100644 --- a/lib/finch-api/models/hris/payment.rb +++ b/lib/finch-api/models/hris/payment.rb @@ -124,11 +124,9 @@ module PayFrequency finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class PayPeriod < FinchAPI::BaseModel diff --git a/lib/finch-api/models/hris/supported_benefit.rb b/lib/finch-api/models/hris/supported_benefit.rb index 6b5aa852..d8dfe58a 100644 --- a/lib/finch-api/models/hris/supported_benefit.rb +++ b/lib/finch-api/models/hris/supported_benefit.rb @@ -100,11 +100,9 @@ module CompanyContribution finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end module EmployeeDeduction @@ -115,11 +113,9 @@ module EmployeeDeduction finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end module HsaContributionLimit @@ -130,11 +126,9 @@ module HsaContributionLimit finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/w42005.rb b/lib/finch-api/models/hris/w42005.rb index 9ad03dad..042ac83b 100644 --- a/lib/finch-api/models/hris/w42005.rb +++ b/lib/finch-api/models/hris/w42005.rb @@ -116,11 +116,9 @@ module Exemption finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The individual's filing status for tax purposes. @@ -133,11 +131,9 @@ module FilingStatus finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -149,11 +145,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/hris/w42020.rb b/lib/finch-api/models/hris/w42020.rb index 5aaecd3d..41751295 100644 --- a/lib/finch-api/models/hris/w42020.rb +++ b/lib/finch-api/models/hris/w42020.rb @@ -135,11 +135,9 @@ module FilingStatus finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -151,11 +149,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/income.rb b/lib/finch-api/models/income.rb index 5ff70c23..647fc525 100644 --- a/lib/finch-api/models/income.rb +++ b/lib/finch-api/models/income.rb @@ -59,11 +59,9 @@ module Unit finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/individual_event.rb b/lib/finch-api/models/individual_event.rb index 523e9c31..b164e814 100644 --- a/lib/finch-api/models/individual_event.rb +++ b/lib/finch-api/models/individual_event.rb @@ -57,11 +57,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/introspection.rb b/lib/finch-api/models/introspection.rb index 7d66a2a3..3029b2b5 100644 --- a/lib/finch-api/models/introspection.rb +++ b/lib/finch-api/models/introspection.rb @@ -231,11 +231,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -249,11 +247,9 @@ module ClientType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class ConnectionStatus < FinchAPI::BaseModel @@ -296,11 +292,9 @@ module ConnectionType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/job_completion_event.rb b/lib/finch-api/models/job_completion_event.rb index 6e957750..56ded516 100644 --- a/lib/finch-api/models/job_completion_event.rb +++ b/lib/finch-api/models/job_completion_event.rb @@ -63,11 +63,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/jobs/automated_async_job.rb b/lib/finch-api/models/jobs/automated_async_job.rb index 4f74c873..3392d908 100644 --- a/lib/finch-api/models/jobs/automated_async_job.rb +++ b/lib/finch-api/models/jobs/automated_async_job.rb @@ -109,11 +109,9 @@ module Status finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The type of automated job @@ -125,11 +123,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/jobs/automated_create_params.rb b/lib/finch-api/models/jobs/automated_create_params.rb index ab0b94f7..a0993cab 100644 --- a/lib/finch-api/models/jobs/automated_create_params.rb +++ b/lib/finch-api/models/jobs/automated_create_params.rb @@ -36,11 +36,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Params < FinchAPI::BaseModel diff --git a/lib/finch-api/models/jobs/manual_async_job.rb b/lib/finch-api/models/jobs/manual_async_job.rb index 469f11a6..68508894 100644 --- a/lib/finch-api/models/jobs/manual_async_job.rb +++ b/lib/finch-api/models/jobs/manual_async_job.rb @@ -39,11 +39,9 @@ module Status finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/operation_support.rb b/lib/finch-api/models/operation_support.rb index f2d2407a..68cd639d 100644 --- a/lib/finch-api/models/operation_support.rb +++ b/lib/finch-api/models/operation_support.rb @@ -19,11 +19,9 @@ module OperationSupport finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/pay_statement_event.rb b/lib/finch-api/models/pay_statement_event.rb index 5d04867c..5bb1870d 100644 --- a/lib/finch-api/models/pay_statement_event.rb +++ b/lib/finch-api/models/pay_statement_event.rb @@ -68,11 +68,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/payment_event.rb b/lib/finch-api/models/payment_event.rb index a0247c9f..77738eec 100644 --- a/lib/finch-api/models/payment_event.rb +++ b/lib/finch-api/models/payment_event.rb @@ -60,11 +60,9 @@ module EventType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/payroll/pay_group_list_response.rb b/lib/finch-api/models/payroll/pay_group_list_response.rb index 4454ea01..7ae9e6f4 100644 --- a/lib/finch-api/models/payroll/pay_group_list_response.rb +++ b/lib/finch-api/models/payroll/pay_group_list_response.rb @@ -59,11 +59,9 @@ module PayFrequency finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb index 0d888ff3..f621e67c 100644 --- a/lib/finch-api/models/payroll/pay_group_retrieve_response.rb +++ b/lib/finch-api/models/payroll/pay_group_retrieve_response.rb @@ -53,11 +53,9 @@ module PayFrequency finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/provider.rb b/lib/finch-api/models/provider.rb index 17f5ca44..19c63704 100644 --- a/lib/finch-api/models/provider.rb +++ b/lib/finch-api/models/provider.rb @@ -2012,11 +2012,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/company_update_params.rb b/lib/finch-api/models/sandbox/company_update_params.rb index b44d3a85..fcffc5f7 100644 --- a/lib/finch-api/models/sandbox/company_update_params.rb +++ b/lib/finch-api/models/sandbox/company_update_params.rb @@ -141,11 +141,9 @@ module AccountType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -223,11 +221,9 @@ module Subtype finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The tax payer type of the company. @@ -244,11 +240,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/company_update_response.rb b/lib/finch-api/models/sandbox/company_update_response.rb index 734f466d..0766ddd7 100644 --- a/lib/finch-api/models/sandbox/company_update_response.rb +++ b/lib/finch-api/models/sandbox/company_update_response.rb @@ -123,11 +123,9 @@ module AccountType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -205,11 +203,9 @@ module Subtype finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The tax payer type of the company. @@ -226,11 +222,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connection_create_params.rb b/lib/finch-api/models/sandbox/connection_create_params.rb index df39f5a0..c0396eef 100644 --- a/lib/finch-api/models/sandbox/connection_create_params.rb +++ b/lib/finch-api/models/sandbox/connection_create_params.rb @@ -66,11 +66,9 @@ module AuthenticationType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connection_create_response.rb b/lib/finch-api/models/sandbox/connection_create_response.rb index 60c04a2d..149370cb 100644 --- a/lib/finch-api/models/sandbox/connection_create_response.rb +++ b/lib/finch-api/models/sandbox/connection_create_response.rb @@ -89,11 +89,9 @@ module AuthenticationType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_create_params.rb b/lib/finch-api/models/sandbox/connections/account_create_params.rb index 47af82b4..b241178d 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_params.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_params.rb @@ -62,11 +62,9 @@ module AuthenticationType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_create_response.rb b/lib/finch-api/models/sandbox/connections/account_create_response.rb index e51e68b7..5b4c6c23 100644 --- a/lib/finch-api/models/sandbox/connections/account_create_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_create_response.rb @@ -68,11 +68,9 @@ module AuthenticationType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/connections/account_update_response.rb b/lib/finch-api/models/sandbox/connections/account_update_response.rb index c662a7a7..204ee5fe 100644 --- a/lib/finch-api/models/sandbox/connections/account_update_response.rb +++ b/lib/finch-api/models/sandbox/connections/account_update_response.rb @@ -66,11 +66,9 @@ module AuthenticationType finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/directory_create_params.rb b/lib/finch-api/models/sandbox/directory_create_params.rb index 70eabc0e..35b607f4 100644 --- a/lib/finch-api/models/sandbox/directory_create_params.rb +++ b/lib/finch-api/models/sandbox/directory_create_params.rb @@ -350,11 +350,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -400,11 +398,9 @@ module Subtype finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The main employment type of the individual. @@ -416,11 +412,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -438,11 +432,9 @@ module EmploymentStatus finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The EEOC-defined ethnicity of the individual. @@ -460,11 +452,9 @@ module Ethnicity finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The gender of the individual. @@ -478,11 +468,9 @@ module Gender finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Manager < FinchAPI::BaseModel @@ -539,11 +527,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/employment_update_params.rb b/lib/finch-api/models/sandbox/employment_update_params.rb index 1ba6fe09..c9c07878 100644 --- a/lib/finch-api/models/sandbox/employment_update_params.rb +++ b/lib/finch-api/models/sandbox/employment_update_params.rb @@ -258,11 +258,9 @@ module Subtype finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The main employment type of the individual. @@ -274,11 +272,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -296,11 +292,9 @@ module EmploymentStatus finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/sandbox/employment_update_response.rb b/lib/finch-api/models/sandbox/employment_update_response.rb index b1363d47..03ec24b6 100644 --- a/lib/finch-api/models/sandbox/employment_update_response.rb +++ b/lib/finch-api/models/sandbox/employment_update_response.rb @@ -264,11 +264,9 @@ module Subtype finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The main employment type of the individual. @@ -280,11 +278,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -302,11 +298,9 @@ module EmploymentStatus finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Manager < FinchAPI::BaseModel diff --git a/lib/finch-api/models/sandbox/individual_update_params.rb b/lib/finch-api/models/sandbox/individual_update_params.rb index a3b45f98..509d8c4d 100644 --- a/lib/finch-api/models/sandbox/individual_update_params.rb +++ b/lib/finch-api/models/sandbox/individual_update_params.rb @@ -152,11 +152,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -175,11 +173,9 @@ module Ethnicity finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The gender of the individual. @@ -193,11 +189,9 @@ module Gender finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class PhoneNumber < FinchAPI::BaseModel @@ -233,11 +227,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/individual_update_response.rb b/lib/finch-api/models/sandbox/individual_update_response.rb index 9faac1eb..6e5e1984 100644 --- a/lib/finch-api/models/sandbox/individual_update_response.rb +++ b/lib/finch-api/models/sandbox/individual_update_response.rb @@ -160,11 +160,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -183,11 +181,9 @@ module Ethnicity finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end # The gender of the individual. @@ -201,11 +197,9 @@ module Gender finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class PhoneNumber < FinchAPI::BaseModel @@ -241,11 +235,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/job_create_params.rb b/lib/finch-api/models/sandbox/job_create_params.rb index cc17b434..de341449 100644 --- a/lib/finch-api/models/sandbox/job_create_params.rb +++ b/lib/finch-api/models/sandbox/job_create_params.rb @@ -30,11 +30,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb index 226b0e51..5e799f4f 100644 --- a/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb +++ b/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rb @@ -34,11 +34,9 @@ module CompletionStatus finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end module Type @@ -48,11 +46,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/sandbox/payment_create_params.rb b/lib/finch-api/models/sandbox/payment_create_params.rb index 0aeb3911..35306e20 100644 --- a/lib/finch-api/models/sandbox/payment_create_params.rb +++ b/lib/finch-api/models/sandbox/payment_create_params.rb @@ -263,11 +263,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -455,11 +453,9 @@ module PaymentMethod finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end class Tax < FinchAPI::BaseModel @@ -565,11 +561,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end @@ -583,11 +577,9 @@ module Type finalize! - class << self - # @!parse - # # @return [Array] - # def values; end - end + # @!parse + # # @return [Array] + # def self.values; end end end end diff --git a/lib/finch-api/models/webhook_event.rb b/lib/finch-api/models/webhook_event.rb index a8efe956..02b0b402 100644 --- a/lib/finch-api/models/webhook_event.rb +++ b/lib/finch-api/models/webhook_event.rb @@ -24,10 +24,8 @@ module WebhookEvent variant -> { FinchAPI::Models::PayStatementEvent } # @!parse - # class << self - # # @return [Array(FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent)] - # def variants; end - # end + # # @return [Array(FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent)] + # def self.variants; end end end end diff --git a/rbi/lib/finch-api/models/account_update_event.rbi b/rbi/lib/finch-api/models/account_update_event.rbi index f979b54c..ef218692 100644 --- a/rbi/lib/finch-api/models/account_update_event.rbi +++ b/rbi/lib/finch-api/models/account_update_event.rbi @@ -2339,13 +2339,11 @@ module FinchAPI OAUTH = T.let(:oauth, FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::AccountUpdateEvent::Data::AuthenticationMethod::Type::TaggedSymbol]) + end + def self.values end end end @@ -2360,10 +2358,8 @@ module FinchAPI ACCOUNT_UPDATED = T.let(:"account.updated", FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::AccountUpdateEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/company_event.rbi b/rbi/lib/finch-api/models/company_event.rbi index 55af18e3..5dc180c6 100644 --- a/rbi/lib/finch-api/models/company_event.rbi +++ b/rbi/lib/finch-api/models/company_event.rbi @@ -42,10 +42,8 @@ module FinchAPI COMPANY_UPDATED = T.let(:"company.updated", FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::CompanyEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/connect/session_new_params.rbi b/rbi/lib/finch-api/models/connect/session_new_params.rbi index 1c06ab3c..d87b295f 100644 --- a/rbi/lib/finch-api/models/connect/session_new_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_new_params.rbi @@ -110,10 +110,8 @@ module FinchAPI BENEFITS = T.let(:benefits, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Product::TaggedSymbol]) } + def self.values end end @@ -162,13 +160,11 @@ module FinchAPI API_TOKEN = T.let(:api_token, FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Integration::AuthMethod::TaggedSymbol]) + end + def self.values end end end @@ -183,10 +179,8 @@ module FinchAPI FINCH = T.let(:finch, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) PROVIDER = T.let(:provider, FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionNewParams::Sandbox::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi index b035d63f..f1306ba9 100644 --- a/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi +++ b/rbi/lib/finch-api/models/connect/session_reauthenticate_params.rbi @@ -75,10 +75,8 @@ module FinchAPI T.let(:benefits, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) SSN = T.let(:ssn, FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Connect::SessionReauthenticateParams::Product::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/connection_status_type.rbi b/rbi/lib/finch-api/models/connection_status_type.rbi index ae3fb4d1..672cd482 100644 --- a/rbi/lib/finch-api/models/connection_status_type.rbi +++ b/rbi/lib/finch-api/models/connection_status_type.rbi @@ -16,10 +16,8 @@ module FinchAPI ERROR_PERMISSIONS = T.let(:error_permissions, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) REAUTH = T.let(:reauth, FinchAPI::Models::ConnectionStatusType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::ConnectionStatusType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::ConnectionStatusType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/create_access_token_response.rbi b/rbi/lib/finch-api/models/create_access_token_response.rbi index 8a1ab90a..bfcc9759 100644 --- a/rbi/lib/finch-api/models/create_access_token_response.rbi +++ b/rbi/lib/finch-api/models/create_access_token_response.rbi @@ -113,10 +113,8 @@ module FinchAPI DEVELOPMENT = T.let(:development, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) SANDBOX = T.let(:sandbox, FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ClientType::TaggedSymbol]) } + def self.values end end @@ -135,10 +133,8 @@ module FinchAPI PROVIDER = T.let(:provider, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) FINCH = T.let(:finch, FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::CreateAccessTokenResponse::ConnectionType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/directory_event.rbi b/rbi/lib/finch-api/models/directory_event.rbi index abbc6fec..6854755f 100644 --- a/rbi/lib/finch-api/models/directory_event.rbi +++ b/rbi/lib/finch-api/models/directory_event.rbi @@ -67,10 +67,8 @@ module FinchAPI DIRECTORY_DELETED = T.let(:"directory.deleted", FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::DirectoryEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/employment_event.rbi b/rbi/lib/finch-api/models/employment_event.rbi index ca7cc789..3a6e3e7d 100644 --- a/rbi/lib/finch-api/models/employment_event.rbi +++ b/rbi/lib/finch-api/models/employment_event.rbi @@ -67,10 +67,8 @@ module FinchAPI EMPLOYMENT_DELETED = T.let(:"employment.deleted", FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::EmploymentEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi index 4ed09243..e946879e 100644 --- a/rbi/lib/finch-api/models/hris/benefit_contribution.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_contribution.rbi @@ -42,10 +42,8 @@ module FinchAPI FIXED = T.let(:fixed, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) PERCENT = T.let(:percent, FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitContribution::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi index 220048e2..45f38f6b 100644 --- a/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_features_and_operations.rbi @@ -215,15 +215,13 @@ module FinchAPI FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::CompanyContribution::TaggedSymbol] + ) + end + def self.values end end @@ -251,15 +249,13 @@ module FinchAPI FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::EmployeeDeduction::TaggedSymbol] + ) + end + def self.values end end @@ -289,17 +285,15 @@ module FinchAPI FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol - ] - ) - end - def values - end + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::BenefitFeaturesAndOperations::SupportedFeatures::HsaContributionLimit::TaggedSymbol + ] + ) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi index 427ee8b7..cfec91c8 100644 --- a/rbi/lib/finch-api/models/hris/benefit_frequency.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_frequency.rbi @@ -13,10 +13,8 @@ module FinchAPI EVERY_PAYCHECK = T.let(:every_paycheck, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol) MONTHLY = T.let(:monthly, FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitFrequency::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/benefit_type.rbi b/rbi/lib/finch-api/models/hris/benefit_type.rbi index 2c03081a..cd0e2c26 100644 --- a/rbi/lib/finch-api/models/hris/benefit_type.rbi +++ b/rbi/lib/finch-api/models/hris/benefit_type.rbi @@ -30,10 +30,8 @@ module FinchAPI CUSTOM_POST_TAX = T.let(:custom_post_tax, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) CUSTOM_PRE_TAX = T.let(:custom_pre_tax, FinchAPI::Models::HRIS::BenefitType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::BenefitType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi index 39ed96bb..965d62f4 100644 --- a/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/enrolled_individual.rbi @@ -98,10 +98,8 @@ module FinchAPI NOT_FOUND = T.let(404, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) FORBIDDEN = T.let(403, FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Benefits::EnrolledIndividual::Code::TaggedInteger]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi index 250086cf..c481e71e 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_benefit.rbi @@ -145,15 +145,13 @@ module FinchAPI FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::HRIS::Benefits::IndividualBenefit::Body::HsaContributionLimit::TaggedSymbol] + ) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi index 7b24df70..7a911dca 100644 --- a/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi +++ b/rbi/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rbi @@ -232,17 +232,15 @@ module FinchAPI FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol - ] - ) - end - def values - end + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::AnnualContributionLimit::TaggedSymbol + ] + ) + end + def self.values end end @@ -320,17 +318,15 @@ module FinchAPI FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol - ] - ) - end - def values - end + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::CompanyContribution::Type::TaggedSymbol + ] + ) + end + def self.values end end end @@ -409,17 +405,15 @@ module FinchAPI FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[ - FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol - ] - ) - end - def values - end + sig do + override + .returns( + T::Array[ + FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual::Configuration::EmployeeDeduction::Type::TaggedSymbol + ] + ) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/company.rbi b/rbi/lib/finch-api/models/hris/company.rbi index 40bbab48..1309816e 100644 --- a/rbi/lib/finch-api/models/hris/company.rbi +++ b/rbi/lib/finch-api/models/hris/company.rbi @@ -151,10 +151,8 @@ module FinchAPI CHECKING = T.let(:checking, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) SAVINGS = T.let(:savings, FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Account::AccountType::TaggedSymbol]) } + def self.values end end end @@ -255,10 +253,8 @@ module FinchAPI C_CORPORATION = T.let(:c_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) B_CORPORATION = T.let(:b_corporation, FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Subtype::TaggedSymbol]) } + def self.values end end @@ -279,10 +275,8 @@ module FinchAPI PARTNERSHIP = T.let(:partnership, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) COOPERATIVE = T.let(:cooperative, FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::HRISCompany::Entity::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/document_list_params.rbi b/rbi/lib/finch-api/models/hris/document_list_params.rbi index 4ae1c24b..1a0660bc 100644 --- a/rbi/lib/finch-api/models/hris/document_list_params.rbi +++ b/rbi/lib/finch-api/models/hris/document_list_params.rbi @@ -74,10 +74,8 @@ module FinchAPI W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentListParams::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/document_response.rbi b/rbi/lib/finch-api/models/hris/document_response.rbi index 0f301daa..431a3dba 100644 --- a/rbi/lib/finch-api/models/hris/document_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_response.rbi @@ -73,10 +73,8 @@ module FinchAPI W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::DocumentResponse::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi index 67a5c9da..478d82fc 100644 --- a/rbi/lib/finch-api/models/hris/document_retreive_response.rbi +++ b/rbi/lib/finch-api/models/hris/document_retreive_response.rbi @@ -8,13 +8,8 @@ module FinchAPI module DocumentRetreiveResponse extend FinchAPI::Union - Variants = - type_template(:out) { {fixed: T.any(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)} } - - class << self - sig { override.returns([FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]) } - def variants - end + sig { override.returns([FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]) } + def self.variants end end end diff --git a/rbi/lib/finch-api/models/hris/employment_data.rbi b/rbi/lib/finch-api/models/hris/employment_data.rbi index ecc14ce4..22e9c824 100644 --- a/rbi/lib/finch-api/models/hris/employment_data.rbi +++ b/rbi/lib/finch-api/models/hris/employment_data.rbi @@ -284,10 +284,8 @@ module FinchAPI INDIVIDUAL_CONTRACTOR = T.let(:individual_contractor, FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Subtype::TaggedSymbol]) } + def self.values end end @@ -302,10 +300,8 @@ module FinchAPI EMPLOYEE = T.let(:employee, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) CONTRACTOR = T.let(:contractor, FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::Employment::Type::TaggedSymbol]) } + def self.values end end end @@ -327,10 +323,8 @@ module FinchAPI RETIRED = T.let(:retired, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) TERMINATED = T.let(:terminated, FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::EmploymentData::EmploymentStatus::TaggedSymbol]) } + def self.values end end diff --git a/rbi/lib/finch-api/models/hris/individual.rbi b/rbi/lib/finch-api/models/hris/individual.rbi index ce2789b5..1a80d0df 100644 --- a/rbi/lib/finch-api/models/hris/individual.rbi +++ b/rbi/lib/finch-api/models/hris/individual.rbi @@ -156,10 +156,8 @@ module FinchAPI WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol) PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Email::Type::TaggedSymbol]) } + def self.values end end end @@ -186,10 +184,8 @@ module FinchAPI DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Ethnicity::TaggedSymbol]) } + def self.values end end @@ -205,10 +201,8 @@ module FinchAPI OTHER = T.let(:other, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::Gender::TaggedSymbol]) } + def self.values end end @@ -251,10 +245,8 @@ module FinchAPI WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::PhoneNumber::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/pay_statement.rbi b/rbi/lib/finch-api/models/hris/pay_statement.rbi index 7b927183..8c107cfa 100644 --- a/rbi/lib/finch-api/models/hris/pay_statement.rbi +++ b/rbi/lib/finch-api/models/hris/pay_statement.rbi @@ -236,10 +236,8 @@ module FinchAPI NUMBER_1099 = T.let(:"1099", FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Earning::Type::TaggedSymbol]) } + def self.values end end end @@ -491,10 +489,8 @@ module FinchAPI DIRECT_DEPOSIT = T.let(:direct_deposit, FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::PaymentMethod::TaggedSymbol]) } + def self.values end end @@ -617,10 +613,8 @@ module FinchAPI LOCAL = T.let(:local, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) FICA = T.let(:fica, FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Tax::Type::TaggedSymbol]) } + def self.values end end end @@ -636,10 +630,8 @@ module FinchAPI OFF_CYCLE_PAYROLL = T.let(:off_cycle_payroll, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) ONE_TIME_PAYMENT = T.let(:one_time_payment, FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::PayStatement::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/payment.rbi b/rbi/lib/finch-api/models/hris/payment.rbi index f7007887..eba3e803 100644 --- a/rbi/lib/finch-api/models/hris/payment.rbi +++ b/rbi/lib/finch-api/models/hris/payment.rbi @@ -140,10 +140,8 @@ module FinchAPI DAILY = T.let(:daily, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::Payment::PayFrequency::TaggedSymbol]) } + def self.values end end diff --git a/rbi/lib/finch-api/models/hris/supported_benefit.rbi b/rbi/lib/finch-api/models/hris/supported_benefit.rbi index 4e43b027..7afe8e13 100644 --- a/rbi/lib/finch-api/models/hris/supported_benefit.rbi +++ b/rbi/lib/finch-api/models/hris/supported_benefit.rbi @@ -116,10 +116,8 @@ module FinchAPI FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol]) } + def self.values end end @@ -134,10 +132,8 @@ module FinchAPI FIXED = T.let(:fixed, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) PERCENT = T.let(:percent, FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::EmployeeDeduction::TaggedSymbol]) } + def self.values end end @@ -153,10 +149,8 @@ module FinchAPI T.let(:individual, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) FAMILY = T.let(:family, FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::SupportedBenefit::HsaContributionLimit::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 67a6852c..85072ea4 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -123,10 +123,8 @@ module FinchAPI EXEMPT = T.let(:exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) NON_EXEMPT = T.let(:non_exempt, FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol]) } + def self.values end end @@ -146,10 +144,8 @@ module FinchAPI ) SINGLE = T.let(:single, FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol]) } + def self.values end end end @@ -163,10 +159,8 @@ module FinchAPI W4_2005 = T.let(:w4_2005, FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42005::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/hris/w42020.rbi b/rbi/lib/finch-api/models/hris/w42020.rbi index eb075137..f8852091 100644 --- a/rbi/lib/finch-api/models/hris/w42020.rbi +++ b/rbi/lib/finch-api/models/hris/w42020.rbi @@ -150,10 +150,8 @@ module FinchAPI FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol ) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Data::FilingStatus::TaggedSymbol]) } + def self.values end end end @@ -167,10 +165,8 @@ module FinchAPI W4_2020 = T.let(:w4_2020, FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::HRIS::W42020::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/income.rbi b/rbi/lib/finch-api/models/income.rbi index 82e845a0..667a7e62 100644 --- a/rbi/lib/finch-api/models/income.rbi +++ b/rbi/lib/finch-api/models/income.rbi @@ -67,10 +67,8 @@ module FinchAPI HOURLY = T.let(:hourly, FinchAPI::Models::Income::Unit::TaggedSymbol) FIXED = T.let(:fixed, FinchAPI::Models::Income::Unit::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Income::Unit::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Income::Unit::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/individual_event.rbi b/rbi/lib/finch-api/models/individual_event.rbi index a6c5be02..2a8dc066 100644 --- a/rbi/lib/finch-api/models/individual_event.rbi +++ b/rbi/lib/finch-api/models/individual_event.rbi @@ -67,10 +67,8 @@ module FinchAPI INDIVIDUAL_DELETED = T.let(:"individual.deleted", FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::IndividualEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/introspection.rbi b/rbi/lib/finch-api/models/introspection.rbi index 647b979e..dd5311c6 100644 --- a/rbi/lib/finch-api/models/introspection.rbi +++ b/rbi/lib/finch-api/models/introspection.rbi @@ -242,10 +242,8 @@ module FinchAPI T.let(:api_credential, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) OAUTH = T.let(:oauth, FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Introspection::AuthenticationMethod::Type::TaggedSymbol]) } + def self.values end end end @@ -261,10 +259,8 @@ module FinchAPI DEVELOPMENT = T.let(:development, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) SANDBOX = T.let(:sandbox, FinchAPI::Models::Introspection::ClientType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Introspection::ClientType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Introspection::ClientType::TaggedSymbol]) } + def self.values end end @@ -305,10 +301,8 @@ module FinchAPI PROVIDER = T.let(:provider, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) FINCH = T.let(:finch, FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Introspection::ConnectionType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/job_completion_event.rbi b/rbi/lib/finch-api/models/job_completion_event.rbi index bb7a2ba7..dff4174b 100644 --- a/rbi/lib/finch-api/models/job_completion_event.rbi +++ b/rbi/lib/finch-api/models/job_completion_event.rbi @@ -74,10 +74,8 @@ module FinchAPI JOB_DATA_SYNC_ALL_COMPLETED = T.let(:"job.data_sync_all.completed", FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::JobCompletionEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi index 7b54ec62..f07be912 100644 --- a/rbi/lib/finch-api/models/jobs/automated_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_async_job.rbi @@ -120,10 +120,8 @@ module FinchAPI PERMISSIONS_ERROR = T.let(:permissions_error, FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Status::TaggedSymbol]) } + def self.values end end @@ -138,10 +136,8 @@ module FinchAPI W4_FORM_EMPLOYEE_SYNC = T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedAsyncJob::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi index d35cabc0..eb10d8e7 100644 --- a/rbi/lib/finch-api/models/jobs/automated_create_params.rbi +++ b/rbi/lib/finch-api/models/jobs/automated_create_params.rbi @@ -52,10 +52,8 @@ module FinchAPI W4_FORM_EMPLOYEE_SYNC = T.let(:w4_form_employee_sync, FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Jobs::AutomatedCreateParams::Type::TaggedSymbol]) } + def self.values end end diff --git a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi index 95675245..67d1d5ee 100644 --- a/rbi/lib/finch-api/models/jobs/manual_async_job.rbi +++ b/rbi/lib/finch-api/models/jobs/manual_async_job.rbi @@ -49,10 +49,8 @@ module FinchAPI ERROR = T.let(:error, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) COMPLETE = T.let(:complete, FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Jobs::ManualAsyncJob::Status::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/operation_support.rbi b/rbi/lib/finch-api/models/operation_support.rbi index 2fd5096a..6cb9ccc4 100644 --- a/rbi/lib/finch-api/models/operation_support.rbi +++ b/rbi/lib/finch-api/models/operation_support.rbi @@ -21,10 +21,8 @@ module FinchAPI T.let(:not_supported_by_provider, FinchAPI::Models::OperationSupport::TaggedSymbol) CLIENT_ACCESS_ONLY = T.let(:client_access_only, FinchAPI::Models::OperationSupport::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::OperationSupport::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::OperationSupport::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/pay_statement_event.rbi b/rbi/lib/finch-api/models/pay_statement_event.rbi index 32acea05..db6f59f3 100644 --- a/rbi/lib/finch-api/models/pay_statement_event.rbi +++ b/rbi/lib/finch-api/models/pay_statement_event.rbi @@ -74,10 +74,8 @@ module FinchAPI PAY_STATEMENT_DELETED = T.let(:"pay_statement.deleted", FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::PayStatementEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/payment_event.rbi b/rbi/lib/finch-api/models/payment_event.rbi index 583aa3c6..6937f19a 100644 --- a/rbi/lib/finch-api/models/payment_event.rbi +++ b/rbi/lib/finch-api/models/payment_event.rbi @@ -65,10 +65,8 @@ module FinchAPI PAYMENT_UPDATED = T.let(:"payment.updated", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) PAYMENT_DELETED = T.let(:"payment.deleted", FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::PaymentEvent::EventType::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi index 46de2961..8eea3178 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_list_response.rbi @@ -74,10 +74,8 @@ module FinchAPI DAILY = T.let(:daily, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupListResponse::PayFrequency::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi index 22573599..8d529f59 100644 --- a/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi +++ b/rbi/lib/finch-api/models/payroll/pay_group_retrieve_response.rbi @@ -69,12 +69,10 @@ module FinchAPI DAILY = T.let(:daily, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) OTHER = T.let(:other, FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol) - class << self - sig do - override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) - end - def values - end + sig do + override.returns(T::Array[FinchAPI::Models::Payroll::PayGroupRetrieveResponse::PayFrequency::TaggedSymbol]) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/provider.rbi b/rbi/lib/finch-api/models/provider.rbi index 89da6bce..483d1529 100644 --- a/rbi/lib/finch-api/models/provider.rbi +++ b/rbi/lib/finch-api/models/provider.rbi @@ -2268,10 +2268,8 @@ module FinchAPI T.let(:api_credential, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) OAUTH = T.let(:oauth, FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Provider::AuthenticationMethod::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi index 6cb1f6f2..cd28482e 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_params.rbi @@ -160,13 +160,11 @@ module FinchAPI SAVINGS = T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol]) + end + def self.values end end end @@ -278,10 +276,8 @@ module FinchAPI B_CORPORATION = T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol]) } + def self.values end end @@ -307,10 +303,8 @@ module FinchAPI COOPERATIVE = T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi index b0f56f73..e5f7c40c 100644 --- a/rbi/lib/finch-api/models/sandbox/company_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/company_update_response.rbi @@ -145,13 +145,11 @@ module FinchAPI SAVINGS = T.let(:savings, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Account::AccountType::TaggedSymbol]) + end + def self.values end end end @@ -263,12 +261,10 @@ module FinchAPI B_CORPORATION = T.let(:b_corporation, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol) - class << self - sig do - override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol]) - end - def values - end + sig do + override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Subtype::TaggedSymbol]) + end + def self.values end end @@ -294,10 +290,8 @@ module FinchAPI COOPERATIVE = T.let(:cooperative, FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::CompanyUpdateResponse::Entity::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi index 323c0022..46d30729 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_params.rbi @@ -82,13 +82,11 @@ module FinchAPI ASSISTED = T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType::TaggedSymbol]) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi index 074e58ff..a05ba85a 100644 --- a/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connection_create_response.rbi @@ -95,13 +95,11 @@ module FinchAPI ASSISTED = T.let(:assisted, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol]) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi index f4edb194..60c89844 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_params.rbi @@ -100,15 +100,13 @@ module FinchAPI FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType::TaggedSymbol] + ) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi index 1a3564c3..abd032b9 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_create_response.rbi @@ -96,15 +96,13 @@ module FinchAPI FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol] + ) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi index 6c960431..541cdff4 100644 --- a/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/connections/account_update_response.rbi @@ -94,15 +94,13 @@ module FinchAPI FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol] + ) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi index 3347efb7..f5ea7ad9 100644 --- a/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/directory_create_params.rbi @@ -391,13 +391,11 @@ module FinchAPI PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Email::Type::TaggedSymbol]) + end + def self.values end end end @@ -470,15 +468,13 @@ module FinchAPI FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Subtype::TaggedSymbol] + ) + end + def self.values end end @@ -496,13 +492,11 @@ module FinchAPI CONTRACTOR = T.let(:contractor, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment::Type::TaggedSymbol]) + end + def self.values end end end @@ -531,13 +525,11 @@ module FinchAPI TERMINATED = T.let(:terminated, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus::TaggedSymbol]) + end + def self.values end end @@ -580,12 +572,10 @@ module FinchAPI FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol ) - class << self - sig do - override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol]) - end - def values - end + sig do + override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Ethnicity::TaggedSymbol]) + end + def self.values end end @@ -604,10 +594,8 @@ module FinchAPI DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender::TaggedSymbol]) } + def self.values end end @@ -674,13 +662,11 @@ module FinchAPI PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type::TaggedSymbol]) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi index 070386fa..e5ea2b98 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi @@ -288,13 +288,11 @@ module FinchAPI FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol ) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol]) + end + def self.values end end @@ -312,13 +310,11 @@ module FinchAPI CONTRACTOR = T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol]) + end + def self.values end end end @@ -346,13 +342,11 @@ module FinchAPI TERMINATED = T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol]) + end + def self.values end end diff --git a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi index 6b13137a..9e2859e2 100644 --- a/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/employment_update_response.rbi @@ -293,13 +293,11 @@ module FinchAPI FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol ) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype::TaggedSymbol]) + end + def self.values end end @@ -317,13 +315,11 @@ module FinchAPI CONTRACTOR = T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type::TaggedSymbol]) + end + def self.values end end end @@ -352,13 +348,11 @@ module FinchAPI TERMINATED = T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus::TaggedSymbol]) + end + def self.values end end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi index 20c72e9b..ce15721f 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_params.rbi @@ -161,10 +161,8 @@ module FinchAPI WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email::Type::TaggedSymbol]) } + def self.values end end end @@ -202,10 +200,8 @@ module FinchAPI DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::TaggedSymbol]) } + def self.values end end @@ -223,10 +219,8 @@ module FinchAPI DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::TaggedSymbol]) } + def self.values end end @@ -274,13 +268,11 @@ module FinchAPI PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type::TaggedSymbol]) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi index 4641647e..b369f2f0 100644 --- a/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi +++ b/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi @@ -173,10 +173,8 @@ module FinchAPI PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol]) } + def self.values end end end @@ -214,10 +212,8 @@ module FinchAPI DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol]) } + def self.values end end @@ -236,10 +232,8 @@ module FinchAPI DECLINE_TO_SPECIFY = T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol]) } + def self.values end end @@ -287,13 +281,11 @@ module FinchAPI PERSONAL = T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol]) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi index 0adca813..8db17e55 100644 --- a/rbi/lib/finch-api/models/sandbox/job_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/job_create_params.rbi @@ -39,10 +39,8 @@ module FinchAPI DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi index 8da49d3a..1a526172 100644 --- a/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi +++ b/rbi/lib/finch-api/models/sandbox/jobs/sandbox_job_configuration.rbi @@ -56,15 +56,13 @@ module FinchAPI ERROR = T.let(:error, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol] + ) + end + def self.values end end @@ -79,10 +77,8 @@ module FinchAPI DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) - class << self - sig { override.returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol]) } - def values - end + sig { override.returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol]) } + def self.values end end end diff --git a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi index 4a2c88e9..4bce37f4 100644 --- a/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi +++ b/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi @@ -386,15 +386,13 @@ module FinchAPI OTHER = T.let(:other, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Earning::Type::TaggedSymbol] + ) + end + def self.values end end end @@ -692,15 +690,13 @@ module FinchAPI FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol ) - class << self - sig do - override - .returns( - T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol] - ) - end - def values - end + sig do + override + .returns( + T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::PaymentMethod::TaggedSymbol] + ) + end + def self.values end end @@ -854,13 +850,11 @@ module FinchAPI FICA = T.let(:fica, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Tax::Type::TaggedSymbol]) + end + def self.values end end end @@ -884,13 +878,11 @@ module FinchAPI ONE_TIME_PAYMENT = T.let(:one_time_payment, FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol) - class << self - sig do - override - .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol]) - end - def values - end + sig do + override + .returns(T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement::Type::TaggedSymbol]) + end + def self.values end end end diff --git a/rbi/lib/finch-api/models/webhook_event.rbi b/rbi/lib/finch-api/models/webhook_event.rbi index 51b1e7fb..4a20469c 100644 --- a/rbi/lib/finch-api/models/webhook_event.rbi +++ b/rbi/lib/finch-api/models/webhook_event.rbi @@ -5,31 +5,13 @@ module FinchAPI module WebhookEvent extend FinchAPI::Union - Variants = - type_template(:out) do - { - fixed: T.any( - FinchAPI::Models::AccountUpdateEvent, - FinchAPI::Models::CompanyEvent, - FinchAPI::Models::JobCompletionEvent, - FinchAPI::Models::DirectoryEvent, - FinchAPI::Models::EmploymentEvent, - FinchAPI::Models::IndividualEvent, - FinchAPI::Models::PaymentEvent, - FinchAPI::Models::PayStatementEvent - ) - } - end - - class << self - sig do - override - .returns( - [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] - ) - end - def variants - end + sig do + override + .returns( + [FinchAPI::Models::AccountUpdateEvent, FinchAPI::Models::CompanyEvent, FinchAPI::Models::JobCompletionEvent, FinchAPI::Models::DirectoryEvent, FinchAPI::Models::EmploymentEvent, FinchAPI::Models::IndividualEvent, FinchAPI::Models::PaymentEvent, FinchAPI::Models::PayStatementEvent] + ) + end + def self.variants end end end From 1d98cb0aabcaa378bc08b87e54ae9bdb476d077e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 22:08:11 +0000 Subject: [PATCH 64/67] chore: disable dangerous rubocop auto correct rule (#67) --- .rubocop.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.rubocop.yml b/.rubocop.yml index 1eec67fd..b5329c39 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -84,6 +84,12 @@ Lint/MissingSuper: Lint/UnusedMethodArgument: AutoCorrect: false +# This option is prone to causing accidental bugs. +Lint/UselessAssignment: + AutoCorrect: false + Exclude: + - "examples/**/*.rb" + Metrics/AbcSize: Enabled: false From 7af6e913d4c8acbac489d14d33ed3df443e9fd7e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 24 Mar 2025 16:32:39 +0000 Subject: [PATCH 65/67] chore: more readable output when tests fail (#68) --- Rakefile | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/Rakefile b/Rakefile index f3763943..d1a3eb10 100644 --- a/Rakefile +++ b/Rakefile @@ -1,20 +1,25 @@ # frozen_string_literal: true +require "securerandom" +require "shellwords" + require "minitest/test_task" require "rake/clean" require "rubocop/rake_task" -require "securerandom" -require "shellwords" CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/]) xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --] -task(default: [:test, :format]) +task(default: [:test]) + +multitask(:test) do + rb = + FileList[ENV.fetch("TEST", "./test/**/*_test.rb")] + .map { "require_relative(#{_1.dump});" } + .join -Minitest::TestTask.create do |t| - t.libs = %w[.] - t.test_globs = ENV.fetch("TEST", "./test/**/*_test.rb") + ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 } end RuboCop::RakeTask.new(:rubocop) do |t| From 1374a6ea4304b03f6ba6a7874ad920baf86d2f6c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 25 Mar 2025 16:26:07 +0000 Subject: [PATCH 66/67] feat(api): api update (#69) --- .stats.yml | 2 +- lib/finch-api/models/hris/w42005.rb | 10 +++------- lib/finch-api/resources/hris/documents.rb | 8 ++++---- rbi/lib/finch-api/models/hris/w42005.rbi | 9 +++------ rbi/lib/finch-api/resources/hris/documents.rbi | 8 ++++---- sig/finch-api/models/hris/w42005.rbs | 10 +++------- test/finch-api/resources/sandbox/company_test.rb | 2 +- 7 files changed, 19 insertions(+), 30 deletions(-) diff --git a/.stats.yml b/.stats.yml index 424dc58b..fc279b3c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 41 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-f1779210fbedfc6099076412405288b489f727cbb0b3a85e7b7c12fabb37ef47.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-69819ddc6d03624ee8d880317fca03afab50a0a843218f1d9f14616e8a003dad.yml diff --git a/lib/finch-api/models/hris/w42005.rb b/lib/finch-api/models/hris/w42005.rb index 042ac83b..8f0ac8b1 100644 --- a/lib/finch-api/models/hris/w42005.rb +++ b/lib/finch-api/models/hris/w42005.rb @@ -59,15 +59,11 @@ class Data < FinchAPI::BaseModel # # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption] # attr_writer :exemption - # @!attribute [r] filing_status + # @!attribute filing_status # The individual's filing status for tax purposes. # # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil] - optional :filing_status, enum: -> { FinchAPI::Models::HRIS::W42005::Data::FilingStatus } - - # @!parse - # # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus] - # attr_writer :filing_status + optional :filing_status, enum: -> { FinchAPI::Models::HRIS::W42005::Data::FilingStatus }, nil?: true # @!attribute [r] individual_id # The unique identifier for the individual associated with this 2005 W4 form. @@ -90,7 +86,7 @@ class Data < FinchAPI::BaseModel # # # # @param additional_withholding [Integer, nil] # # @param exemption [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption] - # # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus] + # # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil] # # @param individual_id [String] # # @param total_number_of_allowances [Integer, nil] # # diff --git a/lib/finch-api/resources/hris/documents.rb b/lib/finch-api/resources/hris/documents.rb index 7ddc6506..996c99db 100644 --- a/lib/finch-api/resources/hris/documents.rb +++ b/lib/finch-api/resources/hris/documents.rb @@ -4,8 +4,8 @@ module FinchAPI module Resources class HRIS class Documents - # **Beta:** This endpoint is in beta and may change. - # Retrieve a list of company-wide documents. + # **Beta:** This endpoint is in beta and may change. Retrieve a list of + # company-wide documents. # # @param params [FinchAPI::Models::HRIS::DocumentListParams, Hash{Symbol=>Object}] . # @@ -33,8 +33,8 @@ def list(params = {}) ) end - # **Beta:** This endpoint is in beta and may change. - # Retrieve details of a specific document by its ID. + # **Beta:** This endpoint is in beta and may change. Retrieve details of a + # specific document by its ID. # # @param document_id [String] The unique identifier of the document. # diff --git a/rbi/lib/finch-api/models/hris/w42005.rbi b/rbi/lib/finch-api/models/hris/w42005.rbi index 85072ea4..78380257 100644 --- a/rbi/lib/finch-api/models/hris/w42005.rbi +++ b/rbi/lib/finch-api/models/hris/w42005.rbi @@ -62,10 +62,7 @@ module FinchAPI # The individual's filing status for tax purposes. sig { returns(T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol)) } - attr_reader :filing_status - - sig { params(filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol).void } - attr_writer :filing_status + attr_accessor :filing_status # The unique identifier for the individual associated with this 2005 W4 form. sig { returns(T.nilable(String)) } @@ -83,7 +80,7 @@ module FinchAPI params( additional_withholding: T.nilable(Integer), exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::OrSymbol, - filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol, + filing_status: T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::OrSymbol), individual_id: String, total_number_of_allowances: T.nilable(Integer) ) @@ -104,7 +101,7 @@ module FinchAPI { additional_withholding: T.nilable(Integer), exemption: FinchAPI::Models::HRIS::W42005::Data::Exemption::TaggedSymbol, - filing_status: FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol, + filing_status: T.nilable(FinchAPI::Models::HRIS::W42005::Data::FilingStatus::TaggedSymbol), individual_id: String, total_number_of_allowances: T.nilable(Integer) } diff --git a/rbi/lib/finch-api/resources/hris/documents.rbi b/rbi/lib/finch-api/resources/hris/documents.rbi index 358028a3..3dc10bc1 100644 --- a/rbi/lib/finch-api/resources/hris/documents.rbi +++ b/rbi/lib/finch-api/resources/hris/documents.rbi @@ -4,8 +4,8 @@ module FinchAPI module Resources class HRIS class Documents - # **Beta:** This endpoint is in beta and may change. - # Retrieve a list of company-wide documents. + # **Beta:** This endpoint is in beta and may change. Retrieve a list of + # company-wide documents. sig do params( individual_ids: T::Array[String], @@ -31,8 +31,8 @@ module FinchAPI ) end - # **Beta:** This endpoint is in beta and may change. - # Retrieve details of a specific document by its ID. + # **Beta:** This endpoint is in beta and may change. Retrieve details of a + # specific document by its ID. sig do params( document_id: String, diff --git a/sig/finch-api/models/hris/w42005.rbs b/sig/finch-api/models/hris/w42005.rbs index 8259c4d9..4b60d8eb 100644 --- a/sig/finch-api/models/hris/w42005.rbs +++ b/sig/finch-api/models/hris/w42005.rbs @@ -35,7 +35,7 @@ module FinchAPI { additional_withholding: Integer?, exemption: FinchAPI::Models::HRIS::W42005::Data::exemption, - filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status, + filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?, individual_id: String, total_number_of_allowances: Integer? } @@ -49,11 +49,7 @@ module FinchAPI FinchAPI::Models::HRIS::W42005::Data::exemption ) -> FinchAPI::Models::HRIS::W42005::Data::exemption - attr_reader filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status? - - def filing_status=: ( - FinchAPI::Models::HRIS::W42005::Data::filing_status - ) -> FinchAPI::Models::HRIS::W42005::Data::filing_status + attr_accessor filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status? attr_reader individual_id: String? @@ -64,7 +60,7 @@ module FinchAPI def initialize: ( ?additional_withholding: Integer?, ?exemption: FinchAPI::Models::HRIS::W42005::Data::exemption, - ?filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status, + ?filing_status: FinchAPI::Models::HRIS::W42005::Data::filing_status?, ?individual_id: String, ?total_number_of_allowances: Integer? ) -> void diff --git a/test/finch-api/resources/sandbox/company_test.rb b/test/finch-api/resources/sandbox/company_test.rb index cc9980ef..40bd3dfe 100644 --- a/test/finch-api/resources/sandbox/company_test.rb +++ b/test/finch-api/resources/sandbox/company_test.rb @@ -12,7 +12,7 @@ def test_update_required_params entity: {}, legal_name: "legal_name", locations: [{}], - primary_email: "primary_email", + primary_email: "dev@stainless.com", primary_phone_number: "primary_phone_number" ) From b1b1642657f606dd913b0bb4e53b0377b0f238de Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 25 Mar 2025 16:26:47 +0000 Subject: [PATCH 67/67] release: 0.1.0-alpha.2 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 85 +++++++++++++++++++++++++++++++++++ Gemfile.lock | 2 +- lib/finch-api/version.rb | 2 +- rbi/lib/finch-api/version.rbi | 2 +- 5 files changed, 89 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index ba6c3483..f14b480a 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.1" + ".": "0.1.0-alpha.2" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index a59f455e..33f0ec9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,90 @@ # Changelog +## 0.1.0-alpha.2 (2025-03-25) + +Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.1...v0.1.0-alpha.2) + +### ⚠ BREAKING CHANGES + +* use tagged enums in sorbet type definitions ([#57](https://github.com/Finch-API/finch-api-ruby/issues/57)) +* support `for item in stream` style iteration on `Stream`s ([#55](https://github.com/Finch-API/finch-api-ruby/issues/55)) +* **model:** base model should recursively store coerced base models ([#44](https://github.com/Finch-API/finch-api-ruby/issues/44)) + +### Features + +* add jsonl support ([#10](https://github.com/Finch-API/finch-api-ruby/issues/10)) ([74f6a63](https://github.com/Finch-API/finch-api-ruby/commit/74f6a630c57dfbc065fe3dccc20d2a0912241e58)) +* add SKIP_BREW env var to ./scripts/bootstrap ([#14](https://github.com/Finch-API/finch-api-ruby/issues/14)) ([6d5ad33](https://github.com/Finch-API/finch-api-ruby/commit/6d5ad336c49d7492c9a1382cd0eb6e4938a9630d)) +* **api:** api update ([#69](https://github.com/Finch-API/finch-api-ruby/issues/69)) ([1374a6e](https://github.com/Finch-API/finch-api-ruby/commit/1374a6ea4304b03f6ba6a7874ad920baf86d2f6c)) +* consistently accept `AnyHash` types in parameter positions in sorbet ([#62](https://github.com/Finch-API/finch-api-ruby/issues/62)) ([8a5cbf7](https://github.com/Finch-API/finch-api-ruby/commit/8a5cbf70086cb9b903b8b54594995332fdf12a29)) +* prevent tapioca from introspecting the gem internals ([#61](https://github.com/Finch-API/finch-api-ruby/issues/61)) ([a7e45cc](https://github.com/Finch-API/finch-api-ruby/commit/a7e45cc2a440752eba32881faeb37b3192634ce7)) +* support `for item in stream` style iteration on `Stream`s ([#55](https://github.com/Finch-API/finch-api-ruby/issues/55)) ([c59a90c](https://github.com/Finch-API/finch-api-ruby/commit/c59a90c57b184e478192f899a6c2f0b10395f548)) +* support client level methods ([#18](https://github.com/Finch-API/finch-api-ruby/issues/18)) ([92bf05c](https://github.com/Finch-API/finch-api-ruby/commit/92bf05cf13896ff88e36de59a7c780835686f75f)) +* support jsonl uploads ([#32](https://github.com/Finch-API/finch-api-ruby/issues/32)) ([fd8bb80](https://github.com/Finch-API/finch-api-ruby/commit/fd8bb80dd8174a3da2e715313e5348b6ad61e75f)) +* support streaming uploads ([#25](https://github.com/Finch-API/finch-api-ruby/issues/25)) ([5adeadb](https://github.com/Finch-API/finch-api-ruby/commit/5adeadbe7a0cbeb213d9a37cebe6b8c04288c98a)) +* use tagged enums in sorbet type definitions ([#57](https://github.com/Finch-API/finch-api-ruby/issues/57)) ([6956ce9](https://github.com/Finch-API/finch-api-ruby/commit/6956ce97a9b6d7298bc8264914cd0c121d5a3400)) + + +### Bug Fixes + +* bad documentation url for gemdocs.org ([#43](https://github.com/Finch-API/finch-api-ruby/issues/43)) ([10c313f](https://github.com/Finch-API/finch-api-ruby/commit/10c313ffd786e8640c6dfb1665664157ea9a32a9)) +* enums should only coerce matching symbols into strings ([#26](https://github.com/Finch-API/finch-api-ruby/issues/26)) ([d0260a3](https://github.com/Finch-API/finch-api-ruby/commit/d0260a33499410c0e267b01b8583d2d072b7ae61)) +* label optional keyword arguments in *.rbs type definitions ([#53](https://github.com/Finch-API/finch-api-ruby/issues/53)) ([66ba596](https://github.com/Finch-API/finch-api-ruby/commit/66ba5968ed917bc848cb3cb79223cb3f0eb5489a)) +* **model:** base model should recursively store coerced base models ([#44](https://github.com/Finch-API/finch-api-ruby/issues/44)) ([5b67ef6](https://github.com/Finch-API/finch-api-ruby/commit/5b67ef6d68c5d9729c5e1b44dd2b00a05a987342)) +* pages should be able to accept non-converter models ([#65](https://github.com/Finch-API/finch-api-ruby/issues/65)) ([1927323](https://github.com/Finch-API/finch-api-ruby/commit/1927323200a74179fde0a73a976eeea2096b1969)) +* rectify a mistake where wrong lines were chosen during rebase ([#19](https://github.com/Finch-API/finch-api-ruby/issues/19)) ([7ff758e](https://github.com/Finch-API/finch-api-ruby/commit/7ff758e5ccd442f8fe4843f70025f7c302e6d1ba)) +* resolve tapioca derived sorbet errors ([#56](https://github.com/Finch-API/finch-api-ruby/issues/56)) ([0b1c07a](https://github.com/Finch-API/finch-api-ruby/commit/0b1c07a2abd333fc000f785066987fe951f7bf59)) +* sorbet class aliases are not type aliases ([#52](https://github.com/Finch-API/finch-api-ruby/issues/52)) ([f2abbe9](https://github.com/Finch-API/finch-api-ruby/commit/f2abbe9fb129d81f6b345f522af1ff36a0044786)) +* yard example tag formatting ([#59](https://github.com/Finch-API/finch-api-ruby/issues/59)) ([de42306](https://github.com/Finch-API/finch-api-ruby/commit/de42306ed5186b7031889b725609b28b8b04b35c)) + + +### Chores + +* `BaseModel` fields that are `BaseModel` typed should also accept `Hash` ([#58](https://github.com/Finch-API/finch-api-ruby/issues/58)) ([a519092](https://github.com/Finch-API/finch-api-ruby/commit/a519092120ad92d1ad8bb1fa1cdc18902b3842c4)) +* add `[@yieldparam](https://github.com/yieldparam)` to yard doc ([#48](https://github.com/Finch-API/finch-api-ruby/issues/48)) ([07be571](https://github.com/Finch-API/finch-api-ruby/commit/07be5719c8710e6b876ae13593daf13d744800ee)) +* add `sorbet` section to README ([#15](https://github.com/Finch-API/finch-api-ruby/issues/15)) ([353250b](https://github.com/Finch-API/finch-api-ruby/commit/353250b0ba9474617d2c844eb01d9753405b87ca)) +* add example directory ([#51](https://github.com/Finch-API/finch-api-ruby/issues/51)) ([f7dbdf7](https://github.com/Finch-API/finch-api-ruby/commit/f7dbdf7c341bd6622b5caa66abc010218ff7669b)) +* add more examples to README.md ([#16](https://github.com/Finch-API/finch-api-ruby/issues/16)) ([00b0b73](https://github.com/Finch-API/finch-api-ruby/commit/00b0b73708af0e39e23f03028bb4d32250c07cf4)) +* add most doc strings to rbi type definitions ([#33](https://github.com/Finch-API/finch-api-ruby/issues/33)) ([e366baa](https://github.com/Finch-API/finch-api-ruby/commit/e366baa122865a1734c9e17bba6a0531c115c1a3)) +* add type annotations for enum and union member listing methods ([#60](https://github.com/Finch-API/finch-api-ruby/issues/60)) ([414af1a](https://github.com/Finch-API/finch-api-ruby/commit/414af1a8c761ded84a26cd5ad1d85838fe372cdf)) +* bump lockfile ([#7](https://github.com/Finch-API/finch-api-ruby/issues/7)) ([a644446](https://github.com/Finch-API/finch-api-ruby/commit/a64444614bbee1dd6cb93d1f5ba3440eb15e192c)) +* disable dangerous rubocop auto correct rule ([#67](https://github.com/Finch-API/finch-api-ruby/issues/67)) ([1d98cb0](https://github.com/Finch-API/finch-api-ruby/commit/1d98cb0aabcaa378bc08b87e54ae9bdb476d077e)) +* disable overloads in `*.rbs` definitions for readable LSP errors ([#54](https://github.com/Finch-API/finch-api-ruby/issues/54)) ([2d71742](https://github.com/Finch-API/finch-api-ruby/commit/2d717426f7371291b3d6cde32f63d179a3ba5da0)) +* disable unnecessary linter rules for sorbet manifests ([#47](https://github.com/Finch-API/finch-api-ruby/issues/47)) ([50e9efe](https://github.com/Finch-API/finch-api-ruby/commit/50e9efea70eb91f9cb8fb1e39205ca16009fefcc)) +* do not label modules as abstract ([#42](https://github.com/Finch-API/finch-api-ruby/issues/42)) ([f99868b](https://github.com/Finch-API/finch-api-ruby/commit/f99868b7b10d354a735276e8f2d5dba226daf35c)) +* document Client's concurrency capability ([#46](https://github.com/Finch-API/finch-api-ruby/issues/46)) ([24aba19](https://github.com/Finch-API/finch-api-ruby/commit/24aba192cb119c823905ee9296f65870ce697aa5)) +* document union variants in yard doc ([#37](https://github.com/Finch-API/finch-api-ruby/issues/37)) ([623ce81](https://github.com/Finch-API/finch-api-ruby/commit/623ce8130371bb406cd138fb07757932a2522464)) +* ensure doc strings for rbi method arguments ([#34](https://github.com/Finch-API/finch-api-ruby/issues/34)) ([a592cdf](https://github.com/Finch-API/finch-api-ruby/commit/a592cdf6fea4bab81c60e25ea1149a38b3e2ad75)) +* error fields are now mutable in keeping with rest of SDK ([#36](https://github.com/Finch-API/finch-api-ruby/issues/36)) ([99d4319](https://github.com/Finch-API/finch-api-ruby/commit/99d43196e06882dfc973a70a2e5294cd5d2c28dc)) +* fused enum should use faster internal iteration by default ([#22](https://github.com/Finch-API/finch-api-ruby/issues/22)) ([c4ee170](https://github.com/Finch-API/finch-api-ruby/commit/c4ee1708018b48967978e1a94c882e15bc920aa5)) +* generate better supported rbi signatures ([#12](https://github.com/Finch-API/finch-api-ruby/issues/12)) ([e093ce4](https://github.com/Finch-API/finch-api-ruby/commit/e093ce41d1d87e0848f49cde7e5eac8e8d11bbe5)) +* ignore some spurious linter warnings and formatting changes ([#45](https://github.com/Finch-API/finch-api-ruby/issues/45)) ([2dce5e9](https://github.com/Finch-API/finch-api-ruby/commit/2dce5e92fca8b7a9f70ddee082390d0fbb470d21)) +* improve documentation ([#24](https://github.com/Finch-API/finch-api-ruby/issues/24)) ([1896856](https://github.com/Finch-API/finch-api-ruby/commit/1896856a88362566dd81a1afed4e97096b62c7d6)) +* improve rbi typedef for page classes ([#29](https://github.com/Finch-API/finch-api-ruby/issues/29)) ([ac6b999](https://github.com/Finch-API/finch-api-ruby/commit/ac6b9994ed71d42702133590144fe5a22c273111)) +* **internal:** add sorbet config for SDK local development ([#50](https://github.com/Finch-API/finch-api-ruby/issues/50)) ([bb63811](https://github.com/Finch-API/finch-api-ruby/commit/bb6381194d39b2794921cea5c885be5157bd1163)) +* **internal:** codegen related update ([#17](https://github.com/Finch-API/finch-api-ruby/issues/17)) ([b0d79ac](https://github.com/Finch-API/finch-api-ruby/commit/b0d79ac02e99852b1ab14892a0f14fa275105819)) +* **internal:** codegen related update ([#20](https://github.com/Finch-API/finch-api-ruby/issues/20)) ([d715c02](https://github.com/Finch-API/finch-api-ruby/commit/d715c0202babd8cdd2911f8cd390611865c0955f)) +* **internal:** remove extra empty newlines ([#30](https://github.com/Finch-API/finch-api-ruby/issues/30)) ([d8c970e](https://github.com/Finch-API/finch-api-ruby/commit/d8c970e6728b8a61c13e518850776d75cbdcece8)) +* **internal:** version bump ([#4](https://github.com/Finch-API/finch-api-ruby/issues/4)) ([1e24a6c](https://github.com/Finch-API/finch-api-ruby/commit/1e24a6c308f2bda2dfc8d253bad8c0e7c007d149)) +* mark non-inheritable SDK internal classes as final ([#39](https://github.com/Finch-API/finch-api-ruby/issues/39)) ([69bb3a3](https://github.com/Finch-API/finch-api-ruby/commit/69bb3a3c0831b8940709dd3b14115fefbcc7508e)) +* modify sorbet initializers to better support auto-completion ([#13](https://github.com/Finch-API/finch-api-ruby/issues/13)) ([3271474](https://github.com/Finch-API/finch-api-ruby/commit/327147477a34f2f0bd0e0e6b813a2646493ca2df)) +* more readable output when tests fail ([#68](https://github.com/Finch-API/finch-api-ruby/issues/68)) ([7af6e91](https://github.com/Finch-API/finch-api-ruby/commit/7af6e913d4c8acbac489d14d33ed3df443e9fd7e)) +* move examples into tests ([#9](https://github.com/Finch-API/finch-api-ruby/issues/9)) ([4ba4a39](https://github.com/Finch-API/finch-api-ruby/commit/4ba4a39da10518ea5f4ec13f35d2ffcdac9931dc)) +* pagination ([#21](https://github.com/Finch-API/finch-api-ruby/issues/21)) ([e95562f](https://github.com/Finch-API/finch-api-ruby/commit/e95562f4be1b85f0c5de44037eb0c64ac0c66dde)) +* recursively accept `AnyHash` for `BaseModel`s in arrays and hashes ([#63](https://github.com/Finch-API/finch-api-ruby/issues/63)) ([727a5b5](https://github.com/Finch-API/finch-api-ruby/commit/727a5b5a14aa309e4db8a21fac8689f8924863df)) +* reduce verbosity in type declarations ([#66](https://github.com/Finch-API/finch-api-ruby/issues/66)) ([47de683](https://github.com/Finch-API/finch-api-ruby/commit/47de6833d2762936d4dd2be7f21466c1a7f2d6b1)) +* refactor BasePage to have initializer ([#28](https://github.com/Finch-API/finch-api-ruby/issues/28)) ([0b49043](https://github.com/Finch-API/finch-api-ruby/commit/0b49043f7bcd2fa9cc522ca65945634add1338a8)) +* remove stale thread local checks ([#27](https://github.com/Finch-API/finch-api-ruby/issues/27)) ([3fbfa6c](https://github.com/Finch-API/finch-api-ruby/commit/3fbfa6cf8802942f58d331a1193b9ed537f5669d)) +* rename misleading variable ([#8](https://github.com/Finch-API/finch-api-ruby/issues/8)) ([0b3397f](https://github.com/Finch-API/finch-api-ruby/commit/0b3397f11d90ca29a56b7fa7f162d96edf07be06)) +* sdk client internal refactoring ([#41](https://github.com/Finch-API/finch-api-ruby/issues/41)) ([a0e8fe9](https://github.com/Finch-API/finch-api-ruby/commit/a0e8fe940fbeab06cfd62c3faea8b32b93500234)) +* sdk internal updates ([#31](https://github.com/Finch-API/finch-api-ruby/issues/31)) ([74a9ff6](https://github.com/Finch-API/finch-api-ruby/commit/74a9ff6839ce6c108514d1197987e5a6223a571e)) +* slightly more consistent type definition layout ([#38](https://github.com/Finch-API/finch-api-ruby/issues/38)) ([cf75aa6](https://github.com/Finch-API/finch-api-ruby/commit/cf75aa6659727bf0f0c429df3e2cdb51ccb49541)) +* support different EOLs in streaming ([#11](https://github.com/Finch-API/finch-api-ruby/issues/11)) ([4eb4cc3](https://github.com/Finch-API/finch-api-ruby/commit/4eb4cc36954eeb5fb39beee0d335d573cddd11b6)) +* switch to prettier looking sorbet annotations ([#64](https://github.com/Finch-API/finch-api-ruby/issues/64)) ([797cdf7](https://github.com/Finch-API/finch-api-ruby/commit/797cdf7ff1377392296b80b8681447b47de0c3a9)) +* touch up sdk usage examples ([#35](https://github.com/Finch-API/finch-api-ruby/issues/35)) ([f17f349](https://github.com/Finch-API/finch-api-ruby/commit/f17f349ca92249203baa08738ed0f6100c280f6c)) +* update custom timeout header name ([#6](https://github.com/Finch-API/finch-api-ruby/issues/6)) ([e19278e](https://github.com/Finch-API/finch-api-ruby/commit/e19278e42797781e1ed237688abe62a2b9e85b4c)) +* use generics instead of overloading for sorbet type definitions ([#40](https://github.com/Finch-API/finch-api-ruby/issues/40)) ([e8e32c7](https://github.com/Finch-API/finch-api-ruby/commit/e8e32c72394607c86788de884fa2ed8335e4d8bf)) +* use multi-line formatting style for really long lines ([#49](https://github.com/Finch-API/finch-api-ruby/issues/49)) ([96c2c73](https://github.com/Finch-API/finch-api-ruby/commit/96c2c73fa1e7994dffdbeabafee3c8dc93c0a46d)) + ## 0.1.0-alpha.1 (2025-03-05) Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/Finch-API/finch-api-ruby/compare/v0.0.1-alpha.0...v0.1.0-alpha.1) diff --git a/Gemfile.lock b/Gemfile.lock index 6f85e901..0febc9da 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - finch-api (0.1.0.pre.alpha.1) + finch-api (0.1.0.pre.alpha.2) connection_pool GEM diff --git a/lib/finch-api/version.rb b/lib/finch-api/version.rb index e85ced32..45af2d06 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-alpha.1" + VERSION = "0.1.0-alpha.2" end diff --git a/rbi/lib/finch-api/version.rbi b/rbi/lib/finch-api/version.rbi index 772681c6..1a41f4f1 100644 --- a/rbi/lib/finch-api/version.rbi +++ b/rbi/lib/finch-api/version.rbi @@ -1,5 +1,5 @@ # typed: strong module FinchAPI - VERSION = "0.1.0-alpha.1" + VERSION = "0.1.0-alpha.2" end